@hyperlane-xyz/core 1.5.7-beta1 → 1.5.8

package/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/**
+ * Format of metadata:
+ * [   0:  32] Origin mailbox address
+ * [  32:  64] Signed checkpoint root
+ * [  64:????] Validator signatures (length := threshold * 65)
+ */
+library MessageIdMultisigIsmMetadata {
+    uint8 private constant ORIGIN_MAILBOX_OFFSET = 0;
+    uint8 private constant MERKLE_ROOT_OFFSET = 32;
+    uint8 private constant SIGNATURES_OFFSET = 64;
+    uint8 private constant SIGNATURE_LENGTH = 65;
+
+    /**
+     * @notice Returns the origin mailbox of the signed checkpoint as bytes32.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Origin mailbox of the signed checkpoint as bytes32
+     */
+    function originMailbox(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes32)
+    {
+        return
+            bytes32(
+                _metadata[ORIGIN_MAILBOX_OFFSET:ORIGIN_MAILBOX_OFFSET + 32]
+            );
+    }
+
+    /**
+     * @notice Returns the merkle root of the signed checkpoint.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Merkle root of the signed checkpoint
+     */
+    function root(bytes calldata _metadata) internal pure returns (bytes32) {
+        return bytes32(_metadata[MERKLE_ROOT_OFFSET:MERKLE_ROOT_OFFSET + 32]);
+    }
+
+    /**
+     * @notice Returns the validator ECDSA signature at `_index`.
+     * @dev Assumes signatures are sorted by validator
+     * @dev Assumes `_metadata` encodes `threshold` signatures.
+     * @dev Assumes `_index` is less than `threshold`
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @param _index The index of the signature to return.
+     * @return The validator ECDSA signature at `_index`.
+     */
+    function signatureAt(bytes calldata _metadata, uint256 _index)
+        internal
+        pure
+        returns (bytes calldata)
+    {
+        uint256 _start = SIGNATURES_OFFSET + (_index * SIGNATURE_LENGTH);
+        uint256 _end = _start + SIGNATURE_LENGTH;
+        return _metadata[_start:_end];
+    }
+}

package/contracts/libs/middleware/InterchainAccountMessage.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {CallLib} from "../Call.sol";
+import {TypeCasts} from "../TypeCasts.sol";
+
+/**
+ * Format of message:
+ * [   0:  32] ICA owner
+ * [  32:  64] ICA ISM
+ * [  64:????] Calls, abi encoded
+ */
+library InterchainAccountMessage {
+    using TypeCasts for bytes32;
+
+    /**
+     * @notice Returns formatted (packed) InterchainAccountMessage
+     * @dev This function should only be used in memory message construction.
+     * @param _owner The owner of the interchain account
+     * @param _ism The address of the remote ISM
+     * @param _to The address of the contract to call
+     * @param _value The value to include in the call
+     * @param _data The calldata
+     * @return Formatted message body
+     */
+    function encode(
+        address _owner,
+        bytes32 _ism,
+        address _to,
+        uint256 _value,
+        bytes memory _data
+    ) internal pure returns (bytes memory) {
+        CallLib.Call[] memory _calls = new CallLib.Call[](1);
+        _calls[0] = CallLib.build(_to, _value, _data);
+        return abi.encode(TypeCasts.addressToBytes32(_owner), _ism, _calls);
+    }
+
+    /**
+     * @notice Returns formatted (packed) InterchainAccountMessage
+     * @dev This function should only be used in memory message construction.
+     * @param _owner The owner of the interchain account
+     * @param _ism The address of the remote ISM
+     * @param _calls The sequence of calls to make
+     * @return Formatted message body
+     */
+    function encode(
+        bytes32 _owner,
+        bytes32 _ism,
+        CallLib.Call[] calldata _calls
+    ) internal pure returns (bytes memory) {
+        return abi.encode(_owner, _ism, _calls);
+    }
+
+    /**
+     * @notice Returns formatted (packed) InterchainAccountMessage
+     * @dev This function should only be used in memory message construction.
+     * @param _owner The owner of the interchain account
+     * @param _ism The address of the remote ISM
+     * @param _calls The sequence of calls to make
+     * @return Formatted message body
+     */
+    function encode(
+        address _owner,
+        bytes32 _ism,
+        CallLib.Call[] calldata _calls
+    ) internal pure returns (bytes memory) {
+        return encode(TypeCasts.addressToBytes32(_owner), _ism, _calls);
+    }
+
+    /**
+     * @notice Parses and returns the calls from the provided message
+     * @param _message The interchain account message
+     * @return The array of calls
+     */
+    function decode(bytes calldata _message)
+        internal
+        pure
+        returns (
+            bytes32,
+            bytes32,
+            CallLib.Call[] memory
+        )
+    {
+        return abi.decode(_message, (bytes32, bytes32, CallLib.Call[]));
+    }
+
+    /**
+     * @notice Parses and returns the ISM address from the provided message
+     * @param _message The interchain account message
+     * @return The ISM encoded in the message
+     */
+    function ism(bytes calldata _message) internal pure returns (address) {
+        return address(bytes20(_message[44:64]));
+    }
+}

package/contracts/libs/middleware/InterchainQueryMessage.sol

@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.13;
+
+import {CallLib} from "../Call.sol";
+
+/**
+ * Format of message:
+ * [   0: 32] Sender address
+ * [  32: 64] Message type (left padded with zeroes)
+ * [  64:???] Encoded call array
+ */
+library InterchainQueryMessage {
+    uint256 private constant SENDER_OFFSET = 0;
+    uint256 private constant TYPE_OFFSET = 32;
+    uint256 private constant CALLS_OFFSET = 64;
+
+    enum MessageType {
+        QUERY,
+        RESPONSE
+    }
+
+    /**
+     * @notice Parses and returns the query sender from the provided message
+     * @param _message The interchain query message
+     * @return The query sender as bytes32
+     */
+    function sender(bytes calldata _message) internal pure returns (bytes32) {
+        return bytes32(_message[SENDER_OFFSET:TYPE_OFFSET]);
+    }
+
+    /**
+     * @notice Parses and returns the message type from the provided message
+     * @param _message The interchain query message
+     * @return The message type (query or response)
+     */
+    function messageType(bytes calldata _message)
+        internal
+        pure
+        returns (MessageType)
+    {
+        // left padded with zeroes
+        return MessageType(uint8(bytes1(_message[CALLS_OFFSET - 1])));
+    }
+
+    /**
+     * @notice Returns formatted InterchainQueryMessage, type == QUERY
+     * @param _sender The query sender as bytes32
+     * @param _calls The sequence of queries to make, with the corresponding
+     * response callbacks
+     * @return Formatted message body
+     */
+    function encode(
+        bytes32 _sender,
+        CallLib.StaticCallWithCallback[] calldata _calls
+    ) internal pure returns (bytes memory) {
+        return abi.encode(_sender, MessageType.QUERY, _calls);
+    }
+
+    /**
+     * @notice Returns formatted InterchainQueryMessage, type == QUERY
+     * @param _sender The query sender as bytes32
+     * @param _to The address of the contract to query
+     * @param _data The calldata encoding the query
+     * @param _callback The calldata of the callback that will be made on the sender.
+     * The return value of the query will be appended.
+     * @return Formatted message body
+     */
+    function encode(
+        bytes32 _sender,
+        address _to,
+        bytes memory _data,
+        bytes memory _callback
+    ) internal pure returns (bytes memory) {
+        CallLib.StaticCallWithCallback[]
+            memory _calls = new CallLib.StaticCallWithCallback[](1);
+        _calls[0] = CallLib.build(_to, _data, _callback);
+        return abi.encode(_sender, MessageType.QUERY, _calls);
+    }
+
+    /**
+     * @notice Parses and returns the calls and callbacks from the message
+     * @param _message The interchain query message, type == QUERY
+     * @return _calls The sequence of queries to make with the corresponding
+     * response callbacks
+     */
+    function callsWithCallbacks(bytes calldata _message)
+        internal
+        pure
+        returns (CallLib.StaticCallWithCallback[] memory _calls)
+    {
+        assert(messageType(_message) == MessageType.QUERY);
+        (, , _calls) = abi.decode(
+            _message,
+            (bytes32, MessageType, CallLib.StaticCallWithCallback[])
+        );
+    }
+
+    /**
+     * @notice Returns formatted InterchainQueryMessage, type == RESPONSE
+     * @param _sender The query sender as bytes32
+     * @param _calls The sequence of callbacks to make
+     * @return Formatted message body
+     */
+    function encode(bytes32 _sender, bytes[] memory _calls)
+        internal
+        pure
+        returns (bytes memory)
+    {
+        return abi.encode(_sender, MessageType.RESPONSE, _calls);
+    }
+
+    /**
+     * @notice Parses and returns the callbacks from the message
+     * @param _message The interchain query message, type == RESPONSE
+     * @return _calls The sequence of callbacks to make
+     */
+    function rawCalls(bytes calldata _message)
+        internal
+        pure
+        returns (bytes[] memory _calls)
+    {
+        assert(messageType(_message) == MessageType.RESPONSE);
+        (, , _calls) = abi.decode(_message, (bytes32, MessageType, bytes[]));
+    }
+}

package/contracts/middleware/InterchainAccountRouter.sol

@@ -2,13 +2,16 @@
 pragma solidity ^0.8.13;
 
 // ============ Internal Imports ============
-import {OwnableMulticall} from "./libs/OwnableMulticall.sol";
-import {InterchainAccountMessage} from "./libs/InterchainAccountMessage.sol";
-import {CallLib} from "./libs/Call.sol";
+import {OwnableMulticall} from "../OwnableMulticall.sol";
+import {HyperlaneConnectionClient} from "../HyperlaneConnectionClient.sol";
+import {IRouter} from "../interfaces/IRouter.sol";
+import {IInterchainAccountRouter} from "../interfaces/middleware/IInterchainAccountRouter.sol";
+import {InterchainAccountMessage} from "../libs/middleware/InterchainAccountMessage.sol";
 import {MinimalProxy} from "../libs/MinimalProxy.sol";
+import {CallLib} from "../libs/Call.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
 import {EnumerableMapExtended} from "../libs/EnumerableMapExtended.sol";
-import {Router} from "../client/Router.sol";
+import {Router} from "../Router.sol";
 
 // ============ External Imports ============
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
@@ -19,7 +22,7 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
  * @title A contract that allows accounts on chain A to call contracts via a
  * proxy contract on chain B.
  */
-contract InterchainAccountRouter is Router {
+contract InterchainAccountRouter is Router, IInterchainAccountRouter {
     // ============ Libraries ============
 
     using TypeCasts for address;
@@ -27,6 +30,7 @@ contract InterchainAccountRouter is Router {
 
     // ============ Constants ============
 
+    uint32 internal immutable localDomain;
     address internal implementation;
     bytes32 internal bytecodeHash;
 
@@ -76,26 +80,38 @@ contract InterchainAccountRouter is Router {
 
     // ============ Constructor ============
 
-    constructor(address _mailbox) Router(_mailbox) {}
+    /**
+     * @notice Constructor deploys a relay (OwnableMulticall.sol) contract that
+     * will be cloned for each interchain account.
+     * @param _localDomain The Hyperlane domain ID on which this contract is
+     * deployed.
+     */
+    constructor(uint32 _localDomain) {
+        localDomain = _localDomain;
+    }
 
     // ============ Initializers ============
 
     /**
      * @notice Initializes the contract with HyperlaneConnectionClient contracts
+     * @param _mailbox The address of the mailbox contract
      * @param _interchainGasPaymaster Unused but required by HyperlaneConnectionClient
      * @param _interchainSecurityModule The address of the local ISM contract
      * @param _owner The address with owner privileges
      */
     function initialize(
+        address _mailbox,
         address _interchainGasPaymaster,
         address _interchainSecurityModule,
         address _owner
     ) external initializer {
-        _MailboxClient_initialize(
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
             _interchainGasPaymaster,
             _interchainSecurityModule,
             _owner
         );
+        require(localDomain == mailbox.localDomain(), "domain mismatch");
 
         implementation = address(new OwnableMulticall(address(this)));
         // cannot be stored immutably because it is dynamically sized
@@ -202,7 +218,7 @@ contract InterchainAccountRouter is Router {
         uint32 _origin,
         bytes32 _sender,
         bytes calldata _message
-    ) external payable override onlyMailbox {
+    ) external override onlyMailbox {
         (
             bytes32 _owner,
             bytes32 _ism,
@@ -213,7 +229,7 @@ contract InterchainAccountRouter is Router {
             _origin,
             _owner,
             _sender,
-            _ism.bytes32ToAddress()
+            TypeCasts.bytes32ToAddress(_ism)
         );
         _interchainAccount.multicall(_calls);
     }
@@ -233,11 +249,13 @@ contract InterchainAccountRouter is Router {
         address _router,
         address _ism
     ) external view returns (OwnableMulticall) {
+        bytes32 _routerAsBytes32 = TypeCasts.addressToBytes32(_router);
+        bytes32 _ownerAsBytes32 = TypeCasts.addressToBytes32(_owner);
         return
             getLocalInterchainAccount(
                 _origin,
-                _owner.addressToBytes32(),
-                _router.addressToBytes32(),
+                _ownerAsBytes32,
+                _routerAsBytes32,
                 _ism
             );
     }
@@ -256,8 +274,8 @@ contract InterchainAccountRouter is Router {
         view
         returns (address)
     {
-        address _router = routers(_destination).bytes32ToAddress();
-        address _ism = isms[_destination].bytes32ToAddress();
+        address _router = TypeCasts.bytes32ToAddress(routers(_destination));
+        address _ism = TypeCasts.bytes32ToAddress(isms[_destination]);
         return getRemoteInterchainAccount(_owner, _router, _ism);
     }
 
@@ -280,8 +298,8 @@ contract InterchainAccountRouter is Router {
         return
             getDeployedInterchainAccount(
                 _origin,
-                _owner.addressToBytes32(),
-                _router.addressToBytes32(),
+                TypeCasts.addressToBytes32(_owner),
+                TypeCasts.addressToBytes32(_router),
                 _ism
             );
     }
@@ -304,7 +322,7 @@ contract InterchainAccountRouter is Router {
             _origin,
             _owner,
             _router,
-            _ism.addressToBytes32()
+            TypeCasts.addressToBytes32(_ism)
         );
         address payable _account = _getLocalInterchainAccount(_salt);
         if (!Address.isContract(_account)) {
@@ -333,7 +351,12 @@ contract InterchainAccountRouter is Router {
         return
             OwnableMulticall(
                 _getLocalInterchainAccount(
-                    _getSalt(_origin, _owner, _router, _ism.addressToBytes32())
+                    _getSalt(
+                        _origin,
+                        _owner,
+                        _router,
+                        TypeCasts.addressToBytes32(_ism)
+                    )
                 )
             );
     }
@@ -374,9 +397,9 @@ contract InterchainAccountRouter is Router {
         bytes32 _bytecodeHash = keccak256(_proxyBytecode);
         bytes32 _salt = _getSalt(
             localDomain,
-            _owner.addressToBytes32(),
-            address(this).addressToBytes32(),
-            _ism.addressToBytes32()
+            TypeCasts.addressToBytes32(_owner),
+            TypeCasts.addressToBytes32(address(this)),
+            TypeCasts.addressToBytes32(_ism)
         );
         return Create2.computeAddress(_salt, _bytecodeHash, _router);
     }

package/contracts/middleware/InterchainQueryRouter.sol

@@ -2,9 +2,10 @@
 pragma solidity ^0.8.13;
 
 // ============ Internal Imports ============
-import {Router} from "../client/Router.sol";
-import {CallLib} from "./libs/Call.sol";
-import {InterchainQueryMessage} from "./libs/InterchainQueryMessage.sol";
+import {CallLib} from "../libs/Call.sol";
+import {Router} from "../Router.sol";
+import {IInterchainQueryRouter} from "../interfaces/middleware/IInterchainQueryRouter.sol";
+import {InterchainQueryMessage} from "../libs/middleware/InterchainQueryMessage.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
 
 // ============ External Imports ============
@@ -16,10 +17,9 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
  * @title Interchain Query Router that performs remote view calls on other chains and returns the result.
  * @dev Currently does not support Sovereign Consensus (user specified Interchain Security Modules).
  */
-contract InterchainQueryRouter is Router {
+contract InterchainQueryRouter is Router, IInterchainQueryRouter {
     using TypeCasts for address;
     using TypeCasts for bytes32;
-    using InterchainQueryMessage for bytes;
 
     /**
      * @notice Emitted when a query is dispatched to another chain.
@@ -40,20 +40,21 @@ contract InterchainQueryRouter is Router {
      */
     event QueryResolved(uint32 indexed destination, address indexed sender);
 
-    constructor(address _mailbox) Router(_mailbox) {}
-
     /**
      * @notice Initializes the Router contract with Hyperlane core contracts and the address of the interchain security module.
+     * @param _mailbox The address of the mailbox contract.
      * @param _interchainGasPaymaster The address of the interchain gas paymaster contract.
      * @param _interchainSecurityModule The address of the interchain security module contract.
      * @param _owner The address with owner privileges.
      */
     function initialize(
+        address _mailbox,
         address _interchainGasPaymaster,
         address _interchainSecurityModule,
         address _owner
     ) external initializer {
-        _MailboxClient_initialize(
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
             _interchainGasPaymaster,
             _interchainSecurityModule,
             _owner
@@ -116,8 +117,9 @@ contract InterchainQueryRouter is Router {
         bytes32, // router sender
         bytes calldata _message
     ) internal override {
-        InterchainQueryMessage.MessageType messageType = _message.messageType();
-        bytes32 sender = _message.sender();
+        InterchainQueryMessage.MessageType messageType = InterchainQueryMessage
+            .messageType(_message);
+        bytes32 sender = InterchainQueryMessage.sender(_message);
         if (messageType == InterchainQueryMessage.MessageType.QUERY) {
             CallLib.StaticCallWithCallback[]
                 memory callsWithCallback = InterchainQueryMessage
@@ -132,7 +134,7 @@ contract InterchainQueryRouter is Router {
             );
         } else if (messageType == InterchainQueryMessage.MessageType.RESPONSE) {
             address senderAddress = sender.bytes32ToAddress();
-            bytes[] memory rawCalls = _message.rawCalls();
+            bytes[] memory rawCalls = InterchainQueryMessage.rawCalls(_message);
             CallLib.multicallto(senderAddress, rawCalls);
             emit QueryResolved(_origin, senderAddress);
         } else {

package/contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import {Router} from "../../client/Router.sol";
+import {Router} from "../../Router.sol";
 
 import {ILiquidityLayerRouter} from "../../interfaces/ILiquidityLayerRouter.sol";
 import {ICircleMessageTransmitter} from "./interfaces/circle/ICircleMessageTransmitter.sol";
@@ -21,20 +21,21 @@ contract LiquidityLayerRouter is Router, ILiquidityLayerRouter {
 
     event LiquidityLayerAdapterSet(string indexed bridge, address adapter);
 
-    constructor(address _mailbox) Router(_mailbox) {}
-
     /**
      * @notice Initializes the Router contract with Hyperlane core contracts and the address of the interchain security module.
+     * @param _mailbox The address of the mailbox contract.
      * @param _interchainGasPaymaster The address of the interchain gas paymaster contract.
      * @param _interchainSecurityModule The address of the interchain security module contract.
      * @param _owner The address with owner privileges.
      */
     function initialize(
+        address _mailbox,
         address _interchainGasPaymaster,
         address _interchainSecurityModule,
         address _owner
     ) external initializer {
-        _MailboxClient_initialize(
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
             _interchainGasPaymaster,
             _interchainSecurityModule,
             _owner

package/contracts/middleware/liquidity-layer/adapters/CircleBridgeAdapter.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import {Router} from "../../../client/Router.sol";
+import {Router} from "../../../Router.sol";
 
 import {ITokenMessenger} from "../interfaces/circle/ITokenMessenger.sol";
 import {ICircleMessageTransmitter} from "../interfaces/circle/ICircleMessageTransmitter.sol";
@@ -62,8 +62,6 @@ contract CircleBridgeAdapter is ILiquidityLayerAdapter, Router {
         _;
     }
 
-    constructor(address _mailbox) Router(_mailbox) {}
-
     /**
      * @param _owner The new owner.
      * @param _tokenMessenger The TokenMessenger contract.

package/contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import {Router} from "../../../client/Router.sol";
+import {Router} from "../../../Router.sol";
 
 import {IPortalTokenBridge} from "../interfaces/portal/IPortalTokenBridge.sol";
 import {ILiquidityLayerAdapter} from "../interfaces/ILiquidityLayerAdapter.sol";
@@ -21,14 +21,14 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
     /// @notice transferId => token address
     mapping(bytes32 => address) public portalTransfersProcessed;
 
+    uint32 public localDomain;
+
     // We could technically use Portal's sequence number here but it doesn't
     // get passed through, so we would have to parse the VAA twice
     // 224 bits should be large enough and allows us to pack into a single slot
     // with a Hyperlane domain
     uint224 public nonce = 0;
 
-    constructor(address _mailbox) Router(_mailbox) {}
-
     /**
      * @notice Emits the nonce of the Portal message when a token is bridged.
      * @param nonce The nonce of the Portal message.
@@ -54,11 +54,13 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
     }
 
     /**
+     * @param _localDomain The local hyperlane domain
      * @param _owner The new owner.
      * @param _portalTokenBridge The Portal TokenBridge contract.
      * @param _liquidityLayerRouter The LiquidityLayerRouter contract.
      */
     function initialize(
+        uint32 _localDomain,
         address _owner,
         address _portalTokenBridge,
         address _liquidityLayerRouter
@@ -66,6 +68,7 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
         // Transfer ownership of the contract to deployer
         _transferOwnership(_owner);
 
+        localDomain = _localDomain;
         portalTokenBridge = IPortalTokenBridge(_portalTokenBridge);
         liquidityLayerRouter = _liquidityLayerRouter;
     }

package/contracts/mock/MockERC5164.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT or Apache-2.0
 pragma solidity ^0.8.13;
 
-import {IMessageDispatcher} from "../interfaces/hooks/IMessageDispatcher.sol";
+import {IMessageDispatcher} from "../hooks/ERC5164/interfaces/IMessageDispatcher.sol";
 
 contract MockMessageDispatcher is IMessageDispatcher {
     function dispatchMessage(