feat: wrap payload

contracts/InterchainTokenFactory.sol

@@ -55,10 +55,10 @@ contract InterchainTokenFactory is IInterchainTokenFactory, ITokenManagerType, M
      * @param chainNameHash_ The hash of the chain name.
      * @param deployer The address of the deployer.
      * @param salt A unique identifier to generate the salt.
-     * @return bytes32 The calculated salt for the interchain token.
+     * @return tokenSalt The calculated salt for the interchain token.
      */
-    function interchainTokenSalt(bytes32 chainNameHash_, address deployer, bytes32 salt) public pure returns (bytes32) {
-        return keccak256(abi.encode(PREFIX_INTERCHAIN_TOKEN_SALT, chainNameHash_, deployer, salt));
+    function interchainTokenSalt(bytes32 chainNameHash_, address deployer, bytes32 salt) public pure returns (bytes32 tokenSalt) {
+        tokenSalt = keccak256(abi.encode(PREFIX_INTERCHAIN_TOKEN_SALT, chainNameHash_, deployer, salt));
     }
 
     /**

contracts/TokenHandler.sol

@@ -47,6 +47,9 @@ contract TokenHandler is ITokenHandler, ITokenManagerType, ReentrancyGuard {
         address to,
         uint256 amount
     ) external payable returns (uint256) {
+        /// @dev Track the flow amount being received via the message
+        ITokenManager(tokenManager).addFlowIn(amount);
+
         if (tokenManagerType == uint256(TokenManagerType.MINT_BURN) || tokenManagerType == uint256(TokenManagerType.MINT_BURN_FROM)) {
             _giveTokenMintBurn(tokenAddress, to, amount);
             return amount;
@@ -86,7 +89,10 @@ contract TokenHandler is ITokenHandler, ITokenManagerType, ReentrancyGuard {
         address tokenManager,
         address from,
         uint256 amount
-    ) external payable returns (uint256) {
+    ) external payable returns (uint256) {        
+        /// @dev Track the flow amount being sent out as a message
+        ITokenManager(tokenManager).addFlowOut(amount);
+
         if (tokenManagerType == uint256(TokenManagerType.MINT_BURN)) {
             _takeTokenMintBurn(tokenAddress, from, amount);
             return amount;

contracts/interfaces/IInterchainTokenFactory.sol

@@ -37,9 +37,9 @@ interface IInterchainTokenFactory is IUpgradable, IMulticall {
      * @param chainNameHash_ The hash of the chain name.
      * @param deployer The address of the deployer.
      * @param salt A unique identifier to generate the salt.
-     * @return bytes32 The calculated salt for the interchain token.
+     * @return tokenSalt The calculated salt for the interchain token.
      */
-    function interchainTokenSalt(bytes32 chainNameHash_, address deployer, bytes32 salt) external view returns (bytes32);
+    function interchainTokenSalt(bytes32 chainNameHash_, address deployer, bytes32 salt) external view returns (bytes32 tokenSalt);
 
     /**
      * @notice Computes the ID for an interchain token based on the deployer and a salt.
@@ -97,9 +97,9 @@ interface IInterchainTokenFactory is IUpgradable, IMulticall {
      * @notice Calculates the salt for a canonical interchain token.
      * @param chainNameHash_ The hash of the chain name.
      * @param tokenAddress The address of the token.
-     * @return salt The calculated salt for the interchain token.
+     * @return tokenSalt The calculated salt for the interchain token.
      */
-    function canonicalInterchainTokenSalt(bytes32 chainNameHash_, address tokenAddress) external view returns (bytes32 salt);
+    function canonicalInterchainTokenSalt(bytes32 chainNameHash_, address tokenAddress) external view returns (bytes32 tokenSalt);
 
     /**
      * @notice Computes the ID for a canonical interchain token based on its address.

contracts/interfaces/IInterchainTokenService.sol

@@ -47,6 +47,7 @@ interface IInterchainTokenService is
     error TokenHandlerFailed(bytes data);
     error EmptyData();
     error PostDeployFailed(bytes data);
+    error InvalidGatewayTokenTransfer(bytes32 tokenId, bytes payload, string tokenSymbol, uint256 amount);
 
     event InterchainTransfer(
         bytes32 indexed tokenId,

contracts/test/utils/TestCreate3Fixed.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { Create3Fixed } from '../../utils/Create3Fixed.sol';
+
+contract TestCreate3Fixed is Create3Fixed {
+    event Deployed(address addr);
+
+    function deploy(bytes memory code, bytes32 salt) public payable returns (address addr) {
+        addr = _create3(code, salt);
+
+        emit Deployed(addr);
+    }
+
+    function deployedAddress(bytes32 salt) public view returns (address addr) {
+        addr = _create3Address(salt);
+    }
+}

contracts/utils/Create3AddressFixed.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Create3AddressFixed contract
+ * @notice This contract can be used to predict the deterministic deployment address of a contract deployed with the `CREATE3` technique.
+ * It is equivalent to the Create3Address found in axelar-gmp-sdk-solidity repo but uses a fixed bytecode for CreateDeploy,
+ * which allows changing compilation options (like number of runs) without affecting the future deployment addresses.
+ */
+contract Create3AddressFixed {
+    // slither-disable-next-line too-many-digits
+    bytes internal constant CREATE_DEPLOY_BYTECODE =
+        hex'608060405234801561001057600080fd5b50610162806100206000396000f3fe60806040526004361061001d5760003560e01c806277436014610022575b600080fd5b61003561003036600461007b565b610037565b005b8051602082016000f061004957600080fd5b50565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b60006020828403121561008d57600080fd5b813567ffffffffffffffff808211156100a557600080fd5b818401915084601f8301126100b957600080fd5b8135818111156100cb576100cb61004c565b604051601f8201601f19908116603f011681019083821181831017156100f3576100f361004c565b8160405282815287602084870101111561010c57600080fd5b82602086016020830137600092810160200192909252509594505050505056fea264697066735822122094780ce55d28f1d568f4e0ab1b9dc230b96e952b73d2e06456fbff2289fa27f464736f6c63430008150033';
+    bytes32 internal constant CREATE_DEPLOY_BYTECODE_HASH = keccak256(CREATE_DEPLOY_BYTECODE);
+
+    /**
+     * @notice Compute the deployed address that will result from the `CREATE3` method.
+     * @param deploySalt A salt to influence the contract address
+     * @return deployed The deterministic contract address if it was deployed
+     */
+    function _create3Address(bytes32 deploySalt) internal view returns (address deployed) {
+        address deployer = address(
+            uint160(uint256(keccak256(abi.encodePacked(hex'ff', address(this), deploySalt, CREATE_DEPLOY_BYTECODE_HASH))))
+        );
+
+        deployed = address(uint160(uint256(keccak256(abi.encodePacked(hex'd6_94', deployer, hex'01')))));
+    }
+}

contracts/utils/Create3Fixed.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { IDeploy } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IDeploy.sol';
+import { ContractAddress } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/ContractAddress.sol';
+import { CreateDeploy } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/deploy/CreateDeploy.sol';
+import { Create3AddressFixed } from './Create3AddressFixed.sol';
+
+/**
+ * @title Create3Fixed contract
+ * @notice This contract can be used to deploy a contract with a deterministic address that depends only on
+ * the deployer address and deployment salt, not the contract bytecode and constructor parameters.
+ * It uses a fixed bytecode to allow changing the compilation settings without affecting the deployment address in the future.
+ */
+contract Create3Fixed is Create3AddressFixed, IDeploy {
+    using ContractAddress for address;
+
+    /**
+     * @notice Deploys a new contract using the `CREATE3` method.
+     * @dev This function first deploys the CreateDeploy contract using
+     * the `CREATE2` opcode and then utilizes the CreateDeploy to deploy the
+     * new contract with the `CREATE` opcode.
+     * @param bytecode The bytecode of the contract to be deployed
+     * @param deploySalt A salt to influence the contract address
+     * @return deployed The address of the deployed contract
+     */
+    function _create3(bytes memory bytecode, bytes32 deploySalt) internal returns (address deployed) {
+        deployed = _create3Address(deploySalt);
+
+        if (bytecode.length == 0) revert EmptyBytecode();
+        if (deployed.isContract()) revert AlreadyDeployed();
+
+        // Deploy using create2
+        CreateDeploy createDeploy;
+        bytes memory createDeployBytecode_ = CREATE_DEPLOY_BYTECODE;
+        uint256 length = createDeployBytecode_.length;
+        assembly {
+            createDeploy := create2(0, add(createDeployBytecode_, 0x20), length, deploySalt)
+        }
+
+        if (address(createDeploy) == address(0)) revert DeployFailed();
+        // Deploy using create
+        createDeploy.deploy(bytecode);
+    }
+}

contracts/utils/InterchainTokenDeployer.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.0;
 
-import { Create3 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/deploy/Create3.sol';
+import { Create3Fixed } from './Create3Fixed.sol';
 
 import { IInterchainTokenDeployer } from '../interfaces/IInterchainTokenDeployer.sol';
 import { IInterchainToken } from '../interfaces/IInterchainToken.sol';
@@ -11,7 +11,7 @@ import { IInterchainToken } from '../interfaces/IInterchainToken.sol';
  * @title InterchainTokenDeployer
  * @notice This contract is used to deploy new instances of the InterchainTokenProxy contract.
  */
-contract InterchainTokenDeployer is IInterchainTokenDeployer, Create3 {
+contract InterchainTokenDeployer is IInterchainTokenDeployer, Create3Fixed {
     address public immutable implementationAddress;
 
     /**

contracts/utils/TokenManagerDeployer.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.0;
 
-import { Create3 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/deploy/Create3.sol';
+import { Create3Fixed } from './Create3Fixed.sol';
 
 import { ITokenManagerDeployer } from '../interfaces/ITokenManagerDeployer.sol';
 
@@ -12,7 +12,7 @@ import { TokenManagerProxy } from '../proxies/TokenManagerProxy.sol';
  * @title TokenManagerDeployer
  * @notice This contract is used to deploy new instances of the TokenManagerProxy contract.
  */
-contract TokenManagerDeployer is ITokenManagerDeployer, Create3 {
+contract TokenManagerDeployer is ITokenManagerDeployer, Create3Fixed {
     /**
      * @notice Deploys a new instance of the TokenManagerProxy contract
      * @param tokenId The unique identifier for the token

hardhat.config.js

@@ -34,6 +34,16 @@ const compilerSettings = {
         optimizer: optimizerSettings,
     },
 };
+const itsCompilerSettings = {
+    version: '0.8.21',
+    settings: {
+        evmVersion: process.env.EVM_VERSION || 'london',
+        optimizer: {
+            ...optimizerSettings,
+            runs: 1, // Reduce runs to keep bytecode size under limit
+        },
+    },
+};
 
 /**
  * @type import('hardhat/config').HardhatUserConfig
@@ -45,6 +55,8 @@ module.exports = {
         overrides: {
             'contracts/proxies/Proxy.sol': compilerSettings,
             'contracts/proxies/TokenManagerProxy.sol': compilerSettings,
+            'contracts/InterchainTokenService.sol': itsCompilerSettings,
+            'contracts/test/TestInterchainTokenService.sol': itsCompilerSettings,
         },
     },
     defaultNetwork: 'hardhat',