Skip to main content

MessageEnvelope

Struct MessageEnvelope 

Source
pub struct MessageEnvelope {
    pub sender: String,
    pub encrypted_header: String,
    pub ciphertext: String,
}
Expand description

A ready-to-publish encrypted message: the NIP-44-encrypted header and the double-ratcheted ciphertext, plus the sender DH pubkey the recipient uses to locate the chain.

Fields§

§sender: String

Sender’s current DH public key (x-only hex).

§encrypted_header: String

NIP-44 v2 encrypted, base64 Header JSON.

§ciphertext: String

Base64 NIP-44 v2 ciphertext of the message payload.

Implementations§

Source§

impl MessageEnvelope

Source

pub fn to_event<S: NostrSigner>( &self, signer: &S, created_at: i64, ) -> Result<NostrNote, Nip104Error>

Render this envelope as a signed kind-MESSAGE_EVENT_KIND Nostr event.

signer must be the sender’s current ephemeral keypair (its public key must equal self.sender); the reference implementation signs ratchet messages with that key, and the recipient locates the chain by the event’s pubkey.

§Errors

Returns Nip104Error::Signer if signing fails.

Source

pub fn from_event(event: &NostrNote) -> Result<Self, Nip104Error>

Parse and verify a kind-MESSAGE_EVENT_KIND Nostr event into an envelope. The event’s pubkey becomes the sender, its content the ciphertext, and the ["header", …] tag the encrypted header.

§Errors

Nip104Error::InvalidHeader if the kind is wrong, the signature is invalid, or the header tag is missing.

Trait Implementations§

Source§

impl Clone for MessageEnvelope

Source§

fn clone(&self) -> MessageEnvelope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageEnvelope

Source§

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

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

impl Eq for MessageEnvelope

Source§

impl PartialEq for MessageEnvelope

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MessageEnvelope

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, 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> 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, 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.