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: inbound evm prototype #178

Closed skosito closed 3 months ago

skosito commented 3 months ago

implements following spec and also moving current prototype sol files to evm folder, and renaming Gateway -> GatewayEVM so it is separated from zevm

// simple deposit of gas asset (ETH)
function deposit(address receiver) payable

// simple deposit of ERC20 asset, we use function overloading to keep same name
function deposit(address receiver, amount uint256, address asset)

// deposit of gas asset and calling omnichain smart contract
function depositAndCall(address receiver, byte[] calldata payload) payable

// deposit of ERC20 asset and calling omnichain smart contract
function depositAndCall(address receiver, amount uint256, asset address, byte[] calldata payload) payable

// calling a omnichain smart contract without asset transfer
function call(address receiver, byte[] calldata payload)

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Base branches to auto review (1) * main

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The updates introduce significant enhancements and renaming for better EVM-specific functionality. Key changes include rebranding Gateway to GatewayEVM, adding new error types and functions for ERC20 and ETH transfers, and modifying initialization processes. Contracts, tests, and TypeScript interfaces have been updated to align with these changes, ensuring a cohesive transition to the new functionality.

Changes

Files Change Summary
contracts/prototypes/evm/ERC20CustodyNew.sol Changed gateway variable type from IGateway to IGatewayEVM.
contracts/prototypes/evm/GatewayEVM.sol, contracts/prototypes/evm/GatewayEVMUpgradeTest.sol Renamed and enriched with new error types, events, functions for token and ETH transfers, and modified initialization.
test/prototypes/GatewayIntegration.spec.ts, test/prototypes/GatewayUpgrade.spec.ts Updated test suite names, added tssAddress, included new test cases for GatewayEVM, reviewed storage checks.
typechain-types/.../*.ts Introduced GatewayEVMInterface, reorganized exports under evm, created new factory class GatewayEVMUpgradeTest__factory.
typechain-types/hardhat.d.ts Renamed contract factories and instances to reflect EVM-specific names.

Poem

In the EVM world so grand,
We've made our contracts take a stand,
With GatewayEVM at the helm,
Tokens and ETH in a realm.
New functions glide, events do shine,
'Tis a coder's dream, divine!
Let's build and test, for now's the time.

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 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](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.
lumtis commented 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
skosito commented 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
skosito commented 3 months ago

Actions performed Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

they are all in generated files, none in solidity, so i resolved them, does it work on solidity files?

EDIT: actually there were comments in sol files, fixed and resolved

skosito commented 3 months ago

@lumtis @fadeev i updated PR description and whole PR with new interface, please recheck when you get a chance, thanks

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 56.81818% with 19 lines in your changes missing coverage. Please review.

Project coverage is 52.20%. Comparing base (cb0ca6c) to head (bc189a9).

Files Patch % Lines
contracts/prototypes/evm/GatewayEVMUpgradeTest.sol 0.00% 16 Missing :warning:
contracts/prototypes/evm/GatewayEVM.sol 88.88% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## init-prototypes #178 +/- ## =================================================== + Coverage 51.95% 52.20% +0.24% =================================================== Files 27 27 Lines 868 908 +40 Branches 175 223 +48 =================================================== + Hits 451 474 +23 - Misses 417 434 +17 ```

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