1 //! Convenient utilities to create an invoice.
3 use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
5 use crate::{prelude::*, Description, InvoiceDescription, Sha256};
7 use bitcoin_hashes::Hash;
9 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
10 use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
11 use lightning::ln::{PaymentHash, PaymentSecret};
12 use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, MIN_FINAL_CLTV_EXPIRY_DELTA};
13 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
14 use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
15 use lightning::routing::gossip::RoutingFees;
16 use lightning::routing::router::{RouteHint, RouteHintHop, Router};
17 use lightning::util::logger::Logger;
18 use secp256k1::PublicKey;
20 use core::time::Duration;
22 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
23 /// See [`PhantomKeysManager`] for more information on phantom node payments.
25 /// `phantom_route_hints` parameter:
26 /// * Contains channel info for all nodes participating in the phantom invoice
27 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
28 /// participating node
29 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
30 /// updated when a channel becomes disabled or closes
31 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
32 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
35 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
36 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
37 /// If `None` is provided for `payment_hash`, then one will be created.
39 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
40 /// in excess of the current time.
42 /// `duration_since_epoch` is the current time since epoch in seconds.
44 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
45 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
46 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
47 /// confirmations during routing.
49 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
50 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
53 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
54 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
55 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
56 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
57 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
58 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
60 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
61 /// available and the current time is supplied by the caller.
62 pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
63 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
64 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
65 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
66 ) -> Result<Invoice, SignOrCreationError<()>>
68 ES::Target: EntropySource,
69 NS::Target: NodeSigner,
72 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
73 let description = InvoiceDescription::Direct(&description,);
74 _create_phantom_invoice::<ES, NS, L>(
75 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
76 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
80 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
81 /// See [`PhantomKeysManager`] for more information on phantom node payments.
83 /// `phantom_route_hints` parameter:
84 /// * Contains channel info for all nodes participating in the phantom invoice
85 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
86 /// participating node
87 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
88 /// updated when a channel becomes disabled or closes
89 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
90 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
93 /// `description_hash` is a SHA-256 hash of the description text
95 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
96 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
97 /// If `None` is provided for `payment_hash`, then one will be created.
99 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
100 /// in excess of the current time.
102 /// `duration_since_epoch` is the current time since epoch in seconds.
104 /// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
105 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
108 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
109 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
110 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
111 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
112 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
114 /// This can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
115 /// available and the current time is supplied by the caller.
116 pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
117 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
118 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
119 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
120 ) -> Result<Invoice, SignOrCreationError<()>>
122 ES::Target: EntropySource,
123 NS::Target: NodeSigner,
126 _create_phantom_invoice::<ES, NS, L>(
127 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
128 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
129 min_final_cltv_expiry_delta, duration_since_epoch,
133 fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
134 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
135 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
136 node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
137 ) -> Result<Invoice, SignOrCreationError<()>>
139 ES::Target: EntropySource,
140 NS::Target: NodeSigner,
144 if phantom_route_hints.is_empty() {
145 return Err(SignOrCreationError::CreationError(
146 CreationError::MissingRouteHints,
150 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
151 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
154 let invoice = match description {
155 InvoiceDescription::Direct(description) => {
156 InvoiceBuilder::new(network).description(description.0.clone())
158 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
161 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
162 let keys = ExpandedKey::new(&node_signer.get_inbound_payment_key_material());
163 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
164 let payment_secret = create_from_hash(
168 invoice_expiry_delta_secs,
171 min_final_cltv_expiry_delta,
173 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
174 (payment_hash, payment_secret)
179 invoice_expiry_delta_secs,
183 min_final_cltv_expiry_delta,
185 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
188 log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
189 phantom_route_hints.len(), log_bytes!(payment_hash.0));
191 let mut invoice = invoice
192 .duration_since_epoch(duration_since_epoch)
193 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
194 .payment_secret(payment_secret)
195 .min_final_cltv_expiry_delta(
196 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
197 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
198 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
199 if let Some(amt) = amt_msat {
200 invoice = invoice.amount_milli_satoshis(amt);
203 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
204 log_trace!(logger, "Generating phantom route hints for node {}",
205 log_pubkey!(real_node_pubkey));
206 let mut route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
208 // If we have any public channel, the route hints from `sort_and_filter_channels` will be
209 // empty. In that case we create a RouteHint on which we will push a single hop with the
210 // phantom route into the invoice, and let the sender find the path to the `real_node_pubkey`
211 // node by looking at our public channels.
212 if route_hints.is_empty() {
213 route_hints.push(RouteHint(vec![]))
215 for mut route_hint in route_hints {
216 route_hint.0.push(RouteHintHop {
217 src_node_id: real_node_pubkey,
218 short_channel_id: phantom_scid,
221 proportional_millionths: 0,
223 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
224 htlc_minimum_msat: None,
225 htlc_maximum_msat: None,});
226 invoice = invoice.private_route(route_hint.clone());
230 let raw_invoice = match invoice.build_raw() {
232 Err(e) => return Err(SignOrCreationError::CreationError(e))
234 let hrp_str = raw_invoice.hrp.to_string();
235 let hrp_bytes = hrp_str.as_bytes();
236 let data_without_signature = raw_invoice.data.to_base32();
237 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
238 match signed_raw_invoice {
239 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
240 Err(e) => Err(SignOrCreationError::SignError(e))
244 #[cfg(feature = "std")]
245 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
246 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
247 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
248 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
249 /// that the payment secret is valid when the invoice is paid.
251 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
252 /// in excess of the current time.
254 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
255 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
256 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
257 /// confirmations during routing.
259 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
260 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
261 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
262 network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32,
263 min_final_cltv_expiry_delta: Option<u16>,
264 ) -> Result<Invoice, SignOrCreationError<()>>
266 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
267 T::Target: BroadcasterInterface,
268 ES::Target: EntropySource,
269 NS::Target: NodeSigner,
270 SP::Target: SignerProvider,
271 F::Target: FeeEstimator,
275 use std::time::SystemTime;
276 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
277 .expect("for the foreseeable future this shouldn't happen");
278 create_invoice_from_channelmanager_and_duration_since_epoch(
279 channelmanager, node_signer, logger, network, amt_msat,
280 description, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
284 #[cfg(feature = "std")]
285 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
286 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
287 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
288 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
289 /// that the payment secret is valid when the invoice is paid.
290 /// Use this variant if you want to pass the `description_hash` to the invoice.
292 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
293 /// in excess of the current time.
295 /// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
296 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
297 /// Note that LDK will add a buffer of 3 blocks to the delta to allow for up to a few new block
298 /// confirmations during routing.
300 /// [`MIN_FINAL_CLTV_EXPIRY_DETLA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
301 pub fn create_invoice_from_channelmanager_with_description_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
302 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
303 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
304 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
305 ) -> Result<Invoice, SignOrCreationError<()>>
307 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
308 T::Target: BroadcasterInterface,
309 ES::Target: EntropySource,
310 NS::Target: NodeSigner,
311 SP::Target: SignerProvider,
312 F::Target: FeeEstimator,
316 use std::time::SystemTime;
318 let duration = SystemTime::now()
319 .duration_since(SystemTime::UNIX_EPOCH)
320 .expect("for the foreseeable future this shouldn't happen");
322 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
323 channelmanager, node_signer, logger, network, amt_msat,
324 description_hash, duration, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
328 /// See [`create_invoice_from_channelmanager_with_description_hash`]
329 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
330 /// available and the current time is supplied by the caller.
331 pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
332 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
333 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
334 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
335 ) -> Result<Invoice, SignOrCreationError<()>>
337 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
338 T::Target: BroadcasterInterface,
339 ES::Target: EntropySource,
340 NS::Target: NodeSigner,
341 SP::Target: SignerProvider,
342 F::Target: FeeEstimator,
346 _create_invoice_from_channelmanager_and_duration_since_epoch(
347 channelmanager, node_signer, logger, network, amt_msat,
348 InvoiceDescription::Hash(&description_hash),
349 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
353 /// See [`create_invoice_from_channelmanager`]
354 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
355 /// available and the current time is supplied by the caller.
356 pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
357 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
358 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
359 invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
360 ) -> Result<Invoice, SignOrCreationError<()>>
362 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
363 T::Target: BroadcasterInterface,
364 ES::Target: EntropySource,
365 NS::Target: NodeSigner,
366 SP::Target: SignerProvider,
367 F::Target: FeeEstimator,
371 _create_invoice_from_channelmanager_and_duration_since_epoch(
372 channelmanager, node_signer, logger, network, amt_msat,
373 InvoiceDescription::Direct(
374 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
376 duration_since_epoch, invoice_expiry_delta_secs, min_final_cltv_expiry_delta,
380 fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
381 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
382 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
383 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, min_final_cltv_expiry_delta: Option<u16>,
384 ) -> Result<Invoice, SignOrCreationError<()>>
386 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
387 T::Target: BroadcasterInterface,
388 ES::Target: EntropySource,
389 NS::Target: NodeSigner,
390 SP::Target: SignerProvider,
391 F::Target: FeeEstimator,
395 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
396 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
399 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
401 let (payment_hash, payment_secret) = channelmanager
402 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs, min_final_cltv_expiry_delta)
403 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
404 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
405 channelmanager, node_signer, logger, network, amt_msat, description, duration_since_epoch,
406 invoice_expiry_delta_secs, payment_hash, payment_secret, min_final_cltv_expiry_delta)
409 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
410 /// This version allows for providing a custom [`PaymentHash`] for the invoice.
411 /// This may be useful if you're building an on-chain swap or involving another protocol where
412 /// the payment hash is also involved outside the scope of lightning.
413 pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
414 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
415 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
416 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, min_final_cltv_expiry_delta: Option<u16>,
417 ) -> Result<Invoice, SignOrCreationError<()>>
419 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
420 T::Target: BroadcasterInterface,
421 ES::Target: EntropySource,
422 NS::Target: NodeSigner,
423 SP::Target: SignerProvider,
424 F::Target: FeeEstimator,
428 let payment_secret = channelmanager
429 .create_inbound_payment_for_hash(payment_hash, amt_msat, invoice_expiry_delta_secs,
430 min_final_cltv_expiry_delta)
431 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
432 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
433 channelmanager, node_signer, logger, network, amt_msat,
434 InvoiceDescription::Direct(
435 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
437 duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret,
438 min_final_cltv_expiry_delta,
442 fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>(
443 channelmanager: &ChannelManager<M, T, ES, NS, SP, F, R, L>, node_signer: NS, logger: L,
444 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription, duration_since_epoch: Duration,
445 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, payment_secret: PaymentSecret,
446 min_final_cltv_expiry_delta: Option<u16>,
447 ) -> Result<Invoice, SignOrCreationError<()>>
449 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
450 T::Target: BroadcasterInterface,
451 ES::Target: EntropySource,
452 NS::Target: NodeSigner,
453 SP::Target: SignerProvider,
454 F::Target: FeeEstimator,
458 let our_node_pubkey = channelmanager.get_our_node_id();
459 let channels = channelmanager.list_channels();
461 if min_final_cltv_expiry_delta.is_some() && min_final_cltv_expiry_delta.unwrap().saturating_add(3) < MIN_FINAL_CLTV_EXPIRY_DELTA {
462 return Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort));
465 log_trace!(logger, "Creating invoice with payment hash {}", log_bytes!(payment_hash.0));
467 let invoice = match description {
468 InvoiceDescription::Direct(description) => {
469 InvoiceBuilder::new(network).description(description.0.clone())
471 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
474 let mut invoice = invoice
475 .duration_since_epoch(duration_since_epoch)
476 .payee_pub_key(our_node_pubkey)
477 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
478 .payment_secret(payment_secret)
480 .min_final_cltv_expiry_delta(
481 // Add a buffer of 3 to the delta if present, otherwise use LDK's minimum.
482 min_final_cltv_expiry_delta.map(|x| x.saturating_add(3)).unwrap_or(MIN_FINAL_CLTV_EXPIRY_DELTA).into())
483 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
484 if let Some(amt) = amt_msat {
485 invoice = invoice.amount_milli_satoshis(amt);
488 let route_hints = sort_and_filter_channels(channels, amt_msat, &logger);
489 for hint in route_hints {
490 invoice = invoice.private_route(hint);
493 let raw_invoice = match invoice.build_raw() {
495 Err(e) => return Err(SignOrCreationError::CreationError(e))
497 let hrp_str = raw_invoice.hrp.to_string();
498 let hrp_bytes = hrp_str.as_bytes();
499 let data_without_signature = raw_invoice.data.to_base32();
500 let signed_raw_invoice = raw_invoice.sign(|_| node_signer.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
501 match signed_raw_invoice {
502 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
503 Err(e) => Err(SignOrCreationError::SignError(e))
507 /// Sorts and filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
510 /// The filtering is based on the following criteria:
511 /// * Only one channel per counterparty node
512 /// * If the counterparty has a channel that is above the `min_inbound_capacity_msat` + 10% scaling
513 /// factor (to allow some margin for change in inbound), select the channel with the lowest
514 /// inbound capacity that is above this threshold.
515 /// * If no `min_inbound_capacity_msat` is specified, or the counterparty has no channels above the
516 /// minimum + 10% scaling factor, select the channel with the highest inbound capacity per counterparty.
517 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
518 /// `is_usable` (i.e. the peer is connected).
519 /// * If any public channel exists, only public [`RouteHint`]s will be returned.
520 /// * If any public, announced, channel exists (i.e. a channel with 7+ confs, to ensure the
521 /// announcement has had a chance to propagate), no [`RouteHint`]s will be returned, as the
522 /// sender is expected to find the path by looking at the public channels instead.
523 /// * Limited to a total of 3 channels.
524 /// * Sorted by lowest inbound capacity if an online channel with the minimum amount requested exists,
525 /// otherwise sort by highest inbound capacity to give the payment the best chance of succeeding.
526 fn sort_and_filter_channels<L: Deref>(
527 channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>, logger: &L
528 ) -> Vec<RouteHint> where L::Target: Logger {
529 let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
530 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
531 let mut min_capacity_channel_exists = false;
532 let mut online_channel_exists = false;
533 let mut online_min_capacity_channel_exists = false;
534 let mut has_pub_unconf_chan = false;
536 log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
537 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
538 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
539 log_trace!(logger, "Ignoring channel {} for invoice route hints", log_bytes!(channel.channel_id));
543 if channel.is_public {
544 if channel.confirmations.is_some() && channel.confirmations < Some(7) {
545 // If we have a public channel, but it doesn't have enough confirmations to (yet)
546 // be in the public network graph (and have gotten a chance to propagate), include
547 // route hints but only for public channels to protect private channel privacy.
548 has_pub_unconf_chan = true;
550 // If any public channel exists, return no hints and let the sender
551 // look at the public channels instead.
552 log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
553 log_bytes!(channel.channel_id));
558 if channel.inbound_capacity_msat >= min_inbound_capacity {
559 if !min_capacity_channel_exists {
560 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
561 min_capacity_channel_exists = true;
564 if channel.is_usable {
565 online_min_capacity_channel_exists = true;
569 if channel.is_usable && !online_channel_exists {
570 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
571 online_channel_exists = true;
574 match filtered_channels.entry(channel.counterparty.node_id) {
575 hash_map::Entry::Occupied(mut entry) => {
576 let current_max_capacity = entry.get().inbound_capacity_msat;
577 // If this channel is public and the previous channel is not, ensure we replace the
578 // previous channel to avoid announcing non-public channels.
579 let new_now_public = channel.is_public && !entry.get().is_public;
580 // Decide whether we prefer the currently selected channel with the node to the new one,
581 // based on their inbound capacity.
582 let prefer_current = prefer_current_channel(min_inbound_capacity_msat, current_max_capacity,
583 channel.inbound_capacity_msat);
584 // If the public-ness of the channel has not changed (in which case simply defer to
585 // `new_now_public), and this channel has more desirable inbound than the incumbent,
586 // prefer to include this channel.
587 let new_channel_preferable = channel.is_public == entry.get().is_public && !prefer_current;
589 if new_now_public || new_channel_preferable {
591 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
592 log_pubkey!(channel.counterparty.node_id),
593 log_bytes!(channel.channel_id), channel.short_channel_id,
594 channel.inbound_capacity_msat,
595 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
596 current_max_capacity);
597 entry.insert(channel);
600 "Preferring counterparty {} channel {} (SCID {:?}, {} msats) over {} (SCID {:?}, {} msats) for invoice route hints",
601 log_pubkey!(channel.counterparty.node_id),
602 log_bytes!(entry.get().channel_id), entry.get().short_channel_id,
603 current_max_capacity,
604 log_bytes!(channel.channel_id), channel.short_channel_id,
605 channel.inbound_capacity_msat);
608 hash_map::Entry::Vacant(entry) => {
609 entry.insert(channel);
614 let route_hint_from_channel = |channel: ChannelDetails| {
615 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
616 RouteHint(vec![RouteHintHop {
617 src_node_id: channel.counterparty.node_id,
618 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
620 base_msat: forwarding_info.fee_base_msat,
621 proportional_millionths: forwarding_info.fee_proportional_millionths,
623 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
624 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
625 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
627 // If all channels are private, prefer to return route hints which have a higher capacity than
628 // the payment value and where we're currently connected to the channel counterparty.
629 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
630 // those which meet at least one criteria.
631 let mut eligible_channels = filtered_channels
633 .map(|(_, channel)| channel)
635 let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
636 let include_channel = if has_pub_unconf_chan {
637 // If we have a public channel, but it doesn't have enough confirmations to (yet)
638 // be in the public network graph (and have gotten a chance to propagate), include
639 // route hints but only for public channels to protect private channel privacy.
641 } else if online_min_capacity_channel_exists {
642 has_enough_capacity && channel.is_usable
643 } else if min_capacity_channel_exists && online_channel_exists {
644 // If there are some online channels and some min_capacity channels, but no
645 // online-and-min_capacity channels, just include the min capacity ones and ignore
648 } else if min_capacity_channel_exists {
650 } else if online_channel_exists {
655 log_trace!(logger, "Including channel {} in invoice route hints",
656 log_bytes!(channel.channel_id));
657 } else if !has_enough_capacity {
658 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
659 log_bytes!(channel.channel_id));
661 debug_assert!(!channel.is_usable || (has_pub_unconf_chan && !channel.is_public));
662 log_trace!(logger, "Ignoring channel {} with disconnected peer",
663 log_bytes!(channel.channel_id));
668 .collect::<Vec<ChannelDetails>>();
670 eligible_channels.sort_unstable_by(|a, b| {
671 if online_min_capacity_channel_exists {
672 a.inbound_capacity_msat.cmp(&b.inbound_capacity_msat)
674 b.inbound_capacity_msat.cmp(&a.inbound_capacity_msat)
676 eligible_channels.into_iter().take(3).map(route_hint_from_channel).collect::<Vec<RouteHint>>()
679 /// prefer_current_channel chooses a channel to use for route hints between a currently selected and candidate
680 /// channel based on the inbound capacity of each channel and the minimum inbound capacity requested for the hints,
681 /// returning true if the current channel should be preferred over the candidate channel.
682 /// * If no minimum amount is requested, the channel with the most inbound is chosen to maximize the chances that a
683 /// payment of any size will succeed.
684 /// * If we have channels with inbound above our minimum requested inbound (plus a 10% scaling factor, expressed as a
685 /// percentage) then we choose the lowest inbound channel with above this amount. If we have sufficient inbound
686 /// channels, we don't want to deplete our larger channels with small payments (the off-chain version of "grinding
688 /// * If no channel above our minimum amount exists, then we just prefer the channel with the most inbound to give
689 /// payments the best chance of succeeding in multiple parts.
690 fn prefer_current_channel(min_inbound_capacity_msat: Option<u64>, current_channel: u64,
691 candidate_channel: u64) -> bool {
693 // If no min amount is given for the hints, err of the side of caution and choose the largest channel inbound to
694 // maximize chances of any payment succeeding.
695 if min_inbound_capacity_msat.is_none() {
696 return current_channel > candidate_channel
699 let scaled_min_inbound = min_inbound_capacity_msat.unwrap() * 110;
700 let current_sufficient = current_channel * 100 >= scaled_min_inbound;
701 let candidate_sufficient = candidate_channel * 100 >= scaled_min_inbound;
703 if current_sufficient && candidate_sufficient {
704 return current_channel < candidate_channel
705 } else if current_sufficient {
707 } else if candidate_sufficient {
711 current_channel > candidate_channel
716 use core::time::Duration;
717 use crate::{Currency, Description, InvoiceDescription, SignOrCreationError, CreationError};
718 use bitcoin_hashes::{Hash, sha256};
719 use bitcoin_hashes::sha256::Hash as Sha256;
720 use lightning::chain::keysinterface::{EntropySource, PhantomKeysManager};
721 use lightning::events::{MessageSendEvent, MessageSendEventsProvider, Event};
722 use lightning::ln::{PaymentPreimage, PaymentHash};
723 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY_DELTA, PaymentId};
724 use lightning::ln::functional_test_utils::*;
725 use lightning::ln::msgs::ChannelMessageHandler;
726 use lightning::routing::router::{PaymentParameters, RouteParameters, find_route};
727 use lightning::util::test_utils;
728 use lightning::util::config::UserConfig;
729 use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
730 use std::collections::HashSet;
733 fn test_prefer_current_channel() {
734 // No minimum, prefer larger candidate channel.
735 assert_eq!(crate::utils::prefer_current_channel(None, 100, 200), false);
737 // No minimum, prefer larger current channel.
738 assert_eq!(crate::utils::prefer_current_channel(None, 200, 100), true);
740 // Minimum set, prefer current channel over minimum + buffer.
741 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 100), true);
743 // Minimum set, prefer candidate channel over minimum + buffer.
744 assert_eq!(crate::utils::prefer_current_channel(Some(100), 105, 125), false);
746 // Minimum set, both channels sufficient, prefer smaller current channel.
747 assert_eq!(crate::utils::prefer_current_channel(Some(100), 115, 125), true);
749 // Minimum set, both channels sufficient, prefer smaller candidate channel.
750 assert_eq!(crate::utils::prefer_current_channel(Some(100), 200, 160), false);
752 // Minimum set, neither sufficient, prefer larger current channel.
753 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 50), true);
755 // Minimum set, neither sufficient, prefer larger candidate channel.
756 assert_eq!(crate::utils::prefer_current_channel(Some(200), 100, 150), false);
761 fn test_from_channelmanager() {
762 let chanmon_cfgs = create_chanmon_cfgs(2);
763 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
764 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
765 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
766 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
767 let non_default_invoice_expiry_secs = 4200;
768 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
769 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
770 Some(10_000), "test".to_string(), Duration::from_secs(1234567),
771 non_default_invoice_expiry_secs, None).unwrap();
772 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
773 // If no `min_final_cltv_expiry_delta` is specified, then it should be `MIN_FINAL_CLTV_EXPIRY_DELTA`.
774 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
775 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
776 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
778 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
780 let chan = &nodes[1].node.list_usable_channels()[0];
781 assert_eq!(invoice.route_hints().len(), 1);
782 assert_eq!(invoice.route_hints()[0].0.len(), 1);
783 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
785 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
786 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
788 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
789 invoice.min_final_cltv_expiry_delta() as u32)
790 .with_features(invoice.features().unwrap().clone())
791 .with_route_hints(invoice.route_hints());
792 let route_params = RouteParameters {
794 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
796 let first_hops = nodes[0].node.list_usable_channels();
797 let network_graph = &node_cfgs[0].network_graph;
798 let logger = test_utils::TestLogger::new();
799 let scorer = test_utils::TestScorer::new();
800 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
801 let route = find_route(
802 &nodes[0].node.get_our_node_id(), &route_params, network_graph,
803 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
806 let payment_event = {
807 let mut payment_hash = PaymentHash([0; 32]);
808 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
809 nodes[0].node.send_payment(&route, payment_hash, &Some(*invoice.payment_secret()), PaymentId(payment_hash.0)).unwrap();
810 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
811 assert_eq!(added_monitors.len(), 1);
812 added_monitors.clear();
814 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
815 assert_eq!(events.len(), 1);
816 SendEvent::from_event(events.remove(0))
819 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
820 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
821 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
822 assert_eq!(added_monitors.len(), 1);
823 added_monitors.clear();
824 let events = nodes[1].node.get_and_clear_pending_msg_events();
825 assert_eq!(events.len(), 2);
828 fn do_create_invoice_min_final_cltv_delta(with_custom_delta: bool) {
829 let chanmon_cfgs = create_chanmon_cfgs(2);
830 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
831 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
832 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
833 let custom_min_final_cltv_expiry_delta = Some(50);
835 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
836 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
837 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
838 if with_custom_delta { custom_min_final_cltv_expiry_delta } else { None },
840 assert_eq!(invoice.min_final_cltv_expiry_delta(), if with_custom_delta {
841 custom_min_final_cltv_expiry_delta.unwrap() + 3 /* Buffer */} else { MIN_FINAL_CLTV_EXPIRY_DELTA } as u64);
845 fn test_create_invoice_custom_min_final_cltv_delta() {
846 do_create_invoice_min_final_cltv_delta(true);
847 do_create_invoice_min_final_cltv_delta(false);
851 fn create_invoice_min_final_cltv_delta_equals_htlc_fail_buffer() {
852 let chanmon_cfgs = create_chanmon_cfgs(2);
853 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
854 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
855 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
856 let custom_min_final_cltv_expiry_delta = Some(21);
858 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
859 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
860 Some(10_000), "".into(), Duration::from_secs(1234567), 3600,
861 custom_min_final_cltv_expiry_delta,
863 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
867 fn test_create_invoice_with_description_hash() {
868 let chanmon_cfgs = create_chanmon_cfgs(2);
869 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
870 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
871 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
872 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
873 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
874 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
875 Some(10_000), description_hash, Duration::from_secs(1234567), 3600, None,
877 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
878 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
879 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
883 fn test_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash() {
884 let chanmon_cfgs = create_chanmon_cfgs(2);
885 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
886 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
887 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
888 let payment_hash = PaymentHash([0; 32]);
889 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
890 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
891 Some(10_000), "test".to_string(), Duration::from_secs(1234567), 3600,
894 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
895 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
896 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
897 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
901 fn test_hints_has_only_public_confd_channels() {
902 let chanmon_cfgs = create_chanmon_cfgs(2);
903 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
904 let mut config = test_default_channel_config();
905 config.channel_handshake_config.minimum_depth = 1;
906 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
907 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
909 // Create a private channel with lots of capacity and a lower value public channel (without
910 // confirming the funding tx yet).
911 let unannounced_scid = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0);
912 let conf_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 10_000, 0);
914 // Before the channel is available, we should include the unannounced_scid.
915 let mut scid_aliases = HashSet::new();
916 scid_aliases.insert(unannounced_scid.0.short_channel_id_alias.unwrap());
917 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
919 // However after we mine the funding tx and exchange channel_ready messages for the public
920 // channel we'll immediately switch to including it as a route hint, even though it isn't
922 let pub_channel_scid = mine_transaction(&nodes[0], &conf_tx);
923 let node_a_pub_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
924 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &node_a_pub_channel_ready);
926 assert_eq!(mine_transaction(&nodes[1], &conf_tx), pub_channel_scid);
927 let events = nodes[1].node.get_and_clear_pending_msg_events();
928 assert_eq!(events.len(), 2);
929 if let MessageSendEvent::SendChannelReady { msg, .. } = &events[0] {
930 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), msg);
932 if let MessageSendEvent::SendChannelUpdate { msg, .. } = &events[1] {
933 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), msg);
936 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()));
938 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
939 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
941 scid_aliases.clear();
942 scid_aliases.insert(node_a_pub_channel_ready.short_channel_id_alias.unwrap());
943 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
944 // This also applies even if the amount is more than the payment amount, to ensure users
945 // dont screw up their privacy.
946 match_invoice_routes(Some(50_000_000), &nodes[1], scid_aliases.clone());
948 // The same remains true until the channel has 7 confirmations, at which point we include
950 connect_blocks(&nodes[1], 5);
951 match_invoice_routes(Some(5000), &nodes[1], scid_aliases.clone());
952 connect_blocks(&nodes[1], 1);
953 get_event_msg!(nodes[1], MessageSendEvent::SendAnnouncementSignatures, nodes[0].node.get_our_node_id());
954 match_invoice_routes(Some(5000), &nodes[1], HashSet::new());
958 fn test_hints_includes_single_channels_to_nodes() {
959 let chanmon_cfgs = create_chanmon_cfgs(3);
960 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
961 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
962 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
964 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
965 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
967 let mut scid_aliases = HashSet::new();
968 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
969 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
971 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
975 fn test_hints_has_only_lowest_inbound_capacity_channel_above_minimum() {
976 let chanmon_cfgs = create_chanmon_cfgs(2);
977 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
978 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
979 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
981 let _chan_1_0_inbound_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000, 0);
982 let _chan_1_0_large_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 500_000, 0);
983 let chan_1_0_low_inbound_above_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 200_000, 0);
985 let mut scid_aliases = HashSet::new();
986 scid_aliases.insert(chan_1_0_low_inbound_above_amt.0.short_channel_id_alias.unwrap());
987 match_invoice_routes(Some(100_000_000), &nodes[0], scid_aliases);
991 fn test_hints_has_only_online_channels() {
992 let chanmon_cfgs = create_chanmon_cfgs(4);
993 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
994 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
995 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
996 let chan_a = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0);
997 let chan_b = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 10_000_000, 0);
998 let _chan_c = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 1_000_000, 0);
1000 // With all peers connected we should get all hints that have sufficient value
1001 let mut scid_aliases = HashSet::new();
1002 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
1003 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1005 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1007 // With only one sufficient-value peer connected we should only get its hint
1008 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
1009 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());
1010 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1012 // If we don't have any sufficient-value peers connected we should get all hints with
1013 // sufficient value, even though there is a connected insufficient-value peer.
1014 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
1015 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1016 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
1020 fn test_insufficient_inbound_sort_by_highest_capacity() {
1021 let chanmon_cfgs = create_chanmon_cfgs(5);
1022 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1023 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1024 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1025 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1026 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1027 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1028 let chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1030 // When no single channel has enough inbound capacity for the payment, we expect the three
1031 // highest inbound channels to be chosen.
1032 let mut scid_aliases = HashSet::new();
1033 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1034 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1035 scid_aliases.insert(chan_4_0.0.short_channel_id_alias.unwrap());
1037 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
1041 fn test_sufficient_inbound_sort_by_lowest_capacity() {
1042 let chanmon_cfgs = create_chanmon_cfgs(5);
1043 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1044 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1045 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1046 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1047 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 200_000, 0);
1048 let chan_3_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 300_000, 0);
1049 let _chan_4_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 4, 0, 400_000, 0);
1051 // When we have channels that have sufficient inbound for the payment, test that we sort
1052 // by lowest inbound capacity.
1053 let mut scid_aliases = HashSet::new();
1054 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1055 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1056 scid_aliases.insert(chan_3_0.0.short_channel_id_alias.unwrap());
1058 match_invoice_routes(Some(50_000_000), &nodes[0], scid_aliases.clone());
1062 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
1063 let chanmon_cfgs = create_chanmon_cfgs(3);
1064 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1065 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1066 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1067 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1069 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
1070 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1071 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1072 let mut private_chan_cfg = UserConfig::default();
1073 private_chan_cfg.channel_handshake_config.announced_channel = false;
1074 let temporary_channel_id = nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 1_000_000, 500_000_000, 42, Some(private_chan_cfg)).unwrap();
1075 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
1076 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_channel);
1077 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
1078 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), &accept_channel);
1080 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
1082 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
1083 confirm_transaction_at(&nodes[2], &tx, conf_height);
1084 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
1085 confirm_transaction_at(&nodes[0], &tx, conf_height);
1086 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
1087 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
1088 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()));
1089 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1090 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
1091 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
1092 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
1093 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
1095 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
1096 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1097 // Therefore only `chan_1_0` should be included in the hints.
1098 let mut scid_aliases = HashSet::new();
1099 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1100 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
1104 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
1105 let chanmon_cfgs = create_chanmon_cfgs(3);
1106 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1107 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1108 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1109 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1111 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1112 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1113 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1115 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
1116 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
1117 // public channel between `nodes[2]` and `nodes[0]`
1118 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1122 fn test_only_public_channels_includes_no_channels_in_hints() {
1123 let chanmon_cfgs = create_chanmon_cfgs(3);
1124 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1125 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1126 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1127 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001);
1128 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
1129 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
1131 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1132 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1133 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1135 // As all of `nodes[0]` channels are public, no channels should be included in the hints
1136 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
1140 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
1141 let chanmon_cfgs = create_chanmon_cfgs(3);
1142 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1143 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1144 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1145 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0);
1146 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0);
1148 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
1149 let mut scid_aliases_99_000_001_msat = HashSet::new();
1150 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1152 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
1154 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
1155 let mut scid_aliases_99_000_000_msat = HashSet::new();
1156 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1157 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1159 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
1161 // As the invoice amt is above all channels' inbound capacity, they will still be included
1162 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
1163 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1164 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1166 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
1168 // An invoice with no specified amount should include all channels in the route hints.
1169 let mut scid_aliases_no_specified_amount = HashSet::new();
1170 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
1171 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
1173 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
1176 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1177 invoice_amt: Option<u64>,
1178 invoice_node: &Node<'a, 'b, 'c>,
1179 mut chan_ids_to_match: HashSet<u64>
1181 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
1182 invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
1183 Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
1184 3600, None).unwrap();
1185 let hints = invoice.private_routes();
1188 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
1189 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1191 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1195 #[cfg(feature = "std")]
1196 fn test_multi_node_receive() {
1197 do_test_multi_node_receive(true);
1198 do_test_multi_node_receive(false);
1201 #[cfg(feature = "std")]
1202 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
1203 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1204 let seed_1 = [42u8; 32];
1205 let seed_2 = [43u8; 32];
1206 let cross_node_seed = [44u8; 32];
1207 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1208 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1209 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1210 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1211 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1212 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1213 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
1214 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
1215 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1216 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1217 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1219 let payment_amt = 10_000;
1220 let route_hints = vec![
1221 nodes[1].node.get_phantom_route_hints(),
1222 nodes[2].node.get_phantom_route_hints(),
1225 let user_payment_preimage = PaymentPreimage([1; 32]);
1226 let payment_hash = if user_generated_pmt_hash {
1227 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
1231 let non_default_invoice_expiry_secs = 4200;
1234 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
1235 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1236 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1237 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
1239 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
1240 let payment_preimage = if user_generated_pmt_hash {
1241 user_payment_preimage
1243 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1246 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1247 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
1248 assert_eq!(invoice.route_hints().len(), 2);
1249 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1250 assert!(!invoice.features().unwrap().supports_basic_mpp());
1252 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key(),
1253 invoice.min_final_cltv_expiry_delta() as u32)
1254 .with_features(invoice.features().unwrap().clone())
1255 .with_route_hints(invoice.route_hints());
1256 let params = RouteParameters {
1258 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
1260 let first_hops = nodes[0].node.list_usable_channels();
1261 let network_graph = &node_cfgs[0].network_graph;
1262 let logger = test_utils::TestLogger::new();
1263 let scorer = test_utils::TestScorer::new();
1264 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
1265 let route = find_route(
1266 &nodes[0].node.get_our_node_id(), ¶ms, network_graph,
1267 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
1269 let (payment_event, fwd_idx) = {
1270 let mut payment_hash = PaymentHash([0; 32]);
1271 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1272 nodes[0].node.send_payment(&route, payment_hash, &Some(*invoice.payment_secret()), PaymentId(payment_hash.0)).unwrap();
1273 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1274 assert_eq!(added_monitors.len(), 1);
1275 added_monitors.clear();
1277 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1278 assert_eq!(events.len(), 1);
1279 let fwd_idx = match events[0] {
1280 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1281 if node_id == nodes[1].node.get_our_node_id() {
1285 _ => panic!("Unexpected event")
1287 (SendEvent::from_event(events.remove(0)), fwd_idx)
1289 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1290 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1292 // Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
1293 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1294 // payments "look real" by taking more time.
1295 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1296 nodes[fwd_idx].node.process_pending_htlc_forwards();
1297 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1298 nodes[fwd_idx].node.process_pending_htlc_forwards();
1300 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1301 expect_payment_claimable!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt, route.paths[0].last().unwrap().pubkey);
1302 do_claim_payment_along_route(&nodes[0], &[&vec!(&nodes[fwd_idx])[..]], false, payment_preimage);
1303 let events = nodes[0].node.get_and_clear_pending_events();
1304 assert_eq!(events.len(), 2);
1306 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1307 assert_eq!(payment_preimage, *ev_preimage);
1308 assert_eq!(payment_hash, *ev_hash);
1309 assert_eq!(fee_paid_msat, &Some(0));
1311 _ => panic!("Unexpected event")
1314 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1315 assert_eq!(hash, Some(payment_hash));
1317 _ => panic!("Unexpected event")
1322 #[cfg(feature = "std")]
1323 fn test_multi_node_hints_has_htlc_min_max_values() {
1324 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1325 let seed_1 = [42u8; 32];
1326 let seed_2 = [43u8; 32];
1327 let cross_node_seed = [44u8; 32];
1328 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1329 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1330 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1331 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1332 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1334 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1335 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1337 let payment_amt = 20_000;
1338 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600, None).unwrap();
1339 let route_hints = vec![
1340 nodes[1].node.get_phantom_route_hints(),
1341 nodes[2].node.get_phantom_route_hints(),
1344 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1345 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
1346 "test".to_string(), 3600, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1347 nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1349 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1350 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1351 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1353 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1354 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1355 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1359 #[cfg(feature = "std")]
1360 fn create_phantom_invoice_with_description_hash() {
1361 let chanmon_cfgs = create_chanmon_cfgs(3);
1362 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1363 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1364 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1366 let payment_amt = 20_000;
1367 let route_hints = vec![
1368 nodes[1].node.get_phantom_route_hints(),
1369 nodes[2].node.get_phantom_route_hints(),
1372 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1373 let non_default_invoice_expiry_secs = 4200;
1374 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1375 &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger,
1377 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1378 route_hints, nodes[1].keys_manager, nodes[1].keys_manager, nodes[1].logger,
1379 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
1382 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1383 assert_eq!(invoice.min_final_cltv_expiry_delta(), MIN_FINAL_CLTV_EXPIRY_DELTA as u64);
1384 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1385 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1389 #[cfg(feature = "std")]
1390 fn create_phantom_invoice_with_custom_payment_hash_and_custom_min_final_cltv_delta() {
1391 let chanmon_cfgs = create_chanmon_cfgs(3);
1392 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1393 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1394 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1396 let payment_amt = 20_000;
1397 let route_hints = vec![
1398 nodes[1].node.get_phantom_route_hints(),
1399 nodes[2].node.get_phantom_route_hints(),
1401 let user_payment_preimage = PaymentPreimage([1; 32]);
1402 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
1403 let non_default_invoice_expiry_secs = 4200;
1404 let min_final_cltv_expiry_delta = Some(100);
1405 let duration_since_epoch = Duration::from_secs(1234567);
1406 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1407 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
1408 "".to_string(), non_default_invoice_expiry_secs, route_hints, nodes[1].keys_manager, nodes[1].keys_manager,
1409 nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
1410 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1411 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
1412 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1416 #[cfg(feature = "std")]
1417 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1418 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1419 let seed_1 = [42u8; 32];
1420 let seed_2 = [43u8; 32];
1421 let cross_node_seed = [44u8; 32];
1422 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1423 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1424 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1425 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1426 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1428 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1429 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1431 let mut scid_aliases = HashSet::new();
1432 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1433 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1435 match_multi_node_invoice_routes(
1438 vec![&nodes[1], &nodes[2],],
1445 #[cfg(feature = "std")]
1446 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1447 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1448 let seed_1 = [42u8; 32];
1449 let seed_2 = [43u8; 32];
1450 let cross_node_seed = [44u8; 32];
1451 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1452 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1453 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1454 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1455 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1457 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1458 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1459 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005);
1461 let mut scid_aliases = HashSet::new();
1462 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1463 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1464 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1466 match_multi_node_invoice_routes(
1469 vec![&nodes[2], &nodes[3],],
1476 #[cfg(feature = "std")]
1477 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1478 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1479 let seed_1 = [42u8; 32];
1480 let seed_2 = [43u8; 32];
1481 let cross_node_seed = [44u8; 32];
1482 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1483 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1484 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1485 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1486 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1488 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1489 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001);
1491 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1492 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1493 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1494 let mut private_chan_cfg = UserConfig::default();
1495 private_chan_cfg.channel_handshake_config.announced_channel = false;
1496 let temporary_channel_id = nodes[1].node.create_channel(nodes[3].node.get_our_node_id(), 1_000_000, 500_000_000, 42, Some(private_chan_cfg)).unwrap();
1497 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1498 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
1499 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1500 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), &accept_channel);
1502 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1504 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1505 confirm_transaction_at(&nodes[1], &tx, conf_height);
1506 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1507 confirm_transaction_at(&nodes[3], &tx, conf_height);
1508 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1509 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1510 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()));
1511 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1512 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1513 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1514 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1515 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1517 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1518 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1519 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1520 let mut scid_aliases = HashSet::new();
1521 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1522 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1524 match_multi_node_invoice_routes(
1527 vec![&nodes[2], &nodes[3],],
1534 #[cfg(feature = "std")]
1535 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1536 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1537 let seed_1 = [42u8; 32];
1538 let seed_2 = [43u8; 32];
1539 let cross_node_seed = [44u8; 32];
1540 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1541 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1542 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1543 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1544 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1546 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
1548 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001);
1549 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1550 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1552 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1553 // `chan_0_2` as `nodes[2]` only has public channels.
1554 let mut scid_aliases = HashSet::new();
1555 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1557 match_multi_node_invoice_routes(
1560 vec![&nodes[1], &nodes[2],],
1567 #[cfg(feature = "std")]
1568 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1569 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1570 let seed_1 = [42u8; 32];
1571 let seed_2 = [43u8; 32];
1572 let cross_node_seed = [44u8; 32];
1573 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1574 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1575 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1576 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1577 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1579 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1580 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1581 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1582 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
1584 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001);
1586 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1587 // channels for `nodes[2]` as it contains a mix of public and private channels.
1588 let mut scid_aliases = HashSet::new();
1589 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1591 match_multi_node_invoice_routes(
1594 vec![&nodes[2], &nodes[3],],
1601 #[cfg(feature = "std")]
1602 fn test_multi_node_hints_has_only_lowest_inbound_channel_above_minimum() {
1603 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1604 let seed_1 = [42u8; 32];
1605 let seed_2 = [43u8; 32];
1606 let cross_node_seed = [44u8; 32];
1607 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1608 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1609 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1610 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1611 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1613 let _chan_0_1_below_amt = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1614 let _chan_0_1_above_amt_high_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 500_000, 0);
1615 let chan_0_1_above_amt_low_inbound = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 180_000, 0);
1616 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
1618 let mut scid_aliases = HashSet::new();
1619 scid_aliases.insert(chan_0_1_above_amt_low_inbound.0.short_channel_id_alias.unwrap());
1620 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1622 match_multi_node_invoice_routes(
1625 vec![&nodes[1], &nodes[2],],
1632 #[cfg(feature = "std")]
1633 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1634 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1635 let seed_1 = [42u8; 32];
1636 let seed_2 = [43u8; 32];
1637 let cross_node_seed = [44u8; 32];
1638 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1639 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1640 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1641 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1642 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1644 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1645 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0);
1646 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0);
1648 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1649 let mut scid_aliases_99_000_001_msat = HashSet::new();
1650 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1651 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1653 match_multi_node_invoice_routes(
1656 vec![&nodes[2], &nodes[3],],
1657 scid_aliases_99_000_001_msat,
1661 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1662 let mut scid_aliases_99_000_000_msat = HashSet::new();
1663 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1664 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1665 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1667 match_multi_node_invoice_routes(
1670 vec![&nodes[2], &nodes[3],],
1671 scid_aliases_99_000_000_msat,
1675 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1676 // `nodes[2]` them should be included.
1677 let mut scid_aliases_300_000_000_msat = HashSet::new();
1678 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1679 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1680 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1682 match_multi_node_invoice_routes(
1685 vec![&nodes[2], &nodes[3],],
1686 scid_aliases_300_000_000_msat,
1690 // Since the no specified amount, all channels should included.
1691 let mut scid_aliases_no_specified_amount = HashSet::new();
1692 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1693 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1694 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1696 match_multi_node_invoice_routes(
1699 vec![&nodes[2], &nodes[3],],
1700 scid_aliases_no_specified_amount,
1705 #[cfg(feature = "std")]
1706 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1707 invoice_amt: Option<u64>,
1708 invoice_node: &Node<'a, 'b, 'c>,
1709 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1710 mut chan_ids_to_match: HashSet<u64>,
1711 nodes_contains_public_channels: bool
1713 let phantom_route_hints = network_multi_nodes.iter()
1714 .map(|node| node.node.get_phantom_route_hints())
1715 .collect::<Vec<PhantomRouteHints>>();
1716 let phantom_scids = phantom_route_hints.iter()
1717 .map(|route_hint| route_hint.phantom_scid)
1718 .collect::<HashSet<u64>>();
1720 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
1721 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
1722 3600, phantom_route_hints, invoice_node.keys_manager, invoice_node.keys_manager,
1723 invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();
1725 let invoice_hints = invoice.private_routes();
1727 for hint in invoice_hints {
1728 let hints = &(hint.0).0;
1731 assert!(nodes_contains_public_channels);
1732 let phantom_scid = hints[0].short_channel_id;
1733 assert!(phantom_scids.contains(&phantom_scid));
1736 let hint_short_chan_id = hints[0].short_channel_id;
1737 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1738 let phantom_scid = hints[1].short_channel_id;
1739 assert!(phantom_scids.contains(&phantom_scid));
1741 _ => panic!("Incorrect hint length generated")
1744 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1748 fn test_create_invoice_fails_with_invalid_custom_min_final_cltv_expiry_delta() {
1749 let chanmon_cfgs = create_chanmon_cfgs(2);
1750 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1751 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1752 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1753 let result = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch(
1754 nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
1755 Some(10_000), "Some description".into(), Duration::from_secs(1234567), 3600, Some(MIN_FINAL_CLTV_EXPIRY_DELTA - 4),
1758 Err(SignOrCreationError::CreationError(CreationError::MinFinalCltvExpiryDeltaTooShort)) => {},