From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Tue, 21 May 2024 19:33:56 +0000 (-0500)
Subject: Add an InvoiceReceived event
X-Git-Tag: v0.0.124-beta~82^2~4
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=4666c33c0f9918ec054ac9befbafe2c492551804;p=rust-lightning

Add an InvoiceReceived event

Some users may want to handle a Bolt12Invoice asynchronously, either in
a different process or by first performing additional verification
before paying the invoice. Add an InvoiceReceived event to facilitate
this.
---

diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
index bfe219915..d6d2da936 100644
--- a/lightning/src/events/mod.rs
+++ b/lightning/src/events/mod.rs
@@ -25,6 +25,8 @@ use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
 use crate::ln::features::ChannelTypeFeatures;
 use crate::ln::msgs;
 use crate::ln::types::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
+use crate::offers::invoice::Bolt12Invoice;
+use crate::onion_message::messenger::Responder;
 use crate::routing::gossip::NetworkUpdate;
 use crate::routing::router::{BlindedTail, Path, RouteHop, RouteParameters};
 use crate::sign::SpendableOutputDescriptor;
@@ -715,6 +717,23 @@ pub enum Event {
 		/// The `payment_id` to have been associated with payment for the requested invoice.
 		payment_id: PaymentId,
 	},
+	/// Indicates a [`Bolt12Invoice`] in response to an [`InvoiceRequest`] or a [`Refund`] was
+	/// received.
+	///
+	/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
+	/// [`Refund`]: crate::offers::refund::Refund
+	InvoiceReceived {
+		/// The `payment_id` associated with payment for the invoice.
+		payment_id: PaymentId,
+		/// The invoice to pay.
+		invoice: Bolt12Invoice,
+		/// A responder for replying with an [`InvoiceError`] if needed.
+		///
+		/// `None` if the invoice wasn't sent with a reply path.
+		///
+		/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
+		responder: Option<Responder>,
+	},
 	/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
 	/// and we got back the payment preimage for it).
 	///
@@ -1471,7 +1490,15 @@ impl Writeable for Event {
 				write_tlv_fields!(writer, {
 					(0, peer_node_id, required),
 				});
-			}
+			},
+			&Event::InvoiceReceived { ref payment_id, ref invoice, ref responder } => {
+				41u8.write(writer)?;
+				write_tlv_fields!(writer, {
+					(0, payment_id, required),
+					(2, invoice, required),
+					(4, responder, option),
+				})
+			},
 			// Note that, going forward, all new events must only write data inside of
 			// `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
 			// data via `write_tlv_fields`.
@@ -1908,6 +1935,21 @@ impl MaybeReadable for Event {
 				};
 				f()
 			},
+			41u8 => {
+				let mut f = || {
+					_init_and_read_len_prefixed_tlv_fields!(reader, {
+						(0, payment_id, required),
+						(2, invoice, required),
+						(4, responder, option),
+					});
+					Ok(Some(Event::InvoiceReceived {
+						payment_id: payment_id.0.unwrap(),
+						invoice: invoice.0.unwrap(),
+						responder,
+					}))
+				};
+				f()
+			},
 			// Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
 			// Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
 			// reads.