Reduce visibility of BlindedPaymentPath inner path.

Works towards making the inner BlindedPath struct private to the module.

Author: valentinewallace

fuzz/src/router.rs

@@ -13,7 +13,7 @@ use bitcoin::script::Builder;
 use bitcoin::transaction::TxOut;
 
 use lightning::blinded_path::payment::BlindedPaymentPath;
-use lightning::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
+use lightning::blinded_path::BlindedHop;
 use lightning::chain::transaction::OutPoint;
 use lightning::ln::channel_state::{ChannelCounterparty, ChannelDetails, ChannelShutdownState};
 use lightning::ln::channelmanager;
@@ -403,11 +403,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 						}
 						(
 							payinfo,
-							BlindedPaymentPath(BlindedPath {
-								introduction_node: IntroductionNode::NodeId(hop.src_node_id),
-								blinding_point: dummy_pk,
-								blinded_hops,
-							}),
+							BlindedPaymentPath::from_raw(hop.src_node_id, dummy_pk, blinded_hops),
 						)
 					})
 					.collect();

lightning/src/blinded_path/payment.rs

@@ -37,7 +37,7 @@ use crate::prelude::*;
 /// A [`BlindedPath`] to be used for sending or receiving a payment, hiding the identity of the
 /// recipient.
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
-pub struct BlindedPaymentPath(pub BlindedPath);
+pub struct BlindedPaymentPath(pub(super) BlindedPath);
 
 impl Writeable for BlindedPaymentPath {
 	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
@@ -120,6 +120,22 @@ impl BlindedPaymentPath {
 	pub fn blinded_hops(&self) -> &[BlindedHop] {
 		&self.0.blinded_hops
 	}
+
+	#[cfg(any(test, fuzzing))]
+	pub fn from_raw(
+		introduction_node_id: PublicKey, blinding_point: PublicKey, blinded_hops: Vec<BlindedHop>
+	) -> Self {
+		Self(BlindedPath {
+			introduction_node: IntroductionNode::NodeId(introduction_node_id),
+			blinding_point,
+			blinded_hops,
+		})
+	}
+
+	#[cfg(test)]
+	pub fn clear_blinded_hops(&mut self) {
+		self.0.blinded_hops.clear()
+	}
 }
 
 /// An intermediate node, its outbound channel, and relay parameters.

lightning/src/ln/max_payment_path_len_tests.rs

@@ -11,7 +11,7 @@
 //! and/or blinded paths present.
 
 use bitcoin::secp256k1::{Secp256k1, PublicKey};
-use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
+use crate::blinded_path::BlindedHop;
 use crate::blinded_path::payment::{BlindedPaymentPath, PaymentConstraints, PaymentContext, ReceiveTlvs};
 use crate::events::{Event, MessageSendEventsProvider};
 use crate::ln::PaymentSecret;
@@ -182,8 +182,8 @@ fn one_hop_blinded_path_with_custom_tlv() {
 		sender_intended_htlc_amt_msat: MIN_FINAL_VALUE_ESTIMATE_WITH_OVERPAY,
 		total_msat: MIN_FINAL_VALUE_ESTIMATE_WITH_OVERPAY,
 		cltv_expiry_height: nodes[0].best_block_info().1 + DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
-		encrypted_tlvs: &blinded_path.1.0.blinded_hops[0].encrypted_payload,
-		intro_node_blinding_point: Some(blinded_path.1.0.blinding_point),
+		encrypted_tlvs: &blinded_path.1.blinded_hops()[0].encrypted_payload,
+		intro_node_blinding_point: Some(blinded_path.1.blinding_point()),
 		keysend_preimage: None,
 		custom_tlvs: &Vec::new()
 	}.serialized_length();
@@ -363,10 +363,9 @@ fn bolt12_invoice_too_large_blinded_paths() {
 			htlc_maximum_msat: 42_000_000,
 			features: BlindedHopFeatures::empty(),
 		},
-		BlindedPaymentPath(BlindedPath {
-			introduction_node: IntroductionNode::NodeId(PublicKey::from_slice(&[2; 33]).unwrap()),
-			blinding_point: PublicKey::from_slice(&[2; 33]).unwrap(),
-			blinded_hops: vec![
+		BlindedPaymentPath::from_raw(
+			PublicKey::from_slice(&[2; 33]).unwrap(), PublicKey::from_slice(&[2; 33]).unwrap(),
+			vec![
 				BlindedHop {
 					blinded_node_id: PublicKey::from_slice(&[2; 33]).unwrap(),
 					encrypted_payload: vec![42; 1300],
@@ -375,8 +374,8 @@ fn bolt12_invoice_too_large_blinded_paths() {
 					blinded_node_id: PublicKey::from_slice(&[2; 33]).unwrap(),
 					encrypted_payload: vec![42; 1300],
 				},
-			],
-		})
+			]
+		)
 	)]);
 
 	let offer = nodes[1].node.create_offer_builder(None).unwrap().build().unwrap();

lightning/src/ln/offers_tests.rs

@@ -585,7 +585,7 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(bob_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(bob_id));
 	}
 
 	route_bolt12_payment(david, &[charlie, bob, alice], &invoice);
@@ -666,7 +666,7 @@ fn creates_and_pays_for_refund_using_two_hop_blinded_path() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(bob_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(bob_id));
 	}
 
 	route_bolt12_payment(david, &[charlie, bob, alice], &invoice);
@@ -731,7 +731,7 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(alice_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(alice_id));
 	}
 
 	route_bolt12_payment(bob, &[alice], &invoice);
@@ -786,7 +786,7 @@ fn creates_and_pays_for_refund_using_one_hop_blinded_path() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(alice_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(alice_id));
 	}
 
 	route_bolt12_payment(bob, &[alice], &invoice);
@@ -1110,7 +1110,7 @@ fn pays_bolt12_invoice_asynchronously() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(alice_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(alice_id));
 	}
 
 	assert!(bob.node.send_payment_for_bolt12_invoice(&invoice, context.as_ref()).is_ok());
@@ -1194,7 +1194,7 @@ fn creates_offer_with_blinded_path_using_unannounced_introduction_node() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(bob_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(bob_id));
 	}
 
 	route_bolt12_payment(bob, &[alice], &invoice);
@@ -1244,7 +1244,7 @@ fn creates_refund_with_blinded_path_using_unannounced_introduction_node() {
 	assert_ne!(invoice.signing_pubkey(), alice_id);
 	assert!(!invoice.payment_paths().is_empty());
 	for (_, path) in invoice.payment_paths() {
-		assert_eq!(path.0.introduction_node, IntroductionNode::NodeId(bob_id));
+		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(bob_id));
 	}
 }
 

lightning/src/ln/onion_utils.rs

@@ -340,8 +340,8 @@ pub(crate) fn set_max_path_length(
 		.map(|(_, path)| path)
 		.max_by_key(|path| path.serialized_length())
 		.map(|largest_path| BlindedTailHopIter {
-			hops: largest_path.0.blinded_hops.iter(),
-			blinding_point: largest_path.0.blinding_point,
+			hops: largest_path.blinded_hops().iter(),
+			blinding_point: largest_path.blinding_point(),
 			final_value_msat: final_value_msat_with_overpay_buffer,
 			excess_final_cltv_expiry_delta: 0,
 		});

lightning/src/ln/outbound_payment.rs

@@ -835,10 +835,10 @@ impl OutboundPayments {
 		// Advance any blinded path where the introduction node is our node.
 		if let Ok(our_node_id) = node_signer.get_node_id(Recipient::Node) {
 			for (_, path) in payment_params.payee.blinded_route_hints_mut().iter_mut() {
-				let introduction_node_id = match path.0.introduction_node {
-					IntroductionNode::NodeId(pubkey) => pubkey,
+				let introduction_node_id = match path.introduction_node() {
+					IntroductionNode::NodeId(pubkey) => *pubkey,
 					IntroductionNode::DirectedShortChannelId(direction, scid) => {
-						match node_id_lookup.next_node_id(scid) {
+						match node_id_lookup.next_node_id(*scid) {
 							Some(next_node_id) => *direction.select_pubkey(&our_node_id, &next_node_id),
 							None => continue,
 						}

lightning/src/offers/test_utils.rs

@@ -13,7 +13,7 @@ use bitcoin::secp256k1::{Keypair, PublicKey, Secp256k1, SecretKey};
 use bitcoin::secp256k1::schnorr::Signature;
 
 use core::time::Duration;
-use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
+use crate::blinded_path::BlindedHop;
 use crate::blinded_path::payment::BlindedPaymentPath;
 use crate::sign::EntropySource;
 use crate::ln::types::PaymentHash;
@@ -69,22 +69,20 @@ pub(super) fn privkey(byte: u8) -> SecretKey {
 
 pub(crate) fn payment_paths() -> Vec<(BlindedPayInfo, BlindedPaymentPath)> {
 	let paths = vec![
-		BlindedPaymentPath(BlindedPath {
-			introduction_node: IntroductionNode::NodeId(pubkey(40)),
-			blinding_point: pubkey(41),
-			blinded_hops: vec![
+		BlindedPaymentPath::from_raw(
+			pubkey(40), pubkey(41),
+			vec![
 				BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
 				BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
-			],
-		}),
-		BlindedPaymentPath(BlindedPath {
-			introduction_node: IntroductionNode::NodeId(pubkey(40)),
-			blinding_point: pubkey(41),
-			blinded_hops: vec![
+			]
+		),
+		BlindedPaymentPath::from_raw(
+			pubkey(40), pubkey(41),
+			vec![
 				BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
 				BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
-			],
-		}),
+			]
+		),
 	];
 
 	let payinfo = vec![