Contract reference

// Creates a ticket for a message from `channel`. The channel's ID is the source address.
public fun prepare_message(
    channel: &Channel,
    destination_chain: String,
    destination_address: String,
    payload: vector<u8>,
): MessageTicket;

// Sends the message: emits `ContractCall`.
public fun send_message(self: &Gateway, message: MessageTicket);

// Marks an approved message executed and returns it, for the destination channel to consume.
// Aborts if the message isn't approved. Relayers call it.
public fun take_approved_message(
    self: &mut Gateway,
    source_chain: String,
    message_id: String,
    source_address: String,
    destination_id: address,
    payload: vector<u8>,
): ApprovedMessage;

public fun is_message_approved(
    self: &Gateway,
    source_chain: String,
    message_id: String,
    source_address: String,
    destination_id: address,
    payload_hash: Bytes32,
): bool;

public fun is_message_executed(self: &Gateway, source_chain: String, message_id: String): bool;

public struct Channel has key, store {
    id: UID,
}

public fun new(ctx: &mut TxContext): Channel; // emits ChannelCreated
public fun destroy(self: Channel); // emits ChannelDestroyed
public fun id(self: &Channel): ID;
public fun to_address(self: &Channel): address;

// Aborts with EInvalidDestination unless the message is addressed to `channel`.
// Returns (source_chain, message_id, source_address, payload).
public fun consume_approved_message(
    channel: &Channel,
    approved_message: ApprovedMessage,
): (String, String, String, vector<u8>);

// No abilities: must be consumed in the transaction that takes it
public struct ApprovedMessage {
    source_chain: String,
    message_id: String,
    source_address: String, // in the source chain's format, e.g. 0x… for EVM
    destination_id: address, // the destination channel's ID
    payload: vector<u8>,
}

public struct MessageTicket {
    source_id: address, // the sending channel
    destination_chain: String,
    destination_address: String,
    payload: vector<u8>,
    version: u64, // gateway version that created it
}

// Pays gas for the ticket's message, before `send_message`.
// Any refund goes to `refund_address`. Pass empty `params`.
public fun pay_gas<T>(
    self: &mut GasService,
    message_ticket: &MessageTicket,
    coin: Coin<T>,
    refund_address: address,
    params: vector<u8>,
);

// Adds gas to a message that was already sent.
public fun add_gas<T>(
    self: &mut GasService,
    coin: Coin<T>,
    message_id: String,
    refund_address: address,
    params: vector<u8>,
);

// Sets the transaction for `channel`, replacing any previous one.
public fun register_transaction(self: &mut RelayerDiscovery, channel: &Channel, tx: Transaction);
public fun remove_transaction(self: &mut RelayerDiscovery, channel: &Channel);
public fun get_transaction(self: &RelayerDiscovery, channel_id: ID): Transaction;

public fun new_function(package_id: address, module_name: String, name: String): Function;
public fun new_move_call(
    function: Function,
    arguments: vector<vector<u8>>,
    type_arguments: vector<String>,
): MoveCall;
public fun new_transaction(is_final: bool, move_calls: vector<MoveCall>): Transaction;

// ID of the package that first defined `T`
public fun package_id<T>(): address;