hyperlane-monorepo/solidity/contracts/hooks/OPL2ToL1Hook.sol

// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity >=0.8.0;

/*@@@@@@@       @@@@@@@@@
 @@@@@@@@@       @@@@@@@@@
  @@@@@@@@@       @@@@@@@@@
   @@@@@@@@@       @@@@@@@@@
    @@@@@@@@@@@@@@@@@@@@@@@@@
     @@@@@  HYPERLANE  @@@@@@@
    @@@@@@@@@@@@@@@@@@@@@@@@@
   @@@@@@@@@       @@@@@@@@@
  @@@@@@@@@       @@@@@@@@@
 @@@@@@@@@       @@@@@@@@@
@@@@@@@@@       @@@@@@@@*/

// ============ Internal Imports ============
import {Message} from "../libs/Message.sol";
import {AbstractPostDispatchHook, AbstractMessageIdAuthHook} from "./libs/AbstractMessageIdAuthHook.sol";
import {AbstractMessageIdAuthorizedIsm} from "../isms/hook/AbstractMessageIdAuthorizedIsm.sol";
import {StandardHookMetadata} from "./libs/StandardHookMetadata.sol";
import {TypeCasts} from "../libs/TypeCasts.sol";
import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
import {InterchainGasPaymaster} from "./igp/InterchainGasPaymaster.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;
    using Message for bytes;

    // ============ Constants ============

    // precompile contract on L2 for sending messages to L1
    ICrossDomainMessenger public immutable l2Messenger;
    // child hook to call first
    IPostDispatchHook public immutable childHook;
    // Minimum gas limit that the message can be executed with - OP specific
    uint32 public constant MIN_GAS_LIMIT = 300_000;

    // ============ Constructor ============

    constructor(
        address _mailbox,
        uint32 _destinationDomain,
        bytes32 _ism,
        address _l2Messenger,
        address _childHook
    ) AbstractMessageIdAuthHook(_mailbox, _destinationDomain, _ism) {
        l2Messenger = ICrossDomainMessenger(_l2Messenger);
        childHook = AbstractPostDispatchHook(_childHook);
    }

    /// @inheritdoc IPostDispatchHook
    function hookType() external pure override returns (uint8) {
        return uint8(IPostDispatchHook.Types.OP_L2_TO_L1);
    }

    /// @inheritdoc AbstractPostDispatchHook
    function _quoteDispatch(
        bytes calldata metadata,
        bytes calldata message
    ) internal view override returns (uint256) {
        return
            metadata.msgValue(0) + childHook.quoteDispatch(metadata, message);
    }

    // ============ Internal functions ============

    /// @inheritdoc AbstractMessageIdAuthHook
    function _sendMessageId(
        bytes calldata metadata,
        bytes calldata message
    ) internal override {
        bytes memory payload = abi.encodeCall(
            AbstractMessageIdAuthorizedIsm.preVerifyMessage,
            (message.id(), metadata.msgValue(0))
        );

        childHook.postDispatch{
            value: childHook.quoteDispatch(metadata, message)
        }(metadata, message);
        l2Messenger.sendMessage{value: metadata.msgValue(0)}(
            TypeCasts.bytes32ToAddress(ism),
            payload,
            MIN_GAS_LIMIT
        );
    }
}