Struct BlindedPaymentPath

pub struct BlindedPaymentPath {
    pub payinfo: BlindedPayInfo,
    /* private fields */
}

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

Fields

payinfo: BlindedPayInfo

The BlindedPayInfo used to pay this blinded path.

Implementations

impl BlindedPaymentPath

pub fn one_hop<ES: Deref, T: Signing + Verification>( payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs, min_final_cltv_expiry_delta: u16, entropy_source: ES, secp_ctx: &Secp256k1<T>, ) -> Result<Self, ()>

where ES::Target: EntropySource,

Create a one-hop blinded path for a payment.

pub fn new<ES: Deref, T: Signing + Verification>( intermediate_nodes: &[PaymentForwardNode], payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs, htlc_maximum_msat: u64, min_final_cltv_expiry_delta: u16, entropy_source: ES, secp_ctx: &Secp256k1<T>, ) -> Result<Self, ()>

where ES::Target: EntropySource,

Create a blinded path for a payment, to be forwarded along intermediate_nodes.

Errors if:

• BlindedPayInfo calculation results in an integer overflow
• any unknown features are required in the provided ForwardTlvs

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

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 payment path by one hop, making the second hop into the new introduction node.

Will only modify self when returning Ok.

pub fn from_blinded_path_and_payinfo( introduction_node_id: PublicKey, blinding_point: PublicKey, blinded_hops: Vec<BlindedHop>, payinfo: BlindedPayInfo, ) -> Self

Builds a new BlindedPaymentPath from its constituent parts.

Useful when reconstructing a blinded path from previously serialized components.

Parameters:

• introduction_node_id: The public key of the introduction node in the path.
• blinding_point: The public key used for blinding the path.
• blinded_hops: The encrypted routing information for each hop in the path.
• payinfo: The BlindedPayInfo for the blinded path.

Trait Implementations

impl Clone for BlindedPaymentPath

fn clone(&self) -> BlindedPaymentPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlindedPaymentPath

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

Formats the value using the given formatter.

impl Hash for BlindedPaymentPath

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 BlindedPaymentPath

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

impl StructuralPartialEq for BlindedPaymentPath