fix: use nonReentrant only on functions interacting with arbitrary co…

…ntracts (#395)
zeta-chain · Oct 23, 2024 · 25a6e0b · 25a6e0b
1 parent d40d2e2
commit 25a6e0b
Show file tree

Hide file tree

Showing 17 changed files with 56 additions and 64 deletions.
diff --git a/v2/contracts/evm/GatewayEVM.sol b/v2/contracts/evm/GatewayEVM.sol
@@ -110,9 +110,9 @@ contract GatewayEVM is
     )
         public
         payable
+        nonReentrant
         onlyRole(TSS_ROLE)
         whenNotPaused
-        nonReentrant
     {
         if (destination == address(0)) revert ZeroAddress();
         (bool success,) = destination.call{ value: msg.value }("");
@@ -135,9 +135,9 @@ contract GatewayEVM is
     )
         external
         payable
+        nonReentrant
         onlyRole(TSS_ROLE)
         whenNotPaused
-        nonReentrant
         returns (bytes memory)
     {
         if (destination == address(0)) revert ZeroAddress();
@@ -172,9 +172,9 @@ contract GatewayEVM is
         bytes calldata data
     )
         public
+        nonReentrant
         onlyRole(ASSET_HANDLER_ROLE)
         whenNotPaused
-        nonReentrant
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (to == address(0)) revert ZeroAddress();
@@ -217,9 +217,9 @@ contract GatewayEVM is
         RevertContext calldata revertContext
     )
         external
+        nonReentrant
         onlyRole(ASSET_HANDLER_ROLE)
         whenNotPaused
-        nonReentrant
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (to == address(0)) revert ZeroAddress();
@@ -233,15 +233,7 @@ contract GatewayEVM is
     /// @notice Deposits ETH to the TSS address.
     /// @param receiver Address of the receiver.
     /// @param revertOptions Revert options.
-    function deposit(
-        address receiver,
-        RevertOptions calldata revertOptions
-    )
-        external
-        payable
-        whenNotPaused
-        nonReentrant
-    {
+    function deposit(address receiver, RevertOptions calldata revertOptions) external payable whenNotPaused {
         if (msg.value == 0) revert InsufficientETHAmount();
         if (receiver == address(0)) revert ZeroAddress();
         if (revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();
@@ -266,7 +258,6 @@ contract GatewayEVM is
     )
         external
         whenNotPaused
-        nonReentrant
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (receiver == address(0)) revert ZeroAddress();
@@ -289,7 +280,6 @@ contract GatewayEVM is
         external
         payable
         whenNotPaused
-        nonReentrant
     {
         if (msg.value == 0) revert InsufficientETHAmount();
         if (receiver == address(0)) revert ZeroAddress();
@@ -317,7 +307,6 @@ contract GatewayEVM is
     )
         external
         whenNotPaused
-        nonReentrant
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (receiver == address(0)) revert ZeroAddress();
@@ -339,7 +328,6 @@ contract GatewayEVM is
     )
         external
         whenNotPaused
-        nonReentrant
     {
         if (receiver == address(0)) revert ZeroAddress();
         if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();

diff --git a/v2/contracts/zevm/GatewayZEVM.sol b/v2/contracts/zevm/GatewayZEVM.sol
@@ -140,7 +140,6 @@ contract GatewayZEVM is
         RevertOptions calldata revertOptions
     )
         external
-        nonReentrant
         whenNotPaused
     {
         if (receiver.length == 0) revert ZeroAddress();
@@ -178,7 +177,6 @@ contract GatewayZEVM is
         RevertOptions calldata revertOptions
     )
         external
-        nonReentrant
         whenNotPaused
     {
         if (receiver.length == 0) revert ZeroAddress();
@@ -212,7 +210,6 @@ contract GatewayZEVM is
         RevertOptions calldata /*revertOptions*/
     )
         external
-        nonReentrant
         whenNotPaused
     {
         // TODO: remove error and comment out code once ZETA supported back
@@ -255,7 +252,6 @@ contract GatewayZEVM is
         RevertOptions calldata /*revertOptions*/
     )
         external
-        nonReentrant
         whenNotPaused
     {
         // TODO: remove error and comment out code once ZETA supported back
@@ -288,7 +284,6 @@ contract GatewayZEVM is
         RevertOptions calldata revertOptions
     )
         external
-        nonReentrant
         whenNotPaused
     {
         if (callOptions.gasLimit == 0) revert InsufficientGasLimit();
@@ -343,6 +338,7 @@ contract GatewayZEVM is
         bytes calldata message
     )
         external
+        nonReentrant
         onlyProtocol
         whenNotPaused
     {
@@ -365,6 +361,7 @@ contract GatewayZEVM is
         bytes calldata message
     )
         external
+        nonReentrant
         onlyProtocol
         whenNotPaused
     {
@@ -388,6 +385,7 @@ contract GatewayZEVM is
         bytes calldata message
     )
         external
+        nonReentrant
         onlyProtocol
         whenNotPaused
     {
@@ -402,7 +400,15 @@ contract GatewayZEVM is
     /// @notice Revert a user-specified contract on ZEVM.
     /// @param target The target contract to call.
     /// @param revertContext Revert context to pass to onRevert.
-    function executeRevert(address target, RevertContext calldata revertContext) external onlyProtocol whenNotPaused {
+    function executeRevert(
+        address target,
+        RevertContext calldata revertContext
+    )
+        external
+        nonReentrant
+        onlyProtocol
+        whenNotPaused
+    {
         if (target == address(0)) revert ZeroAddress();
 
         Revertable(target).onRevert(revertContext);
@@ -420,6 +426,7 @@ contract GatewayZEVM is
         RevertContext calldata revertContext
     )
         external
+        nonReentrant
         onlyProtocol
         whenNotPaused
     {

diff --git a/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md b/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
@@ -164,9 +164,9 @@ function executeRevert(
 )
     public
     payable
+    nonReentrant
     onlyRole(TSS_ROLE)
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -192,9 +192,9 @@ function execute(
 )
     external
     payable
+    nonReentrant
     onlyRole(TSS_ROLE)
     whenNotPaused
-    nonReentrant
     returns (bytes memory);
 ```
 **Parameters**
@@ -229,9 +229,9 @@ function executeWithERC20(
     bytes calldata data
 )
     public
+    nonReentrant
     onlyRole(ASSET_HANDLER_ROLE)
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -260,9 +260,9 @@ function revertWithERC20(
     RevertContext calldata revertContext
 )
     external
+    nonReentrant
     onlyRole(ASSET_HANDLER_ROLE)
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -281,7 +281,7 @@ Deposits ETH to the TSS address.
 
 
 ```solidity
-function deposit(address receiver, RevertOptions calldata revertOptions) external payable whenNotPaused nonReentrant;
+function deposit(address receiver, RevertOptions calldata revertOptions) external payable whenNotPaused;
 ```
 **Parameters**
 
@@ -304,8 +304,7 @@ function deposit(
     RevertOptions calldata revertOptions
 )
     external
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -330,8 +329,7 @@ function depositAndCall(
 )
     external
     payable
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -356,8 +354,7 @@ function depositAndCall(
     RevertOptions calldata revertOptions
 )
     external
-    whenNotPaused
-    nonReentrant;
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -376,14 +373,7 @@ Calls an omnichain smart contract without asset transfer.
 
 
 ```solidity
-function call(
-    address receiver,
-    bytes calldata payload,
-    RevertOptions calldata revertOptions
-)
-    external
-    whenNotPaused
-    nonReentrant;
+function call(address receiver, bytes calldata payload, RevertOptions calldata revertOptions) external whenNotPaused;
 ```
 **Parameters**
 

diff --git a/v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md b/v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
@@ -190,7 +190,6 @@ function withdraw(
     RevertOptions calldata revertOptions
 )
     external
-    nonReentrant
     whenNotPaused;
 ```
 **Parameters**
@@ -218,7 +217,6 @@ function withdrawAndCall(
     RevertOptions calldata revertOptions
 )
     external
-    nonReentrant
     whenNotPaused;
 ```
 **Parameters**
@@ -239,7 +237,7 @@ Withdraw ZETA tokens to an external chain.
 
 
 ```solidity
-function withdraw(bytes memory, uint256, uint256, RevertOptions calldata) external nonReentrant whenNotPaused;
+function withdraw(bytes memory, uint256, uint256, RevertOptions calldata) external whenNotPaused;
 ```
 
 ### withdrawAndCall
@@ -257,7 +255,6 @@ function withdrawAndCall(
     RevertOptions calldata
 )
     external
-    nonReentrant
     whenNotPaused;
 ```
 
@@ -275,7 +272,6 @@ function call(
     RevertOptions calldata revertOptions
 )
     external
-    nonReentrant
     whenNotPaused;
 ```
 **Parameters**
@@ -334,6 +330,7 @@ function execute(
     bytes calldata message
 )
     external
+    nonReentrant
     onlyProtocol
     whenNotPaused;
 ```
@@ -362,6 +359,7 @@ function depositAndCall(
     bytes calldata message
 )
     external
+    nonReentrant
     onlyProtocol
     whenNotPaused;
 ```
@@ -389,6 +387,7 @@ function depositAndCall(
     bytes calldata message
 )
     external
+    nonReentrant
     onlyProtocol
     whenNotPaused;
 ```
@@ -408,7 +407,14 @@ Revert a user-specified contract on ZEVM.
 
 
 ```solidity
-function executeRevert(address target, RevertContext calldata revertContext) external onlyProtocol whenNotPaused;
+function executeRevert(
+    address target,
+    RevertContext calldata revertContext
+)
+    external
+    nonReentrant
+    onlyProtocol
+    whenNotPaused;
 ```
 **Parameters**
 
@@ -431,6 +437,7 @@ function depositAndRevert(
     RevertContext calldata revertContext
 )
     external
+    nonReentrant
     onlyProtocol
     whenNotPaused;
 ```

diff --git a/v2/pkg/erc20custody.t.sol/erc20custodytest.go b/v2/pkg/erc20custody.t.sol/erc20custodytest.go
diff --git a/v2/pkg/gatewayevm.sol/gatewayevm.go b/v2/pkg/gatewayevm.sol/gatewayevm.go
diff --git a/v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go b/v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go
diff --git a/v2/pkg/gatewayevm.t.sol/gatewayevmtest.go b/v2/pkg/gatewayevm.t.sol/gatewayevmtest.go
diff --git a/v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go b/v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go
diff --git a/v2/pkg/gatewayzevm.sol/gatewayzevm.go b/v2/pkg/gatewayzevm.sol/gatewayzevm.go
diff --git a/v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go b/v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go
diff --git a/v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go b/v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go
diff --git a/v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.go b/v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.go
diff --git a/v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.go b/v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.go