Struct BlindedMessagePath

pub struct BlindedMessagePath(/* private fields */);

A blinded path to be used for sending or receiving a message, hiding the identity of the recipient.

Implementations

impl BlindedMessagePath

pub fn one_hop<ES: Deref, T: Signing + Verification>( recipient_node_id: PublicKey, context: MessageContext, entropy_source: ES, secp_ctx: &Secp256k1<T>, ) -> Result<Self, ()>

where ES::Target: EntropySource,

Create a one-hop blinded path for a message.

pub fn new<ES: Deref, T: Signing + Verification>( intermediate_nodes: &[MessageForwardNode], recipient_node_id: PublicKey, context: MessageContext, entropy_source: ES, secp_ctx: &Secp256k1<T>, ) -> Result<Self, ()>

where ES::Target: EntropySource,

Create a path for an onion message, to be forwarded along node_pks. The last node pubkey in node_pks will be the destination node.

Errors if no hops are provided or if node_pk(s) are invalid.

pub fn use_compact_introduction_node( &mut self, network_graph: &ReadOnlyNetworkGraph<'_>, )

Attempts to a use a compact representation for the IntroductionNode by using a directed short channel id from a channel in network_graph leading to the introduction node.

While this may result in a smaller encoding, there is a trade off in that the path may become invalid if the channel is closed or hasn’t been propagated via gossip. Therefore, calling this may not be suitable for long-lived blinded paths.

pub fn public_introduction_node_id<'a>( &self, network_graph: &'a ReadOnlyNetworkGraph<'_>, ) -> Option<&'a NodeId>

Returns the introduction NodeId of the blinded path, if it is publicly reachable (i.e., it is found in the network graph).

pub fn introduction_node(&self) -> &IntroductionNode

The IntroductionNode of the blinded path.

pub fn blinding_point(&self) -> PublicKey

Used by the IntroductionNode to decrypt its encrypted_payload to forward the message.

pub fn blinded_hops(&self) -> &[BlindedHop]

The BlindedHops within the blinded path.

pub fn advance_path_by_one<NS: Deref, NL: Deref, T>( &mut self, node_signer: &NS, node_id_lookup: &NL, secp_ctx: &Secp256k1<T>, ) -> Result<(), ()>

where NS::Target: NodeSigner, NL::Target: NodeIdLookUp, T: Signing + Verification,

Advance the blinded onion message path by one hop, making the second hop into the new introduction node.

Will only modify self when returning Ok.

Trait Implementations

impl Clone for BlindedMessagePath

fn clone(&self) -> BlindedMessagePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlindedMessagePath

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

Formats the value using the given formatter.

impl Hash for BlindedMessagePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BlindedMessagePath

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

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for BlindedMessagePath

fn write<W: Writer>(&self, w: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for BlindedMessagePath

impl StructuralPartialEq for BlindedMessagePath