Subscribe: Add book_changes

[dangell7]

High Level Overview of Change

Context of Change

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Refactor (non-breaking change that only restructures code)
• Tests (You added tests for code that already exists, or your new feature included in this PR)
• Documentation Updates
• Release

Did you update CHANGELOG.md?

• Yes
• No, this change does not impact library users

Test Plan

[coderabbitai]

Walkthrough

A new member, BOOK_CHANGES, was added to the StreamParameter enum within the xrpl/models/requests/subscribe.py file. This addition introduces the string value "book_changes" as a valid stream parameter option. No other logic, error handling, or control flow was modified in this update.

Changes

File(s)	Change Summary
xrpl/models/requests/subscribe.py	Added BOOK_CHANGES = "book_changes" to the StreamParameter enum

Poem

In the field of streams, a change appears,
"book_changes" now joins its peers.
Enum grows with one more name,
To help us track the ledger’s game.
Hopping forward, code renewed,
A rabbit’s cheer for what’s accrued! 🐇📚✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

xrpl/models/requests/subscribe.py (2)

21-33: Add unit tests for the new stream parameter.
To ensure BOOK_CHANGES is properly serialized and handled by clients, please add unit tests that cover using StreamParameter.BOOK_CHANGES in a subscribe request—validating the JSON payload and any downstream behavior.

---

22-24: Update docstring to mention book_changes.
Consider enhancing the class-level docstring (or related documentation) to explicitly list book_changes as a supported stream, so users are aware of this new option.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae208ca and 12db14d.

📒 Files selected for processing (1)

• xrpl/models/requests/subscribe.py (1 hunks)

🔇 Additional comments (1)

xrpl/models/requests/subscribe.py (1)

24-24: Approve addition of BOOK_CHANGES enum member.
The new StreamParameter.BOOK_CHANGES = "book_changes" correctly extends the enum to support the book_changes stream.

[achowdhry-ripple]

Hi, if this PR is ready please add a description with context for the change and mark it as "ready" instead of draft. If you are still working on it, no worries.