Skip to content

Commit caa836e

Browse files
valentinewallacevalentinewallace
committed
Add BlindedPaymentPath type, to disambiguate from message paths.
Next up, we'll add a BlindedMessagePath type so the API is clear which type of path is expected in each context.
1 parent 33e6995 commit caa836e

21 files changed

+243
-231
lines changed

‎fuzz/src/chanmon_consistency.rs

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

3636
use lightning::blinded_path::message::MessageContext;
37-
use lightning::blinded_path::payment::ReceiveTlvs;
37+
use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
3838
use lightning::blinded_path::BlindedPath;
3939
use lightning::chain;
4040
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
@@ -127,7 +127,7 @@ impl Router for FuzzRouter {
127127
fn create_blinded_payment_paths<T: secp256k1::Signing + secp256k1::Verification>(
128128
&self, _recipient: PublicKey, _first_hops: Vec<ChannelDetails>, _tlvs: ReceiveTlvs,
129129
_amount_msats: u64, _secp_ctx: &Secp256k1<T>,
130-
) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
130+
) -> Result<Vec<(BlindedPayInfo, BlindedPaymentPath)>, ()> {
131131
unreachable!()
132132
}
133133
}

‎fuzz/src/full_stack.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use bitcoin::hex::FromHex;
3131
use bitcoin::WPubkeyHash;
3232

3333
use lightning::blinded_path::message::MessageContext;
34-
use lightning::blinded_path::payment::ReceiveTlvs;
34+
use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
3535
use lightning::blinded_path::BlindedPath;
3636
use lightning::chain;
3737
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
@@ -164,7 +164,7 @@ impl Router for FuzzRouter {
164164
fn create_blinded_payment_paths<T: secp256k1::Signing + secp256k1::Verification>(
165165
&self, _recipient: PublicKey, _first_hops: Vec<ChannelDetails>, _tlvs: ReceiveTlvs,
166166
_amount_msats: u64, _secp_ctx: &Secp256k1<T>,
167-
) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
167+
) -> Result<Vec<(BlindedPayInfo, BlindedPaymentPath)>, ()> {
168168
unreachable!()
169169
}
170170
}

‎fuzz/src/invoice_request_deser.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ use crate::utils::test_logger;
1111
use bitcoin::secp256k1::{self, Keypair, Parity, PublicKey, Secp256k1, SecretKey};
1212
use core::convert::TryFrom;
1313
use lightning::blinded_path::payment::{
14-
Bolt12OfferContext, ForwardNode, ForwardTlvs, PaymentConstraints, PaymentContext, PaymentRelay,
15-
ReceiveTlvs,
14+
BlindedPaymentPath, Bolt12OfferContext, ForwardNode, ForwardTlvs, PaymentConstraints,
15+
PaymentContext, PaymentRelay, ReceiveTlvs,
1616
};
17-
use lightning::blinded_path::BlindedPath;
1817
use lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA;
1918
use lightning::ln::features::BlindedHopFeatures;
2019
use lightning::ln::types::PaymentSecret;
@@ -118,7 +117,7 @@ fn build_response<T: secp256k1::Signing + secp256k1::Verification>(
118117
node_id: pubkey(43),
119118
htlc_maximum_msat: 1_000_000_000_000,
120119
}];
121-
let payment_path = BlindedPath::new_for_payment(
120+
let payment_path = BlindedPaymentPath::new(
122121
&intermediate_nodes,
123122
pubkey(42),
124123
payee_tlvs,

‎fuzz/src/refund_deser.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ use crate::utils::test_logger;
1111
use bitcoin::secp256k1::{self, Keypair, PublicKey, Secp256k1, SecretKey};
1212
use core::convert::TryFrom;
1313
use lightning::blinded_path::payment::{
14-
Bolt12RefundContext, ForwardNode, ForwardTlvs, PaymentConstraints, PaymentContext,
15-
PaymentRelay, ReceiveTlvs,
14+
BlindedPaymentPath, Bolt12RefundContext, ForwardNode, ForwardTlvs, PaymentConstraints,
15+
PaymentContext, PaymentRelay, ReceiveTlvs,
1616
};
17-
use lightning::blinded_path::BlindedPath;
1817
use lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA;
1918
use lightning::ln::features::BlindedHopFeatures;
2019
use lightning::ln::types::PaymentSecret;
@@ -96,7 +95,7 @@ fn build_response<T: secp256k1::Signing + secp256k1::Verification>(
9695
node_id: pubkey(43),
9796
htlc_maximum_msat: 1_000_000_000_000,
9897
}];
99-
let payment_path = BlindedPath::new_for_payment(
98+
let payment_path = BlindedPaymentPath::new(
10099
&intermediate_nodes,
101100
pubkey(42),
102101
payee_tlvs,

‎fuzz/src/router.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ use bitcoin::constants::ChainHash;
1212
use bitcoin::script::Builder;
1313
use bitcoin::transaction::TxOut;
1414

15+
use lightning::blinded_path::payment::BlindedPaymentPath;
1516
use lightning::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
1617
use lightning::chain::transaction::OutPoint;
1718
use lightning::ln::channel_state::{ChannelCounterparty, ChannelDetails, ChannelShutdownState};
@@ -380,7 +381,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
380381
let mut last_hops_unblinded = Vec::new();
381382
last_hops!(last_hops_unblinded);
382383
let dummy_pk = PublicKey::from_slice(&[2; 33]).unwrap();
383-
let last_hops: Vec<(BlindedPayInfo, BlindedPath)> = last_hops_unblinded
384+
let last_hops: Vec<(BlindedPayInfo, BlindedPaymentPath)> = last_hops_unblinded
384385
.into_iter()
385386
.map(|hint| {
386387
let hop = &hint.0[0];
@@ -402,11 +403,11 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
402403
}
403404
(
404405
payinfo,
405-
BlindedPath {
406+
BlindedPaymentPath(BlindedPath {
406407
introduction_node: IntroductionNode::NodeId(hop.src_node_id),
407408
blinding_point: dummy_pk,
408409
blinded_hops,
409-
},
410+
}),
410411
)
411412
})
412413
.collect();

‎lightning/src/blinded_path/mod.rs

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ use message::MessageContext;
1818
use core::ops::Deref;
1919

2020
use crate::ln::msgs::DecodeError;
21-
use crate::offers::invoice::BlindedPayInfo;
2221
use crate::routing::gossip::{NodeId, ReadOnlyNetworkGraph};
2322
use crate::sign::EntropySource;
2423
use crate::util::ser::{Readable, Writeable, Writer};
@@ -154,52 +153,6 @@ impl BlindedPath {
154153
})
155154
}
156155

157-
/// Create a one-hop blinded path for a payment.
158-
pub fn one_hop_for_payment<ES: Deref, T: secp256k1::Signing + secp256k1::Verification>(
159-
payee_node_id: PublicKey, payee_tlvs: payment::ReceiveTlvs, min_final_cltv_expiry_delta: u16,
160-
entropy_source: ES, secp_ctx: &Secp256k1<T>
161-
) -> Result<(BlindedPayInfo, Self), ()> where ES::Target: EntropySource {
162-
// This value is not considered in pathfinding for 1-hop blinded paths, because it's intended to
163-
// be in relation to a specific channel.
164-
let htlc_maximum_msat = u64::max_value();
165-
Self::new_for_payment(
166-
&[], payee_node_id, payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta,
167-
entropy_source, secp_ctx
168-
)
169-
}
170-
171-
/// Create a blinded path for a payment, to be forwarded along `intermediate_nodes`.
172-
///
173-
/// Errors if:
174-
/// * a provided node id is invalid
175-
/// * [`BlindedPayInfo`] calculation results in an integer overflow
176-
/// * any unknown features are required in the provided [`ForwardTlvs`]
177-
///
178-
/// [`ForwardTlvs`]: crate::blinded_path::payment::ForwardTlvs
179-
// TODO: make all payloads the same size with padding + add dummy hops
180-
pub fn new_for_payment<ES: Deref, T: secp256k1::Signing + secp256k1::Verification>(
181-
intermediate_nodes: &[payment::ForwardNode], payee_node_id: PublicKey,
182-
payee_tlvs: payment::ReceiveTlvs, htlc_maximum_msat: u64, min_final_cltv_expiry_delta: u16,
183-
entropy_source: ES, secp_ctx: &Secp256k1<T>
184-
) -> Result<(BlindedPayInfo, Self), ()> where ES::Target: EntropySource {
185-
let introduction_node = IntroductionNode::NodeId(
186-
intermediate_nodes.first().map_or(payee_node_id, |n| n.node_id)
187-
);
188-
let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
189-
let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
190-
191-
let blinded_payinfo = payment::compute_payinfo(
192-
intermediate_nodes, &payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta
193-
)?;
194-
Ok((blinded_payinfo, BlindedPath {
195-
introduction_node,
196-
blinding_point: PublicKey::from_secret_key(secp_ctx, &blinding_secret),
197-
blinded_hops: payment::blinded_hops(
198-
secp_ctx, intermediate_nodes, payee_node_id, payee_tlvs, &blinding_secret
199-
).map_err(|_| ())?,
200-
}))
201-
}
202-
203156
/// Returns the introduction [`NodeId`] of the blinded path, if it is publicly reachable (i.e.,
204157
/// it is found in the network graph).
205158
pub fn public_introduction_node_id<'a>(

‎lightning/src/blinded_path/payment.rs

Lines changed: 74 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@
77
// You may not use this file except in accordance with one or both of these
88
// licenses.
99

10-
//! Data structures and methods for constructing [`BlindedPath`]s to send a payment over.
11-
//!
12-
//! [`BlindedPath`]: crate::blinded_path::BlindedPath
10+
//! Data structures and methods for constructing [`BlindedPaymentPath`]s to send a payment over.
1311
1412
use bitcoin::secp256k1::{self, PublicKey, Secp256k1, SecretKey};
1513

@@ -26,7 +24,7 @@ use crate::ln::onion_utils;
2624
use crate::offers::invoice::BlindedPayInfo;
2725
use crate::offers::invoice_request::InvoiceRequestFields;
2826
use crate::offers::offer::OfferId;
29-
use crate::sign::{NodeSigner, Recipient};
27+
use crate::sign::{EntropySource, NodeSigner, Recipient};
3028
use crate::util::ser::{FixedLengthReader, LengthReadableArgs, HighZeroBytesDroppedBigSize, Readable, Writeable, Writer};
3129

3230
use core::mem;
@@ -35,6 +33,69 @@ use core::ops::Deref;
3533
#[allow(unused_imports)]
3634
use crate::prelude::*;
3735

36+
/// A [`BlindedPath`] to be used for sending or receiving a payment, hiding the identity of the
37+
/// recipient.
38+
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
39+
pub struct BlindedPaymentPath(pub BlindedPath);
40+
41+
impl Writeable for BlindedPaymentPath {
42+
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
43+
self.0.write(w)
44+
}
45+
}
46+
47+
impl Readable for BlindedPaymentPath {
48+
fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
49+
Ok(Self(BlindedPath::read(r)?))
50+
}
51+
}
52+
53+
impl BlindedPaymentPath {
54+
/// Create a one-hop blinded path for a payment.
55+
pub fn one_hop<ES: Deref, T: secp256k1::Signing + secp256k1::Verification>(
56+
payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs, min_final_cltv_expiry_delta: u16,
57+
entropy_source: ES, secp_ctx: &Secp256k1<T>
58+
) -> Result<(BlindedPayInfo, Self), ()> where ES::Target: EntropySource {
59+
// This value is not considered in pathfinding for 1-hop blinded paths, because it's intended to
60+
// be in relation to a specific channel.
61+
let htlc_maximum_msat = u64::max_value();
62+
Self::new(
63+
&[], payee_node_id, payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta,
64+
entropy_source, secp_ctx
65+
)
66+
}
67+
68+
/// Create a blinded path for a payment, to be forwarded along `intermediate_nodes`.
69+
///
70+
/// Errors if:
71+
/// * a provided node id is invalid
72+
/// * [`BlindedPayInfo`] calculation results in an integer overflow
73+
/// * any unknown features are required in the provided [`ForwardTlvs`]
74+
// TODO: make all payloads the same size with padding + add dummy hops
75+
pub fn new<ES: Deref, T: secp256k1::Signing + secp256k1::Verification>(
76+
intermediate_nodes: &[ForwardNode], payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs,
77+
htlc_maximum_msat: u64, min_final_cltv_expiry_delta: u16, entropy_source: ES,
78+
secp_ctx: &Secp256k1<T>
79+
) -> Result<(BlindedPayInfo, Self), ()> where ES::Target: EntropySource {
80+
let introduction_node = IntroductionNode::NodeId(
81+
intermediate_nodes.first().map_or(payee_node_id, |n| n.node_id)
82+
);
83+
let blinding_secret_bytes = entropy_source.get_secure_random_bytes();
84+
let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
85+
86+
let blinded_payinfo = compute_payinfo(
87+
intermediate_nodes, &payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta
88+
)?;
89+
Ok((blinded_payinfo, Self(BlindedPath {
90+
introduction_node,
91+
blinding_point: PublicKey::from_secret_key(secp_ctx, &blinding_secret),
92+
blinded_hops: blinded_hops(
93+
secp_ctx, intermediate_nodes, payee_node_id, payee_tlvs, &blinding_secret
94+
).map_err(|_| ())?,
95+
})))
96+
}
97+
}
98+
3899
/// An intermediate node, its outbound channel, and relay parameters.
39100
#[derive(Clone, Debug)]
40101
pub struct ForwardNode {
@@ -117,10 +178,9 @@ pub struct PaymentConstraints {
117178
pub htlc_minimum_msat: u64,
118179
}
119180

120-
/// The context of an inbound payment, which is included in a [`BlindedPath`] via [`ReceiveTlvs`]
121-
/// and surfaced in [`PaymentPurpose`].
181+
/// The context of an inbound payment, which is included in a [`BlindedPaymentPath`] via
182+
/// [`ReceiveTlvs`] and surfaced in [`PaymentPurpose`].
122183
///
123-
/// [`BlindedPath`]: crate::blinded_path::BlindedPath
124184
/// [`PaymentPurpose`]: crate::events::PaymentPurpose
125185
#[derive(Clone, Debug, Eq, PartialEq)]
126186
pub enum PaymentContext {
@@ -286,16 +346,16 @@ pub(super) fn blinded_hops<T: secp256k1::Signing + secp256k1::Verification>(
286346
//
287347
// Will only modify `path` when returning `Ok`.
288348
pub(crate) fn advance_path_by_one<NS: Deref, NL: Deref, T>(
289-
path: &mut BlindedPath, node_signer: &NS, node_id_lookup: &NL, secp_ctx: &Secp256k1<T>
349+
path: &mut BlindedPaymentPath, node_signer: &NS, node_id_lookup: &NL, secp_ctx: &Secp256k1<T>
290350
) -> Result<(), ()>
291351
where
292352
NS::Target: NodeSigner,
293353
NL::Target: NodeIdLookUp,
294354
T: secp256k1::Signing + secp256k1::Verification,
295355
{
296-
let control_tlvs_ss = node_signer.ecdh(Recipient::Node, &path.blinding_point, None)?;
356+
let control_tlvs_ss = node_signer.ecdh(Recipient::Node, &path.0.blinding_point, None)?;
297357
let rho = onion_utils::gen_rho_from_shared_secret(&control_tlvs_ss.secret_bytes());
298-
let encrypted_control_tlvs = &path.blinded_hops.get(0).ok_or(())?.encrypted_payload;
358+
let encrypted_control_tlvs = &path.0.blinded_hops.get(0).ok_or(())?.encrypted_payload;
299359
let mut s = Cursor::new(encrypted_control_tlvs);
300360
let mut reader = FixedLengthReader::new(&mut s, encrypted_control_tlvs.len() as u64);
301361
match ChaChaPolyReadAdapter::read(&mut reader, rho) {
@@ -307,11 +367,11 @@ where
307367
None => return Err(()),
308368
};
309369
let mut new_blinding_point = onion_utils::next_hop_pubkey(
310-
secp_ctx, path.blinding_point, control_tlvs_ss.as_ref()
370+
secp_ctx, path.0.blinding_point, control_tlvs_ss.as_ref()
311371
).map_err(|_| ())?;
312-
mem::swap(&mut path.blinding_point, &mut new_blinding_point);
313-
path.introduction_node = IntroductionNode::NodeId(next_node_id);
314-
path.blinded_hops.remove(0);
372+
mem::swap(&mut path.0.blinding_point, &mut new_blinding_point);
373+
path.0.introduction_node = IntroductionNode::NodeId(next_node_id);
374+
path.0.blinded_hops.remove(0);
315375
Ok(())
316376
},
317377
_ => Err(())

‎lightning/src/ln/blinded_payment_tests.rs

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
// licenses.
99

1010
use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11-
use crate::blinded_path::BlindedPath;
12-
use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, PaymentConstraints, PaymentContext, PaymentRelay, ReceiveTlvs};
11+
use crate::blinded_path::payment::{BlindedPaymentPath, ForwardNode, ForwardTlvs, PaymentConstraints, PaymentContext, PaymentRelay, ReceiveTlvs};
1312
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentFailureReason};
1413
use crate::ln::types::PaymentSecret;
1514
use crate::ln::channelmanager;
@@ -31,7 +30,7 @@ fn blinded_payment_path(
3130
payment_secret: PaymentSecret, intro_node_min_htlc: u64, intro_node_max_htlc: u64,
3231
node_ids: Vec<PublicKey>, channel_upds: &[&msgs::UnsignedChannelUpdate],
3332
keys_manager: &test_utils::TestKeysInterface
34-
) -> (BlindedPayInfo, BlindedPath) {
33+
) -> (BlindedPayInfo, BlindedPaymentPath) {
3534
let mut intermediate_nodes = Vec::new();
3635
let mut intro_node_min_htlc_opt = Some(intro_node_min_htlc);
3736
let mut intro_node_max_htlc_opt = Some(intro_node_max_htlc);
@@ -66,7 +65,7 @@ fn blinded_payment_path(
6665
payment_context: PaymentContext::unknown(),
6766
};
6867
let mut secp_ctx = Secp256k1::new();
69-
BlindedPath::new_for_payment(
68+
BlindedPaymentPath::new(
7069
&intermediate_nodes[..], *node_ids.last().unwrap(), payee_tlvs,
7170
intro_node_max_htlc_opt.unwrap_or_else(|| channel_upds.last().unwrap().htlc_maximum_msat),
7271
TEST_FINAL_CLTV as u16, keys_manager, &secp_ctx
@@ -112,8 +111,8 @@ fn do_one_hop_blinded_path(success: bool) {
112111
payment_context: PaymentContext::unknown(),
113112
};
114113
let mut secp_ctx = Secp256k1::new();
115-
let blinded_path = BlindedPath::one_hop_for_payment(
116-
nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
114+
let blinded_path = BlindedPaymentPath::new(
115+
&[], nodes[1].node.get_our_node_id(), payee_tlvs, u64::MAX, TEST_FINAL_CLTV as u16,
117116
&chanmon_cfgs[1].keys_manager, &secp_ctx
118117
).unwrap();
119118

@@ -155,8 +154,8 @@ fn mpp_to_one_hop_blinded_path() {
155154
},
156155
payment_context: PaymentContext::unknown(),
157156
};
158-
let blinded_path = BlindedPath::one_hop_for_payment(
159-
nodes[3].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
157+
let blinded_path = BlindedPaymentPath::new(
158+
&[], nodes[3].node.get_our_node_id(), payee_tlvs, u64::MAX, TEST_FINAL_CLTV as u16,
160159
&chanmon_cfgs[3].keys_manager, &secp_ctx
161160
).unwrap();
162161

@@ -1301,8 +1300,8 @@ fn custom_tlvs_to_blinded_path() {
13011300
payment_context: PaymentContext::unknown(),
13021301
};
13031302
let mut secp_ctx = Secp256k1::new();
1304-
let blinded_path = BlindedPath::one_hop_for_payment(
1305-
nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
1303+
let blinded_path = BlindedPaymentPath::new(
1304+
&[], nodes[1].node.get_our_node_id(), payee_tlvs, u64::MAX, TEST_FINAL_CLTV as u16,
13061305
&chanmon_cfgs[1].keys_manager, &secp_ctx
13071306
).unwrap();
13081307

0 commit comments

Comments
 (0)