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: v2 contracts natspec #249

Closed skosito closed 2 months ago

skosito commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the clarity, documentation, and functionality of multiple Solidity contracts, focusing on improved error handling, detailed NatSpec comments, and new event definitions. These changes support better developer understanding and interaction with the contracts, particularly for cross-chain operations and token management. The introduction of new access control mechanisms and refined documentation ensures robust contract interactions while preserving core logic.

Changes

Files Change Summary
contracts/prototypes/evm/ERC20CustodyNew.sol, contracts/prototypes/evm/GatewayEVM.sol, contracts/prototypes/evm/GatewayEVMUpgradeTest.sol, contracts/prototypes/evm/IERC20CustodyNew.sol, contracts/prototypes/evm/IGatewayEVM.sol, contracts/prototypes/evm/ReceiverEVM.sol, contracts/prototypes/evm/ZetaConnectorNative.sol, contracts/prototypes/evm/ZetaConnectorNewBase.sol, contracts/prototypes/evm/ZetaConnectorNonNative.sol Enhanced documentation with detailed NatSpec comments; added error types and events; improved access control via new modifiers.
contracts/prototypes/zevm/GatewayZEVM.sol, contracts/prototypes/zevm/IGatewayZEVM.sol, contracts/prototypes/zevm/SenderZEVM.sol, contracts/prototypes/zevm/TestZContract.sol Expanded functionalities related to cross-chain interactions; introduced new events and functions; updated documentation for clarity and usability.
testFoundry/GatewayEVMUpgrade.t.sol, testFoundry/ZetaConnectorNonNative.t.sol Modified tests to reflect changes in functionality and error handling; removed irrelevant checks for maximum supply constraints.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Gateway
    participant TSS
    participant Contract

    User->>TSS: Initiates transaction
    TSS->>Gateway: Calls execute method
    Gateway->>Contract: Executes cross-chain call
    Contract-->>Gateway: Returns result
    Gateway-->>TSS: Returns response
    TSS-->>User: Notifies user of outcome

🐇 "In the fields where tokens play,
A rabbit hops with joy today!
New docs and functions, clear and bright,
Enhancing code, what a lovely sight!
With each change, we leap and cheer,
In the world of contracts, we hold dear!" 🐇✨

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

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 60.29%. Comparing base (0ba9959) to head (a3719f0).

Files Patch % Lines
contracts/prototypes/evm/GatewayEVMUpgradeTest.sol 0.00% 6 Missing :warning:
contracts/prototypes/evm/ERC20CustodyNew.sol 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #249 +/- ## ========================================== - Coverage 61.40% 60.29% -1.11% ========================================== Files 16 16 Lines 399 403 +4 Branches 106 108 +2 ========================================== - Hits 245 243 -2 - Misses 154 160 +6 ```

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