@hyperlane-xyz/core 3.1.2 → 3.1.3

package/contracts/Mailbox.sol

@@ -191,11 +191,10 @@ contract Mailbox is IMailbox, Indexed, Versioned, OwnableUpgradeable {
      * @param _metadata Metadata used by the ISM to verify `_message`.
      * @param _message Formatted Hyperlane message (refer to Message.sol).
      */
-    function process(bytes calldata _metadata, bytes calldata _message)
-        external
-        payable
-        override
-    {
+    function process(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) external payable override {
         /// CHECKS ///
 
         // Check that the message was intended for this mailbox.
@@ -391,11 +390,9 @@ contract Mailbox is IMailbox, Indexed, Versioned, OwnableUpgradeable {
      * @param _recipient The message recipient whose ISM should be returned.
      * @return The ISM to use for `_recipient`.
      */
-    function recipientIsm(address _recipient)
-        public
-        view
-        returns (IInterchainSecurityModule)
-    {
+    function recipientIsm(
+        address _recipient
+    ) public view returns (IInterchainSecurityModule) {
         // use low-level staticcall in case of revert or empty return data
         (bool success, bytes memory returnData) = _recipient.staticcall(
             abi.encodeCall(

package/contracts/client/GasRouter.sol

@@ -19,10 +19,9 @@ abstract contract GasRouter is Router {
      * @notice Sets the gas amount dispatched for each configured domain.
      * @param gasConfigs The array of GasRouterConfig structs
      */
-    function setDestinationGas(GasRouterConfig[] calldata gasConfigs)
-        external
-        onlyOwner
-    {
+    function setDestinationGas(
+        GasRouterConfig[] calldata gasConfigs
+    ) external onlyOwner {
         for (uint256 i = 0; i < gasConfigs.length; i += 1) {
             _setDestinationGas(gasConfigs[i].domain, gasConfigs[i].gas);
         }
@@ -42,11 +41,9 @@ abstract contract GasRouter is Router {
      * @param _destinationDomain The domain of the router.
      * @return _gasPayment Payment computed by the registered InterchainGasPaymaster.
      */
-    function quoteGasPayment(uint32 _destinationDomain)
-        external
-        view
-        returns (uint256 _gasPayment)
-    {
+    function quoteGasPayment(
+        uint32 _destinationDomain
+    ) external view returns (uint256 _gasPayment) {
         return _quoteDispatch(_destinationDomain, "");
     }
 
@@ -54,13 +51,9 @@ abstract contract GasRouter is Router {
         return msg.sender;
     }
 
-    function _metadata(uint32 _destination)
-        internal
-        view
-        virtual
-        override
-        returns (bytes memory)
-    {
+    function _metadata(
+        uint32 _destination
+    ) internal view virtual override returns (bytes memory) {
         return
             StandardHookMetadata.formatMetadata(
                 destinationGas[_destination],

package/contracts/client/MailboxClient.sol

@@ -68,11 +68,9 @@ abstract contract MailboxClient is OwnableUpgradeable {
      * @notice Sets the address of the application's custom interchain security module.
      * @param _module The address of the interchain security module contract.
      */
-    function setInterchainSecurityModule(address _module)
-        public
-        onlyContractOrNull(_module)
-        onlyOwner
-    {
+    function setInterchainSecurityModule(
+        address _module
+    ) public onlyContractOrNull(_module) onlyOwner {
         interchainSecurityModule = IInterchainSecurityModule(_module);
     }
 

package/contracts/client/Router.sol

@@ -52,11 +52,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the remote Application Router
      * @param _router The address of the remote Application Router
      */
-    function enrollRemoteRouter(uint32 _domain, bytes32 _router)
-        external
-        virtual
-        onlyOwner
-    {
+    function enrollRemoteRouter(
+        uint32 _domain,
+        bytes32 _router
+    ) external virtual onlyOwner {
         _enrollRemoteRouter(_domain, _router);
     }
 
@@ -80,11 +79,9 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @notice Batch version of `unenrollRemoteRouter`
      * @param _domains The domains of the remote Application Routers
      */
-    function unenrollRemoteRouters(uint32[] calldata _domains)
-        external
-        virtual
-        onlyOwner
-    {
+    function unenrollRemoteRouters(
+        uint32[] calldata _domains
+    ) external virtual onlyOwner {
         uint256 length = _domains.length;
         for (uint256 i = 0; i < length; i += 1) {
             _unenrollRemoteRouter(_domains[i]);
@@ -121,10 +118,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain
      * @param _address The new router
      */
-    function _enrollRemoteRouter(uint32 _domain, bytes32 _address)
-        internal
-        virtual
-    {
+    function _enrollRemoteRouter(
+        uint32 _domain,
+        bytes32 _address
+    ) internal virtual {
         _routers.set(_domain, _address);
     }
 
@@ -141,11 +138,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the potential remote Application Router
      * @param _address The address of the potential remote Application Router
      */
-    function _isRemoteRouter(uint32 _domain, bytes32 _address)
-        internal
-        view
-        returns (bool)
-    {
+    function _isRemoteRouter(
+        uint32 _domain,
+        bytes32 _address
+    ) internal view returns (bool) {
         return routers(_domain) == _address;
     }
 
@@ -154,21 +150,17 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the chain for which to get the Application Router
      * @return _router The address of the remote Application Router on _domain
      */
-    function _mustHaveRemoteRouter(uint32 _domain)
-        internal
-        view
-        returns (bytes32)
-    {
+    function _mustHaveRemoteRouter(
+        uint32 _domain
+    ) internal view returns (bytes32) {
         (bool contained, bytes32 _router) = _routers.tryGet(_domain);
         require(contained, _domainNotFoundError(_domain));
         return _router;
     }
 
-    function _domainNotFoundError(uint32 _domain)
-        internal
-        pure
-        returns (string memory)
-    {
+    function _domainNotFoundError(
+        uint32 _domain
+    ) internal pure returns (string memory) {
         return
             string.concat(
                 "No router enrolled for domain: ",
@@ -176,11 +168,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
             );
     }
 
-    function _dispatch(uint32 _destinationDomain, bytes memory _messageBody)
-        internal
-        virtual
-        returns (bytes32)
-    {
+    function _dispatch(
+        uint32 _destinationDomain,
+        bytes memory _messageBody
+    ) internal virtual returns (bytes32) {
         return _dispatch(_destinationDomain, msg.value, _messageBody);
     }
 

package/contracts/hooks/OPStackHook.sol

@@ -59,22 +59,20 @@ contract OPStackHook is AbstractMessageIdAuthHook {
     }
 
     // ============ Internal functions ============
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        pure
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal pure override returns (uint256) {
         return 0; // gas subsidized by the L2
     }
 
     /// @inheritdoc AbstractMessageIdAuthHook
-    function _sendMessageId(bytes calldata metadata, bytes memory payload)
-        internal
-        override
-    {
+    function _sendMessageId(
+        bytes calldata metadata,
+        bytes memory payload
+    ) internal override {
         require(
-            metadata.msgValue(0) < 2**255,
+            metadata.msgValue(0) < 2 ** 255,
             "OPStackHook: msgValue must be less than 2 ** 255"
         );
         l1Messenger.sendMessage{value: metadata.msgValue(0)}(

package/contracts/hooks/PausableHook.sol

@@ -43,19 +43,16 @@ contract PausableHook is AbstractPostDispatchHook, Ownable, Pausable {
     // ============ Internal functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-        whenNotPaused
-    {}
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override whenNotPaused {}
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        pure
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal pure override returns (uint256) {
         return 0;
     }
 }

package/contracts/hooks/StaticProtocolFee.sol

@@ -91,10 +91,10 @@ contract StaticProtocolFee is AbstractPostDispatchHook, Ownable {
     // ============ Internal Functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         require(
             msg.value >= protocolFee,
             "StaticProtocolFee: insufficient protocol fee"
@@ -109,12 +109,10 @@ contract StaticProtocolFee is AbstractPostDispatchHook, Ownable {
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        view
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal view override returns (uint256) {
         return protocolFee;
     }
 

package/contracts/hooks/aggregation/ERC5164Hook.sol

@@ -45,12 +45,10 @@ contract ERC5164Hook is AbstractMessageIdAuthHook {
 
     // ============ Internal Functions ============
 
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        pure
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal pure override returns (uint256) {
         return 0; // EIP-5164 doesn't enforce a gas abstraction
     }
 

package/contracts/hooks/aggregation/StaticAggregationHook.sol

@@ -29,10 +29,10 @@ contract StaticAggregationHook is AbstractPostDispatchHook {
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         address[] memory _hooks = hooks(message);
         uint256 count = _hooks.length;
         for (uint256 i = 0; i < count; i++) {
@@ -49,12 +49,10 @@ contract StaticAggregationHook is AbstractPostDispatchHook {
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        view
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal view override returns (uint256) {
         address[] memory _hooks = hooks(message);
         uint256 count = _hooks.length;
         uint256 total = 0;

package/contracts/hooks/igp/InterchainGasPaymaster.sol

@@ -101,10 +101,10 @@ contract InterchainGasPaymaster is
      * @param _owner The owner of the contract.
      * @param _beneficiary The beneficiary.
      */
-    function initialize(address _owner, address _beneficiary)
-        public
-        initializer
-    {
+    function initialize(
+        address _owner,
+        address _beneficiary
+    ) public initializer {
         __Ownable_init();
         _transferOwnership(_owner);
         _setBeneficiary(_beneficiary);
@@ -124,10 +124,9 @@ contract InterchainGasPaymaster is
      * @notice Sets the gas oracles for remote domains specified in the config array.
      * @param _configs An array of configs including the remote domain and gas oracles to set.
      */
-    function setDestinationGasConfigs(GasParam[] calldata _configs)
-        external
-        onlyOwner
-    {
+    function setDestinationGasConfigs(
+        GasParam[] calldata _configs
+    ) external onlyOwner {
         uint256 _len = _configs.length;
         for (uint256 i = 0; i < _len; i++) {
             _setDestinationGasConfig(
@@ -192,13 +191,10 @@ contract InterchainGasPaymaster is
      * @param _gasLimit The amount of destination gas to pay for.
      * @return The amount of native tokens required to pay for interchain gas.
      */
-    function quoteGasPayment(uint32 _destinationDomain, uint256 _gasLimit)
-        public
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function quoteGasPayment(
+        uint32 _destinationDomain,
+        uint256 _gasLimit
+    ) public view virtual override returns (uint256) {
         // Get the gas data for the destination domain.
         (
             uint128 _tokenExchangeRate,
@@ -221,7 +217,9 @@ contract InterchainGasPaymaster is
      * @return tokenExchangeRate The exchange rate of the remote native token quoted in the local native token.
      * @return gasPrice The gas price on the remote chain.
      */
-    function getExchangeRateAndGasPrice(uint32 _destinationDomain)
+    function getExchangeRateAndGasPrice(
+        uint32 _destinationDomain
+    )
         public
         view
         override
@@ -250,11 +248,10 @@ contract InterchainGasPaymaster is
      * @param _gasLimit The amount of destination gas to pay for. This is only for application gas usage as
      *      the gas usage for the mailbox and the ISM is already accounted in the DomainGasConfig.gasOverhead
      */
-    function destinationGasLimit(uint32 _destinationDomain, uint256 _gasLimit)
-        public
-        view
-        returns (uint256)
-    {
+    function destinationGasLimit(
+        uint32 _destinationDomain,
+        uint256 _gasLimit
+    ) public view returns (uint256) {
         return
             uint256(destinationGasConfigs[_destinationDomain].gasOverhead) +
             _gasLimit;
@@ -263,10 +260,10 @@ contract InterchainGasPaymaster is
     // ============ Internal Functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         payForGas(
             message.id(),
             message.destination(),
@@ -279,12 +276,10 @@ contract InterchainGasPaymaster is
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        view
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal view override returns (uint256) {
         return
             quoteGasPayment(
                 message.destination(),

package/contracts/hooks/igp/StorageGasOracle.sol

@@ -46,7 +46,9 @@ contract StorageGasOracle is IGasOracle, Ownable {
      * @return tokenExchangeRate The exchange rate of the remote native token quoted in the local native token.
      * @return gasPrice The gas price on the remote chain.
      */
-    function getExchangeRateAndGasPrice(uint32 _destinationDomain)
+    function getExchangeRateAndGasPrice(
+        uint32 _destinationDomain
+    )
         external
         view
         override
@@ -63,10 +65,9 @@ contract StorageGasOracle is IGasOracle, Ownable {
      * @notice Sets the remote gas data for many remotes at a time.
      * @param _configs The configs to use when setting the remote gas data.
      */
-    function setRemoteGasDataConfigs(RemoteGasDataConfig[] calldata _configs)
-        external
-        onlyOwner
-    {
+    function setRemoteGasDataConfigs(
+        RemoteGasDataConfig[] calldata _configs
+    ) external onlyOwner {
         uint256 _len = _configs.length;
         for (uint256 i = 0; i < _len; i++) {
             _setRemoteGasData(_configs[i]);
@@ -77,10 +78,9 @@ contract StorageGasOracle is IGasOracle, Ownable {
      * @notice Sets the remote gas data using the values in `_config`.
      * @param _config The config to use when setting the remote gas data.
      */
-    function setRemoteGasData(RemoteGasDataConfig calldata _config)
-        external
-        onlyOwner
-    {
+    function setRemoteGasData(
+        RemoteGasDataConfig calldata _config
+    ) external onlyOwner {
         _setRemoteGasData(_config);
     }
 

package/contracts/hooks/libs/AbstractMessageIdAuthHook.sol

@@ -65,10 +65,10 @@ abstract contract AbstractMessageIdAuthHook is
     // ============ Internal functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         bytes32 id = message.id();
         require(
             _isLatestDispatched(id),
@@ -90,7 +90,8 @@ abstract contract AbstractMessageIdAuthHook is
      * @param metadata The metadata for the hook caller
      * @param payload The payload for call to the ISM
      */
-    function _sendMessageId(bytes calldata metadata, bytes memory payload)
-        internal
-        virtual;
+    function _sendMessageId(
+        bytes calldata metadata,
+        bytes memory payload
+    ) internal virtual;
 }

package/contracts/hooks/libs/AbstractPostDispatchHook.sol

@@ -27,24 +27,19 @@ abstract contract AbstractPostDispatchHook is IPostDispatchHook {
     // ============ External functions ============
 
     /// @inheritdoc IPostDispatchHook
-    function supportsMetadata(bytes calldata metadata)
-        public
-        pure
-        virtual
-        override
-        returns (bool)
-    {
+    function supportsMetadata(
+        bytes calldata metadata
+    ) public pure virtual override returns (bool) {
         return
             metadata.length == 0 ||
             metadata.variant() == StandardHookMetadata.VARIANT;
     }
 
     /// @inheritdoc IPostDispatchHook
-    function postDispatch(bytes calldata metadata, bytes calldata message)
-        external
-        payable
-        override
-    {
+    function postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) external payable override {
         require(
             supportsMetadata(metadata),
             "AbstractPostDispatchHook: invalid metadata variant"
@@ -53,12 +48,10 @@ abstract contract AbstractPostDispatchHook is IPostDispatchHook {
     }
 
     /// @inheritdoc IPostDispatchHook
-    function quoteDispatch(bytes calldata metadata, bytes calldata message)
-        public
-        view
-        override
-        returns (uint256)
-    {
+    function quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) public view override returns (uint256) {
         require(
             supportsMetadata(metadata),
             "AbstractPostDispatchHook: invalid metadata variant"
@@ -73,9 +66,10 @@ abstract contract AbstractPostDispatchHook is IPostDispatchHook {
      * @param metadata The metadata of the message being dispatched.
      * @param message The message being dispatched.
      */
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        virtual;
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal virtual;
 
     /**
      * @notice Quote dispatch hook implementation.
@@ -83,9 +77,8 @@ abstract contract AbstractPostDispatchHook is IPostDispatchHook {
      * @param message The message being dispatched.
      * @return The quote for the dispatch.
      */
-    function _quoteDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        view
-        virtual
-        returns (uint256);
+    function _quoteDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal view virtual returns (uint256);
 }