Enum RecentPaymentDetails

pub enum RecentPaymentDetails {
    AwaitingInvoice {
        payment_id: PaymentId,
    },
    Pending {
        payment_id: PaymentId,
        payment_hash: PaymentHash,
        total_msat: u64,
    },
    Fulfilled {
        payment_id: PaymentId,
        payment_hash: Option<PaymentHash>,
    },
    Abandoned {
        payment_id: PaymentId,
        payment_hash: PaymentHash,
    },
}

Used by ChannelManager::list_recent_payments to express the status of recent payments. These include payments that have yet to find a successful path, or have unresolved HTLCs.

Variants

AwaitingInvoice

When an invoice was requested and thus a payment has not yet been sent.

Fields

payment_id: PaymentId

A user-provided identifier in ChannelManager::pay_for_offer used to uniquely identify a payment and ensure idempotency in LDK.

Pending

When a payment is still being sent and awaiting successful delivery.

Fields

payment_id: PaymentId

A user-provided identifier in send_payment or pay_for_offer used to uniquely identify a payment and ensure idempotency in LDK.

payment_hash: PaymentHash

Hash of the payment that is currently being sent but has yet to be fulfilled or abandoned.

total_msat: u64

Total amount (in msat, excluding fees) across all paths for this payment, not just the amount currently inflight.

Fulfilled

When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have been resolved. Upon receiving Event::PaymentSent, we delay for a few minutes before the payment is removed from tracking.

Fields

payment_id: PaymentId

A user-provided identifier in send_payment or pay_for_offer used to uniquely identify a payment and ensure idempotency in LDK.

payment_hash: Option<PaymentHash>

Hash of the payment that was claimed. None for serializations of ChannelManager made before LDK version 0.0.104.

Abandoned

After a payment’s retries are exhausted per the provided Retry, or it is explicitly abandoned via ChannelManager::abandon_payment, it is marked as abandoned until all pending HTLCs for this payment resolve and an Event::PaymentFailed is generated.

Fields

payment_id: PaymentId

A user-provided identifier in send_payment or pay_for_offer used to uniquely identify a payment and ensure idempotency in LDK.

payment_hash: PaymentHash

Hash of the payment that we have given up trying to send.

Trait Implementations

impl Debug for RecentPaymentDetails

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

Formats the value using the given formatter.

impl PartialEq for RecentPaymentDetails

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