Enum PaymentPurpose

pub enum PaymentPurpose {
    Bolt11InvoicePayment {
        payment_preimage: Option<PaymentPreimage>,
        payment_secret: PaymentSecret,
    },
    Bolt12OfferPayment {
        payment_preimage: Option<PaymentPreimage>,
        payment_secret: PaymentSecret,
        payment_context: Bolt12OfferContext,
    },
    Bolt12RefundPayment {
        payment_preimage: Option<PaymentPreimage>,
        payment_secret: PaymentSecret,
        payment_context: Bolt12RefundContext,
    },
    SpontaneousPayment(PaymentPreimage),
}

Some information provided on receipt of payment depends on whether the payment received is a spontaneous payment or a “conventional” lightning payment that’s paying an invoice.

Variants

Bolt11InvoicePayment

A payment for a BOLT 11 invoice.

Fields

payment_preimage: Option<PaymentPreimage>

The preimage to the payment_hash, if the payment hash (and secret) were fetched via ChannelManager::create_inbound_payment. When handling Event::PaymentClaimable, this can be passed directly to ChannelManager::claim_funds to claim the payment. No action is needed when seen in Event::PaymentClaimed.

payment_secret: PaymentSecret

The “payment secret”. This authenticates the sender to the recipient, preventing a number of deanonymization attacks during the routing process. It is provided here for your reference, however its accuracy is enforced directly by ChannelManager using the values you previously provided to ChannelManager::create_inbound_payment or ChannelManager::create_inbound_payment_for_hash.

Bolt12OfferPayment

A payment for a BOLT 12 Offer.

Fields

payment_preimage: Option<PaymentPreimage>

The preimage to the payment hash. When handling Event::PaymentClaimable, this can be passed directly to ChannelManager::claim_funds, if provided. No action is needed when seen in Event::PaymentClaimed.

payment_secret: PaymentSecret

The secret used to authenticate the sender to the recipient, preventing a number of de-anonymization attacks while routing a payment.

See PaymentPurpose::Bolt11InvoicePayment::payment_secret for further details.

payment_context: Bolt12OfferContext

The context of the payment such as information about the corresponding Offer and InvoiceRequest.

This includes the Human Readable Name which the sender indicated they were paying to, for possible recipient disambiguation if you’re using a single wildcard DNS entry to resolve to many recipients.

Bolt12RefundPayment

A payment for a BOLT 12 Refund.

Fields

payment_preimage: Option<PaymentPreimage>

The preimage to the payment hash. When handling Event::PaymentClaimable, this can be passed directly to ChannelManager::claim_funds, if provided. No action is needed when seen in Event::PaymentClaimed.

payment_secret: PaymentSecret

The secret used to authenticate the sender to the recipient, preventing a number of de-anonymization attacks while routing a payment.

See PaymentPurpose::Bolt11InvoicePayment::payment_secret for further details.

payment_context: Bolt12RefundContext

The context of the payment such as information about the corresponding Refund.

SpontaneousPayment(PaymentPreimage)

Because this is a spontaneous payment, the payer generated their own preimage rather than us (the payee) providing a preimage.

Implementations

impl PaymentPurpose

pub fn preimage(&self) -> Option<PaymentPreimage>

Returns the preimage for this payment, if it is known.

Trait Implementations

impl Clone for PaymentPurpose

fn clone(&self) -> PaymentPurpose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentPurpose

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

Formats the value using the given formatter.

impl PartialEq for PaymentPurpose

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

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for PaymentPurpose

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

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 PaymentPurpose

impl StructuralPartialEq for PaymentPurpose