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: revert specs #217

Closed skosito closed 2 months ago

skosito commented 2 months ago

implements specs for revert

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

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This update introduces significant enhancements to the smart contract architecture, emphasizing security, functionality, and improved workflows. Key features include enhanced event logging, reentrancy protection, and streamlined token management through new contracts and interfaces. The changes also refine deployment processes and testing frameworks, fostering a more robust developer experience while effectively managing generated files within the codebase.

Changes

File(s) Change Summary
.gitattributes New file added to mark pkg and typechain-types directories as generated, improving repository management.
.github/workflows/publish-npm.yaml Enhanced workflow with submodule handling and new toolchain installation for Foundry, streamlining setup processes.
contracts/prototypes/evm/* Major updates to contracts, introducing new functions, events, and reentrancy protections; improvements to token handling.
contracts/prototypes/zevm/* Adjustments to contracts and interfaces for enhanced security and functionality; new events and struct definitions.
foundry.toml Minor formatting change to the evm_version setting.
readme.md New section added highlighting ongoing development of Version 2 enhancements.
scripts/worker.ts Updated event handling logic to reflect changes in the Withdrawal event signature.
test/* Various updates to testing contracts to accommodate new functionalities and modifications in contract interfaces.
slither.config.json Updated filter_paths to exclude new directories for Slither analysis.

Poem

In the patchwork of code, a rabbit hops,
With every new function, the old fear flops.
Events now dance like sunlit streams,
Reentrancy guarded, fulfilling dreams.
So let’s gather round, and cheer with delight,
For a future in code that shines ever 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 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 9.09091% with 20 lines in your changes missing coverage. Please review.

Project coverage is 47.13%. Comparing base (deee4d3) to head (78b292d).

Files Patch % Lines
contracts/prototypes/evm/GatewayEVM.sol 0.00% 8 Missing :warning:
contracts/prototypes/zevm/GatewayZEVM.sol 22.22% 7 Missing :warning:
contracts/prototypes/evm/ERC20CustodyNew.sol 0.00% 3 Missing :warning:
contracts/prototypes/zevm/TestZContract.sol 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## zeta-connector #217 +/- ## ================================================== - Coverage 50.16% 47.13% -3.04% ================================================== Files 12 12 Lines 295 314 +19 Branches 82 87 +5 ================================================== Hits 148 148 - Misses 147 166 +19 ```

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

skosito commented 2 months ago

@lumtis @fbac i think all comments are addressed

@fbac comments about rbac and checking erc20 contract are planned after we have basic implementations done, since they span all prototypes contracts, but these will be addressed soon: