Struct BlindedPath

pub struct BlindedPath {
    pub introduction_node_id: PublicKey,
    pub blinding_point: PublicKey,
    pub blinded_hops: Vec<BlindedHop>,
}

Onion messages and payments can be sent and received to blinded paths, which serve to hide the identity of the recipient.

Fields

introduction_node_id: PublicKey

To send to a blinded path, the sender first finds a route to the unblinded introduction_node_id, which can unblind its encrypted_payload to find out the onion message or payment’s next hop and forward it along.

blinding_point: PublicKey

Used by the introduction node to decrypt its encrypted_payload to forward the onion message or payment.

blinded_hops: Vec<BlindedHop>

The hops composing the blinded path.

Implementations

impl BlindedPath

pub fn one_hop_for_message<ES, T>( recipient_node_id: PublicKey, entropy_source: &ES, secp_ctx: &Secp256k1<T>, ) -> Result<BlindedPath, ()>

where ES: EntropySource + ?Sized, T: Signing + Verification,

Create a one-hop blinded path for a message.

pub fn new_for_message<ES, T>( node_pks: &[PublicKey], entropy_source: &ES, secp_ctx: &Secp256k1<T>, ) -> Result<BlindedPath, ()>

where ES: EntropySource + ?Sized, T: Signing + Verification,

Create a blinded 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 one_hop_for_payment<ES, T>( payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs, entropy_source: &ES, secp_ctx: &Secp256k1<T>, ) -> Result<(BlindedPayInfo, BlindedPath), ()>

where ES: EntropySource + ?Sized, T: Signing + Verification,

Create a one-hop blinded path for a payment.

Trait Implementations

impl Clone for BlindedPath

fn clone(&self) -> BlindedPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlindedPath

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

Formats the value using the given formatter.

impl Hash for BlindedPath

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

where __H: Hasher,

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 BlindedPath

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

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for BlindedPath

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

where W: Writer,

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 BlindedPath

impl StructuralPartialEq for BlindedPath