Skip to content

Commit 18f18ef

Browse files
committed
Remove create_compact_blinded_paths
1. The `params` parameter now allows specifying the type of blinded path to be created, enabling a single function to handle the processing for both compact and full-length blinded paths. 2. This change renders the `create_compact_blinded_paths` function redundant, leading to its removal. 3. With this commit, the blinded path creation process is streamlined to a single function capable of creating any type of blinded path.
1 parent 2db0a82 commit 18f18ef

File tree

7 files changed

+34
-92
lines changed

7 files changed

+34
-92
lines changed

fuzz/src/chanmon_consistency.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ use bitcoin::hashes::sha256d::Hash as Sha256dHash;
3333
use bitcoin::hashes::Hash as TraitImport;
3434
use bitcoin::WPubkeyHash;
3535

36-
use lightning::blinded_path::message::{BlindedMessagePath, MessageContext};
36+
use lightning::blinded_path::message::{BlindedMessagePath, MessageContext, MessageForwardNode};
3737
use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
3838
use lightning::chain;
3939
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
@@ -144,7 +144,7 @@ impl MessageRouter for FuzzRouter {
144144

145145
fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
146146
&self, _params: BlindedPathParams, _recipient: PublicKey, _context: MessageContext,
147-
_peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>,
147+
_peers: Vec<MessageForwardNode>, _secp_ctx: &Secp256k1<T>,
148148
) -> Result<Vec<BlindedMessagePath>, ()> {
149149
unreachable!()
150150
}

fuzz/src/full_stack.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ use bitcoin::hashes::Hash as _;
3030
use bitcoin::hex::FromHex;
3131
use bitcoin::WPubkeyHash;
3232

33-
use lightning::blinded_path::message::{BlindedMessagePath, MessageContext};
33+
use lightning::blinded_path::message::{BlindedMessagePath, MessageContext, MessageForwardNode};
3434
use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
3535
use lightning::chain;
3636
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
@@ -179,7 +179,7 @@ impl MessageRouter for FuzzRouter {
179179

180180
fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
181181
&self, _params: BlindedPathParams, _recipient: PublicKey, _context: MessageContext,
182-
_peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>,
182+
_peers: Vec<MessageForwardNode>, _secp_ctx: &Secp256k1<T>,
183183
) -> Result<Vec<BlindedMessagePath>, ()> {
184184
unreachable!()
185185
}

fuzz/src/onion_message.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ use bitcoin::secp256k1::ecdsa::RecoverableSignature;
55
use bitcoin::secp256k1::schnorr;
66
use bitcoin::secp256k1::{self, PublicKey, Scalar, Secp256k1, SecretKey};
77

8-
use lightning::blinded_path::message::{BlindedMessagePath, MessageContext, OffersContext};
8+
use lightning::blinded_path::message::{
9+
BlindedMessagePath, MessageContext, MessageForwardNode, OffersContext,
10+
};
911
use lightning::blinded_path::EmptyNodeIdLookUp;
1012
use lightning::ln::features::InitFeatures;
1113
use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
@@ -97,7 +99,7 @@ impl MessageRouter for TestMessageRouter {
9799

98100
fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
99101
&self, _params: BlindedPathParams, _recipient: PublicKey, _context: MessageContext,
100-
_peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>,
102+
_peers: Vec<MessageForwardNode>, _secp_ctx: &Secp256k1<T>,
101103
) -> Result<Vec<BlindedMessagePath>, ()> {
102104
unreachable!()
103105
}

lightning/src/ln/channelmanager.rs

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ use bitcoin::secp256k1::Secp256k1;
3333
use bitcoin::{secp256k1, Sequence};
3434

3535
use crate::events::FundingInfo;
36-
use crate::blinded_path::message::{MessageContext, OffersContext};
36+
use crate::blinded_path::message::{MessageContext, MessageForwardNode, OffersContext};
3737
use crate::blinded_path::NodeIdLookUp;
3838
use crate::blinded_path::message::BlindedMessagePath;
3939
use crate::blinded_path::payment::{BlindedPaymentPath, Bolt12OfferContext, Bolt12RefundContext, PaymentConstraints, PaymentContext, ReceiveTlvs};
@@ -2499,9 +2499,7 @@ const MAX_NO_CHANNEL_PEERS: usize = 250;
24992499
/// short-lived, while anything with a greater expiration is considered long-lived.
25002500
///
25012501
/// Using [`ChannelManager::create_offer_builder`] or [`ChannelManager::create_refund_builder`],
2502-
/// will included a [`BlindedMessagePath`] created using:
2503-
/// - [`MessageRouter::create_compact_blinded_paths`] when short-lived, and
2504-
/// - [`MessageRouter::create_blinded_paths`] when long-lived.
2502+
/// will included a [`BlindedMessagePath`] created using [`MessageRouter::create_blinded_paths`].
25052503
///
25062504
/// Using compact [`BlindedMessagePath`]s may provide better privacy as the [`MessageRouter`] could select
25072505
/// more hops. However, since they use short channel ids instead of pubkeys, they are more likely to
@@ -9384,7 +9382,23 @@ where
93849382
.map(|(node_id, peer_state)| (node_id, peer_state.lock().unwrap()))
93859383
.filter(|(_, peer)| peer.is_connected)
93869384
.filter(|(_, peer)| peer.latest_features.supports_onion_messages())
9387-
.map(|(node_id, _)| *node_id)
9385+
.map(|(node_id, peer)| {
9386+
if params.is_compact {
9387+
MessageForwardNode {
9388+
node_id: *node_id,
9389+
short_channel_id: peer.channel_by_id
9390+
.iter()
9391+
.filter(|(_, channel)| channel.context().is_usable())
9392+
.min_by_key(|(_, channel)| channel.context().channel_creation_height)
9393+
.and_then(|(_, channel)| channel.context().get_short_channel_id()),
9394+
}
9395+
} else {
9396+
MessageForwardNode {
9397+
node_id: *node_id,
9398+
short_channel_id: None,
9399+
}
9400+
}
9401+
})
93889402
.collect::<Vec<_>>();
93899403

93909404
self.router

lightning/src/onion_message/messenger.rs

Lines changed: 4 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ for OnionMessenger<ES, NS, L, NL, MR, OMH, APH, CMH> where
175175
/// # })
176176
/// # }
177177
/// # fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
178-
/// # &self, _params: BlindedPathParams, _recipient: PublicKey, _context: MessageContext, _peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>
178+
/// # &self, _params: BlindedPathParams, _recipient: PublicKey, _context: MessageContext, _peers: Vec<MessageForwardNode>, _secp_ctx: &Secp256k1<T>
179179
/// # ) -> Result<Vec<BlindedMessagePath>, ()> {
180180
/// # unreachable!()
181181
/// # }
@@ -475,36 +475,8 @@ pub trait MessageRouter {
475475
fn create_blinded_paths<
476476
T: secp256k1::Signing + secp256k1::Verification
477477
>(
478-
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
478+
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
479479
) -> Result<Vec<BlindedMessagePath>, ()>;
480-
481-
/// Creates compact [`BlindedMessagePath`]s to the `recipient` node. The nodes in `peers` are
482-
/// assumed to be direct peers with the `recipient`.
483-
///
484-
/// Compact blinded paths use short channel ids instead of pubkeys for a smaller serialization,
485-
/// which is beneficial when a QR code is used to transport the data. The SCID is passed using
486-
/// a [`MessageForwardNode`] but may be `None` for graceful degradation.
487-
///
488-
/// Implementations using additional intermediate nodes are responsible for using a
489-
/// [`MessageForwardNode`] with `Some` short channel id, if possible. Similarly, implementations
490-
/// should call [`BlindedMessagePath::use_compact_introduction_node`].
491-
///
492-
/// The provided implementation simply delegates to [`MessageRouter::create_blinded_paths`],
493-
/// ignoring the short channel ids.
494-
fn create_compact_blinded_paths<
495-
T: secp256k1::Signing + secp256k1::Verification
496-
>(
497-
&self, recipient: PublicKey, context: MessageContext,
498-
peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
499-
) -> Result<Vec<BlindedMessagePath>, ()> {
500-
let peers = peers
501-
.into_iter()
502-
.map(|MessageForwardNode { node_id, short_channel_id: _ }| node_id)
503-
.collect();
504-
505-
let params = BlindedPathParams::new(true);
506-
self.create_blinded_paths(params, recipient, context, peers, secp_ctx)
507-
}
508480
}
509481

510482
/// A [`MessageRouter`] that can only route to a directly connected [`Destination`].
@@ -638,21 +610,8 @@ where
638610
T: secp256k1::Signing + secp256k1::Verification
639611
>(
640612
params: BlindedPathParams, network_graph: &G, recipient: PublicKey, context: MessageContext,
641-
peers: Vec<PublicKey>, entropy_source: &ES, secp_ctx: &Secp256k1<T>,
642-
) -> Result<Vec<BlindedMessagePath>, ()> {
643-
let peers = peers
644-
.into_iter()
645-
.map(|node_id| MessageForwardNode { node_id, short_channel_id: None });
646-
Self::create_blinded_paths_from_iter(params, network_graph, recipient, context, peers.into_iter(), entropy_source, secp_ctx)
647-
}
648-
649-
pub(crate) fn create_compact_blinded_paths<
650-
T: secp256k1::Signing + secp256k1::Verification
651-
>(
652-
network_graph: &G, recipient: PublicKey, context: MessageContext,
653613
peers: Vec<MessageForwardNode>, entropy_source: &ES, secp_ctx: &Secp256k1<T>,
654614
) -> Result<Vec<BlindedMessagePath>, ()> {
655-
let params = BlindedPathParams::new(true);
656615
Self::create_blinded_paths_from_iter(params, network_graph, recipient, context, peers.into_iter(), entropy_source, secp_ctx)
657616
}
658617
}
@@ -671,19 +630,10 @@ where
671630
fn create_blinded_paths<
672631
T: secp256k1::Signing + secp256k1::Verification
673632
>(
674-
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
633+
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
675634
) -> Result<Vec<BlindedMessagePath>, ()> {
676635
Self::create_blinded_paths(params, &self.network_graph, recipient, context, peers, &self.entropy_source, secp_ctx)
677636
}
678-
679-
fn create_compact_blinded_paths<
680-
T: secp256k1::Signing + secp256k1::Verification
681-
>(
682-
&self, recipient: PublicKey, context: MessageContext, peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
683-
) -> Result<Vec<BlindedMessagePath>, ()> {
684-
Self::create_compact_blinded_paths(&self.network_graph, recipient, context, peers, &self.entropy_source, secp_ctx)
685-
}
686-
687637
}
688638

689639
/// A path for sending an [`OnionMessage`].
@@ -1275,7 +1225,7 @@ where
12751225
let peers = self.message_recipients.lock().unwrap()
12761226
.iter()
12771227
.filter(|(_, peer)| matches!(peer, OnionMessageRecipient::ConnectedPeer(_)))
1278-
.map(|(node_id, _ )| *node_id)
1228+
.map(|(node_id, _)| MessageForwardNode { node_id: *node_id, short_channel_id: None })
12791229
.collect::<Vec<_>>();
12801230

12811231
self.message_router

lightning/src/routing/router.rs

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -197,18 +197,10 @@ impl< G: Deref<Target = NetworkGraph<L>>, L: Deref, ES: Deref, S: Deref, SP: Siz
197197
fn create_blinded_paths<
198198
T: secp256k1::Signing + secp256k1::Verification
199199
> (
200-
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
200+
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext, peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
201201
) -> Result<Vec<BlindedMessagePath>, ()> {
202202
DefaultMessageRouter::create_blinded_paths(params, &self.network_graph, recipient, context, peers, &self.entropy_source, secp_ctx)
203203
}
204-
205-
fn create_compact_blinded_paths<
206-
T: secp256k1::Signing + secp256k1::Verification
207-
> (
208-
&self, recipient: PublicKey, context: MessageContext, peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
209-
) -> Result<Vec<BlindedMessagePath>, ()> {
210-
DefaultMessageRouter::create_compact_blinded_paths(&self.network_graph, recipient, context, peers, &self.entropy_source, secp_ctx)
211-
}
212204
}
213205

214206
/// A trait defining behavior for routing a payment.

lightning/src/util/test_utils.rs

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -277,18 +277,9 @@ impl<'a> MessageRouter for TestRouter<'a> {
277277
T: secp256k1::Signing + secp256k1::Verification
278278
>(
279279
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext,
280-
peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
281-
) -> Result<Vec<BlindedMessagePath>, ()> {
282-
self.router.create_blinded_paths(params, recipient, context, peers, secp_ctx)
283-
}
284-
285-
fn create_compact_blinded_paths<
286-
T: secp256k1::Signing + secp256k1::Verification
287-
>(
288-
&self, recipient: PublicKey, context: MessageContext,
289280
peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
290281
) -> Result<Vec<BlindedMessagePath>, ()> {
291-
self.router.create_compact_blinded_paths(recipient, context, peers, secp_ctx)
282+
self.router.create_blinded_paths(params, recipient, context, peers, secp_ctx)
292283
}
293284
}
294285

@@ -320,16 +311,9 @@ impl<'a> MessageRouter for TestMessageRouter<'a> {
320311

321312
fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
322313
&self, params: BlindedPathParams, recipient: PublicKey, context: MessageContext,
323-
peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
324-
) -> Result<Vec<BlindedMessagePath>, ()> {
325-
self.inner.create_blinded_paths(params, recipient, context, peers, secp_ctx)
326-
}
327-
328-
fn create_compact_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
329-
&self, recipient: PublicKey, context: MessageContext,
330314
peers: Vec<MessageForwardNode>, secp_ctx: &Secp256k1<T>,
331315
) -> Result<Vec<BlindedMessagePath>, ()> {
332-
self.inner.create_compact_blinded_paths(recipient, context, peers, secp_ctx)
316+
self.inner.create_blinded_paths(params, recipient, context, peers, secp_ctx)
333317
}
334318
}
335319

0 commit comments

Comments
 (0)