feat: erc20 auth calls (#401)

Co-authored-by: lumtis <[email protected]>
zeta-chain · Oct 18, 2024 · 2095aa6 · 2095aa6
1 parent ff64066
commit 2095aa6
Show file tree

Hide file tree

Showing 73 changed files with 1,311 additions and 732 deletions.
diff --git a/v2/contracts/evm/ERC20Custody.sol b/v2/contracts/evm/ERC20Custody.sol
@@ -2,7 +2,7 @@
 pragma solidity 0.8.26;
 
 import { IERC20Custody } from "./interfaces/IERC20Custody.sol";
-import { IGatewayEVM } from "./interfaces/IGatewayEVM.sol";
+import { IGatewayEVM, MessageContext } from "./interfaces/IGatewayEVM.sol";
 
 import { RevertContext } from "../../contracts/Revert.sol";
 
@@ -140,11 +140,13 @@ contract ERC20Custody is
 
     /// @notice WithdrawAndCall transfers tokens to Gateway and call a contract through the Gateway.
     /// @dev This function can only be called by the TSS address.
+    /// @param messageContext Message context containing sender.
     /// @param to Address of the contract to call.
     /// @param token Address of the ERC20 token.
     /// @param amount Amount of tokens to withdraw.
     /// @param data Calldata to pass to the contract call.
     function withdrawAndCall(
+        MessageContext calldata messageContext,
         address to,
         address token,
         uint256 amount,
@@ -161,7 +163,7 @@ contract ERC20Custody is
         IERC20(token).safeTransfer(address(gateway), amount);
 
         // Forward the call to the Gateway contract
-        gateway.executeWithERC20(token, to, amount, data);
+        gateway.executeWithERC20(messageContext, token, to, amount, data);
 
         emit WithdrawnAndCalled(to, token, amount, data);
     }

diff --git a/v2/contracts/evm/GatewayEVM.sol b/v2/contracts/evm/GatewayEVM.sol
@@ -122,7 +122,7 @@ contract GatewayEVM is
         emit Reverted(destination, address(0), msg.value, data, revertContext);
     }
 
-    /// @notice Executes an authenticated call to a destination address without ERC20 tokens.
+    /// @notice Executes a call to a destination address without ERC20 tokens.
     /// @dev This function can only be called by the TSS address and it is payable.
     /// @param messageContext Message context containing sender.
     /// @param destination Address to call.
@@ -142,30 +142,14 @@ contract GatewayEVM is
     {
         if (destination == address(0)) revert ZeroAddress();
         bytes memory result;
-        result = _executeAuthenticatedCall(messageContext, destination, data);
-
-        emit Executed(destination, msg.value, data);
-
-        return result;
-    }
-
-    /// @notice Executes an arbitrary call to a destination address without ERC20 tokens.
-    /// @dev This function can only be called by the TSS address and it is payable.
-    /// @param destination Address to call.
-    /// @param data Calldata to pass to the call.
-    /// @return The result of the call.
-    function execute(
-        address destination,
-        bytes calldata data
-    )
-        external
-        payable
-        onlyRole(TSS_ROLE)
-        whenNotPaused
-        returns (bytes memory)
-    {
-        if (destination == address(0)) revert ZeroAddress();
-        bytes memory result = _executeArbitraryCall(destination, data);
+        // 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
+        if (messageContext.sender == address(0)) {
+            result = _executeArbitraryCall(destination, data);
+        } else {
+            result = _executeAuthenticatedCall(messageContext, destination, data);
+        }
 
         emit Executed(destination, msg.value, data);
 
@@ -175,11 +159,13 @@ contract GatewayEVM is
     /// @notice Executes a call to a destination contract using ERC20 tokens.
     /// @dev This function can only be called by the custody or connector address.
     ///      It uses the ERC20 allowance system, resetting gateway allowance at the end.
+    /// @param messageContext Message context containing sender.
     /// @param token Address of the ERC20 token.
     /// @param to Address of the contract to call.
     /// @param amount Amount of tokens to transfer.
     /// @param data Calldata to pass to the call.
     function executeWithERC20(
+        MessageContext calldata messageContext,
         address token,
         address to,
         uint256 amount,
@@ -196,7 +182,13 @@ contract GatewayEVM is
         if (!_resetApproval(token, to)) revert ApprovalFailed();
         if (!IERC20(token).approve(to, amount)) revert ApprovalFailed();
         // Execute the call on the target contract
-        _executeArbitraryCall(to, data);
+        // if sender is provided in messageContext call is authenticated and target is Callable.onCall
+        // otherwise, call is arbitrary
+        if (messageContext.sender == address(0)) {
+            _executeArbitraryCall(to, data);
+        } else {
+            _executeAuthenticatedCall(messageContext, to, data);
+        }
 
         // Reset approval
         if (!_resetApproval(token, to)) revert ApprovalFailed();

diff --git a/v2/contracts/evm/ZetaConnectorBase.sol b/v2/contracts/evm/ZetaConnectorBase.sol
@@ -10,7 +10,12 @@ import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 import { RevertContext } from "../../contracts/Revert.sol";
-import { IGatewayEVM, IGatewayEVMErrors, IGatewayEVMEvents } from "../../contracts/evm/interfaces/IGatewayEVM.sol";
+import {
+    IGatewayEVM,
+    IGatewayEVMErrors,
+    IGatewayEVMEvents,
+    MessageContext
+} from "../../contracts/evm/interfaces/IGatewayEVM.sol";
 import "../../contracts/evm/interfaces/IZetaConnector.sol";
 
 /// @title ZetaConnectorBase
@@ -112,11 +117,13 @@ abstract contract ZetaConnectorBase is
     function withdraw(address to, uint256 amount, bytes32 internalSendHash) external virtual;
 
     /// @notice Withdraw tokens and call a contract through Gateway.
+    /// @param messageContext Message context containing sender.
     /// @param to The address to withdraw tokens to.
     /// @param amount The amount of tokens to withdraw.
     /// @param data The calldata to pass to the contract call.
     /// @param internalSendHash A hash used for internal tracking of the transaction.
     function withdrawAndCall(
+        MessageContext calldata messageContext,
         address to,
         uint256 amount,
         bytes calldata data,

diff --git a/v2/contracts/evm/ZetaConnectorNative.sol b/v2/contracts/evm/ZetaConnectorNative.sol
@@ -46,13 +46,15 @@ contract ZetaConnectorNative is ZetaConnectorBase {
     }
 
     /// @notice Withdraw tokens and call a contract through Gateway.
+    /// @param messageContext Message context containing sender.
     /// @param to The address to withdraw tokens to.
     /// @param amount The amount of tokens to withdraw.
     /// @param data The calldata to pass to the contract call.
     //// @param internalSendHash A hash used for internal tracking of the transaction (not used currently
     // https://github.com/zeta-chain/protocol-contracts/issues/398)
     /// @dev This function can only be called by the TSS address.
     function withdrawAndCall(
+        MessageContext calldata messageContext,
         address to,
         uint256 amount,
         bytes calldata data,
@@ -68,7 +70,7 @@ contract ZetaConnectorNative is ZetaConnectorBase {
         IERC20(zetaToken).safeTransfer(address(gateway), amount);
 
         // Forward the call to the Gateway contract
-        gateway.executeWithERC20(address(zetaToken), to, amount, data);
+        gateway.executeWithERC20(messageContext, address(zetaToken), to, amount, data);
 
         emit WithdrawnAndCalled(to, amount, data);
     }

diff --git a/v2/contracts/evm/ZetaConnectorNonNative.sol b/v2/contracts/evm/ZetaConnectorNonNative.sol
@@ -61,12 +61,14 @@ contract ZetaConnectorNonNative is ZetaConnectorBase {
     }
 
     /// @notice Withdraw tokens and call a contract through Gateway.
+    /// @param messageContext Message context containing sender.
     /// @param to The address to withdraw tokens to.
     /// @param amount The amount of tokens to withdraw.
     /// @param data The calldata to pass to the contract call.
     /// @param internalSendHash A hash used for internal tracking of the transaction.
     /// @dev This function can only be called by the TSS address, and mints if supply is not reached.
     function withdrawAndCall(
+        MessageContext calldata messageContext,
         address to,
         uint256 amount,
         bytes calldata data,
@@ -82,7 +84,7 @@ contract ZetaConnectorNonNative is ZetaConnectorBase {
         _mintTo(address(gateway), amount, internalSendHash);
 
         // Forward the call to the Gateway contract
-        gateway.executeWithERC20(address(zetaToken), to, amount, data);
+        gateway.executeWithERC20(messageContext, address(zetaToken), to, amount, data);
 
         emit WithdrawnAndCalled(to, amount, data);
     }

diff --git a/v2/contracts/evm/interfaces/IERC20Custody.sol b/v2/contracts/evm/interfaces/IERC20Custody.sol
@@ -2,6 +2,8 @@
 pragma solidity 0.8.26;
 
 import { RevertContext } from "../../../contracts/Revert.sol";
+
+import { MessageContext } from "./IGatewayEVM.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 /// @title IERC20CustodyEvents
@@ -71,11 +73,19 @@ interface IERC20Custody is IERC20CustodyEvents, IERC20CustodyErrors {
 
     /// @notice WithdrawAndCall transfers tokens to Gateway and call a contract through the Gateway.
     /// @dev This function can only be called by the TSS address.
+    /// @param messageContext Message context containing sender.
     /// @param token Address of the ERC20 token.
     /// @param to Address of the contract to call.
     /// @param amount Amount of tokens to withdraw.
     /// @param data Calldata to pass to the contract call.
-    function withdrawAndCall(address token, address to, uint256 amount, bytes calldata data) external;
+    function withdrawAndCall(
+        MessageContext calldata messageContext,
+        address token,
+        address to,
+        uint256 amount,
+        bytes calldata data
+    )
+        external;
 
     /// @notice WithdrawAndRevert transfers tokens to Gateway and call a contract with a revert functionality through
     /// the Gateway.

diff --git a/v2/contracts/evm/interfaces/IGatewayEVM.sol b/v2/contracts/evm/interfaces/IGatewayEVM.sol
@@ -100,11 +100,19 @@ interface IGatewayEVMErrors {
 /// @notice Interface for the GatewayEVM contract.
 interface IGatewayEVM is IGatewayEVMErrors, IGatewayEVMEvents {
     /// @notice Executes a call to a contract using ERC20 tokens.
+    /// @param messageContext Message context containing sender and arbitrary call flag.
     /// @param token The address of the ERC20 token.
     /// @param to The address of the contract to call.
     /// @param amount The amount of tokens to transfer.
     /// @param data The calldata to pass to the contract call.
-    function executeWithERC20(address token, address to, uint256 amount, bytes calldata data) external;
+    function executeWithERC20(
+        MessageContext calldata messageContext,
+        address token,
+        address to,
+        uint256 amount,
+        bytes calldata data
+    )
+        external;
 
     /// @notice Transfers msg.value to destination contract and executes it's onRevert function.
     /// @dev This function can only be called by the TSS address and it is payable.
@@ -119,12 +127,6 @@ interface IGatewayEVM is IGatewayEVMErrors, IGatewayEVMEvents {
         external
         payable;
 
-    /// @notice Executes a call to a contract.
-    /// @param destination The address of the contract to call.
-    /// @param data The calldata to pass to the contract call.
-    /// @return The result of the contract call.
-    function execute(address destination, bytes calldata data) external payable returns (bytes memory);
-
     /// @notice Executes a call to a destination address without ERC20 tokens.
     /// @dev This function can only be called by the TSS address and it is payable.
     /// @param messageContext Message context containing sender and arbitrary call flag.

diff --git a/v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md b/v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
@@ -208,6 +208,7 @@ WithdrawAndCall transfers tokens to Gateway and call a contract through the Gate
 
 ```solidity
 function withdrawAndCall(
+    MessageContext calldata messageContext,
     address to,
     address token,
     uint256 amount,
@@ -222,6 +223,7 @@ function withdrawAndCall(
 
 |Name|Type|Description|
 |----|----|-----------|
+|`messageContext`|`MessageContext`|Message context containing sender.|
 |`to`|`address`|Address of the contract to call.|
 |`token`|`address`|Address of the ERC20 token.|
 |`amount`|`uint256`|Amount of tokens to withdraw.|
@@ -264,9 +266,6 @@ function withdrawAndRevert(
 
 Deposits asset to custody and pay fee in zeta erc20.
 
-**Note:**
-This method is deprecated.
-
 
 ```solidity
 function deposit(

diff --git a/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md b/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
@@ -85,9 +85,6 @@ uint256 public constant MAX_PAYLOAD_SIZE = 1024;
 ## Functions
 ### constructor
 
-**Note:**
-constructor
-
 
 ```solidity
 constructor();
@@ -182,7 +179,7 @@ function executeRevert(
 
 ### execute
 
-Executes an authenticated call to a destination address without ERC20 tokens.
+Executes a call to a destination address without ERC20 tokens.
 
 *This function can only be called by the TSS address and it is payable.*
 
@@ -215,38 +212,6 @@ function execute(
 |`<none>`|`bytes`|The result of the call.|
 
 
-### execute
-
-Executes an arbitrary call to a destination address without ERC20 tokens.
-
-*This function can only be called by the TSS address and it is payable.*
-
-
-```solidity
-function execute(
-    address destination,
-    bytes calldata data
-)
-    external
-    payable
-    onlyRole(TSS_ROLE)
-    whenNotPaused
-    returns (bytes memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`destination`|`address`|Address to call.|
-|`data`|`bytes`|Calldata to pass to the call.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|The result of the call.|
-
-
 ### executeWithERC20
 
 Executes a call to a destination contract using ERC20 tokens.
@@ -257,6 +222,7 @@ It uses the ERC20 allowance system, resetting gateway allowance at the end.*
 
 ```solidity
 function executeWithERC20(
+    MessageContext calldata messageContext,
     address token,
     address to,
     uint256 amount,
@@ -271,6 +237,7 @@ function executeWithERC20(
 
 |Name|Type|Description|
 |----|----|-----------|
+|`messageContext`|`MessageContext`|Message context containing sender.|
 |`token`|`address`|Address of the ERC20 token.|
 |`to`|`address`|Address of the contract to call.|
 |`amount`|`uint256`|Amount of tokens to transfer.|

diff --git a/v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md b/v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md
@@ -155,12 +155,21 @@ Withdraw tokens and call a contract through Gateway.
 
 
 ```solidity
-function withdrawAndCall(address to, uint256 amount, bytes calldata data, bytes32 internalSendHash) external virtual;
+function withdrawAndCall(
+    MessageContext calldata messageContext,
+    address to,
+    uint256 amount,
+    bytes calldata data,
+    bytes32 internalSendHash
+)
+    external
+    virtual;
 ```
 **Parameters**
 
 |Name|Type|Description|
 |----|----|-----------|
+|`messageContext`|`MessageContext`|Message context containing sender.|
 |`to`|`address`|The address to withdraw tokens to.|
 |`amount`|`uint256`|The amount of tokens to withdraw.|
 |`data`|`bytes`|The calldata to pass to the contract call.|

diff --git a/v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md b/v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md
@@ -62,6 +62,7 @@ Withdraw tokens and call a contract through Gateway.
 
 ```solidity
 function withdrawAndCall(
+    MessageContext calldata messageContext,
     address to,
     uint256 amount,
     bytes calldata data,
@@ -77,6 +78,7 @@ function withdrawAndCall(
 
 |Name|Type|Description|
 |----|----|-----------|
+|`messageContext`|`MessageContext`|Message context containing sender.|
 |`to`|`address`|The address to withdraw tokens to.|
 |`amount`|`uint256`|The amount of tokens to withdraw.|
 |`data`|`bytes`|The calldata to pass to the contract call.|