Merge pull request #3204 from valentinewallace/2024-07-rb-test-vectors

Implement route blinding test vectors

Author: TheBlueMatt

fuzz/src/invoice_request_deser.rs

@@ -113,6 +113,7 @@ fn build_response<T: secp256k1::Signing + secp256k1::Verification>(
 				htlc_minimum_msat: 100,
 			},
 			features: BlindedHopFeatures::empty(),
+			next_blinding_override: None,
 		},
 		node_id: pubkey(43),
 		htlc_maximum_msat: 1_000_000_000_000,

fuzz/src/onion_hop_data.rs

@@ -21,7 +21,7 @@ pub fn onion_hop_data_test<Out: test_logger::Output>(data: &[u8], _out: Out) {
 	let node_signer = test_utils::TestNodeSigner::new(test_utils::privkey(42));
 	let _ = <lightning::ln::msgs::InboundOnionPayload as ReadableArgs<(
 		Option<PublicKey>,
-		&&test_utils::TestNodeSigner,
+		&test_utils::TestNodeSigner,
 	)>>::read(&mut r, (None, &&node_signer));
 }
 
@@ -34,6 +34,6 @@ pub extern "C" fn onion_hop_data_run(data: *const u8, datalen: usize) {
 	let node_signer = test_utils::TestNodeSigner::new(test_utils::privkey(42));
 	let _ = <lightning::ln::msgs::InboundOnionPayload as ReadableArgs<(
 		Option<PublicKey>,
-		&&test_utils::TestNodeSigner,
+		&test_utils::TestNodeSigner,
 	)>>::read(&mut r, (None, &&node_signer));
 }

fuzz/src/refund_deser.rs

@@ -91,6 +91,7 @@ fn build_response<T: secp256k1::Signing + secp256k1::Verification>(
 				htlc_minimum_msat: 100,
 			},
 			features: BlindedHopFeatures::empty(),
+			next_blinding_override: None,
 		},
 		node_id: pubkey(43),
 		htlc_maximum_msat: 1_000_000_000_000,

lightning/src/blinded_path/payment.rs

@@ -26,7 +26,7 @@ use crate::offers::invoice_request::InvoiceRequestFields;
 use crate::offers::offer::OfferId;
 use crate::routing::gossip::{NodeId, ReadOnlyNetworkGraph};
 use crate::sign::{EntropySource, NodeSigner, Recipient};
-use crate::util::ser::{FixedLengthReader, LengthReadableArgs, HighZeroBytesDroppedBigSize, Readable, Writeable, Writer};
+use crate::util::ser::{FixedLengthReader, LengthReadableArgs, HighZeroBytesDroppedBigSize, Readable, WithoutLength, Writeable, Writer};
 
 use core::mem;
 use core::ops::Deref;
@@ -201,6 +201,9 @@ pub struct ForwardTlvs {
 	///
 	/// [`BlindedHop::encrypted_payload`]: crate::blinded_path::BlindedHop::encrypted_payload
 	pub features: BlindedHopFeatures,
+	/// Set if this [`BlindedPaymentPath`] is concatenated to another, to indicate the
+	/// [`BlindedPaymentPath::blinding_point`] of the appended blinded path.
+	pub next_blinding_override: Option<PublicKey>,
 }
 
 /// Data to construct a [`BlindedHop`] for receiving a payment. This payload is custom to LDK and
@@ -234,7 +237,7 @@ enum BlindedPaymentTlvsRef<'a> {
 /// Parameters for relaying over a given [`BlindedHop`].
 ///
 /// [`BlindedHop`]: crate::blinded_path::BlindedHop
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub struct PaymentRelay {
 	/// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for this [`BlindedHop`].
 	pub cltv_expiry_delta: u16,
@@ -248,7 +251,7 @@ pub struct PaymentRelay {
 /// Constraints for relaying over a given [`BlindedHop`].
 ///
 /// [`BlindedHop`]: crate::blinded_path::BlindedHop
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub struct PaymentConstraints {
 	/// The maximum total CLTV that is acceptable when relaying a payment over this [`BlindedHop`].
 	pub max_cltv_expiry: u32,
@@ -341,7 +344,7 @@ impl Writeable for ForwardTlvs {
 	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		let features_opt =
 			if self.features == BlindedHopFeatures::empty() { None }
-			else { Some(&self.features) };
+			else { Some(WithoutLength(&self.features)) };
 		encode_tlv_stream!(w, {
 			(2, self.short_channel_id, required),
 			(10, self.payment_relay, required),
@@ -379,9 +382,10 @@ impl Readable for BlindedPaymentTlvs {
 		_init_and_read_tlv_stream!(r, {
 			(1, _padding, option),
 			(2, scid, option),
+			(8, next_blinding_override, option),
 			(10, payment_relay, option),
 			(12, payment_constraints, required),
-			(14, features, option),
+			(14, features, (option, encoding: (BlindedHopFeatures, WithoutLength))),
 			(65536, payment_secret, option),
 			(65537, payment_context, (default_value, PaymentContext::unknown())),
 		});
@@ -395,6 +399,7 @@ impl Readable for BlindedPaymentTlvs {
 				short_channel_id,
 				payment_relay: payment_relay.ok_or(DecodeError::InvalidValue)?,
 				payment_constraints: payment_constraints.0.unwrap(),
+				next_blinding_override,
 				features: features.unwrap_or_else(BlindedHopFeatures::empty),
 			}))
 		} else {
@@ -602,6 +607,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 100,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value(),
@@ -618,6 +624,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 1_000,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value(),
@@ -675,6 +682,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 1,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value()
@@ -691,6 +699,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 2_000,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value()
@@ -726,6 +735,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 5_000,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value()
@@ -742,6 +752,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 2_000,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: u64::max_value()
@@ -781,6 +792,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 1,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: 5_000,
@@ -797,6 +809,7 @@ mod tests {
 					max_cltv_expiry: 0,
 					htlc_minimum_msat: 1,
 				},
+				next_blinding_override: None,
 				features: BlindedHopFeatures::empty(),
 			},
 			htlc_maximum_msat: 10_000

lightning/src/blinded_path/utils.rs

@@ -109,7 +109,7 @@ where
 }
 
 // Panics if `unblinded_tlvs` length is less than `unblinded_pks` length
-pub(super) fn construct_blinded_hops<'a, T, I1, I2>(
+pub(crate) fn construct_blinded_hops<'a, T, I1, I2>(
 	secp_ctx: &Secp256k1<T>, unblinded_pks: I1, mut unblinded_tlvs: I2, session_priv: &SecretKey
 ) -> Result<Vec<BlindedHop>, secp256k1::Error>
 where