Make BlindedPath type private.

Users should use the Blinded{Message,Payment}Path types instead.

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/message.rs

@@ -32,10 +32,10 @@ use crate::util::ser::{FixedLengthReader, LengthReadableArgs, Readable, Writeabl
 use core::mem;
 use core::ops::Deref;
 
-/// A [`BlindedPath`] to be used for sending or receiving a message, hiding the identity of the
+/// A blinded path to be used for sending or receiving a message, hiding the identity of the
 /// recipient.
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
-pub struct BlindedMessagePath(pub BlindedPath);
+pub struct BlindedMessagePath(pub(crate) BlindedPath);
 
 impl Writeable for BlindedMessagePath {
 	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {

lightning/src/blinded_path/mod.rs

@@ -37,7 +37,7 @@ pub enum NextMessageHop {
 /// Onion messages and payments can be sent and received to blinded paths, which serve to hide the
 /// identity of the recipient.
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
-pub struct BlindedPath {
+pub(crate) struct BlindedPath {
 	/// To send to a blinded path, the sender first finds a route to the unblinded
 	/// `introduction_node`, which can unblind its [`encrypted_payload`] to find out the onion
 	/// message or payment's next hop and forward it along.
@@ -53,7 +53,7 @@ pub struct BlindedPath {
 	pub blinded_hops: Vec<BlindedHop>,
 }
 
-/// The unblinded node in a [`BlindedPath`].
+/// The unblinded node in a blinded path.
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 pub enum IntroductionNode {
 	/// The node id of the introduction node.
@@ -63,8 +63,8 @@ pub enum IntroductionNode {
 	DirectedShortChannelId(Direction, u64),
 }
 
-/// The side of a channel that is the [`IntroductionNode`] in a [`BlindedPath`]. [BOLT 7] defines
-/// which nodes is which in the [`ChannelAnnouncement`] message.
+/// The side of a channel that is the [`IntroductionNode`] in a blinded path. [BOLT 7] defines which
+/// nodes is which in the [`ChannelAnnouncement`] message.
 ///
 /// [BOLT 7]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
 /// [`ChannelAnnouncement`]: crate::ln::msgs::ChannelAnnouncement
@@ -109,9 +109,9 @@ impl Deref for EmptyNodeIdLookUp {
 /// and thus can be used to hide the identity of the recipient.
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 pub struct BlindedHop {
-	/// The blinded node id of this hop in a [`BlindedPath`].
+	/// The blinded node id of this hop in a blinded path.
 	pub blinded_node_id: PublicKey,
-	/// The encrypted payload intended for this hop in a [`BlindedPath`].
+	/// The encrypted payload intended for this hop in a blinded path.
 	// The node sending to this blinded path will later encode this payload into the onion packet for
 	// this hop.
 	pub encrypted_payload: Vec<u8>,

lightning/src/blinded_path/payment.rs

@@ -34,10 +34,10 @@ use core::ops::Deref;
 #[allow(unused_imports)]
 use crate::prelude::*;
 
-/// A [`BlindedPath`] to be used for sending or receiving a payment, hiding the identity of the
+/// A blinded path 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(crate) BlindedPath);
 
 impl Writeable for BlindedPaymentPath {
 	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
@@ -89,6 +89,17 @@ impl BlindedPaymentPath {
 	) -> Option<&'a NodeId> {
 		self.0.public_introduction_node_id(network_graph)
 	}
+
+	#[cfg(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,
+		})
+	}
 }
 
 /// An intermediate node, its outbound channel, and relay parameters.