Skip to content

Commit 09c442f

Browse files
Correct docs on payment id in RecentPaymentDetails.
1 parent bd41dc6 commit 09c442f

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2514,14 +2514,17 @@ pub const MAX_SHORT_LIVED_RELATIVE_EXPIRY: Duration = Duration::from_secs(60 * 6
25142514
pub enum RecentPaymentDetails {
25152515
/// When an invoice was requested and thus a payment has not yet been sent.
25162516
AwaitingInvoice {
2517-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2518-
/// a payment and ensure idempotency in LDK.
2517+
/// A user-provided identifier in [`ChannelManager::pay_for_offer`] used to uniquely identify a
2518+
/// payment and ensure idempotency in LDK.
25192519
payment_id: PaymentId,
25202520
},
25212521
/// When a payment is still being sent and awaiting successful delivery.
25222522
Pending {
2523-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2524-
/// a payment and ensure idempotency in LDK.
2523+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2524+
/// identify a payment and ensure idempotency in LDK.
2525+
///
2526+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2527+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25252528
payment_id: PaymentId,
25262529
/// Hash of the payment that is currently being sent but has yet to be fulfilled or
25272530
/// abandoned.
@@ -2534,8 +2537,11 @@ pub enum RecentPaymentDetails {
25342537
/// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
25352538
/// payment is removed from tracking.
25362539
Fulfilled {
2537-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2538-
/// a payment and ensure idempotency in LDK.
2540+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2541+
/// identify a payment and ensure idempotency in LDK.
2542+
///
2543+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2544+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25392545
payment_id: PaymentId,
25402546
/// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
25412547
/// made before LDK version 0.0.104.
@@ -2545,8 +2551,11 @@ pub enum RecentPaymentDetails {
25452551
/// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
25462552
/// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
25472553
Abandoned {
2548-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2549-
/// a payment and ensure idempotency in LDK.
2554+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2555+
/// identify a payment and ensure idempotency in LDK.
2556+
///
2557+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2558+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25502559
payment_id: PaymentId,
25512560
/// Hash of the payment that we have given up trying to send.
25522561
payment_hash: PaymentHash,

0 commit comments

Comments
 (0)