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 Zero Address Checks in Constructors of IPAccountRegistry and IPAccountStorage Contracts #158

Conversation

kingster-will
Copy link

@kingster-will kingster-will commented Jun 4, 2024

Description

This PR includes changes that add zero address checks in the constructors of the IPAccountRegistry and IPAccountStorage contracts. These checks ensure that the contracts are initialized with valid addresses, preventing potential issues down the line.

Changes:

  1. Modified the constructor of the IPAccountRegistry contract to include a check for the erc6551Registry contract address. If the erc6551Registry contract address is zero, the constructor will revert and prevent the initialization of the contract.

  2. Modified the constructor of the IPAccountStorage contract to include checks for the ipAssetRegistry, licenseRegistry, and moduleRegistry addresses. If any of these addresses are zero, the constructor will revert and prevent the initialization of the contract.

Test Plan

Updated the unit tests to reflect these changes. The tests now cover scenarios where an attempt is made to initialize the IPAccountRegistry and IPAccountStorage contracts with zero addresses.

Summary by CodeRabbit

  • New Features

    • Improved error handling in contract constructors to ensure non-zero addresses for various registries.
  • Tests

    • Added tests to verify that constructors revert with appropriate errors when provided with zero addresses.

Copy link

coderabbitai bot commented Jun 4, 2024

Walkthrough

The recent changes enhance the robustness of the IPAccountStorage and IPAccountRegistry contracts by adding checks for zero addresses in their constructors. These checks ensure that critical registry addresses are not set to zero, preventing potential issues. Additionally, corresponding error messages have been added to the Errors library. New tests have been introduced to verify these changes, ensuring the constructors revert as expected when provided with zero addresses.

Changes

File Change Summary
contracts/IPAccountStorage.sol Added zero address checks in the constructor for ipAssetRegistry, licenseRegistry, and moduleRegistry.
contracts/lib/Errors.sol Added specific errors for zero addresses in IP Asset Registry, License Registry, Module Registry, and ERC6551 Registry.
contracts/registries/IPAccountRegistry.sol Added a zero address check in the constructor for erc6551Registry.
test/foundry/IPAccountStorage.t.sol Added tests for constructor revert conditions in IPAccountStorage with zero addresses.
test/foundry/registries/IPAccountRegistry.t.sol Added tests for constructor revert conditions in IPAccountRegistry with zero addresses and introduced a MockIPAccountRegistry contract.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Deployer
    participant IPAccountStorage
    participant Errors

    Deployer->>IPAccountStorage: Deploy with addresses
    IPAccountStorage->>IPAccountStorage: Check zero addresses
    alt Any address is zero
        IPAccountStorage->>Errors: Revert with specific error
    else All addresses valid
        IPAccountStorage->>IPAccountStorage: Set storage variables
    end
Loading
sequenceDiagram
    participant Deployer
    participant IPAccountRegistry
    participant Errors

    Deployer->>IPAccountRegistry: Deploy with erc6551Registry and ipAccountImpl
    IPAccountRegistry->>IPAccountRegistry: Check erc6551Registry address
    alt Address is zero
        IPAccountRegistry->>Errors: Revert with specific error
    else Address valid
        IPAccountRegistry->>IPAccountRegistry: Set storage variables
    end
Loading

Poem

In the world of code so bright,
Checks for zero, now in sight.
Constructors guard with utmost care,
No zero address shall slip in there.
Errors guide us, tests ensure,
Solidity’s path is safe and pure.
🌟🐇✨


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>.
    • 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 Configration 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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b2b1e82 and fbeba9a.

Files selected for processing (5)
  • contracts/IPAccountStorage.sol (1 hunks)
  • contracts/lib/Errors.sol (2 hunks)
  • contracts/registries/IPAccountRegistry.sol (1 hunks)
  • test/foundry/IPAccountStorage.t.sol (2 hunks)
  • test/foundry/registries/IPAccountRegistry.t.sol (2 hunks)
Additional comments not posted (6)
test/foundry/registries/IPAccountRegistry.t.sol (2)

7-7: Import statement and MockIPAccountRegistry contract definition look good.

Also applies to: 11-13


42-47: The constructor revert tests in test_IPAccountRegistry_constructor_revert are correctly implemented.

contracts/registries/IPAccountRegistry.sol (1)

28-28: The constructor now correctly handles zero addresses, enhancing contract robustness.

contracts/IPAccountStorage.sol (1)

37-39: The constructor now correctly handles zero addresses, enhancing contract robustness.

test/foundry/IPAccountStorage.t.sol (1)

239-246: The constructor revert tests in test_IPAccountStorage_constructor_revert are correctly implemented.

contracts/lib/Errors.sol (1)

Line range hint 41-62: New error definitions for zero addresses in Errors library are correctly defined and used.

Copy link

@Ramarti Ramarti left a comment

Choose a reason for hiding this comment

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

LGTM + Approved by auditors

@Ramarti Ramarti merged commit ae20c7d into storyprotocol:main Jun 27, 2024
3 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