feat: use gmp sdk utils

.gitignore

@@ -20,6 +20,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+coverage.json
 *.lcov
 
 # nyc test coverage
@@ -105,13 +106,12 @@ dist
 
 # Editor files
 .vscode/
+.idea/
 
 build/
 cache/
 artifacts/
+/interfaces/
 
 info/local.json
 keys.json
-.vscode
-coverage.json
-coverage

DESIGN.md

@@ -30,9 +30,9 @@ Most projects that look to go cross-chain nowadays have more complex needs that
 - Mint/Burn: This `TokenManager` will burn/mint tokens from/to the user to initiate/fulfill cross-chain transfers. Tokens used with this kind of `TokenManager` need to be properly permissioned to allow for this behavior.
 - Liquidity Pool: This `TokenManager` functions exactly like a Lock/Unlock one, except the balance is kept at a separate, pre-specified account. This allows for deployers to have more control over the bridged funds.
 
-## Linker Router
+## Interchain Address Tracker
 
-We plan to finalize the design of the `InterchainTokenService` but we want to be able to support new chains as they get added to the Axelar Network. For this purpose, the service will ask a separate contract, the [`RemoteAddressValidator`](./contracts/remoteAddressValidator/RemoteAddressValidator.sol) to obtain the destination address for outgoing messages, and for validation of incoming messages. This contract might eventually stop being upgradable but it will probably be able to support new addresses for new chains indefinitely.
+We plan to finalize the design of the `InterchainTokenService` but we want to be able to support new chains as they get added to the Axelar Network. For this purpose, the service will ask a separate contract, the [`InterchainAddressTracker`](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity/blob/main/contracts/utils/InterchainAddressTracker.sol) to obtain the destination address for outgoing messages, and for validation of incoming messages.
 
 ## Interchain Token
 

contracts/address-tracker/AddressTracker.sol

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { Ownable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/Ownable.sol';
+import { InterchainAddressTracker } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/InterchainAddressTracker.sol';
+
+import { IAddressTracker } from '../interfaces/IAddressTracker.sol';
+
+contract AddressTracker is IAddressTracker, Ownable, InterchainAddressTracker {
+    constructor(
+        address owner_,
+        string memory chainName_,
+        string[] memory trustedChainNames,
+        string[] memory trustedAddresses
+    ) Ownable(owner_) InterchainAddressTracker(chainName_) {
+        uint256 length = trustedChainNames.length;
+
+        if (length != trustedAddresses.length) revert LengthMismatch();
+
+        for (uint256 i; i < length; ++i) {
+            _setTrustedAddress(trustedChainNames[i], trustedAddresses[i]);
+        }
+    }
+
+    function setTrustedAddress(string memory chain, string memory address_) external onlyOwner {
+        _setTrustedAddress(chain, address_);
+    }
+
+    function removeTrustedAddress(string memory chain) external onlyOwner {
+        _removeTrustedAddress(chain);
+    }
+}

contracts/interfaces/IAddressTracker.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { IOwnable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IOwnable.sol';
+import { IInterchainAddressTracker } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IInterchainAddressTracker.sol';
+
+interface IAddressTracker is IOwnable, IInterchainAddressTracker {
+    /**
+     * @dev Sets the trusted address for the specified chain
+     * @param chain Chain name to be trusted
+     * @param address_ Trusted address to be added for the chain
+     */
+    function setTrustedAddress(string memory chain, string memory address_) external;
+
+    /**
+     * @dev Remove the trusted address of the chain.
+     * @param chain Chain name that should be made untrusted
+     */
+    function removeTrustedAddress(string calldata chain) external;
+}

contracts/interfaces/ICanonicalTokenRegistrar.sol

@@ -8,9 +8,9 @@ interface ICanonicalTokenRegistrar {
 
     function chainNameHash() external view returns (bytes32);
 
-    function getCanonicalTokenSalt(address tokenAddress) external view returns (bytes32 salt);
+    function canonicalTokenSalt(address tokenAddress) external view returns (bytes32 salt);
 
-    function getCanonicalTokenId(address tokenAddress) external view returns (bytes32 tokenId);
+    function canonicalTokenId(address tokenAddress) external view returns (bytes32 tokenId);
 
     function registerCanonicalToken(address tokenAddress) external payable returns (bytes32 tokenId);
 

contracts/interfaces/IFlowLimit.sol

@@ -5,23 +5,23 @@ pragma solidity ^0.8.0;
 interface IFlowLimit {
     error FlowLimitExceeded(uint256 limit, uint256 flowAmount);
 
-    event FlowLimitSet(bytes32 indexed tokenId, address operator, uint256 flowLimit);
+    event FlowLimitSet(bytes32 indexed tokenId, address operator, uint256 flowLimit_);
 
     /**
      * @notice Returns the current flow limit
-     * @return flowLimit The current flow limit value
+     * @return flowLimit_ The current flow limit value
      */
-    function getFlowLimit() external view returns (uint256 flowLimit);
+    function flowLimit() external view returns (uint256 flowLimit_);
 
     /**
      * @notice Returns the current flow out amount
-     * @return flowOutAmount The current flow out amount
+     * @return flowOutAmount_ The current flow out amount
      */
-    function getFlowOutAmount() external view returns (uint256 flowOutAmount);
+    function flowOutAmount() external view returns (uint256 flowOutAmount_);
 
     /**
      * @notice Returns the current flow in amount
-     * @return flowInAmount The current flow in amount
+     * @return flowInAmount_ The current flow in amount
      */
-    function getFlowInAmount() external view returns (uint256 flowInAmount);
+    function flowInAmount() external view returns (uint256 flowInAmount_);
 }

contracts/interfaces/IInterchainTokenService.sol

@@ -4,11 +4,11 @@ pragma solidity ^0.8.0;
 
 import { IAxelarValuedExpressExecutable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarValuedExpressExecutable.sol';
 import { IContractIdentifier } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IContractIdentifier.sol';
+import { IMulticall } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IMulticall.sol';
+import { IInterchainAddressTracker } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IInterchainAddressTracker.sol';
+import { IPausable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IPausable.sol';
 
 import { ITokenManagerType } from './ITokenManagerType.sol';
-import { IPausable } from './IPausable.sol';
-import { IMulticall } from './IMulticall.sol';
-import { IRemoteAddressValidator } from './IRemoteAddressValidator.sol';
 
 interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExecutable, IPausable, IMulticall, IContractIdentifier {
     error ZeroAddress();
@@ -26,6 +26,7 @@ interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExec
     error SelectorUnknown(uint256 selector);
     error InvalidMetadataVersion(uint32 version);
     error ExecuteWithTokenNotSupported();
+    error UntrustedChain(string chainName);
     error InvalidExpressSelector(uint256 selector);
 
     event TokenSent(bytes32 indexed tokenId, string destinationChain, bytes destinationAddress, uint256 indexed amount);
@@ -82,12 +83,13 @@ interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExec
         address mintTo
     );
     event CustomTokenIdClaimed(bytes32 indexed tokenId, address indexed deployer, bytes32 indexed salt);
+    event PausedSet(bool indexed paused, address indexed msgSender);
 
     /**
-     * @notice Returns the address of the token manager deployer contract.
-     * @return remoteAddressValidator_ The remoteAddressValidator.
+     * @notice Returns the address of the interchain router contract.
+     * @return interchainAddressTracker_ The interchainAddressTracker.
      */
-    function remoteAddressValidator() external view returns (IRemoteAddressValidator remoteAddressValidator_);
+    function interchainAddressTracker() external view returns (IInterchainAddressTracker interchainAddressTracker_);
 
     /**
      * @notice Returns the address of the token manager deployer contract.
@@ -104,52 +106,52 @@ interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExec
     /**
      * @notice Returns the address of the token manager associated with the given tokenId.
      * @param tokenId The tokenId of the token manager.
-     * @return tokenManagerAddress The address of the token manager.
+     * @return tokenManagerAddress_ The address of the token manager.
      */
-    function getTokenManagerAddress(bytes32 tokenId) external view returns (address tokenManagerAddress);
+    function tokenManagerAddress(bytes32 tokenId) external view returns (address tokenManagerAddress_);
 
     /**
      * @notice Returns the address of the valid token manager associated with the given tokenId.
      * @param tokenId The tokenId of the token manager.
-     * @return tokenManagerAddress The address of the valid token manager.
+     * @return tokenManagerAddress_ The address of the valid token manager.
      */
-    function getValidTokenManagerAddress(bytes32 tokenId) external view returns (address tokenManagerAddress);
+    function validTokenManagerAddress(bytes32 tokenId) external view returns (address tokenManagerAddress_);
 
     /**
      * @notice Returns the address of the token associated with the given tokenId.
      * @param tokenId The tokenId of the token manager.
-     * @return tokenAddress The address of the token.
+     * @return tokenAddress_ The address of the token.
      */
-    function getTokenAddress(bytes32 tokenId) external view returns (address tokenAddress);
+    function tokenAddress(bytes32 tokenId) external view returns (address tokenAddress_);
 
     /**
      * @notice Returns the address of the standardized token associated with the given tokenId.
      * @param tokenId The tokenId of the standardized token.
-     * @return tokenAddress The address of the standardized token.
+     * @return tokenAddress_ The address of the standardized token.
      */
-    function getStandardizedTokenAddress(bytes32 tokenId) external view returns (address tokenAddress);
+    function standardizedTokenAddress(bytes32 tokenId) external view returns (address tokenAddress_);
 
     /**
      * @notice Returns the canonical tokenId associated with the given tokenAddress.
-     * @param tokenAddress The address of the token.
+     * @param tokenAddress_ The address of the token.
      * @return tokenId The canonical tokenId associated with the tokenAddress.
      */
-    function getCanonicalTokenId(address tokenAddress) external view returns (bytes32 tokenId);
+    function canonicalTokenId(address tokenAddress_) external view returns (bytes32 tokenId);
 
     /**
      * @notice Returns the custom tokenId associated with the given operator and salt.
-     * @param operator The operator address.
+     * @param operator_ The operator address.
      * @param salt The salt used for token id calculation.
      * @return tokenId The custom tokenId associated with the operator and salt.
      */
-    function getCustomTokenId(address operator, bytes32 salt) external view returns (bytes32 tokenId);
+    function customTokenId(address operator_, bytes32 salt) external view returns (bytes32 tokenId);
 
     /**
      * @notice Registers a canonical token and returns its associated tokenId.
-     * @param tokenAddress The address of the canonical token.
+     * @param tokenAddress_ The address of the canonical token.
      * @return tokenId The tokenId associated with the registered canonical token.
      */
-    function registerCanonicalToken(address tokenAddress) external payable returns (bytes32 tokenId);
+    function registerCanonicalToken(address tokenAddress_) external payable returns (bytes32 tokenId);
 
     /**
      * @notice Deploys a standardized canonical token on a remote chain.
@@ -235,9 +237,9 @@ interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExec
     /**
      * @notice Returns the implementation address for a given token manager type.
      * @param tokenManagerType The type of token manager.
-     * @return tokenManagerAddress The address of the token manager implementation.
+     * @return tokenManagerAddress_ The address of the token manager implementation.
      */
-    function getImplementation(uint256 tokenManagerType) external view returns (address tokenManagerAddress);
+    function tokenManagerImplementation(uint256 tokenManagerType) external view returns (address tokenManagerAddress_);
 
     function interchainTransfer(
         bytes32 tokenId,
@@ -283,23 +285,23 @@ interface IInterchainTokenService is ITokenManagerType, IAxelarValuedExpressExec
     /**
      * @notice Returns the flow limit for a specific token.
      * @param tokenId The tokenId of the token.
-     * @return flowLimit The flow limit for the token.
+     * @return flowLimit_ The flow limit for the token.
      */
-    function getFlowLimit(bytes32 tokenId) external view returns (uint256 flowLimit);
+    function flowLimit(bytes32 tokenId) external view returns (uint256 flowLimit_);
 
     /**
      * @notice Returns the total amount of outgoing flow for a specific token.
      * @param tokenId The tokenId of the token.
-     * @return flowOutAmount The total amount of outgoing flow for the token.
+     * @return flowOutAmount_ The total amount of outgoing flow for the token.
      */
-    function getFlowOutAmount(bytes32 tokenId) external view returns (uint256 flowOutAmount);
+    function flowOutAmount(bytes32 tokenId) external view returns (uint256 flowOutAmount_);
 
     /**
      * @notice Returns the total amount of incoming flow for a specific token.
      * @param tokenId The tokenId of the token.
-     * @return flowInAmount The total amount of incoming flow for the token.
+     * @return flowInAmount_ The total amount of incoming flow for the token.
      */
-    function getFlowInAmount(bytes32 tokenId) external view returns (uint256 flowInAmount);
+    function flowInAmount(bytes32 tokenId) external view returns (uint256 flowInAmount_);
 
     /**
      * @notice Sets the paused state of the contract.