@hyperlane-xyz/core 5.0.0 → 5.1.0

package/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol

@@ -3,7 +3,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
-import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
+import {AbstractMultisig} from "./AbstractMultisigIsm.sol";
 import {MerkleRootMultisigIsmMetadata} from "../../isms/libs/MerkleRootMultisigIsmMetadata.sol";
 import {Message} from "../../libs/Message.sol";
 import {MerkleLib} from "../../libs/Merkle.sol";
@@ -22,23 +22,19 @@ import {CheckpointLib} from "../../libs/CheckpointLib.sol";
  * This abstract contract can be overridden for customizing the `validatorsAndThreshold()` (static or dynamic).
  * @dev May be adapted in future to support batch message verification against a single root.
  */
-abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
+abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisig {
     using MerkleRootMultisigIsmMetadata for bytes;
     using Message for bytes;
 
     // ============ Constants ============
 
-    // solhint-disable-next-line const-name-snakecase
-    uint8 public constant moduleType =
-        uint8(IInterchainSecurityModule.Types.MERKLE_ROOT_MULTISIG);
-
     /**
-     * @inheritdoc AbstractMultisigIsm
+     * @inheritdoc AbstractMultisig
      */
     function digest(
         bytes calldata _metadata,
         bytes calldata _message
-    ) internal pure override returns (bytes32) {
+    ) internal pure virtual override returns (bytes32) {
         require(
             _metadata.messageIndex() <= _metadata.signedIndex(),
             "Invalid merkle index metadata"
@@ -61,7 +57,7 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
     }
 
     /**
-     * @inheritdoc AbstractMultisigIsm
+     * @inheritdoc AbstractMultisig
      */
     function signatureAt(
         bytes calldata _metadata,
@@ -69,4 +65,13 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
     ) internal pure virtual override returns (bytes calldata) {
         return _metadata.signatureAt(_index);
     }
+
+    /**
+     * @inheritdoc AbstractMultisig
+     */
+    function signatureCount(
+        bytes calldata _metadata
+    ) public pure override returns (uint256) {
+        return _metadata.signatureCount();
+    }
 }

package/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol

@@ -3,7 +3,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
-import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
+import {AbstractMultisig} from "./AbstractMultisigIsm.sol";
 import {MessageIdMultisigIsmMetadata} from "../libs/MessageIdMultisigIsmMetadata.sol";
 import {Message} from "../../libs/Message.sol";
 import {CheckpointLib} from "../../libs/CheckpointLib.sol";
@@ -18,18 +18,14 @@ import {CheckpointLib} from "../../libs/CheckpointLib.sol";
  * @dev Provides the default implementation of verifying signatures over a checkpoint related to a specific message ID.
  * This abstract contract can be customized to change the `validatorsAndThreshold()` (static or dynamic).
  */
-abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
+abstract contract AbstractMessageIdMultisigIsm is AbstractMultisig {
     using Message for bytes;
     using MessageIdMultisigIsmMetadata for bytes;
 
     // ============ Constants ============
 
-    // solhint-disable-next-line const-name-snakecase
-    uint8 public constant moduleType =
-        uint8(IInterchainSecurityModule.Types.MESSAGE_ID_MULTISIG);
-
     /**
-     * @inheritdoc AbstractMultisigIsm
+     * @inheritdoc AbstractMultisig
      */
     function digest(
         bytes calldata _metadata,
@@ -46,7 +42,7 @@ abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
     }
 
     /**
-     * @inheritdoc AbstractMultisigIsm
+     * @inheritdoc AbstractMultisig
      */
     function signatureAt(
         bytes calldata _metadata,
@@ -54,4 +50,13 @@ abstract contract AbstractMessageIdMultisigIsm is AbstractMultisigIsm {
     ) internal pure virtual override returns (bytes calldata) {
         return _metadata.signatureAt(_index);
     }
+
+    /**
+     * @inheritdoc AbstractMultisig
+     */
+    function signatureCount(
+        bytes calldata _metadata
+    ) public pure override returns (uint256) {
+        return _metadata.signatureCount();
+    }
 }

package/contracts/isms/multisig/AbstractMultisigIsm.sol

@@ -1,6 +1,18 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
 // ============ External Imports ============
 import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 
@@ -11,30 +23,13 @@ import {Message} from "../../libs/Message.sol";
 import {MerkleLib} from "../../libs/Merkle.sol";
 
 /**
- * @title MultisigIsm
- * @notice Manages per-domain m-of-n Validator sets that are used to verify
- * interchain messages.
+ * @title AbstractMultisig
+ * @notice Manages per-domain m-of-n Validator sets
  * @dev See ./AbstractMerkleRootMultisigIsm.sol and ./AbstractMessageIdMultisigIsm.sol
  * for concrete implementations of `digest` and `signatureAt`.
  * @dev See ./StaticMultisigIsm.sol for concrete implementations.
  */
-abstract contract AbstractMultisigIsm is IMultisigIsm {
-    // ============ Virtual Functions ============
-    // ======= OVERRIDE THESE TO IMPLEMENT =======
-
-    /**
-     * @notice Returns the set of validators responsible for verifying _message
-     * and the number of signatures required
-     * @dev Can change based on the content of _message
-     * @dev Signatures provided to `verify` must be consistent with validator ordering
-     * @param _message Hyperlane formatted interchain message
-     * @return validators The array of validator addresses
-     * @return threshold The number of validator signatures needed
-     */
-    function validatorsAndThreshold(
-        bytes calldata _message
-    ) public view virtual returns (address[] memory, uint8);
-
+abstract contract AbstractMultisig {
     /**
      * @notice Returns the digest to be used for signature verification.
      * @param _metadata ABI encoded module metadata
@@ -57,6 +52,38 @@ abstract contract AbstractMultisigIsm is IMultisigIsm {
         uint256 _index
     ) internal pure virtual returns (bytes calldata);
 
+    /**
+     * @notice Returns the number of signatures in the metadata.
+     * @param _metadata ABI encoded module metadata
+     * @return count The number of signatures
+     */
+    function signatureCount(
+        bytes calldata _metadata
+    ) public pure virtual returns (uint256);
+}
+
+/**
+ * @title AbstractMultisigIsm
+ * @notice Manages per-domain m-of-n Validator sets of AbstractMultisig that are used to verify
+ * interchain messages.
+ */
+abstract contract AbstractMultisigIsm is AbstractMultisig {
+    // ============ Virtual Functions ============
+    // ======= OVERRIDE THESE TO IMPLEMENT =======
+
+    /**
+     * @notice Returns the set of validators responsible for verifying _message
+     * and the number of signatures required
+     * @dev Can change based on the content of _message
+     * @dev Signatures provided to `verify` must be consistent with validator ordering
+     * @param _message Hyperlane formatted interchain message
+     * @return validators The array of validator addresses
+     * @return threshold The number of validator signatures needed
+     */
+    function validatorsAndThreshold(
+        bytes calldata _message
+    ) public view virtual returns (address[] memory, uint8);
+
     // ============ Public Functions ============
 
     /**

package/contracts/isms/multisig/AbstractWeightedMultisigIsm.sol

@@ -0,0 +1,100 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ External Imports ============
+import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+// ============ Internal Imports ============
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {IStaticWeightedMultisigIsm} from "../../interfaces/isms/IWeightedMultisigIsm.sol";
+import {Message} from "../../libs/Message.sol";
+
+import {MerkleLib} from "../../libs/Merkle.sol";
+import {AbstractMultisig} from "./AbstractMultisigIsm.sol";
+
+/**
+ * @title AbstractStaticWeightedMultisigIsm
+ * @notice Manages per-domain m-of-n Validator sets with stake weights that are used to verify
+ * interchain messages.
+ */
+abstract contract AbstractStaticWeightedMultisigIsm is
+    AbstractMultisig,
+    IStaticWeightedMultisigIsm
+{
+    // ============ Constants ============
+
+    // total weight of all validators
+    uint96 public constant TOTAL_WEIGHT = 1e10;
+
+    /**
+     * @inheritdoc IStaticWeightedMultisigIsm
+     */
+    function validatorsAndThresholdWeight(
+        bytes calldata /* _message*/
+    ) public view virtual returns (ValidatorInfo[] memory, uint96);
+
+    /**
+     * @inheritdoc IInterchainSecurityModule
+     */
+    function verify(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) public view virtual returns (bool) {
+        bytes32 _digest = digest(_metadata, _message);
+        (
+            ValidatorInfo[] memory _validators,
+            uint96 _thresholdWeight
+        ) = validatorsAndThresholdWeight(_message);
+
+        require(
+            _thresholdWeight > 0 && _thresholdWeight <= TOTAL_WEIGHT,
+            "Invalid threshold weight"
+        );
+
+        uint256 _validatorCount = Math.min(
+            _validators.length,
+            signatureCount(_metadata)
+        );
+        uint256 _validatorIndex = 0;
+        uint96 _totalWeight = 0;
+
+        // assumes that signatures are ordered by validator
+        for (
+            uint256 i = 0;
+            _totalWeight < _thresholdWeight && i < _validatorCount;
+            ++i
+        ) {
+            address _signer = ECDSA.recover(_digest, signatureAt(_metadata, i));
+            // loop through remaining validators until we find a match
+            while (
+                _validatorIndex < _validatorCount &&
+                _signer != _validators[_validatorIndex].signingAddress
+            ) {
+                ++_validatorIndex;
+            }
+            // fail if we never found a match
+            require(_validatorIndex < _validatorCount, "Invalid signer");
+
+            // add the weight of the current validator
+            _totalWeight += _validators[_validatorIndex].weight;
+        }
+        require(
+            _totalWeight >= _thresholdWeight,
+            "Insufficient validator weight"
+        );
+        return true;
+    }
+}

package/contracts/isms/multisig/StaticMultisigIsm.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 // ============ Internal Imports ============
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
 import {AbstractMerkleRootMultisigIsm} from "./AbstractMerkleRootMultisigIsm.sol";
 import {AbstractMessageIdMultisigIsm} from "./AbstractMessageIdMultisigIsm.sol";
@@ -34,7 +36,10 @@ abstract contract AbstractMetaProxyMultisigIsm is AbstractMultisigIsm {
 contract StaticMerkleRootMultisigIsm is
     AbstractMerkleRootMultisigIsm,
     AbstractMetaProxyMultisigIsm
-{}
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.MERKLE_ROOT_MULTISIG);
+}
 
 /**
  * @title StaticMessageIdMultisigIsm
@@ -44,7 +49,10 @@ contract StaticMerkleRootMultisigIsm is
 contract StaticMessageIdMultisigIsm is
     AbstractMessageIdMultisigIsm,
     AbstractMetaProxyMultisigIsm
-{}
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.MESSAGE_ID_MULTISIG);
+}
 
 // solhint-enable no-empty-blocks
 

package/contracts/isms/multisig/WeightedMultisigIsm.sol

@@ -0,0 +1,67 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {AbstractMerkleRootMultisigIsm} from "./AbstractMerkleRootMultisigIsm.sol";
+import {AbstractMessageIdMultisigIsm} from "./AbstractMessageIdMultisigIsm.sol";
+import {AbstractStaticWeightedMultisigIsm} from "./AbstractWeightedMultisigIsm.sol";
+import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
+import {StaticWeightedValidatorSetFactory} from "../../libs/StaticWeightedValidatorSetFactory.sol";
+import {MetaProxy} from "../../libs/MetaProxy.sol";
+
+abstract contract AbstractMetaProxyWeightedMultisigIsm is
+    AbstractStaticWeightedMultisigIsm
+{
+    /**
+     * @inheritdoc AbstractStaticWeightedMultisigIsm
+     */
+    function validatorsAndThresholdWeight(
+        bytes calldata /* _message*/
+    ) public pure override returns (ValidatorInfo[] memory, uint96) {
+        return abi.decode(MetaProxy.metadata(), (ValidatorInfo[], uint96));
+    }
+}
+
+contract StaticMerkleRootWeightedMultisigIsm is
+    AbstractMerkleRootMultisigIsm,
+    AbstractMetaProxyWeightedMultisigIsm
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.WEIGHT_MERKLE_ROOT_MULTISIG);
+}
+
+contract StaticMessageIdWeightedMultisigIsm is
+    AbstractMessageIdMultisigIsm,
+    AbstractMetaProxyWeightedMultisigIsm
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.WEIGHT_MESSAGE_ID_MULTISIG);
+}
+
+contract StaticMerkleRootWeightedMultisigIsmFactory is
+    StaticWeightedValidatorSetFactory
+{
+    function _deployImplementation() internal override returns (address) {
+        return address(new StaticMerkleRootWeightedMultisigIsm());
+    }
+}
+
+contract StaticMessageIdWeightedMultisigIsmFactory is
+    StaticWeightedValidatorSetFactory
+{
+    function _deployImplementation() internal override returns (address) {
+        return address(new StaticMessageIdWeightedMultisigIsm());
+    }
+}

package/contracts/isms/routing/DomainRoutingIsm.sol

@@ -85,8 +85,10 @@ contract DomainRoutingIsm is AbstractRoutingIsm, OwnableUpgradeable {
         uint32 origin
     ) public view virtual returns (IInterchainSecurityModule) {
         (bool contained, bytes32 _module) = _modules.tryGet(origin);
-        require(contained, _originNotFoundError(origin));
-        return IInterchainSecurityModule(_module.bytes32ToAddress());
+        if (contained) {
+            return IInterchainSecurityModule(_module.bytes32ToAddress());
+        }
+        revert(_originNotFoundError(origin));
     }
 
     // ============ Public Functions ============

package/contracts/libs/CheckpointLib.sol

@@ -1,14 +1,24 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
-// ============ External Imports ============
 import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import {TypeCasts} from "./TypeCasts.sol";
+
+struct Checkpoint {
+    uint32 origin;
+    bytes32 merkleTree;
+    bytes32 root;
+    uint32 index;
+    bytes32 messageId;
+}
 
 library CheckpointLib {
+    using TypeCasts for bytes32;
+
     /**
      * @notice Returns the digest validators are expected to sign when signing checkpoints.
      * @param _origin The origin domain of the checkpoint.
-     * @param _originmerkleTreeHook The address of the origin merkle tree hook as bytes32.
+     * @param _merkleTreeHook The address of the origin merkle tree hook as bytes32.
      * @param _checkpointRoot The root of the checkpoint.
      * @param _checkpointIndex The index of the checkpoint.
      * @param _messageId The message ID of the checkpoint.
@@ -17,12 +27,12 @@ library CheckpointLib {
      */
     function digest(
         uint32 _origin,
-        bytes32 _originmerkleTreeHook,
+        bytes32 _merkleTreeHook,
         bytes32 _checkpointRoot,
         uint32 _checkpointIndex,
         bytes32 _messageId
     ) internal pure returns (bytes32) {
-        bytes32 _domainHash = domainHash(_origin, _originmerkleTreeHook);
+        bytes32 _domainHash = domainHash(_origin, _merkleTreeHook);
         return
             ECDSA.toEthSignedMessageHash(
                 keccak256(
@@ -36,16 +46,40 @@ library CheckpointLib {
             );
     }
 
+    /**
+     * @notice Returns the digest validators are expected to sign when signing checkpoints.
+     * @param checkpoint The checkpoint (struct) to hash.
+     * @return The digest of the checkpoint.
+     */
+    function digest(
+        Checkpoint memory checkpoint
+    ) internal pure returns (bytes32) {
+        return
+            digest(
+                checkpoint.origin,
+                checkpoint.merkleTree,
+                checkpoint.root,
+                checkpoint.index,
+                checkpoint.messageId
+            );
+    }
+
+    function merkleTreeAddress(
+        Checkpoint calldata checkpoint
+    ) internal pure returns (address) {
+        return checkpoint.merkleTree.bytes32ToAddress();
+    }
+
     /**
      * @notice Returns the domain hash that validators are expected to use
      * when signing checkpoints.
      * @param _origin The origin domain of the checkpoint.
-     * @param _originmerkleTreeHook The address of the origin merkle tree as bytes32.
+     * @param _merkleTreeHook The address of the origin merkle tree as bytes32.
      * @return The domain hash.
      */
     function domainHash(
         uint32 _origin,
-        bytes32 _originmerkleTreeHook
+        bytes32 _merkleTreeHook
     ) internal pure returns (bytes32) {
         // Including the origin merkle tree address in the signature allows the slashing
         // protocol to enroll multiple trees. Otherwise, a valid signature for
@@ -53,8 +87,6 @@ library CheckpointLib {
         // The slashing protocol should slash if validators sign attestations for
         // anything other than a whitelisted tree.
         return
-            keccak256(
-                abi.encodePacked(_origin, _originmerkleTreeHook, "HYPERLANE")
-            );
+            keccak256(abi.encodePacked(_origin, _merkleTreeHook, "HYPERLANE"));
     }
 }

package/contracts/libs/Merkle.sol

@@ -3,15 +3,15 @@ pragma solidity >=0.6.11;
 
 // work based on eth2 deposit contract, which is used under CC0-1.0
 
+uint256 constant TREE_DEPTH = 32;
+uint256 constant MAX_LEAVES = 2 ** TREE_DEPTH - 1;
+
 /**
  * @title MerkleLib
  * @author Celo Labs Inc.
  * @notice An incremental merkle tree modeled on the eth2 deposit contract.
  **/
 library MerkleLib {
-    uint256 internal constant TREE_DEPTH = 32;
-    uint256 internal constant MAX_LEAVES = 2 ** TREE_DEPTH - 1;
-
     /**
      * @notice Struct representing incremental merkle tree. Contains current
      * branch and the number of inserted leaves in the tree.
@@ -140,6 +140,36 @@ library MerkleLib {
         }
     }
 
+    /**
+     * @notice Calculates and returns the merkle root as if the index is
+     * the topmost leaf in the tree.
+     * @param _item Merkle leaf
+     * @param _branch Merkle proof
+     * @param _index Index of `_item` in tree
+     * @dev Replaces siblings greater than the index (right subtrees) with zeroes.
+     * @return _current Calculated merkle root
+     **/
+    function reconstructRoot(
+        bytes32 _item,
+        bytes32[TREE_DEPTH] memory _branch, // cheaper than calldata indexing
+        uint256 _index
+    ) internal pure returns (bytes32 _current) {
+        _current = _item;
+
+        bytes32[TREE_DEPTH] memory _zeroes = zeroHashes();
+
+        for (uint256 i = 0; i < TREE_DEPTH; i++) {
+            uint256 _ithBit = (_index >> i) & 0x01;
+            // cheaper than calldata indexing _branch[i*32:(i+1)*32];
+            if (_ithBit == 1) {
+                _current = keccak256(abi.encodePacked(_branch[i], _current));
+            } else {
+                // remove right subtree from proof
+                _current = keccak256(abi.encodePacked(_current, _zeroes[i]));
+            }
+        }
+    }
+
     // keccak256 zero hashes
     bytes32 internal constant Z_0 =
         hex"0000000000000000000000000000000000000000000000000000000000000000";

package/contracts/libs/OPL2ToL1Metadata.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+/**
+ * @title Hyperlane OPL2ToL1Metadata Library
+ * @notice Library for formatted metadata used by OPL2ToL1Ism
+ */
+library OPL2ToL1Metadata {
+    // bottom offset to the start of message id in the metadata
+    uint256 private constant MESSAGE_ID_OFFSET = 88;
+    // from IOptimismPortal.WithdrawalTransaction
+    // Σ {
+    //      nonce                          = 32 bytes
+    //      PADDING + sender               = 32 bytes
+    //      PADDING + target               = 32 bytes
+    //      value                          = 32 bytes
+    //      gasLimit                       = 32 bytes
+    //      _data
+    //          OFFSET                      = 32 bytes
+    //          LENGTH                      = 32 bytes
+    // } = 252 bytes
+    uint256 private constant FIXED_METADATA_LENGTH = 252;
+    // metadata here is double encoded call relayMessage(..., verifyMessageId)
+    // Σ {
+    //      _selector                       =  4 bytes
+    //      _nonce                          = 32 bytes
+    //      PADDING + _sender               = 32 bytes
+    //      PADDING + _target               = 32 bytes
+    //      _value                          = 32 bytes
+    //      _minGasLimit                    = 32 bytes
+    //      _data
+    //          OFFSET                      = 32 bytes
+    //          LENGTH                      = 32 bytes
+    //          PADDING + verifyMessageId   = 64 bytes
+    // } = 292 bytes
+    uint256 private constant MESSENGER_CALLDATA_LENGTH = 292;
+
+    /**
+     * @notice Returns the message ID.
+     * @param _metadata OptimismPortal.WithdrawalTransaction encoded calldata
+     * @return ID of `_metadata`
+     */
+    function messageId(
+        bytes calldata _metadata
+    ) internal pure returns (bytes32) {
+        uint256 metadataLength = _metadata.length;
+        return
+            bytes32(
+                _metadata[metadataLength - MESSAGE_ID_OFFSET:metadataLength -
+                    MESSAGE_ID_OFFSET +
+                    32]
+            );
+    }
+
+    function checkCalldataLength(
+        bytes calldata _metadata
+    ) internal pure returns (bool) {
+        return
+            _metadata.length ==
+            MESSENGER_CALLDATA_LENGTH + FIXED_METADATA_LENGTH;
+    }
+}