Skip to content

Commit 6c32b79

Browse files
committed
f - expand docs
1 parent 64d98f0 commit 6c32b79

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lightning/src/events/mod.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -722,13 +722,17 @@ 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.
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`].
726728
///
727729
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
728730
/// [`Refund`]: crate::offers::refund::Refund
729731
/// [`UserConfig::manually_handle_bolt12_invoices`]: crate::util::config::UserConfig::manually_handle_bolt12_invoices
730732
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
731733
/// [`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
732736
InvoiceReceived {
733737
/// The `payment_id` associated with payment for the invoice.
734738
payment_id: PaymentId,

0 commit comments

Comments
 (0)