Enum PaymentKind

pub enum PaymentKind {
    Onchain {
        txid: Txid,
        status: ConfirmationStatus,
    },
    Bolt11 {
        hash: PaymentHash,
        preimage: Option<PaymentPreimage>,
        secret: Option<PaymentSecret>,
    },
    Bolt11Jit {
        hash: PaymentHash,
        preimage: Option<PaymentPreimage>,
        secret: Option<PaymentSecret>,
        counterparty_skimmed_fee_msat: Option<u64>,
        lsp_fee_limits: LSPFeeLimits,
    },
    Bolt12Offer {
        hash: Option<PaymentHash>,
        preimage: Option<PaymentPreimage>,
        secret: Option<PaymentSecret>,
        offer_id: OfferId,
        payer_note: Option<UntrustedString>,
        quantity: Option<u64>,
    },
    Bolt12Refund {
        hash: Option<PaymentHash>,
        preimage: Option<PaymentPreimage>,
        secret: Option<PaymentSecret>,
        payer_note: Option<UntrustedString>,
        quantity: Option<u64>,
    },
    Spontaneous {
        hash: PaymentHash,
        preimage: Option<PaymentPreimage>,
    },
}

Represents the kind of a payment.

Variants

Onchain

An on-chain payment.

Payments of this kind will be considered pending until the respective transaction has reached ANTI_REORG_DELAY confirmations on-chain.

Fields

txid: Txid

The transaction identifier of this payment.

status: ConfirmationStatus

The confirmation status of this payment.

Bolt11

A BOLT 11 payment.

Fields

hash: PaymentHash

The payment hash, i.e., the hash of the preimage.

preimage: Option<PaymentPreimage>

The pre-image used by the payment.

secret: Option<PaymentSecret>

The secret used by the payment.

Bolt11Jit

A BOLT 11 payment intended to open an [bLIP-52 / LSPS 2] just-in-time channel.

Fields

hash: PaymentHash

The payment hash, i.e., the hash of the preimage.

preimage: Option<PaymentPreimage>

The pre-image used by the payment.

secret: Option<PaymentSecret>

The secret used by the payment.

counterparty_skimmed_fee_msat: Option<u64>

The value, in thousands of a satoshi, that was deducted from this payment as an extra fee taken by our channel counterparty.

Will only be Some once we received the payment. Will always be None for LDK Node v0.4 and prior.

lsp_fee_limits: LSPFeeLimits

Limits applying to how much fee we allow an LSP to deduct from the payment amount.

Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.

See LdkChannelConfig::accept_underpaying_htlcs for more information.

Bolt12Offer

A BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.

Fields

hash: Option<PaymentHash>

The payment hash, i.e., the hash of the preimage.

preimage: Option<PaymentPreimage>

The pre-image used by the payment.

secret: Option<PaymentSecret>

The secret used by the payment.

offer_id: OfferId

The ID of the offer this payment is for.

payer_note: Option<UntrustedString>

The payer note for the payment.

Truncated to PAYER_NOTE_LIMIT characters.

This will always be None for payments serialized with version v0.3.0.

quantity: Option<u64>

The quantity of an item requested in the offer.

This will always be None for payments serialized with version v0.3.0.

Bolt12Refund

A BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.

Fields

hash: Option<PaymentHash>

The payment hash, i.e., the hash of the preimage.

preimage: Option<PaymentPreimage>

The pre-image used by the payment.

secret: Option<PaymentSecret>

The secret used by the payment.

payer_note: Option<UntrustedString>

The payer note for the refund payment.

This will always be None for payments serialized with version v0.3.0.

quantity: Option<u64>

The quantity of an item that the refund is for.

This will always be None for payments serialized with version v0.3.0.

Spontaneous

A spontaneous (“keysend”) payment.

Fields

hash: PaymentHash

The payment hash, i.e., the hash of the preimage.

preimage: Option<PaymentPreimage>

The pre-image used by the payment.

Trait Implementations

impl Clone for PaymentKind

fn clone(&self) -> PaymentKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentKind

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

Formats the value using the given formatter.

impl PartialEq for PaymentKind

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

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

Reads a Self in from the given Read.

impl Writeable for PaymentKind

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 PaymentKind

impl StructuralPartialEq for PaymentKind