release 4.3.1: update the patch version of the xrpl-py package #884
Conversation
WalkthroughThe pull request updates the project version from 4.3.0 to 4.3.1 in Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Caller
participant Helpers as encode_mptoken_metadata / decode_mptoken_metadata
participant MPTokenMetadata
participant BinaryCodec
Note over Caller,Helpers: New helpers for MPTokenMetadata (XLS-89)
Caller->>Helpers: encode_mptoken_metadata(MPTokenMetadata)
Helpers->>MPTokenMetadata: read fields (XLS-89)
Helpers->>BinaryCodec: serialize fields -> bytes
BinaryCodec-->>Helpers: bytes
Helpers-->>Caller: encoded bytes
Caller->>Helpers: decode_mptoken_metadata(bytes)
Helpers->>BinaryCodec: parse bytes -> fields
BinaryCodec-->>Helpers: parsed fields
Helpers->>MPTokenMetadata: construct object
Helpers-->>Caller: MPTokenMetadata
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-15T15:54:25.836Z
Learnt from: ckeshava
Repo: XRPLF/xrpl-py PR: 866
File: xrpl/models/transactions/loan_set.py:158-181
Timestamp: 2025-09-15T15:54:25.836Z
Learning: In the xrpl-py codebase, validation logic for transaction fields is primarily handled by rippled (the C++ XRPL implementation) rather than being duplicated in the Python models. Python models should focus on basic structural validation rather than comprehensive field validation that rippled already performs.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-06-04T22:17:47.164Z
Learnt from: ckeshava
Repo: XRPLF/xrpl-py PR: 814
File: xrpl/models/amounts/mpt_amount.py:54-64
Timestamp: 2025-06-04T22:17:47.164Z
Learning: For MPTIssue class in xrpl-py, the user ckeshava confirmed that a simple class implementation without BaseModel inheritance works correctly for their current requirements, even though other currency types in the same Union (IssuedCurrency, MPTCurrency, XRP) extend BaseModel.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-06-04T22:17:47.822Z
Learnt from: ckeshava
Repo: XRPLF/xrpl-py PR: 814
File: xrpl/models/requests/vault_info.py:16-31
Timestamp: 2025-06-04T22:17:47.822Z
Learning: In the xrpl-py library, Request classes do not perform client-side validation on their contents. The library relies on the rippled node to return appropriate error codes for malformed requests, maintaining a consistent pattern across all Request models.
Applied to files:
CHANGELOG.md
🪛 markdownlint-cli2 (0.18.1)
CHANGELOG.md
21-21: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
- GitHub Check: Integration test (3.14)
- GitHub Check: Integration test (3.11)
- GitHub Check: Integration test (3.13)
- GitHub Check: Integration test (3.9)
- GitHub Check: Integration test (3.10)
- GitHub Check: Integration test (3.12)
- GitHub Check: Integration test (3.8)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
CHANGELOG.md (1)
10-20: Changelog entry is well‑structured and properly documents breaking changes.The new 4.3.1 section follows the Keep a Changelog format consistently. The breaking changes in lines 19–20 are clearly documented with explanations, which is appropriate for a patch release addressing XLS-89 standard compliance. The reference to PR #870 provides good traceability for the binary-codec fix.
| - Removed snippets files from the xrpl-py code repository. Updated the README file to point to the correct location on XRPL.org. | ||
| - [Breaking change] Fix `MPTokenMetadata` type to adhere to the XLS-89 standard. Since XLS-89 is still in a forming state and undergoing changes, this breaking change is being released as a bug fix via patch version bump. If you are using `MPTokenMetadata` in your code, please verify that it adheres to the updated type definition. | ||
| - [Breaking change] Fix `validate_mptoken_metadata` to correctly validate MPTokenMetadata as per XLS-89 standard. Since XLS-89 is still in a forming state and undergoing changes, this breaking change is being released as a bug fix via patch version bump. If you are using `validateMPTokenMetadata` in your code, expect it to change as per the XLS-89 standard. | ||
| - Fixed the binary-codec issues pertaining to the serialization of the `MPTCurrency` rippled type. (Reference PR: https://github.com/XRPLF/xrpl-py/pull/870) |
There was a problem hiding this comment.
Wrap the bare URL in markdown link syntax.
Line 21 contains a bare URL that should be wrapped in proper markdown link format to comply with markdown best practices.
Apply this diff to fix the formatting:
-- Fixed the binary-codec issues pertaining to the serialization of the `MPTCurrency` rippled type. (Reference PR: https://github.com/XRPLF/xrpl-py/pull/870)
+- Fixed the binary-codec issues pertaining to the serialization of the `MPTCurrency` rippled type. ([Reference PR](https://github.com/XRPLF/xrpl-py/pull/870))📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Fixed the binary-codec issues pertaining to the serialization of the `MPTCurrency` rippled type. (Reference PR: https://github.com/XRPLF/xrpl-py/pull/870) | |
| - Fixed the binary-codec issues pertaining to the serialization of the `MPTCurrency` rippled type. ([Reference PR](https://github.com/XRPLF/xrpl-py/pull/870)) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
21-21: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In CHANGELOG.md around line 21, the PR reference is a bare URL; wrap it in
markdown link syntax so it displays as a proper link. Replace the bare URL with
a markdown link like [PR #870](https://github.com/XRPLF/xrpl-py/pull/870) (or
similar descriptive text) so the changelog uses proper markdown link formatting.
There was a problem hiding this comment.
This is not a critical suggestion. I will choose to ignore it for the paucity of time. We need to release this library to bring parity between the different programming languages client libraries.
There was a problem hiding this comment.
@ckeshava, understood! No problem at all—I appreciate you prioritizing the release timeline. Best of luck with getting 4.3.1 out the door! 🚀
🧠 Learnings used
Learnt from: ckeshava
Repo: XRPLF/xrpl-py PR: 866
File: xrpl/models/transactions/loan_set.py:158-181
Timestamp: 2025-09-15T15:54:25.836Z
Learning: In the xrpl-py codebase, validation logic for transaction fields is primarily handled by rippled (the C++ XRPL implementation) rather than being duplicated in the Python models. Python models should focus on basic structural validation rather than comprehensive field validation that rippled already performs.
Learnt from: mvadari
Repo: XRPLF/xrpl-py PR: 759
File: tests/unit/models/transactions/test_account_delete.py:52-60
Timestamp: 2024-12-12T00:48:38.042Z
Learning: The credential ID format validation for xrpl-py is being tracked in issue #766 and should not be duplicated in other PRs.
3 participants
High Level Overview of Change
release-4.3.1: update the patch version of the xrpl-py package and the CHANGELOG entryContext of Change
This is a PR to create a new release. No functional changes have been made to the code in this PR.
Type of Change
Did you update CHANGELOG.md?
Test Plan
This is a PR to create a new release. No functional changes have been made to the code in this PR. No new tests are added either.