search

zeta-chain / protocol-contracts

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

chore: scripts for deploying implementation contracts #423

Closed lumtis closed 1 week ago

lumtis commented 4 weeks ago

Add scripts allowing to only deploy the implementation of the contract for the upgrade process

Summary by CodeRabbit

coderabbitai[bot] commented 4 weeks ago
📝 Walkthrough ## Walkthrough This pull request introduces three new Solidity smart contracts for deploying specific implementations using the CREATE2 opcode: `DeployERC20CustodyImplementation`, `DeployGatewayEVMImplementation`, and `DeployGatewayZEVMImplementation`. Each contract contains a `run` function that computes an expected implementation address based on a unique salt derived from a string identifier. The deployment process is managed within a transaction broadcast context, ensuring that the deployed addresses are validated against expected values. Additionally, the documentation has been updated to include deployment instructions for these new contracts, along with new upgrade simulation scripts for each contract. ## Changes | File Path | Change Summary | |------------------------------------------------------|------------------------------------------------------------------------------------------------| | `v2/scripts/deploy/deterministic/DeployERC20CustodyImplementation.s.sol` | Contract `DeployERC20CustodyImplementation` added with function `run()`. | | `v2/scripts/deploy/deterministic/DeployGatewayEVMImplementation.s.sol` | Contract `DeployGatewayEVM` added with function `run()`. | | `v2/scripts/deploy/deterministic/DeployGatewayZEVMImplementation.s.sol` | Contract `DeployGatewayZEVM` added with function `run()`. | | `v2/scripts/deploy/readme.md` | Documentation updated with deployment instructions for `GatewayEVM`, `ERC20Custody`, and `GatewayZEVM` implementations, including new function `upgradeToAndCall`. | | `v2/scripts/upgrade/SimulateERC20CustodyUpgrade.s.sol` | Contract `UpgradeSimulation` added to simulate the upgrade process for `ERC20Custody`. | | `v2/scripts/upgrade/SimulateGatewayEVMUpgrade.s.sol` | Contract `UpgradeSimulation` added to simulate the upgrade process for `GatewayEVM`. | | `v2/scripts/upgrade/SimulateGatewayZEVMUpgrade.s.sol` | Contract `UpgradeSimulation` added to simulate the upgrade process for `GatewayZEVM`. | | `v2/lib/types.ts` | Type `ParamSymbol` updated to remove `"tMATIC"` entry. | ## Possibly related PRs - **#368**: The changes in the `GatewayEVM` contract regarding the removal of the `_execute` function and the introduction of new deposit functionalities may relate to the deployment logic in the main PR, as both involve the `GatewayEVM` contract and its operational context. - **#408**: The `DeployGatewayEVM` contract in this PR is directly related to the main PR's focus on deploying the `ERC20Custody` contract, as both involve deployment scripts that utilize the CREATE2 opcode for contract creation. - **#419**: The modifications to the `DeployGatewayEVM` contract, including the use of a deployer address and the transfer of admin roles, are relevant as they enhance the deployment process, which is a core aspect of the main PR's changes to the `DeployERC20CustodyImplementation` contract. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - skosito - fbac

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) 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 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.06%. Comparing base (a91ef11) to head (3c7603e). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #423 +/- ## ========================================== - Coverage 84.27% 84.06% -0.22% ========================================== Files 8 8 Lines 388 389 +1 Branches 123 124 +1 ========================================== Hits 327 327 - Misses 61 62 +1 ```

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

🚨 Try these New Features: