mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 15:02:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Document InvoiceRequestFailed in ChannelManager

Browse source
This commit is contained in:
Jeffrey Czyz 2023-10-19 09:16:08 -05:00
parent 2840252cbc
commit 5a0b111668
No known key found for this signature in database
GPG key ID: 3A4E08275D5E96D2
2 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lightning/src/events/mod.rs
View file

@ -514,9 +514,13 @@ pub enum Event {
sender_intended_total_msat: Option<u64>,
},
/// Indicates a request for an invoice failed to yield a response in a reasonable amount of time
/// or was explicitly abandoned by [`ChannelManager::abandon_payment`].
/// or was explicitly abandoned by [`ChannelManager::abandon_payment`]. This may be for an
/// [`InvoiceRequest`] sent for an [`Offer`] or for a [`Refund`] that hasn't been redeemed.
///
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Offer`]: crate::offers::offer::Offer
/// [`Refund`]: crate::offers::refund::Refund
InvoiceRequestFailed {
/// The `payment_id` to have been associated with payment for the requested invoice.
payment_id: PaymentId,

16
lightning/src/ln/channelmanager.rs
View file

@ -3608,9 +3608,10 @@ where
///
/// # Requested Invoices
///
/// In the case of paying a [`Bolt12Invoice`], abandoning the payment prior to receiving the
/// invoice will result in an [`Event::InvoiceRequestFailed`] and prevent any attempts at paying
/// it once received. The other events may only be generated once the invoice has been received.
/// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
/// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
/// and prevent any attempts at paying it once received. The other events may only be generated
/// once the invoice has been received.
///
/// # Restart Behavior
///
@ -7348,6 +7349,8 @@ where
///
/// The provided `payment_id` is used to ensure that only one invoice is paid for the refund. To
/// revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the invoice.
/// If an invoice isn't received before expiration, the payment will fail with an
/// [`Event::InvoiceRequestFailed`].
///
/// Uses a one-hop [`BlindedPath`] for the refund with [`ChannelManager::get_our_node_id`] as
/// the introduction node and a derived payer id for sender privacy. As such, currently, the
@ -7397,8 +7400,11 @@ where
///
/// The provided `payment_id` is used to ensure that only one invoice is paid for the request
/// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
/// been sent. To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving
/// the invoice.
/// been sent.
///
/// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
/// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
/// payment will fail with an [`Event::InvoiceRequestFailed`].
///
/// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link.
///