fix: improve error handling and messages (#205, #206) (#473)

Author: s2imonovic

.gitignore

@@ -19,6 +19,7 @@ tsconfig.tsbuildinfo
 # Misc
 .env
 .DS_Store
+.idea
 .secrets
 .wallet.json
 

contracts/evm/GatewayEVM.sol

@@ -179,8 +179,8 @@ contract GatewayEVM is
         if (amount == 0) revert InsufficientERC20Amount();
         if (to == address(0)) revert ZeroAddress();
         // Approve the target contract to spend the tokens
-        if (!_resetApproval(token, to)) revert ApprovalFailed();
-        if (!IERC20(token).approve(to, amount)) revert ApprovalFailed();
+        if (!_resetApproval(token, to)) revert ApprovalFailed(token, to);
+        if (!IERC20(token).approve(to, amount)) revert ApprovalFailed(token, to);
         // Execute the call on the target contract
         // if sender is provided in messageContext call is authenticated and target is Callable.onCall
         // otherwise, call is arbitrary
@@ -191,7 +191,7 @@ contract GatewayEVM is
         }
 
         // Reset approval
-        if (!_resetApproval(token, to)) revert ApprovalFailed();
+        if (!_resetApproval(token, to)) revert ApprovalFailed(token, to);
 
         // Transfer any remaining tokens back to the custody/connector contract
         uint256 remainingBalance = IERC20(token).balanceOf(address(this));
@@ -236,7 +236,9 @@ contract GatewayEVM is
     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();
+        if (revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) {
+            revert PayloadSizeExceeded(revertOptions.revertMessage.length, MAX_PAYLOAD_SIZE);
+        }
 
         (bool deposited,) = tssAddress.call{ value: msg.value }("");
 
@@ -261,7 +263,9 @@ contract GatewayEVM is
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (receiver == address(0)) revert ZeroAddress();
-        if (revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();
+        if (revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) {
+            revert PayloadSizeExceeded(revertOptions.revertMessage.length, MAX_PAYLOAD_SIZE);
+        }
 
         _transferFromToAssetHandler(msg.sender, asset, amount);
 
@@ -283,7 +287,9 @@ contract GatewayEVM is
     {
         if (msg.value == 0) revert InsufficientETHAmount();
         if (receiver == address(0)) revert ZeroAddress();
-        if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();
+        if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) {
+            revert PayloadSizeExceeded(payload.length + revertOptions.revertMessage.length, MAX_PAYLOAD_SIZE);
+        }
 
         (bool deposited,) = tssAddress.call{ value: msg.value }("");
 
@@ -310,7 +316,9 @@ contract GatewayEVM is
     {
         if (amount == 0) revert InsufficientERC20Amount();
         if (receiver == address(0)) revert ZeroAddress();
-        if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();
+        if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) {
+            revert PayloadSizeExceeded(payload.length + revertOptions.revertMessage.length, MAX_PAYLOAD_SIZE);
+        }
 
         _transferFromToAssetHandler(msg.sender, asset, amount);
 
@@ -331,7 +339,8 @@ contract GatewayEVM is
     {
         if (revertOptions.callOnRevert) revert CallOnRevertNotSupported();
         if (receiver == address(0)) revert ZeroAddress();
-        if (payload.length + revertOptions.revertMessage.length > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded();
+        uint256 payloadSize = payload.length + revertOptions.revertMessage.length;
+        if (payloadSize > MAX_PAYLOAD_SIZE) revert PayloadSizeExceeded(payloadSize, MAX_PAYLOAD_SIZE);
 
         emit Called(msg.sender, receiver, payload, revertOptions);
     }
@@ -387,7 +396,7 @@ contract GatewayEVM is
             // ZetaConnectorBase(zetaConnector).receiveTokens(amount);
         } else {
             // transfer to custody
-            if (!IERC20Custody(custody).whitelisted(token)) revert NotWhitelistedInCustody();
+            if (!IERC20Custody(custody).whitelisted(token)) revert NotWhitelistedInCustody(token);
             IERC20(token).safeTransferFrom(from, custody, amount);
         }
     }
@@ -401,12 +410,12 @@ contract GatewayEVM is
         if (token == zetaToken) {
             // transfer to connector
             // approve connector to handle tokens depending on connector version (eg. lock or burn)
-            if (!IERC20(token).approve(zetaConnector, amount)) revert ApprovalFailed();
+            if (!IERC20(token).approve(zetaConnector, amount)) revert ApprovalFailed(token, zetaConnector);
             // send tokens to connector
             ZetaConnectorBase(zetaConnector).receiveTokens(amount);
         } else {
             // transfer to custody
-            if (!IERC20Custody(custody).whitelisted(token)) revert NotWhitelistedInCustody();
+            if (!IERC20Custody(custody).whitelisted(token)) revert NotWhitelistedInCustody(token);
             IERC20(token).safeTransfer(custody, amount);
         }
     }

contracts/evm/interfaces/IGatewayEVM.sol

@@ -91,7 +91,9 @@ interface IGatewayEVMErrors {
     error ZeroAddress();
 
     /// @notice Error for failed token approval.
-    error ApprovalFailed();
+    /// @param token The address of the token for which approval failed.
+    /// @param spender The address that was supposed to be approved to spend the tokens.
+    error ApprovalFailed(address token, address spender);
 
     /// @notice Error for already initialized custody.
     error CustodyInitialized();
@@ -100,7 +102,8 @@ interface IGatewayEVMErrors {
     error ConnectorInitialized();
 
     /// @notice Error when trying to transfer not whitelisted token to custody.
-    error NotWhitelistedInCustody();
+    /// @param token The address of the token that is not whitelisted in custody.
+    error NotWhitelistedInCustody(address token);
 
     /// @notice Error when trying to call onCall method using arbitrary call.
     error NotAllowedToCallOnCall();
@@ -109,7 +112,9 @@ interface IGatewayEVMErrors {
     error NotAllowedToCallOnRevert();
 
     /// @notice Error indicating payload size exceeded in external functions.
-    error PayloadSizeExceeded();
+    /// @param provided The size of the payload that was provided.
+    /// @param maximum The maximum allowed payload size.
+    error PayloadSizeExceeded(uint256 provided, uint256 maximum);
 }
 
 /// @title IGatewayEVM

contracts/zevm/GatewayZEVM.sol

@@ -89,6 +89,45 @@ contract GatewayZEVM is
         _unpause();
     }
 
+    /// @notice Helper function to safely execute transferFrom
+    /// @param zrc20 The ZRC20 token address
+    /// @param from The sender address
+    /// @param to The recipient address
+    /// @param amount The amount to transfer
+    /// @return True if the transfer was successful, false otherwise.
+    function _safeTransferFrom(address zrc20, address from, address to, uint256 amount) private returns (bool) {
+        try IZRC20(zrc20).transferFrom(from, to, amount) returns (bool success) {
+            return success;
+        } catch {
+            return false;
+        }
+    }
+
+    // @notice Helper function to safely burn ZRC20 tokens
+    // @param zrc20 The ZRC20 token address
+    // @param amount The amount to burn
+    // @return True if the burn was successful, false otherwise
+    function _safeBurn(address zrc20, uint256 amount) private returns (bool) {
+        try IZRC20(zrc20).burn(amount) returns (bool success) {
+            return success;
+        } catch {
+            return false;
+        }
+    }
+
+    // @notice Helper function to safely deposit
+    // @param zrc20 The ZRC20 token address
+    // @param amount The target address to receive the deposited tokens
+    // @param amount The amount to deposit
+    // @return True if the deposit was successful, false otherwise
+    function _safeDeposit(address zrc20, address target, uint256 amount) private returns (bool) {
+        try IZRC20(zrc20).deposit(target, amount) returns (bool success) {
+            return success;
+        } catch {
+            return false;
+        }
+    }
+
     /// @dev Private function to withdraw ZRC20 tokens.
     /// @param amount The amount of tokens to withdraw.
     /// @param zrc20 The address of the ZRC20 token.
@@ -105,15 +144,18 @@ contract GatewayZEVM is
     /// @return The gas fee for the withdrawal.
     function _withdrawZRC20WithGasLimit(uint256 amount, address zrc20, uint256 gasLimit) private returns (uint256) {
         (address gasZRC20, uint256 gasFee) = IZRC20(zrc20).withdrawGasFeeWithGasLimit(gasLimit);
-        if (!IZRC20(gasZRC20).transferFrom(msg.sender, PROTOCOL_ADDRESS, gasFee)) {
-            revert GasFeeTransferFailed();
+
+        if (!_safeTransferFrom(gasZRC20, msg.sender, PROTOCOL_ADDRESS, gasFee)) {
+            revert GasFeeTransferFailed(gasZRC20, PROTOCOL_ADDRESS, gasFee);
         }
 
-        if (!IZRC20(zrc20).transferFrom(msg.sender, address(this), amount)) {
-            revert ZRC20TransferFailed();
+        if (!_safeTransferFrom(zrc20, msg.sender, address(this), amount)) {
+            revert ZRC20TransferFailed(zrc20, msg.sender, address(this), amount);
         }
 
-        if (!IZRC20(zrc20).burn(amount)) revert ZRC20BurnFailed();
+        if (!_safeBurn(zrc20, amount)) {
+            revert ZRC20BurnFailed(zrc20, amount);
+        }
 
         return gasFee;
     }
@@ -122,10 +164,15 @@ contract GatewayZEVM is
     /// @param amount The amount of tokens to transfer.
     /// @param to The address to transfer the tokens to.
     function _transferZETA(uint256 amount, address to) private {
-        if (!IWETH9(zetaToken).transferFrom(msg.sender, address(this), amount)) revert FailedZetaSent();
-        IWETH9(zetaToken).withdraw(amount);
-        (bool sent,) = to.call{ value: amount }("");
-        if (!sent) revert FailedZetaSent();
+        if (!_safeTransferFrom(zetaToken, msg.sender, address(this), amount)) {
+            revert FailedZetaSent(address(this), amount);
+        }
+        try IWETH9(zetaToken).withdraw(amount) {
+            (bool sent,) = to.call{ value: amount }("");
+            if (!sent) revert FailedZetaSent(to, amount);
+        } catch {
+            revert FailedZetaSent(to, amount);
+        }
     }
 
     /// @notice Withdraw ZRC20 tokens to an external chain.
@@ -144,7 +191,9 @@ contract GatewayZEVM is
     {
         if (receiver.length == 0) revert ZeroAddress();
         if (amount == 0) revert InsufficientZRC20Amount();
-        if (revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) revert MessageSizeExceeded();
+        if (revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) {
+            revert MessageSizeExceeded(revertOptions.revertMessage.length, MAX_MESSAGE_SIZE);
+        }
 
         uint256 gasFee = _withdrawZRC20(amount, zrc20);
         emit Withdrawn(
@@ -182,7 +231,9 @@ contract GatewayZEVM is
         if (receiver.length == 0) revert ZeroAddress();
         if (amount == 0) revert InsufficientZRC20Amount();
         if (callOptions.gasLimit == 0) revert InsufficientGasLimit();
-        if (message.length + revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) revert MessageSizeExceeded();
+        if (message.length + revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) {
+            revert MessageSizeExceeded(message.length + revertOptions.revertMessage.length, MAX_MESSAGE_SIZE);
+        }
 
         uint256 gasFee = _withdrawZRC20WithGasLimit(amount, zrc20, callOptions.gasLimit);
         emit WithdrawnAndCalled(
@@ -289,7 +340,9 @@ contract GatewayZEVM is
         whenNotPaused
     {
         if (callOptions.gasLimit == 0) revert InsufficientGasLimit();
-        if (message.length + revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) revert MessageSizeExceeded();
+        if (message.length + revertOptions.revertMessage.length > MAX_MESSAGE_SIZE) {
+            revert MessageSizeExceeded(message.length + revertOptions.revertMessage.length, MAX_MESSAGE_SIZE);
+        }
 
         _call(receiver, zrc20, message, callOptions, revertOptions);
     }
@@ -306,8 +359,8 @@ contract GatewayZEVM is
         if (receiver.length == 0) revert ZeroAddress();
 
         (address gasZRC20, uint256 gasFee) = IZRC20(zrc20).withdrawGasFeeWithGasLimit(callOptions.gasLimit);
-        if (!IZRC20(gasZRC20).transferFrom(msg.sender, PROTOCOL_ADDRESS, gasFee)) {
-            revert GasFeeTransferFailed();
+        if (!_safeTransferFrom(gasZRC20, msg.sender, PROTOCOL_ADDRESS, gasFee)) {
+            revert GasFeeTransferFailed(gasZRC20, PROTOCOL_ADDRESS, gasFee);
         }
 
         emit Called(msg.sender, zrc20, receiver, message, callOptions, revertOptions);
@@ -323,7 +376,9 @@ contract GatewayZEVM is
 
         if (target == PROTOCOL_ADDRESS || target == address(this)) revert InvalidTarget();
 
-        if (!IZRC20(zrc20).deposit(target, amount)) revert ZRC20DepositFailed();
+        if (!_safeDeposit(zrc20, target, amount)) {
+            revert ZRC20DepositFailed(zrc20, target, amount);
+        }
     }
 
     /// @notice Execute a user-specified contract on ZEVM.
@@ -371,7 +426,10 @@ contract GatewayZEVM is
         if (amount == 0) revert InsufficientZRC20Amount();
         if (target == PROTOCOL_ADDRESS || target == address(this)) revert InvalidTarget();
 
-        if (!IZRC20(zrc20).deposit(target, amount)) revert ZRC20DepositFailed();
+        if (!_safeDeposit(zrc20, target, amount)) {
+            revert ZRC20DepositFailed(zrc20, target, amount);
+        }
+
         UniversalContract(target).onCall(context, zrc20, amount, message);
     }
 
@@ -436,7 +494,10 @@ contract GatewayZEVM is
         if (amount == 0) revert InsufficientZRC20Amount();
         if (target == PROTOCOL_ADDRESS || target == address(this)) revert InvalidTarget();
 
-        if (!IZRC20(zrc20).deposit(target, amount)) revert ZRC20DepositFailed();
+        if (!_safeDeposit(zrc20, target, amount)) {
+            revert ZRC20DepositFailed(zrc20, target, amount);
+        }
+
         Revertable(target).onRevert(revertContext);
     }
 

contracts/zevm/interfaces/IGatewayZEVM.sol

@@ -76,7 +76,10 @@ interface IGatewayZEVMEvents {
 /// @notice Interface for the errors used in the GatewayZEVM contract.
 interface IGatewayZEVMErrors {
     /// @notice Error indicating a withdrawal failure.
-    error WithdrawalFailed();
+    /// @param token The address of the token that failed to withdraw.
+    /// @param recipient The address that was supposed to receive the tokens.
+    /// @param amount The amount of tokens that failed to withdraw.
+    error WithdrawalFailed(address token, address recipient, uint256 amount);
 
     /// @notice Error indicating an insufficient ZRC20 token amount.
     error InsufficientZRC20Amount();
@@ -85,16 +88,28 @@ interface IGatewayZEVMErrors {
     error InsufficientZetaAmount();
 
     /// @notice Error indicating a failure to burn ZRC20 tokens.
-    error ZRC20BurnFailed();
+    /// @param zrc20 The address of the ZRC20 token that failed to burn.
+    /// @param amount The amount of tokens that failed to burn.
+    error ZRC20BurnFailed(address zrc20, uint256 amount);
 
     /// @notice Error indicating a failure to transfer ZRC20 tokens.
-    error ZRC20TransferFailed();
+    /// @param zrc20 The address of the ZRC20 token that failed to transfer.
+    /// @param from The address sending the tokens.
+    /// @param to The address receiving the tokens.
+    /// @param amount The amount of tokens that failed to transfer.
+    error ZRC20TransferFailed(address zrc20, address from, address to, uint256 amount);
 
     /// @notice Error indicating a failure to deposit ZRC20 tokens.
-    error ZRC20DepositFailed();
+    /// @param zrc20 The address of the ZRC20 token that failed to deposit.
+    /// @param to The address that was supposed to receive the deposit.
+    /// @param amount The amount of tokens that failed to deposit.
+    error ZRC20DepositFailed(address zrc20, address to, uint256 amount);
 
     /// @notice Error indicating a failure to transfer gas fee.
-    error GasFeeTransferFailed();
+    /// @param token The address of the token used for gas fee.
+    /// @param to The address that was supposed to receive the gas fee.
+    /// @param amount The amount of gas fee that failed to transfer.
+    error GasFeeTransferFailed(address token, address to, uint256 amount);
 
     /// @notice Error indicating that the caller is not the protocol account.
     error CallerIsNotProtocol();
@@ -103,7 +118,9 @@ interface IGatewayZEVMErrors {
     error InvalidTarget();
 
     /// @notice Error indicating a failure to send ZETA tokens.
-    error FailedZetaSent();
+    /// @param recipient The address that was supposed to receive the ZETA tokens.
+    /// @param amount The amount of ZETA tokens that failed to send.
+    error FailedZetaSent(address recipient, uint256 amount);
 
     /// @notice Error indicating that only WZETA or the protocol address can call the function.
     error OnlyWZETAOrProtocol();
@@ -112,7 +129,9 @@ interface IGatewayZEVMErrors {
     error InsufficientGasLimit();
 
     /// @notice Error indicating message size exceeded in external functions.
-    error MessageSizeExceeded();
+    /// @param provided The size of the message that was provided.
+    /// @param maximum The maximum allowed message size.
+    error MessageSizeExceeded(uint256 provided, uint256 maximum);
 }
 
 /// @title IGatewayZEVM

data/addresses.mainnet.json

@@ -1,5 +1,3 @@
-
-
 [
   {
     "address": "0x70e967acFcC17c3941E87562161406d41676FD83",

data/addresses.testnet.json

@@ -1,5 +1,3 @@
-
-
 [
   {
     "address": "0x0000ecb8cdd25a18f12daa23f6422e07fbf8b9e1",

docs/book.toml

@@ -6,7 +6,6 @@ title = ""
 no-section-label = true
 additional-js = ["solidity.min.js"]
 additional-css = ["book.css"]
-mathjax-support = true
 git-repository-url = "https://github.com/zeta-chain/protocol-contracts"
 
 [output.html.fold]