Skip to content

Commit 5a07741

Browse files
Correct docs on payment id in RecentPaymentDetails.
1 parent bad2120 commit 5a07741

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
@@ -2548,14 +2548,17 @@ pub const MAX_SHORT_LIVED_RELATIVE_EXPIRY: Duration = Duration::from_secs(60 * 6
25482548
pub enum RecentPaymentDetails {
25492549
/// When an invoice was requested and thus a payment has not yet been sent.
25502550
AwaitingInvoice {
2551-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2552-
/// a payment and ensure idempotency in LDK.
2551+
/// A user-provided identifier in [`ChannelManager::pay_for_offer`] used to uniquely identify a
2552+
/// payment and ensure idempotency in LDK.
25532553
payment_id: PaymentId,
25542554
},
25552555
/// When a payment is still being sent and awaiting successful delivery.
25562556
Pending {
2557-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2558-
/// a payment and ensure idempotency in LDK.
2557+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2558+
/// identify a payment and ensure idempotency in LDK.
2559+
///
2560+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2561+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25592562
payment_id: PaymentId,
25602563
/// Hash of the payment that is currently being sent but has yet to be fulfilled or
25612564
/// abandoned.
@@ -2568,8 +2571,11 @@ pub enum RecentPaymentDetails {
25682571
/// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
25692572
/// payment is removed from tracking.
25702573
Fulfilled {
2571-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2572-
/// a payment and ensure idempotency in LDK.
2574+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2575+
/// identify a payment and ensure idempotency in LDK.
2576+
///
2577+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2578+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25732579
payment_id: PaymentId,
25742580
/// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
25752581
/// made before LDK version 0.0.104.
@@ -2579,8 +2585,11 @@ pub enum RecentPaymentDetails {
25792585
/// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
25802586
/// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
25812587
Abandoned {
2582-
/// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
2583-
/// a payment and ensure idempotency in LDK.
2588+
/// A user-provided identifier in [`send_payment`] or [`pay_for_offer`] used to uniquely
2589+
/// identify a payment and ensure idempotency in LDK.
2590+
///
2591+
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2592+
/// [`pay_for_offer`]: crate::ln::channelmanager::ChannelManager::pay_for_offer
25842593
payment_id: PaymentId,
25852594
/// Hash of the payment that we have given up trying to send.
25862595
payment_hash: PaymentHash,

0 commit comments

Comments
 (0)