Enum lightning::util::events::PaymentPurpose

pub enum PaymentPurpose {
    InvoicePayment {
        payment_preimage: Option<PaymentPreimage>,
        payment_secret: PaymentSecret,
    },
    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

InvoicePayment

Fields

payment_preimage: Option<PaymentPreimage>

The preimage to the payment_hash, if the payment hash (and secret) were fetched via ChannelManager::create_inbound_payment. If provided, this can be handed directly to ChannelManager::claim_funds.

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.

Information for receiving a payment that we generated an invoice for.

SpontaneousPayment(PaymentPreimage)

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

Trait Implementations

impl Clone for PaymentPurpose

fn clone(&self) -> PaymentPurpose

Returns a copy 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 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

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.