Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more unit test for DynamicNFT #2892

Merged
merged 2 commits into from
Feb 5, 2025
Merged

Conversation

yinyiqian1
Copy link
Collaborator

High Level Overview of Change

This is related to the PR: #2726

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 HISTORY.md?

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

Test Plan

Copy link

coderabbitai bot commented Feb 3, 2025

Walkthrough

This pull request updates release notes for the NFTokenModify transaction by adding references to the XLS-46 amendment in both the ripple-binary-codec and xrpl packages. Additionally, it introduces a new utility function convertTxFlagsToNumber, replacing the deprecated setTransactionFlagsToNumber in the xrpl package. Changes to the NFTokenModify model clarify the expected handling of the URI field, and new tests ensure proper validation of this field.

Changes

Files Summary
packages/ripple-binary-codec/HISTORY.md, packages/xrpl/HISTORY.md Updated release notes for NFTokenModify to reference XLS-46; added convertTxFlagsToNumber and deprecated setTransactionFlagsToNumber in xrpl/HISTORY.md.
packages/xrpl/src/models/transactions/NFTokenModify.ts Updated the URI field in the NFTokenModify interface from undefined to null if unused; adjusted validation comments accordingly.
packages/xrpl/test/models/NFTokenModify.test.ts Added new test cases to verify that errors are thrown when the URI is an empty string or not in hex format.

Possibly related PRs

  • support DynamicNFT #2726: The changes in the main PR regarding the NFTokenModify transaction and its handling are directly related to the modifications in this retrieved PR, which also includes the addition of the NFTokenModify transaction and the tfMutable flag in the HISTORY.md file.
  • 4.1.0 release #2851: The changes in the main PR regarding the HISTORY.md file for the ripple-binary-codec package and the updates in this retrieved PR for the xrpl package's HISTORY.md file both document the addition of support for the DynamicNFT amendment (XLS-46).

Suggested reviewers

  • mvadari
  • achowdhry-ripple
  • khancode

Poem

I'm a rabbit, hopping through lines of code,
Discovering changes down every digital road.
XLS-46 shines bright in the release note light,
Validations and tests make our code just right.
With a skip and a hop, I celebrate each fix —
Enjoying these updates with a twitch and quick clicks! 🐇✨

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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
🪧 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. (Beta)
  • @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.

@yinyiqian1 yinyiqian1 mentioned this pull request Feb 3, 2025
8 tasks
Copy link
Collaborator

@pdp2121 pdp2121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@achowdhry-ripple achowdhry-ripple left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor wording change to match convention we use for all amendments (just reference the amendment, leave details out of history doc). Otherwise LGTM!

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
packages/xrpl/HISTORY.md (3)

7-9: Utility Function Addition – convertTxFlagsToNumber

A new utility function is added on lines 7–9 that simplifies transaction flag conversion. This addition is clear and helps modernize the API. Please ensure that corresponding documentation (and unit tests in other files) adequately cover its behavior and edge cases.


10-11: Deprecation Notice for setTransactionFlagsToNumber

The changelog now marks setTransactionFlagsToNumber as deprecated on lines 10–11, advising users to switch to convertTxFlagsToNumber. This is well documented here; however, please verify that all related documentation and any in-code references in the codebase are updated accordingly.


15-21: DynamicNFT Amendment Support Addition

In the 4.1.0 release notes (lines 15–21), a new entry on line 20 indicates support for the DynamicNFT amendment (XLS-46). This update is in line with the broader effort to enhance NFT-related functionality. It would be helpful to include a reference or link to further documentation or the related PR (if available) so that users can quickly understand the implications of this amendment.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d1a5e86 and 57dc6cf.

📒 Files selected for processing (2)
  • packages/ripple-binary-codec/HISTORY.md (1 hunks)
  • packages/xrpl/HISTORY.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/ripple-binary-codec/HISTORY.md
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: snippets (22.x)
  • GitHub Check: unit (22.x)
  • GitHub Check: snippets (20.x)
  • GitHub Check: unit (20.x)
  • GitHub Check: integration (22.x)
  • GitHub Check: snippets (18.x)
  • GitHub Check: unit (18.x)
  • GitHub Check: integration (20.x)
  • GitHub Check: browser (18.x)
  • GitHub Check: integration (18.x)
  • GitHub Check: build-and-lint (18.x)
  • GitHub Check: Analyze (javascript)

@yinyiqian1 yinyiqian1 merged commit 991a1d2 into XRPLF:main Feb 5, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants