1 //! Convenient utilities to create an invoice.
3 use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
5 use crate::{prelude::*, Description, InvoiceDescription, Sha256};
7 use bitcoin_hashes::Hash;
9 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
10 use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
11 use lightning::ln::{PaymentHash, PaymentSecret};
12 use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, MIN_FINAL_CLTV_EXPIRY_DELTA};
13 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
14 use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
15 use lightning::routing::gossip::RoutingFees;
16 use lightning::routing::router::{RouteHint, RouteHintHop, Router};
17 use lightning::util::logger::Logger;
18 use secp256k1::PublicKey;
20 use core::time::Duration;
22 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
23 /// See [`PhantomKeysManager`] for more information on phantom node payments.
25 /// `phantom_route_hints` parameter:
26 /// * Contains channel info for all nodes participating in the phantom invoice
27 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
28 /// participating node
29 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
30 /// updated when a channel becomes disabled or closes
31 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
32 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
35 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
36 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
37 /// If `None` is provided for `payment_hash`, then one will be created.
39 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
40 /// in excess of the current time.
42 /// `duration_since_epoch` is the current time since epoch in seconds.
44 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
45 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
46 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
47 /// confirmations during routing.
49 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
50 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
53 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
54 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
55 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
56 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
57 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
58 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
60 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
61 /// available and the current time is supplied by the caller.
62 pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
63 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
64 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
65 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
66 ) -> Result<Invoice, SignOrCreationError<()>>
68 ES::Target: EntropySource,
69 NS::Target: NodeSigner,
72 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
73 let description = InvoiceDescription::Direct(&description,);
74 _create_phantom_invoice::<ES, NS, L>(
75 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
76 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
80 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
81 /// See [`PhantomKeysManager`] for more information on phantom node payments.
83 /// `phantom_route_hints` parameter:
84 /// * Contains channel info for all nodes participating in the phantom invoice
85 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
86 /// participating node
87 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
88 /// updated when a channel becomes disabled or closes
89 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
90 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
93 /// `description_hash` is a SHA-256 hash of the description text
95 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
96 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
97 /// If `None` is provided for `payment_hash`, then one will be created.
99 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
100 /// in excess of the current time.
102 /// `duration_since_epoch` is the current time since epoch in seconds.
104 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
105 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
108 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
109 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
110 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
111 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
112 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
114 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
115 /// available and the current time is supplied by the caller.
116 pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
117 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
118 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
119 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
120 ) -> Result<Invoice, SignOrCreationError<()>>
122 ES::Target: EntropySource,
123 NS::Target: NodeSigner,
126 _create_phantom_invoice::<ES, NS, L>(
127 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
128 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
129 min_final_cltv_expiry_delta, duration_since_epoch,
133 fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
134 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
135 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
136 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
137 ) -> Result<Invoice, SignOrCreationError<()>>
139 ES::Target: EntropySource,
140 NS::Target: NodeSigner,
144 if phantom_route_hints.is_empty() {
145 return Err(SignOrCreationError::CreationError(
146 CreationError::MissingRouteHints,
150 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
151 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
154 let invoice = match description {
155 InvoiceDescription::Direct(description) => {
156 InvoiceBuilder::new(network).description(description.0.clone())
158 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
161 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
162 let keys = ExpandedKey::new(&node_signer.get_inbound_payment_key_material());
163 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
164 let payment_secret = create_from_hash(
168 invoice_expiry_delta_secs,
171 min_final_cltv_expiry_delta,
173 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
174 (payment_hash, payment_secret)
179 invoice_expiry_delta_secs,
183 min_final_cltv_expiry_delta,
185 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
188 log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
189 phantom_route_hints.len(), log_bytes!(payment_hash.0));
191 let mut invoice = invoice
192 .duration_since_epoch(duration_since_epoch)
193 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
194 .payment_secret(payment_secret)
195 .min_final_cltv_expiry_delta(
196 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
197 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
198 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
199 if let Some(amt) = amt_msat {
200 invoice = invoice.amount_milli_satoshis(amt);
203 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
204 log_trace!(logger, "Generating phantom route hints for node {}",
205 log_pubkey!(real_node_pubkey));
206 let mut route_hints = filter_channels(channels, amt_msat, &logger);
208 // If we have any public channel, the route hints from `filter_channels` will be empty.
209 // In that case we create a RouteHint on which we will push a single hop with the phantom
210 // route into the invoice, and let the sender find the path to the `real_node_pubkey`
211 // node by looking at our public channels.
212 if route_hints.is_empty() {
213 route_hints.push(RouteHint(vec![]))
215 for mut route_hint in route_hints {
216 route_hint.0.push(RouteHintHop {
217 src_node_id: real_node_pubkey,
218 short_channel_id: phantom_scid,
221 proportional_millionths: 0,
223 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
224 htlc_minimum_msat: None,
225 htlc_maximum_msat: None,});
226 invoice = invoice.private_route(route_hint.clone());
230 let raw_invoice = match invoice.build_raw() {
232 Err(e) => return Err(SignOrCreationError::CreationError(e))
234 let hrp_str = raw_invoice.hrp.to_string();
235 let hrp_bytes = hrp_str.as_bytes();
236 let data_without_signature = raw_invoice.data.to_base32();
237 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
238 match signed_raw_invoice {
239 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
240 Err(e) => Err(SignOrCreationError::SignError(e))
244 #[cfg(feature = "std")]
245 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
246 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
247 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
248 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
249 /// that the payment secret is valid when the invoice is paid.
251 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
252 /// in excess of the current time.
254 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
255 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
256 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
257 /// confirmations during routing.
259 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
260 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
261 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
262 network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32,
263 min_final_cltv_expiry_delta: Option<u16>,
264 ) -> Result<Invoice, SignOrCreationError<()>>
266 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
267 T::Target: BroadcasterInterface,
268 ES::Target: EntropySource,
269 NS::Target: NodeSigner,
270 SP::Target: SignerProvider,
271 F::Target: FeeEstimator,
275 use std::time::SystemTime;
276 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
277 .expect("for the foreseeable future this shouldn't happen");
278 create_invoice_from_channelmanager_and_duration_since_epoch(
279 channelmanager, node_signer, logger, network, amt_msat,
280 description, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
284 #[cfg(feature = "std")]
285 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
286 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
287 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
288 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
289 /// that the payment secret is valid when the invoice is paid.
290 /// Use this variant if you want to pass the `description_hash` to the invoice.
292 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
293 /// in excess of the current time.
295 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
296 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
297 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
298 /// confirmations during routing.
300 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
301 pub fn create_invoice_from_channelmanager_with_description_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
302 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
303 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
304 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
305 ) -> Result<Invoice, SignOrCreationError<()>>
307 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
308 T::Target: BroadcasterInterface,
309 ES::Target: EntropySource,
310 NS::Target: NodeSigner,
311 SP::Target: SignerProvider,
312 F::Target: FeeEstimator,
316 use std::time::SystemTime;
318 let duration = SystemTime::now()
319 .duration_since(SystemTime::UNIX_EPOCH)
320 .expect("for the foreseeable future this shouldn't happen");
322 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
323 channelmanager, node_signer, logger, network, amt_msat,
324 description_hash, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
328 /// See [`create_invoice_from_channelmanager_with_description_hash`]
329 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
330 /// available and the current time is supplied by the caller.
331 pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
332 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
333 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
334 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
335 ) -> Result<Invoice, SignOrCreationError<()>>
337 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
338 T::Target: BroadcasterInterface,
339 ES::Target: EntropySource,
340 NS::Target: NodeSigner,
341 SP::Target: SignerProvider,
342 F::Target: FeeEstimator,
346 _create_invoice_from_channelmanager_and_duration_since_epoch(
347 channelmanager, node_signer, logger, network, amt_msat,
348 InvoiceDescription::Hash(&description_hash),
349 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
353 /// See [`create_invoice_from_channelmanager`]
354 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
355 /// available and the current time is supplied by the caller.
356 pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
357 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
358 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
359 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
360 ) -> Result<Invoice, SignOrCreationError<()>>
362 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
363 T::Target: BroadcasterInterface,
364 ES::Target: EntropySource,
365 NS::Target: NodeSigner,
366 SP::Target: SignerProvider,
367 F::Target: FeeEstimator,
371 _create_invoice_from_channelmanager_and_duration_since_epoch(
372 channelmanager, node_signer, logger, network, amt_msat,
373 InvoiceDescription::Direct(
374 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
376 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
380 fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
381 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
382 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
383 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
384 ) -> Result<Invoice, SignOrCreationError<()>>
386 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
387 T::Target: BroadcasterInterface,
388 ES::Target: EntropySource,
389 NS::Target: NodeSigner,
390 SP::Target: SignerProvider,
391 F::Target: FeeEstimator,
395 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
396 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
399 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
401 let (payment_hash, payment_secret) = channelmanager
402 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs, min_final_cltv_expiry_delta)
403 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
404 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
405 channelmanager, node_signer, logger, network, amt_msat, description, duration_since_epoch,
406 invoice_expiry_delta_secs, payment_hash, payment_secret, min_final_cltv_expiry_delta)
409 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
410 /// This version allows for providing a custom [`PaymentHash`] for the invoice.
411 /// This may be useful if you're building an on-chain swap or involving another protocol where
412 /// the payment hash is also involved outside the scope of lightning.
413 pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
414 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
415 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
416 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, min_final_cltv_expiry_delta: Option<u16>,
417 ) -> Result<Invoice, SignOrCreationError<()>>
419 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
420 T::Target: BroadcasterInterface,
421 ES::Target: EntropySource,
422 NS::Target: NodeSigner,
423 SP::Target: SignerProvider,
424 F::Target: FeeEstimator,
428 let payment_secret = channelmanager
429 .create_inbound_payment_for_hash(payment_hash, amt_msat, invoice_expiry_delta_secs,
430 min_final_cltv_expiry_delta)
431 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
432 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
433 channelmanager, node_signer, logger, network, amt_msat,
434 InvoiceDescription::Direct(
435 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
437 duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret,
438 min_final_cltv_expiry_delta,
442 fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
443 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
444 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription, duration_since_epoch: Duration,
445 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, payment_secret: PaymentSecret,
446 min_final_cltv_expiry_delta: Option<u16>,
447 ) -> Result<Invoice, SignOrCreationError<()>>
449 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
450 T::Target: BroadcasterInterface,
451 ES::Target: EntropySource,
452 NS::Target: NodeSigner,
453 SP::Target: SignerProvider,
454 F::Target: FeeEstimator,
458 let our_node_pubkey = channelmanager.get_our_node_id();
459 let channels = channelmanager.list_channels();
461 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
462 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
465 log_trace!(logger, "Creating invoice with payment hash {}", log_bytes!(payment_hash.0));
467 let invoice = match description {
468 InvoiceDescription::Direct(description) => {
469 InvoiceBuilder::new(network).description(description.0.clone())
471 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
474 let mut invoice = invoice
475 .duration_since_epoch(duration_since_epoch)
476 .payee_pub_key(our_node_pubkey)
477 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
478 .payment_secret(payment_secret)
480 .min_final_cltv_expiry_delta(
481 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
482 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
483 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
484 if let Some(amt) = amt_msat {
485 invoice = invoice.amount_milli_satoshis(amt);
488 let route_hints = filter_channels(channels, amt_msat, &logger);
489 for hint in route_hints {
490 invoice = invoice.private_route(hint);
493 let raw_invoice = match invoice.build_raw() {
495 Err(e) => return Err(SignOrCreationError::CreationError(e))
497 let hrp_str = raw_invoice.hrp.to_string();
498 let hrp_bytes = hrp_str.as_bytes();
499 let data_without_signature = raw_invoice.data.to_base32();
500 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
501 match signed_raw_invoice {
502 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
503 Err(e) => Err(SignOrCreationError::SignError(e))
507 /// Filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
510 /// The filtering is based on the following criteria:
511 /// * Only one channel per counterparty node
512 /// * Always select the channel with the highest inbound capacity per counterparty node
513 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
514 /// `is_usable` (i.e. the peer is connected).
515 /// * If any public channel exists, only public [`RouteHint`]s will be returned.
516 /// * If any public, announced, channel exists (i.e. a channel with 7+ confs, to ensure the
517 /// announcement has had a chance to propagate), no [`RouteHint`]s will be returned, as the
518 /// sender is expected to find the path by looking at the public channels instead.
519 fn filter_channels<L: Deref>(
520 channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>, logger: &L
521 ) -> Vec<RouteHint> where L::Target: Logger {
522 let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
523 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
524 let mut min_capacity_channel_exists = false;
525 let mut online_channel_exists = false;
526 let mut online_min_capacity_channel_exists = false;
527 let mut has_pub_unconf_chan = false;
529 log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
530 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
531 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
532 log_trace!(logger, "Ignoring channel {} for invoice route hints", log_bytes!(channel.channel_id));
536 if channel.is_public {
537 if channel.confirmations.is_some() && channel.confirmations < Some(7) {
538 // If we have a public channel, but it doesn't have enough confirmations to (yet)
539 // be in the public network graph (and have gotten a chance to propagate), include
540 // route hints but only for public channels to protect private channel privacy.
541 has_pub_unconf_chan = true;
543 // If any public channel exists, return no hints and let the sender
544 // look at the public channels instead.
545 log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
546 log_bytes!(channel.channel_id));
551 if channel.inbound_capacity_msat >= min_inbound_capacity {
552 if !min_capacity_channel_exists {
553 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
554 min_capacity_channel_exists = true;
557 if channel.is_usable {
558 online_min_capacity_channel_exists = true;
562 if channel.is_usable && !online_channel_exists {
563 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
564 online_channel_exists = true;
567 match filtered_channels.entry(channel.counterparty.node_id) {
568 hash_map::Entry::Occupied(mut entry) => {
569 let current_max_capacity = entry.get().inbound_capacity_msat;
570 // If this channel is public and the previous channel is not, ensure we replace the
571 // previous channel to avoid announcing non-public channels.
572 let new_now_public = channel.is_public && !entry.get().is_public;
573 // If the public-ness of the channel has not changed (in which case simply defer to
574 // `new_now_public), and this channel has a greater capacity, prefer to announce
576 let new_higher_capacity = channel.is_public == entry.get().is_public &&
577 channel.inbound_capacity_msat > current_max_capacity;
578 if new_now_public || new_higher_capacity {
580 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
581 log_pubkey!(channel.counterparty.node_id),
582 log_bytes!(channel.channel_id), channel.short_channel_id,
583 channel.inbound_capacity_msat,
584 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
585 current_max_capacity);
586 entry.insert(channel);
589 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
590 log_pubkey!(channel.counterparty.node_id),
591 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
592 current_max_capacity,
593 log_bytes!(channel.channel_id), channel.short_channel_id,
594 channel.inbound_capacity_msat);
597 hash_map::Entry::Vacant(entry) => {
598 entry.insert(channel);
603 let route_hint_from_channel = |channel: ChannelDetails| {
604 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
605 RouteHint(vec![RouteHintHop {
606 src_node_id: channel.counterparty.node_id,
607 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
609 base_msat: forwarding_info.fee_base_msat,
610 proportional_millionths: forwarding_info.fee_proportional_millionths,
612 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
613 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
614 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
616 // If all channels are private, prefer to return route hints which have a higher capacity than
617 // the payment value and where we're currently connected to the channel counterparty.
618 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
619 // those which meet at least one criteria.
622 .map(|(_, channel)| channel)
624 let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
625 let include_channel = if has_pub_unconf_chan {
626 // If we have a public channel, but it doesn't have enough confirmations to (yet)
627 // be in the public network graph (and have gotten a chance to propagate), include
628 // route hints but only for public channels to protect private channel privacy.
630 } else if online_min_capacity_channel_exists {
631 has_enough_capacity && channel.is_usable
632 } else if min_capacity_channel_exists && online_channel_exists {
633 // If there are some online channels and some min_capacity channels, but no
634 // online-and-min_capacity channels, just include the min capacity ones and ignore
637 } else if min_capacity_channel_exists {
639 } else if online_channel_exists {
644 log_trace!(logger, "Including channel {} in invoice route hints",
645 log_bytes!(channel.channel_id));
646 } else if !has_enough_capacity {
647 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
648 log_bytes!(channel.channel_id));
650 debug_assert!(!channel.is_usable || (has_pub_unconf_chan && !channel.is_public));
651 log_trace!(logger, "Ignoring channel {} with disconnected peer",
652 log_bytes!(channel.channel_id));
657 .map(route_hint_from_channel)
658 .collect::<Vec<RouteHint>>()
663 use core::time::Duration;
664 use crate::{Currency, Description, InvoiceDescription, SignOrCreationError, CreationError};
665 use bitcoin_hashes::{Hash, sha256};
666 use bitcoin_hashes::sha256::Hash as Sha256;
667 use lightning::chain::keysinterface::PhantomKeysManager;
668 use lightning::events::{MessageSendEvent, MessageSendEventsProvider, Event};
669 use lightning::ln::{PaymentPreimage, PaymentHash};
670 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY_DELTA, PaymentId, RecipientOnionFields, Retry};
671 use lightning::ln::functional_test_utils::*;
672 use lightning::ln::msgs::ChannelMessageHandler;
673 use lightning::routing::router::{PaymentParameters, RouteParameters};
674 use lightning::util::test_utils;
675 use lightning::util::config::UserConfig;
676 use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
677 use std::collections::HashSet;
680 fn test_from_channelmanager() {
681 let chanmon_cfgs = create_chanmon_cfgs(2);
682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
685 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
686 let non_default_invoice_expiry_secs = 4200;
687 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
688 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
689 Some(10_000), "test".to_string(), Duration::from_secs(1234567),
690 non_default_invoice_expiry_secs, None).unwrap();
691 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
692 // If no `min_final_cltv_expiry_delta` is specified, then it should be `MIN_FINAL_CLTV_EXPIRY_DELTA`.
693 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
694 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
695 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
697 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
699 let chan = &nodes[1].node.list_usable_channels()[0];
700 assert_eq!(invoice.route_hints().len(), 1);
701 assert_eq!(invoice.route_hints()[0].0.len(), 1);
702 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
704 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
705 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
707 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
708 invoice.min_final_cltv_expiry_delta() as u32)
709 .with_features(invoice.features().unwrap().clone())
710 .with_route_hints(invoice.route_hints());
711 let route_params = RouteParameters {
713 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
715 let payment_event = {
716 let mut payment_hash = PaymentHash([0; 32]);
717 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
718 nodes[0].node.send_payment(payment_hash,
719 RecipientOnionFields::secret_only(*invoice.payment_secret()),
720 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
721 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
722 assert_eq!(added_monitors.len(), 1);
723 added_monitors.clear();
725 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
726 assert_eq!(events.len(), 1);
727 SendEvent::from_event(events.remove(0))
730 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
731 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
732 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
733 assert_eq!(added_monitors.len(), 1);
734 added_monitors.clear();
735 let events = nodes[1].node.get_and_clear_pending_msg_events();
736 assert_eq!(events.len(), 2);
739 fn do_create_invoice_min_final_cltv_delta(with_custom_delta: bool) {
740 let chanmon_cfgs = create_chanmon_cfgs(2);
741 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
742 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
743 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
744 let custom_min_final_cltv_expiry_delta = Some(50);
746 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
747 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
748 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
749 if with_custom_delta { custom_min_final_cltv_expiry_delta } else { None },
751 assert_eq!(invoice.min_final_cltv_expiry_delta(), if with_custom_delta {
752 custom_min_final_cltv_expiry_delta.unwrap() + 3 /* Buffer */} else { MIN_FINAL_CLTV_EXPIRY_DELTA } as u64);
756 fn test_create_invoice_custom_min_final_cltv_delta() {
757 do_create_invoice_min_final_cltv_delta(true);
758 do_create_invoice_min_final_cltv_delta(false);
762 fn create_invoice_min_final_cltv_delta_equals_htlc_fail_buffer() {
763 let chanmon_cfgs = create_chanmon_cfgs(2);
764 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
765 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
766 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
767 let custom_min_final_cltv_expiry_delta = Some(21);
769 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
770 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
771 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
772 custom_min_final_cltv_expiry_delta,
774 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
778 fn test_create_invoice_with_description_hash() {
779 let chanmon_cfgs = create_chanmon_cfgs(2);
780 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
781 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
782 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
783 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
784 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
785 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
786 Some(10_000), description_hash, Duration::from_secs(1234567), 3600, None,
788 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
789 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
790 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
794 fn test_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash() {
795 let chanmon_cfgs = create_chanmon_cfgs(2);
796 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
797 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
798 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
799 let payment_hash = PaymentHash([0; 32]);
800 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
801 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
802 Some(10_000), "test".to_string(), Duration::from_secs(1234567), 3600,
805 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
806 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
807 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
808 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
812 fn test_hints_has_only_public_confd_channels() {
813 let chanmon_cfgs = create_chanmon_cfgs(2);
814 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
815 let mut config = test_default_channel_config();
816 config.channel_handshake_config.minimum_depth = 1;
817 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
818 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
820 // Create a private channel with lots of capacity and a lower value public channel (without
821 // confirming the funding tx yet).
822 let unannounced_scid = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0);
823 let conf_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 10_000, 0);
825 // Before the channel is available, we should include the unannounced_scid.
826 let mut scid_aliases = HashSet::new();
827 scid_aliases.insert(unannounced_scid.0.short_channel_id_alias.unwrap());
828 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
830 // However after we mine the funding tx and exchange channel_ready messages for the public
831 // channel we'll immediately switch to including it as a route hint, even though it isn't
833 let pub_channel_scid = mine_transaction(&nodes[0], &conf_tx);
834 let node_a_pub_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
835 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &node_a_pub_channel_ready);
837 assert_eq!(mine_transaction(&nodes[1], &conf_tx), pub_channel_scid);
838 let events = nodes[1].node.get_and_clear_pending_msg_events();
839 assert_eq!(events.len(), 2);
840 if let MessageSendEvent::SendChannelReady { msg, .. } = &events[0] {
841 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), msg);
843 if let MessageSendEvent::SendChannelUpdate { msg, .. } = &events[1] {
844 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), msg);
847 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id()));
849 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
850 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
852 scid_aliases.clear();
853 scid_aliases.insert(node_a_pub_channel_ready.short_channel_id_alias.unwrap());
854 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
855 // This also applies even if the amount is more than the payment amount, to ensure users
856 // dont screw up their privacy.
857 match_invoice_routes(Some(50_000_000), &nodes[1], scid_aliases.clone());
859 // The same remains true until the channel has 7 confirmations, at which point we include
861 connect_blocks(&nodes[1], 5);
862 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
863 connect_blocks(&nodes[1], 1);
864 get_event_msg!(nodes[1], MessageSendEvent::SendAnnouncementSignatures, nodes[0].node.get_our_node_id());
865 match_invoice_routes(Some(5000), &nodes[1], HashSet::new());
869 fn test_hints_includes_single_channels_to_nodes() {
870 let chanmon_cfgs = create_chanmon_cfgs(3);
871 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
872 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
873 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
875 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
876 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
878 let mut scid_aliases = HashSet::new();
879 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
880 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
882 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
886 fn test_hints_has_only_highest_inbound_capacity_channel() {
887 let chanmon_cfgs = create_chanmon_cfgs(2);
888 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
889 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
890 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
891 let _chan_1_0_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
892 let chan_1_0_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0);
893 let _chan_1_0_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 1_000_000, 0);
894 let mut scid_aliases = HashSet::new();
895 scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap());
896 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
900 fn test_hints_has_only_online_channels() {
901 let chanmon_cfgs = create_chanmon_cfgs(4);
902 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
903 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
904 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
905 let chan_a = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0);
906 let chan_b = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 10_000_000, 0);
907 let _chan_c = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 1_000_000, 0);
909 // With all peers connected we should get all hints that have sufficient value
910 let mut scid_aliases = HashSet::new();
911 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
912 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
914 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
916 // With only one sufficient-value peer connected we should only get its hint
917 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
918 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());
919 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
921 // If we don't have any sufficient-value peers connected we should get all hints with
922 // sufficient value, even though there is a connected insufficient-value peer.
923 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
924 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
925 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
929 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
930 let chanmon_cfgs = create_chanmon_cfgs(3);
931 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
932 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
933 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
934 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
936 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
937 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
938 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
939 let mut private_chan_cfg = UserConfig::default();
940 private_chan_cfg.channel_handshake_config.announced_channel = false;
941 let temporary_channel_id = nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 1_000_000, 500_000_000, 42, Some(private_chan_cfg)).unwrap();
942 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
943 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_channel);
944 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
945 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), &accept_channel);
947 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
949 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
950 confirm_transaction_at(&nodes[2], &tx, conf_height);
951 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
952 confirm_transaction_at(&nodes[0], &tx, conf_height);
953 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
954 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
955 nodes[2].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[2].node.get_our_node_id()));
956 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
957 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
958 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
959 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
960 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
962 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
963 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
964 // Therefore only `chan_1_0` should be included in the hints.
965 let mut scid_aliases = HashSet::new();
966 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
967 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
971 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
972 let chanmon_cfgs = create_chanmon_cfgs(3);
973 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
974 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
975 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
976 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
978 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
979 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
980 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
982 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
983 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
984 // public channel between `nodes[2]` and `nodes[0]`
985 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
989 fn test_only_public_channels_includes_no_channels_in_hints() {
990 let chanmon_cfgs = create_chanmon_cfgs(3);
991 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
992 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
993 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
994 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
995 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
996 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
998 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
999 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1000 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1002 // As all of `nodes[0]` channels are public, no channels should be included in the hints
1003 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1007 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
1008 let chanmon_cfgs = create_chanmon_cfgs(3);
1009 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1010 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1011 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1012 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1013 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0);
1015 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
1016 let mut scid_aliases_99_000_001_msat = HashSet::new();
1017 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1019 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
1021 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
1022 let mut scid_aliases_99_000_000_msat = HashSet::new();
1023 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1024 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1026 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
1028 // As the invoice amt is above all channels' inbound capacity, they will still be included
1029 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
1030 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1031 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1033 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
1035 // An invoice with no specified amount should include all channels in the route hints.
1036 let mut scid_aliases_no_specified_amount = HashSet::new();
1037 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1038 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1040 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
1043 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1044 invoice_amt: Option<u64>,
1045 invoice_node: &Node<'a, 'b, 'c>,
1046 mut chan_ids_to_match: HashSet<u64>
1048 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
1049 invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
1050 Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
1051 3600, None).unwrap();
1052 let hints = invoice.private_routes();
1055 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
1056 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1058 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1062 #[cfg(feature = "std")]
1063 fn test_multi_node_receive() {
1064 do_test_multi_node_receive(true);
1065 do_test_multi_node_receive(false);
1068 #[cfg(feature = "std")]
1069 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
1070 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1071 let seed_1 = [42u8; 32];
1072 let seed_2 = [43u8; 32];
1073 let cross_node_seed = [44u8; 32];
1074 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1075 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1076 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1077 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1078 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1079 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1080 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
1081 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
1082 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1083 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1084 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1086 let payment_amt = 10_000;
1087 let route_hints = vec![
1088 nodes[1].node.get_phantom_route_hints(),
1089 nodes[2].node.get_phantom_route_hints(),
1092 let user_payment_preimage = PaymentPreimage([1; 32]);
1093 let payment_hash = if user_generated_pmt_hash {
1094 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
1098 let non_default_invoice_expiry_secs = 4200;
1101 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
1102 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1103 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1104 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
1106 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
1107 let payment_preimage = if user_generated_pmt_hash {
1108 user_payment_preimage
1110 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1113 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1114 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
1115 assert_eq!(invoice.route_hints().len(), 2);
1116 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1117 assert!(!invoice.features().unwrap().supports_basic_mpp());
1119 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
1120 invoice.min_final_cltv_expiry_delta() as u32)
1121 .with_features(invoice.features().unwrap().clone())
1122 .with_route_hints(invoice.route_hints());
1123 let params = RouteParameters {
1125 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
1127 let (payment_event, fwd_idx) = {
1128 let mut payment_hash = PaymentHash([0; 32]);
1129 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1130 nodes[0].node.send_payment(payment_hash,
1131 RecipientOnionFields::secret_only(*invoice.payment_secret()),
1132 PaymentId(payment_hash.0), params, Retry::Attempts(0)).unwrap();
1133 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1134 assert_eq!(added_monitors.len(), 1);
1135 added_monitors.clear();
1137 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1138 assert_eq!(events.len(), 1);
1139 let fwd_idx = match events[0] {
1140 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1141 if node_id == nodes[1].node.get_our_node_id() {
1145 _ => panic!("Unexpected event")
1147 (SendEvent::from_event(events.remove(0)), fwd_idx)
1149 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1150 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1152 // Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
1153 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1154 // payments "look real" by taking more time.
1155 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1156 nodes[fwd_idx].node.process_pending_htlc_forwards();
1157 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1158 nodes[fwd_idx].node.process_pending_htlc_forwards();
1160 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1161 expect_payment_claimable!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt, invoice.recover_payee_pub_key());
1162 do_claim_payment_along_route(&nodes[0], &[&vec!(&nodes[fwd_idx])[..]], false, payment_preimage);
1163 let events = nodes[0].node.get_and_clear_pending_events();
1164 assert_eq!(events.len(), 2);
1166 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1167 assert_eq!(payment_preimage, *ev_preimage);
1168 assert_eq!(payment_hash, *ev_hash);
1169 assert_eq!(fee_paid_msat, &Some(0));
1171 _ => panic!("Unexpected event")
1174 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1175 assert_eq!(hash, Some(payment_hash));
1177 _ => panic!("Unexpected event")
1182 #[cfg(feature = "std")]
1183 fn test_multi_node_hints_has_htlc_min_max_values() {
1184 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1185 let seed_1 = [42u8; 32];
1186 let seed_2 = [43u8; 32];
1187 let cross_node_seed = [44u8; 32];
1188 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1189 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1190 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1191 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1192 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1194 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1195 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1197 let payment_amt = 20_000;
1198 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600, None).unwrap();
1199 let route_hints = vec![
1200 nodes[1].node.get_phantom_route_hints(),
1201 nodes[2].node.get_phantom_route_hints(),
1204 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1205 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
1206 "test".to_string(), 3600, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1207 nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1209 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1210 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1211 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1213 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1214 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1215 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1219 #[cfg(feature = "std")]
1220 fn create_phantom_invoice_with_description_hash() {
1221 let chanmon_cfgs = create_chanmon_cfgs(3);
1222 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1223 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1224 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1226 let payment_amt = 20_000;
1227 let route_hints = vec![
1228 nodes[1].node.get_phantom_route_hints(),
1229 nodes[2].node.get_phantom_route_hints(),
1232 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1233 let non_default_invoice_expiry_secs = 4200;
1234 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1235 &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger,
1237 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1238 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1239 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
1242 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1243 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1244 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1245 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1249 #[cfg(feature = "std")]
1250 fn create_phantom_invoice_with_custom_payment_hash_and_custom_min_final_cltv_delta() {
1251 let chanmon_cfgs = create_chanmon_cfgs(3);
1252 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1253 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1254 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1256 let payment_amt = 20_000;
1257 let route_hints = vec![
1258 nodes[1].node.get_phantom_route_hints(),
1259 nodes[2].node.get_phantom_route_hints(),
1261 let user_payment_preimage = PaymentPreimage([1; 32]);
1262 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
1263 let non_default_invoice_expiry_secs = 4200;
1264 let min_final_cltv_expiry_delta = Some(100);
1265 let duration_since_epoch = Duration::from_secs(1234567);
1266 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1267 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
1268 "".to_string(), non_default_invoice_expiry_secs, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1269 nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
1270 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1271 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
1272 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1276 #[cfg(feature = "std")]
1277 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1278 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1279 let seed_1 = [42u8; 32];
1280 let seed_2 = [43u8; 32];
1281 let cross_node_seed = [44u8; 32];
1282 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1283 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1284 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1285 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1286 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1288 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1289 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1291 let mut scid_aliases = HashSet::new();
1292 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1293 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1295 match_multi_node_invoice_routes(
1298 vec![&nodes[1], &nodes[2],],
1305 #[cfg(feature = "std")]
1306 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1307 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1308 let seed_1 = [42u8; 32];
1309 let seed_2 = [43u8; 32];
1310 let cross_node_seed = [44u8; 32];
1311 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1312 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1313 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1314 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1315 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1317 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1318 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1319 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005);
1321 let mut scid_aliases = HashSet::new();
1322 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1323 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1324 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1326 match_multi_node_invoice_routes(
1329 vec![&nodes[2], &nodes[3],],
1336 #[cfg(feature = "std")]
1337 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1338 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1339 let seed_1 = [42u8; 32];
1340 let seed_2 = [43u8; 32];
1341 let cross_node_seed = [44u8; 32];
1342 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1343 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1344 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1345 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1346 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1348 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1349 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1351 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1352 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1353 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1354 let mut private_chan_cfg = UserConfig::default();
1355 private_chan_cfg.channel_handshake_config.announced_channel = false;
1356 let temporary_channel_id = nodes[1].node.create_channel(nodes[3].node.get_our_node_id(), 1_000_000, 500_000_000, 42, Some(private_chan_cfg)).unwrap();
1357 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1358 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
1359 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1360 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), &accept_channel);
1362 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1364 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1365 confirm_transaction_at(&nodes[1], &tx, conf_height);
1366 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1367 confirm_transaction_at(&nodes[3], &tx, conf_height);
1368 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1369 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1370 nodes[1].node.handle_channel_ready(&nodes[3].node.get_our_node_id(), &get_event_msg!(nodes[3], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id()));
1371 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1372 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1373 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1374 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1375 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1377 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1378 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1379 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1380 let mut scid_aliases = HashSet::new();
1381 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1382 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1384 match_multi_node_invoice_routes(
1387 vec![&nodes[2], &nodes[3],],
1394 #[cfg(feature = "std")]
1395 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1396 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1397 let seed_1 = [42u8; 32];
1398 let seed_2 = [43u8; 32];
1399 let cross_node_seed = [44u8; 32];
1400 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1401 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1402 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1403 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1404 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1406 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1408 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1409 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1410 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1412 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1413 // `chan_0_2` as `nodes[2]` only has public channels.
1414 let mut scid_aliases = HashSet::new();
1415 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1417 match_multi_node_invoice_routes(
1420 vec![&nodes[1], &nodes[2],],
1427 #[cfg(feature = "std")]
1428 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1429 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1430 let seed_1 = [42u8; 32];
1431 let seed_2 = [43u8; 32];
1432 let cross_node_seed = [44u8; 32];
1433 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1434 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1435 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1436 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1437 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1439 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1440 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1441 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1442 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
1444 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001);
1446 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1447 // channels for `nodes[2]` as it contains a mix of public and private channels.
1448 let mut scid_aliases = HashSet::new();
1449 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1451 match_multi_node_invoice_routes(
1454 vec![&nodes[2], &nodes[3],],
1461 #[cfg(feature = "std")]
1462 fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() {
1463 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1464 let seed_1 = [42u8; 32];
1465 let seed_2 = [43u8; 32];
1466 let cross_node_seed = [44u8; 32];
1467 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1468 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1469 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1470 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1471 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1473 let _chan_0_1_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1474 let chan_0_1_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0);
1475 let _chan_0_1_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1476 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1478 let mut scid_aliases = HashSet::new();
1479 scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap());
1480 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1482 match_multi_node_invoice_routes(
1485 vec![&nodes[1], &nodes[2],],
1492 #[cfg(feature = "std")]
1493 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1494 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1495 let seed_1 = [42u8; 32];
1496 let seed_2 = [43u8; 32];
1497 let cross_node_seed = [44u8; 32];
1498 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1499 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1500 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1501 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1502 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1504 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1505 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0);
1506 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0);
1508 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1509 let mut scid_aliases_99_000_001_msat = HashSet::new();
1510 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1511 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1513 match_multi_node_invoice_routes(
1516 vec![&nodes[2], &nodes[3],],
1517 scid_aliases_99_000_001_msat,
1521 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1522 let mut scid_aliases_99_000_000_msat = HashSet::new();
1523 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1524 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1525 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1527 match_multi_node_invoice_routes(
1530 vec![&nodes[2], &nodes[3],],
1531 scid_aliases_99_000_000_msat,
1535 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1536 // `nodes[2]` them should be included.
1537 let mut scid_aliases_300_000_000_msat = HashSet::new();
1538 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1539 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1540 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1542 match_multi_node_invoice_routes(
1545 vec![&nodes[2], &nodes[3],],
1546 scid_aliases_300_000_000_msat,
1550 // Since the no specified amount, all channels should included.
1551 let mut scid_aliases_no_specified_amount = HashSet::new();
1552 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1553 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1554 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1556 match_multi_node_invoice_routes(
1559 vec![&nodes[2], &nodes[3],],
1560 scid_aliases_no_specified_amount,
1565 #[cfg(feature = "std")]
1566 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1567 invoice_amt: Option<u64>,
1568 invoice_node: &Node<'a, 'b, 'c>,
1569 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1570 mut chan_ids_to_match: HashSet<u64>,
1571 nodes_contains_public_channels: bool
1573 let phantom_route_hints = network_multi_nodes.iter()
1574 .map(|node| node.node.get_phantom_route_hints())
1575 .collect::<Vec<PhantomRouteHints>>();
1576 let phantom_scids = phantom_route_hints.iter()
1577 .map(|route_hint| route_hint.phantom_scid)
1578 .collect::<HashSet<u64>>();
1580 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1581 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
1582 3600, phantom_route_hints, invoice_node.keys_manager, invoice_node.keys_manager,
1583 invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1585 let invoice_hints = invoice.private_routes();
1587 for hint in invoice_hints {
1588 let hints = &(hint.0).0;
1591 assert!(nodes_contains_public_channels);
1592 let phantom_scid = hints[0].short_channel_id;
1593 assert!(phantom_scids.contains(&phantom_scid));
1596 let hint_short_chan_id = hints[0].short_channel_id;
1597 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1598 let phantom_scid = hints[1].short_channel_id;
1599 assert!(phantom_scids.contains(&phantom_scid));
1601 _ => panic!("Incorrect hint length generated")
1604 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1608 fn test_create_invoice_fails_with_invalid_custom_min_final_cltv_expiry_delta() {
1609 let chanmon_cfgs = create_chanmon_cfgs(2);
1610 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1611 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1612 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1613 let result = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
1614 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
1615 Some(10_000), "Some description".into(), Duration::from_secs(1234567), 3600, Some(MIN_FINAL_CLTV_EXPIRY_DELTA - 4),
1618 Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort)) => {},