IGateway.sol

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: 2023 Snowfork <hello@snowfork.com>
pragma solidity 0.8.25;

import {MultiAddress} from "../MultiAddress.sol";
import {OperatingMode, InboundMessage} from "./Types.sol";
import {Verification} from "../Verification.sol";
import {UD60x18} from "prb/math/src/UD60x18.sol";

interface IGatewayV2 {
    error InvalidAsset();
    error InvalidFee();
    error InvalidEtherValue();

    function operatingMode() external view returns (OperatingMode);

    function agentOf(bytes32 agentID) external view returns (address);

    /**
     * Events
     */

    // V2: Emitted when inbound message has been dispatched
    event InboundMessageDispatched(
        uint64 indexed nonce, bool success, bytes32 indexed rewardAddress
    );

    // v2 Emitted when an outbound message has been accepted for delivery to a Polkadot parachain
    event OutboundMessageAccepted(uint64 nonce, uint256 reward, bytes payload);

    // V2

    // Submit a message for verification and dispatch
    function v2_submit(
        InboundMessage calldata message,
        bytes32[] calldata leafProof,
        Verification.Proof calldata headerProof,
        bytes32 rewardAddress
    ) external;

    // Send an XCM with arbitrary assets to Polkadot Asset Hub
    //
    // Params:
    //   * `xcm` (bytes): SCALE-encoded VersionedXcm message
    //   * `assets` (bytes[]): Array of asset specs, constrained to maximum of eight.
    //
    // Supported asset specs:
    // * Ether: abi.encode(0, value)
    // * ERC20: abi.encode(1, tokenAddress, value)
    //
    // On Asset Hub, the assets will be received into the assets holding register.
    //
    // The `xcm` should contain the necessary instructions to:
    // 1. Pay XCM execution fees for `xcm`, either from assets in holding,
    //    or from the sovereign account of `msg.sender`.
    // 2. Handle the assets in holding, either depositing them into
    //    some account, or forwarding them to another destination.
    //
    // To incentivize message delivery, some amount of ether must be passed and should
    // at least cover the total cost of delivery to Polkadot. This ether be sent across
    // the bridge as WETH, and given to the relayer as compensation and incentivization.
    //
    function v2_sendMessage(
        bytes calldata xcm,
        bytes[] calldata assets,
        bytes calldata claimer
    ) external payable;

    // Register Ethereum-native token on AHP, using `xcmFeeAHP` of `msg.value`
    // to pay for execution on AHP.
    function v2_registerToken(address token, uint128 xcmFeeAHP) external payable;

    // Register Ethereum-native token on AHK, using `xcmFeeAHP` and `xcmFeeAHK`
    // of `msg.value` to pay for execution on AHP and AHK respectively.
    function v2_registerTokenOnKusama(
        address token,
        uint128 xcmFeeAHP,
        uint128 xcmFeeAHK
    ) external payable;

    // Check if an inbound message was previously accepted and dispatched
    function v2_isDispatched(uint64 nonce) external view returns (bool);

    /// @dev Check whether a token is registered
    function isTokenRegistered(address token) external view returns (bool);
}