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

fix: check for zero address in setConnected #47

Merged
merged 2 commits into from
Feb 5, 2025

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented Jan 30, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced address validation in setConnected functions for both NFT and Token core contracts
    • Added checks to prevent setting zero addresses in contract connections
  • Security

    • Improved error handling to prevent potential invalid address assignments

@fadeev fadeev requested a review from a team as a code owner January 30, 2025 15:40
Copy link

coderabbitai bot commented Jan 30, 2025

📝 Walkthrough

Walkthrough

The pull request introduces enhanced error handling in two similar contracts: UniversalNFTCore and UniversalTokenCore. Both contracts now include additional validation in their setConnected function to prevent setting connections with zero addresses. This modification adds a layer of security by ensuring that only valid, non-zero addresses can be used when establishing connections between different contract addresses and ZRC20 tokens.

Changes

File Change Summary
contracts/nft/contracts/zetachain/UniversalNFTCore.sol Added zero address checks in setConnected function, reverting with InvalidAddress error if zrc20 or contractAddress is a zero address
contracts/token/contracts/zetachain/UniversalTokenCore.sol Added zero address checks in setConnected function, reverting with InvalidAddress error; also confirmed onlyOwner modifier remains in place

Sequence Diagram

sequenceDiagram
    participant Caller
    participant UniversalContract
    participant AddressValidator

    Caller->>UniversalContract: setConnected(zrc20, contractAddress)
    UniversalContract->>AddressValidator: Validate zrc20
    AddressValidator-->>UniversalContract: Check if not zero address
    UniversalContract->>AddressValidator: Validate contractAddress
    AddressValidator-->>UniversalContract: Check if not zero address
    alt Addresses are valid
        UniversalContract->>UniversalContract: Set connection
    else Invalid Address
        UniversalContract-->>Caller: Revert with InvalidAddress error
    end
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
🪧 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.

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 (2)
contracts/token/contracts/zetachain/UniversalTokenCore.sol (1)

105-106: LGTM! Consider combining the checks for better gas efficiency.

The zero address validation is correctly implemented for both parameters. However, we can optimize gas usage by combining the checks.

-        if (zrc20 == address(0)) revert InvalidAddress();
-        if (contractAddress == address(0)) revert InvalidAddress();
+        if (zrc20 == address(0) || contractAddress == address(0)) revert InvalidAddress();
contracts/nft/contracts/zetachain/UniversalNFTCore.sol (1)

107-108: Apply the same optimization as in UniversalTokenCore.

For consistency with UniversalTokenCore and better gas efficiency, combine the zero address checks.

-        if (zrc20 == address(0)) revert InvalidAddress();
-        if (contractAddress == address(0)) revert InvalidAddress();
+        if (zrc20 == address(0) || contractAddress == address(0)) revert InvalidAddress();
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9b99ad6 and 2c95dfc.

📒 Files selected for processing (2)
  • contracts/nft/contracts/zetachain/UniversalNFTCore.sol (1 hunks)
  • contracts/token/contracts/zetachain/UniversalTokenCore.sol (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: test (contracts/token)
  • GitHub Check: test (contracts/nft)
  • GitHub Check: slither (contracts/token, token.sarif)
  • GitHub Check: slither (contracts/nft, nft.sarif)

@fadeev fadeev merged commit 32d34c7 into main Feb 5, 2025
10 checks passed
@fadeev fadeev deleted the fix-set-connected-invalid-address branch February 5, 2025 11:31
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