feat: custom token registrars

.solhint.json

@@ -8,6 +8,7 @@
     "no-inline-assembly": "off",
     "no-empty-blocks": "off",
     "avoid-low-level-calls": "off",
-    "not-rely-on-time": "off"
+    "not-rely-on-time": "off",
+    "immutable-vars-naming": "off"
   }
 }

contracts/interchain-token-service/InterchainTokenService.sol

@@ -17,7 +17,6 @@ import { IRemoteAddressValidator } from '../interfaces/IRemoteAddressValidator.s
 import { IInterchainTokenExecutable } from '../interfaces/IInterchainTokenExecutable.sol';
 import { IInterchainTokenExpressExecutable } from '../interfaces/IInterchainTokenExpressExecutable.sol';
 import { ITokenManager } from '../interfaces/ITokenManager.sol';
-import { ITokenManagerProxy } from '../interfaces/ITokenManagerProxy.sol';
 import { IERC20Named } from '../interfaces/IERC20Named.sol';
 
 import { AddressBytesUtils } from '../libraries/AddressBytesUtils.sol';
@@ -495,7 +494,7 @@ contract InterchainTokenService is
      * @param tokenIds an array of the token Ids of the tokenManagers to set the flow limit of.
      * @param flowLimits the flowLimits to set
      */
-    function setFlowLimits(bytes32[] calldata tokenIds, uint256[] calldata flowLimits) external onlyOperator {
+    function setFlowLimits(bytes32[] calldata tokenIds, uint256[] calldata flowLimits) external onlyRole(uint8(Roles.OPERATOR)) {
         uint256 length = tokenIds.length;
         if (length != flowLimits.length) revert LengthMismatch();
         for (uint256 i; i < length; ++i) {
@@ -518,7 +517,7 @@ contract InterchainTokenService is
     \****************/
 
     function _setup(bytes calldata params) internal override {
-        _setOperator(params.toAddress());
+        _addOperator(params.toAddress());
     }
 
     function _sanitizeTokenManagerImplementation(

contracts/interfaces/ICanonicalTokenRegistrar.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+interface ICanonicalTokenRegistrar {
+    error ZeroAddress();
+
+    function chainNameHash() external view returns (bytes32);
+
+    function getCanonicalTokenSalt(address tokenAddress) external view returns (bytes32 salt);
+
+    function getCanonicalTokenId(address tokenAddress) external view returns (bytes32 tokenId);
+
+    function registerCanonicalToken(address tokenAddress) external payable returns (bytes32 tokenId);
+
+    function deployAndRegisterRemoteCanonicalToken(bytes32 salt, string calldata destinationChain, uint256 gasValue) external payable;
+}

contracts/interfaces/IDistributable.sol

@@ -2,19 +2,9 @@
 
 pragma solidity ^0.8.0;
 
-interface IDistributable {
-    error NotDistributor();
-    error NotProposedDistributor();
-
-    event DistributorshipTransferred(address indexed distributor);
-    event DistributorshipTransferStarted(address indexed distributor);
-
-    /**
-     * @notice Get the address of the distributor
-     * @return distributor_ of the distributor
-     */
-    function distributor() external view returns (address distributor_);
+import { IRolesBase } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IRolesBase.sol';
 
+interface IDistributable is IRolesBase {
     /**
      * @notice Change the distributor of the contract
      * @dev Can only be called by the current distributor
@@ -33,5 +23,11 @@ interface IDistributable {
      * @notice Accept a change of the distributor of the contract
      * @dev Can only be called by the proposed distributor
      */
-    function acceptDistributorship() external;
+    function acceptDistributorship(address fromDistributor) external;
+
+    /**
+     * @notice Query if an address is a distributor
+     * @param addr the address to query for
+     */
+    function isDistributor(address addr) external view returns (bool);
 }

contracts/interfaces/IInterchainTokenService.sol

@@ -9,6 +9,7 @@ import { IExpressCallHandler } from './IExpressCallHandler.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, IExpressCallHandler, IAxelarExecutable, IPausable, IMulticall, IContractIdentifier {
     error ZeroAddress();
@@ -78,6 +79,12 @@ interface IInterchainTokenService is ITokenManagerType, IExpressCallHandler, IAx
     );
     event CustomTokenIdClaimed(bytes32 indexed tokenId, address indexed deployer, bytes32 indexed salt);
 
+    /**
+     * @notice Returns the address of the token manager deployer contract.
+     * @return remoteAddressValidator The remoteAddressValidator.
+     */
+    function remoteAddressValidator() external view returns (IRemoteAddressValidator remoteAddressValidator);
+
     /**
      * @notice Returns the address of the token manager deployer contract.
      * @return tokenManagerDeployerAddress The address of the token manager deployer contract.

contracts/interfaces/IOperatable.sol

@@ -2,19 +2,9 @@
 
 pragma solidity ^0.8.0;
 
-interface IOperatable {
-    error NotOperator();
-    error NotProposedOperator();
-
-    event OperatorshipTransferred(address indexed operator);
-    event OperatorChangeProposed(address indexed operator);
-
-    /**
-     * @notice Get the address of the operator
-     * @return operator_ of the operator
-     */
-    function operator() external view returns (address operator_);
+import { IRolesBase } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IRolesBase.sol';
 
+interface IOperatable is IRolesBase {
     /**
      * @notice Change the operator of the contract
      * @dev Can only be called by the current operator
@@ -33,5 +23,11 @@ interface IOperatable {
      * @notice Accept a proposed change of operatorship
      * @dev Can only be called by the proposed operator
      */
-    function acceptOperatorship() external;
+    function acceptOperatorship(address fromOperator) external;
+
+    /**
+     * @notice Query if an address is a operator
+     * @param addr the address to query for
+     */
+    function isOperator(address addr) external view returns (bool);
 }

contracts/interfaces/IStandardizedToken.sol

@@ -2,20 +2,34 @@
 
 pragma solidity ^0.8.0;
 
-import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 import { IContractIdentifier } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IContractIdentifier.sol';
 
-import { IImplementation } from './IImplementation.sol';
 import { IInterchainToken } from './IInterchainToken.sol';
 import { IDistributable } from './IDistributable.sol';
 import { IERC20MintableBurnable } from './IERC20MintableBurnable.sol';
+import { ITokenManager } from './ITokenManager.sol';
+import { IERC20Named } from './IERC20Named.sol';
 
 /**
  * @title StandardizedToken
  * @notice This contract implements a standardized token which extends InterchainToken functionality.
  * This contract also inherits Distributable and Implementation logic.
  */
-interface IStandardizedToken is IImplementation, IInterchainToken, IDistributable, IERC20MintableBurnable, IERC20, IContractIdentifier {
+interface IStandardizedToken is IInterchainToken, IDistributable, IERC20MintableBurnable, IERC20Named, IContractIdentifier {
     error TokenManagerAddressZero();
     error TokenNameEmpty();
+
+    /**
+     * @notice Called by the proxy to setup itself.
+     * @dev This should be hidden by the proxy.
+     * @param params the data to be used for the initialization.
+     */
+    function setup(bytes calldata params) external;
+
+    /**
+     * @notice Getter for the tokenManager used for this token.
+     * @dev Needs to be overwitten.
+     * @return tokenManager_ the TokenManager called to facilitate cross chain transfers.
+     */
+    function tokenManager() external view returns (ITokenManager tokenManager_);
 }

contracts/interfaces/IStandardizedTokenDeployer.sol

@@ -2,8 +2,6 @@
 
 pragma solidity ^0.8.0;
 
-import { Create3Deployer } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/deploy/Create3Deployer.sol';
-
 /**
  * @title IStandardizedTokenDeployer
  * @notice This contract is used to deploy new instances of the StandardizedTokenProxy contract.

contracts/interfaces/IStandardizedTokenRegistrar.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+interface IStandardizedTokenRegistrar {
+    error ZeroAddress();
+    error NotDistributor(address distributor);
+    error NotOperator(address operator);
+
+    function chainNameHash() external view returns (bytes32);
+
+    function getStandardizedTokenSalt(address deployer, bytes32 salt) external view returns (bytes32);
+
+    function getStandardizedTokenId(address deployer, bytes32 salt) external view returns (bytes32 tokenId);
+
+    function getStandardizedTokenAddress(address deployer, bytes32 salt) external view returns (address tokenAddress);
+
+    function deployStandardizedToken(
+        bytes32 salt,
+        string calldata name,
+        string calldata symbol,
+        uint8 decimals,
+        uint256 mintAmount,
+        address distributor
+    ) external payable;
+
+    function deployRemoteStandarizedToken(
+        bytes32 salt,
+        address additionalDistributor,
+        address optionalOperator,
+        string memory destinationChain,
+        uint256 gasValue
+    ) external payable;
+}

contracts/interfaces/ITokenManager.sol

@@ -17,6 +17,9 @@ interface ITokenManager is ITokenManagerType, IOperatable, IFlowLimit, IImplemen
     error TakeTokenFailed();
     error GiveTokenFailed();
     error NotToken();
+    error ZeroAddress();
+    error AlreadyFlowLimiter(address flowLimiter);
+    error NotFlowLimiter(address flowLimiter);
 
     /**
      * @notice A function that returns the token id.

contracts/interfaces/ITokenManagerDeployer.sol

@@ -2,8 +2,6 @@
 
 pragma solidity ^0.8.0;
 
-import { Create3Deployer } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/deploy/Create3Deployer.sol';
-
 /**
  * @title ITokenManagerDeployer
  * @notice This contract is used to deploy new instances of the TokenManagerProxy contract.

contracts/proxies/CanonicalTokenRegistrarProxy.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { FinalProxy } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/FinalProxy.sol';
+
+/**
+ * @title InterchainTokenServiceProxy
+ * @dev Proxy contract for interchain token service contracts. Inherits from the FinalProxy contract.
+ */
+contract CanonicalTokenRegistrarProxy is FinalProxy {
+    bytes32 private constant CONTRACT_ID = keccak256('canonical-token-registrar');
+
+    /**
+     * @dev Constructs the InterchainTokenServiceProxy contract.
+     * @param implementationAddress Address of the interchain token service implementation
+     * @param owner Address of the owner of the proxy
+     */
+    constructor(address implementationAddress, address owner) FinalProxy(implementationAddress, owner, '') {}
+
+    /**
+     * @dev Override for the 'contractId' function in FinalProxy. Returns a unique identifier for this contract.
+     * @return bytes32 identifier for this contract
+     */
+    function contractId() internal pure override returns (bytes32) {
+        return CONTRACT_ID;
+    }
+}

contracts/proxies/StandardizedTokenRegistrarProxy.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { FinalProxy } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/FinalProxy.sol';
+
+/**
+ * @title InterchainTokenServiceProxy
+ * @dev Proxy contract for interchain token service contracts. Inherits from the FinalProxy contract.
+ */
+contract StandardizedTokenRegistrarProxy is FinalProxy {
+    bytes32 private constant CONTRACT_ID = keccak256('standardized-token-registrar');
+
+    /**
+     * @dev Constructs the InterchainTokenServiceProxy contract.
+     * @param implementationAddress Address of the interchain token service implementation
+     * @param owner Address of the owner of the proxy
+     */
+    constructor(address implementationAddress, address owner) FinalProxy(implementationAddress, owner, '') {}
+
+    /**
+     * @dev Override for the 'contractId' function in FinalProxy. Returns a unique identifier for this contract.
+     * @return bytes32 identifier for this contract
+     */
+    function contractId() internal pure override returns (bytes32) {
+        return CONTRACT_ID;
+    }
+}

contracts/test/FeeOnTransferTokenTest.sol

@@ -19,7 +19,7 @@ contract FeeOnTransferTokenTest is InterchainToken, Distributable, IERC20Mintabl
         name = name_;
         symbol = symbol_;
         decimals = decimals_;
-        _setDistributor(msg.sender);
+        _addDistributor(msg.sender);
         tokenManager_ = ITokenManager(tokenManagerAddress);
     }
 
@@ -50,11 +50,11 @@ contract FeeOnTransferTokenTest is InterchainToken, Distributable, IERC20Mintabl
         tokenManagerRequiresApproval_ = requiresApproval;
     }
 
-    function mint(address account, uint256 amount) external onlyDistributor {
+    function mint(address account, uint256 amount) external onlyRole(uint8(Roles.DISTRIBUTOR)) {
         _mint(account, amount);
     }
 
-    function burn(address account, uint256 amount) external onlyDistributor {
+    function burn(address account, uint256 amount) external onlyRole(uint8(Roles.DISTRIBUTOR)) {
         _burn(account, amount);
     }
 

contracts/test/HardCodedConstantsTest.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MIT
 
 pragma solidity ^0.8.0;
 
 import { TokenManagerLiquidityPool } from '../token-manager/implementations/TokenManagerLiquidityPool.sol';
 import { Distributable } from '../utils/Distributable.sol';
@@ -13,25 +13,22 @@
     string public constant NAME = 'TestTokenManager';
 
     constructor(address interchainTokenService_) TokenManagerLiquidityPool(interchainTokenService_) {
         require(TOKEN_ADDRESS_SLOT == uint256(keccak256('token-address')) - 1, 'invalid constant');
         require(LIQUIDITY_POOL_SLOT == uint256(keccak256('liquidity-pool-slot')) - 1, 'invalid constant');
     }
 }
 
 contract TestDistributable is Distributable {
     string public constant NAME = 'TestDistributable';
 
-    constructor() {
-        require(DISTRIBUTOR_SLOT == uint256(keccak256('distributor')) - 1, 'invalid constant');
-        require(PROPOSED_DISTRIBUTOR_SLOT == uint256(keccak256('proposed-distributor')) - 1, 'invalid constant');
-    }
+    constructor() {}
 }
 
 contract TestFlowLimit is FlowLimit {
     string public constant NAME = 'TestFlowLimit';
 
     constructor() {
         require(FLOW_LIMIT_SLOT == uint256(keccak256('flow-limit')) - 1, 'invalid constant');
     }
 }
 
@@ -39,23 +36,20 @@
     string public constant NAME = 'TestNoReEntrancy';
 
     constructor() {
         require(ENTERED_SLOT == uint256(keccak256('entered')) - 1, 'invalid constant');
     }
 }
 
 contract TestOperatable is Operatable {
     string public constant NAME = 'TestOperatable';
 
-    constructor() {
-        require(OPERATOR_SLOT == uint256(keccak256('operator')) - 1, 'invalid constant');
-        require(PROPOSED_OPERATOR_SLOT == uint256(keccak256('proposed-operator')) - 1, 'invalid constant');
-    }
+    constructor() {}
 }
 
 contract TestPausable is Pausable {
     string public constant NAME = 'TestPausable';
 
     constructor() {
         require(PAUSE_SLOT == uint256(keccak256('paused')) - 1, 'invalid constant');
     }
 }

contracts/test/InterchainExecutableTest.sol

@@ -3,7 +3,6 @@
 pragma solidity ^0.8.0;
 
 import { InterchainTokenExpressExecutable } from '../examples/InterchainTokenExpressExecutable.sol';
-import { IInterchainTokenService } from '../interfaces/IInterchainTokenService.sol';
 import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 
 contract InterchainExecutableTest is InterchainTokenExpressExecutable {

contracts/test/InterchainTokenTest.sol

@@ -18,7 +18,7 @@ contract InterchainTokenTest is InterchainToken, Distributable, IERC20MintableBu
         name = name_;
         symbol = symbol_;
         decimals = decimals_;
-        _setDistributor(msg.sender);
+        _addDistributor(msg.sender);
         tokenManager_ = ITokenManager(tokenManagerAddress);
     }
 
@@ -49,11 +49,11 @@ contract InterchainTokenTest is InterchainToken, Distributable, IERC20MintableBu
         tokenManagerRequiresApproval_ = requiresApproval;
     }
 
-    function mint(address account, uint256 amount) external onlyDistributor {
+    function mint(address account, uint256 amount) external onlyRole(uint8(Roles.DISTRIBUTOR)) {
         _mint(account, amount);
     }
 
-    function burn(address account, uint256 amount) external onlyDistributor {
+    function burn(address account, uint256 amount) external onlyRole(uint8(Roles.DISTRIBUTOR)) {
         _burn(account, amount);
     }