@hyperlane-xyz/core 5.0.0-beta.2 → 5.1.0

package/contracts/AttributeCheckpointFraud.sol

@@ -0,0 +1,140 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+
+import {TREE_DEPTH} from "./libs/Merkle.sol";
+import {CheckpointLib, Checkpoint} from "./libs/CheckpointLib.sol";
+import {CheckpointFraudProofs} from "./CheckpointFraudProofs.sol";
+
+enum FraudType {
+    Whitelist,
+    Premature,
+    MessageId,
+    Root
+}
+
+struct Attribution {
+    FraudType fraudType;
+    // for comparison with staking epoch
+    uint48 timestamp;
+}
+
+/**
+ * @title AttributeCheckpointFraud
+ * @dev The AttributeCheckpointFraud contract is used to attribute fraud to a specific ECDSA checkpoint signer.
+ */
+contract AttributeCheckpointFraud is Ownable {
+    using CheckpointLib for Checkpoint;
+    using Address for address;
+
+    CheckpointFraudProofs public immutable checkpointFraudProofs =
+        new CheckpointFraudProofs();
+
+    mapping(address => bool) public merkleTreeWhitelist;
+
+    mapping(address signer => mapping(bytes32 digest => Attribution))
+        internal _attributions;
+
+    function _recover(
+        Checkpoint calldata checkpoint,
+        bytes calldata signature
+    ) internal pure returns (address signer, bytes32 digest) {
+        digest = checkpoint.digest();
+        signer = ECDSA.recover(digest, signature);
+    }
+
+    function _attribute(
+        bytes calldata signature,
+        Checkpoint calldata checkpoint,
+        FraudType fraudType
+    ) internal {
+        (address signer, bytes32 digest) = _recover(checkpoint, signature);
+        require(
+            _attributions[signer][digest].timestamp == 0,
+            "fraud already attributed to signer for digest"
+        );
+        _attributions[signer][digest] = Attribution({
+            fraudType: fraudType,
+            timestamp: uint48(block.timestamp)
+        });
+    }
+
+    function attributions(
+        Checkpoint calldata checkpoint,
+        bytes calldata signature
+    ) external view returns (Attribution memory) {
+        (address signer, bytes32 digest) = _recover(checkpoint, signature);
+        return _attributions[signer][digest];
+    }
+
+    function whitelist(address merkleTree) external onlyOwner {
+        require(
+            merkleTree.isContract(),
+            "merkle tree must be a valid contract"
+        );
+        merkleTreeWhitelist[merkleTree] = true;
+    }
+
+    function attributeWhitelist(
+        Checkpoint calldata checkpoint,
+        bytes calldata signature
+    ) external {
+        require(
+            checkpointFraudProofs.isLocal(checkpoint),
+            "checkpoint must be local"
+        );
+
+        require(
+            !merkleTreeWhitelist[checkpoint.merkleTreeAddress()],
+            "merkle tree is whitelisted"
+        );
+
+        _attribute(signature, checkpoint, FraudType.Whitelist);
+    }
+
+    function attributePremature(
+        Checkpoint calldata checkpoint,
+        bytes calldata signature
+    ) external {
+        require(
+            checkpointFraudProofs.isPremature(checkpoint),
+            "checkpoint must be premature"
+        );
+
+        _attribute(signature, checkpoint, FraudType.Premature);
+    }
+
+    function attributeMessageId(
+        Checkpoint calldata checkpoint,
+        bytes32[TREE_DEPTH] calldata proof,
+        bytes32 actualMessageId,
+        bytes calldata signature
+    ) external {
+        require(
+            checkpointFraudProofs.isFraudulentMessageId(
+                checkpoint,
+                proof,
+                actualMessageId
+            ),
+            "checkpoint must have fraudulent message ID"
+        );
+
+        _attribute(signature, checkpoint, FraudType.MessageId);
+    }
+
+    function attributeRoot(
+        Checkpoint calldata checkpoint,
+        bytes32[TREE_DEPTH] calldata proof,
+        bytes calldata signature
+    ) external {
+        require(
+            checkpointFraudProofs.isFraudulentRoot(checkpoint, proof),
+            "checkpoint must have fraudulent root"
+        );
+
+        _attribute(signature, checkpoint, FraudType.Root);
+    }
+}

package/contracts/CheckpointFraudProofs.sol

@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
+import {TypeCasts} from "./libs/TypeCasts.sol";
+import {Checkpoint, CheckpointLib} from "./libs/CheckpointLib.sol";
+import {MerkleLib, TREE_DEPTH} from "./libs/Merkle.sol";
+import {MerkleTreeHook} from "./hooks/MerkleTreeHook.sol";
+import {IMailbox} from "./interfaces/IMailbox.sol";
+
+struct StoredIndex {
+    uint32 index;
+    bool exists;
+}
+
+contract CheckpointFraudProofs {
+    using CheckpointLib for Checkpoint;
+    using Address for address;
+
+    mapping(address merkleTree => mapping(bytes32 root => StoredIndex index))
+        public storedCheckpoints;
+
+    function storedCheckpointContainsMessage(
+        address merkleTree,
+        uint32 index,
+        bytes32 messageId,
+        bytes32[TREE_DEPTH] calldata proof
+    ) public view returns (bool) {
+        bytes32 root = MerkleLib.branchRoot(messageId, proof, index);
+        StoredIndex storage storedIndex = storedCheckpoints[merkleTree][root];
+        return storedIndex.exists && storedIndex.index >= index;
+    }
+
+    modifier onlyMessageInStoredCheckpoint(
+        Checkpoint calldata checkpoint,
+        bytes32[TREE_DEPTH] calldata proof,
+        bytes32 messageId
+    ) {
+        require(
+            storedCheckpointContainsMessage(
+                checkpoint.merkleTreeAddress(),
+                checkpoint.index,
+                messageId,
+                proof
+            ),
+            "message must be member of stored checkpoint"
+        );
+        _;
+    }
+
+    function isLocal(
+        Checkpoint calldata checkpoint
+    ) public view returns (bool) {
+        address merkleTree = checkpoint.merkleTreeAddress();
+        return
+            merkleTree.isContract() &&
+            MerkleTreeHook(merkleTree).localDomain() == checkpoint.origin;
+    }
+
+    modifier onlyLocal(Checkpoint calldata checkpoint) {
+        require(isLocal(checkpoint), "must be local checkpoint");
+        _;
+    }
+
+    /**
+     *  @notice Stores the latest checkpoint of the provided merkle tree hook
+     *  @param merkleTree Address of the merkle tree hook to store the latest checkpoint of.
+     *  @dev Must be called before proving fraud to circumvent race on message insertion and merkle proof construction.
+     */
+    function storeLatestCheckpoint(
+        address merkleTree
+    ) external returns (bytes32 root, uint32 index) {
+        (root, index) = MerkleTreeHook(merkleTree).latestCheckpoint();
+        storedCheckpoints[merkleTree][root] = StoredIndex(index, true);
+    }
+
+    /**
+     *  @notice Checks whether the provided checkpoint is premature (fraud).
+     *  @param checkpoint Checkpoint to check.
+     *  @dev Checks whether checkpoint.index is greater than or equal to mailbox count
+     *  @return Whether the provided checkpoint is premature.
+     */
+    function isPremature(
+        Checkpoint calldata checkpoint
+    ) public view onlyLocal(checkpoint) returns (bool) {
+        // count is the number of messages in the mailbox (i.e. the latest index + 1)
+        uint32 count = MerkleTreeHook(checkpoint.merkleTreeAddress()).count();
+
+        // index >= count is equivalent to index > latest index
+        return checkpoint.index >= count;
+    }
+
+    /**
+     *  @notice Checks whether the provided checkpoint has a fraudulent message ID.
+     *  @param checkpoint Checkpoint to check.
+     *  @param proof Merkle proof of the actual message ID at checkpoint.index on checkpoint.merkleTree
+     *  @param actualMessageId Actual message ID at checkpoint.index on checkpoint.merkleTree
+     *  @dev Must produce proof of inclusion for actualMessageID against some stored checkpoint.
+     *  @return Whether the provided checkpoint has a fraudulent message ID.
+     */
+    function isFraudulentMessageId(
+        Checkpoint calldata checkpoint,
+        bytes32[TREE_DEPTH] calldata proof,
+        bytes32 actualMessageId
+    )
+        public
+        view
+        onlyLocal(checkpoint)
+        onlyMessageInStoredCheckpoint(checkpoint, proof, actualMessageId)
+        returns (bool)
+    {
+        return actualMessageId != checkpoint.messageId;
+    }
+
+    /**
+     *  @notice Checks whether the provided checkpoint has a fraudulent root.
+     *  @param checkpoint Checkpoint to check.
+     *  @param proof Merkle proof of the checkpoint.messageId at checkpoint.index on checkpoint.merkleTree
+     *  @dev Must produce proof of inclusion for checkpoint.messageId against some stored checkpoint.
+     *  @return Whether the provided checkpoint has a fraudulent message ID.
+     */
+    function isFraudulentRoot(
+        Checkpoint calldata checkpoint,
+        bytes32[TREE_DEPTH] calldata proof
+    )
+        public
+        view
+        onlyLocal(checkpoint)
+        onlyMessageInStoredCheckpoint(checkpoint, proof, checkpoint.messageId)
+        returns (bool)
+    {
+        // proof of checkpoint.messageId at checkpoint.index is the list of siblings from the leaf node to some stored root
+        // once verifying the proof, we can reconstruct the specific root at checkpoint.index by replacing siblings greater
+        // than the index (right subtrees) with zeroes
+        bytes32 root = MerkleLib.reconstructRoot(
+            checkpoint.messageId,
+            proof,
+            checkpoint.index
+        );
+        return root != checkpoint.root;
+    }
+}

package/contracts/client/Router.sol

@@ -153,8 +153,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
         uint32 _domain
     ) internal view returns (bytes32) {
         (bool contained, bytes32 _router) = _routers.tryGet(_domain);
-        require(contained, _domainNotFoundError(_domain));
-        return _router;
+        if (contained) {
+            return _router;
+        }
+        revert(_domainNotFoundError(_domain));
     }
 
     function _domainNotFoundError(

package/contracts/hooks/OPL2ToL1Hook.sol

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
+import {AbstractPostDispatchHook, AbstractMessageIdAuthHook} from "./libs/AbstractMessageIdAuthHook.sol";
+import {StandardHookMetadata} from "./libs/StandardHookMetadata.sol";
+import {TypeCasts} from "../libs/TypeCasts.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
+
+// ============ External Imports ============
+import {ICrossDomainMessenger} from "../interfaces/optimism/ICrossDomainMessenger.sol";
+
+/**
+ * @title OPL2ToL1Hook
+ * @notice Message hook to inform the OPL2ToL1Ism of messages published through
+ * the native Optimism bridge.
+ * @notice This works only for L2 -> L1 messages and has the 7 day delay as specified by the OptimismPortal contract.
+ */
+contract OPL2ToL1Hook is AbstractMessageIdAuthHook {
+    using StandardHookMetadata for bytes;
+
+    // ============ Constants ============
+
+    // precompile contract on L2 for sending messages to L1
+    ICrossDomainMessenger public immutable l2Messenger;
+    // Immutable quote amount
+    uint32 public immutable GAS_QUOTE;
+
+    // ============ Constructor ============
+
+    constructor(
+        address _mailbox,
+        uint32 _destinationDomain,
+        bytes32 _ism,
+        address _l2Messenger,
+        uint32 _gasQuote
+    ) AbstractMessageIdAuthHook(_mailbox, _destinationDomain, _ism) {
+        GAS_QUOTE = _gasQuote;
+        l2Messenger = ICrossDomainMessenger(_l2Messenger);
+    }
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.OP_L2_TO_L1);
+    }
+
+    /// @inheritdoc AbstractPostDispatchHook
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal view override returns (uint256) {
+        return GAS_QUOTE;
+    }
+
+    // ============ Internal functions ============
+
+    /// @inheritdoc AbstractMessageIdAuthHook
+    function _sendMessageId(
+        bytes calldata metadata,
+        bytes memory payload
+    ) internal override {
+        require(
+            msg.value >= metadata.msgValue(0) + GAS_QUOTE,
+            "OPL2ToL1Hook: insufficient msg.value"
+        );
+        l2Messenger.sendMessage{value: metadata.msgValue(0)}(
+            TypeCasts.bytes32ToAddress(ism),
+            payload,
+            GAS_QUOTE
+        );
+    }
+}

package/contracts/hooks/igp/InterchainGasPaymaster.sol

@@ -228,14 +228,14 @@ contract InterchainGasPaymaster is
         IGasOracle _gasOracle = destinationGasConfigs[_destinationDomain]
             .gasOracle;
 
-        require(
-            address(_gasOracle) != address(0),
-            string.concat(
-                "Configured IGP doesn't support domain ",
-                Strings.toString(_destinationDomain)
-            )
-        );
-
+        if (address(_gasOracle) == address(0)) {
+            revert(
+                string.concat(
+                    "Configured IGP doesn't support domain ",
+                    Strings.toString(_destinationDomain)
+                )
+            );
+        }
         return _gasOracle.getExchangeRateAndGasPrice(_destinationDomain);
     }
 

package/contracts/hooks/routing/DomainRoutingHook.sol

@@ -90,12 +90,13 @@ contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
         bytes calldata message
     ) internal view virtual returns (IPostDispatchHook hook) {
         hook = hooks[message.destination()];
-        require(
-            address(hook) != address(0),
-            string.concat(
-                "No hook configured for destination: ",
-                message.destination().toString()
-            )
-        );
+        if (address(hook) == address(0)) {
+            revert(
+                string.concat(
+                    "No hook configured for destination: ",
+                    message.destination().toString()
+                )
+            );
+        }
     }
 }

package/contracts/interfaces/IInterchainSecurityModule.sol

@@ -11,7 +11,10 @@ interface IInterchainSecurityModule {
         MESSAGE_ID_MULTISIG,
         NULL, // used with relayer carrying no metadata
         CCIP_READ,
-        ARB_L2_TO_L1
+        ARB_L2_TO_L1,
+        WEIGHT_MERKLE_ROOT_MULTISIG,
+        WEIGHT_MESSAGE_ID_MULTISIG,
+        OP_L2_TO_L1
     }
 
     /**

package/contracts/interfaces/hooks/IPostDispatchHook.sol

@@ -26,7 +26,8 @@ interface IPostDispatchHook {
         PROTOCOL_FEE,
         LAYER_ZERO_V1,
         RATE_LIMITED,
-        ARB_L2_TO_L1
+        ARB_L2_TO_L1,
+        OP_L2_TO_L1
     }
 
     /**

package/contracts/interfaces/isms/IWeightedMultisigIsm.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+import {IInterchainSecurityModule} from "../IInterchainSecurityModule.sol";
+
+interface IStaticWeightedMultisigIsm is IInterchainSecurityModule {
+    // ============ Structs ============
+
+    // ValidatorInfo contains the signing address and weight of a validator
+    struct ValidatorInfo {
+        address signingAddress;
+        uint96 weight;
+    }
+
+    /**
+     * @notice Returns the validators and threshold weight for this ISM.
+     * @param _message The message to be verified
+     * @return validators The validators and their weights
+     * @return thresholdWeight The threshold weight required to pass verification
+     */
+    function validatorsAndThresholdWeight(
+        bytes calldata _message
+    )
+        external
+        view
+        returns (ValidatorInfo[] memory validators, uint96 thresholdWeight);
+}

package/contracts/interfaces/optimism/ICrossDomainMessenger.sol

@@ -30,6 +30,8 @@ interface ICrossDomainMessenger {
     function xDomainMessageSender() external view returns (address);
 
     function OTHER_MESSENGER() external view returns (address);
+
+    function PORTAL() external view returns (address);
 }
 
 interface IL1CrossDomainMessenger is ICrossDomainMessenger {}

package/contracts/interfaces/optimism/IOptimismPortal.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+// author: OP Labs
+// copied from https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock
+interface IOptimismPortal {
+    /// @notice Struct representing a withdrawal transaction.
+    /// @custom:field nonce    Nonce of the withdrawal transaction
+    /// @custom:field sender   Address of the sender of the transaction.
+    /// @custom:field target   Address of the recipient of the transaction.
+    /// @custom:field value    Value to send to the recipient.
+    /// @custom:field gasLimit Gas limit of the transaction.
+    /// @custom:field data     Data of the transaction.
+    struct WithdrawalTransaction {
+        uint256 nonce;
+        address sender;
+        address target;
+        uint256 value;
+        uint256 gasLimit;
+        bytes data;
+    }
+
+    /// @notice Finalizes a withdrawal transaction.
+    /// @param _tx Withdrawal transaction to finalize.
+    function finalizeWithdrawalTransaction(
+        WithdrawalTransaction memory _tx
+    ) external;
+}

package/contracts/isms/hook/OPL2ToL1Ism.sol

@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {TypeCasts} from "../../libs/TypeCasts.sol";
+import {Message} from "../../libs/Message.sol";
+import {OPL2ToL1Metadata} from "../../libs/OPL2ToL1Metadata.sol";
+import {AbstractMessageIdAuthorizedIsm} from "./AbstractMessageIdAuthorizedIsm.sol";
+
+// ============ External Imports ============
+
+import {ICrossDomainMessenger} from "../../interfaces/optimism/ICrossDomainMessenger.sol";
+import {IOptimismPortal} from "../../interfaces/optimism/IOptimismPortal.sol";
+import {CrossChainEnabledOptimism} from "@openzeppelin/contracts/crosschain/optimism/CrossChainEnabledOptimism.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
+/**
+ * @title OPL2ToL1Ism
+ * @notice Uses the native Optimism bridge to verify interchain messages from L2 to L1.
+ */
+contract OPL2ToL1Ism is
+    CrossChainEnabledOptimism,
+    AbstractMessageIdAuthorizedIsm
+{
+    using TypeCasts for address;
+    using Message for bytes;
+    using OPL2ToL1Metadata for bytes;
+
+    // ============ Constants ============
+
+    // module type for the ISM
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.OP_L2_TO_L1);
+    // OptimismPortal contract on L1 to finalize withdrawal from L1
+    IOptimismPortal public immutable portal;
+
+    // ============ Constructor ============
+
+    constructor(address _messenger) CrossChainEnabledOptimism(_messenger) {
+        address _portal = ICrossDomainMessenger(_messenger).PORTAL();
+        require(
+            Address.isContract(_portal),
+            "OPL2ToL1Ism: invalid OptimismPortal contract"
+        );
+        portal = IOptimismPortal(_portal);
+    }
+
+    // ============ External Functions ============
+
+    /// @inheritdoc IInterchainSecurityModule
+    function verify(
+        bytes calldata metadata,
+        bytes calldata message
+    ) external override returns (bool) {
+        bool verified = isVerified(message);
+        if (!verified) {
+            _verifyWithPortalCall(metadata, message);
+        }
+        releaseValueToRecipient(message);
+        return true;
+    }
+
+    // ============ Internal function ============
+
+    /**
+     * @notice Verify message directly using the portal.finalizeWithdrawal function.
+     * @dev This is a fallback in case the message is not verified by the stateful verify function first.
+     */
+    function _verifyWithPortalCall(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal {
+        require(
+            metadata.checkCalldataLength(),
+            "OPL2ToL1Ism: invalid data length"
+        );
+        require(
+            metadata.messageId() == message.id(),
+            "OPL2ToL1Ism: invalid message id"
+        );
+
+        IOptimismPortal.WithdrawalTransaction memory withdrawal = abi.decode(
+            metadata,
+            (IOptimismPortal.WithdrawalTransaction)
+        );
+        // if the finalizeWithdrawalTransaction call is successful, the message is verified
+        portal.finalizeWithdrawalTransaction(withdrawal);
+    }
+
+    /// @inheritdoc AbstractMessageIdAuthorizedIsm
+    function _isAuthorized() internal view override returns (bool) {
+        return
+            _crossChainSender() == TypeCasts.bytes32ToAddress(authorizedHook);
+    }
+}

package/contracts/isms/libs/MerkleRootMultisigIsmMetadata.sol

@@ -109,4 +109,20 @@ library MerkleRootMultisigIsmMetadata {
         uint256 _end = _start + SIGNATURE_LENGTH;
         return _metadata[_start:_end];
     }
+
+    /**
+     * @notice Returns the number of signatures in the metadata.
+     * @param _metadata ABI encoded Merkle Root Multisig ISM metadata.
+     * @return The number of signatures in the metadata.
+     */
+    function signatureCount(
+        bytes calldata _metadata
+    ) internal pure returns (uint256) {
+        uint256 signatures = _metadata.length - SIGNATURES_OFFSET;
+        require(
+            signatures % SIGNATURE_LENGTH == 0,
+            "Invalid signatures length"
+        );
+        return signatures / SIGNATURE_LENGTH;
+    }
 }

package/contracts/isms/libs/MessageIdMultisigIsmMetadata.sol

@@ -68,4 +68,20 @@ library MessageIdMultisigIsmMetadata {
         uint256 _end = _start + SIGNATURE_LENGTH;
         return _metadata[_start:_end];
     }
+
+    /**
+     * @notice Returns the number of signatures in the metadata.
+     * @param _metadata ABI encoded MessageId Multisig ISM metadata.
+     * @return The number of signatures in the metadata.
+     */
+    function signatureCount(
+        bytes calldata _metadata
+    ) internal pure returns (uint256) {
+        uint256 signatures = _metadata.length - SIGNATURES_OFFSET;
+        require(
+            signatures % SIGNATURE_LENGTH == 0,
+            "Invalid signatures length"
+        );
+        return signatures / SIGNATURE_LENGTH;
+    }
 }