fixup! add the bolt12 invoice to the PaymentSend event

Signed-off-by: Vincenzo Palazzo <[email protected]>

Author: vincenzopalazzo

lightning/src/events/mod.rs

@@ -955,6 +955,10 @@ pub enum Event {
 		/// payment hash. A third party can verify that the payment was made by
 		/// showing the invoice and confirming that the payment hash matches
 		/// the hash of the payment preimage.
+		///
+		/// However, the [`PaidInvoice`] can also be of type [`StaticInvoice`], which
+		/// is a special [`Bolt12Invoice`] where proof of payment is not possible.
+		/// For more details, see the `async_payments` specification.
 		bolt12_invoice: Option<PaidInvoice>,
 	},
 	/// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
@@ -2450,13 +2454,12 @@ impl<T: EventHandler> EventHandler for Arc<T> {
 	}
 }
 
-/// Wrapper time to move the bolt12 invoice and the static
-/// invoice across the same event as a unique type.
+/// The BOLT 12 invoice that was paid, surfaced in [`Event::PaymentSent::bolt12_invoice`].
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum PaidInvoice {
-	/// Bolt12 invoice
+	///
 	Bolt12Invoice(crate::offers::invoice::Bolt12Invoice),
-	/// Static invoice
+	///
 	StaticInvoice(crate::offers::static_invoice::StaticInvoice),
  }
 

lightning/src/ln/outbound_payment.rs

@@ -157,9 +157,9 @@ impl_writeable_tlv_based!(RetryableInvoiceRequest, {
 });
 
 impl PendingOutboundPayment {
-	fn bolt12_invoice(&self) -> Option<&PaidInvoice> {
+	fn bolt12_invoice(&self) -> Option<PaidInvoice> {
 		match self {
-			PendingOutboundPayment::Retryable { bolt12_invoice, .. } => bolt12_invoice.as_ref(),
+			PendingOutboundPayment::Retryable { bolt12_invoice, .. } => bolt12_invoice.clone(),
 			_ => None,
 		}
 	}
@@ -968,7 +968,7 @@ impl OutboundPayments {
 		}
 		let invoice = PaidInvoice::Bolt12Invoice(invoice.clone());
 		self.send_payment_for_bolt12_invoice_internal(
-			payment_id, payment_hash, None, None, Some(&invoice), route_params, retry_strategy, router, first_hops,
+			payment_id, payment_hash, None, None, Some(invoice), route_params, retry_strategy, router, first_hops,
 			inflight_htlcs, entropy_source, node_signer, node_id_lookup, secp_ctx, best_block_height,
 			logger, pending_events, send_payment_along_path
 		)
@@ -979,7 +979,7 @@ impl OutboundPayments {
 	>(
 		&self, payment_id: PaymentId, payment_hash: PaymentHash,
 		keysend_preimage: Option<PaymentPreimage>, invoice_request: Option<&InvoiceRequest>,
-		bolt12_invoice: Option<&PaidInvoice>,
+		bolt12_invoice: Option<PaidInvoice>,
 		mut route_params: RouteParameters, retry_strategy: Retry, router: &R,
 		first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
 		node_id_lookup: &NL, secp_ctx: &Secp256k1<secp256k1::All>, best_block_height: u32, logger: &L,
@@ -1042,7 +1042,7 @@ impl OutboundPayments {
 			hash_map::Entry::Occupied(entry) => match entry.get() {
 				PendingOutboundPayment::InvoiceReceived { .. } => {
 					let (retryable_payment, onion_session_privs) = Self::create_pending_payment(
-						payment_hash, recipient_onion.clone(), keysend_preimage, None, bolt12_invoice.cloned(), &route,
+						payment_hash, recipient_onion.clone(), keysend_preimage, None, bolt12_invoice, &route,
 						Some(retry_strategy), payment_params, entropy_source, best_block_height,
 					);
 					*entry.into_mut() = retryable_payment;
@@ -1053,7 +1053,7 @@ impl OutboundPayments {
 						invoice_request
 					} else { unreachable!() };
 					let (retryable_payment, onion_session_privs) = Self::create_pending_payment(
-						payment_hash, recipient_onion.clone(), keysend_preimage, Some(invreq), bolt12_invoice.cloned(), &route,
+						payment_hash, recipient_onion.clone(), keysend_preimage, Some(invreq), bolt12_invoice, &route,
 						Some(retry_strategy), payment_params, entropy_source, best_block_height
 					);
 					outbounds.insert(payment_id, retryable_payment);
@@ -2029,7 +2029,7 @@ impl OutboundPayments {
 					payment_hash,
 					amount_msat,
 					fee_paid_msat,
-					bolt12_invoice: payment.get().bolt12_invoice().cloned(),
+					bolt12_invoice: payment.get().bolt12_invoice(),
 				}, Some(ev_completion_action.clone())));
 				payment.get_mut().mark_fulfilled();
 			}
@@ -2388,7 +2388,7 @@ impl OutboundPayments {
 					payment_metadata: None, // only used for retries, and we'll never retry on startup
 					keysend_preimage: None, // only used for retries, and we'll never retry on startup
 					invoice_request: None, // only used for retries, and we'll never retry on startup
-					bolt12_invoice: None, // only used for retries, and we'll never retry on startup! TODO(vincenzopalazzo): double check this
+					bolt12_invoice: None, // only used for retries, and we'll never retry on startup!
 					custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
 					pending_amt_msat: path_amt,
 					pending_fee_msat: Some(path_fee),