coderabbitai[bot]
commented
1 month ago 📝 Walkthrough
📝 Walkthrough
## Walkthrough This pull request includes modifications to several contracts and test files within the ZetaChain protocol. Key changes involve the removal of the `internalSendHash` parameter from the `withdraw`, `withdrawAndCall`, and `withdrawAndRevert` functions in the `ZetaConnectorNative` contract. Additionally, new test functions and event updates are introduced across various test contracts to enhance coverage and ensure proper functionality, particularly in relation to withdrawal operations. The overall structure and logic of the contracts remain unchanged despite these adjustments. ## Changes | File Path | Change Summary | |---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | v2/contracts/evm/ZetaConnectorNative.sol | Updated method signatures for `withdraw`, `withdrawAndCall`, and `withdrawAndRevert` to comment out `internalSendHash`. | | v2/test/ERC20Custody.t.sol | Added `testUpgradeAndWithdraw` method to test upgrade process and withdrawal functionality; enhanced role management checks; refined existing tests. | | v2/test/GatewayZEVM.t.sol | Added `WithdrawnV2` event; updated `testWithdrawZRC20` and related functions to include new event and additional failure checks. | | v2/test/ZRC20.t.sol | Added checks for gas fee withdrawal; ensured comprehensive coverage of `ZRC20` functionalities and constraints. | | v2/test/fuzz/ERC20CustodyEchidnaTest.sol | Introduced `ERC20CustodyEchidnaTest` contract; added `testWithdrawAndCall` method to test withdrawal functionality. | | v2/test/fuzz/GatewayEVMEchidnaTest.sol | Introduced `GatewayEVMEchidnaTest` contract; added `testExecuteWithERC20` method to test ERC20 token execution. | | v2/test/utils/ReceiverEVM.sol | Updated `onCall` function to remove parameter names; added return statement. | | v2/test/utils/SenderZEVM.sol | Added `CallOptions` structure; updated `callReceiver` and `withdrawAndCallReceiver` functions to use `CallOptions`. | | v2/test/utils/TestUniversalContract.sol | Updated `onCall` function to comment out parameter names while retaining their types. | | v2/test/utils/upgrades/ZetaConnectorNativeUpgradeTest.sol | Renamed `Withdrawn` event to `WithdrawnV2`; updated withdrawal function signatures to comment out `internalSendHash`. | ## Possibly related issues - **zeta-chain/protocol-contracts#307**: This PR addresses the objective of adding `CallOptions` containing a gas limit for `call` and `withdrawAndCall` functions, which relates to the changes in the `SenderZEVM` contract. ## Possibly related PRs - **#178**: The changes in the `GatewayEVM` and `ERC20Custody` contracts regarding the handling of various functions and roles are related to the modifications in the `ZetaConnectorNative` contract, particularly in the context of managing withdrawal functionalities and role assignments. - **#361**: The addition of the `sender` field in the `RevertContext` struct enhances the context during revert operations, which aligns with the changes in the `GatewayEVM` contract that also focus on improving error handling and context management. - **#370**: The introduction of checks to prevent zero gas limits in the `GatewayEVM` contract is directly related to the changes in the main PR, which also involve modifications to the `withdrawAndCall` and `call` functions. - **#376**: The enforcement of payload size limits in the `GatewayEVM` contract is relevant to the main PR's focus on improving the robustness of contract interactions, particularly in the context of withdrawal and call functions. - **#385**: The transition of the `ERC20Custody` and `ZetaConnector` contracts to upgradeable contracts is related to the main PR's focus on enhancing the functionality and management of these contracts, particularly in the context of role assignments and initialization. - **#386**: The addition of the `PAUSER_ROLE` to the TSS address in the `ERC20Custody` and `GatewayEVM` contracts is relevant to the main PR's focus on role management and enhancing control mechanisms within the contracts. - **#393**: The refactoring to disable ZETA-related functions and the removal of outdated methods aligns with the main PR's focus on streamlining the codebase and improving the overall functionality of the contracts. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - fbacThank 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?
codecov-commenter
Mainly comment out unused parameter or variables
NOTE: the test failure should be fixed once https://github.com/zeta-chain/protocol-contracts/pull/393 is merged
Summary by CodeRabbit
Release Notes
New Features
WithdrawnV2for enhanced tracking of withdrawal operations.ERC20Custodycontract, ensuring functionality post-upgrade.ZRC20andZETAtoken withdrawal functionalities.Echidna, improving testing capabilities.Bug Fixes
Refactor
Tests
GatewayEVMandERC20Custodyfunctionalities, improving overall robustness.