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: prototype inbound zevm #183

Closed skosito closed 3 months ago

skosito commented 3 months ago

Initializes GatewayZEVM and implements specs for inbound:


// simple withdraw of a ZRC20
function withdraw(address receiver, amount uint256, address zrc20)

// withdraw of a ZRC20 and calling a smart contract on external chain
function withdrawAndCall(address receiver, amount uint256, address zrc20, byte[] calldata message)

// calling a smart contract on external chain without asset transfer
function call(address receiver, byte[] calldata message)

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 changes introduce a more robust development workflow focused on Solidity smart contracts. They include configuration and workflow adjustments for efficient testing, linting, coverage reporting, automatic reviews, and publishing. Significant modifications include enhancements to GitHub Actions workflows, a smart contract for managing omnichain interactions, interface updates, and additions to supporting tools and configurations.

Changes

Files/Groups Summary
.coderabbit.yaml Added configuration instructions for code reviews
.github/workflows/coverage.yaml Introduced a GitHub Actions workflow for test coverage with Codecov uploads
.github/workflows/generated-files.yaml
.github/workflows/lint.yaml
.github/workflows/publish-npm.yaml
.github/workflows/semantic-pr.yaml
.github/workflows/test.yaml		 Adjusted workflow triggers and conditions
.gitignore Added entries for code coverage files
.solcover.js Added configuration for Solidity contract testing
contracts/prototypes/zevm/GatewayZEVM.sol
test/prototypes/GatewayZEVM.spec.ts
typechain-types/contracts/prototypes/index.ts
typechain-types/contracts/prototypes/zevm/GatewayZEVM.ts
typechain-types/contracts/prototypes/zevm/index.ts
typechain-types/factories/contracts/prototypes/zevm/GatewayZEVM__factory.ts
typechain-types/factories/contracts/prototypes/zevm/index.ts		 Introduced the GatewayZEVM contract, its tests, and related typechain & factory files
contracts/zevm/interfaces/IZRC20.sol
typechain-types/contracts/zevm/interfaces/IZRC20.ts		 Renamed PROTOCOL_FEE to PROTOCOL_FLAT_FEE and updated function signatures
docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md Updated documentation for renamed PROTOCOL_FEE function
hardhat.config.ts Added imports for solidity-coverage and hardhat-gas-reporter
package.json Updated dependencies, removed Node engine requirement, adjusted lint script
pkg/contracts/zevm/interfaces/izrc20.sol/izrc20.go
pkg/contracts/zevm/systemcontract.sol/systemcontract.go
pkg/contracts/zevm/testing/systemcontractmock.sol/systemcontractmock.go		 Updated ABI definitions and function signatures
scripts/generate_addresses_types.ts Improved type safety for mainnet and testnet array typing

🎉 Amid the code and logic's dance, A rabbit pranced, full of chance, With configs set and workflows tight, It brought the changes, day and night. Solidity sang, reviews in flight, In code, we found the future bright. 🐇✨

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.
codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 93.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 57.46%. Comparing base (b9e5bfd) to head (fe21cdc).

Files Patch % Lines
contracts/prototypes/zevm/GatewayZEVM.sol 90.47% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## init-prototypes #183 +/- ## =================================================== + Coverage 52.20% 57.46% +5.26% =================================================== Files 27 29 +2 Lines 908 938 +30 Branches 223 226 +3 =================================================== + Hits 474 539 +65 + Misses 434 399 -35 ```

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

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

Seems like the restricted path for @coderabbitai in the config doesn't work. It should not look at Go code

coderabbitai[bot] commented 3 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@lumtis, it appears that the current configuration does not explicitly exclude Go code from reviews. If you wish to prevent CodeRabbit from reviewing Go code, you can add a path filter in the .coderabbit.yaml configuration file to exclude Go files. For example, you could add !**/*.go to the path_filters section to exclude all Go files from being reviewed.

Here is how you could update the configuration:

reviews:
  path_filters:
    - "!**/*.go"  # Exclude all Go files

Adding this line will ensure that Go files are not included in the reviews. If you need further assistance with this configuration, please let me know!

Analysis chain @lumtis, I'll check the current configuration settings to understand why CodeRabbit is reviewing Go code despite the restrictions. I'll provide the details shortly.
Scripts executed The following scripts were executed for the analysis: --- > Debug Information Gathered