Enum Payee

pub enum Payee {
    Blinded {
        route_hints: Vec<BlindedPaymentPath>,
        features: Option<Bolt12InvoiceFeatures>,
    },
    Clear {
        node_id: PublicKey,
        route_hints: Vec<RouteHint>,
        features: Option<Bolt11InvoiceFeatures>,
        final_cltv_expiry_delta: u32,
    },
}

The recipient of a payment, differing based on whether they’ve hidden their identity with route blinding.

Variants

Blinded

The recipient provided blinded paths and payinfo to reach them. The blinded paths themselves will be included in the final Route.

Fields

route_hints: Vec<BlindedPaymentPath>

Aggregated routing info and blinded paths, for routing to the payee without knowing their node id.

features: Option<Bolt12InvoiceFeatures>

Features supported by the payee.

May be set from the payee’s invoice. May be None if the invoice does not contain any features.

Clear

The recipient included these route hints in their BOLT11 invoice.

Fields

node_id: PublicKey

The node id of the payee.

route_hints: Vec<RouteHint>

Hints for routing to the payee, containing channels connecting the payee to public nodes.

features: Option<Bolt11InvoiceFeatures>

Features supported by the payee.

May be set from the payee’s invoice or via for_keysend. May be None if the invoice does not contain any features.

final_cltv_expiry_delta: u32

The minimum CLTV delta at the end of the route. This value must not be zero.

Trait Implementations

impl Clone for Payee

fn clone(&self) -> Payee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payee

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

Formats the value using the given formatter.

impl Hash for Payee

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 Payee

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

impl StructuralPartialEq for Payee