Struct cosmwasm_std::IbcReceiveResponse

#[non_exhaustive]
pub struct IbcReceiveResponse<T = Empty> {
    pub acknowledgement: Option<Binary>,
    pub messages: Vec<SubMsg<T>>,
    pub attributes: Vec<Attribute>,
    pub events: Vec<Event>,
}

This defines the return value on packet response processing. This “success” case should be returned even in application-level errors, Where the acknowledgement bytes contain an encoded error message to be returned to the calling chain. (Returning ContractResult::Err will abort processing of this packet and not inform the calling chain).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

acknowledgement: Option<Binary>

The bytes we return to the contract that sent the packet. This may represent a success or error of execution. In case of None, no acknowledgement is written.

messages: Vec<SubMsg<T>>

Optional list of messages to pass. These will be executed in order. If the ReplyOn member is set, they will invoke this contract’s reply entry point after execution. Otherwise, they act like “fire and forget”. Use call or msg.into() to create messages with the older “fire and forget” semantics.

attributes: Vec<Attribute>

The attributes that will be emitted as part of a “wasm” event.

More info about events (and their attributes) can be found in Cosmos SDK docs.

events: Vec<Event>

Extra, custom events separate from the main wasm one. These will have wasm- prepended to the type.

More info about events can be found in Cosmos SDK docs.

Implementations

impl<T> IbcReceiveResponse<T>

pub fn new(ack: impl Into<Binary>) -> Self

Create a new response with the given acknowledgement.

Examples

use cosmwasm_std::{StdAck, IbcReceiveResponse};

// 0x01 is a FungibleTokenPacketSuccess from ICS-20.
let resp: IbcReceiveResponse = IbcReceiveResponse::new(StdAck::success(b"\x01"));
assert_eq!(resp.acknowledgement.unwrap(), b"{\"result\":\"AQ==\"}");

pub fn without_ack() -> Self

Creates a new response without an acknowledgement.

This allows you to send the acknowledgement asynchronously later using [IbcMsg::WriteAcknowledgement]. If you want to send the acknowledgement immediately, use IbcReceiveResponse::new.

pub fn add_attribute( self, key: impl Into<String>, value: impl Into<String> ) -> Self

Add an attribute included in the main wasm event.

pub fn add_message(self, msg: impl Into<CosmosMsg<T>>) -> Self

This creates a “fire and forget” message, by using SubMsg::new() to wrap it, and adds it to the list of messages to process.

pub fn add_submessage(self, msg: SubMsg<T>) -> Self

This takes an explicit SubMsg (creates via e.g. reply_on_error) and adds it to the list of messages to process.

pub fn add_event(self, event: Event) -> Self

Adds an extra event to the response, separate from the main wasm event that is always created.

The wasm- prefix will be appended by the runtime to the provided type of event.

pub fn add_attributes<A: Into<Attribute>>( self, attrs: impl IntoIterator<Item = A> ) -> Self

Bulk add attributes included in the main wasm event.

Anything that can be turned into an iterator and yields something that can be converted into an Attribute is accepted.

Examples

use cosmwasm_std::{attr, IbcReceiveResponse, StdAck};

let attrs = vec![
    ("action", "reaction"),
    ("answer", "42"),
    ("another", "attribute"),
];
let res: IbcReceiveResponse = IbcReceiveResponse::new(StdAck::success(b"\x01")).add_attributes(attrs.clone());
assert_eq!(res.attributes, attrs);

pub fn add_messages<M: Into<CosmosMsg<T>>>( self, msgs: impl IntoIterator<Item = M> ) -> Self

Bulk add “fire and forget” messages to the list of messages to process.

Examples

use cosmwasm_std::{CosmosMsg, IbcReceiveResponse, StdAck};

fn make_response_with_msgs(msgs: Vec<CosmosMsg>) -> IbcReceiveResponse {
    IbcReceiveResponse::new(StdAck::success(b"\x01")).add_messages(msgs)
}

pub fn add_submessages(self, msgs: impl IntoIterator<Item = SubMsg<T>>) -> Self

Bulk add explicit SubMsg structs to the list of messages to process.

Examples

use cosmwasm_std::{SubMsg, StdAck, IbcReceiveResponse};

fn make_response_with_submsgs(msgs: Vec<SubMsg>) -> IbcReceiveResponse {
    IbcReceiveResponse::new(StdAck::success(b"\x01")).add_submessages(msgs)
}

pub fn add_events(self, events: impl IntoIterator<Item = Event>) -> Self

Bulk add custom events to the response. These are separate from the main wasm event.

The wasm- prefix will be appended by the runtime to the provided types of events.

Trait Implementations

impl<T: Clone> Clone for IbcReceiveResponse<T>

fn clone(&self) -> IbcReceiveResponse<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IbcReceiveResponse<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for IbcReceiveResponse<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: JsonSchema> JsonSchema for IbcReceiveResponse<T>

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(gen: &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<T: PartialEq> PartialEq for IbcReceiveResponse<T>

fn eq(&self, other: &IbcReceiveResponse<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for IbcReceiveResponse<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for IbcReceiveResponse<T>

impl<T> StructuralPartialEq for IbcReceiveResponse<T>