Struct IbcDestinationCallbackMsg

pub struct IbcDestinationCallbackMsg {
    pub packet: IbcPacket,
    pub ack: IbcAcknowledgement,
    pub transfer: Option<IbcTransferCallback>,
}

The message type of the IBC destination callback.

The IBC destination callback is needed for cases where someone triggers the sending of an IBC packet through some other message (i.e. not through crate::IbcMsg::SendPacket) and your contract needs to know that it received this. A prominent example is the crate::IbcMsg::Transfer message. Without callbacks, you cannot know that someone sent you IBC coins.

It is important to validate that the packet and acknowledgement are what you expect them to be. For example for a transfer message, the receiver is not necessarily the contract itself.

The callback is called when the packet is being acknowledged on the destination chain. This happens for both synchronous and asynchronous acknowledgements.

Note that there are some prerequisites that need to be fulfilled to receive destination callbacks:

• The contract must implement the ibc_destination_callback entrypoint.
• The IBC application in the destination chain must have support for the callbacks middleware.
• You have to add serialized IbcCallbackRequest to a specific field of the message. For IbcMsg::Transfer, this is the memo field and it needs to be json-encoded.

Fields

packet: IbcPacket

ack: IbcAcknowledgement

transfer: Option<IbcTransferCallback>

When the underlying packet is a successful transfer message, this field contains information about the transfer. Otherwise it is empty.

This is always empty on chains using CosmWasm < 3.0

Trait Implementations

impl Clone for IbcDestinationCallbackMsg

fn clone(&self) -> IbcDestinationCallbackMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IbcDestinationCallbackMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IbcDestinationCallbackMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for IbcDestinationCallbackMsg

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 IbcDestinationCallbackMsg

fn eq(&self, other: &IbcDestinationCallbackMsg) -> 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 Schemaifier for IbcDestinationCallbackMsg

fn visit_schema(visitor: &mut SchemaVisitor) -> DefinitionReference

fn id() -> Identifier

impl Serialize for IbcDestinationCallbackMsg

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 IbcDestinationCallbackMsg

impl StructuralPartialEq for IbcDestinationCallbackMsg