@hyperlane-xyz/core 1.5.6-beta0 → 1.5.8

package/contracts/hooks/libs/AbstractPostDispatchHook.sol

@@ -1,91 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-// ============ Internal Imports ============
-import {StandardHookMetadata} from "./StandardHookMetadata.sol";
-import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
-
-/**
- * @title AbstractPostDispatch
- * @notice Abstract post dispatch hook supporting the current global hook metadata variant.
- */
-abstract contract AbstractPostDispatchHook is IPostDispatchHook {
-    using StandardHookMetadata for bytes;
-
-    // ============ External functions ============
-
-    /// @inheritdoc IPostDispatchHook
-    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
-    {
-        require(
-            supportsMetadata(metadata),
-            "AbstractPostDispatchHook: invalid metadata variant"
-        );
-        _postDispatch(metadata, message);
-    }
-
-    /// @inheritdoc IPostDispatchHook
-    function quoteDispatch(bytes calldata metadata, bytes calldata message)
-        public
-        view
-        override
-        returns (uint256)
-    {
-        require(
-            supportsMetadata(metadata),
-            "AbstractPostDispatchHook: invalid metadata variant"
-        );
-        return _quoteDispatch(metadata, message);
-    }
-
-    // ============ Internal functions ============
-
-    /**
-     * @notice Post dispatch hook implementation.
-     * @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;
-
-    /**
-     * @notice Quote dispatch hook implementation.
-     * @param metadata The metadata of the message being dispatched.
-     * @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);
-}

package/contracts/hooks/libs/StandardHookMetadata.sol

@@ -1,160 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-/**
- * Format of metadata:
- *
- * [0:1] variant
- * [2:33] msg.value
- * [34:65] Gas limit for message (IGP)
- * [66:85] Refund address for message (IGP)
- * [86:] Custom metadata
- */
-library StandardHookMetadata {
-    uint8 private constant VARIANT_OFFSET = 0;
-    uint8 private constant MSG_VALUE_OFFSET = 2;
-    uint8 private constant GAS_LIMIT_OFFSET = 34;
-    uint8 private constant REFUND_ADDRESS_OFFSET = 66;
-    uint256 private constant MIN_METADATA_LENGTH = 86;
-
-    uint16 public constant VARIANT = 1;
-
-    /**
-     * @notice Returns the variant of the metadata.
-     * @param _metadata ABI encoded global hook metadata.
-     * @return variant of the metadata as uint8.
-     */
-    function variant(bytes calldata _metadata) internal pure returns (uint16) {
-        if (_metadata.length < VARIANT_OFFSET + 2) return 0;
-        return uint16(bytes2(_metadata[VARIANT_OFFSET:VARIANT_OFFSET + 2]));
-    }
-
-    /**
-     * @notice Returns the specified value for the message.
-     * @param _metadata ABI encoded global hook metadata.
-     * @param _default Default fallback value.
-     * @return Value for the message as 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]));
-    }
-
-    /**
-     * @notice Returns the specified gas limit for the message.
-     * @param _metadata ABI encoded global hook metadata.
-     * @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)
-    {
-        if (_metadata.length < GAS_LIMIT_OFFSET + 32) return _default;
-        return
-            uint256(bytes32(_metadata[GAS_LIMIT_OFFSET:GAS_LIMIT_OFFSET + 32]));
-    }
-
-    /**
-     * @notice Returns the specified refund address for the message.
-     * @param _metadata ABI encoded global hook metadata.
-     * @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)
-    {
-        if (_metadata.length < REFUND_ADDRESS_OFFSET + 20) return _default;
-        return
-            address(
-                bytes20(
-                    _metadata[REFUND_ADDRESS_OFFSET:REFUND_ADDRESS_OFFSET + 20]
-                )
-            );
-    }
-
-    /**
-     * @notice Returns the specified refund address for the message.
-     * @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)
-    {
-        if (_metadata.length < MIN_METADATA_LENGTH) return _metadata[0:0];
-        return _metadata[MIN_METADATA_LENGTH:];
-    }
-
-    /**
-     * @notice Formats the specified gas limit and refund address into global hook metadata.
-     * @param _msgValue msg.value for the message.
-     * @param _gasLimit Gas limit for the message.
-     * @param _refundAddress Refund address for the message.
-     * @param _customMetadata Additional metadata to include in the global hook metadata.
-     * @return ABI encoded global hook metadata.
-     */
-    function formatMetadata(
-        uint256 _msgValue,
-        uint256 _gasLimit,
-        address _refundAddress,
-        bytes memory _customMetadata
-    ) internal pure returns (bytes memory) {
-        return
-            abi.encodePacked(
-                VARIANT,
-                _msgValue,
-                _gasLimit,
-                _refundAddress,
-                _customMetadata
-            );
-    }
-
-    /**
-     * @notice Formats the specified gas limit and refund address into global hook metadata.
-     * @param _msgValue msg.value for the message.
-     * @return ABI encoded global hook metadata.
-     */
-    function formatMetadata(uint256 _msgValue)
-        internal
-        view
-        returns (bytes memory)
-    {
-        return formatMetadata(_msgValue, uint256(0), msg.sender, "");
-    }
-
-    /**
-     * @notice Formats the specified gas limit and refund address into global hook metadata.
-     * @param _gasLimit Gas limit for the message.
-     * @param _refundAddress Refund address for the message.
-     * @return ABI encoded global hook metadata.
-     */
-    function formatMetadata(uint256 _gasLimit, address _refundAddress)
-        internal
-        pure
-        returns (bytes memory)
-    {
-        return formatMetadata(uint256(0), _gasLimit, _refundAddress, "");
-    }
-}

package/contracts/hooks/routing/DestinationRecipientRoutingHook.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-import {Message} from "../../libs/Message.sol";
-import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
-import {DomainRoutingHook} from "./DomainRoutingHook.sol";
-
-contract DestinationRecipientRoutingHook is DomainRoutingHook {
-    using Message for bytes;
-
-    /// @notice destination => recipient =>custom hook
-    mapping(uint32 => mapping(bytes32 => address)) public customHooks;
-
-    constructor(address mailbox, address owner)
-        DomainRoutingHook(mailbox, owner)
-    {}
-
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
-        address customHookPreset = customHooks[message.destination()][
-            message.recipient()
-        ];
-        if (customHookPreset != address(0)) {
-            IPostDispatchHook(customHookPreset).postDispatch{value: msg.value}(
-                metadata,
-                message
-            );
-        } else {
-            super._postDispatch(metadata, message);
-        }
-    }
-
-    function configCustomHook(
-        uint32 destinationDomain,
-        bytes32 recipient,
-        address hook
-    ) external onlyOwner {
-        customHooks[destinationDomain][recipient] = hook;
-    }
-}

package/contracts/hooks/routing/DomainRoutingHook.sol

@@ -1,106 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-// ============ Internal Imports ============
-import {StandardHookMetadata} from "../libs/StandardHookMetadata.sol";
-import {AbstractPostDispatchHook} from "../libs/AbstractPostDispatchHook.sol";
-import {MailboxClient} from "../../client/MailboxClient.sol";
-import {Message} from "../../libs/Message.sol";
-import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
-
-// ============ External Imports ============
-import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
-
-/**
- * @title DomainRoutingHook
- * @notice Delegates to a hook based on the destination domain of the message.
- */
-contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
-    using Strings for uint32;
-    using Message for bytes;
-
-    struct HookConfig {
-        uint32 destination;
-        address hook;
-    }
-
-    mapping(uint32 => IPostDispatchHook) public hooks;
-
-    constructor(address _mailbox, address _owner) MailboxClient(_mailbox) {
-        _transferOwnership(_owner);
-    }
-
-    function setHook(uint32 destination, address hook) public onlyOwner {
-        hooks[destination] = IPostDispatchHook(hook);
-    }
-
-    function setHooks(HookConfig[] calldata configs) external onlyOwner {
-        for (uint256 i = 0; i < configs.length; i++) {
-            setHook(configs[i].destination, configs[i].hook);
-        }
-    }
-
-    function supportsMetadata(bytes calldata)
-        public
-        pure
-        virtual
-        override
-        returns (bool)
-    {
-        // routing hook does not care about metadata shape
-        return true;
-    }
-
-    // ============ Internal Functions ============
-
-    /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        virtual
-        override
-    {
-        _getConfiguredHook(message).postDispatch{value: msg.value}(
-            metadata,
-            message
-        );
-    }
-
-    /// @inheritdoc AbstractPostDispatchHook
-    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)
-    {
-        hook = hooks[message.destination()];
-        require(
-            address(hook) != address(0),
-            string.concat(
-                "No hook configured for destination: ",
-                message.destination().toString()
-            )
-        );
-    }
-}

package/contracts/hooks/routing/FallbackDomainRoutingHook.sol

@@ -1,52 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
-import {IMailbox} from "../../interfaces/IMailbox.sol";
-import {DomainRoutingHook} from "./DomainRoutingHook.sol";
-import {Message} from "../../libs/Message.sol";
-
-/**
- * @title FallbackDomainRoutingHook
- * @notice Delegates to a hook based on the destination domain of the message.
- * If no hook is configured for the destination domain, delegates to a fallback hook.
- */
-contract FallbackDomainRoutingHook is DomainRoutingHook {
-    using Message for bytes;
-
-    IPostDispatchHook public immutable fallbackHook;
-
-    constructor(
-        address _mailbox,
-        address _owner,
-        address _fallback
-    ) DomainRoutingHook(_mailbox, _owner) {
-        fallbackHook = IPostDispatchHook(_fallback);
-    }
-
-    // ============ Internal Functions ============
-
-    function _getConfiguredHook(bytes calldata message)
-        internal
-        view
-        override
-        returns (IPostDispatchHook hook)
-    {
-        hook = hooks[message.destination()];
-        if (address(hook) == address(0)) {
-            hook = fallbackHook;
-        }
-    }
-}

package/contracts/interfaces/hooks/IPostDispatchHook.sol

@@ -1,46 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-interface IPostDispatchHook {
-    /**
-     * @notice Returns whether the hook supports metadata
-     * @param metadata metadata
-     * @return Whether the hook supports metadata
-     */
-    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;
-
-    /**
-     * @notice Compute the payment required by the postDispatch call
-     * @param metadata The metadata required for the hook
-     * @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);
-}

package/contracts/interfaces/optimism/ICrossDomainMessenger.sol

@@ -1,39 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.0;
-
-/**
- * @title ICrossDomainMessenger interface for bedrock update
- * @dev eth-optimism's version uses strict 0.8.15 which we don't want to restrict to
- */
-interface ICrossDomainMessenger {
-    /**
-     * Sends a cross domain message to the target messenger.
-     * @param _target Target contract address.
-     * @param _message Message to send to the target.
-     * @param _gasLimit Gas limit for the provided message.
-     */
-    function sendMessage(
-        address _target,
-        bytes calldata _message,
-        uint32 _gasLimit
-    ) external payable;
-
-    function relayMessage(
-        uint256 _nonce,
-        address _sender,
-        address _target,
-        uint256 _value,
-        uint256 _minGasLimit,
-        bytes calldata _message
-    ) external payable;
-
-    /*************
-     * Variables *
-     *************/
-
-    function xDomainMessageSender() external view returns (address);
-}
-
-interface IL2CrossDomainMessenger is ICrossDomainMessenger {
-    function messageNonce() external view returns (uint256);
-}

package/contracts/isms/NoopIsm.sol

@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
-
-contract NoopIsm is IInterchainSecurityModule {
-    uint8 public constant override moduleType = uint8(Types.NULL);
-
-    function verify(bytes calldata, bytes calldata)
-        public
-        pure
-        override
-        returns (bool)
-    {
-        return true;
-    }
-}

package/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

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