Struct AMPPkt

pub struct AMPPkt {
    pub messages: Vec<AMPMsg>,
    pub ctx: AMPCtx,
}

An Andromeda packet contains all message protocol related data, this is what is sent between ADOs when communicating It contains an original sender, if used for authorisation the sender must be authorised The previous sender is the one who sent the message A packet may contain several messages which allows for message batching

Fields

messages: Vec<AMPMsg>

Any messages associated with the packet

ctx: AMPCtx

Implementations

impl AMPPkt

pub fn new( origin: impl Into<String>, previous_sender: impl Into<String>, messages: Vec<AMPMsg>, ) -> AMPPkt

Creates a new AMP Packet

pub fn add_message(self, message: AMPMsg) -> Self

Adds a message to the current AMP Packet

pub fn get_unique_recipients(&self) -> Vec<String>

Gets all unique recipients for messages

pub fn get_messages_for_recipient(&self, recipient: String) -> Vec<AMPMsg>

Gets all messages for a given recipient

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

Used to verify that the sender of the AMPPkt is authorised to attach the given origin field. A sender is valid if:

1. The origin matches the sender
2. The sender is the kernel
3. The sender has a code ID stored within the ADODB (and as such is a valid ADO)

If the sender is not valid, an error is returned

pub fn get_verified_origin( &self, info: &MessageInfo, deps: &Deps<'_>, ) -> Result<String, ContractError>

Verifies the origin of the AMPPkt and returns the origin if it is valid

pub fn to_sub_msg( &self, address: impl Into<String>, funds: Option<Vec<Coin>>, id: u64, ) -> Result<SubMsg, ContractError>

Generates a SubMsg to send the AMPPkt to the kernel

pub fn with_id(&self, id: u64) -> AMPPkt

Attaches an ID to the current packet

pub fn to_ibc_hooks_memo( &self, contract_addr: String, callback_addr: String, ) -> String

Converts a given AMP Packet to an IBC Hook memo for use with Osmosis’ IBC Hooks module

pub fn to_json(&self) -> String

Serializes the given AMP Packet to a JSON string

pub fn from_ctx(ctx: Option<AMPPkt>, current_address: String) -> Self

Generates an AMP Packet from context

Trait Implementations

impl Clone for AMPPkt

fn clone(&self) -> AMPPkt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AMPPkt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AMPPkt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AMPPkt

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 AMPPkt

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

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 AMPPkt