Struct sn_messaging::MsgEnvelope

pub struct MsgEnvelope {
    pub message: Message,
    pub origin: MsgSender,
    pub proxies: Vec<MsgSender>,
}

Message envelope containing a Safe message payload, sender, and the list of proxies the message could have been gone through with their signatures. This struct also provides utilities to obtain the serialised bytes ready to send them over the wire. The serialised bytes contain information about messaging protocol version, serialisation style used for the payload (e.g. Json), and/or any other information required by the receiving end to either deserialise it, or detect any incompatibility.

Fields

message: Message

The actual message payload

origin: MsgSender

The source of the message.

proxies: Vec<MsgSender>

Intermediate actors, so far, on the path of this message. Every new actor handling this message, would add itself here.

Implementations

impl MsgEnvelope

pub fn id(&self) -> MessageId

Gets the message ID.

pub fn verify(&self) -> Result<bool>

Verify the signature provided by the most recent sender is valid.

pub fn from(bytes: Bytes) -> Result<Self>

Deserialise a MsgEnvelope from bytes received over the wire.

pub fn serialise(&self) -> Result<Bytes>

Serialise this MsgEnvelope into bytes ready to be sent over the wire.

pub fn add_proxy(&mut self, proxy: MsgSender)

The proxy would first sign the MsgEnvelope, and then call this method to add itself (public key + the signature) to the envelope.

pub fn most_recent_sender(&self) -> &MsgSender

Return the most recent proxy this message passed through, or the sender if it didn't go through any proxy.

pub fn destination(&self) -> Result<Address>

Return the final destination address for this message.

Trait Implementations

impl Clone for MsgEnvelope

pub fn clone(&self) -> MsgEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MsgEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MsgEnvelope

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for MsgEnvelope

impl PartialEq<MsgEnvelope> for MsgEnvelope

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

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

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

This method tests for !=.

impl Serialize for MsgEnvelope

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

Serialize this value into the given Serde serializer.

impl StructuralEq for MsgEnvelope

impl StructuralPartialEq for MsgEnvelope