Add payer_id quantity fields

In this commit I exposed the payer_id and quantity fields to
PaymentKind::Bolt12Offer and PaymentKind::Bolt12Refund. As
of right now, I'm unsure how to access payer_id in bolt12.rs.
At first thought I was going to use payee_pubkey but I imagine
that isn't the payers publickey we want.

Author: slanesuke

bindings/ldk_node.udl

@@ -281,8 +281,8 @@ interface PaymentKind {
 	Onchain();
 	Bolt11(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret);
 	Bolt11Jit(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret, LSPFeeLimits lsp_fee_limits);
-	Bolt12Offer(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, OfferId offer_id, UntrustedString? payer_note);
-	Bolt12Refund(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, UntrustedString? payer_note);
+	Bolt12Offer(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, OfferId offer_id, UntrustedString? payer_note, PublicKey? payer_id, u64? quantity);
+	Bolt12Refund(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, UntrustedString? payer_note, PublicKey? payer_id, u64? quantity);
 	Spontaneous(PaymentHash hash, PaymentPreimage? preimage);
 };
 

src/event.rs

@@ -597,14 +597,18 @@ where
 						payment_context,
 						..
 					} => {
-						let payer_note = payment_context.invoice_request.payer_note_truncated;
 						let offer_id = payment_context.offer_id;
+						let payer_note = payment_context.invoice_request.payer_note_truncated;
+						let payer_id = payment_context.invoice_request.payer_id;
+						let quantity = payment_context.invoice_request.quantity;
 						let kind = PaymentKind::Bolt12Offer {
 							hash: Some(payment_hash),
 							preimage: payment_preimage,
 							secret: Some(payment_secret),
 							offer_id,
 							payer_note,
+							payer_id: Some(payer_id),
+							quantity,
 						};
 
 						let payment = PaymentDetails::new(

src/payment/bolt12.rs

@@ -97,6 +97,8 @@ impl Bolt12Payment {
 					secret: None,
 					offer_id: offer.id(),
 					payer_note: payer_note.map(UntrustedString),
+					payer_id: None,
+					quantity,
 				};
 				let payment = PaymentDetails::new(
 					payment_id,
@@ -120,6 +122,8 @@ impl Bolt12Payment {
 							secret: None,
 							offer_id: offer.id(),
 							payer_note: payer_note.map(UntrustedString),
+							payer_id: None,
+							quantity,
 						};
 						let payment = PaymentDetails::new(
 							payment_id,
@@ -200,6 +204,8 @@ impl Bolt12Payment {
 					secret: None,
 					offer_id: offer.id(),
 					payer_note: payer_note.map(UntrustedString),
+					payer_id: None,
+					quantity,
 				};
 				let payment = PaymentDetails::new(
 					payment_id,
@@ -223,6 +229,8 @@ impl Bolt12Payment {
 							secret: None,
 							offer_id: offer.id(),
 							payer_note: payer_note.map(UntrustedString),
+							payer_id: None,
+							quantity,
 						};
 						let payment = PaymentDetails::new(
 							payment_id,
@@ -291,6 +299,8 @@ impl Bolt12Payment {
 			preimage: None,
 			secret: None,
 			payer_note: refund.payer_note().map(|note| UntrustedString(note.to_string())),
+			payer_id: None,
+			quantity: None,
 		};
 
 		let payment = PaymentDetails::new(
@@ -344,6 +354,8 @@ impl Bolt12Payment {
 			preimage: None,
 			secret: None,
 			payer_note: refund.payer_note().map(|note| UntrustedString(note.to_string())),
+			payer_id: None,
+			quantity: None,
 		};
 		let payment = PaymentDetails::new(
 			payment_id,

src/payment/store.rs

@@ -6,6 +6,7 @@ use crate::logger::{log_error, Logger};
 use crate::types::DynStore;
 use crate::Error;
 
+use bitcoin::secp256k1::PublicKey;
 use lightning::ln::channelmanager::PaymentId;
 use lightning::ln::msgs::DecodeError;
 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
@@ -213,10 +214,20 @@ pub enum PaymentKind {
 		secret: Option<PaymentSecret>,
 		/// The ID of the offer this payment is for.
 		offer_id: OfferId,
-		/// The payer note for the payment.
+		/// The payer note for the payment. Truncated to [PAYER_NOTE_LIMIT] characters.
 		///
 		/// This will always be `None` for payments serialized with version `v0.3.0`.
+		///
+		/// [PAYER_NOTE_LIMIT]: lightning::offers::invoice_request::PAYER_NOTE_LIMIT
 		payer_note: Option<UntrustedString>,
+		/// The payers ID for the payment.
+		///
+		/// This will always be `None` for payments serialized with version `v0.3.0`.
+		payer_id: Option<PublicKey>,
+		/// The quantity of items or units requested in the offer.
+		///
+		/// This will always be `None` for payments serialized with version `v0.3.0`.
+		quantity: Option<u64>,
 	},
 	/// A [BOLT 12] 'refund' payment, i.e., a payment for a [`Refund`].
 	///
@@ -233,6 +244,14 @@ pub enum PaymentKind {
 		///
 		/// This will always be `None` for payments serialized with version `v0.3.0`.
 		payer_note: Option<UntrustedString>,
+		/// The payers ID for the refund payment.
+		///
+		/// This will always be `None` for payments serialized with version `v0.3.0`.
+		payer_id: Option<PublicKey>,
+		/// The quantity of items or units requested in the offer.
+		///
+		/// This will always be `None` for payments serialized with version `v0.3.0`.
+		quantity: Option<u64>,
 	},
 	/// A spontaneous ("keysend") payment.
 	Spontaneous {
@@ -258,20 +277,24 @@ impl_writeable_tlv_based_enum!(PaymentKind,
 	},
 	(6, Bolt12Offer) => {
 		(0, hash, option),
+		(1, payer_note, option),
 		(2, preimage, option),
+		(3, payer_id, option),
 		(4, secret, option),
+		(5, quantity, option),
 		(6, offer_id, required),
-		(1, payer_note, option),
 	},
 	(8, Spontaneous) => {
 		(0, hash, required),
 		(2, preimage, option),
 	},
 	(10, Bolt12Refund) => {
 		(0, hash, option),
+		(1, payer_note, option),
 		(2, preimage, option),
+		(3, payer_id, option),
 		(4, secret, option),
-		(1, payer_note, option),
+		(5, quantity, option),
 	};
 );
 

tests/integration_tests_rust.rs

@@ -523,7 +523,7 @@ fn simple_bolt12_send_receive() {
 	let node_b_payments = node_b.list_payments_with_filter(|p| p.id == node_b_payment_id);
 	assert_eq!(node_b_payments.len(), 1);
 	match node_b_payments.first().unwrap().kind {
-		PaymentKind::Bolt12Refund { hash, preimage, secret: _ } => {
+		PaymentKind::Bolt12Refund { hash, preimage, secret: _ , ..} => {
 			assert!(hash.is_some());
 			assert!(preimage.is_some());
 			//TODO: We should eventually set and assert the secret sender-side, too, but the BOLT12
@@ -539,7 +539,7 @@ fn simple_bolt12_send_receive() {
 	let node_a_payments = node_a.list_payments_with_filter(|p| p.id == node_a_payment_id);
 	assert_eq!(node_a_payments.len(), 1);
 	match node_a_payments.first().unwrap().kind {
-		PaymentKind::Bolt12Refund { hash, preimage, secret } => {
+		PaymentKind::Bolt12Refund { hash, preimage, secret, .. } => {
 			assert!(hash.is_some());
 			assert!(preimage.is_some());
 			assert!(secret.is_some());