SecureMessage

Struct SecureMessage 

Source
pub struct SecureMessage {
    pub type: MessageType,
    pub payload: String,
}
Expand description

An encrypted message model defines a secure message that has been encrypted using the Sirius’s SDK libraries.

Please note: The strategy to encrypt and decrypt should be consistent between the different SDKs. A client may send a transaction using a different encryption strategy than the recipient. Even though the same encryption algorithm is used, the outcome may still be different depending on the encoding process.

The encryption strategy this SDK uses is UTF-8 and hex encodings: “plain text” string -> utf8 byte array -> encrypted byte array -> hex string

Fields§

§type: MessageType

Message type

§payload: String

Message payload.

Implementations§

Source§

impl SecureMessage

Source

pub fn create( sender_account: &Account, recipient_public_account: &PublicAccount, payload: &str, ) -> Result<Self>

Creates an encrypted message from [plainTextMessage].

The message is encrypted using a shared key generated by the [senderPrivateKey] and the [recipient_public_key]. The recipient can decrypt this message using this shared key by taking the sender’s public key and the recipient’s public key.

Source

pub fn from_hex_payload(payload: &str) -> Result<Self>

It creates a SecureMessage from the payload hex without the 01 prefix. The 01 prefix will be attached to the final payload.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

It creates a SecureMessage from the given bytes.

Source

pub fn decrypt( &self, recipient_account: &Account, sender_public_account: PublicAccount, ) -> Result<PlainMessage>

Decrypts an SecureMessage.

Returns a PlainMessage.

Trait Implementations§

Source§

impl Clone for SecureMessage

Source§

fn clone(&self) -> SecureMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecureMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SecureMessage

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for SecureMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Message for SecureMessage

Source§

fn message_type(&self) -> MessageType

Source§

fn payload(&self) -> String

Source§

fn box_clone(&self) -> Box<dyn Message + 'static>

Source§

fn payload_to_vec(&self) -> Vec<u8>

Source§

fn to_vec(&self) -> Vec<u8>

Source§

fn to_dto(&self) -> String

Source§

impl Serialize for SecureMessage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,