Enum PaymentMethod

pub enum PaymentMethod {
    LightningBolt11(Bolt11Invoice),
    LightningBolt12(Offer),
    OnChain {
        amount: Option<Amount>,
        address: Address,
    },
}

A method which can be used to make a payment

Variants

LightningBolt11(Bolt11Invoice)

A payment using lightning as descibred by the given BOLT 11 invoice.

LightningBolt12(Offer)

A payment using lightning as descibred by the given BOLT 12 offer.

OnChain

A payment directly on-chain to the specified address.

Fields

amount: Option<Amount>

The amount which this payment method requires payment for.

• For instructions extracted from BIP 321 bitcoin: URIs this is the amount parameter.
• For the fallback address from a lightning BOLT 11 invoice this is the invoice’s amount, rounded up to the nearest whole satoshi.

address: Address

The address to which payment can be made.

Implementations

impl PaymentMethod

pub fn amount(&self) -> Option<Amount>

The amount this payment method requires payment for.

If None for non-BOLT 12 payments, any amount can be paid.

For Lightning BOLT 12 offers, the requested amount may be denominated in an alternative currency, requiring currency conversion and negotiatin while paying. In such a case, None will be returned. See Offer::amount and LDK’s offer payment logic for more info.

Trait Implementations

impl Debug for PaymentMethod

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

Formats the value using the given formatter.

impl PartialEq for PaymentMethod

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

impl StructuralPartialEq for PaymentMethod