@hyperlane-xyz/core 0.5.5 → 1.0.0-beta0

package/contracts/libs/Message.sol

@@ -4,24 +4,35 @@ pragma solidity >=0.8.0;
 import {TypeCasts} from "./TypeCasts.sol";
 
 /**
- * @title Message Library
- * @author Celo Labs Inc.
- * @notice Library for formatted messages used by Outbox and Replica.
+ * @title Hyperlane Message Library
+ * @notice Library for formatted messages used by Mailbox
  **/
 library Message {
     using TypeCasts for bytes32;
 
+    uint256 private constant VERSION_OFFSET = 0;
+    uint256 private constant NONCE_OFFSET = 1;
+    uint256 private constant ORIGIN_OFFSET = 5;
+    uint256 private constant SENDER_OFFSET = 9;
+    uint256 private constant DESTINATION_OFFSET = 41;
+    uint256 private constant RECIPIENT_OFFSET = 45;
+    uint256 private constant BODY_OFFSET = 77;
+
     /**
-     * @notice Returns formatted (packed) message with provided fields
+     * @notice Returns formatted (packed) Hyperlane message with provided fields
      * @dev This function should only be used in memory message construction.
-     * @param _originDomain Domain of home chain
+     * @param _version The version of the origin and destination Mailboxes
+     * @param _nonce A nonce to uniquely identify the message on its origin chain
+     * @param _originDomain Domain of origin chain
      * @param _sender Address of sender as bytes32
      * @param _destinationDomain Domain of destination chain
      * @param _recipient Address of recipient on destination chain as bytes32
      * @param _messageBody Raw bytes of message body
      * @return Formatted message
-     **/
+     */
     function formatMessage(
+        uint8 _version,
+        uint32 _nonce,
         uint32 _originDomain,
         bytes32 _sender,
         uint32 _destinationDomain,
@@ -30,6 +41,8 @@ library Message {
     ) internal pure returns (bytes memory) {
         return
             abi.encodePacked(
+                _version,
+                _nonce,
                 _originDomain,
                 _sender,
                 _destinationDomain,
@@ -39,84 +52,112 @@ library Message {
     }
 
     /**
-     * @notice Returns leaf of formatted message with provided fields.
-     * @dev hash of abi packed message and leaf index.
-     * @param _message Raw bytes of message contents.
-     * @param _leafIndex Index of the message in the tree
-     * @return Leaf (hash) of formatted message
+     * @notice Returns the message ID.
+     * @param _message ABI encoded Hyperlane message.
+     * @return ID of `_message`
+     */
+    function id(bytes memory _message) internal pure returns (bytes32) {
+        return keccak256(_message);
+    }
+
+    /**
+     * @notice Returns the message version.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Version of `_message`
+     */
+    function version(bytes calldata _message) internal pure returns (uint8) {
+        return uint8(bytes1(_message[VERSION_OFFSET:NONCE_OFFSET]));
+    }
+
+    /**
+     * @notice Returns the message nonce.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Nonce of `_message`
+     */
+    function nonce(bytes calldata _message) internal pure returns (uint32) {
+        return uint32(bytes4(_message[NONCE_OFFSET:ORIGIN_OFFSET]));
+    }
+
+    /**
+     * @notice Returns the message origin domain.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Origin domain of `_message`
+     */
+    function origin(bytes calldata _message) internal pure returns (uint32) {
+        return uint32(bytes4(_message[ORIGIN_OFFSET:SENDER_OFFSET]));
+    }
+
+    /**
+     * @notice Returns the message sender as bytes32.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Sender of `_message` as bytes32
+     */
+    function sender(bytes calldata _message) internal pure returns (bytes32) {
+        return bytes32(_message[SENDER_OFFSET:DESTINATION_OFFSET]);
+    }
+
+    /**
+     * @notice Returns the message sender as address.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Sender of `_message` as address
+     */
+    function senderAddress(bytes calldata _message)
+        internal
+        pure
+        returns (address)
+    {
+        return sender(_message).bytes32ToAddress();
+    }
+
+    /**
+     * @notice Returns the message destination domain.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Destination domain of `_message`
+     */
+    function destination(bytes calldata _message)
+        internal
+        pure
+        returns (uint32)
+    {
+        return uint32(bytes4(_message[DESTINATION_OFFSET:RECIPIENT_OFFSET]));
+    }
+
+    /**
+     * @notice Returns the message recipient as bytes32.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Recipient of `_message` as bytes32
      */
-    function leaf(bytes calldata _message, uint256 _leafIndex)
+    function recipient(bytes calldata _message)
         internal
         pure
         returns (bytes32)
     {
-        return keccak256(abi.encodePacked(_message, _leafIndex));
+        return bytes32(_message[RECIPIENT_OFFSET:BODY_OFFSET]);
     }
 
     /**
-     * @notice Decode raw message bytes into structured message fields.
-     * @dev Efficiently slices calldata into structured message fields.
-     * @param _message Raw bytes of message contents.
-     * @return origin Domain of home chain
-     * @return sender Address of sender as bytes32
-     * @return destination Domain of destination chain
-     * @return recipient Address of recipient on destination chain as bytes32
-     * @return body Raw bytes of message body
+     * @notice Returns the message recipient as address.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Recipient of `_message` as address
      */
-    function destructure(bytes calldata _message)
+    function recipientAddress(bytes calldata _message)
         internal
         pure
-        returns (
-            uint32 origin,
-            bytes32 sender,
-            uint32 destination,
-            bytes32 recipient,
-            bytes calldata body
-        )
+        returns (address)
     {
-        return (
-            uint32(bytes4(_message[0:4])),
-            bytes32(_message[4:36]),
-            uint32(bytes4(_message[36:40])),
-            bytes32(_message[40:72]),
-            bytes(_message[72:])
-        );
+        return recipient(_message).bytes32ToAddress();
     }
 
     /**
-     * @notice Decode raw message bytes into structured message fields.
-     * @dev Efficiently slices calldata into structured message fields.
-     * @param _message Raw bytes of message contents.
-     * @return origin Domain of home chain
-     * @return sender Address of sender as address (bytes20)
-     * @return destination Domain of destination chain
-     * @return recipient Address of recipient on destination chain as address (bytes20)
-     * @return body Raw bytes of message body
+     * @notice Returns the message body.
+     * @param _message ABI encoded Hyperlane message.
+     * @return Body of `_message`
      */
-    function destructureAddresses(bytes calldata _message)
+    function body(bytes calldata _message)
         internal
         pure
-        returns (
-            uint32,
-            address,
-            uint32,
-            address,
-            bytes calldata
-        )
+        returns (bytes calldata)
     {
-        (
-            uint32 _origin,
-            bytes32 _sender,
-            uint32 destination,
-            bytes32 _recipient,
-            bytes calldata body
-        ) = destructure(_message);
-        return (
-            _origin,
-            _sender.bytes32ToAddress(),
-            destination,
-            _recipient.bytes32ToAddress(),
-            body
-        );
+        return bytes(_message[BODY_OFFSET:]);
     }
 }

package/contracts/libs/MultisigIsmMetadata.sol

@@ -0,0 +1,185 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/**
+ * Format of metadata:
+ * [   0:  32] Merkle root
+ * [  32:  36] Root index
+ * [  36:  68] Origin mailbox address
+ * [  68:1092] Merkle proof
+ * [1092:1093] Threshold
+ * [1093:????] Validator signatures, 65 bytes each, length == Threshold
+ * [????:????] Addresses of the entire validator set, left padded to bytes32
+ */
+library MultisigIsmMetadata {
+    uint256 private constant MERKLE_ROOT_OFFSET = 0;
+    uint256 private constant MERKLE_INDEX_OFFSET = 32;
+    uint256 private constant ORIGIN_MAILBOX_OFFSET = 36;
+    uint256 private constant MERKLE_PROOF_OFFSET = 68;
+    uint256 private constant THRESHOLD_OFFSET = 1092;
+    uint256 private constant SIGNATURES_OFFSET = 1093;
+    uint256 private constant SIGNATURE_LENGTH = 65;
+
+    /**
+     * @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_INDEX_OFFSET]);
+    }
+
+    /**
+     * @notice Returns the index of the signed checkpoint.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Index of the signed checkpoint
+     */
+    function index(bytes calldata _metadata) internal pure returns (uint32) {
+        return
+            uint32(
+                bytes4(_metadata[MERKLE_INDEX_OFFSET:ORIGIN_MAILBOX_OFFSET])
+            );
+    }
+
+    /**
+     * @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:MERKLE_PROOF_OFFSET]);
+    }
+
+    /**
+     * @notice Returns the merkle proof branch of the message.
+     * @dev This appears to be more gas efficient than returning a calldata
+     * slice and using that.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Merkle proof branch of the message.
+     */
+    function proof(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes32[32] memory)
+    {
+        return
+            abi.decode(
+                _metadata[MERKLE_PROOF_OFFSET:THRESHOLD_OFFSET],
+                (bytes32[32])
+            );
+    }
+
+    /**
+     * @notice Returns the number of required signatures. Verified against
+     * the commitment stored in the module.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return The number of required signatures.
+     */
+    function threshold(bytes calldata _metadata) internal pure returns (uint8) {
+        return uint8(bytes1(_metadata[THRESHOLD_OFFSET:SIGNATURES_OFFSET]));
+    }
+
+    /**
+     * @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];
+    }
+
+    /**
+     * @notice Returns the validator address at `_index`.
+     * @dev Assumes `_index` is less than the number of validators
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @param _index The index of the validator to return.
+     * @return The validator address at `_index`.
+     */
+    function validatorAt(bytes calldata _metadata, uint256 _index)
+        internal
+        pure
+        returns (address)
+    {
+        // Validator addresses are left padded to bytes32 in order to match
+        // abi.encodePacked(address[]).
+        uint256 _start = _validatorsOffset(_metadata) + (_index * 32) + 12;
+        uint256 _end = _start + 20;
+        return address(bytes20(_metadata[_start:_end]));
+    }
+
+    /**
+     * @notice Returns the validator set encoded as bytes. Verified against the
+     * commitment stored in the module.
+     * @dev Validator addresses are encoded as tightly packed array of bytes32,
+     * sorted to match the enumerable set stored by the module.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return The validator set encoded as bytes.
+     */
+    function validators(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes calldata)
+    {
+        return _metadata[_validatorsOffset(_metadata):];
+    }
+
+    /**
+     * @notice Returns the size of the validator set encoded in the metadata
+     * @dev Validator addresses are encoded as tightly packed array of bytes32,
+     * sorted to match the enumerable set stored by the module.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return The size of the validator set encoded in the metadata
+     */
+    function commitment(bytes calldata _metadata)
+        internal
+        pure
+        returns (uint256)
+    {
+        return (_metadata.length - _validatorsOffset(_metadata)) / 32;
+    }
+
+    /**
+     * @notice Returns the size of the validator set encoded in the metadata
+     * @dev Validator addresses are encoded as tightly packed array of bytes32,
+     * sorted to match the enumerable set stored by the module.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return The size of the validator set encoded in the metadata
+     */
+    function validatorCount(bytes calldata _metadata)
+        internal
+        pure
+        returns (uint256)
+    {
+        return (_metadata.length - _validatorsOffset(_metadata)) / 32;
+    }
+
+    /**
+     * @notice Returns the offset in bytes of the list of validators within
+     * `_metadata`.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return The index at which the list of validators starts
+     */
+    function _validatorsOffset(bytes calldata _metadata)
+        private
+        pure
+        returns (uint256)
+    {
+        return
+            SIGNATURES_OFFSET +
+            (uint256(threshold(_metadata)) * SIGNATURE_LENGTH);
+    }
+}

package/contracts/middleware/InterchainAccountRouter.sol

@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
+// ============ Internal Imports ============
 import {OwnableMulticall, Call} from "../OwnableMulticall.sol";
+import {Router} from "../Router.sol";
 import {IInterchainAccountRouter} from "../../interfaces/IInterchainAccountRouter.sol";
 
 // ============ External Imports ============
-import {Router} from "../Router.sol";
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
@@ -25,21 +26,21 @@ contract InterchainAccountRouter is Router, IInterchainAccountRouter {
     );
 
     function initialize(
-        address _owner,
-        address _abacusConnectionManager,
-        address _interchainGasPaymaster
+        address _mailbox,
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Set the addresses for the ACM and IGP
-        // Alternatively, this could be done later in an initialize method
-        _setAbacusConnectionManager(_abacusConnectionManager);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
     }
 
     function dispatch(uint32 _destinationDomain, Call[] calldata calls)
         external
-        returns (uint256)
+        returns (bytes32)
     {
         return _dispatch(_destinationDomain, abi.encode(msg.sender, calls));
     }
@@ -48,7 +49,7 @@ contract InterchainAccountRouter is Router, IInterchainAccountRouter {
         uint32 _destinationDomain,
         address target,
         bytes calldata data
-    ) external returns (uint256) {
+    ) external returns (bytes32) {
         Call[] memory calls = new Call[](1);
         calls[0] = Call({to: target, data: data});
         return _dispatch(_destinationDomain, abi.encode(msg.sender, calls));

package/contracts/middleware/InterchainQueryRouter.sol

@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
+// ============ Internal Imports ============
 import {OwnableMulticall, Call} from "../OwnableMulticall.sol";
+import {Router} from "../Router.sol";
 import {IInterchainQueryRouter} from "../../interfaces/IInterchainQueryRouter.sol";
 
 // ============ External Imports ============
-import {Router} from "../Router.sol";
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
@@ -31,16 +32,16 @@ contract InterchainQueryRouter is
     );
 
     function initialize(
-        address _owner,
-        address _abacusConnectionManager,
-        address _interchainGasPaymaster
+        address _mailbox,
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Set the addresses for the ACM and IGP
-        // Alternatively, this could be done later in an initialize method
-        _setAbacusConnectionManager(_abacusConnectionManager);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
     }
 
     /**
@@ -54,13 +55,13 @@ contract InterchainQueryRouter is
         address target,
         bytes calldata queryData,
         bytes calldata callback
-    ) external returns (uint256 leafIndex) {
+    ) external returns (bytes32 messageId) {
         // TODO: fix this ugly arrayification
         Call[] memory calls = new Call[](1);
         calls[0] = Call({to: target, data: queryData});
         bytes[] memory callbacks = new bytes[](1);
         callbacks[0] = callback;
-        leafIndex = query(_destinationDomain, calls, callbacks);
+        messageId = query(_destinationDomain, calls, callbacks);
     }
 
     /**
@@ -72,13 +73,13 @@ contract InterchainQueryRouter is
         uint32 _destinationDomain,
         Call calldata call,
         bytes calldata callback
-    ) external returns (uint256 leafIndex) {
+    ) external returns (bytes32 messageId) {
         // TODO: fix this ugly arrayification
         Call[] memory calls = new Call[](1);
         calls[0] = call;
         bytes[] memory callbacks = new bytes[](1);
         callbacks[0] = callback;
-        leafIndex = query(_destinationDomain, calls, callbacks);
+        messageId = query(_destinationDomain, calls, callbacks);
     }
 
     /**
@@ -90,12 +91,12 @@ contract InterchainQueryRouter is
         uint32 _destinationDomain,
         Call[] memory calls,
         bytes[] memory callbacks
-    ) public returns (uint256 leafIndex) {
+    ) public returns (bytes32 messageId) {
         require(
             calls.length == callbacks.length,
             "InterchainQueryRouter: calls and callbacks must be same length"
         );
-        leafIndex = _dispatch(
+        messageId = _dispatch(
             _destinationDomain,
             abi.encode(Action.DISPATCH, msg.sender, calls, callbacks)
         );

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

@@ -3,33 +3,33 @@ pragma solidity ^0.8.13;
 
 import {Router} from "../../Router.sol";
 
-import {IMessageRecipient} from "../../../interfaces/IMessageRecipient.sol";
+import {ILiquidityLayerRouter} from "../../../interfaces/ILiquidityLayerRouter.sol";
 import {ICircleBridge} from "./interfaces/circle/ICircleBridge.sol";
 import {ICircleMessageTransmitter} from "./interfaces/circle/ICircleMessageTransmitter.sol";
 import {ILiquidityLayerAdapter} from "./interfaces/ILiquidityLayerAdapter.sol";
-import {ILiquidityLayerMessageRecipient} from "./interfaces/ILiquidityLayerMessageRecipient.sol";
+import {ILiquidityLayerMessageRecipient} from "../../../interfaces/ILiquidityLayerMessageRecipient.sol";
 
 import {TypeCasts} from "../../libs/TypeCasts.sol";
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-contract LiquidityLayerRouter is Router {
+contract LiquidityLayerRouter is Router, ILiquidityLayerRouter {
     // Token bridge => adapter address
     mapping(string => address) public liquidityLayerAdapters;
 
     event LiquidityLayerAdapterSet(string indexed bridge, address adapter);
 
     function initialize(
-        address _owner,
-        address _abacusConnectionManager,
-        address _interchainGasPaymaster
+        address _mailbox,
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Set the addresses for the ACM and IGP
-        // Alternatively, this could be done later in an initialize method
-        _setAbacusConnectionManager(_abacusConnectionManager);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
     }
 
     function dispatchWithTokens(
@@ -39,7 +39,7 @@ contract LiquidityLayerRouter is Router {
         address _token,
         uint256 _amount,
         string calldata _bridge
-    ) external payable {
+    ) external payable returns (bytes32) {
         ILiquidityLayerAdapter _adapter = _getAdapter(_bridge);
 
         // Transfer the tokens to the adapter
@@ -71,7 +71,14 @@ contract LiquidityLayerRouter is Router {
         );
 
         // Dispatch the _messageWithMetadata to the destination's LiquidityLayerRouter.
-        _dispatchWithGas(_destinationDomain, _messageWithMetadata, msg.value);
+        return
+            _dispatchWithGas(
+                _destinationDomain,
+                _messageWithMetadata,
+                0, // TODO eventually accommodate gas amounts
+                msg.value,
+                msg.sender
+            );
     }
 
     // Handles a message from an enrolled remote LiquidityLayerRouter

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

@@ -74,10 +74,6 @@ contract CircleBridgeAdapter is ILiquidityLayerAdapter, Router {
         // Transfer ownership of the contract to deployer
         _transferOwnership(_owner);
 
-        // Set the addresses for the ACM and IGP to address(0) - they aren't used.
-        _setAbacusConnectionManager(address(0));
-        _setInterchainGasPaymaster(address(0));
-
         circleBridge = ICircleBridge(_circleBridge);
         circleMessageTransmitter = ICircleMessageTransmitter(
             _circleMessageTransmitter