feat: revert specs #217
feat: revert specs #217
Conversation
Co-authored-by: lumtis <lucas.bertrand.22@gmail.com>
Co-authored-by: lumtis <lucas.bertrand.22@gmail.com>
Co-authored-by: lumtis <lucas.bertrand.22@gmail.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ 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 ☔ View full report in Codecov by Sentry. |
| @@ -7,6 +7,13 @@ struct zContext { | |||
| uint256 chainID; | |||
| } | |||
|
|
|||
| // TODO: define revertContext | |||
There was a problem hiding this comment.
It's not planned for this PR? Would need issue otherwise
There was a problem hiding this comment.
it is same as zContext atm, was not sure if this information is enough, or we should wait for integration with zetacore to see if we need more info (this applies to zContext as well)
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (8)
testFoundry/GatewayEVM.t.sol (8)
10-10: Add documentation for new imports.Consider adding comments to explain the purpose of the new imports.
15-16: Group related imports together.The imports for
IGatewayEVMandIReceiverEVMshould be grouped with the other interface imports for consistency.-import "contracts/prototypes/evm/IGatewayEVM.sol"; -import "contracts/prototypes/evm/IReceiverEVM.sol";
26-28: Add comments for new state variables.Consider adding comments to explain the purpose of the new state variables
zetaConnectorandzeta.+ // Connector for non-native Zeta interactions + ZetaConnectorNonNative zetaConnector; + // ERC20 token for Zeta + TestERC20 zeta;
42-43: Add comments for token initialization.Consider adding comments to explain the initialization of the
zetatoken.+ // Initialize Zeta token zeta = new TestERC20("zeta", "ZETA");
50-50: Add comments for connector initialization.Consider adding comments to explain the initialization of the
zetaConnector.+ // Initialize ZetaConnectorNonNative with gateway and zeta token addresses zetaConnector = new ZetaConnectorNonNative(address(gateway), address(zeta));
184-186: Add comments for new state variables.Consider adding comments to explain the purpose of the new state variables
zetaConnectorandzeta.+ // Connector for non-native Zeta interactions + ZetaConnectorNonNative zetaConnector; + // ERC20 token for Zeta + TestERC20 zeta;
199-200: Add comments for token initialization.Consider adding comments to explain the initialization of the
zetatoken.+ // Initialize Zeta token zeta = new TestERC20("zeta", "ZETA");
206-206: Add comments for connector initialization.Consider adding comments to explain the initialization of the
zetaConnector.+ // Initialize ZetaConnectorNonNative with gateway and zeta token addresses zetaConnector = new ZetaConnectorNonNative(address(gateway), address(zeta));
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (103)
pkg/contracts/prototypes/evm/erc20custodynew.sol/erc20custodynew.gois excluded by!pkg/**pkg/contracts/prototypes/evm/gatewayevm.sol/gatewayevm.gois excluded by!pkg/**pkg/contracts/prototypes/evm/gatewayevmupgradetest.sol/gatewayevmupgradetest.gois excluded by!pkg/**pkg/contracts/prototypes/evm/igatewayevm.sol/igatewayevm.gois excluded by!pkg/**pkg/contracts/prototypes/evm/igatewayevm.sol/igatewayevmerrors.gois excluded by!pkg/**pkg/contracts/prototypes/evm/igatewayevm.sol/igatewayevmevents.gois excluded by!pkg/**pkg/contracts/prototypes/evm/igatewayevm.sol/revertable.gois excluded by!pkg/**pkg/contracts/prototypes/evm/ireceiverevm.sol/ireceiverevmevents.gois excluded by!pkg/**pkg/contracts/prototypes/evm/izetanonethnew.sol/izetanonethnew.gois excluded by!pkg/**pkg/contracts/prototypes/evm/zetaconnectornative.sol/zetaconnectornative.gois excluded by!pkg/**pkg/contracts/prototypes/evm/zetaconnectornewbase.sol/zetaconnectornewbase.gois excluded by!pkg/**pkg/contracts/prototypes/evm/zetaconnectornonnative.sol/zetaconnectornonnative.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/gatewayzevm.sol/gatewayzevm.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/igatewayzevm.sol/igatewayzevm.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/igatewayzevm.sol/igatewayzevmerrors.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/igatewayzevm.sol/igatewayzevmevents.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/senderzevm.sol/senderzevm.gois excluded by!pkg/**pkg/contracts/prototypes/zevm/testzcontract.sol/testzcontract.gois excluded by!pkg/**pkg/contracts/zevm/interfaces/zcontract.sol/universalcontract.gois excluded by!pkg/**pkg/contracts/zevm/systemcontract.sol/systemcontract.gois excluded by!pkg/**pkg/contracts/zevm/testing/systemcontractmock.sol/systemcontractmock.gois excluded by!pkg/**pkg/openzeppelin/contracts-upgradeable/security/reentrancyguardupgradeable.sol/reentrancyguardupgradeable.gois excluded by!pkg/**typechain-types/@openzeppelin/contracts-upgradeable/index.tsis excluded by!typechain-types/**typechain-types/@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.tsis excluded by!typechain-types/**typechain-types/@openzeppelin/contracts-upgradeable/security/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/ERC20CustodyNew.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/GatewayEVM.sol/GatewayEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/GatewayEVM.sol/Revertable.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/GatewayEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/GatewayEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/GatewayEVMUpgradeTest.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVMErrors.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVMEvents.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IGatewayEVM.sol/Revertable.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IGatewayEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IReceiverEVM.sol/IReceiverEVMEvents.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IReceiverEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/IZetaNonEthNew.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/ZetaConnectorNative.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/ZetaConnectorNew.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/ZetaConnectorNewBase.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/ZetaConnectorNonNative.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/interfaces.sol/IGatewayEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/evm/interfaces.sol/IGatewayEVMEvents.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/test/GatewayEVM.t.sol/GatewayEVMTest.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/test/GatewayEVMZEVM.t.sol/GatewayEVMZEVMTest.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/GatewayZEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVM.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVMErrors.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVMEvents.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/IGatewayZEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/TestZContract.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/index.tsis excluded by!typechain-types/**typechain-types/contracts/prototypes/zevm/interfaces.sol/IGatewayZEVMEvents.tsis excluded by!typechain-types/**typechain-types/contracts/zevm/interfaces/index.tsis excluded by!typechain-types/**typechain-types/contracts/zevm/interfaces/zContract.sol/UniversalContract.tsis excluded by!typechain-types/**typechain-types/contracts/zevm/interfaces/zContract.sol/ZContract.tsis excluded by!typechain-types/**typechain-types/contracts/zevm/interfaces/zContract.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/@openzeppelin/contracts-upgradeable/index.tsis excluded by!typechain-types/**typechain-types/factories/@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable__factory.tsis excluded by!typechain-types/**typechain-types/factories/@openzeppelin/contracts-upgradeable/security/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/ERC20CustodyNew__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/GatewayEVM.sol/GatewayEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/GatewayEVM.sol/Revertable__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/GatewayEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/GatewayEVMUpgradeTest__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/GatewayEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVMErrors__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVMEvents__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IGatewayEVM.sol/IGatewayEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IGatewayEVM.sol/Revertable__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IGatewayEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IReceiverEVM.sol/IReceiverEVMEvents__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IReceiverEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/IZetaNonEthNew__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/ZetaConnectorNative__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/ZetaConnectorNewBase__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/ZetaConnectorNonNative__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/interfaces.sol/IGatewayEVMEvents__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/interfaces.sol/IGatewayEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/test/GatewayEVM.t.sol/GatewayEVMTest__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/test/GatewayEVMZEVM.t.sol/GatewayEVMZEVMTest__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/GatewayZEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVMErrors__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVMEvents__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/IGatewayZEVM.sol/IGatewayZEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/IGatewayZEVM.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/SenderZEVM__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/TestZContract__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/interfaces.sol/IGatewayZEVMErrors__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/zevm/interfaces.sol/IGatewayZEVMEvents__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/SystemContract.sol/SystemContract__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/interfaces/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/interfaces/zContract.sol/UniversalContract__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/interfaces/zContract.sol/ZContract__factory.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/interfaces/zContract.sol/index.tsis excluded by!typechain-types/**typechain-types/factories/contracts/zevm/testing/SystemContractMock.sol/SystemContractMock__factory.tsis excluded by!typechain-types/**typechain-types/hardhat.d.tsis excluded by!typechain-types/**typechain-types/index.tsis excluded by!typechain-types/**
Files selected for processing (27)
- .gitattributes (1 hunks)
- .github/workflows/publish-npm.yaml (1 hunks)
- contracts/prototypes/evm/ERC20CustodyNew.sol (3 hunks)
- contracts/prototypes/evm/GatewayEVM.sol (7 hunks)
- contracts/prototypes/evm/GatewayEVMUpgradeTest.sol (2 hunks)
- contracts/prototypes/evm/IGatewayEVM.sol (2 hunks)
- contracts/prototypes/evm/IReceiverEVM.sol (1 hunks)
- contracts/prototypes/evm/IZetaNonEthNew.sol (1 hunks)
- contracts/prototypes/evm/ZetaConnectorNative.sol (1 hunks)
- contracts/prototypes/evm/ZetaConnectorNewBase.sol (1 hunks)
- contracts/prototypes/evm/ZetaConnectorNonNative.sol (1 hunks)
- contracts/prototypes/zevm/GatewayZEVM.sol (4 hunks)
- contracts/prototypes/zevm/IGatewayZEVM.sol (2 hunks)
- contracts/prototypes/zevm/SenderZEVM.sol (1 hunks)
- contracts/prototypes/zevm/TestZContract.sol (2 hunks)
- contracts/zevm/interfaces/zContract.sol (2 hunks)
- foundry.toml (1 hunks)
- readme.md (1 hunks)
- scripts/worker.ts (1 hunks)
- slither.config.json (1 hunks)
- test/fuzz/ERC20CustodyNewEchidnaTest.sol (1 hunks)
- test/fuzz/GatewayEVMEchidnaTest.sol (1 hunks)
- test/prototypes/GatewayEVMUniswap.spec.ts (1 hunks)
- testFoundry/GatewayEVM.t.sol (6 hunks)
- testFoundry/GatewayEVMUpgrade.t.sol (3 hunks)
- testFoundry/GatewayEVMZEVM.t.sol (5 hunks)
- testFoundry/GatewayZEVM.t.sol (3 hunks)
Files skipped from review due to trivial changes (2)
- .gitattributes
- foundry.toml
Additional context used
Path-based instructions (18)
contracts/prototypes/evm/IZetaNonEthNew.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/IReceiverEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/zevm/interfaces/zContract.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.test/fuzz/GatewayEVMEchidnaTest.sol (1)
Pattern
test/**: Review the test files for proper coverage, edge cases, and best practices.contracts/prototypes/zevm/TestZContract.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/ZetaConnectorNewBase.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/zevm/SenderZEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/zevm/IGatewayZEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/IGatewayEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/ZetaConnectorNonNative.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.test/fuzz/ERC20CustodyNewEchidnaTest.sol (1)
Pattern
test/**: Review the test files for proper coverage, edge cases, and best practices.contracts/prototypes/evm/ZetaConnectorNative.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/ERC20CustodyNew.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.test/prototypes/GatewayEVMUniswap.spec.ts (1)
Pattern
test/**: Review the test files for proper coverage, edge cases, and best practices.scripts/worker.ts (1)
Pattern
scripts/**: Review the Hardhat scripts for best practices.contracts/prototypes/zevm/GatewayZEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/GatewayEVM.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.contracts/prototypes/evm/GatewayEVMUpgradeTest.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.
Additional comments not posted (88)
slither.config.json (1)
3-3: Confirm the intention behind excludingcontracts/evmandcontracts/zevm.The addition of these paths to
filter_pathswill exclude them from Slither's analysis. Ensure this exclusion is intentional and doesn't omit critical security checks.contracts/prototypes/evm/IZetaNonEthNew.sol (1)
1-13: Ensure thorough testing ofburnFromandmintfunctions.The
burnFromandmintfunctions should be thoroughly tested to ensure they handle edge cases and adhere to security best practices, such as preventing unauthorized minting or burning.contracts/prototypes/evm/IReceiverEVM.sol (1)
1-9: Ensure event parameters are well-documented and tested.The events defined in the interface should have clear documentation for each parameter. Ensure that these events are thoroughly tested to verify that they are emitted correctly in all relevant scenarios.
contracts/zevm/interfaces/zContract.sol (3)
11-15: LGTM! New structrevertContextis well-defined.The new struct follows a clear and consistent pattern.
35-40: LGTM! New functiononRevertis well-defined.The function signature is consistent and follows the existing pattern.
27-32: LGTM! New functiononCrossChainCallis well-defined.The function signature is consistent and follows the existing pattern.
.github/workflows/publish-npm.yaml (2)
14-15: LGTM! The new step for handling submodules is well-defined.Including
submodules: recursiveensures that any submodules are also checked out during the repository cloning process.
23-25: LGTM! The new step for installing the Foundry toolchain is well-defined.This step is crucial for projects that depend on the Foundry toolchain, allowing for a more streamlined setup of the development environment.
contracts/prototypes/zevm/TestZContract.sol (3)
7-7: Ensure compatibility withUniversalContract.The class now inherits from
UniversalContractinstead ofzContract. Verify thatUniversalContractprovides the necessary functionality and does not introduce breaking changes.
16-20: Improved handling ofmessageparameter.The function now includes a conditional check for the
messageparameter, ensuring it is only decoded if it contains data. This prevents potential errors and improves robustness.
29-32: Improved handling ofmessageparameter.The function now includes a conditional check for the
messageparameter, ensuring it is only decoded if it contains data. This prevents potential errors and improves robustness.contracts/prototypes/evm/ZetaConnectorNewBase.sol (3)
14-15: Ensure proper initialization of immutable variables.The contract declares
gatewayandzetaTokenas immutable variables. Verify that these variables are correctly initialized in the constructor.
20-26: Check for zero address in constructor.The constructor includes a check to ensure that neither
_gatewaynor_zetaTokenare zero addresses. This is a good practice to prevent errors related to invalid addresses.
28-32: Implement abstract functions in derived contracts.The contract declares three abstract functions:
withdraw,withdrawAndCall, andreceiveTokens. Ensure that these functions are implemented in derived contracts.contracts/prototypes/zevm/SenderZEVM.sol (1)
5-5: Verify new interface dependency.The import statement has been changed from
interfaces.soltoIGatewayZEVM.sol. Ensure that the new interface provides the necessary functionality and does not introduce breaking changes.contracts/prototypes/zevm/IGatewayZEVM.sol (2)
49-49: LGTM! The new error enhances error handling capabilities.The addition of
FailedZetaSentimproves the precision of error feedback.
38-38: Verify the impact of the updatedWithdrawalevent signature.The
Withdrawalevent signature has been updated to include an additional parameteraddress zrc20. Ensure that all code listening for this event is updated accordingly.contracts/prototypes/evm/IGatewayEVM.sol (3)
41-43: LGTM! The new function enhances error handling and state recovery.The addition of
onRevertimproves the contract's capability to manage error handling and state recovery.
29-39: Verify the impact of the modifiedexecuteWithERC20function signature and the newrevertWithERC20function.The
executeWithERC20function signature has been modified to remove its return type. Ensure that all calls to this function handle the lack of return data appropriately. Additionally, verify the usage of the newrevertWithERC20function in the codebase.
6-8: Verify the impact of the newRevertedandRevertedWithERC20events.The new events
RevertedandRevertedWithERC20have been added. Ensure that all code listening for these events is updated accordingly.Verification successful
The new events
RevertedandRevertedWithERC20are integrated into the codebase.The search results confirm multiple instances where these events are referenced, emitted, and filtered. The integration appears to be correctly handled.
- Files with references:
contracts/prototypes/evm/IGatewayEVM.solcontracts/prototypes/evm/GatewayEVM.solcontracts/prototypes/test/GatewayEVMZEVM.t.solcontracts/prototypes/test/GatewayEVM.t.solcontracts/prototypes/evm/interfaces.solpkg/contracts/prototypes/evm/igatewayevm.solpkg/contracts/prototypes/evm/gatewayevmupgradetest.solScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the new `Reverted` and `RevertedWithERC20` events in the codebase. # Test: Search for the event usage. Expect: Only occurrences of the new events. rg --type solidity -A 5 $'Reverted(address indexed destination, uint256 value, bytes data)' rg --type solidity -A 5 $'RevertedWithERC20(address indexed token, address indexed to, uint256 amount, bytes data)'Length of output: 275
Script:
#!/bin/bash # Description: Verify the usage of the new `Reverted` and `RevertedWithERC20` events in the codebase. # Find all Solidity files and then search for the event usage within those files. fd -e sol -x rg 'Reverted(address indexed destination, uint256 value, bytes data)' {} fd -e sol -x rg 'RevertedWithERC20(address indexed token, address indexed to, uint256 amount, bytes data)' {}Length of output: 203
Script:
#!/bin/bash # Description: Verify the usage of the new `Reverted` and `RevertedWithERC20` events in the codebase. # Find all Solidity files and then search for the event names within those files. fd -e sol -x rg 'Reverted' {} fd -e sol -x rg 'RevertedWithERC20' {}Length of output: 161191
contracts/prototypes/evm/ZetaConnectorNonNative.sol (4)
9-11: LGTM! The constructor correctly initializes the contract.The constructor initializes the contract by calling the parent constructor with
_gatewayand_zetaTokenparameters.
30-34: LGTM! The function correctly implements the token transfer and burn logic.The
receiveTokensfunction correctly implements the logic to handle token transfer and burn them.
20-27: Verify the usage of thenonReentrantmodifier.The
withdrawAndCallfunction correctly implements the withdrawal and call logic. Ensure that thenonReentrantmodifier is used appropriately to prevent reentrancy attacks.Verification successful
Verified the usage of the
nonReentrantmodifier.The
withdrawAndCallfunction correctly implements thenonReentrantmodifier to prevent reentrancy attacks. The usage is consistent with other functions in the codebase, ensuring security against such vulnerabilities.
contracts/prototypes/evm/ZetaConnectorNonNative.solScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the `nonReentrant` modifier in the codebase. # Test: Search for the `nonReentrant` modifier usage. Expect: Appropriate usage to prevent reentrancy attacks. rg --type solidity -A 5 $'nonReentrant'Length of output: 71
Script:
#!/bin/bash # Description: Verify the usage of the `nonReentrant` modifier in Solidity files. # Test: Search for the `nonReentrant` modifier usage. Expect: Appropriate usage to prevent reentrancy attacks. rg 'nonReentrant' --glob '*.sol' -A 5Length of output: 14249
14-17: Verify the usage of thenonReentrantmodifier.The
withdrawfunction correctly implements the withdrawal logic. Ensure that thenonReentrantmodifier is used appropriately to prevent reentrancy attacks.Verification successful
Verification successful.
The
nonReentrantmodifier is correctly implemented and used in thewithdrawfunction to prevent reentrancy attacks.
- The modifier is implemented to set a
_lockedflag and revert if the function is re-entered.- This pattern is a standard and effective way to prevent reentrancy attacks.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the `nonReentrant` modifier in the codebase. # Test: Search for the `nonReentrant` modifier usage. Expect: Appropriate usage to prevent reentrancy attacks. rg --type solidity -A 5 $'nonReentrant'Length of output: 71
Script:
#!/bin/bash # Description: Verify the usage of the `nonReentrant` modifier in Solidity files. # Find all Solidity files and search for the `nonReentrant` modifier usage. fd -e sol -x grep -H -A 5 'nonReentrant' {}Length of output: 33636
Script:
#!/bin/bash # Description: Locate the definition of the `nonReentrant` modifier in Solidity files. # Find all Solidity files and search for the definition of the `nonReentrant` modifier. fd -e sol -x grep -H 'modifier nonReentrant' {}Length of output: 19429
Script:
#!/bin/bash # Description: Extract the implementation of the `nonReentrant` modifier from Solidity files. # Extract the implementation of the `nonReentrant` modifier from `ZetaTokenConsumerPancakeV3.strategy.sol`. fd -e sol -x grep -A 5 'modifier nonReentrant' ./contracts/evm/tools/ZetaTokenConsumerPancakeV3.strategy.solLength of output: 172661
test/fuzz/ERC20CustodyNewEchidnaTest.sol (1)
20-20: Verify the appropriateness of the hardcoded address.The hardcoded address
0x123is added as an additional parameter to theinitializefunction of theGatewayEVMcontract. Ensure that this address is appropriate for the intended functionality.contracts/prototypes/evm/ZetaConnectorNative.sol (4)
1-10: LGTM! Imports and contract declaration are appropriate.The imports and the use of
SafeERC20for safe token transfers are correctly implemented.
11-19: LGTM! Constructor andwithdrawfunction are correctly implemented.The constructor correctly initializes the base contract, and the
withdrawfunction securely transfers tokens and emits an event.
21-30: LGTM!withdrawAndCallfunction is correctly implemented.The function securely transfers tokens to the gateway and correctly forwards the call to the gateway contract.
32-36: LGTM!receiveTokensfunction is correctly implemented.The function securely transfers tokens from the sender to the contract.
contracts/prototypes/evm/ERC20CustodyNew.sol (4)
Line range hint
1-10:
LGTM! Imports and contract declaration are appropriate.The imports and the use of
SafeERC20for safe token transfers andReentrancyGuardto prevent reentrancy attacks are correctly implemented.
Line range hint
11-19:
LGTM! Constructor andwithdrawfunction are correctly implemented.The constructor correctly initializes the
gatewayand checks for a zero address. Thewithdrawfunction securely transfers tokens and emits an event.
Line range hint
20-50:
LGTM!withdrawAndCallfunction is correctly implemented.The function securely transfers tokens to the gateway and correctly forwards the call to the gateway contract.
51-64: LGTM!withdrawAndRevertfunction is correctly implemented.The function securely transfers tokens to the gateway and correctly forwards the call to the gateway contract's revert function.
testFoundry/GatewayEVMUpgrade.t.sol (6)
11-11: LGTM!The import statement for
ZetaConnectorNonNativeis correctly added.
16-17: LGTM!The import statement for
TestERC20is correctly added.
28-30: LGTM!The variable declarations for
zetaConnectorandzetaare correctly added.
41-41: LGTM!The initialization of the
zetatoken is correctly added.
45-45: LGTM!The
ERC1967Proxyinitialization call is correctly updated to include thezetatoken.
50-54: LGTM!The initialization of the
zetaConnectorand thesetConnectormethod call are correctly added.readme.md (1)
1-5: LGTM!The new section highlighting the development of Version 2 (V2) of the smart contract architecture is correctly added and provides the necessary information.
test/prototypes/GatewayEVMUniswap.spec.ts (2)
59-64: LGTM!The deployment process is correctly updated to include the
ZetaConnectorNonNativecontract and theTestERC20token named "Zeta".
69-71: LGTM!The method calls to
setCustodyandsetConnectorare correctly added to establish relationships between the gateway and the custody contract as well as the Zeta connector.testFoundry/GatewayZEVM.t.sol (3)
12-12: Good practice: Specific import.The change to import a more specific interface
IGatewayZEVM.solimproves clarity and maintainability.
54-54: Improvement: Explicit event emission.The change to use
address(zrc20)in theWithdrawalevent emission makes the event more explicit and clear.
66-66: Improvement: Explicit event emission.The change to use
address(zrc20)in theWithdrawalevent emission makes the event more explicit and clear.scripts/worker.ts (2)
134-134: Improvement: Enhanced event parameter clarity.The change to the
Withdrawalevent signature, updating the second parameter frombytes totoaddress zrc20, enhances the clarity of the event's parameters.
138-138: LGTM! But verify the argument indexing.The change to the index used to retrieve the
messagefrom theargsarray suggests a reordering of the arguments. Ensure that the new indexing is correct and does not break existing functionality.contracts/prototypes/zevm/GatewayZEVM.sol (12)
7-13: Necessary imports for new functionality.The new imports for
ReentrancyGuardUpgradeableandIWZETAare necessary for the introduced functionality and security enhancements.
28-36: Enhanced robustness in initialization.The update to the
initializefunction to accept an address parameter_zetaTokenand include a validation check for a zero address enhances the robustness of the initialization process.
Line range hint
41-50:
Improved clarity in function naming and logic.The renaming of
_withdrawto_withdrawZRC20and the logic updates for handling ZRC20 tokens make the function's purpose more explicit and improve code clarity.
56-61: Centralized ZETA transfer logic.The new
_transferZETAfunction centralizes the ZETA transfer logic, improving the contract's structure.
64-66: Enhanced security withnonReentrantmodifier.The update to the
withdrawfunction to include thenonReentrantmodifier enhances security against reentrancy attacks.
70-73: Enhanced security withnonReentrantmodifier.The update to the
withdrawAndCallfunction to include thenonReentrantmodifier enhances security against reentrancy attacks.
76-79: Enhanced security withnonReentrantmodifier.The update to the
withdrawfunction for ZETA to include thenonReentrantmodifier enhances security against reentrancy attacks.
82-84: Enhanced security withnonReentrantmodifier.The update to the
withdrawAndCallfunction for ZETA to include thenonReentrantmodifier enhances security against reentrancy attacks.
88-88: Enhanced security withnonReentrantmodifier.The update to the
callfunction to include thenonReentrantmodifier enhances security against reentrancy attacks.
141-152: Increased flexibility in cross-chain operations.The new
depositAndCallfunction provides users with more flexibility in cross-chain operations by allowing them to deposit ZETA and interact with target contracts.
157-167: Enhanced functionality with revert operations.The new
executeRevertfunction enhances the contract's functionality by providing a way to revert operations on the ZEVM.
172-183: Increased flexibility in cross-chain operations.The new
depositAndRevertfunction provides users with more flexibility in cross-chain operations by allowing them to deposit ZRC20 tokens and revert a contract on the ZEVM.testFoundry/GatewayEVMZEVM.t.sol (6)
10-10: LGTM! Import statements are appropriate.The new import statements for
ZetaConnectorNonNative.soland specific interfaces are necessary for the new functionality.Also applies to: 21-23
34-36: LGTM! State variables are necessary for new functionality.The new state variables
zetaConnectorandzetaare required for the new functionality introduced in the tests.
58-59: LGTM! Constructor changes are appropriate.The addition of the
zetatoken initialization is necessary for the new functionality.
62-62: LGTM! Proxy initialization changes are appropriate.The inclusion of the
zetatoken address in the proxy initialization forGatewayEVMis necessary for the new functionality.
69-69: LGTM! Method call changes are appropriate.The
setConnectormethod ofgatewayEVMbeing called with the address of thezetaConnectoris necessary for the new functionality.
150-150: LGTM! Event emission changes are appropriate.The inclusion of the address of
zrc20in theWithdrawalevent emission is necessary for the new functionality.contracts/prototypes/evm/GatewayEVM.sol (11)
9-12: LGTM! Import statements are appropriate.The new import statements for
ReentrancyGuardUpgradeable.solandZetaConnectorNewBase.solare necessary for the new functionality and security enhancements.
27-29: LGTM! State variables are necessary for new functionality.The new state variables
zetaConnector,zeta, andzetaTokenare required for the new functionality and security enhancements.
36-46: LGTM! Initialize function changes are appropriate.The
initializefunction now accepts an additional parameter_zetaTokenand includes a zero address check, enhancing the contract's robustness against improper initialization.
58-66: LGTM! New executeRevert function is appropriate.The
executeRevertfunction enhances the contract's interaction capabilities with external contracts by handling revert operations.
Line range hint
88-107:
LGTM! ExecuteWithERC20 function changes are appropriate.The
executeWithERC20function now includes reentrancy protection and approval checks, enhancing the security and functionality of the contract.
112-122: LGTM! RevertWithERC20 function changes are appropriate.The
revertWithERC20function now includes reentrancy protection, enhancing the security of the contract.
135-139: LGTM! Deposit function changes are appropriate.The
depositfunction now includes a zero amount check and emits an event, enhancing the functionality and traceability of the contract.
Line range hint
154-162:
LGTM! DepositAndCall function changes are appropriate.The
depositAndCallfunction now includes a zero amount check and emits an event, enhancing the functionality and traceability of the contract.
175-180: LGTM! SetConnector function changes are appropriate.The
setConnectorfunction now includes a zero address check and an initialization check, enhancing the configurability and security of the contract.
186-197: LGTM! TransferFromToAssetHandler function is appropriate.The
transferFromToAssetHandlerfunction centralizes the logic for transferring tokens, enhancing maintainability and reducing code duplication.
199-208: LGTM! TransferToAssetHandler function is appropriate.The
transferToAssetHandlerfunction centralizes the logic for transferring tokens, enhancing maintainability and reducing code duplication.contracts/prototypes/evm/GatewayEVMUpgradeTest.sol (8)
9-11: LGTM! Import statements are appropriate.The new import statements for
ReentrancyGuardUpgradeable.solandZetaConnectorNewBase.solare necessary for the new functionality and security enhancements.
26-28: LGTM! State variables are necessary for new functionality.The new state variables
zetaConnector,zeta, andzetaTokenare required for the new functionality and security enhancements.
37-47: LGTM! Initialize function changes are appropriate.The
initializefunction now accepts an additional parameter_zetaTokenand includes a zero address check, enhancing the contract's robustness against improper initialization.
61-67: LGTM! New executeRevert function is appropriate.The
executeRevertfunction enhances the contract's interaction capabilities with external contracts by handling revert operations.
89-108: LGTM! ExecuteWithERC20 function changes are appropriate.The
executeWithERC20function now includes reentrancy protection and approval checks, enhancing the security and functionality of the contract.
112-124: LGTM! RevertWithERC20 function changes are appropriate.The
revertWithERC20function now includes reentrancy protection, enhancing the security of the contract.
136-139: LGTM! Deposit function changes are appropriate.The
depositfunction now includes a zero amount check and emits an event, enhancing the functionality and traceability of the contract.
156-162: LGTM! DepositAndCall function changes are appropriate.The
depositAndCallfunction now includes a zero amount check and emits an event, enhancing the functionality and traceability of the contract.testFoundry/GatewayEVM.t.sol (4)
46-46: Ensure correct initialization of GatewayEVM.Verify that the additional parameter
address(zeta)in theGatewayEVMconstructor call is correct and does not break existing functionality.
54-54: Ensure correct usage of setConnector method.Verify that the
setConnectormethod call with the address ofzetaConnectoris correct and does not break existing functionality.
202-202: Ensure correct initialization of GatewayEVM.Verify that the additional parameter
address(zeta)in theGatewayEVMconstructor call is correct and does not break existing functionality.
209-209: Ensure correct usage of setConnector method.Verify that the
setConnectormethod call with the address ofzetaConnectoris correct and does not break existing functionality.
test/fuzz/GatewayEVMEchidnaTest.sol
Outdated
| @@ -15,6 +15,7 @@ contract GatewayEVMEchidnaTest is GatewayEVM { | |||
|
|
|||
| constructor() { | |||
| tssAddress = echidnaCaller; | |||
| zetaConnector = address(0x123); | |||
There was a problem hiding this comment.
Consider making the hardcoded address configurable.
The hardcoded address value 0x123 may be a placeholder. It is recommended to make this address configurable for better flexibility and maintainability.
- zetaConnector = address(0x123);
+ zetaConnector = address(0x123); // Consider making this address configurableCommittable suggestion was skipped due to low confidence.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -13,7 +13,23 @@ | |||
| uint256 amount, | |||
| bytes calldata message | |||
| ) external override { | |||
| string memory decodedMessage = abi.decode(message, (string)); | |||
| string memory decodedMessage; | |||
Check warning
Code scanning / Slither
Uninitialized local variables Medium
| uint256 amount, | ||
| bytes calldata message | ||
| ) external override { | ||
| string memory decodedMessage; |
Check warning
Code scanning / Slither
Uninitialized local variables Medium
| function transferFromToAssetHandler(address from, address token, uint256 amount) private { | ||
| if (token == zetaToken) { // transfer to connector | ||
| // transfer amount to gateway | ||
| IERC20(token).safeTransferFrom(from, address(this), amount); | ||
| // approve connector to handle tokens depending on connector version (eg. lock or burn) | ||
| IERC20(token).approve(zetaConnector, amount); | ||
| // send tokens to connector | ||
| ZetaConnectorNewBase(zetaConnector).receiveTokens(amount); | ||
| } else { // transfer to custody | ||
| IERC20(token).safeTransferFrom(from, custody, amount); | ||
| } | ||
| } |
Check warning
Code scanning / Slither
Unused return Medium
| function transferToAssetHandler(address token, uint256 amount) private { | ||
| if (token == zetaToken) { // transfer to connector | ||
| // approve connector to handle tokens depending on connector version (eg. lock or burn) | ||
| IERC20(token).approve(zetaConnector, amount); | ||
| // send tokens to connector | ||
| ZetaConnectorNewBase(zetaConnector).receiveTokens(amount); | ||
| } else { // transfer to custody | ||
| IERC20(token).safeTransfer(custody, amount); | ||
| } | ||
| } |
Check warning
Code scanning / Slither
Unused return Medium
| return result; | ||
| } | ||
|
|
||
| // Called by the TSS | ||
| // Calling onRevert directly | ||
| function executeRevert(address destination, bytes calldata data) public payable { |
Check notice
Code scanning / Slither
Missing zero address validation Low
| if (!success) revert ExecutionFailed(); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| // Called by the TSS | ||
| // Calling onRevert directly | ||
| function executeRevert(address destination, bytes calldata data) public payable { |
Check notice
Code scanning / Slither
Missing zero address validation Low
| function executeRevert(address destination, bytes calldata data) public payable { | ||
| (bool success, bytes memory result) = destination.call{value: msg.value}(""); | ||
| if (!success) revert ExecutionFailed(); | ||
| Revertable(destination).onRevert(data); | ||
|
|
||
| emit Reverted(destination, msg.value, data); | ||
| } |
Check notice
Code scanning / Slither
Reentrancy vulnerabilities Low
| function executeRevert(address destination, bytes calldata data) public payable { | ||
| (bool success, bytes memory result) = destination.call{value: msg.value}(""); | ||
| if (!success) revert ExecutionFailed(); | ||
| Revertable(destination).onRevert(data); | ||
|
|
||
| emit Reverted(destination, msg.value, data); | ||
| } |
Check notice
Code scanning / Slither
Reentrancy vulnerabilities Low
| function executeRevert(address destination, bytes calldata data) public payable { | ||
| (bool success, bytes memory result) = destination.call{value: msg.value}(""); | ||
| if (!success) revert ExecutionFailed(); | ||
| Revertable(destination).onRevert(data); | ||
|
|
||
| emit Reverted(destination, msg.value, data); | ||
| } |
Check warning
Code scanning / Slither
Low-level calls Warning
| function executeRevert(address destination, bytes calldata data) public payable { | ||
| (bool success, bytes memory result) = destination.call{value: msg.value}(""); | ||
| if (!success) revert ExecutionFailed(); | ||
| Revertable(destination).onRevert(data); | ||
|
|
||
| emit Reverted(destination, msg.value, data); | ||
| } |
Check warning
Code scanning / Slither
Low-level calls Warning
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
New Features
WithdrawAndRevertto track specific withdrawal operations.withdrawAndRevert,executeRevert, andrevertWithERC20for improved token handling.Bug Fixes
Chores
.gitattributesfile for better repository management.