Enum IbcMsg

#[non_exhaustive]
pub enum IbcMsg {
    Transfer {
        channel_id: String,
        to_address: String,
        amount: Coin,
        timeout: IbcTimeout,
        memo: Option<String>,
    },
    SendPacket {
        channel_id: String,
        data: Binary,
        timeout: IbcTimeout,
    },
    WriteAcknowledgement {
        channel_id: String,
        packet_sequence: u64,
        ack: IbcAcknowledgement,
    },
    CloseChannel {
        channel_id: String,
    },
    PayPacketFee {
        port_id: String,
        channel_id: String,
        fee: IbcFee,
        relayers: Vec<String>,
    },
    PayPacketFeeAsync {
        port_id: String,
        channel_id: String,
        sequence: u64,
        fee: IbcFee,
        relayers: Vec<String>,
    },
}

These are messages in the IBC lifecycle. Only usable by IBC-enabled contracts (contracts that directly speak the IBC protocol via 6 entry points)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Transfer

Sends bank tokens owned by the contract to the given address on another chain. The channel must already be established between the ibctransfer module on this chain and a matching module on the remote chain. We cannot select the port_id, this is whatever the local chain has bound the ibctransfer module to.

Fields

channel_id: String

existing channel to send the tokens over

to_address: String

address on the remote chain to receive these tokens

amount: Coin

packet data only supports one coin https://github.com/cosmos/cosmos-sdk/blob/v0.40.0/proto/ibc/applications/transfer/v1/transfer.proto#L11-L20

timeout: IbcTimeout

when packet times out, measured on remote chain

memo: Option<String>

An optional memo. See the blog post “Moving Beyond Simple Token Transfers” for more information.

There is no difference between setting this to None or an empty string.

This field is only supported on chains with CosmWasm >= 2.0 and silently ignored on older chains. If you need support for both 1.x and 2.x chain with the same codebase, it is recommended to use CosmosMsg::Stargate with a custom MsgTransfer protobuf encoder instead.

SendPacket

Sends an IBC packet with given data over the existing channel. Data should be encoded in a format defined by the channel version, and the module on the other side should know how to parse this.

Fields

channel_id: String

data: Binary

timeout: IbcTimeout

when packet times out, measured on remote chain

WriteAcknowledgement

Acknowledges a packet that this contract received over IBC. This allows acknowledging a packet that was not acknowledged yet in the ibc_packet_receive call.

Fields

channel_id: String

Existing channel where the packet was received

packet_sequence: u64

Sequence number of the packet that was received

ack: IbcAcknowledgement

The acknowledgement to send back

CloseChannel

This will close an existing channel that is owned by this contract. Port is auto-assigned to the contract’s IBC port

Fields

channel_id: String

PayPacketFee

Incentivizes the next IBC packet sent after this message with a fee. Note that this does not necessarily have to be a packet sent by this contract. The fees are taken from the contract’s balance immediately and locked until the packet is handled.

Example

Most commonly, you will attach this message to a response right before sending a packet using IbcMsg::SendPacket or IbcMsg::Transfer.

let incentivize = IbcMsg::PayPacketFee {
    port_id: "transfer".to_string(),
    channel_id: "source-channel".to_string(),
    fee: IbcFee {
        receive_fee: coins(100, "token"),
        ack_fee: coins(201, "token"),
        timeout_fee: coins(200, "token"),
    },
    relayers: vec![],
};
let transfer = IbcMsg::Transfer {
    channel_id: "source-channel".to_string(),
    to_address: "receiver".to_string(),
    amount: Coin::new(100u32, "token"),
    timeout: IbcTimeout::with_timestamp(Timestamp::from_nanos(0)),
    memo: None,
};

let _: Response = Response::new()
    .add_message(CosmosMsg::Ibc(incentivize))
    .add_message(CosmosMsg::Ibc(transfer));

Fields

port_id: String

The port id on the chain where the packet is sent from (this chain).

channel_id: String

The channel id on the chain where the packet is sent from (this chain).

fee: IbcFee

relayers: Vec<String>

Allowlist of relayer addresses that can receive the fee. An empty list means that any relayer can receive the fee.

This is currently not implemented and must be empty.

PayPacketFeeAsync

Incentivizes the existing IBC packet with the given port, channel and sequence with a fee. Note that this does not necessarily have to be a packet sent by this contract. The fees are taken from the contract’s balance immediately and locked until the packet is handled. They are added to the existing fees on the packet.

Fields

port_id: String

The port id on the chain where the packet is sent from (this chain).

channel_id: String

The channel id on the chain where the packet is sent from (this chain).

sequence: u64

The sequence number of the packet that should be incentivized.

fee: IbcFee

relayers: Vec<String>

Allowlist of relayer addresses that can receive the fee. An empty list means that any relayer can receive the fee.

This is currently not implemented and must be empty.

Trait Implementations

impl Clone for IbcMsg

fn clone(&self) -> IbcMsg

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IbcMsg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IbcMsg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<IbcMsg> for CosmosMsg<T>

fn from(msg: IbcMsg) -> Self

Converts to this type from the input type.

impl JsonSchema for IbcMsg

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for IbcMsg

fn eq(&self, other: &IbcMsg) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IbcMsg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for IbcMsg

impl StructuralPartialEq for IbcMsg