@hyperlane-xyz/core 1.5.4-beta0 → 1.5.6-beta0

package/contracts/isms/aggregation/StaticAggregationIsm.sol

@@ -3,7 +3,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {AbstractAggregationIsm} from "./AbstractAggregationIsm.sol";
-import {AggregationIsmMetadata} from "../../libs/isms/AggregationIsmMetadata.sol";
+import {AggregationIsmMetadata} from "../../isms/libs/AggregationIsmMetadata.sol";
 import {MetaProxy} from "../../libs/MetaProxy.sol";
 
 /**

package/contracts/isms/aggregation/StaticAggregationIsmFactory.sol

@@ -2,9 +2,9 @@
 pragma solidity >=0.8.0;
 // ============ Internal Imports ============
 import {StaticAggregationIsm} from "./StaticAggregationIsm.sol";
-import {StaticMOfNAddressSetFactory} from "../../libs/StaticMOfNAddressSetFactory.sol";
+import {StaticThresholdAddressSetFactory} from "../../libs/StaticAddressSetFactory.sol";
 
-contract StaticAggregationIsmFactory is StaticMOfNAddressSetFactory {
+contract StaticAggregationIsmFactory is StaticThresholdAddressSetFactory {
     function _deployImplementation()
         internal
         virtual

package/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

@@ -0,0 +1,108 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {LibBit} from "../../libs/LibBit.sol";
+import {Message} from "../../libs/Message.sol";
+import {TypeCasts} from "../../libs/TypeCasts.sol";
+
+// ============ External Imports ============
+
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+
+/**
+ * @title AbstractMessageIdAuthorizedIsm
+ * @notice Uses external verfication options to verify interchain messages which need a authorized caller
+ */
+abstract contract AbstractMessageIdAuthorizedIsm is
+    IInterchainSecurityModule,
+    Initializable
+{
+    using Address for address payable;
+    using LibBit for uint256;
+    using Message for bytes;
+    // ============ Public Storage ============
+
+    /// @notice Maps messageId to whether or not the message has been verified
+    /// first bit is boolean for verification
+    /// rest of bits is the amount to send to the recipient
+    /// @dev bc of the bit packing, we can only send up to 2^255 wei
+    /// @dev the first bit is reserved for verification and the rest 255 bits are for the msg.value
+    mapping(bytes32 => uint256) public verifiedMessages;
+    /// @notice Index of verification bit in verifiedMessages
+    uint256 public constant MASK_INDEX = 255;
+    /// @notice Address for the authorized hook
+    address public authorizedHook;
+
+    // ============ Events ============
+
+    /// @notice Emitted when a message is received from the external bridge
+    event ReceivedMessage(bytes32 indexed messageId);
+
+    // ============ Initializer ============
+
+    function setAuthorizedHook(address _hook) external initializer {
+        require(
+            _hook != address(0),
+            "AbstractMessageIdAuthorizedIsm: invalid authorized hook"
+        );
+        authorizedHook = _hook;
+    }
+
+    // ============ External Functions ============
+
+    /**
+     * @notice Verify a message was received by ISM.
+     * @param message Message to verify.
+     */
+    function verify(
+        bytes calldata,
+        /*_metadata*/
+        bytes calldata message
+    ) external returns (bool) {
+        bytes32 messageId = message.id();
+
+        // check for the first bit (used for verification)
+        bool verified = verifiedMessages[messageId].isBitSet(MASK_INDEX);
+        // rest 255 bits contains the msg.value passed from the hook
+        if (verified) {
+            payable(message.recipientAddress()).sendValue(
+                verifiedMessages[messageId].clearBit(MASK_INDEX)
+            );
+        }
+        return verified;
+    }
+
+    /**
+     * @notice Receive a message from the AbstractMessageIdAuthHook
+     * @dev Only callable by the authorized hook.
+     * @param messageId Hyperlane Id of the message.
+     */
+    function verifyMessageId(bytes32 messageId) external payable virtual {
+        require(
+            _isAuthorized(),
+            "AbstractMessageIdAuthorizedIsm: sender is not the hook"
+        );
+
+        verifiedMessages[messageId] = msg.value.setBit(MASK_INDEX);
+        emit ReceivedMessage(messageId);
+    }
+
+    function _isAuthorized() internal view virtual returns (bool);
+}

package/contracts/isms/hook/ERC5164Ism.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {Message} from "../../libs/Message.sol";
+import {TypeCasts} from "../../libs/TypeCasts.sol";
+import {AbstractMessageIdAuthorizedIsm} from "./AbstractMessageIdAuthorizedIsm.sol";
+
+// ============ External Imports ============
+
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
+/**
+ * @title ERC5164Ism
+ * @notice Uses the generic eip-5164 standard to verify interchain messages.
+ */
+contract ERC5164Ism is AbstractMessageIdAuthorizedIsm {
+    // ============ Constants ============
+
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.NULL);
+    // corresponding 5164 executor address
+    address public immutable executor;
+
+    // ============ Constructor ============
+
+    constructor(address _executor) {
+        require(Address.isContract(_executor), "ERC5164Ism: invalid executor");
+        executor = _executor;
+    }
+
+    /**
+     * @notice Check if sender is authorized to message `verifyMessageId`.
+     */
+    function _isAuthorized() internal view override returns (bool) {
+        return msg.sender == executor;
+    }
+}

package/contracts/isms/hook/OPStackIsm.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {Message} from "../../libs/Message.sol";
+import {TypeCasts} from "../../libs/TypeCasts.sol";
+import {AbstractMessageIdAuthorizedIsm} from "./AbstractMessageIdAuthorizedIsm.sol";
+
+// ============ External Imports ============
+import {CrossChainEnabledOptimism} from "@openzeppelin/contracts/crosschain/optimism/CrossChainEnabledOptimism.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
+/**
+ * @title OPStackIsm
+ * @notice Uses the native Optimism bridge to verify interchain messages.
+ */
+contract OPStackIsm is
+    CrossChainEnabledOptimism,
+    AbstractMessageIdAuthorizedIsm
+{
+    // ============ Constants ============
+
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.NULL);
+
+    // ============ Constructor ============
+
+    constructor(address _l2Messenger) CrossChainEnabledOptimism(_l2Messenger) {
+        require(
+            Address.isContract(_l2Messenger),
+            "OPStackIsm: invalid L2Messenger"
+        );
+    }
+
+    // ============ Internal function ============
+
+    /**
+     * @notice Check if sender is authorized to message `verifyMessageId`.
+     */
+    function _isAuthorized() internal view override returns (bool) {
+        return _crossChainSender() == authorizedHook;
+    }
+}

package/contracts/isms/libs/MerkleRootMultisigIsmMetadata.sol

@@ -0,0 +1,123 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/**
+ * Format of metadata:
+ * [   0:  32] Origin merkle tree address
+ * [  32:  36] Index of message ID in merkle tree
+ * [  36:  68] Signed checkpoint message ID
+ * [  68:1092] Merkle proof
+ * [1092:1096] Signed checkpoint index (computed from proof and index)
+ * [1096:????] Validator signatures (length := threshold * 65)
+ */
+library MerkleRootMultisigIsmMetadata {
+    uint8 private constant ORIGIN_MERKLE_TREE_OFFSET = 0;
+    uint8 private constant MESSAGE_INDEX_OFFSET = 32;
+    uint8 private constant MESSAGE_ID_OFFSET = 36;
+    uint8 private constant MERKLE_PROOF_OFFSET = 68;
+    uint16 private constant MERKLE_PROOF_LENGTH = 32 * 32;
+    uint16 private constant SIGNED_INDEX_OFFSET = 1092;
+    uint16 private constant SIGNATURES_OFFSET = 1096;
+    uint8 private constant SIGNATURE_LENGTH = 65;
+
+    /**
+     * @notice Returns the origin merkle tree hook of the signed checkpoint as bytes32.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Origin merkle tree hook of the signed checkpoint as bytes32
+     */
+    function originMerkleTreeHook(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes32)
+    {
+        return
+            bytes32(
+                _metadata[ORIGIN_MERKLE_TREE_OFFSET:ORIGIN_MERKLE_TREE_OFFSET +
+                    32]
+            );
+    }
+
+    /**
+     * @notice Returns the index of the message being proven.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Index of the target message in the merkle tree.
+     */
+    function messageIndex(bytes calldata _metadata)
+        internal
+        pure
+        returns (uint32)
+    {
+        return
+            uint32(
+                bytes4(_metadata[MESSAGE_INDEX_OFFSET:MESSAGE_INDEX_OFFSET + 4])
+            );
+    }
+
+    /**
+     * @notice Returns the index of the signed checkpoint.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Index of the signed checkpoint
+     */
+    function signedIndex(bytes calldata _metadata)
+        internal
+        pure
+        returns (uint32)
+    {
+        return
+            uint32(
+                bytes4(_metadata[SIGNED_INDEX_OFFSET:SIGNED_INDEX_OFFSET + 4])
+            );
+    }
+
+    /**
+     * @notice Returns the message ID of the signed checkpoint.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Message ID of the signed checkpoint
+     */
+    function signedMessageId(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes32)
+    {
+        return bytes32(_metadata[MESSAGE_ID_OFFSET:MESSAGE_ID_OFFSET + 32]);
+    }
+
+    /**
+     * @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:MERKLE_PROOF_OFFSET +
+                    MERKLE_PROOF_LENGTH],
+                (bytes32[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/isms/libs/MessageIdMultisigIsmMetadata.sol

@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/**
+ * Format of metadata:
+ * [   0:  32] Origin merkle tree address
+ * [  32:  64] Signed checkpoint root
+ * [  64:  68] Signed checkpoint index
+ * [  68:????] Validator signatures (length := threshold * 65)
+ */
+library MessageIdMultisigIsmMetadata {
+    uint8 private constant ORIGIN_MERKLE_TREE_OFFSET = 0;
+    uint8 private constant MERKLE_ROOT_OFFSET = 32;
+    uint8 private constant MERKLE_INDEX_OFFSET = 64;
+    uint8 private constant SIGNATURES_OFFSET = 68;
+    uint8 private constant SIGNATURE_LENGTH = 65;
+
+    /**
+     * @notice Returns the origin merkle tree hook of the signed checkpoint as bytes32.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Origin merkle tree hook of the signed checkpoint as bytes32
+     */
+    function originMerkleTreeHook(bytes calldata _metadata)
+        internal
+        pure
+        returns (bytes32)
+    {
+        return
+            bytes32(
+                _metadata[ORIGIN_MERKLE_TREE_OFFSET:ORIGIN_MERKLE_TREE_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 merkle index of the signed checkpoint.
+     * @param _metadata ABI encoded Multisig ISM metadata.
+     * @return Merkle index of the signed checkpoint
+     */
+    function index(bytes calldata _metadata) internal pure returns (uint32) {
+        return
+            uint32(
+                bytes4(_metadata[MERKLE_INDEX_OFFSET:MERKLE_INDEX_OFFSET + 4])
+            );
+    }
+
+    /**
+     * @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/isms/multisig/AbstractMerkleRootMultisigIsm.sol

@@ -4,7 +4,7 @@ pragma solidity >=0.8.0;
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
-import {MerkleRootMultisigIsmMetadata} from "../../libs/isms/MerkleRootMultisigIsmMetadata.sol";
+import {MerkleRootMultisigIsmMetadata} from "../../isms/libs/MerkleRootMultisigIsmMetadata.sol";
 import {Message} from "../../libs/Message.sol";
 import {MerkleLib} from "../../libs/Merkle.sol";
 import {CheckpointLib} from "../../libs/CheckpointLib.sol";
@@ -23,6 +23,9 @@ import {CheckpointLib} from "../../libs/CheckpointLib.sol";
  * @dev May be adapted in future to support batch message verification against a single root.
  */
 abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
+    using MerkleRootMultisigIsmMetadata for bytes;
+    using Message for bytes;
+
     // ============ Constants ============
 
     // solhint-disable-next-line const-name-snakecase
@@ -38,20 +41,24 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
         override
         returns (bytes32)
     {
+        require(
+            _metadata.messageIndex() <= _metadata.signedIndex(),
+            "Invalid merkle index metadata"
+        );
         // We verify a merkle proof of (messageId, index) I to compute root J
-        bytes32 _root = MerkleLib.branchRoot(
-            Message.id(_message),
-            MerkleRootMultisigIsmMetadata.proof(_metadata),
-            Message.nonce(_message)
+        bytes32 _signedRoot = MerkleLib.branchRoot(
+            _message.id(),
+            _metadata.proof(),
+            _metadata.messageIndex()
         );
         // We provide (messageId, index) J in metadata for digest derivation
         return
             CheckpointLib.digest(
-                Message.origin(_message),
-                MerkleRootMultisigIsmMetadata.originMailbox(_metadata),
-                _root,
-                MerkleRootMultisigIsmMetadata.index(_metadata),
-                MerkleRootMultisigIsmMetadata.messageId(_metadata)
+                _message.origin(),
+                _metadata.originMerkleTreeHook(),
+                _signedRoot,
+                _metadata.signedIndex(),
+                _metadata.signedMessageId()
             );
     }
 
@@ -63,8 +70,8 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
         pure
         virtual
         override
-        returns (bytes memory signature)
+        returns (bytes calldata)
     {
-        return MerkleRootMultisigIsmMetadata.signatureAt(_metadata, _index);
+        return _metadata.signatureAt(_index);
     }
 }

package/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol

@@ -4,7 +4,7 @@ pragma solidity >=0.8.0;
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
-import {MessageIdMultisigIsmMetadata} from "../../libs/isms/MessageIdMultisigIsmMetadata.sol";
+import {MessageIdMultisigIsmMetadata} from "../libs/MessageIdMultisigIsmMetadata.sol";
 import {Message} from "../../libs/Message.sol";
 import {CheckpointLib} from "../../libs/CheckpointLib.sol";
 
@@ -19,6 +19,9 @@ import {CheckpointLib} from "../../libs/CheckpointLib.sol";
  * This abstract contract can be customized to change the `validatorsAndThreshold()` (static or dynamic).
  */
 abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
+    using Message for bytes;
+    using MessageIdMultisigIsmMetadata for bytes;
+
     // ============ Constants ============
 
     // solhint-disable-next-line const-name-snakecase
@@ -36,11 +39,11 @@ abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
     {
         return
             CheckpointLib.digest(
-                Message.origin(_message),
-                MessageIdMultisigIsmMetadata.originMailbox(_metadata),
-                MessageIdMultisigIsmMetadata.root(_metadata),
-                Message.nonce(_message),
-                Message.id(_message)
+                _message.origin(),
+                _metadata.originMerkleTreeHook(),
+                _metadata.root(),
+                _metadata.index(),
+                _message.id()
             );
     }
 
@@ -52,8 +55,8 @@ abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
         pure
         virtual
         override
-        returns (bytes memory)
+        returns (bytes calldata)
     {
-        return MessageIdMultisigIsmMetadata.signatureAt(_metadata, _index);
+        return _metadata.signatureAt(_index);
     }
 }

package/contracts/isms/multisig/AbstractMultisigIsm.sol

@@ -58,7 +58,7 @@ abstract contract AbstractMultisigIsm is IMultisigIsm {
         internal
         pure
         virtual
-        returns (bytes memory);
+        returns (bytes calldata);
 
     // ============ Public Functions ============
 

package/contracts/isms/multisig/StaticMultisigIsm.sol

@@ -5,7 +5,7 @@ import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
 import {AbstractMerkleRootMultisigIsm} from "./AbstractMerkleRootMultisigIsm.sol";
 import {AbstractMessageIdMultisigIsm} from "./AbstractMessageIdMultisigIsm.sol";
 import {MetaProxy} from "../../libs/MetaProxy.sol";
-import {StaticMOfNAddressSetFactory} from "../../libs/StaticMOfNAddressSetFactory.sol";
+import {StaticThresholdAddressSetFactory} from "../../libs/StaticAddressSetFactory.sol";
 
 /**
  * @title AbstractMetaProxyMultisigIsm
@@ -55,13 +55,15 @@ contract StaticMessageIdMultisigIsm is
 
 // solhint-enable no-empty-blocks
 
-contract StaticMerkleRootMultisigIsmFactory is StaticMOfNAddressSetFactory {
+contract StaticMerkleRootMultisigIsmFactory is
+    StaticThresholdAddressSetFactory
+{
     function _deployImplementation() internal override returns (address) {
         return address(new StaticMerkleRootMultisigIsm());
     }
 }
 
-contract StaticMessageIdMultisigIsmFactory is StaticMOfNAddressSetFactory {
+contract StaticMessageIdMultisigIsmFactory is StaticThresholdAddressSetFactory {
     function _deployImplementation() internal override returns (address) {
         return address(new StaticMessageIdMultisigIsm());
     }