1 //! Convenient utilities to create an invoice.
3 use crate::{Bolt11Invoice, CreationError, Currency, InvoiceBuilder, SignOrCreationError};
5 use crate::{prelude::*, Description, Bolt11InvoiceDescription, Sha256};
7 use bitcoin_hashes::Hash;
9 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
10 use lightning::sign::{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;
21 use core::iter::Iterator;
23 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
24 /// See [`PhantomKeysManager`] for more information on phantom node payments.
26 /// `phantom_route_hints` parameter:
27 /// * Contains channel info for all nodes participating in the phantom invoice
28 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
29 /// participating node
30 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
31 /// updated when a channel becomes disabled or closes
32 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
33 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
36 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
37 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
38 /// If `None` is provided for `payment_hash`, then one will be created.
40 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
41 /// in excess of the current time.
43 /// `duration_since_epoch` is the current time since epoch in seconds.
45 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
46 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
47 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
48 /// confirmations during routing.
50 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
51 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
54 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
55 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
56 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
57 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
58 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
59 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
61 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
62 /// available and the current time is supplied by the caller.
63 pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
64 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
65 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
66 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
67 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
69 ES::Target: EntropySource,
70 NS::Target: NodeSigner,
73 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
74 let description = Bolt11InvoiceDescription::Direct(&description,);
75 _create_phantom_invoice::<ES, NS, L>(
76 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
77 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
81 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
82 /// See [`PhantomKeysManager`] for more information on phantom node payments.
84 /// `phantom_route_hints` parameter:
85 /// * Contains channel info for all nodes participating in the phantom invoice
86 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
87 /// participating node
88 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
89 /// updated when a channel becomes disabled or closes
90 /// * Note that the route hints generated from `phantom_route_hints` will be limited to a maximum
91 /// of 3 hints to ensure that the invoice can be scanned in a QR code. These hints are selected
92 /// in the order that the nodes in `PhantomRouteHints` are specified, selecting one hint per node
93 /// until the maximum is hit. Callers may provide as many `PhantomRouteHints::channels` as
94 /// desired, but note that some nodes will be trimmed if more than 3 nodes are provided.
96 /// `description_hash` is a SHA-256 hash of the description text
98 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
99 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
100 /// If `None` is provided for `payment_hash`, then one will be created.
102 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
103 /// in excess of the current time.
105 /// `duration_since_epoch` is the current time since epoch in seconds.
107 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
108 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
111 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
112 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
113 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
114 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
115 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
117 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
118 /// available and the current time is supplied by the caller.
119 pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
120 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
121 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
122 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
123 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
125 ES::Target: EntropySource,
126 NS::Target: NodeSigner,
129 _create_phantom_invoice::<ES, NS, L>(
130 amt_msat, payment_hash, Bolt11InvoiceDescription::Hash(&description_hash),
131 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
132 min_final_cltv_expiry_delta, duration_since_epoch,
136 const MAX_CHANNEL_HINTS: usize = 3;
138 fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
139 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: Bolt11InvoiceDescription,
140 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
141 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
142 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
144 ES::Target: EntropySource,
145 NS::Target: NodeSigner,
149 if phantom_route_hints.is_empty() {
150 return Err(SignOrCreationError::CreationError(
151 CreationError::MissingRouteHints,
155 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
156 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
159 let invoice = match description {
160 Bolt11InvoiceDescription::Direct(description) => {
161 InvoiceBuilder::new(network).description(description.0.clone())
163 Bolt11InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
166 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
167 let keys = ExpandedKey::new(&node_signer.get_inbound_payment_key_material());
168 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
169 let payment_secret = create_from_hash(
173 invoice_expiry_delta_secs,
176 min_final_cltv_expiry_delta,
178 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
179 (payment_hash, payment_secret)
184 invoice_expiry_delta_secs,
188 min_final_cltv_expiry_delta,
190 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
193 log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
194 phantom_route_hints.len(), log_bytes!(payment_hash.0));
196 let mut invoice = invoice
197 .duration_since_epoch(duration_since_epoch)
198 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
199 .payment_secret(payment_secret)
200 .min_final_cltv_expiry_delta(
201 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
202 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
203 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
204 if let Some(amt) = amt_msat {
205 invoice = invoice.amount_milli_satoshis(amt);
209 for route_hint in select_phantom_hints(amt_msat, phantom_route_hints, logger).take(MAX_CHANNEL_HINTS) {
210 invoice = invoice.private_route(route_hint);
213 let raw_invoice = match invoice.build_raw() {
215 Err(e) => return Err(SignOrCreationError::CreationError(e))
217 let hrp_str = raw_invoice.hrp.to_string();
218 let hrp_bytes = hrp_str.as_bytes();
219 let data_without_signature = raw_invoice.data.to_base32();
220 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
221 match signed_raw_invoice {
222 Ok(inv) => Ok(Bolt11Invoice::from_signed(inv).unwrap()),
223 Err(e) => Err(SignOrCreationError::SignError(e))
227 /// Utility to select route hints for phantom invoices.
228 /// See [`PhantomKeysManager`] for more information on phantom node payments.
230 /// To ensure that the phantom invoice is still readable by QR code, we limit to 3 hints per invoice:
231 /// * Select up to three channels per node.
232 /// * Select one hint from each node, up to three hints or until we run out of hints.
234 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
235 fn select_phantom_hints<L: Deref>(amt_msat: Option<u64>, phantom_route_hints: Vec<PhantomRouteHints>,
236 logger: L) -> impl Iterator<Item = RouteHint>
240 let mut phantom_hints: Vec<_> = Vec::new();
242 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
243 log_trace!(logger, "Generating phantom route hints for node {}",
244 log_pubkey!(real_node_pubkey));
245 let route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
247 // If we have any public channel, the route hints from `sort_and_filter_channels` will be
248 // empty. In that case we create a RouteHint on which we will push a single hop with the
249 // phantom route into the invoice, and let the sender find the path to the `real_node_pubkey`
250 // node by looking at our public channels.
251 let empty_route_hints = route_hints.len() == 0;
252 let mut have_pushed_empty = false;
253 let route_hints = route_hints
254 .chain(core::iter::from_fn(move || {
255 if empty_route_hints && !have_pushed_empty {
256 // set flag of having handled the empty route_hints and ensure empty vector
257 // returned only once
258 have_pushed_empty = true;
259 Some(RouteHint(Vec::new()))
264 .map(move |mut hint| {
265 hint.0.push(RouteHintHop {
266 src_node_id: real_node_pubkey,
267 short_channel_id: phantom_scid,
270 proportional_millionths: 0,
272 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
273 htlc_minimum_msat: None,
274 htlc_maximum_msat: None,
279 phantom_hints.push(route_hints);
282 // We have one vector per real node involved in creating the phantom invoice. To distribute
283 // the hints across our real nodes we add one hint from each in turn until no node has any hints
284 // left (if one node has more hints than any other, these will accumulate at the end of the
286 rotate_through_iterators(phantom_hints)
289 /// Draw items iteratively from multiple iterators. The items are retrieved by index and
290 /// rotates through the iterators - first the zero index then the first index then second index, etc.
291 fn rotate_through_iterators<T, I: Iterator<Item = T>>(mut vecs: Vec<I>) -> impl Iterator<Item = T> {
292 let mut iterations = 0;
294 core::iter::from_fn(move || {
295 let mut exhausted_iterators = 0;
300 let next_idx = iterations % vecs.len();
302 if let Some(item) = vecs[next_idx].next() {
305 // exhausted_vectors increase when the "next_idx" vector is exhausted
306 exhausted_iterators += 1;
307 // The check for exhausted iterators gets reset to 0 after each yield of `Some()`
308 // The loop will return None when all of the nested iterators are exhausted
309 if exhausted_iterators == vecs.len() {
316 #[cfg(feature = "std")]
317 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
318 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
319 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
320 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
321 /// that the payment secret is valid when the invoice is paid.
323 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
324 /// in excess of the current time.
326 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
327 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
328 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
329 /// confirmations during routing.
331 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
332 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
333 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
334 network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32,
335 min_final_cltv_expiry_delta: Option<u16>,
336 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
338 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
339 T::Target: BroadcasterInterface,
340 ES::Target: EntropySource,
341 NS::Target: NodeSigner,
342 SP::Target: SignerProvider,
343 F::Target: FeeEstimator,
347 use std::time::SystemTime;
348 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
349 .expect("for the foreseeable future this shouldn't happen");
350 create_invoice_from_channelmanager_and_duration_since_epoch(
351 channelmanager, node_signer, logger, network, amt_msat,
352 description, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
356 #[cfg(feature = "std")]
357 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
358 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
359 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
360 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
361 /// that the payment secret is valid when the invoice is paid.
362 /// Use this variant if you want to pass the `description_hash` to the invoice.
364 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
365 /// in excess of the current time.
367 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
368 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
369 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
370 /// confirmations during routing.
372 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
373 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>(
374 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
375 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
376 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
377 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
379 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
380 T::Target: BroadcasterInterface,
381 ES::Target: EntropySource,
382 NS::Target: NodeSigner,
383 SP::Target: SignerProvider,
384 F::Target: FeeEstimator,
388 use std::time::SystemTime;
390 let duration = SystemTime::now()
391 .duration_since(SystemTime::UNIX_EPOCH)
392 .expect("for the foreseeable future this shouldn't happen");
394 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
395 channelmanager, node_signer, logger, network, amt_msat,
396 description_hash, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
400 /// See [`create_invoice_from_channelmanager_with_description_hash`]
401 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
402 /// available and the current time is supplied by the caller.
403 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>(
404 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
405 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
406 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
407 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
409 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
410 T::Target: BroadcasterInterface,
411 ES::Target: EntropySource,
412 NS::Target: NodeSigner,
413 SP::Target: SignerProvider,
414 F::Target: FeeEstimator,
418 _create_invoice_from_channelmanager_and_duration_since_epoch(
419 channelmanager, node_signer, logger, network, amt_msat,
420 Bolt11InvoiceDescription::Hash(&description_hash),
421 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
425 /// See [`create_invoice_from_channelmanager`]
426 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
427 /// available and the current time is supplied by the caller.
428 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>(
429 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
430 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
431 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
432 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
434 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
435 T::Target: BroadcasterInterface,
436 ES::Target: EntropySource,
437 NS::Target: NodeSigner,
438 SP::Target: SignerProvider,
439 F::Target: FeeEstimator,
443 _create_invoice_from_channelmanager_and_duration_since_epoch(
444 channelmanager, node_signer, logger, network, amt_msat,
445 Bolt11InvoiceDescription::Direct(
446 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
448 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
452 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>(
453 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
454 network: Currency, amt_msat: Option<u64>, description: Bolt11InvoiceDescription,
455 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
456 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
458 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
459 T::Target: BroadcasterInterface,
460 ES::Target: EntropySource,
461 NS::Target: NodeSigner,
462 SP::Target: SignerProvider,
463 F::Target: FeeEstimator,
467 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
468 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
471 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
473 let (payment_hash, payment_secret) = channelmanager
474 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs, min_final_cltv_expiry_delta)
475 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
476 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
477 channelmanager, node_signer, logger, network, amt_msat, description, duration_since_epoch,
478 invoice_expiry_delta_secs, payment_hash, payment_secret, min_final_cltv_expiry_delta)
481 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
482 /// This version allows for providing a custom [`PaymentHash`] for the invoice.
483 /// This may be useful if you're building an on-chain swap or involving another protocol where
484 /// the payment hash is also involved outside the scope of lightning.
485 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>(
486 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
487 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
488 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, min_final_cltv_expiry_delta: Option<u16>,
489 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
491 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
492 T::Target: BroadcasterInterface,
493 ES::Target: EntropySource,
494 NS::Target: NodeSigner,
495 SP::Target: SignerProvider,
496 F::Target: FeeEstimator,
500 let payment_secret = channelmanager
501 .create_inbound_payment_for_hash(payment_hash, amt_msat, invoice_expiry_delta_secs,
502 min_final_cltv_expiry_delta)
503 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
504 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
505 channelmanager, node_signer, logger, network, amt_msat,
506 Bolt11InvoiceDescription::Direct(
507 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
509 duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret,
510 min_final_cltv_expiry_delta,
514 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>(
515 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
516 network: Currency, amt_msat: Option<u64>, description: Bolt11InvoiceDescription,
517 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, payment_hash: PaymentHash,
518 payment_secret: PaymentSecret, min_final_cltv_expiry_delta: Option<u16>,
519 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
521 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
522 T::Target: BroadcasterInterface,
523 ES::Target: EntropySource,
524 NS::Target: NodeSigner,
525 SP::Target: SignerProvider,
526 F::Target: FeeEstimator,
530 let our_node_pubkey = channelmanager.get_our_node_id();
531 let channels = channelmanager.list_channels();
533 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
534 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
537 log_trace!(logger, "Creating invoice with payment hash {}", log_bytes!(payment_hash.0));
539 let invoice = match description {
540 Bolt11InvoiceDescription::Direct(description) => {
541 InvoiceBuilder::new(network).description(description.0.clone())
543 Bolt11InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
546 let mut invoice = invoice
547 .duration_since_epoch(duration_since_epoch)
548 .payee_pub_key(our_node_pubkey)
549 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
550 .payment_secret(payment_secret)
552 .min_final_cltv_expiry_delta(
553 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
554 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
555 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
556 if let Some(amt) = amt_msat {
557 invoice = invoice.amount_milli_satoshis(amt);
560 let route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
561 for hint in route_hints {
562 invoice = invoice.private_route(hint);
565 let raw_invoice = match invoice.build_raw() {
567 Err(e) => return Err(SignOrCreationError::CreationError(e))
569 let hrp_str = raw_invoice.hrp.to_string();
570 let hrp_bytes = hrp_str.as_bytes();
571 let data_without_signature = raw_invoice.data.to_base32();
572 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
573 match signed_raw_invoice {
574 Ok(inv) => Ok(Bolt11Invoice::from_signed(inv).unwrap()),
575 Err(e) => Err(SignOrCreationError::SignError(e))
579 /// Sorts and filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
582 /// The filtering is based on the following criteria:
583 /// * Only one channel per counterparty node
584 /// * If the counterparty has a channel that is above the `min_inbound_capacity_msat` + 10% scaling
585 /// factor (to allow some margin for change in inbound), select the channel with the lowest
586 /// inbound capacity that is above this threshold.
587 /// * If no `min_inbound_capacity_msat` is specified, or the counterparty has no channels above the
588 /// minimum + 10% scaling factor, select the channel with the highest inbound capacity per counterparty.
589 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
590 /// `is_usable` (i.e. the peer is connected).
591 /// * If any public channel exists, only public [`RouteHint`]s will be returned.
592 /// * If any public, announced, channel exists (i.e. a channel with 7+ confs, to ensure the
593 /// announcement has had a chance to propagate), no [`RouteHint`]s will be returned, as the
594 /// sender is expected to find the path by looking at the public channels instead.
595 /// * Limited to a total of 3 channels.
596 /// * Sorted by lowest inbound capacity if an online channel with the minimum amount requested exists,
597 /// otherwise sort by highest inbound capacity to give the payment the best chance of succeeding.
598 fn sort_and_filter_channels<L: Deref>(
599 channels: Vec<ChannelDetails>,
600 min_inbound_capacity_msat: Option<u64>,
602 ) -> impl ExactSizeIterator<Item = RouteHint>
606 let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
607 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
608 let mut min_capacity_channel_exists = false;
609 let mut online_channel_exists = false;
610 let mut online_min_capacity_channel_exists = false;
611 let mut has_pub_unconf_chan = false;
613 let route_hint_from_channel = |channel: ChannelDetails| {
614 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
615 RouteHint(vec![RouteHintHop {
616 src_node_id: channel.counterparty.node_id,
617 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
619 base_msat: forwarding_info.fee_base_msat,
620 proportional_millionths: forwarding_info.fee_proportional_millionths,
622 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
623 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
624 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
627 log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
628 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
629 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
630 log_trace!(logger, "Ignoring channel {} for invoice route hints", log_bytes!(channel.channel_id));
634 if channel.is_public {
635 if channel.confirmations.is_some() && channel.confirmations < Some(7) {
636 // If we have a public channel, but it doesn't have enough confirmations to (yet)
637 // be in the public network graph (and have gotten a chance to propagate), include
638 // route hints but only for public channels to protect private channel privacy.
639 has_pub_unconf_chan = true;
641 // If any public channel exists, return no hints and let the sender
642 // look at the public channels instead.
643 log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
644 log_bytes!(channel.channel_id));
645 return vec![].into_iter().take(MAX_CHANNEL_HINTS).map(route_hint_from_channel);
649 if channel.inbound_capacity_msat >= min_inbound_capacity {
650 if !min_capacity_channel_exists {
651 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
652 min_capacity_channel_exists = true;
655 if channel.is_usable {
656 online_min_capacity_channel_exists = true;
660 if channel.is_usable && !online_channel_exists {
661 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
662 online_channel_exists = true;
665 match filtered_channels.entry(channel.counterparty.node_id) {
666 hash_map::Entry::Occupied(mut entry) => {
667 let current_max_capacity = entry.get().inbound_capacity_msat;
668 // If this channel is public and the previous channel is not, ensure we replace the
669 // previous channel to avoid announcing non-public channels.
670 let new_now_public = channel.is_public && !entry.get().is_public;
671 // Decide whether we prefer the currently selected channel with the node to the new one,
672 // based on their inbound capacity.
673 let prefer_current = prefer_current_channel(min_inbound_capacity_msat, current_max_capacity,
674 channel.inbound_capacity_msat);
675 // If the public-ness of the channel has not changed (in which case simply defer to
676 // `new_now_public), and this channel has more desirable inbound than the incumbent,
677 // prefer to include this channel.
678 let new_channel_preferable = channel.is_public == entry.get().is_public && !prefer_current;
680 if new_now_public || new_channel_preferable {
682 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
683 log_pubkey!(channel.counterparty.node_id),
684 log_bytes!(channel.channel_id), channel.short_channel_id,
685 channel.inbound_capacity_msat,
686 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
687 current_max_capacity);
688 entry.insert(channel);
691 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
692 log_pubkey!(channel.counterparty.node_id),
693 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
694 current_max_capacity,
695 log_bytes!(channel.channel_id), channel.short_channel_id,
696 channel.inbound_capacity_msat);
699 hash_map::Entry::Vacant(entry) => {
700 entry.insert(channel);
705 // If all channels are private, prefer to return route hints which have a higher capacity than
706 // the payment value and where we're currently connected to the channel counterparty.
707 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
708 // those which meet at least one criteria.
709 let mut eligible_channels = filtered_channels
711 .map(|(_, channel)| channel)
713 let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
714 let include_channel = if has_pub_unconf_chan {
715 // If we have a public channel, but it doesn't have enough confirmations to (yet)
716 // be in the public network graph (and have gotten a chance to propagate), include
717 // route hints but only for public channels to protect private channel privacy.
719 } else if online_min_capacity_channel_exists {
720 has_enough_capacity && channel.is_usable
721 } else if min_capacity_channel_exists && online_channel_exists {
722 // If there are some online channels and some min_capacity channels, but no
723 // online-and-min_capacity channels, just include the min capacity ones and ignore
726 } else if min_capacity_channel_exists {
728 } else if online_channel_exists {
733 log_trace!(logger, "Including channel {} in invoice route hints",
734 log_bytes!(channel.channel_id));
735 } else if !has_enough_capacity {
736 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
737 log_bytes!(channel.channel_id));
739 debug_assert!(!channel.is_usable || (has_pub_unconf_chan && !channel.is_public));
740 log_trace!(logger, "Ignoring channel {} with disconnected peer",
741 log_bytes!(channel.channel_id));
746 .collect::<Vec<ChannelDetails>>();
748 eligible_channels.sort_unstable_by(|a, b| {
749 if online_min_capacity_channel_exists {
750 a.inbound_capacity_msat.cmp(&b.inbound_capacity_msat)
752 b.inbound_capacity_msat.cmp(&a.inbound_capacity_msat)
755 eligible_channels.into_iter().take(MAX_CHANNEL_HINTS).map(route_hint_from_channel)
758 /// prefer_current_channel chooses a channel to use for route hints between a currently selected and candidate
759 /// channel based on the inbound capacity of each channel and the minimum inbound capacity requested for the hints,
760 /// returning true if the current channel should be preferred over the candidate channel.
761 /// * If no minimum amount is requested, the channel with the most inbound is chosen to maximize the chances that a
762 /// payment of any size will succeed.
763 /// * If we have channels with inbound above our minimum requested inbound (plus a 10% scaling factor, expressed as a
764 /// percentage) then we choose the lowest inbound channel with above this amount. If we have sufficient inbound
765 /// channels, we don't want to deplete our larger channels with small payments (the off-chain version of "grinding
767 /// * If no channel above our minimum amount exists, then we just prefer the channel with the most inbound to give
768 /// payments the best chance of succeeding in multiple parts.
769 fn prefer_current_channel(min_inbound_capacity_msat: Option<u64>, current_channel: u64,
770 candidate_channel: u64) -> bool {
772 // If no min amount is given for the hints, err of the side of caution and choose the largest channel inbound to
773 // maximize chances of any payment succeeding.
774 if min_inbound_capacity_msat.is_none() {
775 return current_channel > candidate_channel
778 let scaled_min_inbound = min_inbound_capacity_msat.unwrap() * 110;
779 let current_sufficient = current_channel * 100 >= scaled_min_inbound;
780 let candidate_sufficient = candidate_channel * 100 >= scaled_min_inbound;
782 if current_sufficient && candidate_sufficient {
783 return current_channel < candidate_channel
784 } else if current_sufficient {
786 } else if candidate_sufficient {
790 current_channel > candidate_channel
795 use core::cell::RefCell;
796 use core::time::Duration;
797 use crate::{Currency, Description, Bolt11InvoiceDescription, SignOrCreationError, CreationError};
798 use bitcoin_hashes::{Hash, sha256};
799 use bitcoin_hashes::sha256::Hash as Sha256;
800 use lightning::sign::PhantomKeysManager;
801 use lightning::events::{MessageSendEvent, MessageSendEventsProvider, Event, EventsProvider};
802 use lightning::ln::{PaymentPreimage, PaymentHash};
803 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY_DELTA, PaymentId};
804 use lightning::ln::outbound_payment::{RecipientOnionFields, Retry};
805 use lightning::ln::functional_test_utils::*;
806 use lightning::ln::msgs::ChannelMessageHandler;
807 use lightning::routing::router::{PaymentParameters, RouteParameters};
808 use lightning::util::test_utils;
809 use lightning::util::config::UserConfig;
810 use crate::utils::{create_invoice_from_channelmanager_and_duration_since_epoch, rotate_through_iterators};
811 use std::collections::HashSet;
814 fn test_prefer_current_channel() {
815 // No minimum, prefer larger candidate channel.
816 assert_eq!(crate::utils::prefer_current_channel(None, 100, 200), false);
818 // No minimum, prefer larger current channel.
819 assert_eq!(crate::utils::prefer_current_channel(None, 200, 100), true);
821 // Minimum set, prefer current channel over minimum + buffer.
822 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 100), true);
824 // Minimum set, prefer candidate channel over minimum + buffer.
825 assert_eq!(crate::utils::prefer_current_channel(Some(100), 105, 125), false);
827 // Minimum set, both channels sufficient, prefer smaller current channel.
828 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 125), true);
830 // Minimum set, both channels sufficient, prefer smaller candidate channel.
831 assert_eq!(crate::utils::prefer_current_channel(Some(100), 200, 160), false);
833 // Minimum set, neither sufficient, prefer larger current channel.
834 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 50), true);
836 // Minimum set, neither sufficient, prefer larger candidate channel.
837 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 150), false);
842 fn test_from_channelmanager() {
843 let chanmon_cfgs = create_chanmon_cfgs(2);
844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
847 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
848 let non_default_invoice_expiry_secs = 4200;
849 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
850 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
851 Some(10_000), "test".to_string(), Duration::from_secs(1234567),
852 non_default_invoice_expiry_secs, None).unwrap();
853 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
854 // If no `min_final_cltv_expiry_delta` is specified, then it should be `MIN_FINAL_CLTV_EXPIRY_DELTA`.
855 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
856 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description("test".to_string())));
857 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
859 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
861 let chan = &nodes[1].node.list_usable_channels()[0];
862 assert_eq!(invoice.route_hints().len(), 1);
863 assert_eq!(invoice.route_hints()[0].0.len(), 1);
864 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
866 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
867 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
869 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
870 invoice.min_final_cltv_expiry_delta() as u32)
871 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
872 .with_route_hints(invoice.route_hints()).unwrap();
873 let route_params = RouteParameters {
875 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
877 let payment_event = {
878 let mut payment_hash = PaymentHash([0; 32]);
879 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
880 nodes[0].node.send_payment(payment_hash,
881 RecipientOnionFields::secret_only(*invoice.payment_secret()),
882 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
883 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
884 assert_eq!(added_monitors.len(), 1);
885 added_monitors.clear();
887 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
888 assert_eq!(events.len(), 1);
889 SendEvent::from_event(events.remove(0))
892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
893 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
894 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
895 assert_eq!(added_monitors.len(), 1);
896 added_monitors.clear();
897 let events = nodes[1].node.get_and_clear_pending_msg_events();
898 assert_eq!(events.len(), 2);
901 fn do_create_invoice_min_final_cltv_delta(with_custom_delta: bool) {
902 let chanmon_cfgs = create_chanmon_cfgs(2);
903 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
904 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
905 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
906 let custom_min_final_cltv_expiry_delta = Some(50);
908 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
909 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
910 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
911 if with_custom_delta { custom_min_final_cltv_expiry_delta } else { None },
913 assert_eq!(invoice.min_final_cltv_expiry_delta(), if with_custom_delta {
914 custom_min_final_cltv_expiry_delta.unwrap() + 3 /* Buffer */} else { MIN_FINAL_CLTV_EXPIRY_DELTA } as u64);
918 fn test_create_invoice_custom_min_final_cltv_delta() {
919 do_create_invoice_min_final_cltv_delta(true);
920 do_create_invoice_min_final_cltv_delta(false);
924 fn create_invoice_min_final_cltv_delta_equals_htlc_fail_buffer() {
925 let chanmon_cfgs = create_chanmon_cfgs(2);
926 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
927 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
928 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
929 let custom_min_final_cltv_expiry_delta = Some(21);
931 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
932 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
933 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
934 custom_min_final_cltv_expiry_delta,
936 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
940 fn test_create_invoice_with_description_hash() {
941 let chanmon_cfgs = create_chanmon_cfgs(2);
942 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
943 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
944 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
945 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
946 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
947 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
948 Some(10_000), description_hash, Duration::from_secs(1234567), 3600, None,
950 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
951 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
952 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
956 fn test_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash() {
957 let chanmon_cfgs = create_chanmon_cfgs(2);
958 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
959 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
960 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
961 let payment_hash = PaymentHash([0; 32]);
962 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
963 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
964 Some(10_000), "test".to_string(), Duration::from_secs(1234567), 3600,
967 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
968 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
969 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description("test".to_string())));
970 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
974 fn test_hints_has_only_public_confd_channels() {
975 let chanmon_cfgs = create_chanmon_cfgs(2);
976 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
977 let mut config = test_default_channel_config();
978 config.channel_handshake_config.minimum_depth = 1;
979 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
980 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
982 // Create a private channel with lots of capacity and a lower value public channel (without
983 // confirming the funding tx yet).
984 let unannounced_scid = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0);
985 let conf_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 10_000, 0);
987 // Before the channel is available, we should include the unannounced_scid.
988 let mut scid_aliases = HashSet::new();
989 scid_aliases.insert(unannounced_scid.0.short_channel_id_alias.unwrap());
990 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
992 // However after we mine the funding tx and exchange channel_ready messages for the public
993 // channel we'll immediately switch to including it as a route hint, even though it isn't
995 let pub_channel_scid = mine_transaction(&nodes[0], &conf_tx);
996 let node_a_pub_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
997 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &node_a_pub_channel_ready);
999 assert_eq!(mine_transaction(&nodes[1], &conf_tx), pub_channel_scid);
1000 let events = nodes[1].node.get_and_clear_pending_msg_events();
1001 assert_eq!(events.len(), 2);
1002 if let MessageSendEvent::SendChannelReady { msg, .. } = &events[0] {
1003 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), msg);
1004 } else { panic!(); }
1005 if let MessageSendEvent::SendChannelUpdate { msg, .. } = &events[1] {
1006 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), msg);
1007 } else { panic!(); }
1009 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()));
1011 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1012 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1014 scid_aliases.clear();
1015 scid_aliases.insert(node_a_pub_channel_ready.short_channel_id_alias.unwrap());
1016 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
1017 // This also applies even if the amount is more than the payment amount, to ensure users
1018 // dont screw up their privacy.
1019 match_invoice_routes(Some(50_000_000), &nodes[1], scid_aliases.clone());
1021 // The same remains true until the channel has 7 confirmations, at which point we include
1023 connect_blocks(&nodes[1], 5);
1024 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
1025 connect_blocks(&nodes[1], 1);
1026 get_event_msg!(nodes[1], MessageSendEvent::SendAnnouncementSignatures, nodes[0].node.get_our_node_id());
1027 match_invoice_routes(Some(5000), &nodes[1], HashSet::new());
1031 fn test_hints_includes_single_channels_to_nodes() {
1032 let chanmon_cfgs = create_chanmon_cfgs(3);
1033 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1034 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1035 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1037 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1038 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1040 let mut scid_aliases = HashSet::new();
1041 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1042 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1044 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
1048 fn test_hints_has_only_lowest_inbound_capacity_channel_above_minimum() {
1049 let chanmon_cfgs = create_chanmon_cfgs(2);
1050 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1051 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1052 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1054 let _chan_1_0_inbound_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000, 0);
1055 let _chan_1_0_large_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 500_000, 0);
1056 let chan_1_0_low_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 200_000, 0);
1058 let mut scid_aliases = HashSet::new();
1059 scid_aliases.insert(chan_1_0_low_inbound_above_amt.0.short_channel_id_alias.unwrap());
1060 match_invoice_routes(Some(100_000_000), &nodes[0], scid_aliases);
1064 fn test_hints_has_only_online_channels() {
1065 let chanmon_cfgs = create_chanmon_cfgs(4);
1066 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1067 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1068 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1069 let chan_a = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0);
1070 let chan_b = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 10_000_000, 0);
1071 let _chan_c = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 1_000_000, 0);
1073 // With all peers connected we should get all hints that have sufficient value
1074 let mut scid_aliases = HashSet::new();
1075 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
1076 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1078 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1080 // With only one sufficient-value peer connected we should only get its hint
1081 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
1082 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());
1083 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1085 // If we don't have any sufficient-value peers connected we should get all hints with
1086 // sufficient value, even though there is a connected insufficient-value peer.
1087 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1088 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1089 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
1093 fn test_insufficient_inbound_sort_by_highest_capacity() {
1094 let chanmon_cfgs = create_chanmon_cfgs(5);
1095 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1096 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1097 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1098 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1099 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1100 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1101 let chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1103 // When no single channel has enough inbound capacity for the payment, we expect the three
1104 // highest inbound channels to be chosen.
1105 let mut scid_aliases = HashSet::new();
1106 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1107 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1108 scid_aliases.insert(chan_4_0.0.short_channel_id_alias.unwrap());
1110 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1114 fn test_sufficient_inbound_sort_by_lowest_capacity() {
1115 let chanmon_cfgs = create_chanmon_cfgs(5);
1116 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1117 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1118 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1119 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1120 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1121 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1122 let _chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1124 // When we have channels that have sufficient inbound for the payment, test that we sort
1125 // by lowest inbound capacity.
1126 let mut scid_aliases = HashSet::new();
1127 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1128 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1129 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1131 match_invoice_routes(Some(50_000_000), &nodes[0], scid_aliases.clone());
1135 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
1136 let chanmon_cfgs = create_chanmon_cfgs(3);
1137 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1138 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1139 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1140 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1142 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
1143 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1144 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1145 let mut private_chan_cfg = UserConfig::default();
1146 private_chan_cfg.channel_handshake_config.announced_channel = false;
1147 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();
1148 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
1149 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_channel);
1150 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
1151 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), &accept_channel);
1153 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
1155 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
1156 confirm_transaction_at(&nodes[2], &tx, conf_height);
1157 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
1158 confirm_transaction_at(&nodes[0], &tx, conf_height);
1159 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
1160 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
1161 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()));
1162 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1163 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
1164 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
1165 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
1166 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
1168 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
1169 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1170 // Therefore only `chan_1_0` should be included in the hints.
1171 let mut scid_aliases = HashSet::new();
1172 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1173 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
1177 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
1178 let chanmon_cfgs = create_chanmon_cfgs(3);
1179 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1180 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1181 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1182 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1184 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1185 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1186 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1188 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
1189 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
1190 // public channel between `nodes[2]` and `nodes[0]`
1191 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1195 fn test_only_public_channels_includes_no_channels_in_hints() {
1196 let chanmon_cfgs = create_chanmon_cfgs(3);
1197 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1198 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1199 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1200 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1201 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
1202 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
1204 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1205 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1206 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1208 // As all of `nodes[0]` channels are public, no channels should be included in the hints
1209 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1213 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
1214 let chanmon_cfgs = create_chanmon_cfgs(3);
1215 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1216 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1217 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1218 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1219 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0);
1221 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
1222 let mut scid_aliases_99_000_001_msat = HashSet::new();
1223 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1225 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
1227 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
1228 let mut scid_aliases_99_000_000_msat = HashSet::new();
1229 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1230 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1232 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
1234 // As the invoice amt is above all channels' inbound capacity, they will still be included
1235 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
1236 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1237 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1239 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
1241 // An invoice with no specified amount should include all channels in the route hints.
1242 let mut scid_aliases_no_specified_amount = HashSet::new();
1243 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1244 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1246 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
1249 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1250 invoice_amt: Option<u64>,
1251 invoice_node: &Node<'a, 'b, 'c>,
1252 mut chan_ids_to_match: HashSet<u64>
1254 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
1255 invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
1256 Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
1257 3600, None).unwrap();
1258 let hints = invoice.private_routes();
1261 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
1262 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1264 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1268 #[cfg(feature = "std")]
1269 fn test_multi_node_receive() {
1270 do_test_multi_node_receive(true);
1271 do_test_multi_node_receive(false);
1274 #[cfg(feature = "std")]
1275 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
1276 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1277 let seed_1 = [42u8; 32];
1278 let seed_2 = [43u8; 32];
1279 let cross_node_seed = [44u8; 32];
1280 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1281 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1282 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1283 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1284 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1285 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1286 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
1287 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
1288 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1289 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1290 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1292 let payment_amt = 10_000;
1293 let route_hints = vec![
1294 nodes[1].node.get_phantom_route_hints(),
1295 nodes[2].node.get_phantom_route_hints(),
1298 let user_payment_preimage = PaymentPreimage([1; 32]);
1299 let payment_hash = if user_generated_pmt_hash {
1300 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
1304 let genesis_timestamp = bitcoin::blockdata::constants::genesis_block(bitcoin::Network::Testnet).header.time as u64;
1305 let non_default_invoice_expiry_secs = 4200;
1308 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
1309 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1310 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1311 Currency::BitcoinTestnet, None, Duration::from_secs(genesis_timestamp)
1313 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
1314 let payment_preimage = if user_generated_pmt_hash {
1315 user_payment_preimage
1317 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1320 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1321 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description("test".to_string())));
1322 assert_eq!(invoice.route_hints().len(), 2);
1323 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1324 assert!(!invoice.features().unwrap().supports_basic_mpp());
1326 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
1327 invoice.min_final_cltv_expiry_delta() as u32)
1328 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
1329 .with_route_hints(invoice.route_hints()).unwrap();
1330 let params = RouteParameters {
1332 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
1334 let (payment_event, fwd_idx) = {
1335 let mut payment_hash = PaymentHash([0; 32]);
1336 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1337 nodes[0].node.send_payment(payment_hash,
1338 RecipientOnionFields::secret_only(*invoice.payment_secret()),
1339 PaymentId(payment_hash.0), params, Retry::Attempts(0)).unwrap();
1340 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1341 assert_eq!(added_monitors.len(), 1);
1342 added_monitors.clear();
1344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345 assert_eq!(events.len(), 1);
1346 let fwd_idx = match events[0] {
1347 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1348 if node_id == nodes[1].node.get_our_node_id() {
1352 _ => panic!("Unexpected event")
1354 (SendEvent::from_event(events.remove(0)), fwd_idx)
1356 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1357 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1359 // Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
1360 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1361 // payments "look real" by taking more time.
1362 let other_events = RefCell::new(Vec::new());
1363 let forward_event_handler = |event: Event| {
1364 if let Event::PendingHTLCsForwardable { .. } = event {
1365 nodes[fwd_idx].node.process_pending_htlc_forwards();
1367 other_events.borrow_mut().push(event);
1370 nodes[fwd_idx].node.process_pending_events(&forward_event_handler);
1371 nodes[fwd_idx].node.process_pending_events(&forward_event_handler);
1373 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1374 assert_eq!(other_events.borrow().len(), 1);
1375 check_payment_claimable(&other_events.borrow()[0], payment_hash, payment_secret, payment_amt, payment_preimage_opt, invoice.recover_payee_pub_key());
1376 do_claim_payment_along_route(&nodes[0], &[&vec!(&nodes[fwd_idx])[..]], false, payment_preimage);
1377 let events = nodes[0].node.get_and_clear_pending_events();
1378 assert_eq!(events.len(), 2);
1380 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1381 assert_eq!(payment_preimage, *ev_preimage);
1382 assert_eq!(payment_hash, *ev_hash);
1383 assert_eq!(fee_paid_msat, &Some(0));
1385 _ => panic!("Unexpected event")
1388 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1389 assert_eq!(hash, Some(payment_hash));
1391 _ => panic!("Unexpected event")
1396 #[cfg(feature = "std")]
1397 fn test_multi_node_hints_has_htlc_min_max_values() {
1398 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1399 let seed_1 = [42u8; 32];
1400 let seed_2 = [43u8; 32];
1401 let cross_node_seed = [44u8; 32];
1402 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1403 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1404 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1405 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1406 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1408 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1409 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1411 let payment_amt = 20_000;
1412 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600, None).unwrap();
1413 let route_hints = vec![
1414 nodes[1].node.get_phantom_route_hints(),
1415 nodes[2].node.get_phantom_route_hints(),
1418 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1419 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
1420 "test".to_string(), 3600, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1421 nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1423 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1424 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1425 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1427 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1428 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1429 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1433 #[cfg(feature = "std")]
1434 fn create_phantom_invoice_with_description_hash() {
1435 let chanmon_cfgs = create_chanmon_cfgs(3);
1436 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1437 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1438 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1440 let payment_amt = 20_000;
1441 let route_hints = vec![
1442 nodes[1].node.get_phantom_route_hints(),
1443 nodes[2].node.get_phantom_route_hints(),
1446 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1447 let non_default_invoice_expiry_secs = 4200;
1448 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1449 &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger,
1451 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1452 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1453 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
1456 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1457 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1458 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1459 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1463 #[cfg(feature = "std")]
1464 fn create_phantom_invoice_with_custom_payment_hash_and_custom_min_final_cltv_delta() {
1465 let chanmon_cfgs = create_chanmon_cfgs(3);
1466 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1467 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1468 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1470 let payment_amt = 20_000;
1471 let route_hints = vec![
1472 nodes[1].node.get_phantom_route_hints(),
1473 nodes[2].node.get_phantom_route_hints(),
1475 let user_payment_preimage = PaymentPreimage([1; 32]);
1476 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
1477 let non_default_invoice_expiry_secs = 4200;
1478 let min_final_cltv_expiry_delta = Some(100);
1479 let duration_since_epoch = Duration::from_secs(1234567);
1480 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1481 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
1482 "".to_string(), non_default_invoice_expiry_secs, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1483 nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
1484 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1485 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
1486 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1490 #[cfg(feature = "std")]
1491 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1492 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1493 let seed_1 = [42u8; 32];
1494 let seed_2 = [43u8; 32];
1495 let cross_node_seed = [44u8; 32];
1496 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1497 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1498 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1499 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1500 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1502 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1503 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1505 let mut scid_aliases = HashSet::new();
1506 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1507 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1509 match_multi_node_invoice_routes(
1512 vec![&nodes[1], &nodes[2],],
1519 #[cfg(feature = "std")]
1520 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1521 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1522 let seed_1 = [42u8; 32];
1523 let seed_2 = [43u8; 32];
1524 let cross_node_seed = [44u8; 32];
1525 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1526 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1527 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1528 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1529 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1531 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1532 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1533 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005);
1535 let mut scid_aliases = HashSet::new();
1536 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1537 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1538 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1540 match_multi_node_invoice_routes(
1543 vec![&nodes[2], &nodes[3],],
1550 #[cfg(feature = "std")]
1551 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1552 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1553 let seed_1 = [42u8; 32];
1554 let seed_2 = [43u8; 32];
1555 let cross_node_seed = [44u8; 32];
1556 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1557 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1558 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1559 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1560 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1562 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1563 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1565 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1566 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1567 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1568 let mut private_chan_cfg = UserConfig::default();
1569 private_chan_cfg.channel_handshake_config.announced_channel = false;
1570 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();
1571 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1572 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
1573 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1574 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), &accept_channel);
1576 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1578 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1579 confirm_transaction_at(&nodes[1], &tx, conf_height);
1580 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1581 confirm_transaction_at(&nodes[3], &tx, conf_height);
1582 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1583 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1584 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()));
1585 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1586 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1587 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1588 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1589 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1591 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1592 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1593 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1594 let mut scid_aliases = HashSet::new();
1595 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1596 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1598 match_multi_node_invoice_routes(
1601 vec![&nodes[2], &nodes[3],],
1608 #[cfg(feature = "std")]
1609 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1610 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1611 let seed_1 = [42u8; 32];
1612 let seed_2 = [43u8; 32];
1613 let cross_node_seed = [44u8; 32];
1614 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1615 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1616 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1617 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1618 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1620 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1622 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1623 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1624 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1626 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1627 // `chan_0_2` as `nodes[2]` only has public channels.
1628 let mut scid_aliases = HashSet::new();
1629 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1631 match_multi_node_invoice_routes(
1634 vec![&nodes[1], &nodes[2],],
1641 #[cfg(feature = "std")]
1642 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1643 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1644 let seed_1 = [42u8; 32];
1645 let seed_2 = [43u8; 32];
1646 let cross_node_seed = [44u8; 32];
1647 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1648 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1649 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1650 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1651 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1653 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1654 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1655 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1656 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
1658 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001);
1660 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1661 // channels for `nodes[2]` as it contains a mix of public and private channels.
1662 let mut scid_aliases = HashSet::new();
1663 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1665 match_multi_node_invoice_routes(
1668 vec![&nodes[2], &nodes[3],],
1675 #[cfg(feature = "std")]
1676 fn test_multi_node_hints_has_only_lowest_inbound_channel_above_minimum() {
1677 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1678 let seed_1 = [42u8; 32];
1679 let seed_2 = [43u8; 32];
1680 let cross_node_seed = [44u8; 32];
1681 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1682 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1683 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1684 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1685 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1687 let _chan_0_1_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1688 let _chan_0_1_above_amt_high_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 500_000, 0);
1689 let chan_0_1_above_amt_low_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 180_000, 0);
1690 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1692 let mut scid_aliases = HashSet::new();
1693 scid_aliases.insert(chan_0_1_above_amt_low_inbound.0.short_channel_id_alias.unwrap());
1694 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1696 match_multi_node_invoice_routes(
1699 vec![&nodes[1], &nodes[2],],
1706 #[cfg(feature = "std")]
1707 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1708 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1709 let seed_1 = [42u8; 32];
1710 let seed_2 = [43u8; 32];
1711 let cross_node_seed = [44u8; 32];
1712 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1713 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1714 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1715 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1716 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1718 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1719 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0);
1720 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0);
1722 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1723 let mut scid_aliases_99_000_001_msat = HashSet::new();
1724 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1725 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1727 match_multi_node_invoice_routes(
1730 vec![&nodes[2], &nodes[3],],
1731 scid_aliases_99_000_001_msat,
1735 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1736 let mut scid_aliases_99_000_000_msat = HashSet::new();
1737 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1738 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1739 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1741 match_multi_node_invoice_routes(
1744 vec![&nodes[2], &nodes[3],],
1745 scid_aliases_99_000_000_msat,
1749 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1750 // `nodes[2]` them should be included.
1751 let mut scid_aliases_300_000_000_msat = HashSet::new();
1752 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1753 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1754 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1756 match_multi_node_invoice_routes(
1759 vec![&nodes[2], &nodes[3],],
1760 scid_aliases_300_000_000_msat,
1764 // Since the no specified amount, all channels should included.
1765 let mut scid_aliases_no_specified_amount = HashSet::new();
1766 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1767 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1768 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1770 match_multi_node_invoice_routes(
1773 vec![&nodes[2], &nodes[3],],
1774 scid_aliases_no_specified_amount,
1780 fn test_multi_node_hints_limited_to_3() {
1781 let mut chanmon_cfgs = create_chanmon_cfgs(6);
1782 let seed_1 = [42 as u8; 32];
1783 let seed_2 = [43 as u8; 32];
1784 let seed_3 = [44 as u8; 32];
1785 let seed_4 = [45 as u8; 32];
1786 let cross_node_seed = [44 as u8; 32];
1787 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1788 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1789 chanmon_cfgs[4].keys_manager.backing = PhantomKeysManager::new(&seed_3, 43, 44, &cross_node_seed);
1790 chanmon_cfgs[5].keys_manager.backing = PhantomKeysManager::new(&seed_4, 43, 44, &cross_node_seed);
1791 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1792 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1793 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1795 // Setup each phantom node with two channels from distinct peers.
1796 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 10_000, 0);
1797 let chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 20_000, 0);
1798 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 20_000, 0);
1799 let _chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 10_000, 0);
1800 let chan_0_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 4, 20_000, 0);
1801 let _chan_1_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000, 0);
1802 let _chan_0_5 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 5, 20_000, 0);
1803 let _chan_1_5 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000, 0);
1805 // Set invoice amount > all channels inbound so that every one is eligible for inclusion
1806 // and hints will be sorted by largest inbound capacity.
1807 let invoice_amt = Some(100_000_000);
1809 // With 4 phantom nodes, assert that we include 1 hint per node, up to 3 nodes.
1810 let mut scid_aliases = HashSet::new();
1811 scid_aliases.insert(chan_1_2.0.short_channel_id_alias.unwrap());
1812 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1813 scid_aliases.insert(chan_0_4.0.short_channel_id_alias.unwrap());
1815 match_multi_node_invoice_routes(
1818 vec![&nodes[2], &nodes[3], &nodes[4], &nodes[5]],
1823 // With 2 phantom nodes, assert that we include no more than 3 hints.
1824 let mut scid_aliases = HashSet::new();
1825 scid_aliases.insert(chan_1_2.0.short_channel_id_alias.unwrap());
1826 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1827 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1829 match_multi_node_invoice_routes(
1832 vec![&nodes[2], &nodes[3]],
1839 fn test_multi_node_hints_at_least_3() {
1840 let mut chanmon_cfgs = create_chanmon_cfgs(5);
1841 let seed_1 = [42 as u8; 32];
1842 let seed_2 = [43 as u8; 32];
1843 let cross_node_seed = [44 as u8; 32];
1844 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1845 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1846 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1847 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1848 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1850 let _chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 10_000, 0);
1851 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 20_000, 0);
1852 let chan_2_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 30_000, 0);
1853 let chan_0_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 4, 10_000, 0);
1855 // Since the invoice amount is above all channels inbound, all four are eligible. Test that
1856 // we still include 3 hints from 2 distinct nodes sorted by inbound.
1857 let mut scid_aliases = HashSet::new();
1858 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1859 scid_aliases.insert(chan_2_3.0.short_channel_id_alias.unwrap());
1860 scid_aliases.insert(chan_0_4.0.short_channel_id_alias.unwrap());
1862 match_multi_node_invoice_routes(
1865 vec![&nodes[3], &nodes[4],],
1871 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1872 invoice_amt: Option<u64>,
1873 invoice_node: &Node<'a, 'b, 'c>,
1874 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1875 mut chan_ids_to_match: HashSet<u64>,
1876 nodes_contains_public_channels: bool
1878 let phantom_route_hints = network_multi_nodes.iter()
1879 .map(|node| node.node.get_phantom_route_hints())
1880 .collect::<Vec<PhantomRouteHints>>();
1881 let phantom_scids = phantom_route_hints.iter()
1882 .map(|route_hint| route_hint.phantom_scid)
1883 .collect::<HashSet<u64>>();
1885 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1886 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
1887 3600, phantom_route_hints, invoice_node.keys_manager, invoice_node.keys_manager,
1888 invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1890 let invoice_hints = invoice.private_routes();
1892 for hint in invoice_hints {
1893 let hints = &(hint.0).0;
1896 assert!(nodes_contains_public_channels);
1897 let phantom_scid = hints[0].short_channel_id;
1898 assert!(phantom_scids.contains(&phantom_scid));
1901 let hint_short_chan_id = hints[0].short_channel_id;
1902 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1903 let phantom_scid = hints[1].short_channel_id;
1904 assert!(phantom_scids.contains(&phantom_scid));
1906 _ => panic!("Incorrect hint length generated")
1909 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1913 fn test_create_invoice_fails_with_invalid_custom_min_final_cltv_expiry_delta() {
1914 let chanmon_cfgs = create_chanmon_cfgs(2);
1915 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1916 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1917 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1918 let result = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
1919 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
1920 Some(10_000), "Some description".into(), Duration::from_secs(1234567), 3600, Some(MIN_FINAL_CLTV_EXPIRY_DELTA - 4),
1923 Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort)) => {},
1929 fn test_rotate_through_iterators() {
1930 // two nested vectors
1931 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec!["a1", "b1"].into_iter()];
1932 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1934 let expected = vec!["a0", "a1", "b0", "b1", "c0"];
1935 assert_eq!(expected, result);
1937 // test single nested vector
1938 let a = vec![vec!["a0", "b0", "c0"].into_iter()];
1939 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1941 let expected = vec!["a0", "b0", "c0"];
1942 assert_eq!(expected, result);
1944 // test second vector with only one element
1945 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec!["a1"].into_iter()];
1946 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1948 let expected = vec!["a0", "a1", "b0", "c0"];
1949 assert_eq!(expected, result);
1951 // test three nestend vectors
1952 let a = vec![vec!["a0"].into_iter(), vec!["a1", "b1", "c1"].into_iter(), vec!["a2"].into_iter()];
1953 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1955 let expected = vec!["a0", "a1", "a2", "b1", "c1"];
1956 assert_eq!(expected, result);
1958 // test single nested vector with a single value
1959 let a = vec![vec!["a0"].into_iter()];
1960 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1962 let expected = vec!["a0"];
1963 assert_eq!(expected, result);
1965 // test single empty nested vector
1966 let a:Vec<std::vec::IntoIter<&str>> = vec![vec![].into_iter()];
1967 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1968 let expected:Vec<&str> = vec![];
1970 assert_eq!(expected, result);
1972 // test first nested vector is empty
1973 let a:Vec<std::vec::IntoIter<&str>>= vec![vec![].into_iter(), vec!["a1", "b1", "c1"].into_iter()];
1974 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1976 let expected = vec!["a1", "b1", "c1"];
1977 assert_eq!(expected, result);
1979 // test two empty vectors
1980 let a:Vec<std::vec::IntoIter<&str>> = vec![vec![].into_iter(), vec![].into_iter()];
1981 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1983 let expected:Vec<&str> = vec![];
1984 assert_eq!(expected, result);
1986 // test an empty vector amongst other filled vectors
1988 vec!["a0", "b0", "c0"].into_iter(),
1990 vec!["a1", "b1", "c1"].into_iter(),
1991 vec!["a2", "b2", "c2"].into_iter(),
1993 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1995 let expected = vec!["a0", "a1", "a2", "b0", "b1", "b2", "c0", "c1", "c2"];
1996 assert_eq!(expected, result);
1998 // test a filled vector between two empty vectors
1999 let a = vec![vec![].into_iter(), vec!["a1", "b1", "c1"].into_iter(), vec![].into_iter()];
2000 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2002 let expected = vec!["a1", "b1", "c1"];
2003 assert_eq!(expected, result);
2005 // test an empty vector at the end of the vectors
2006 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec![].into_iter()];
2007 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2009 let expected = vec!["a0", "b0", "c0"];
2010 assert_eq!(expected, result);
2012 // test multiple empty vectors amongst multiple filled vectors
2015 vec!["a1", "b1", "c1"].into_iter(),
2017 vec!["a3", "b3"].into_iter(),
2021 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2023 let expected = vec!["a1", "a3", "b1", "b3", "c1"];
2024 assert_eq!(expected, result);
2026 // test one element in the first nested vectore and two elements in the second nested
2028 let a = vec![vec!["a0"].into_iter(), vec!["a1", "b1"].into_iter()];
2029 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2031 let expected = vec!["a0", "a1", "b1"];
2032 assert_eq!(expected, result);