Skip to content

Commit f2721af

Browse files
committed
f - rewrite docs
1 parent 17f5158 commit f2721af

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

lightning/src/events/mod.rs

+2-5
Original file line numberDiff line numberDiff line change
@@ -722,17 +722,14 @@ pub enum Event {
722722
///
723723
/// This event will only be generated if [`UserConfig::manually_handle_bolt12_invoices`] is set.
724724
/// Use [`ChannelManager::send_payment_for_bolt12_invoice`] to pay the invoice or
725-
/// [`ChannelManager::abandon_payment`] to abandon the associated payment. Must be paid before
726-
/// [`Bolt12Invoice::relative_expiry`] has elapsed since [`Bolt12Invoice::created_at`].
727-
/// Attempting to pay the invoice after this time will result in an [`Event::PaymentFailed`].
725+
/// [`ChannelManager::abandon_payment`] to abandon the associated payment. See those docs for
726+
/// further details.
728727
///
729728
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
730729
/// [`Refund`]: crate::offers::refund::Refund
731730
/// [`UserConfig::manually_handle_bolt12_invoices`]: crate::util::config::UserConfig::manually_handle_bolt12_invoices
732731
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
733732
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
734-
/// [`Bolt12Invoice::relative_expiry`]: crate::offers::invoice::Bolt12Invoice::relative_expiry
735-
/// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
736733
InvoiceReceived {
737734
/// The `payment_id` associated with payment for the invoice.
738735
payment_id: PaymentId,

lightning/src/ln/channelmanager.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -4001,7 +4001,10 @@ where
40014001
/// The invoice's `payer_metadata` is used to authenticate that the invoice was indeed requested
40024002
/// before attempting a payment. [`Bolt12PaymentError::UnexpectedInvoice`] is returned if this
40034003
/// fails or if the encoded `payment_id` is not recognized. The latter may happen once the
4004-
/// invoice is paid and the payment no longer tracked.
4004+
/// payment is no longer tracked because the payment was attempted after:
4005+
/// - an invoice for the `payment_id` was already paid,
4006+
/// - one timer tick has elapsed since initially requesting the invoice when paying an offer, or
4007+
/// - the refund corresponding to the invoice has already expired.
40054008
///
40064009
/// Attempting to pay the same invoice twice while the first payment is still pending will
40074010
/// result in a [`Bolt12PaymentError::DuplicateInvoice`].

0 commit comments

Comments
 (0)