feat: ERC20Custody and ZetaConnector uups upgradable

[skosito]

NOTE: will run yarn generate before merge to make review a bit easier

• custody and connectors upgradable since we will have to add some changes in v21
• commented out echidna tests with issue added to fix them, they are failing and out of scope of this work, currently not used at all

Summary by CodeRabbit

• New Features

  • Transitioned multiple contracts to be upgradeable, enhancing flexibility and security.
  • Introduced initialization functions for contract setup, replacing constructors.

• Bug Fixes

  • Improved contract upgrade authorization to ensure only designated roles can perform upgrades.

• Tests

  • Updated testing contracts to utilize UUPS proxies for better contract management.
  • Modified setup logic in tests to align with new proxy deployment mechanisms.
  • Added new events and tests to verify upgrade functionalities.

• Chores

  • Updated import paths for contracts to reflect new directory structures.

[codecov-commenter]

Codecov Report

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

Project coverage is 84.69%. Comparing base (cbbcf27) to head (8084b72). Report is 2 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #385 +/- ## ========================================== - Coverage 84.77% 84.69% -0.09% ========================================== Files 8 8 Lines 394 405 +11 Branches 134 134 ========================================== + Hits 334 343 +9 - Misses 60 62 +2 ```

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

[coderabbitai[bot]]

📝 Walkthrough

📝 Walkthrough

## Walkthrough The pull request introduces significant changes across multiple contracts to transition them from non-upgradeable to upgradeable architectures using OpenZeppelin's upgradeable contracts. Key modifications include replacing constructors with `initialize` functions, altering variable declarations from `immutable` to regular state variables, and adding internal functions for upgrade authorization. The deployment scripts have also been updated to support the new upgradeable structure, and several test contracts have been modified to reflect these changes. ## Changes | File Path | Change Summary | |---------------------------------------------|-------------------------------------------------------------------------------------------------| | v2/contracts/evm/ERC20Custody.sol | Transitioned to upgradeable contract; added `initialize` and `_authorizeUpgrade` functions; changed `gateway` to a regular state variable. | | v2/contracts/evm/ZetaConnectorBase.sol | Made upgradeable; added `initialize` and `_authorizeUpgrade` functions; changed `gateway` and `zetaToken` to regular state variables. | | v2/contracts/evm/ZetaConnectorNative.sol | Replaced constructor with `initialize` function; no logic changes. | | v2/contracts/evm/ZetaConnectorNonNative.sol| Replaced constructor with `initialize` function; integrated initialization logic for `maxSupply`. | | v2/scripts/deploy/deterministic/DeployERC20Custody.s.sol | Updated import path; altered deployment logic to use CREATE2 for proxy contracts. | | v2/scripts/deploy/deterministic/DeployGatewayEVM.s.sol | Updated import path; no logic changes. | | v2/scripts/deploy/deterministic/DeployZetaConnectorNonNative.s.sol | Updated import path; altered deployment logic to a two-step process involving proxy contracts. | | v2/scripts/deploy/deterministic/UpgradeGatewayEVM.s.sol | Updated import path; no logic changes. | | v2/test/ERC20Custody.t.sol | Updated to use UUPS proxies; modified test functions for new architecture. | | v2/test/GatewayEVM.t.sol | Updated to use UUPS proxies; modified `setUp` function for deployment. | | v2/test/GatewayEVMUpgrade.t.sol | Removed entire contract responsible for testing upgrade functionality. | | v2/test/GatewayEVMZEVM.t.sol | Updated initialization for multiple proxies; streamlined `setUp` function. | | v2/test/ZetaConnectorNative.t.sol | Updated to use UUPS proxies; modified `setUp` function. | | v2/test/ZetaConnectorNonNative.t.sol | Updated to use UUPS proxies; modified `setUp` function. | | v2/test/utils/upgrades/ERC20CustodyUpgradeTest.sol | Added new contract for testing ERC20Custody upgrades with various functionalities. | | v2/test/utils/upgrades/GatewayEVMUpgradeTest.sol | Modified import paths and event naming; added new event `ExecutedV2`. | | v2/test/utils/upgrades/GatewayZEVMUpgradeTest.sol | Introduced new contract for testing GatewayZEVM upgrades with initialization and event logging. | | v2/test/utils/upgrades/ZetaConnectorNativeUpgradeTest.sol | Added new contract for testing ZetaConnectorNative upgrades with initialization and withdrawal functions. | | v2/test/utils/upgrades/ZetaConnectorNonNativeUpgradeTest.sol | Added new contract for testing ZetaConnectorNonNative upgrades with initialization and event logging. | ## Possibly related PRs - **#162**: The `ERC20CustodyNew` contract introduces new withdrawal functions and an `initialize` method, which aligns with the changes made to the `ERC20Custody` contract in the main PR regarding upgradeability and initialization. - **#338**: The changes in the `ZRC20` contract regarding constructor access control and flexibility in deployment are relevant as they reflect similar upgradeability and initialization concerns addressed in the main PR. - **#352**: The updates to the `GatewayEVM` contract regarding access control and the introduction of new functions for managing addresses are related to the changes made in the main PR for the `ERC20Custody` contract. - **#363**: The addition of the `updateTSSAddress` function in the `ERC20Custody` and `GatewayEVM` contracts directly relates to the main PR's focus on enhancing contract functionality and security. - **#370**: The introduction of checks for gas limits in the `GatewayEVM` contract complements the main PR's focus on improving contract robustness and error handling. - **#376**: The implementation of payload size limits in the `GatewayEVM` contract aligns with the main PR's goal of enhancing contract functionality and security through better input validation. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - lumtis - 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://coderabbit.ai/docs) 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.

[skosito]

LGTM to me Maybe we can add a test for the upgrade for each contracts?

yes good point, will add, useful to see if some change in contract makes it non-upgradable (eg importing some 3rd party contract etc), i will add tests in this PR

[skosito]

LGTM to me Maybe we can add a test for the upgrade for each contracts?

@lumtis added