fix: resolve `TransactionStream` and `Ledger` model issues

[mvadari]

High Level Overview of Change

Title says it all.

Context of Change

Fixes #2767 Fixes #2714 Fixes #2715

Type of Change

• [x] Bug fix (non-breaking change which fixes an issue)

Did you update HISTORY.md?

• [x] Yes

Test Plan

The models match the output. CI passes.

[justinr1234]

@coderabbitai full review

[coderabbitai[bot]]

Actions performed

Full review triggered.

[coderabbitai[bot]]

Walkthrough

The recent updates to the xrpl package introduce several enhancements, including the addition of a utility function parseTransactionFlags, updates to the TransactionStream and Ledger models to include a new field close_time_iso, and modifications to support API version 2. These changes improve the handling of transaction data and enhance the clarity of time-related information across the package.

Changes

File(s)	Change Summary
packages/xrpl/HISTORY.md	Added a summary of changes including new utility function and model updates.
packages/xrpl/src/client/partialPayment.ts	Updated handleStreamPartialPayment to accept both TransactionStream and TransactionV1Stream.
packages/xrpl/src/models/ledger/Ledger.ts	Added close_time_iso property to BaseLedger interface.
packages/xrpl/src/models/methods/index.ts	Introduced TransactionV1Stream entity for enhanced streaming capabilities.
packages/xrpl/src/models/methods/subscribe.ts	Created TransactionStreamBase interface for API version handling and added close_time_iso.
packages/xrpl/test/fixtures/requests/hashLedger.json	Added close_time_iso field to the JSON structure for standardized date format.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant TransactionStream
    participant Ledger

    Client->>API: Request transaction stream
    API->>TransactionStream: Provide transaction data
    TransactionStream->>Ledger: Include close_time_iso
    Ledger-->>API: Return ledger data with close_time_iso
    API-->>Client: Send transaction stream with close_time_iso

Assessment against linked issues

Objective	Addressed	Explanation
TransactionStream type is wrong when using API version 2 (#2767)	✅
TransactionStream missing close_time_iso field (#2714)	✅
Response of ledger command missing close_time_iso field (#2715)	✅

Suggested labels

dependencies

Suggested reviewers

• justinr1234
• ckeshava

Poem

🐇 In the land of code where rabbits hop,
New flags and streams make our hearts stop!
With ISO times shining bright,
Transactions dance in the moonlight.
Hooray for changes, let’s all cheer,
For the XRPL's future is looking clear! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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

[ckeshava]

The CodeRabbit AI does not make a mention of the changes pertaining to tx_json and transaction fields.

I also don't understand the diagram because TransactionStream and API do not refer to anything concrete in the architecture of XRPL.

[mvadari]

The CodeRabbit AI does not make a mention of the changes pertaining to tx_json and transaction fields.

I also don't understand the diagram because TransactionStream and API do not refer to anything concrete in the architecture of XRPL.

CodeRabbit isn't the smartest. cc @justinr1234