Fix the get_latest_open_ledger_sequence method

[ckeshava]

High Level Overview of Change

Fixes #810

Reference documentation for the ledger RPC method: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger#request-format

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

This is a Breaking Change. It changes the behavior of the external user-facing API.

However, if any user were using this method, they should have reported this bug sooner. This change can be integrated into the main branch without disrupting the workflow of any users because nobody seems to be using it.

[coderabbitai]

Walkthrough

This pull request corrects the behavior of the get_latest_open_ledger_sequence function by updating it to use the "current" ledger instead of the invalid "open" ledger. Additionally, it improves model parameter type validation as documented in the CHANGELOG. A new asynchronous test, test_fetch_current_ledger, has been added to validate the function’s output. No changes were made to exported or public entities.

Changes

File(s)	Change Summary
CHANGELOG.md	Updated the "Fixed" section to note that get_latest_open_ledger_sequence now uses the "current" ledger and added an entry in the "Added" section for enhanced model parameter type validation.
tests/integration/reqs/test_ledger.py	Introduced a new asynchronous test method test_fetch_current_ledger (decorated with @test_async_and_sync) and added the necessary import for get_latest_open_ledger_sequence.
xrpl/.../ledger/main.py	Modified get_latest_open_ledger_sequence to use ledger_index="current" instead of "open", added assertions to validate the response structure, updated the return value to ledger_current_index, and clarified the behavior in the docstring for backwards compatibility.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test
    participant C as Client
    participant L as Ledger Server
    T->>C: Invoke get_latest_open_ledger_sequence(client)
    C->>L: Request ledger with ledger_index="current"
    L-->>C: Respond with ledger data (includes ledger_current_index)
    C-->>T: Return ledger_current_index value after assertions

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Fix get_latest_open_ledger_sequence() to use the correct ledger index instead of "open" (#810)	✅

Suggested reviewers

• pdp2121
• achowdhry-ripple

Poem

I'm a rabbit with a coding flair,
Hopping through ledgers without a care.
"Current" is the beat in my code so true,
Fixing bugs and making tests shine through.
With each hop, improvements bloom – woohoo!
Happy trails and code leaps to you!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6979324 and 5d56510.

📒 Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• tests/integration/reqs/test_ledger.py (2 hunks)
• xrpl/asyncio/ledger/main.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Integration test (3.12)
• GitHub Check: Integration test (3.13)
• GitHub Check: Integration test (3.8)

🔇 Additional comments (5)

tests/integration/reqs/test_ledger.py (2)

3-3: Appropriate import added for the new test

The import for get_latest_open_ledger_sequence from the asyncio ledger module is correct and necessary for the new test being added.

---

13-20: Well-structured test for the updated API method

The test properly validates that get_latest_open_ledger_sequence returns an integer after the API change from using "open" to "current" ledger. The test_async_and_sync decorator ensures both sync and async implementations are tested, and use_testnet=True ensures a reliable test environment.

CHANGELOG.md (1)

12-12: Clear changelog entry for the implementation fix

The changelog entry accurately describes the fix made to the get_latest_open_ledger_sequence method, specifically noting the change from "open" to "current" ledger for extracting the sequence number. This provides users with clear information about the change.

xrpl/asyncio/ledger/main.py (2)

36-41: Excellent documentation explaining the API correction

The added docstring provides clear context about why the implementation is changing while maintaining backward compatibility. The link to the documentation is helpful for users to understand the XRPL ledger specifications.

---

52-66: Correctly fixed the implementation with proper validation

The implementation now properly uses "current" instead of "open" for the ledger index and returns the correct ledger_current_index field. The added assertions are valuable for verifying the response structure and will help catch any unexpected changes in the API response format.

✨ 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.

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 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.