search

zeta-chain / protocol-contracts

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

feat: add zeta handling to v2 contracts #214

Closed skosito closed 4 months ago

skosito commented 4 months ago

implements specs for zeta handling

NOTE: unit tests and worker will be in follow up PR once unit test PR is merged and specs are approved

Qs:

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes enhance the functionality of various EVM-related smart contracts, focusing on the integration of Zeta token handling, improved connectors, and refined interfaces. These updates streamline token transfer processes, improve error management, and strengthen contract interactions. New tests and deployment scripts ensure robust functionality and seamless integration within the Ethereum Virtual Machine (EVM) landscape.

Changes

Files/Directories Change Summary
contracts/prototypes/evm/GatewayEVM.sol Added Zeta token and connector handling, modified initialization and token transfer logic, added new functions for transfer and connector setup.
contracts/prototypes/evm/GatewayEVMUpgradeTest.sol Enhanced with Zeta token interactions, deposit functions, and error handling.
contracts/prototypes/evm/ERC20CustodyNew.sol Updated import from interfaces.sol to IGatewayEVM.sol.
contracts/prototypes/evm/IGatewayEVM.sol Changed executeWithERC20 to a void function, removed event declarations.
contracts/prototypes/evm/ZetaConnectorNew.sol Introduced ZetaConnectorNew for ERC20 token transfers with withdrawal and calling functionalities.
contracts/prototypes/evm/ZetaConnectorNewBase.sol Introduced abstract base contract for token interactions with external gateway.
contracts/prototypes/evm/ZetaConnectorNewEth.sol Added ZetaConnectorNewEth contract with token withdrawal and transfer functionalities.
contracts/prototypes/evm/ZetaConnectorNewNonEth.sol Added contract for handling ERC20 tokens within the Zeta protocol.
contracts/prototypes/zevm/IGatewayZEVM.sol Modified Withdrawal event and added new errors for better Zeta token handling.
testFoundry/GatewayEVM.t.sol Added instances of TestERC20 and ZetaConnectorNewNonEth, modified proxy initialization to include Zeta token.
testFoundry/GatewayEVMUpgrade.t.sol Enhanced GatewayEVM initialization and setup with Zeta token and connector.
testFoundry/GatewayEVMZEVM.t.sol Added Zeta token and connector setup, modified initialization and event handling.
test/prototypes/GatewayEVMUniswap.spec.ts Added deployment and setup scripts for Zeta token and connectors, improved contract interactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GatewayEVM
    participant ZetaConnectorNewNonEth
    participant ZetaToken

    User ->> GatewayEVM: Initialize with ZetaToken and ZetaConnector
    GatewayEVM ->> ZetaConnectorNewNonEth: Set connector address
    User ->> GatewayEVM: Transfer tokens
    GatewayEVM ->> ZetaToken: Transfer tokens to custody
    GatewayEVM ->> ZetaConnectorNewNonEth: Transfer Zeta tokens

Poem

In the fields of code we play,
Tokens dance the Zeta way,
Connectors link and contracts call,
Solidity weaves a vibrant thrall.
With bytes and gas, our work is done,
EVM flows like rivers run.
🐇✨

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 4 months ago

Codecov Report

Attention: Patch coverage is 19.76744% with 69 lines in your changes missing coverage. Please review.

Project coverage is 47.52%. Comparing base (00b18ad) to head (1cc8ad5).

Files Patch % Lines
contracts/prototypes/evm/GatewayEVMUpgradeTest.sol 0.00% 32 Missing :warning:
contracts/prototypes/zevm/GatewayZEVM.sol 31.57% 13 Missing :warning:
contracts/prototypes/evm/GatewayEVM.sol 57.89% 8 Missing :warning:
contracts/prototypes/evm/ZetaConnectorNative.sol 0.00% 6 Missing :warning:
...ontracts/prototypes/evm/ZetaConnectorNonNative.sol 0.00% 6 Missing :warning:
contracts/prototypes/evm/ZetaConnectorNewBase.sol 0.00% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #214 +/- ## =========================================== - Coverage 58.29% 47.52% -10.78% =========================================== Files 11 14 +3 Lines 235 303 +68 Branches 61 82 +21 =========================================== + Hits 137 144 +7 - Misses 98 159 +61 ```

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

skosito commented 4 months ago

@lumtis @fbac i think all comments are addressed

@lumtis i added 2 implementations for connector (lock and mint versions), will add supply cap for non eth connector with this https://github.com/zeta-chain/protocol-contracts/issues/236 and unit tests in follow up PR