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::types::{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, Record};
18 use secp256k1::PublicKey;
19 use alloc::collections::{btree_map, BTreeMap};
21 use core::time::Duration;
22 #[cfg(not(feature = "std"))]
23 use core::iter::Iterator;
25 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
26 /// See [`PhantomKeysManager`] for more information on phantom node payments.
28 /// `phantom_route_hints` parameter:
29 /// * Contains channel info for all nodes participating in the phantom invoice
30 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
31 /// participating node
32 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
33 /// updated when a channel becomes disabled or closes
34 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
35 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
38 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
39 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
40 /// If `None` is provided for `payment_hash`, then one will be created.
42 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
43 /// in excess of the current time.
45 /// `duration_since_epoch` is the current time since epoch in seconds.
47 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
48 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
49 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
50 /// confirmations during routing.
52 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
53 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
56 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
57 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
58 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
59 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
60 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
61 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
63 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
64 /// available and the current time is supplied by the caller.
65 pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
66 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
67 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
68 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
69 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
71 ES::Target: EntropySource,
72 NS::Target: NodeSigner,
75 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
76 let description = Bolt11InvoiceDescription::Direct(&description,);
77 _create_phantom_invoice::<ES, NS, L>(
78 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
79 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
83 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
84 /// See [`PhantomKeysManager`] for more information on phantom node payments.
86 /// `phantom_route_hints` parameter:
87 /// * Contains channel info for all nodes participating in the phantom invoice
88 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
89 /// participating node
90 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
91 /// updated when a channel becomes disabled or closes
92 /// * Note that the route hints generated from `phantom_route_hints` will be limited to a maximum
93 /// of 3 hints to ensure that the invoice can be scanned in a QR code. These hints are selected
94 /// in the order that the nodes in `PhantomRouteHints` are specified, selecting one hint per node
95 /// until the maximum is hit. Callers may provide as many `PhantomRouteHints::channels` as
96 /// desired, but note that some nodes will be trimmed if more than 3 nodes are provided.
98 /// `description_hash` is a SHA-256 hash of the description text
100 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
101 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
102 /// If `None` is provided for `payment_hash`, then one will be created.
104 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
105 /// in excess of the current time.
107 /// `duration_since_epoch` is the current time since epoch in seconds.
109 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
110 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
113 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
114 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
115 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
116 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
117 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
119 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
120 /// available and the current time is supplied by the caller.
121 pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
122 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
123 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
124 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
125 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
127 ES::Target: EntropySource,
128 NS::Target: NodeSigner,
131 _create_phantom_invoice::<ES, NS, L>(
132 amt_msat, payment_hash, Bolt11InvoiceDescription::Hash(&description_hash),
133 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
134 min_final_cltv_expiry_delta, duration_since_epoch,
138 const MAX_CHANNEL_HINTS: usize = 3;
140 fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
141 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: Bolt11InvoiceDescription,
142 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
143 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
144 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
146 ES::Target: EntropySource,
147 NS::Target: NodeSigner,
151 if phantom_route_hints.is_empty() {
152 return Err(SignOrCreationError::CreationError(
153 CreationError::MissingRouteHints,
157 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
158 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
161 let invoice = match description {
162 Bolt11InvoiceDescription::Direct(description) => {
163 InvoiceBuilder::new(network).description(description.0.0.clone())
165 Bolt11InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
168 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
169 let keys = ExpandedKey::new(&node_signer.get_inbound_payment_key_material());
170 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
171 let payment_secret = create_from_hash(
175 invoice_expiry_delta_secs,
178 min_final_cltv_expiry_delta,
180 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
181 (payment_hash, payment_secret)
186 invoice_expiry_delta_secs,
190 min_final_cltv_expiry_delta,
192 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
195 log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
196 phantom_route_hints.len(), &payment_hash);
198 let mut invoice = invoice
199 .duration_since_epoch(duration_since_epoch)
200 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
201 .payment_secret(payment_secret)
202 .min_final_cltv_expiry_delta(
203 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
204 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
205 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
206 if let Some(amt) = amt_msat {
207 invoice = invoice.amount_milli_satoshis(amt);
211 for route_hint in select_phantom_hints(amt_msat, phantom_route_hints, logger).take(MAX_CHANNEL_HINTS) {
212 invoice = invoice.private_route(route_hint);
215 let raw_invoice = match invoice.build_raw() {
217 Err(e) => return Err(SignOrCreationError::CreationError(e))
219 let hrp_str = raw_invoice.hrp.to_string();
220 let hrp_bytes = hrp_str.as_bytes();
221 let data_without_signature = raw_invoice.data.to_base32();
222 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
223 match signed_raw_invoice {
224 Ok(inv) => Ok(Bolt11Invoice::from_signed(inv).unwrap()),
225 Err(e) => Err(SignOrCreationError::SignError(e))
229 /// Utility to select route hints for phantom invoices.
230 /// See [`PhantomKeysManager`] for more information on phantom node payments.
232 /// To ensure that the phantom invoice is still readable by QR code, we limit to 3 hints per invoice:
233 /// * Select up to three channels per node.
234 /// * Select one hint from each node, up to three hints or until we run out of hints.
236 /// [`PhantomKeysManager`]: lightning::sign::PhantomKeysManager
237 fn select_phantom_hints<L: Deref>(amt_msat: Option<u64>, phantom_route_hints: Vec<PhantomRouteHints>,
238 logger: L) -> impl Iterator<Item = RouteHint>
242 let mut phantom_hints: Vec<_> = Vec::new();
244 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
245 log_trace!(logger, "Generating phantom route hints for node {}",
246 log_pubkey!(real_node_pubkey));
247 let route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
249 // If we have any public channel, the route hints from `sort_and_filter_channels` will be
250 // empty. In that case we create a RouteHint on which we will push a single hop with the
251 // phantom route into the invoice, and let the sender find the path to the `real_node_pubkey`
252 // node by looking at our public channels.
253 let empty_route_hints = route_hints.len() == 0;
254 let mut have_pushed_empty = false;
255 let route_hints = route_hints
256 .chain(core::iter::from_fn(move || {
257 if empty_route_hints && !have_pushed_empty {
258 // set flag of having handled the empty route_hints and ensure empty vector
259 // returned only once
260 have_pushed_empty = true;
261 Some(RouteHint(Vec::new()))
266 .map(move |mut hint| {
267 hint.0.push(RouteHintHop {
268 src_node_id: real_node_pubkey,
269 short_channel_id: phantom_scid,
272 proportional_millionths: 0,
274 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
275 htlc_minimum_msat: None,
276 htlc_maximum_msat: None,
281 phantom_hints.push(route_hints);
284 // We have one vector per real node involved in creating the phantom invoice. To distribute
285 // the hints across our real nodes we add one hint from each in turn until no node has any hints
286 // left (if one node has more hints than any other, these will accumulate at the end of the
288 rotate_through_iterators(phantom_hints)
291 /// Draw items iteratively from multiple iterators. The items are retrieved by index and
292 /// rotates through the iterators - first the zero index then the first index then second index, etc.
293 fn rotate_through_iterators<T, I: Iterator<Item = T>>(mut vecs: Vec<I>) -> impl Iterator<Item = T> {
294 let mut iterations = 0;
296 core::iter::from_fn(move || {
297 let mut exhausted_iterators = 0;
302 let next_idx = iterations % vecs.len();
304 if let Some(item) = vecs[next_idx].next() {
307 // exhausted_vectors increase when the "next_idx" vector is exhausted
308 exhausted_iterators += 1;
309 // The check for exhausted iterators gets reset to 0 after each yield of `Some()`
310 // The loop will return None when all of the nested iterators are exhausted
311 if exhausted_iterators == vecs.len() {
318 #[cfg(feature = "std")]
319 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
320 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
321 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
322 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
323 /// that the payment secret is valid when the invoice is paid.
325 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
326 /// in excess of the current time.
328 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
329 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
330 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
331 /// confirmations during routing.
333 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
334 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
335 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
336 network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32,
337 min_final_cltv_expiry_delta: Option<u16>,
338 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
340 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
341 T::Target: BroadcasterInterface,
342 ES::Target: EntropySource,
343 NS::Target: NodeSigner,
344 SP::Target: SignerProvider,
345 F::Target: FeeEstimator,
349 use std::time::SystemTime;
350 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
351 .expect("for the foreseeable future this shouldn't happen");
352 create_invoice_from_channelmanager_and_duration_since_epoch(
353 channelmanager, node_signer, logger, network, amt_msat,
354 description, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
358 #[cfg(feature = "std")]
359 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
360 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
361 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
362 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
363 /// that the payment secret is valid when the invoice is paid.
364 /// Use this variant if you want to pass the `description_hash` to the invoice.
366 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
367 /// in excess of the current time.
369 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
370 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
371 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
372 /// confirmations during routing.
374 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
375 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>(
376 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
377 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
378 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
379 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
381 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
382 T::Target: BroadcasterInterface,
383 ES::Target: EntropySource,
384 NS::Target: NodeSigner,
385 SP::Target: SignerProvider,
386 F::Target: FeeEstimator,
390 use std::time::SystemTime;
392 let duration = SystemTime::now()
393 .duration_since(SystemTime::UNIX_EPOCH)
394 .expect("for the foreseeable future this shouldn't happen");
396 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
397 channelmanager, node_signer, logger, network, amt_msat,
398 description_hash, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
402 /// See [`create_invoice_from_channelmanager_with_description_hash`]
403 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
404 /// available and the current time is supplied by the caller.
405 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>(
406 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
407 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
408 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
409 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
411 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
412 T::Target: BroadcasterInterface,
413 ES::Target: EntropySource,
414 NS::Target: NodeSigner,
415 SP::Target: SignerProvider,
416 F::Target: FeeEstimator,
420 _create_invoice_from_channelmanager_and_duration_since_epoch(
421 channelmanager, node_signer, logger, network, amt_msat,
422 Bolt11InvoiceDescription::Hash(&description_hash),
423 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
427 /// See [`create_invoice_from_channelmanager`]
428 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
429 /// available and the current time is supplied by the caller.
430 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>(
431 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
432 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
433 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
434 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
436 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
437 T::Target: BroadcasterInterface,
438 ES::Target: EntropySource,
439 NS::Target: NodeSigner,
440 SP::Target: SignerProvider,
441 F::Target: FeeEstimator,
445 _create_invoice_from_channelmanager_and_duration_since_epoch(
446 channelmanager, node_signer, logger, network, amt_msat,
447 Bolt11InvoiceDescription::Direct(
448 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
450 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
454 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>(
455 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
456 network: Currency, amt_msat: Option<u64>, description: Bolt11InvoiceDescription,
457 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
458 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
460 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
461 T::Target: BroadcasterInterface,
462 ES::Target: EntropySource,
463 NS::Target: NodeSigner,
464 SP::Target: SignerProvider,
465 F::Target: FeeEstimator,
469 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
470 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
473 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
475 let (payment_hash, payment_secret) = channelmanager
476 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs, min_final_cltv_expiry_delta)
477 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
478 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
479 channelmanager, node_signer, logger, network, amt_msat, description, duration_since_epoch,
480 invoice_expiry_delta_secs, payment_hash, payment_secret, min_final_cltv_expiry_delta)
483 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
484 /// This version allows for providing a custom [`PaymentHash`] for the invoice.
485 /// This may be useful if you're building an on-chain swap or involving another protocol where
486 /// the payment hash is also involved outside the scope of lightning.
487 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>(
488 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
489 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
490 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, min_final_cltv_expiry_delta: Option<u16>,
491 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
493 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
494 T::Target: BroadcasterInterface,
495 ES::Target: EntropySource,
496 NS::Target: NodeSigner,
497 SP::Target: SignerProvider,
498 F::Target: FeeEstimator,
502 let payment_secret = channelmanager
503 .create_inbound_payment_for_hash(payment_hash, amt_msat, invoice_expiry_delta_secs,
504 min_final_cltv_expiry_delta)
505 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
506 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
507 channelmanager, node_signer, logger, network, amt_msat,
508 Bolt11InvoiceDescription::Direct(
509 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
511 duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret,
512 min_final_cltv_expiry_delta,
516 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>(
517 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
518 network: Currency, amt_msat: Option<u64>, description: Bolt11InvoiceDescription,
519 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, payment_hash: PaymentHash,
520 payment_secret: PaymentSecret, min_final_cltv_expiry_delta: Option<u16>,
521 ) -> Result<Bolt11Invoice, SignOrCreationError<()>>
523 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
524 T::Target: BroadcasterInterface,
525 ES::Target: EntropySource,
526 NS::Target: NodeSigner,
527 SP::Target: SignerProvider,
528 F::Target: FeeEstimator,
532 let our_node_pubkey = channelmanager.get_our_node_id();
533 let channels = channelmanager.list_channels();
535 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
536 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
539 log_trace!(logger, "Creating invoice with payment hash {}", &payment_hash);
541 let invoice = match description {
542 Bolt11InvoiceDescription::Direct(description) => {
543 InvoiceBuilder::new(network).description(description.0.0.clone())
545 Bolt11InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
548 let mut invoice = invoice
549 .duration_since_epoch(duration_since_epoch)
550 .payee_pub_key(our_node_pubkey)
551 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
552 .payment_secret(payment_secret)
554 .min_final_cltv_expiry_delta(
555 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
556 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
557 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
558 if let Some(amt) = amt_msat {
559 invoice = invoice.amount_milli_satoshis(amt);
562 let route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
563 for hint in route_hints {
564 invoice = invoice.private_route(hint);
567 let raw_invoice = match invoice.build_raw() {
569 Err(e) => return Err(SignOrCreationError::CreationError(e))
571 let hrp_str = raw_invoice.hrp.to_string();
572 let hrp_bytes = hrp_str.as_bytes();
573 let data_without_signature = raw_invoice.data.to_base32();
574 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
575 match signed_raw_invoice {
576 Ok(inv) => Ok(Bolt11Invoice::from_signed(inv).unwrap()),
577 Err(e) => Err(SignOrCreationError::SignError(e))
581 /// Sorts and filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
584 /// The filtering is based on the following criteria:
585 /// * Only one channel per counterparty node
586 /// * If the counterparty has a channel that is above the `min_inbound_capacity_msat` + 10% scaling
587 /// factor (to allow some margin for change in inbound), select the channel with the lowest
588 /// inbound capacity that is above this threshold.
589 /// * If no `min_inbound_capacity_msat` is specified, or the counterparty has no channels above the
590 /// minimum + 10% scaling factor, select the channel with the highest inbound capacity per counterparty.
591 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
592 /// `is_usable` (i.e. the peer is connected).
593 /// * If any public channel exists, only public [`RouteHint`]s will be returned.
594 /// * If any public, announced, channel exists (i.e. a channel with 7+ confs, to ensure the
595 /// announcement has had a chance to propagate), no [`RouteHint`]s will be returned, as the
596 /// sender is expected to find the path by looking at the public channels instead.
597 /// * Limited to a total of 3 channels.
598 /// * Sorted by lowest inbound capacity if an online channel with the minimum amount requested exists,
599 /// otherwise sort by highest inbound capacity to give the payment the best chance of succeeding.
600 fn sort_and_filter_channels<L: Deref>(
601 channels: Vec<ChannelDetails>,
602 min_inbound_capacity_msat: Option<u64>,
604 ) -> impl ExactSizeIterator<Item = RouteHint>
608 let mut filtered_channels: BTreeMap<PublicKey, ChannelDetails> = BTreeMap::new();
609 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
610 let mut min_capacity_channel_exists = false;
611 let mut online_channel_exists = false;
612 let mut online_min_capacity_channel_exists = false;
613 let mut has_pub_unconf_chan = false;
615 let route_hint_from_channel = |channel: ChannelDetails| {
616 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
617 RouteHint(vec![RouteHintHop {
618 src_node_id: channel.counterparty.node_id,
619 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
621 base_msat: forwarding_info.fee_base_msat,
622 proportional_millionths: forwarding_info.fee_proportional_millionths,
624 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
625 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
626 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
629 log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
630 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
631 let logger = WithChannelDetails::from(logger, &channel);
632 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
633 log_trace!(logger, "Ignoring channel {} for invoice route hints", &channel.channel_id);
637 if channel.is_public {
638 if channel.confirmations.is_some() && channel.confirmations < Some(7) {
639 // If we have a public channel, but it doesn't have enough confirmations to (yet)
640 // be in the public network graph (and have gotten a chance to propagate), include
641 // route hints but only for public channels to protect private channel privacy.
642 has_pub_unconf_chan = true;
644 // If any public channel exists, return no hints and let the sender
645 // look at the public channels instead.
646 log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
647 &channel.channel_id);
648 return vec![].into_iter().take(MAX_CHANNEL_HINTS).map(route_hint_from_channel);
652 if channel.inbound_capacity_msat >= min_inbound_capacity {
653 if !min_capacity_channel_exists {
654 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
655 min_capacity_channel_exists = true;
658 if channel.is_usable {
659 online_min_capacity_channel_exists = true;
663 if channel.is_usable && !online_channel_exists {
664 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
665 online_channel_exists = true;
668 match filtered_channels.entry(channel.counterparty.node_id) {
669 btree_map::Entry::Occupied(mut entry) => {
670 let current_max_capacity = entry.get().inbound_capacity_msat;
671 // If this channel is public and the previous channel is not, ensure we replace the
672 // previous channel to avoid announcing non-public channels.
673 let new_now_public = channel.is_public && !entry.get().is_public;
674 // Decide whether we prefer the currently selected channel with the node to the new one,
675 // based on their inbound capacity.
676 let prefer_current = prefer_current_channel(min_inbound_capacity_msat, current_max_capacity,
677 channel.inbound_capacity_msat);
678 // If the public-ness of the channel has not changed (in which case simply defer to
679 // `new_now_public), and this channel has more desirable inbound than the incumbent,
680 // prefer to include this channel.
681 let new_channel_preferable = channel.is_public == entry.get().is_public && !prefer_current;
683 if new_now_public || new_channel_preferable {
685 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
686 log_pubkey!(channel.counterparty.node_id),
687 &channel.channel_id, channel.short_channel_id,
688 channel.inbound_capacity_msat,
689 &entry.get().channel_id, entry.get().short_channel_id,
690 current_max_capacity);
691 entry.insert(channel);
694 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
695 log_pubkey!(channel.counterparty.node_id),
696 &entry.get().channel_id, entry.get().short_channel_id,
697 current_max_capacity,
698 &channel.channel_id, channel.short_channel_id,
699 channel.inbound_capacity_msat);
702 btree_map::Entry::Vacant(entry) => {
703 entry.insert(channel);
708 // If all channels are private, prefer to return route hints which have a higher capacity than
709 // the payment value and where we're currently connected to the channel counterparty.
710 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
711 // those which meet at least one criteria.
712 let mut eligible_channels = filtered_channels
714 .map(|(_, channel)| channel)
716 let logger = WithChannelDetails::from(logger, &channel);
717 let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
718 let include_channel = if has_pub_unconf_chan {
719 // If we have a public channel, but it doesn't have enough confirmations to (yet)
720 // be in the public network graph (and have gotten a chance to propagate), include
721 // route hints but only for public channels to protect private channel privacy.
723 } else if online_min_capacity_channel_exists {
724 has_enough_capacity && channel.is_usable
725 } else if min_capacity_channel_exists && online_channel_exists {
726 // If there are some online channels and some min_capacity channels, but no
727 // online-and-min_capacity channels, just include the min capacity ones and ignore
730 } else if min_capacity_channel_exists {
732 } else if online_channel_exists {
737 log_trace!(logger, "Including channel {} in invoice route hints",
738 &channel.channel_id);
739 } else if !has_enough_capacity {
740 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
741 &channel.channel_id);
743 debug_assert!(!channel.is_usable || (has_pub_unconf_chan && !channel.is_public));
744 log_trace!(logger, "Ignoring channel {} with disconnected peer",
745 &channel.channel_id);
750 .collect::<Vec<ChannelDetails>>();
752 eligible_channels.sort_unstable_by(|a, b| {
753 if online_min_capacity_channel_exists {
754 a.inbound_capacity_msat.cmp(&b.inbound_capacity_msat)
756 b.inbound_capacity_msat.cmp(&a.inbound_capacity_msat)
759 eligible_channels.into_iter().take(MAX_CHANNEL_HINTS).map(route_hint_from_channel)
762 /// prefer_current_channel chooses a channel to use for route hints between a currently selected and candidate
763 /// channel based on the inbound capacity of each channel and the minimum inbound capacity requested for the hints,
764 /// returning true if the current channel should be preferred over the candidate channel.
765 /// * If no minimum amount is requested, the channel with the most inbound is chosen to maximize the chances that a
766 /// payment of any size will succeed.
767 /// * If we have channels with inbound above our minimum requested inbound (plus a 10% scaling factor, expressed as a
768 /// percentage) then we choose the lowest inbound channel with above this amount. If we have sufficient inbound
769 /// channels, we don't want to deplete our larger channels with small payments (the off-chain version of "grinding
771 /// * If no channel above our minimum amount exists, then we just prefer the channel with the most inbound to give
772 /// payments the best chance of succeeding in multiple parts.
773 fn prefer_current_channel(min_inbound_capacity_msat: Option<u64>, current_channel: u64,
774 candidate_channel: u64) -> bool {
776 // If no min amount is given for the hints, err of the side of caution and choose the largest channel inbound to
777 // maximize chances of any payment succeeding.
778 if min_inbound_capacity_msat.is_none() {
779 return current_channel > candidate_channel
782 let scaled_min_inbound = min_inbound_capacity_msat.unwrap() * 110;
783 let current_sufficient = current_channel * 100 >= scaled_min_inbound;
784 let candidate_sufficient = candidate_channel * 100 >= scaled_min_inbound;
786 if current_sufficient && candidate_sufficient {
787 return current_channel < candidate_channel
788 } else if current_sufficient {
790 } else if candidate_sufficient {
794 current_channel > candidate_channel
797 /// Adds relevant context to a [`Record`] before passing it to the wrapped [`Logger`].
798 struct WithChannelDetails<'a, 'b, L: Deref> where L::Target: Logger {
799 /// The logger to delegate to after adding context to the record.
801 /// The [`ChannelDetails`] for adding relevant context to the logged record.
802 details: &'b ChannelDetails
805 impl<'a, 'b, L: Deref> Logger for WithChannelDetails<'a, 'b, L> where L::Target: Logger {
806 fn log(&self, mut record: Record) {
807 record.peer_id = Some(self.details.counterparty.node_id);
808 record.channel_id = Some(self.details.channel_id);
809 self.logger.log(record)
813 impl<'a, 'b, L: Deref> WithChannelDetails<'a, 'b, L> where L::Target: Logger {
814 fn from(logger: &'a L, details: &'b ChannelDetails) -> Self {
815 Self { logger, details }
821 use core::time::Duration;
822 use crate::{Currency, Description, Bolt11InvoiceDescription, SignOrCreationError, CreationError};
823 use bitcoin::hashes::{Hash, sha256};
824 use bitcoin::hashes::sha256::Hash as Sha256;
825 use lightning::sign::PhantomKeysManager;
826 use lightning::events::{MessageSendEvent, MessageSendEventsProvider};
827 use lightning::ln::types::PaymentHash;
828 #[cfg(feature = "std")]
829 use lightning::ln::types::PaymentPreimage;
830 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY_DELTA, PaymentId, RecipientOnionFields, Retry};
831 use lightning::ln::functional_test_utils::*;
832 use lightning::ln::msgs::ChannelMessageHandler;
833 use lightning::routing::router::{PaymentParameters, RouteParameters};
834 use lightning::util::test_utils;
835 use lightning::util::config::UserConfig;
836 use crate::utils::{create_invoice_from_channelmanager_and_duration_since_epoch, rotate_through_iterators};
837 use std::collections::HashSet;
838 use lightning::util::string::UntrustedString;
841 fn test_prefer_current_channel() {
842 // No minimum, prefer larger candidate channel.
843 assert_eq!(crate::utils::prefer_current_channel(None, 100, 200), false);
845 // No minimum, prefer larger current channel.
846 assert_eq!(crate::utils::prefer_current_channel(None, 200, 100), true);
848 // Minimum set, prefer current channel over minimum + buffer.
849 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 100), true);
851 // Minimum set, prefer candidate channel over minimum + buffer.
852 assert_eq!(crate::utils::prefer_current_channel(Some(100), 105, 125), false);
854 // Minimum set, both channels sufficient, prefer smaller current channel.
855 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 125), true);
857 // Minimum set, both channels sufficient, prefer smaller candidate channel.
858 assert_eq!(crate::utils::prefer_current_channel(Some(100), 200, 160), false);
860 // Minimum set, neither sufficient, prefer larger current channel.
861 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 50), true);
863 // Minimum set, neither sufficient, prefer larger candidate channel.
864 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 150), false);
869 fn test_from_channelmanager() {
870 let chanmon_cfgs = create_chanmon_cfgs(2);
871 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
872 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
873 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
874 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
875 let non_default_invoice_expiry_secs = 4200;
876 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
877 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
878 Some(10_000), "test".to_string(), Duration::from_secs(1234567),
879 non_default_invoice_expiry_secs, None).unwrap();
880 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
881 // If no `min_final_cltv_expiry_delta` is specified, then it should be `MIN_FINAL_CLTV_EXPIRY_DELTA`.
882 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
883 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description(UntrustedString("test".to_string()))));
884 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
886 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
888 let chan = &nodes[1].node.list_usable_channels()[0];
889 assert_eq!(invoice.route_hints().len(), 1);
890 assert_eq!(invoice.route_hints()[0].0.len(), 1);
891 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
893 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
894 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
896 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
897 invoice.min_final_cltv_expiry_delta() as u32)
898 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
899 .with_route_hints(invoice.route_hints()).unwrap();
900 let route_params = RouteParameters::from_payment_params_and_value(
901 payment_params, invoice.amount_milli_satoshis().unwrap());
902 let payment_event = {
903 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
904 nodes[0].node.send_payment(payment_hash,
905 RecipientOnionFields::secret_only(*invoice.payment_secret()),
906 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
907 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
908 assert_eq!(added_monitors.len(), 1);
909 added_monitors.clear();
911 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
912 assert_eq!(events.len(), 1);
913 SendEvent::from_event(events.remove(0))
916 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
917 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
918 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
919 assert_eq!(added_monitors.len(), 1);
920 added_monitors.clear();
921 let events = nodes[1].node.get_and_clear_pending_msg_events();
922 assert_eq!(events.len(), 2);
925 fn do_create_invoice_min_final_cltv_delta(with_custom_delta: bool) {
926 let chanmon_cfgs = create_chanmon_cfgs(2);
927 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
928 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
929 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
930 let custom_min_final_cltv_expiry_delta = Some(50);
932 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
933 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
934 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
935 if with_custom_delta { custom_min_final_cltv_expiry_delta } else { None },
937 assert_eq!(invoice.min_final_cltv_expiry_delta(), if with_custom_delta {
938 custom_min_final_cltv_expiry_delta.unwrap() + 3 /* Buffer */} else { MIN_FINAL_CLTV_EXPIRY_DELTA } as u64);
942 fn test_create_invoice_custom_min_final_cltv_delta() {
943 do_create_invoice_min_final_cltv_delta(true);
944 do_create_invoice_min_final_cltv_delta(false);
948 fn create_invoice_min_final_cltv_delta_equals_htlc_fail_buffer() {
949 let chanmon_cfgs = create_chanmon_cfgs(2);
950 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
951 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
952 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
953 let custom_min_final_cltv_expiry_delta = Some(21);
955 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
956 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
957 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
958 custom_min_final_cltv_expiry_delta,
960 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
964 fn test_create_invoice_with_description_hash() {
965 let chanmon_cfgs = create_chanmon_cfgs(2);
966 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
967 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
968 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
969 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
970 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
971 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
972 Some(10_000), description_hash, Duration::from_secs(1234567), 3600, None,
974 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
975 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
976 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
980 fn test_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash() {
981 let chanmon_cfgs = create_chanmon_cfgs(2);
982 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
983 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
984 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
985 let payment_hash = PaymentHash([0; 32]);
986 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
987 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
988 Some(10_000), "test".to_string(), Duration::from_secs(1234567), 3600,
991 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
992 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
993 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description(UntrustedString("test".to_string()))));
994 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
998 fn test_hints_has_only_public_confd_channels() {
999 let chanmon_cfgs = create_chanmon_cfgs(2);
1000 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1001 let mut config = test_default_channel_config();
1002 config.channel_handshake_config.minimum_depth = 1;
1003 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
1004 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1006 // Create a private channel with lots of capacity and a lower value public channel (without
1007 // confirming the funding tx yet).
1008 let unannounced_scid = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0);
1009 let conf_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 10_000, 0);
1011 // Before the channel is available, we should include the unannounced_scid.
1012 let mut scid_aliases = HashSet::new();
1013 scid_aliases.insert(unannounced_scid.0.short_channel_id_alias.unwrap());
1014 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
1016 // However after we mine the funding tx and exchange channel_ready messages for the public
1017 // channel we'll immediately switch to including it as a route hint, even though it isn't
1019 let pub_channel_scid = mine_transaction(&nodes[0], &conf_tx);
1020 let node_a_pub_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
1021 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &node_a_pub_channel_ready);
1023 assert_eq!(mine_transaction(&nodes[1], &conf_tx), pub_channel_scid);
1024 let events = nodes[1].node.get_and_clear_pending_msg_events();
1025 assert_eq!(events.len(), 2);
1026 if let MessageSendEvent::SendChannelReady { msg, .. } = &events[0] {
1027 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), msg);
1028 } else { panic!(); }
1029 if let MessageSendEvent::SendChannelUpdate { msg, .. } = &events[1] {
1030 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), msg);
1031 } else { panic!(); }
1033 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()));
1035 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1036 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1038 scid_aliases.clear();
1039 scid_aliases.insert(node_a_pub_channel_ready.short_channel_id_alias.unwrap());
1040 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
1041 // This also applies even if the amount is more than the payment amount, to ensure users
1042 // dont screw up their privacy.
1043 match_invoice_routes(Some(50_000_000), &nodes[1], scid_aliases.clone());
1045 // The same remains true until the channel has 7 confirmations, at which point we include
1047 connect_blocks(&nodes[1], 5);
1048 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
1049 connect_blocks(&nodes[1], 1);
1050 get_event_msg!(nodes[1], MessageSendEvent::SendAnnouncementSignatures, nodes[0].node.get_our_node_id());
1051 match_invoice_routes(Some(5000), &nodes[1], HashSet::new());
1055 fn test_hints_includes_single_channels_to_nodes() {
1056 let chanmon_cfgs = create_chanmon_cfgs(3);
1057 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1058 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1059 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1061 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1062 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1064 let mut scid_aliases = HashSet::new();
1065 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1066 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1068 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
1072 fn test_hints_has_only_lowest_inbound_capacity_channel_above_minimum() {
1073 let chanmon_cfgs = create_chanmon_cfgs(2);
1074 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1075 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1076 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1078 let _chan_1_0_inbound_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000, 0);
1079 let _chan_1_0_large_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 500_000, 0);
1080 let chan_1_0_low_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 200_000, 0);
1082 let mut scid_aliases = HashSet::new();
1083 scid_aliases.insert(chan_1_0_low_inbound_above_amt.0.short_channel_id_alias.unwrap());
1084 match_invoice_routes(Some(100_000_000), &nodes[0], scid_aliases);
1088 fn test_hints_has_only_online_channels() {
1089 let chanmon_cfgs = create_chanmon_cfgs(4);
1090 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1091 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1092 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1093 let chan_a = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0);
1094 let chan_b = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 10_000_000, 0);
1095 let _chan_c = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 1_000_000, 0);
1097 // With all peers connected we should get all hints that have sufficient value
1098 let mut scid_aliases = HashSet::new();
1099 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
1100 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1102 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1104 // With only one sufficient-value peer connected we should only get its hint
1105 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
1106 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());
1107 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1109 // If we don't have any sufficient-value peers connected we should get all hints with
1110 // sufficient value, even though there is a connected insufficient-value peer.
1111 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1112 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1113 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
1117 fn test_insufficient_inbound_sort_by_highest_capacity() {
1118 let chanmon_cfgs = create_chanmon_cfgs(5);
1119 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1120 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1121 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1122 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1123 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1124 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1125 let chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1127 // When no single channel has enough inbound capacity for the payment, we expect the three
1128 // highest inbound channels to be chosen.
1129 let mut scid_aliases = HashSet::new();
1130 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1131 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1132 scid_aliases.insert(chan_4_0.0.short_channel_id_alias.unwrap());
1134 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1138 fn test_sufficient_inbound_sort_by_lowest_capacity() {
1139 let chanmon_cfgs = create_chanmon_cfgs(5);
1140 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1141 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1142 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1143 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1144 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1145 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1146 let _chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1148 // When we have channels that have sufficient inbound for the payment, test that we sort
1149 // by lowest inbound capacity.
1150 let mut scid_aliases = HashSet::new();
1151 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1152 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1153 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1155 match_invoice_routes(Some(50_000_000), &nodes[0], scid_aliases.clone());
1159 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
1160 let chanmon_cfgs = create_chanmon_cfgs(3);
1161 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1162 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1163 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1164 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1166 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
1167 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1168 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1169 let mut private_chan_cfg = UserConfig::default();
1170 private_chan_cfg.channel_handshake_config.announced_channel = false;
1171 let temporary_channel_id = nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, Some(private_chan_cfg)).unwrap();
1172 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
1173 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_channel);
1174 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
1175 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), &accept_channel);
1177 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
1179 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
1180 confirm_transaction_at(&nodes[2], &tx, conf_height);
1181 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
1182 confirm_transaction_at(&nodes[0], &tx, conf_height);
1183 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
1184 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
1185 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()));
1186 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1187 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
1188 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
1189 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
1190 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
1192 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
1193 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1194 // Therefore only `chan_1_0` should be included in the hints.
1195 let mut scid_aliases = HashSet::new();
1196 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1197 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
1201 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
1202 let chanmon_cfgs = create_chanmon_cfgs(3);
1203 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1204 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1205 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1206 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1208 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1209 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1210 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1212 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
1213 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
1214 // public channel between `nodes[2]` and `nodes[0]`
1215 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1219 fn test_only_public_channels_includes_no_channels_in_hints() {
1220 let chanmon_cfgs = create_chanmon_cfgs(3);
1221 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1222 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1223 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1224 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1225 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
1226 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
1228 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1229 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1230 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1232 // As all of `nodes[0]` channels are public, no channels should be included in the hints
1233 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1237 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
1238 let chanmon_cfgs = create_chanmon_cfgs(3);
1239 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1240 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1241 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1242 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1243 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0);
1245 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
1246 let mut scid_aliases_99_000_001_msat = HashSet::new();
1247 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1249 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
1251 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
1252 let mut scid_aliases_99_000_000_msat = HashSet::new();
1253 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1254 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1256 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
1258 // As the invoice amt is above all channels' inbound capacity, they will still be included
1259 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
1260 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1261 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1263 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
1265 // An invoice with no specified amount should include all channels in the route hints.
1266 let mut scid_aliases_no_specified_amount = HashSet::new();
1267 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1268 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1270 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
1273 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1274 invoice_amt: Option<u64>,
1275 invoice_node: &Node<'a, 'b, 'c>,
1276 mut chan_ids_to_match: HashSet<u64>
1278 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
1279 invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
1280 Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
1281 3600, None).unwrap();
1282 let hints = invoice.private_routes();
1285 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
1286 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1288 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1292 #[cfg(feature = "std")]
1293 fn test_multi_node_receive() {
1294 do_test_multi_node_receive(true);
1295 do_test_multi_node_receive(false);
1298 #[cfg(feature = "std")]
1299 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
1300 use lightning::events::{Event, EventsProvider};
1301 use core::cell::RefCell;
1303 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1304 let seed_1 = [42u8; 32];
1305 let seed_2 = [43u8; 32];
1306 let cross_node_seed = [44u8; 32];
1307 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1308 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1309 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1310 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1311 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1312 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1313 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
1314 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
1315 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1316 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1317 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1319 let payment_amt = 10_000;
1320 let route_hints = vec![
1321 nodes[1].node.get_phantom_route_hints(),
1322 nodes[2].node.get_phantom_route_hints(),
1325 let user_payment_preimage = PaymentPreimage([1; 32]);
1326 let payment_hash = if user_generated_pmt_hash {
1327 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).to_byte_array()))
1331 let genesis_timestamp = bitcoin::blockdata::constants::genesis_block(bitcoin::Network::Testnet).header.time as u64;
1332 let non_default_invoice_expiry_secs = 4200;
1335 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
1336 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1337 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1338 Currency::BitcoinTestnet, None, Duration::from_secs(genesis_timestamp)
1340 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
1341 let payment_preimage = if user_generated_pmt_hash {
1342 user_payment_preimage
1344 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1347 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1348 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Direct(&Description(UntrustedString("test".to_string()))));
1349 assert_eq!(invoice.route_hints().len(), 2);
1350 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1351 assert!(!invoice.features().unwrap().supports_basic_mpp());
1353 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
1354 invoice.min_final_cltv_expiry_delta() as u32)
1355 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
1356 .with_route_hints(invoice.route_hints()).unwrap();
1357 let params = RouteParameters::from_payment_params_and_value(
1358 payment_params, invoice.amount_milli_satoshis().unwrap());
1359 let (payment_event, fwd_idx) = {
1360 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
1361 nodes[0].node.send_payment(payment_hash,
1362 RecipientOnionFields::secret_only(*invoice.payment_secret()),
1363 PaymentId(payment_hash.0), params, Retry::Attempts(0)).unwrap();
1364 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1365 assert_eq!(added_monitors.len(), 1);
1366 added_monitors.clear();
1368 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1369 assert_eq!(events.len(), 1);
1370 let fwd_idx = match events[0] {
1371 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1372 if node_id == nodes[1].node.get_our_node_id() {
1376 _ => panic!("Unexpected event")
1378 (SendEvent::from_event(events.remove(0)), fwd_idx)
1380 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1381 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1383 // Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
1384 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1385 // payments "look real" by taking more time.
1386 let other_events = RefCell::new(Vec::new());
1387 let forward_event_handler = |event: Event| {
1388 if let Event::PendingHTLCsForwardable { .. } = event {
1389 nodes[fwd_idx].node.process_pending_htlc_forwards();
1391 other_events.borrow_mut().push(event);
1394 nodes[fwd_idx].node.process_pending_events(&forward_event_handler);
1395 nodes[fwd_idx].node.process_pending_events(&forward_event_handler);
1397 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1398 assert_eq!(other_events.borrow().len(), 1);
1399 check_payment_claimable(&other_events.borrow()[0], payment_hash, payment_secret, payment_amt, payment_preimage_opt, invoice.recover_payee_pub_key());
1400 do_claim_payment_along_route(
1401 ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[fwd_idx]]], payment_preimage)
1403 expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
1407 #[cfg(feature = "std")]
1408 fn test_multi_node_hints_has_htlc_min_max_values() {
1409 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1410 let seed_1 = [42u8; 32];
1411 let seed_2 = [43u8; 32];
1412 let cross_node_seed = [44u8; 32];
1413 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1414 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1415 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1416 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1417 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1419 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1420 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1422 let payment_amt = 20_000;
1423 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600, None).unwrap();
1424 let route_hints = vec![
1425 nodes[1].node.get_phantom_route_hints(),
1426 nodes[2].node.get_phantom_route_hints(),
1429 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1430 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
1431 "test".to_string(), 3600, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1432 nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1434 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1435 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1436 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1438 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1439 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1440 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1444 #[cfg(feature = "std")]
1445 fn create_phantom_invoice_with_description_hash() {
1446 let chanmon_cfgs = create_chanmon_cfgs(3);
1447 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1448 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1449 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1451 let payment_amt = 20_000;
1452 let route_hints = vec![
1453 nodes[1].node.get_phantom_route_hints(),
1454 nodes[2].node.get_phantom_route_hints(),
1457 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1458 let non_default_invoice_expiry_secs = 4200;
1459 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1460 &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger,
1462 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1463 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1464 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
1467 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1468 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1469 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1470 assert_eq!(invoice.description(), Bolt11InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1474 #[cfg(feature = "std")]
1475 fn create_phantom_invoice_with_custom_payment_hash_and_custom_min_final_cltv_delta() {
1476 let chanmon_cfgs = create_chanmon_cfgs(3);
1477 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1478 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1479 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1481 let payment_amt = 20_000;
1482 let route_hints = vec![
1483 nodes[1].node.get_phantom_route_hints(),
1484 nodes[2].node.get_phantom_route_hints(),
1486 let user_payment_preimage = PaymentPreimage([1; 32]);
1487 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).to_byte_array()));
1488 let non_default_invoice_expiry_secs = 4200;
1489 let min_final_cltv_expiry_delta = Some(100);
1490 let duration_since_epoch = Duration::from_secs(1234567);
1491 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1492 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
1493 "".to_string(), non_default_invoice_expiry_secs, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1494 nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
1495 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1496 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
1497 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1501 #[cfg(feature = "std")]
1502 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1503 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1504 let seed_1 = [42u8; 32];
1505 let seed_2 = [43u8; 32];
1506 let cross_node_seed = [44u8; 32];
1507 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1508 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1509 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1510 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1511 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1513 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1514 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1516 let mut scid_aliases = HashSet::new();
1517 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1518 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1520 match_multi_node_invoice_routes(
1523 vec![&nodes[1], &nodes[2],],
1530 #[cfg(feature = "std")]
1531 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1532 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1533 let seed_1 = [42u8; 32];
1534 let seed_2 = [43u8; 32];
1535 let cross_node_seed = [44u8; 32];
1536 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1537 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1538 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1539 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1540 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1542 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1543 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1544 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005);
1546 let mut scid_aliases = HashSet::new();
1547 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1548 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1549 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1551 match_multi_node_invoice_routes(
1554 vec![&nodes[2], &nodes[3],],
1561 #[cfg(feature = "std")]
1562 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1563 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1564 let seed_1 = [42u8; 32];
1565 let seed_2 = [43u8; 32];
1566 let cross_node_seed = [44u8; 32];
1567 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1568 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1569 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1570 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1571 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1573 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1574 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1576 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1577 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1578 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1579 let mut private_chan_cfg = UserConfig::default();
1580 private_chan_cfg.channel_handshake_config.announced_channel = false;
1581 let temporary_channel_id = nodes[1].node.create_channel(nodes[3].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, Some(private_chan_cfg)).unwrap();
1582 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1583 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
1584 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1585 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), &accept_channel);
1587 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1589 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1590 confirm_transaction_at(&nodes[1], &tx, conf_height);
1591 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1592 confirm_transaction_at(&nodes[3], &tx, conf_height);
1593 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1594 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1595 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()));
1596 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1597 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1598 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1599 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1600 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1602 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1603 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1604 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1605 let mut scid_aliases = HashSet::new();
1606 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1607 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1609 match_multi_node_invoice_routes(
1612 vec![&nodes[2], &nodes[3],],
1619 #[cfg(feature = "std")]
1620 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1621 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1622 let seed_1 = [42u8; 32];
1623 let seed_2 = [43u8; 32];
1624 let cross_node_seed = [44u8; 32];
1625 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1626 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1627 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1628 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1629 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1631 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1633 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1634 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1635 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1637 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1638 // `chan_0_2` as `nodes[2]` only has public channels.
1639 let mut scid_aliases = HashSet::new();
1640 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1642 match_multi_node_invoice_routes(
1645 vec![&nodes[1], &nodes[2],],
1652 #[cfg(feature = "std")]
1653 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1654 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1655 let seed_1 = [42u8; 32];
1656 let seed_2 = [43u8; 32];
1657 let cross_node_seed = [44u8; 32];
1658 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1659 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1660 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1661 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1662 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1664 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1665 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1666 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1667 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
1669 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001);
1671 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1672 // channels for `nodes[2]` as it contains a mix of public and private channels.
1673 let mut scid_aliases = HashSet::new();
1674 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1676 match_multi_node_invoice_routes(
1679 vec![&nodes[2], &nodes[3],],
1686 #[cfg(feature = "std")]
1687 fn test_multi_node_hints_has_only_lowest_inbound_channel_above_minimum() {
1688 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1689 let seed_1 = [42u8; 32];
1690 let seed_2 = [43u8; 32];
1691 let cross_node_seed = [44u8; 32];
1692 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1693 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1694 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1695 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1696 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1698 let _chan_0_1_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1699 let _chan_0_1_above_amt_high_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 500_000, 0);
1700 let chan_0_1_above_amt_low_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 180_000, 0);
1701 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1703 let mut scid_aliases = HashSet::new();
1704 scid_aliases.insert(chan_0_1_above_amt_low_inbound.0.short_channel_id_alias.unwrap());
1705 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1707 match_multi_node_invoice_routes(
1710 vec![&nodes[1], &nodes[2],],
1717 #[cfg(feature = "std")]
1718 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1719 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1720 let seed_1 = [42u8; 32];
1721 let seed_2 = [43u8; 32];
1722 let cross_node_seed = [44u8; 32];
1723 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1724 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1725 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1726 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1727 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1729 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1730 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0);
1731 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0);
1733 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1734 let mut scid_aliases_99_000_001_msat = HashSet::new();
1735 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1736 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1738 match_multi_node_invoice_routes(
1741 vec![&nodes[2], &nodes[3],],
1742 scid_aliases_99_000_001_msat,
1746 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1747 let mut scid_aliases_99_000_000_msat = HashSet::new();
1748 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1749 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1750 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1752 match_multi_node_invoice_routes(
1755 vec![&nodes[2], &nodes[3],],
1756 scid_aliases_99_000_000_msat,
1760 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1761 // `nodes[2]` them should be included.
1762 let mut scid_aliases_300_000_000_msat = HashSet::new();
1763 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1764 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1765 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1767 match_multi_node_invoice_routes(
1770 vec![&nodes[2], &nodes[3],],
1771 scid_aliases_300_000_000_msat,
1775 // Since the no specified amount, all channels should included.
1776 let mut scid_aliases_no_specified_amount = HashSet::new();
1777 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1778 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1779 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1781 match_multi_node_invoice_routes(
1784 vec![&nodes[2], &nodes[3],],
1785 scid_aliases_no_specified_amount,
1791 fn test_multi_node_hints_limited_to_3() {
1792 let mut chanmon_cfgs = create_chanmon_cfgs(6);
1793 let seed_1 = [42 as u8; 32];
1794 let seed_2 = [43 as u8; 32];
1795 let seed_3 = [44 as u8; 32];
1796 let seed_4 = [45 as u8; 32];
1797 let cross_node_seed = [44 as u8; 32];
1798 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1799 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1800 chanmon_cfgs[4].keys_manager.backing = PhantomKeysManager::new(&seed_3, 43, 44, &cross_node_seed);
1801 chanmon_cfgs[5].keys_manager.backing = PhantomKeysManager::new(&seed_4, 43, 44, &cross_node_seed);
1802 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1803 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1804 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1806 // Setup each phantom node with two channels from distinct peers.
1807 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 10_000, 0);
1808 let chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 20_000, 0);
1809 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 20_000, 0);
1810 let _chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 10_000, 0);
1811 let chan_0_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 4, 20_000, 0);
1812 let _chan_1_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000, 0);
1813 let _chan_0_5 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 5, 20_000, 0);
1814 let _chan_1_5 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000, 0);
1816 // Set invoice amount > all channels inbound so that every one is eligible for inclusion
1817 // and hints will be sorted by largest inbound capacity.
1818 let invoice_amt = Some(100_000_000);
1820 // With 4 phantom nodes, assert that we include 1 hint per node, up to 3 nodes.
1821 let mut scid_aliases = HashSet::new();
1822 scid_aliases.insert(chan_1_2.0.short_channel_id_alias.unwrap());
1823 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1824 scid_aliases.insert(chan_0_4.0.short_channel_id_alias.unwrap());
1826 match_multi_node_invoice_routes(
1829 vec![&nodes[2], &nodes[3], &nodes[4], &nodes[5]],
1834 // With 2 phantom nodes, assert that we include no more than 3 hints.
1835 let mut scid_aliases = HashSet::new();
1836 scid_aliases.insert(chan_1_2.0.short_channel_id_alias.unwrap());
1837 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1838 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1840 match_multi_node_invoice_routes(
1843 vec![&nodes[2], &nodes[3]],
1850 fn test_multi_node_hints_at_least_3() {
1851 let mut chanmon_cfgs = create_chanmon_cfgs(5);
1852 let seed_1 = [42 as u8; 32];
1853 let seed_2 = [43 as u8; 32];
1854 let cross_node_seed = [44 as u8; 32];
1855 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1856 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1857 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1858 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1859 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1861 let _chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 10_000, 0);
1862 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 20_000, 0);
1863 let chan_2_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 30_000, 0);
1864 let chan_0_4 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 4, 10_000, 0);
1866 // Since the invoice amount is above all channels inbound, all four are eligible. Test that
1867 // we still include 3 hints from 2 distinct nodes sorted by inbound.
1868 let mut scid_aliases = HashSet::new();
1869 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1870 scid_aliases.insert(chan_2_3.0.short_channel_id_alias.unwrap());
1871 scid_aliases.insert(chan_0_4.0.short_channel_id_alias.unwrap());
1873 match_multi_node_invoice_routes(
1876 vec![&nodes[3], &nodes[4],],
1882 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1883 invoice_amt: Option<u64>,
1884 invoice_node: &Node<'a, 'b, 'c>,
1885 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1886 mut chan_ids_to_match: HashSet<u64>,
1887 nodes_contains_public_channels: bool
1889 let phantom_route_hints = network_multi_nodes.iter()
1890 .map(|node| node.node.get_phantom_route_hints())
1891 .collect::<Vec<PhantomRouteHints>>();
1892 let phantom_scids = phantom_route_hints.iter()
1893 .map(|route_hint| route_hint.phantom_scid)
1894 .collect::<HashSet<u64>>();
1896 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1897 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
1898 3600, phantom_route_hints, invoice_node.keys_manager, invoice_node.keys_manager,
1899 invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1901 let invoice_hints = invoice.private_routes();
1903 for hint in invoice_hints {
1904 let hints = &(hint.0).0;
1907 assert!(nodes_contains_public_channels);
1908 let phantom_scid = hints[0].short_channel_id;
1909 assert!(phantom_scids.contains(&phantom_scid));
1912 let hint_short_chan_id = hints[0].short_channel_id;
1913 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1914 let phantom_scid = hints[1].short_channel_id;
1915 assert!(phantom_scids.contains(&phantom_scid));
1917 _ => panic!("Incorrect hint length generated")
1920 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1924 fn test_create_invoice_fails_with_invalid_custom_min_final_cltv_expiry_delta() {
1925 let chanmon_cfgs = create_chanmon_cfgs(2);
1926 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1927 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1928 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1929 let result = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
1930 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
1931 Some(10_000), "Some description".into(), Duration::from_secs(1234567), 3600, Some(MIN_FINAL_CLTV_EXPIRY_DELTA - 4),
1934 Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort)) => {},
1940 fn test_rotate_through_iterators() {
1941 // two nested vectors
1942 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec!["a1", "b1"].into_iter()];
1943 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1945 let expected = vec!["a0", "a1", "b0", "b1", "c0"];
1946 assert_eq!(expected, result);
1948 // test single nested vector
1949 let a = vec![vec!["a0", "b0", "c0"].into_iter()];
1950 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1952 let expected = vec!["a0", "b0", "c0"];
1953 assert_eq!(expected, result);
1955 // test second vector with only one element
1956 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec!["a1"].into_iter()];
1957 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1959 let expected = vec!["a0", "a1", "b0", "c0"];
1960 assert_eq!(expected, result);
1962 // test three nestend vectors
1963 let a = vec![vec!["a0"].into_iter(), vec!["a1", "b1", "c1"].into_iter(), vec!["a2"].into_iter()];
1964 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1966 let expected = vec!["a0", "a1", "a2", "b1", "c1"];
1967 assert_eq!(expected, result);
1969 // test single nested vector with a single value
1970 let a = vec![vec!["a0"].into_iter()];
1971 let result = rotate_through_iterators(a).collect::<Vec<_>>();
1973 let expected = vec!["a0"];
1974 assert_eq!(expected, result);
1976 // test single empty nested vector
1977 let a:Vec<std::vec::IntoIter<&str>> = vec![vec![].into_iter()];
1978 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1979 let expected:Vec<&str> = vec![];
1981 assert_eq!(expected, result);
1983 // test first nested vector is empty
1984 let a:Vec<std::vec::IntoIter<&str>>= vec![vec![].into_iter(), vec!["a1", "b1", "c1"].into_iter()];
1985 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1987 let expected = vec!["a1", "b1", "c1"];
1988 assert_eq!(expected, result);
1990 // test two empty vectors
1991 let a:Vec<std::vec::IntoIter<&str>> = vec![vec![].into_iter(), vec![].into_iter()];
1992 let result = rotate_through_iterators(a).collect::<Vec<&str>>();
1994 let expected:Vec<&str> = vec![];
1995 assert_eq!(expected, result);
1997 // test an empty vector amongst other filled vectors
1999 vec!["a0", "b0", "c0"].into_iter(),
2001 vec!["a1", "b1", "c1"].into_iter(),
2002 vec!["a2", "b2", "c2"].into_iter(),
2004 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2006 let expected = vec!["a0", "a1", "a2", "b0", "b1", "b2", "c0", "c1", "c2"];
2007 assert_eq!(expected, result);
2009 // test a filled vector between two empty vectors
2010 let a = vec![vec![].into_iter(), vec!["a1", "b1", "c1"].into_iter(), vec![].into_iter()];
2011 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2013 let expected = vec!["a1", "b1", "c1"];
2014 assert_eq!(expected, result);
2016 // test an empty vector at the end of the vectors
2017 let a = vec![vec!["a0", "b0", "c0"].into_iter(), vec![].into_iter()];
2018 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2020 let expected = vec!["a0", "b0", "c0"];
2021 assert_eq!(expected, result);
2023 // test multiple empty vectors amongst multiple filled vectors
2026 vec!["a1", "b1", "c1"].into_iter(),
2028 vec!["a3", "b3"].into_iter(),
2032 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2034 let expected = vec!["a1", "a3", "b1", "b3", "c1"];
2035 assert_eq!(expected, result);
2037 // test one element in the first nested vectore and two elements in the second nested
2039 let a = vec![vec!["a0"].into_iter(), vec!["a1", "b1"].into_iter()];
2040 let result = rotate_through_iterators(a).collect::<Vec<_>>();
2042 let expected = vec!["a0", "a1", "b1"];
2043 assert_eq!(expected, result);