fix: add MPTAmount support in Issue model #2919
Conversation
WalkthroughThe changes introduce a new section titled "Fixed" in the Changes
Suggested reviewers
Poem
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![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
🔭 Outside diff range comments (1)
packages/ripple-binary-codec/src/types/issue.ts (1)
83-90:⚠️ Potential issueUpdate the
fromParsermethod to handle MPT amounts.The
fromParsermethod doesn't appear to have been updated to handle MPT amounts. Since you've added support for MPT in other methods, this method should also be updated to ensure consistency when parsing from binary data.Consider adding logic to detect and handle MPT amounts in the parser:
static fromParser(parser: BinaryParser): Issue { const currency = parser.read(20) if (new Currency(currency).toJSON() === 'XRP') { return new Issue(currency) } + // If the currency value matches an MPT issuance format, treat as MPT + if (currency.length === Hash192.width / 2) { + return new Issue(currency) + } const currencyAndIssuer = [currency, parser.read(20)] return new Issue(concat(currencyAndIssuer)) }Please verify this implementation against the xrpl-py repository's approach as mentioned in the PR objectives.
🧹 Nitpick comments (1)
packages/ripple-binary-codec/src/types/issue.ts (1)
1-121: Add tests for MPT amount handling.With the addition of MPT amount support, it would be beneficial to add tests that verify the serialization and deserialization of MPT amounts to ensure the implementation works correctly for all cases.
Would you like me to help draft some test cases for this implementation?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/ripple-binary-codec/HISTORY.md(1 hunks)packages/ripple-binary-codec/src/types/issue.ts(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: snippets (22.x)
- GitHub Check: snippets (20.x)
- GitHub Check: integration (22.x)
- GitHub Check: snippets (18.x)
- GitHub Check: integration (20.x)
- GitHub Check: integration (18.x)
- GitHub Check: browser (18.x)
🔇 Additional comments (5)
packages/ripple-binary-codec/HISTORY.md (1)
5-6: Documentation looks good.The added "Fixed" section properly documents the implementation of MPTAmount support in the Issue type, making it clear what change was made in this release.
packages/ripple-binary-codec/src/types/issue.ts (4)
7-7: Appropriate import for MPT support.The
Hash192import is correctly added to handle the MPT issuance ID in the Issue type.
13-16: Interface modifications look good.The changes to the
IssueObjectinterface are appropriate:
- Making
currencyoptional allows for cases where only an MPT issuance ID is present- Adding the optional
mpt_issuance_idproperty supports the new MPT functionalityThese changes align with the PR's objective of adding MPTAmount support.
23-29: Type guard logic properly updated.The
isIssueObjectfunction is correctly updated to handle all three cases:
- XRP case: object has only a currency property
- IOU case: object has both currency and issuer properties
- MPT case: object has only an mpt_issuance_id property
This comprehensive type guard ensures proper validation for all supported Issue object types.
54-72: Implementation of MPT case infrommethod looks good.The static
frommethod has been properly updated to handle the three cases:
- IOU case (when both currency and issuer are present)
- XRP case (when only currency is present)
- MPT case (when mpt_issuance_id is present)
The code structure is clear and the implementation is correct.
| // If the buffer is exactly 24 bytes, treat it as an MPT amount. | ||
| if (this.toBytes.length === Hash192.width) { | ||
| return { | ||
| mpt_issuance_id: this.toHex().toUpperCase(), | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Fix method call in toJSON implementation.
There appears to be a syntax error when checking the byte length. The toBytes should be called as a method, not accessed as a property.
- if (this.toBytes.length === Hash192.width) {
+ if (this.toBytes().length === Hash192.width) {📝 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.
| // If the buffer is exactly 24 bytes, treat it as an MPT amount. | |
| if (this.toBytes.length === Hash192.width) { | |
| return { | |
| mpt_issuance_id: this.toHex().toUpperCase(), | |
| } | |
| } | |
| // If the buffer is exactly 24 bytes, treat it as an MPT amount. | |
| - if (this.toBytes.length === Hash192.width) { | |
| + if (this.toBytes().length === Hash192.width) { | |
| return { | |
| mpt_issuance_id: this.toHex().toUpperCase(), | |
| } | |
| } |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
packages/ripple-binary-codec/src/types/issue.ts (1)
92-99: 🛠️ Refactor suggestionUpdate fromParser method to handle MPT Issue types.
The fromParser method hasn't been updated to handle MPT issue types, which could lead to issues when parsing serialized MPT Issues. Consider adding support for MPT Issue types in this method.
static fromParser(parser: BinaryParser): Issue { const currency = parser.read(20) if (new Currency(currency).toJSON() === 'XRP') { return new Issue(currency) } + + // Check if this is an MPT issue (should be exactly Hash192.width bytes) + if (currency.length === Hash192.width) { + return new Issue(currency) + } + const currencyAndIssuer = [currency, parser.read(20)] return new Issue(concat(currencyAndIssuer)) }
♻️ Duplicate comments (1)
packages/ripple-binary-codec/src/types/issue.ts (1)
107-113:⚠️ Potential issueFix method call in toJSON implementation.
There appears to be a syntax error when checking the byte length. The
toBytesshould be called as a method, not accessed as a property.- if (this.toBytes.length === Hash192.width) { + if (this.toBytes().length === Hash192.width) {
🧹 Nitpick comments (3)
packages/ripple-binary-codec/src/types/issue.ts (3)
48-54: Update JSDoc to include MPT issue type.The JSDoc comment for the from method should be updated to include the MPT issue type.
/** * Construct an amount from an IOU or string amount * - * @param value An Amount, object representing an IOU, or a string + * @param value An Amount, object representing an XRP, IOU, or MPT issue, or a string * representing an integer amount * @returns An Amount object */
55-55: Consider implementing stronger type checking in the from method.The current implementation relies on checking properties in a specific order. Consider making the type guard more explicit to handle unexpected combinations of properties.
static from<T extends Issue | IssueObject>(value: T): Issue { if (value instanceof Issue) { return value } if (isIssueObject(value)) { + // Handle each type explicitly rather than relying on property checks + if ('mpt_issuance_id' in value) { + const mptIssuanceIdBytes = Hash192.from( + value.mpt_issuance_id.toString(), + ).toBytes() + return new Issue(mptIssuanceIdBytes) + } else if ('currency' in value) { + const currency = Currency.from(value.currency.toString()).toBytes() + + if ('issuer' in value) { + const issuer = AccountID.from(value.issuer.toString()).toBytes() + return new Issue(concat([currency, issuer])) + } + + return new Issue(currency) + } - if (value.currency) { - const currency = Currency.from(value.currency.toString()).toBytes() - - //IOU case - if (value.issuer) { - const issuer = AccountID.from(value.issuer.toString()).toBytes() - return new Issue(concat([currency, issuer])) - } - - //XRP case - return new Issue(currency) - } - - // MPT case - if (value.mpt_issuance_id) { - const mptIssuanceIdBytes = Hash192.from( - value.mpt_issuance_id.toString(), - ).toBytes() - return new Issue(mptIssuanceIdBytes) - } } throw new Error('Invalid type to construct an Amount') }
83-83: Improve error message specificity.The current error message is generic. Consider providing more specific error messages for different failure scenarios.
- throw new Error('Invalid type to construct an Amount') + throw new Error('Invalid type to construct an Issue: expected Issue instance or IssueObject with valid properties')
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/ripple-binary-codec/src/types/issue.ts(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: snippets (22.x)
- GitHub Check: unit (20.x)
- GitHub Check: snippets (20.x)
- GitHub Check: unit (18.x)
- GitHub Check: integration (22.x)
- GitHub Check: snippets (18.x)
- GitHub Check: integration (20.x)
- GitHub Check: integration (18.x)
- GitHub Check: browser (18.x)
- GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
packages/ripple-binary-codec/src/types/issue.ts (5)
7-7: LGTM: Adding Hash192 import for MPT support.The import of Hash192 is correctly added to support the new MPTIssue type.
9-19: Well-structured type definitions for Issue types.The interfaces are cleanly structured to represent the three distinct issue types:
- XRPIssue: Contains only currency
- IOUIssue: Contains currency and issuer
- MPTIssue: Contains mpt_issuance_id
This approach provides good type safety and clarity.
23-23: Good union type approach for IssueObject.Converting IssueObject from an interface to a union type is the correct approach to handle the different issue variants.
28-36: Correctly updated type guard for the new union type.The isIssueObject type guard has been properly updated to handle all three issue types. The implementation is clean and follows a logical pattern.
61-81: Well-implemented Issue handling in the from method.The from method has been correctly updated to handle all three issue types with appropriate branching logic.
|
|
||
| it(`test from value mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) |
There was a problem hiding this comment.
@khancode saw value in the python tests, but wasn't sure whether to add it here based on our discussions. Seems like it should be here, but that would require me to change the isMPT logic in Issue to something different than what we discussed
There was a problem hiding this comment.
Can you check if value is included when Issue.from is normally called? If yes, then we should add it.
There was a problem hiding this comment.
Issue.from accepts both types in the input parameter.
static from<T extends Issue | IssueObject>(value: T): Issue
It should work either ways
achowdhry-ripple
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
packages/ripple-binary-codec/src/types/issue.ts (3)
28-36: Type guard implementation could be more robustThe current implementation of
isIssueObjectrelies on checking the existence and order of keys, which might be brittle if object properties are reordered. Consider enhancing the type guard to also validate the types of the values:function isIssueObject(arg): arg is IssueObject { const keys = Object.keys(arg).sort() const isXRP = keys.length === 1 && keys[0] === 'currency' const isIOU = keys.length === 2 && keys[0] === 'currency' && keys[1] === 'issuer' const isMPT = keys.length === 1 && keys[0] === 'mpt_issuance_id' + // Additional validation for value types + if (isXRP && typeof arg.currency !== 'string') return false + if (isIOU && (typeof arg.currency !== 'string' || typeof arg.issuer !== 'string')) return false + if (isMPT && typeof arg.mpt_issuance_id !== 'string') return false return isXRP || isIOU || isMPT }
48-54: Update JSDoc comment for the from methodThe JSDoc comment for the
frommethod needs to be updated to reflect the addition of MPT issue support./** * Construct an amount from an IOU or string amount * * @param value An Amount, object representing an IOU, or a string * representing an integer amount - * @returns An Issue object + * @param value An Amount, object representing an XRP issue, IOU issue, MPT issue, or a string + * representing an integer amount + * @returns An Issue object representing XRP, IOU, or MPT */
75-81: Add validation for MPT issuance ID formatCurrently, the code doesn't validate the format of the
mpt_issuance_idstring beyond passing it toHash192.from(). Consider adding explicit validation to ensure it meets the expected format.// MPT case if (value.mpt_issuance_id) { + // Validate mpt_issuance_id format (should be 48 characters of hex) + const mptId = value.mpt_issuance_id.toString() + if (!/^[0-9A-Fa-f]{48}$/.test(mptId)) { + throw new Error('Invalid MPT issuance ID format') + } const mptIssuanceIdBytes = Hash192.from( value.mpt_issuance_id.toString(), ).toBytes() return new Issue(mptIssuanceIdBytes) }
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/ripple-binary-codec/src/types/issue.ts(4 hunks)packages/ripple-binary-codec/test/issue.test.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: snippets (22.x)
- GitHub Check: snippets (20.x)
- GitHub Check: snippets (18.x)
- GitHub Check: integration (22.x)
- GitHub Check: integration (20.x)
- GitHub Check: integration (18.x)
🔇 Additional comments (7)
packages/ripple-binary-codec/test/issue.test.ts (2)
29-36: Good implementation of MPT issue test caseThe test case properly verifies that an MPT issue with a
mpt_issuance_idcan be created and correctly serialized back to JSON.There's a commented-out line about
valueproperty with an explanation that "MPT amounts must be an integer string (no decimal point)". This comment provides helpful context about the constraints of MPT amounts.
79-86: Comprehensive error handling testGood job including a test case for invalid input handling. The test properly verifies that the
Issue.frommethod throws an appropriate error message when given invalid input.packages/ripple-binary-codec/src/types/issue.ts (5)
7-7: Good addition of Hash192 importThe addition of the Hash192 import is necessary for handling MPT issuance IDs, which are 192-bit hashes.
9-23: Well-structured type definitions for different issue typesBreaking down the
IssueObjectinto three distinct interfaces (XRPIssue,IOUIssue, andMPTIssue) improves type safety and makes the code more maintainable. The union type definition in line 23 properly combines these interfaces.
55-81: Structured handling of different issue typesThe implementation of the
frommethod properly handles all three types of issues (XRP, IOU, and MPT). The structure is clear with dedicated code paths for each case.
95-106: Proper implementation of MPT parsing with hint parameterThe
fromParsermethod has been updated to handle MPT issues by checking if the hint parameter matchesHash192.width. This approach is efficient and clear.
113-119: Fix method call in toJSON implementationThe issue identified in the previous review regarding
this.toByteshas been correctly fixed tothis.toBytes().The implementation properly handles MPT issues by checking if the byte length matches
Hash192.widthand returning an appropriate object withmpt_issuance_id.
| it(`test from parser mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) | ||
| mpt_issuance_id: 'BAADF00DBAADF00DBAADF00DBAADF00DBAADF00DBAADF00D', | ||
| } | ||
| const mptIssue = Issue.from(mptJson) | ||
| const parser = new BinaryParser(mptIssue.toHex()) | ||
| const parserIssue = Issue.fromParser(parser, 24) | ||
| expect(parserIssue.toJSON()).toMatchObject(mptJson) | ||
| }) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Ensure hint parameter for MPT parsing is always provided
This test correctly verifies that an MPT issue can be parsed from binary data using the fromParser method. Note that line 75 passes 24 as the hint parameter, which is crucial for correctly identifying and parsing MPT issues.
For clarity and to prevent potential issues, consider adding a test case that verifies behavior when the hint is not provided for an MPT issue.
🏁 Script executed:
#!/bin/bash
# Check if there are any other places in the codebase where fromParser is called for MPT issues without a hint
grep -r "fromParser" --include="*.ts" --include="*.js" . | grep -v "hint" | grep -i "mpt"Length of output: 194
Action Required: Ensure consistent use of the hint parameter for MPT parsing
The test in packages/ripple-binary-codec/test/issue.test.ts demonstrates that providing a hint (e.g., 24) to Issue.fromParser is essential for correct MPT parsing. However, our search revealed that in packages/ripple-binary-codec/src/types/amount.ts the call to Hash192.fromParser(parser) does not include a hint parameter. Please review this discrepancy and consider the following:
- Verify whether omitting the hint for
Hash192.fromParseris intentional or an oversight. - If a hint is required for consistency (or to prevent potential parsing issues), update the invocation accordingly.
- Additionally, add a test case that verifies the behavior when the hint parameter is not provided for an MPT issue.
There was a problem hiding this comment.
@achowdhry-ripple this is a good catch. Hash192 doesn't have a hint parameter.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
There was a problem hiding this comment.
The hint parameter is not used in the Issue.from_parser method. Specifying a hint won't affect the output of the function. I suspect it has been retained for inheritance purposes.
| expect(iouIssue.toJSON()).toMatchObject(iouJson) | ||
| }) | ||
|
|
||
| it(`test from value nonstandard currency`, () => { |
There was a problem hiding this comment.
nit
| it(`test from value nonstandard currency`, () => { | |
| it(`test from value non-standard currency`, () => { |
|
|
||
| it(`test from value mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) |
There was a problem hiding this comment.
Can you check if value is included when Issue.from is normally called? If yes, then we should add it.
| it(`test from parser mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) | ||
| mpt_issuance_id: 'BAADF00DBAADF00DBAADF00DBAADF00DBAADF00DBAADF00D', | ||
| } | ||
| const mptIssue = Issue.from(mptJson) | ||
| const parser = new BinaryParser(mptIssue.toHex()) | ||
| const parserIssue = Issue.fromParser(parser, 24) | ||
| expect(parserIssue.toJSON()).toMatchObject(mptJson) | ||
| }) |
There was a problem hiding this comment.
@achowdhry-ripple this is a good catch. Hash192 doesn't have a hint parameter.
| @@ -39,20 +50,34 @@ class Issue extends SerializedType { | |||
| * | |||
| * @param value An Amount, object representing an IOU, or a string | |||
There was a problem hiding this comment.
| * @param value An Amount, object representing an IOU, or a string | |
| * @param value An Amount, object representing an IOU (or) MPTAmount, or a string |
| currency: string | ||
| issuer?: string | ||
| } | ||
| type IssueObject = XRPIssue | IOUIssue | MPTIssue | ||
|
|
||
| /** | ||
| * Type guard for AmountObject |
There was a problem hiding this comment.
| * Type guard for AmountObject | |
| * Type guard for Issue Object |
|
|
||
| it(`test from value mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) |
There was a problem hiding this comment.
Issue.from accepts both types in the input parameter.
static from<T extends Issue | IssueObject>(value: T): Issue
It should work either ways
| it(`test from parser mpt`, () => { | ||
| const mptJson = { | ||
| // value: '100', // MPT amounts must be an integer string (no decimal point) | ||
| mpt_issuance_id: 'BAADF00DBAADF00DBAADF00DBAADF00DBAADF00DBAADF00D', | ||
| } | ||
| const mptIssue = Issue.from(mptJson) | ||
| const parser = new BinaryParser(mptIssue.toHex()) | ||
| const parserIssue = Issue.fromParser(parser, 24) | ||
| expect(parserIssue.toJSON()).toMatchObject(mptJson) | ||
| }) |
There was a problem hiding this comment.
The hint parameter is not used in the Issue.from_parser method. Specifying a hint won't affect the output of the function. I suspect it has been retained for inheritance purposes.
High Level Overview of Change
Add MPTAmount support in the Issue object. Parallel to XRPLF/xrpl-py#809
Context of Change
Type of Change
Did you update HISTORY.md?
Test Plan