search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
68 stars 55 forks source link

feat: connector native minting cap #248

Closed skosito closed 2 months ago

skosito commented 2 months ago

closes #236

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes to the ZetaConnectorNonNative contract primarily focus on implementing a maximum supply mechanism for token minting. This enhancement includes the introduction of a maxSupply variable, an event for tracking updates, and error handling for oversupply scenarios. The modifications strengthen the contract's operational integrity, ensuring that any minting attempts exceeding the specified limit are effectively prevented and logged.

Changes

Files Change Summaries
contracts/prototypes/evm/ZetaConnectorNonNative.sol Introduced maxSupply variable; added MaxSupplyUpdated event and ExceedsMaxSupply error; implemented setMaxSupply function; modified withdrawal functions to check against maxSupply.
testFoundry/ZetaConnectorNonNative.t.sol Added tests for new maximum supply constraints, including scenarios for withdrawal failures when max supply is reached and asserting expected events/errors during these operations.
testFoundry/GatewayEVM.t.sol Allocated 1 ether to tssAddress in test setup to ensure sufficient balance for operations.
testFoundry/ZetaConnectorNative.t.sol Similar allocation of 1 ether to tssAddress in testMint function to prepare for minting operations.

Sequence Diagram(s)

sequenceDiagram
    participant TSS as Trusted Service Supplier
    participant Contract as ZetaConnectorNonNative
    participant User as User

    User->>TSS: Request minting
    TSS->>Contract: Check maxSupply
    alt Sufficient supply available
        Contract-->>TSS: Proceed with minting
        TSS-->>User: Tokens minted successfully
    else Max supply reached
        Contract-->>TSS: Revert with ExceedsMaxSupply
        TSS-->>User: Minting failed
    end

Assessment against linked issues

Objective Addressed Explanation
Implement safety mechanism for ZetaConnector v2 (#236) ✅
Minting cap ✅

🐇 In the meadow where bunnies play,
New limits on tokens brighten the day!
With max supply set, we hop with glee,
No more excess, just harmony!
Events will ring, and errors will cheer,
A safer contract, for all to revere! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 61.40%. Comparing base (9b5ff23) to head (9c33fdb).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #248 +/- ## ========================================== + Coverage 60.91% 61.40% +0.48% ========================================== Files 16 16 Lines 394 399 +5 Branches 103 106 +3 ========================================== + Hits 240 245 +5 Misses 154 154 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.