Enum PaymentMethod

pub enum PaymentMethod {
    Onchain {
        address: Address,
        amount: Option<Amount>,
        label: Option<String>,
        message: Option<String>,
    },
    Invoice {
        invoice: Invoice,
    },
    Offer {
        offer: Offer,
        bip321_amount: Option<Amount>,
    },
    LnurlPay {
        lnurl: String,
        pay_request: LnurlPayRequest,
    },
}

A single “payment method” – each kind here should correspond with a single linear (outbound) payment flow for a user, where there are no other alternate methods.

For example, a Unified BTC QR code contains a single BIP321 URI, which may contain multiple discrete payment methods (an onchain address, a BOLT11 invoice, a BOLT12 offer).

Compare with ClaimMethod, which is the inbound equivalent.

Variants

Onchain

Fields

address: Address

An onchain Bitcoin address.

amount: Option<Amount>

The amount to pay to the onchain address, if specified.

Parsed from a BIP321 URI or BOLT11 invoice containing the onchain address.

label: Option<String>

A label for the onchain address.

Parsed from a BIP321 URI containing the onchain address.

message: Option<String>

A message describing the transaction or its purpose.

Parsed from a BIP321 URI or BOLT11 invoice containing the onchain address.

Invoice

Fields

invoice: Invoice

A BOLT11 invoice.

Offer

Fields

offer: Offer

A BOLT12 offer.

bip321_amount: Option<Amount>

The amount to pay to the offer, if specified.

Parsed from a BIP321 URI containing the offer.

LnurlPay

Fields

lnurl: String

The LNURL-pay LNURL.

pay_request: LnurlPayRequest

The LNURL-pay request, which includes information about the amount constraints, callback, etc. associated with the LNURL.

Implementations

impl PaymentMethod

pub fn is_onchain(&self) -> bool

Check if the payment method is an onchain address.

pub fn is_invoice(&self) -> bool

Check if the payment method is a BOLT11 invoice.

pub fn is_offer(&self) -> bool

Check if the payment method is a BOLT12 offer.

pub fn is_lnurl_pay(&self) -> bool

Check if the payment method is an LNURL-pay endpoint.

pub fn kind(&self) -> &'static str

Get the “kind” of the payment method as a string: “onchain”, “invoice”, “offer”, or “lnurl-pay”.

pub fn supports_network(&self, network: Network) -> bool

Check if the payment method is valid for the given Network.

pub fn priority(&self) -> usize

For use with sort_by_key, max_by_key, etc. Payment methods with a higher priority should be preferred over others.