feat: add description field to BOLT11 payments

- Extract and store description from BOLT11 invoices in PaymentKind::Bolt11 and PaymentKind::Bolt11Jit variants.

Author: coreyphillips

bindings/ldk_node.udl

@@ -429,8 +429,8 @@ interface ClosureReason {
 [Enum]
 interface PaymentKind {
 	Onchain(Txid txid, ConfirmationStatus status);
-	Bolt11(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret);
-	Bolt11Jit(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret, u64? counterparty_skimmed_fee_msat, LSPFeeLimits lsp_fee_limits);
+	Bolt11(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret, string? description);
+	Bolt11Jit(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret, u64? counterparty_skimmed_fee_msat, LSPFeeLimits lsp_fee_limits, string? description);
 	Bolt12Offer(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, OfferId offer_id, UntrustedString? payer_note, u64? quantity);
 	Bolt12Refund(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, UntrustedString? payer_note, u64? quantity);
 	Spontaneous(PaymentHash hash, PaymentPreimage? preimage);

src/payment/bolt11.rs

@@ -176,10 +176,19 @@ impl Bolt11Payment {
 				let amt_msat = invoice.amount_milli_satoshis().unwrap();
 				log_info!(self.logger, "Initiated sending {}msat to {}", amt_msat, payee_pubkey);
 
+				// Extract description from the invoice
+				let description = match invoice.description() {
+					lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+					lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+						Some(crate::hex_utils::to_string(hash.0.as_ref()))
+					},
+				};
+
 				let kind = PaymentKind::Bolt11 {
 					hash: payment_hash,
 					preimage: None,
 					secret: payment_secret,
+					description,
 				};
 				let payment = PaymentDetails::new(
 					payment_id,
@@ -199,10 +208,19 @@ impl Bolt11Payment {
 				match e {
 					RetryableSendFailure::DuplicatePayment => Err(Error::DuplicatePayment),
 					_ => {
+						// Extract description from the invoice
+						let description = match invoice.description() {
+							lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+							lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+								Some(crate::hex_utils::to_string(hash.0.as_ref()))
+							},
+						};
+						
 						let kind = PaymentKind::Bolt11 {
 							hash: payment_hash,
 							preimage: None,
 							secret: payment_secret,
+							description,
 						};
 						let payment = PaymentDetails::new(
 							payment_id,
@@ -311,10 +329,19 @@ impl Bolt11Payment {
 					payee_pubkey
 				);
 
+				// Extract description from the invoice
+				let description = match invoice.description() {
+					lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+					lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+						Some(crate::hex_utils::to_string(hash.0.as_ref()))
+					},
+				};
+
 				let kind = PaymentKind::Bolt11 {
 					hash: payment_hash,
 					preimage: None,
 					secret: Some(*payment_secret),
+					description,
 				};
 
 				let payment = PaymentDetails::new(
@@ -335,10 +362,19 @@ impl Bolt11Payment {
 				match e {
 					RetryableSendFailure::DuplicatePayment => Err(Error::DuplicatePayment),
 					_ => {
+						// Extract description from the invoice
+						let description = match invoice.description() {
+							lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+							lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+								Some(crate::hex_utils::to_string(hash.0.as_ref()))
+							},
+						};
+						
 						let kind = PaymentKind::Bolt11 {
 							hash: payment_hash,
 							preimage: None,
 							secret: Some(*payment_secret),
+							description,
 						};
 						let payment = PaymentDetails::new(
 							payment_id,
@@ -569,10 +605,20 @@ impl Bolt11Payment {
 		} else {
 			None
 		};
+		
+		// Extract description from the invoice
+		let description = match invoice.description() {
+			lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+			lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+				Some(crate::hex_utils::to_string(hash.0.as_ref()))
+			},
+		};
+		
 		let kind = PaymentKind::Bolt11 {
 			hash: payment_hash,
 			preimage,
 			secret: Some(payment_secret.clone()),
+			description,
 		};
 		let payment = PaymentDetails::new(
 			id,
@@ -705,12 +751,22 @@ impl Bolt11Payment {
 		let id = PaymentId(payment_hash.0);
 		let preimage =
 			self.channel_manager.get_payment_preimage(payment_hash, payment_secret.clone()).ok();
+		
+		// Extract description from the invoice
+		let description = match invoice.description() {
+			lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
+			lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
+				Some(crate::hex_utils::to_string(hash.0.as_ref()))
+			},
+		};
+		
 		let kind = PaymentKind::Bolt11Jit {
 			hash: payment_hash,
 			preimage,
 			secret: Some(payment_secret.clone()),
 			counterparty_skimmed_fee_msat: None,
 			lsp_fee_limits,
+			description,
 		};
 		let payment = PaymentDetails::new(
 			id,

src/payment/store.rs

@@ -138,9 +138,10 @@ impl Readable for PaymentDetails {
 						secret,
 						counterparty_skimmed_fee_msat,
 						lsp_fee_limits,
+						description: None,
 					}
 				} else {
-					PaymentKind::Bolt11 { hash, preimage, secret }
+					PaymentKind::Bolt11 { hash, preimage, secret, description: None }
 				}
 			} else {
 				PaymentKind::Spontaneous { hash, preimage }
@@ -364,6 +365,8 @@ pub enum PaymentKind {
 		preimage: Option<PaymentPreimage>,
 		/// The secret used by the payment.
 		secret: Option<PaymentSecret>,
+		/// The description from the BOLT 11 invoice.
+		description: Option<String>,
 	},
 	/// A [BOLT 11] payment intended to open an [bLIP-52 / LSPS 2] just-in-time channel.
 	///
@@ -391,6 +394,8 @@ pub enum PaymentKind {
 		///
 		/// [`LdkChannelConfig::accept_underpaying_htlcs`]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
 		lsp_fee_limits: LSPFeeLimits,
+		/// The description from the BOLT 11 invoice.
+		description: Option<String>,
 	},
 	/// A [BOLT 12] 'offer' payment, i.e., a payment for an [`Offer`].
 	///
@@ -456,13 +461,15 @@ impl_writeable_tlv_based_enum!(PaymentKind,
 		(0, hash, required),
 		(2, preimage, option),
 		(4, secret, option),
+		(6, description, option),
 	},
 	(4, Bolt11Jit) => {
 		(0, hash, required),
 		(1, counterparty_skimmed_fee_msat, option),
 		(2, preimage, option),
 		(4, secret, option),
 		(6, lsp_fee_limits, required),
+		(8, description, option),
 	},
 	(6, Bolt12Offer) => {
 		(0, hash, option),
@@ -670,7 +677,7 @@ mod tests {
 			);
 
 			match bolt11_decoded.kind {
-				PaymentKind::Bolt11 { hash: h, preimage: p, secret: s } => {
+				PaymentKind::Bolt11 { hash: h, preimage: p, secret: s, description: _ } => {
 					assert_eq!(hash, h);
 					assert_eq!(preimage, p);
 					assert_eq!(secret, s);
@@ -719,6 +726,7 @@ mod tests {
 					secret: s,
 					counterparty_skimmed_fee_msat: c,
 					lsp_fee_limits: l,
+					description: _,
 				} => {
 					assert_eq!(hash, h);
 					assert_eq!(preimage, p);