Struct Recipient

pub struct Recipient {
    pub address: AndrAddr,
    pub msg: Option<Binary>,
    pub ibc_recovery_address: Option<AndrAddr>,
}

A simple struct used for inter-contract communication. The struct can be used in two ways:

1. Simply just providing an AndrAddr which will treat the communication as a transfer of any related funds
2. Providing an AndrAddr and a Binary message which will be sent to the contract at the resolved address

The Binary message can be any message that the contract at the resolved address can handle.

Fields

address: AndrAddr

msg: Option<Binary>

ibc_recovery_address: Option<AndrAddr>

Implementations

impl Recipient

pub fn new(addr: impl Into<String>, msg: Option<Binary>) -> Recipient

pub fn validate(&self, deps: &Deps<'_>) -> Result<(), ContractError>

Validates a recipient by validating its address and recovery address (if it is provided)

pub fn from_string(addr: impl Into<String>) -> Recipient

Creates a Recipient from the given string with no attached message

pub fn get_addr(&self) -> String

pub fn get_message(&self) -> Option<Binary>

pub fn generate_direct_msg( &self, deps: &Deps<'_>, funds: Vec<Coin>, ) -> Result<SubMsg, ContractError>

Generates a direct sub message for the given recipient.

pub fn generate_msg_cw20( &self, deps: &Deps<'_>, cw20_coin: Cw20Coin, ) -> Result<SubMsg, ContractError>

Generates a message to send a CW20 token to the recipient with the attached message.

Assumes the attached message is a valid CW20 Hook message for the receiving address.

pub fn generate_amp_msg( &self, deps: &Deps<'_>, funds: Option<Vec<Coin>>, ) -> Result<AMPMsg, ContractError>

Generates an AMP message from the given Recipient.

This can be attached to an AMP Packet for execution via the aOS.

pub fn with_ibc_recovery(self, addr: impl Into<String>) -> Self

Adds an IBC recovery address to the recipient

This address can be used to recover any funds on failed IBC messages

pub fn with_msg(self, msg: impl Serialize) -> Self

Adds a message to the recipient to be sent alongside any funds

Trait Implementations

impl Clone for Recipient

fn clone(&self) -> Recipient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Recipient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recipient

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Recipient

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 Recipient

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Recipient