@hyperlane-xyz/core 3.1.2 → 3.1.4

package/contracts/hooks/libs/StandardHookMetadata.sol

@@ -47,11 +47,10 @@ library StandardHookMetadata {
      * @param _default Default fallback value.
      * @return Value for the message as uint256.
      */
-    function msgValue(bytes calldata _metadata, uint256 _default)
-        internal
-        pure
-        returns (uint256)
-    {
+    function msgValue(
+        bytes calldata _metadata,
+        uint256 _default
+    ) internal pure returns (uint256) {
         if (_metadata.length < MSG_VALUE_OFFSET + 32) return _default;
         return
             uint256(bytes32(_metadata[MSG_VALUE_OFFSET:MSG_VALUE_OFFSET + 32]));
@@ -63,11 +62,10 @@ library StandardHookMetadata {
      * @param _default Default fallback gas limit.
      * @return Gas limit for the message as uint256.
      */
-    function gasLimit(bytes calldata _metadata, uint256 _default)
-        internal
-        pure
-        returns (uint256)
-    {
+    function gasLimit(
+        bytes calldata _metadata,
+        uint256 _default
+    ) internal pure returns (uint256) {
         if (_metadata.length < GAS_LIMIT_OFFSET + 32) return _default;
         return
             uint256(bytes32(_metadata[GAS_LIMIT_OFFSET:GAS_LIMIT_OFFSET + 32]));
@@ -79,11 +77,10 @@ library StandardHookMetadata {
      * @param _default Default fallback refund address.
      * @return Refund address for the message as address.
      */
-    function refundAddress(bytes calldata _metadata, address _default)
-        internal
-        pure
-        returns (address)
-    {
+    function refundAddress(
+        bytes calldata _metadata,
+        address _default
+    ) internal pure returns (address) {
         if (_metadata.length < REFUND_ADDRESS_OFFSET + 20) return _default;
         return
             address(
@@ -98,11 +95,9 @@ library StandardHookMetadata {
      * @param _metadata ABI encoded global hook metadata.
      * @return Refund address for the message as address.
      */
-    function getCustomMetadata(bytes calldata _metadata)
-        internal
-        pure
-        returns (bytes calldata)
-    {
+    function getCustomMetadata(
+        bytes calldata _metadata
+    ) internal pure returns (bytes calldata) {
         if (_metadata.length < MIN_METADATA_LENGTH) return _metadata[0:0];
         return _metadata[MIN_METADATA_LENGTH:];
     }
@@ -136,11 +131,9 @@ library StandardHookMetadata {
      * @param _msgValue msg.value for the message.
      * @return ABI encoded global hook metadata.
      */
-    function formatMetadata(uint256 _msgValue)
-        internal
-        view
-        returns (bytes memory)
-    {
+    function formatMetadata(
+        uint256 _msgValue
+    ) internal view returns (bytes memory) {
         return formatMetadata(_msgValue, uint256(0), msg.sender, "");
     }
 
@@ -150,11 +143,10 @@ library StandardHookMetadata {
      * @param _refundAddress Refund address for the message.
      * @return ABI encoded global hook metadata.
      */
-    function formatMetadata(uint256 _gasLimit, address _refundAddress)
-        internal
-        pure
-        returns (bytes memory)
-    {
+    function formatMetadata(
+        uint256 _gasLimit,
+        address _refundAddress
+    ) internal pure returns (bytes memory) {
         return formatMetadata(uint256(0), _gasLimit, _refundAddress, "");
     }
 }

package/contracts/hooks/routing/DestinationRecipientRoutingHook.sol

@@ -23,14 +23,15 @@ contract DestinationRecipientRoutingHook is DomainRoutingHook {
     /// @notice destination => recipient =>custom hook
     mapping(uint32 => mapping(bytes32 => address)) public customHooks;
 
-    constructor(address mailbox, address owner)
-        DomainRoutingHook(mailbox, owner)
-    {}
+    constructor(
+        address mailbox,
+        address owner
+    ) DomainRoutingHook(mailbox, owner) {}
 
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         address customHookPreset = customHooks[message.destination()][
             message.recipient()
         ];

package/contracts/hooks/routing/DomainRoutingHook.sol

@@ -59,13 +59,9 @@ contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
         }
     }
 
-    function supportsMetadata(bytes calldata)
-        public
-        pure
-        virtual
-        override
-        returns (bool)
-    {
+    function supportsMetadata(
+        bytes calldata
+    ) public pure virtual override returns (bool) {
         // routing hook does not care about metadata shape
         return true;
     }
@@ -73,11 +69,10 @@ contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
     // ============ Internal Functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        virtual
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal virtual override {
         _getConfiguredHook(message).postDispatch{value: msg.value}(
             metadata,
             message
@@ -85,22 +80,16 @@ contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal view virtual override returns (uint256) {
         return _getConfiguredHook(message).quoteDispatch(metadata, message);
     }
 
-    function _getConfiguredHook(bytes calldata message)
-        internal
-        view
-        virtual
-        returns (IPostDispatchHook hook)
-    {
+    function _getConfiguredHook(
+        bytes calldata message
+    ) internal view virtual returns (IPostDispatchHook hook) {
         hook = hooks[message.destination()];
         require(
             address(hook) != address(0),

package/contracts/hooks/routing/FallbackDomainRoutingHook.sol

@@ -45,12 +45,9 @@ contract FallbackDomainRoutingHook is DomainRoutingHook {
 
     // ============ Internal Functions ============
 
-    function _getConfiguredHook(bytes calldata message)
-        internal
-        view
-        override
-        returns (IPostDispatchHook)
-    {
+    function _getConfiguredHook(
+        bytes calldata message
+    ) internal view override returns (IPostDispatchHook) {
         IPostDispatchHook _hook = hooks[message.destination()];
         if (address(_hook) == address(0)) {
             _hook = fallbackHook;

package/contracts/interfaces/IGasOracle.sol

@@ -9,8 +9,7 @@ interface IGasOracle {
         uint128 gasPrice;
     }
 
-    function getExchangeRateAndGasPrice(uint32 _destinationDomain)
-        external
-        view
-        returns (uint128 tokenExchangeRate, uint128 gasPrice);
+    function getExchangeRateAndGasPrice(
+        uint32 _destinationDomain
+    ) external view returns (uint128 tokenExchangeRate, uint128 gasPrice);
 }

package/contracts/interfaces/IInterchainGasPaymaster.sol

@@ -28,8 +28,8 @@ interface IInterchainGasPaymaster {
         address _refundAddress
     ) external payable;
 
-    function quoteGasPayment(uint32 _destinationDomain, uint256 _gasAmount)
-        external
-        view
-        returns (uint256);
+    function quoteGasPayment(
+        uint32 _destinationDomain,
+        uint256 _gasAmount
+    ) external view returns (uint256);
 }

package/contracts/interfaces/IInterchainSecurityModule.sol

@@ -28,9 +28,10 @@ interface IInterchainSecurityModule {
      * @param _message Hyperlane encoded interchain message
      * @return True if the message was verified
      */
-    function verify(bytes calldata _metadata, bytes calldata _message)
-        external
-        returns (bool);
+    function verify(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) external returns (bool);
 }
 
 interface ISpecifiesInterchainSecurityModule {

package/contracts/interfaces/IMailbox.sol

@@ -96,12 +96,12 @@ interface IMailbox {
         IPostDispatchHook customHook
     ) external view returns (uint256 fee);
 
-    function process(bytes calldata metadata, bytes calldata message)
-        external
-        payable;
-
-    function recipientIsm(address recipient)
-        external
-        view
-        returns (IInterchainSecurityModule module);
+    function process(
+        bytes calldata metadata,
+        bytes calldata message
+    ) external payable;
+
+    function recipientIsm(
+        address recipient
+    ) external view returns (IInterchainSecurityModule module);
 }

package/contracts/interfaces/IValidatorAnnounce.sol

@@ -10,10 +10,9 @@ interface IValidatorAnnounce {
      * @param _validators The list of validators to get storage locations for
      * @return A list of announced storage locations
      */
-    function getAnnouncedStorageLocations(address[] calldata _validators)
-        external
-        view
-        returns (string[][] memory);
+    function getAnnouncedStorageLocations(
+        address[] calldata _validators
+    ) external view returns (string[][] memory);
 
     /**
      * @notice Announces a validator signature storage location

package/contracts/interfaces/hooks/IPostDispatchHook.sol

@@ -36,19 +36,19 @@ interface IPostDispatchHook {
      * @param metadata metadata
      * @return Whether the hook supports metadata
      */
-    function supportsMetadata(bytes calldata metadata)
-        external
-        view
-        returns (bool);
+    function supportsMetadata(
+        bytes calldata metadata
+    ) external view returns (bool);
 
     /**
      * @notice Post action after a message is dispatched via the Mailbox
      * @param metadata The metadata required for the hook
      * @param message The message passed from the Mailbox.dispatch() call
      */
-    function postDispatch(bytes calldata metadata, bytes calldata message)
-        external
-        payable;
+    function postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) external payable;
 
     /**
      * @notice Compute the payment required by the postDispatch call
@@ -56,8 +56,8 @@ interface IPostDispatchHook {
      * @param message The message passed from the Mailbox.dispatch() call
      * @return Quoted payment for the postDispatch call
      */
-    function quoteDispatch(bytes calldata metadata, bytes calldata message)
-        external
-        view
-        returns (uint256);
+    function quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) external view returns (uint256);
 }

package/contracts/interfaces/isms/IAggregationIsm.sol

@@ -12,8 +12,7 @@ interface IAggregationIsm is IInterchainSecurityModule {
      * @return modules The array of ISM addresses
      * @return threshold The number of modules needed to verify
      */
-    function modulesAndThreshold(bytes calldata _message)
-        external
-        view
-        returns (address[] memory modules, uint8 threshold);
+    function modulesAndThreshold(
+        bytes calldata _message
+    ) external view returns (address[] memory modules, uint8 threshold);
 }

package/contracts/interfaces/isms/IMultisigIsm.sol

@@ -12,8 +12,7 @@ interface IMultisigIsm is IInterchainSecurityModule {
      * @return validators The array of validator addresses
      * @return threshold The number of validator signatures needed
      */
-    function validatorsAndThreshold(bytes calldata _message)
-        external
-        view
-        returns (address[] memory validators, uint8 threshold);
+    function validatorsAndThreshold(
+        bytes calldata _message
+    ) external view returns (address[] memory validators, uint8 threshold);
 }

package/contracts/interfaces/isms/IRoutingIsm.sol

@@ -10,8 +10,7 @@ interface IRoutingIsm is IInterchainSecurityModule {
      * @param _message Formatted Hyperlane message (see Message.sol).
      * @return module The ISM to use to verify _message
      */
-    function route(bytes calldata _message)
-        external
-        view
-        returns (IInterchainSecurityModule);
+    function route(
+        bytes calldata _message
+    ) external view returns (IInterchainSecurityModule);
 }

package/contracts/isms/NoopIsm.sol

@@ -6,12 +6,10 @@ import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule
 contract NoopIsm is IInterchainSecurityModule {
     uint8 public constant override moduleType = uint8(Types.NULL);
 
-    function verify(bytes calldata, bytes calldata)
-        public
-        pure
-        override
-        returns (bool)
-    {
+    function verify(
+        bytes calldata,
+        bytes calldata
+    ) public pure override returns (bool) {
         return true;
     }
 }

package/contracts/isms/PausableIsm.sol

@@ -15,12 +15,10 @@ contract PausableIsm is IInterchainSecurityModule, Ownable, Pausable {
      * @inheritdoc IInterchainSecurityModule
      * @dev Reverts when paused, otherwise returns `true`.
      */
-    function verify(bytes calldata, bytes calldata)
-        external
-        view
-        whenNotPaused
-        returns (bool)
-    {
+    function verify(
+        bytes calldata,
+        bytes calldata
+    ) external view whenNotPaused returns (bool) {
         return true;
     }
 

package/contracts/isms/aggregation/AbstractAggregationIsm.sol

@@ -32,11 +32,9 @@ abstract contract AbstractAggregationIsm is IAggregationIsm {
      * @return modules The array of ISM addresses
      * @return threshold The number of ISMs needed to verify
      */
-    function modulesAndThreshold(bytes calldata _message)
-        public
-        view
-        virtual
-        returns (address[] memory, uint8);
+    function modulesAndThreshold(
+        bytes calldata _message
+    ) public view virtual returns (address[] memory, uint8);
 
     // ============ Public Functions ============
 
@@ -45,10 +43,10 @@ abstract contract AbstractAggregationIsm is IAggregationIsm {
      * @param _metadata ABI encoded module metadata (see AggregationIsmMetadata.sol)
      * @param _message Formatted Hyperlane message (see Message.sol).
      */
-    function verify(bytes calldata _metadata, bytes calldata _message)
-        public
-        returns (bool)
-    {
+    function verify(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) public returns (bool) {
         (address[] memory _isms, uint8 _threshold) = modulesAndThreshold(
             _message
         );

package/contracts/isms/aggregation/StaticAggregationIsm.sol

@@ -21,13 +21,9 @@ contract StaticAggregationIsm is AbstractAggregationIsm {
      * @return modules The array of ISM addresses
      * @return threshold The number of ISMs needed to verify
      */
-    function modulesAndThreshold(bytes calldata)
-        public
-        view
-        virtual
-        override
-        returns (address[] memory, uint8)
-    {
+    function modulesAndThreshold(
+        bytes calldata
+    ) public view virtual override returns (address[] memory, uint8) {
         return abi.decode(MetaProxy.metadata(), (address[], uint8));
     }
 }

package/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

@@ -105,7 +105,7 @@ abstract contract AbstractMessageIdAuthorizedIsm is
             "AbstractMessageIdAuthorizedIsm: sender is not the hook"
         );
         require(
-            msg.value < 2**VERIFIED_MASK_INDEX,
+            msg.value < 2 ** VERIFIED_MASK_INDEX,
             "AbstractMessageIdAuthorizedIsm: msg.value must be less than 2^255"
         );
 

package/contracts/isms/libs/AggregationIsmMetadata.sol

@@ -19,11 +19,10 @@ library AggregationIsmMetadata {
      * @param _index The index of the ISM to check for metadata for
      * @return Whether or not metadata was provided for the ISM at `_index`
      */
-    function hasMetadata(bytes calldata _metadata, uint8 _index)
-        internal
-        pure
-        returns (bool)
-    {
+    function hasMetadata(
+        bytes calldata _metadata,
+        uint8 _index
+    ) internal pure returns (bool) {
         (uint32 _start, ) = _metadataRange(_metadata, _index);
         return _start > 0;
     }
@@ -37,11 +36,10 @@ library AggregationIsmMetadata {
      * @param _index The index of the ISM to return metadata for
      * @return The metadata provided for the ISM at `_index`
      */
-    function metadataAt(bytes calldata _metadata, uint8 _index)
-        internal
-        pure
-        returns (bytes calldata)
-    {
+    function metadataAt(
+        bytes calldata _metadata,
+        uint8 _index
+    ) internal pure returns (bytes calldata) {
         (uint32 _start, uint32 _end) = _metadataRange(_metadata, _index);
         return _metadata[_start:_end];
     }
@@ -56,11 +54,10 @@ library AggregationIsmMetadata {
      * @return The range of the metadata provided for the ISM at `_index`, or
      * zeroes if not provided
      */
-    function _metadataRange(bytes calldata _metadata, uint8 _index)
-        private
-        pure
-        returns (uint32, uint32)
-    {
+    function _metadataRange(
+        bytes calldata _metadata,
+        uint8 _index
+    ) private pure returns (uint32, uint32) {
         uint256 _start = (uint32(_index) * RANGE_SIZE * 2);
         uint256 _mid = _start + RANGE_SIZE;
         uint256 _end = _mid + RANGE_SIZE;

package/contracts/isms/libs/MerkleRootMultisigIsmMetadata.sol

@@ -25,11 +25,9 @@ library MerkleRootMultisigIsmMetadata {
      * @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)
-    {
+    function originMerkleTreeHook(
+        bytes calldata _metadata
+    ) internal pure returns (bytes32) {
         return
             bytes32(
                 _metadata[ORIGIN_MERKLE_TREE_OFFSET:ORIGIN_MERKLE_TREE_OFFSET +
@@ -42,11 +40,9 @@ library MerkleRootMultisigIsmMetadata {
      * @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)
-    {
+    function messageIndex(
+        bytes calldata _metadata
+    ) internal pure returns (uint32) {
         return
             uint32(
                 bytes4(_metadata[MESSAGE_INDEX_OFFSET:MESSAGE_INDEX_OFFSET + 4])
@@ -58,11 +54,9 @@ library MerkleRootMultisigIsmMetadata {
      * @param _metadata ABI encoded Multisig ISM metadata.
      * @return Index of the signed checkpoint
      */
-    function signedIndex(bytes calldata _metadata)
-        internal
-        pure
-        returns (uint32)
-    {
+    function signedIndex(
+        bytes calldata _metadata
+    ) internal pure returns (uint32) {
         return
             uint32(
                 bytes4(_metadata[SIGNED_INDEX_OFFSET:SIGNED_INDEX_OFFSET + 4])
@@ -74,11 +68,9 @@ library MerkleRootMultisigIsmMetadata {
      * @param _metadata ABI encoded Multisig ISM metadata.
      * @return Message ID of the signed checkpoint
      */
-    function signedMessageId(bytes calldata _metadata)
-        internal
-        pure
-        returns (bytes32)
-    {
+    function signedMessageId(
+        bytes calldata _metadata
+    ) internal pure returns (bytes32) {
         return bytes32(_metadata[MESSAGE_ID_OFFSET:MESSAGE_ID_OFFSET + 32]);
     }
 
@@ -89,11 +81,9 @@ library MerkleRootMultisigIsmMetadata {
      * @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)
-    {
+    function proof(
+        bytes calldata _metadata
+    ) internal pure returns (bytes32[32] memory) {
         return
             abi.decode(
                 _metadata[MERKLE_PROOF_OFFSET:MERKLE_PROOF_OFFSET +
@@ -111,11 +101,10 @@ library MerkleRootMultisigIsmMetadata {
      * @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)
-    {
+    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

@@ -20,11 +20,9 @@ library MessageIdMultisigIsmMetadata {
      * @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)
-    {
+    function originMerkleTreeHook(
+        bytes calldata _metadata
+    ) internal pure returns (bytes32) {
         return
             bytes32(
                 _metadata[ORIGIN_MERKLE_TREE_OFFSET:ORIGIN_MERKLE_TREE_OFFSET +
@@ -62,11 +60,10 @@ library MessageIdMultisigIsmMetadata {
      * @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)
-    {
+    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

@@ -35,12 +35,10 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
     /**
      * @inheritdoc AbstractMultisigIsm
      */
-    function digest(bytes calldata _metadata, bytes calldata _message)
-        internal
-        pure
-        override
-        returns (bytes32)
-    {
+    function digest(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) internal pure override returns (bytes32) {
         require(
             _metadata.messageIndex() <= _metadata.signedIndex(),
             "Invalid merkle index metadata"
@@ -65,13 +63,10 @@ abstract contract AbstractMerkleRootMultisigIsm is AbstractMultisigIsm {
     /**
      * @inheritdoc AbstractMultisigIsm
      */
-    function signatureAt(bytes calldata _metadata, uint256 _index)
-        internal
-        pure
-        virtual
-        override
-        returns (bytes calldata)
-    {
+    function signatureAt(
+        bytes calldata _metadata,
+        uint256 _index
+    ) internal pure virtual override returns (bytes calldata) {
         return _metadata.signatureAt(_index);
     }
 }