feat: add tag logic

[andresaiello]

Summary

• Add tags and validations to NFT

Summary by CodeRabbit

• New Features

  • Introduced a mapping for associating user addresses with their NFT tags, enhancing token management.
  • Added a new error handling mechanism to prevent users from minting NFTs with tags they already own.

• Bug Fixes

  • Implemented checks to ensure the minting process reverts if a user attempts to mint an NFT with an already held tag.

• Tests

  • Added test cases to verify tag ownership restrictions and NFT queries by tag and user, improving contract functionality validation.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates to the ZetaXP smart contract significantly enhance NFT management by allowing user-specific tagging of NFTs. A new mapping links user addresses to their tags and token IDs, facilitating efficient tracking. Additionally, the contract introduces error handling to prevent users from minting or updating NFTs with tags they already hold. These improvements optimize user experience and enforce stricter tagging rules within the NFT ecosystem.

Changes

File	Change Summary
packages/zevm-app-contracts/contracts/xp-nft/xpNFT.sol	Added mapping for user tags and token IDs; introduced TagAlreadyHoldByUser error for minting and updating NFTs.
packages/zevm-app-contracts/test/xp-nft/xp-nft.ts	Added tests for tag-related minting restrictions and querying NFTs by user and tag.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ZetaXPContract as Contract

    User->>Contract: Mint NFT with tag
    alt Tag already held
        Contract-->>User: Revert with TagAlreadyHoldByUser error
    else Tag not held
        Contract-->>User: Mint successful
    end

    User->>Contract: Update NFT with tag
    alt Tag already held
        Contract-->>User: Revert with TagAlreadyHoldByUser error
    else Tag not held
        Contract-->>User: Update successful
    end

    User->>Contract: Query NFTs by tag
    Contract-->>User: Return NFTs associated with tag

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9ef6dba and f0eea82.

Files selected for processing (2)

• packages/zevm-app-contracts/contracts/xp-nft/xpNFT.sol (4 hunks)
• packages/zevm-app-contracts/test/xp-nft/xp-nft.ts (2 hunks)

Additional comments not posted (6)

packages/zevm-app-contracts/contracts/xp-nft/xpNFT.sol (4)

26-26: Mapping tokenByUserTag is well-implemented.

The addition of tokenByUserTag efficiently tracks tokens associated with specific tags for each user, aligning with the PR objectives.

---

44-44: Error TagAlreadyHoldByUser is appropriately introduced.

The error ensures that users cannot mint or update NFTs with tags they already hold, maintaining data integrity.

---

136-136: mintNFT function correctly enforces unique tags.

The check for existing tags before minting ensures that users cannot hold multiple tokens with the same tag.

---

148-148: updateNFT function correctly validates tag ownership.

The function ensures that only tokens with the correct tag can be updated, preventing unauthorized changes.

packages/zevm-app-contracts/test/xp-nft/xp-nft.ts (2)

258-293: Test case for tag uniqueness is well-implemented.

The test ensures that the contract correctly reverts when a user tries to mint an NFT with a tag they already hold.

---

295-316: Test case for querying by tag and user is well-implemented.

The test confirms that NFTs are correctly associated with their tags and users, validating the tokenByUserTag mapping.

[GMaiolo]

utACK