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

feat!: create account if NFT recipient account does not exist #319

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

beer-1
Copy link
Contributor

@beer-1 beer-1 commented Dec 12, 2024

Description

This PR contains consensus breaking changes, so should be shipped with upgrade.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@beer-1 beer-1 requested a review from a team as a code owner December 12, 2024 07:22
Copy link

coderabbitai bot commented Dec 12, 2024

📝 Walkthrough

Walkthrough

The changes introduced in this pull request involve modifications to the NFT transfer functionality within the IBC module. Key updates include adjustments to the integration_test.go file for improved SDK type references and the addition of a new test case for NFT transfers involving non-existent accounts. The OnRecvPacket method in relay.go has been updated to ensure that a receiver's account is created if it does not exist. Additionally, new methods have been added to the AccountKeeper interface in expected_keeper.go to enhance account management capabilities.

Changes

File Path Change Summary
x/ibc/nft-transfer/keeper/integration_test.go Updated import statement for sdktypes to sdk. Modified receiver type in MintNft method. Added a new test case in TestSendAndReceive for transferring NFTs to non-existent accounts. Minor formatting adjustments.
x/ibc/nft-transfer/keeper/relay.go Modified OnRecvPacket method to create a receiver account if it does not exist, integrating this logic into existing flow.
x/ibc/nft-transfer/types/expected_keeper.go Added new methods to AccountKeeper interface: SetAccount, HasAccount, and NewAccountWithAddress. No changes to other interfaces.

Sequence Diagram(s)

sequenceDiagram
    participant Sender
    participant Receiver
    participant Keeper
    participant AccountKeeper

    Sender->>Keeper: Send NFT
    Keeper->>AccountKeeper: Check if Receiver account exists
    alt Account does not exist
        AccountKeeper-->>Keeper: Account does not exist
        Keeper->>AccountKeeper: Create new account for Receiver
        AccountKeeper-->>Keeper: Account created
    end
    Keeper->>Receiver: Transfer NFT
Loading

🐇 "In the realm of code, we hop and play,
With NFTs flying, come what may.
Accounts now spring to life with glee,
A joyful dance of code, you see!
So let’s celebrate, both near and far,
For every change, a shining star!" 🌟


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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

@beer-1 beer-1 changed the title feat!: create account if NFT recipient account is not existing feat!: create account if NFT recipient account does not exist Dec 12, 2024
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: 1

🧹 Outside diff range and nitpick comments (1)
x/ibc/nft-transfer/keeper/integration_test.go (1)

230-260: Enhance test coverage for non-existing account scenario

While the test case verifies basic functionality, consider adding these scenarios:

  1. Verify account properties after creation
  2. Test with multiple non-existing accounts
  3. Add error cases for account creation failures

Example enhancement:

 suite.Run("transfer A->B (non-existing account)", func() {
     {
         sender := pathA2B.EndpointA.Chain.SenderAccount.GetAddress()
 
         // random receiver account
         receiver := make(sdk.AccAddress, 20)
         _, err := rand.Read(receiver)
         suite.NoError(err)
 
         packet = suite.transferNft(
             pathA2B.EndpointA,
             pathA2B.EndpointB,
             targetClassId,
             nftId,
             sender.String(),
             receiver.String(),
         )
 
         targetClassId = suite.receiverNft(
             pathA2B.EndpointA,
             pathA2B.EndpointB,
             packet,
         )
 
         suite.ConfirmClassId(pathA2B.EndpointB, classId, targetClassId)
 
         // receiver account should be created
         suite.True(suite.chainB.App.GetAccountKeeper().HasAccount(suite.chainB.GetContext(), receiver))
+        // verify account properties
+        acc := suite.chainB.App.GetAccountKeeper().GetAccount(suite.chainB.GetContext(), receiver)
+        suite.NotNil(acc)
+        suite.Equal(receiver, acc.GetAddress())
     }
 })
 
+// Test multiple non-existing accounts
+suite.Run("transfer A->B (multiple non-existing accounts)", func() {
+    for i := 0; i < 3; i++ {
+        receiver := make(sdk.AccAddress, 20)
+        _, err := rand.Read(receiver)
+        suite.NoError(err)
+        
+        // Verify account doesn't exist
+        suite.False(suite.chainB.App.GetAccountKeeper().HasAccount(suite.chainB.GetContext(), receiver))
+        
+        // Perform transfer
+        packet = suite.transferNft(...)
+        
+        // Verify account was created
+        suite.True(suite.chainB.App.GetAccountKeeper().HasAccount(suite.chainB.GetContext(), receiver))
+    }
+})
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce46dbd and 45bab22.

📒 Files selected for processing (3)
  • x/ibc/nft-transfer/keeper/integration_test.go (3 hunks)
  • x/ibc/nft-transfer/keeper/relay.go (1 hunks)
  • x/ibc/nft-transfer/types/expected_keeper.go (1 hunks)
🔇 Additional comments (2)
x/ibc/nft-transfer/types/expected_keeper.go (1)

22-24: LGTM: Well-defined interface methods for account management

The new methods added to the AccountKeeper interface provide the necessary functionality for managing accounts in a clean and modular way.

x/ibc/nft-transfer/keeper/integration_test.go (1)

4-5: LGTM: Appropriate imports for functionality

The import changes are appropriate:

  • Using crypto/rand for secure random number generation
  • Consistent sdk alias usage

Also applies to: 9-9

x/ibc/nft-transfer/keeper/relay.go Show resolved Hide resolved
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.14%. Comparing base (103a58e) to head (45bab22).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #319   +/-   ##
=======================================
  Coverage   41.14%   41.14%           
=======================================
  Files         269      269           
  Lines       25699    25702    +3     
=======================================
+ Hits        10573    10576    +3     
  Misses      13488    13488           
  Partials     1638     1638           
Files with missing lines Coverage Δ
x/ibc/nft-transfer/keeper/relay.go 61.79% <100.00%> (+0.34%) ⬆️

Copy link
Contributor

@sh-cha sh-cha left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1 beer-1 merged commit c4b2bf7 into main Dec 16, 2024
12 checks passed
@beer-1 beer-1 deleted the feat/create-account-at-nft-receive branch December 16, 2024 06:09
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.

2 participants