1 //! Convenient utilities to create an invoice.
3 use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
4 use crate::payment::Payer;
6 use crate::{prelude::*, Description, InvoiceDescription, Sha256};
8 use bitcoin_hashes::Hash;
10 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
11 use lightning::chain::keysinterface::{Recipient, KeysInterface, NodeSigner, SignerProvider};
12 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
13 use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY};
14 #[cfg(feature = "std")]
15 use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
16 use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
17 use lightning::routing::gossip::RoutingFees;
18 use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, Router};
19 use lightning::util::logger::Logger;
20 use secp256k1::PublicKey;
22 use core::time::Duration;
24 #[cfg(feature = "std")]
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 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
46 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
49 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
50 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
51 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
52 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
53 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
54 pub fn create_phantom_invoice<K: Deref, L: Deref>(
55 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
56 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
57 logger: L, network: Currency,
58 ) -> Result<Invoice, SignOrCreationError<()>>
60 K::Target: KeysInterface,
63 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
64 let description = InvoiceDescription::Direct(&description,);
65 _create_phantom_invoice::<K, L>(
66 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
67 keys_manager, logger, network,
71 #[cfg(feature = "std")]
72 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
73 /// See [`PhantomKeysManager`] for more information on phantom node payments.
75 /// `phantom_route_hints` parameter:
76 /// * Contains channel info for all nodes participating in the phantom invoice
77 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
78 /// participating node
79 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
80 /// updated when a channel becomes disabled or closes
81 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
82 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
85 /// `description_hash` is a SHA-256 hash of the description text
87 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
88 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
89 /// If `None` is provided for `payment_hash`, then one will be created.
91 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
92 /// in excess of the current time.
94 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
95 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
98 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
99 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
100 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
101 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
102 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
103 pub fn create_phantom_invoice_with_description_hash<K: Deref, L: Deref>(
104 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
105 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
106 logger: L, network: Currency
107 ) -> Result<Invoice, SignOrCreationError<()>>
109 K::Target: KeysInterface,
112 _create_phantom_invoice::<K, L>(
113 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
114 invoice_expiry_delta_secs, phantom_route_hints, keys_manager, logger, network,
118 #[cfg(feature = "std")]
119 fn _create_phantom_invoice<K: Deref, L: Deref>(
120 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
121 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
122 logger: L, network: Currency,
123 ) -> Result<Invoice, SignOrCreationError<()>>
125 K::Target: KeysInterface,
128 use std::time::{SystemTime, UNIX_EPOCH};
130 if phantom_route_hints.len() == 0 {
131 return Err(SignOrCreationError::CreationError(
132 CreationError::MissingRouteHints,
136 let invoice = match description {
137 InvoiceDescription::Direct(description) => {
138 InvoiceBuilder::new(network).description(description.0.clone())
140 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
143 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
144 let keys = ExpandedKey::new(&keys_manager.get_inbound_payment_key_material());
145 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
146 let payment_secret = create_from_hash(
150 invoice_expiry_delta_secs,
152 .duration_since(UNIX_EPOCH)
153 .expect("Time must be > 1970")
156 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
157 (payment_hash, payment_secret)
162 invoice_expiry_delta_secs,
165 .duration_since(UNIX_EPOCH)
166 .expect("Time must be > 1970")
169 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
172 log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
173 phantom_route_hints.len(), log_bytes!(payment_hash.0));
175 let mut invoice = invoice
177 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
178 .payment_secret(payment_secret)
179 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
180 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
181 if let Some(amt) = amt_msat {
182 invoice = invoice.amount_milli_satoshis(amt);
185 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
186 log_trace!(logger, "Generating phantom route hints for node {}",
187 log_pubkey!(real_node_pubkey));
188 let mut route_hints = filter_channels(channels, amt_msat, &logger);
190 // If we have any public channel, the route hints from `filter_channels` will be empty.
191 // In that case we create a RouteHint on which we will push a single hop with the phantom
192 // route into the invoice, and let the sender find the path to the `real_node_pubkey`
193 // node by looking at our public channels.
194 if route_hints.is_empty() {
195 route_hints.push(RouteHint(vec![]))
197 for mut route_hint in route_hints {
198 route_hint.0.push(RouteHintHop {
199 src_node_id: real_node_pubkey,
200 short_channel_id: phantom_scid,
203 proportional_millionths: 0,
205 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
206 htlc_minimum_msat: None,
207 htlc_maximum_msat: None,});
208 invoice = invoice.private_route(route_hint.clone());
212 let raw_invoice = match invoice.build_raw() {
214 Err(e) => return Err(SignOrCreationError::CreationError(e))
216 let hrp_str = raw_invoice.hrp.to_string();
217 let hrp_bytes = hrp_str.as_bytes();
218 let data_without_signature = raw_invoice.data.to_base32();
219 let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
220 match signed_raw_invoice {
221 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
222 Err(e) => Err(SignOrCreationError::SignError(e))
226 #[cfg(feature = "std")]
227 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
228 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
229 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
230 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
231 /// that the payment secret is valid when the invoice is paid.
233 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
234 /// in excess of the current time.
235 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
236 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
237 network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32
238 ) -> Result<Invoice, SignOrCreationError<()>>
240 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
241 T::Target: BroadcasterInterface,
242 K::Target: KeysInterface,
243 F::Target: FeeEstimator,
247 use std::time::SystemTime;
248 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
249 .expect("for the foreseeable future this shouldn't happen");
250 create_invoice_from_channelmanager_and_duration_since_epoch(
251 channelmanager, keys_manager, logger, network, amt_msat, description, duration,
252 invoice_expiry_delta_secs
256 #[cfg(feature = "std")]
257 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
258 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
259 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
260 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
261 /// that the payment secret is valid when the invoice is paid.
262 /// Use this variant if you want to pass the `description_hash` to the invoice.
264 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
265 /// in excess of the current time.
266 pub fn create_invoice_from_channelmanager_with_description_hash<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
267 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
268 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
269 invoice_expiry_delta_secs: u32
270 ) -> Result<Invoice, SignOrCreationError<()>>
272 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
273 T::Target: BroadcasterInterface,
274 K::Target: KeysInterface,
275 F::Target: FeeEstimator,
279 use std::time::SystemTime;
281 let duration = SystemTime::now()
282 .duration_since(SystemTime::UNIX_EPOCH)
283 .expect("for the foreseeable future this shouldn't happen");
285 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
286 channelmanager, keys_manager, logger, network, amt_msat,
287 description_hash, duration, invoice_expiry_delta_secs
291 /// See [`create_invoice_from_channelmanager_with_description_hash`]
292 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
293 /// available and the current time is supplied by the caller.
294 pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
295 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
296 network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
297 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
298 ) -> Result<Invoice, SignOrCreationError<()>>
300 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
301 T::Target: BroadcasterInterface,
302 K::Target: KeysInterface,
303 F::Target: FeeEstimator,
307 _create_invoice_from_channelmanager_and_duration_since_epoch(
308 channelmanager, keys_manager, logger, network, amt_msat,
309 InvoiceDescription::Hash(&description_hash),
310 duration_since_epoch, invoice_expiry_delta_secs
314 /// See [`create_invoice_from_channelmanager`]
315 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
316 /// available and the current time is supplied by the caller.
317 pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
318 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
319 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
320 invoice_expiry_delta_secs: u32
321 ) -> Result<Invoice, SignOrCreationError<()>>
323 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
324 T::Target: BroadcasterInterface,
325 K::Target: KeysInterface,
326 F::Target: FeeEstimator,
330 _create_invoice_from_channelmanager_and_duration_since_epoch(
331 channelmanager, keys_manager, logger, network, amt_msat,
332 InvoiceDescription::Direct(
333 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
335 duration_since_epoch, invoice_expiry_delta_secs
339 fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
340 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
341 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
342 duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
343 ) -> Result<Invoice, SignOrCreationError<()>>
345 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
346 T::Target: BroadcasterInterface,
347 K::Target: KeysInterface,
348 F::Target: FeeEstimator,
352 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
354 let (payment_hash, payment_secret) = channelmanager
355 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs)
356 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
357 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
358 channelmanager, keys_manager, logger, network, amt_msat, description, duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret)
361 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
362 /// This version allows for providing a custom [`PaymentHash`] for the invoice.
363 /// This may be useful if you're building an on-chain swap or involving another protocol where
364 /// the payment hash is also involved outside the scope of lightning.
365 pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
366 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
367 network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
368 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash
369 ) -> Result<Invoice, SignOrCreationError<()>>
371 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
372 T::Target: BroadcasterInterface,
373 K::Target: KeysInterface,
374 F::Target: FeeEstimator,
378 let payment_secret = channelmanager
379 .create_inbound_payment_for_hash(payment_hash,amt_msat, invoice_expiry_delta_secs)
380 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
381 _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
382 channelmanager, keys_manager, logger, network, amt_msat,
383 InvoiceDescription::Direct(
384 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
386 duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret
390 fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>(
391 channelmanager: &ChannelManager<M, T, K, F, R, L>, keys_manager: K, logger: L,
392 network: Currency, amt_msat: Option<u64>, description: InvoiceDescription, duration_since_epoch: Duration,
393 invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, payment_secret: PaymentSecret
394 ) -> Result<Invoice, SignOrCreationError<()>>
396 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
397 T::Target: BroadcasterInterface,
398 K::Target: KeysInterface,
399 F::Target: FeeEstimator,
403 let our_node_pubkey = channelmanager.get_our_node_id();
404 let channels = channelmanager.list_channels();
406 log_trace!(logger, "Creating invoice with payment hash {}", log_bytes!(payment_hash.0));
408 let invoice = match description {
409 InvoiceDescription::Direct(description) => {
410 InvoiceBuilder::new(network).description(description.0.clone())
412 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
415 let mut invoice = invoice
416 .duration_since_epoch(duration_since_epoch)
417 .payee_pub_key(our_node_pubkey)
418 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
419 .payment_secret(payment_secret)
421 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
422 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
423 if let Some(amt) = amt_msat {
424 invoice = invoice.amount_milli_satoshis(amt);
427 let route_hints = filter_channels(channels, amt_msat, &logger);
428 for hint in route_hints {
429 invoice = invoice.private_route(hint);
432 let raw_invoice = match invoice.build_raw() {
434 Err(e) => return Err(SignOrCreationError::CreationError(e))
436 let hrp_str = raw_invoice.hrp.to_string();
437 let hrp_bytes = hrp_str.as_bytes();
438 let data_without_signature = raw_invoice.data.to_base32();
439 let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
440 match signed_raw_invoice {
441 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
442 Err(e) => Err(SignOrCreationError::SignError(e))
446 /// Filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
449 /// The filtering is based on the following criteria:
450 /// * Only one channel per counterparty node
451 /// * Always select the channel with the highest inbound capacity per counterparty node
452 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
453 /// `is_usable` (i.e. the peer is connected).
454 /// * If any public channel exists, the returned `RouteHint`s will be empty, and the sender will
455 /// need to find the path by looking at the public channels instead
456 fn filter_channels<L: Deref>(
457 channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>, logger: &L
458 ) -> Vec<RouteHint> where L::Target: Logger {
459 let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
460 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
461 let mut min_capacity_channel_exists = false;
462 let mut online_channel_exists = false;
463 let mut online_min_capacity_channel_exists = false;
465 log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
466 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
467 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
468 log_trace!(logger, "Ignoring channel {} for invoice route hints", log_bytes!(channel.channel_id));
472 if channel.is_public {
473 // If any public channel exists, return no hints and let the sender
474 // look at the public channels instead.
475 log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
476 log_bytes!(channel.channel_id));
480 if channel.inbound_capacity_msat >= min_inbound_capacity {
481 if !min_capacity_channel_exists {
482 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
483 min_capacity_channel_exists = true;
486 if channel.is_usable {
487 online_min_capacity_channel_exists = true;
491 if channel.is_usable {
492 if !online_channel_exists {
493 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
494 online_channel_exists = true;
498 match filtered_channels.entry(channel.counterparty.node_id) {
499 hash_map::Entry::Occupied(mut entry) => {
500 let current_max_capacity = entry.get().inbound_capacity_msat;
501 if channel.inbound_capacity_msat < current_max_capacity {
503 "Preferring counterparty {} channel {} ({} msats) over {} ({} msats) for invoice route hints",
504 log_pubkey!(channel.counterparty.node_id),
505 log_bytes!(entry.get().channel_id), current_max_capacity,
506 log_bytes!(channel.channel_id), channel.inbound_capacity_msat);
510 "Preferring counterparty {} channel {} ({} msats) over {} ({} msats) for invoice route hints",
511 log_pubkey!(channel.counterparty.node_id),
512 log_bytes!(channel.channel_id), channel.inbound_capacity_msat,
513 log_bytes!(entry.get().channel_id), current_max_capacity);
514 entry.insert(channel);
516 hash_map::Entry::Vacant(entry) => {
517 entry.insert(channel);
522 let route_hint_from_channel = |channel: ChannelDetails| {
523 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
524 RouteHint(vec![RouteHintHop {
525 src_node_id: channel.counterparty.node_id,
526 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
528 base_msat: forwarding_info.fee_base_msat,
529 proportional_millionths: forwarding_info.fee_proportional_millionths,
531 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
532 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
533 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
535 // If all channels are private, prefer to return route hints which have a higher capacity than
536 // the payment value and where we're currently connected to the channel counterparty.
537 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
538 // those which meet at least one criteria.
541 .map(|(_, channel)| channel)
543 let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
544 let include_channel = if online_min_capacity_channel_exists {
545 has_enough_capacity && channel.is_usable
546 } else if min_capacity_channel_exists && online_channel_exists {
547 // If there are some online channels and some min_capacity channels, but no
548 // online-and-min_capacity channels, just include the min capacity ones and ignore
551 } else if min_capacity_channel_exists {
553 } else if online_channel_exists {
558 log_trace!(logger, "Including channel {} in invoice route hints",
559 log_bytes!(channel.channel_id));
560 } else if !has_enough_capacity {
561 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
562 log_bytes!(channel.channel_id));
564 debug_assert!(!channel.is_usable);
565 log_trace!(logger, "Ignoring channel {} with disconnected peer",
566 log_bytes!(channel.channel_id));
571 .map(route_hint_from_channel)
572 .collect::<Vec<RouteHint>>()
575 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, R, L>
577 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
578 T::Target: BroadcasterInterface,
579 K::Target: KeysInterface,
580 F::Target: FeeEstimator,
584 fn node_id(&self) -> PublicKey {
585 self.get_our_node_id()
588 fn first_hops(&self) -> Vec<ChannelDetails> {
589 self.list_usable_channels()
593 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
594 payment_id: PaymentId
595 ) -> Result<(), PaymentSendFailure> {
596 self.send_payment(route, payment_hash, payment_secret, payment_id)
599 fn send_spontaneous_payment(
600 &self, route: &Route, payment_preimage: PaymentPreimage, payment_id: PaymentId,
601 ) -> Result<(), PaymentSendFailure> {
602 self.send_spontaneous_payment(route, Some(payment_preimage), payment_id).map(|_| ())
606 &self, route: &Route, payment_id: PaymentId
607 ) -> Result<(), PaymentSendFailure> {
608 self.retry_payment(route, payment_id)
611 fn abandon_payment(&self, payment_id: PaymentId) {
612 self.abandon_payment(payment_id)
615 fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
620 use core::time::Duration;
621 use crate::{Currency, Description, InvoiceDescription};
622 use bitcoin_hashes::{Hash, sha256};
623 use bitcoin_hashes::sha256::Hash as Sha256;
624 use lightning::chain::keysinterface::{EntropySource, PhantomKeysManager};
625 use lightning::ln::{PaymentPreimage, PaymentHash};
626 use lightning::ln::channelmanager::{self, PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY, PaymentId};
627 use lightning::ln::functional_test_utils::*;
628 use lightning::ln::msgs::ChannelMessageHandler;
629 use lightning::routing::router::{PaymentParameters, RouteParameters, find_route};
630 use lightning::util::events::{MessageSendEvent, MessageSendEventsProvider, Event};
631 use lightning::util::test_utils;
632 use lightning::util::config::UserConfig;
633 use lightning::chain::keysinterface::KeysInterface;
634 use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
635 use std::collections::HashSet;
638 fn test_from_channelmanager() {
639 let chanmon_cfgs = create_chanmon_cfgs(2);
640 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
641 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
642 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
643 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
644 let non_default_invoice_expiry_secs = 4200;
645 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
646 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
647 Some(10_000), "test".to_string(), Duration::from_secs(1234567),
648 non_default_invoice_expiry_secs).unwrap();
649 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
650 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
651 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
652 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
654 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
656 let chan = &nodes[1].node.list_usable_channels()[0];
657 assert_eq!(invoice.route_hints().len(), 1);
658 assert_eq!(invoice.route_hints()[0].0.len(), 1);
659 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
661 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
662 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
664 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
665 .with_features(invoice.features().unwrap().clone())
666 .with_route_hints(invoice.route_hints());
667 let route_params = RouteParameters {
669 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
670 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
672 let first_hops = nodes[0].node.list_usable_channels();
673 let network_graph = &node_cfgs[0].network_graph;
674 let logger = test_utils::TestLogger::new();
675 let scorer = test_utils::TestScorer::with_penalty(0);
676 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
677 let route = find_route(
678 &nodes[0].node.get_our_node_id(), &route_params, &network_graph,
679 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
682 let payment_event = {
683 let mut payment_hash = PaymentHash([0; 32]);
684 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
685 nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
686 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
687 assert_eq!(added_monitors.len(), 1);
688 added_monitors.clear();
690 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
691 assert_eq!(events.len(), 1);
692 SendEvent::from_event(events.remove(0))
695 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
696 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
697 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
698 assert_eq!(added_monitors.len(), 1);
699 added_monitors.clear();
700 let events = nodes[1].node.get_and_clear_pending_msg_events();
701 assert_eq!(events.len(), 2);
705 fn test_create_invoice_with_description_hash() {
706 let chanmon_cfgs = create_chanmon_cfgs(2);
707 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
708 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
709 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
710 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
711 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
712 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
713 Some(10_000), description_hash, Duration::from_secs(1234567), 3600
715 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
716 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
717 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
721 fn test_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash() {
722 let chanmon_cfgs = create_chanmon_cfgs(2);
723 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
724 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
725 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
726 let payment_hash = PaymentHash([0; 32]);
727 let invoice = crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
728 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
729 Some(10_000), "test".to_string(), Duration::from_secs(1234567), 3600,
732 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
733 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
734 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
735 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
739 fn test_hints_includes_single_channels_to_nodes() {
740 let chanmon_cfgs = create_chanmon_cfgs(3);
741 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
742 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
743 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
745 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
746 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
748 let mut scid_aliases = HashSet::new();
749 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
750 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
752 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
756 fn test_hints_has_only_highest_inbound_capacity_channel() {
757 let chanmon_cfgs = create_chanmon_cfgs(2);
758 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
759 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
760 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
761 let _chan_1_0_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
762 let chan_1_0_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
763 let _chan_1_0_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
764 let mut scid_aliases = HashSet::new();
765 scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap());
766 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
770 fn test_hints_has_only_online_channels() {
771 let chanmon_cfgs = create_chanmon_cfgs(4);
772 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
773 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
774 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
775 let chan_a = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
776 let chan_b = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
777 let _chan_c = create_unannounced_chan_between_nodes_with_value(&nodes, 3, 0, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
779 // With all peers connected we should get all hints that have sufficient value
780 let mut scid_aliases = HashSet::new();
781 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
782 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
784 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
786 // With only one sufficient-value peer connected we should only get its hint
787 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
788 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
789 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
791 // If we don't have any sufficient-value peers connected we should get all hints with
792 // sufficient value, even though there is a connected insufficient-value peer.
793 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
794 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
795 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
799 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
800 let chanmon_cfgs = create_chanmon_cfgs(3);
801 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
802 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
803 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
804 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
806 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
807 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
808 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
809 let mut private_chan_cfg = UserConfig::default();
810 private_chan_cfg.channel_handshake_config.announced_channel = false;
811 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();
812 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
813 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
814 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
815 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
817 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
819 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
820 confirm_transaction_at(&nodes[2], &tx, conf_height);
821 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
822 confirm_transaction_at(&nodes[0], &tx, conf_height);
823 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
824 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
825 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()));
826 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
827 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
828 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
829 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
830 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
832 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
833 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
834 // Therefore only `chan_1_0` should be included in the hints.
835 let mut scid_aliases = HashSet::new();
836 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
837 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
841 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
842 let chanmon_cfgs = create_chanmon_cfgs(3);
843 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
844 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
845 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
846 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
848 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
849 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
850 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
852 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
853 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
854 // public channel between `nodes[2]` and `nodes[0]`
855 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
859 fn test_only_public_channels_includes_no_channels_in_hints() {
860 let chanmon_cfgs = create_chanmon_cfgs(3);
861 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
862 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
863 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
864 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
865 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
866 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
868 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
869 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
870 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
872 // As all of `nodes[0]` channels are public, no channels should be included in the hints
873 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
877 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
878 let chanmon_cfgs = create_chanmon_cfgs(3);
879 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
880 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
881 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
882 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
883 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
885 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
886 let mut scid_aliases_99_000_001_msat = HashSet::new();
887 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
889 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
891 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
892 let mut scid_aliases_99_000_000_msat = HashSet::new();
893 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
894 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
896 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
898 // As the invoice amt is above all channels' inbound capacity, they will still be included
899 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
900 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
901 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
903 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
905 // An invoice with no specified amount should include all channels in the route hints.
906 let mut scid_aliases_no_specified_amount = HashSet::new();
907 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
908 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
910 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
913 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
914 invoice_amt: Option<u64>,
915 invoice_node: &Node<'a, 'b, 'c>,
916 mut chan_ids_to_match: HashSet<u64>
918 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
919 &invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
920 Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
922 let hints = invoice.private_routes();
925 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
926 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
928 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
932 #[cfg(feature = "std")]
933 fn test_multi_node_receive() {
934 do_test_multi_node_receive(true);
935 do_test_multi_node_receive(false);
938 #[cfg(feature = "std")]
939 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
940 let mut chanmon_cfgs = create_chanmon_cfgs(3);
941 let seed_1 = [42 as u8; 32];
942 let seed_2 = [43 as u8; 32];
943 let cross_node_seed = [44 as u8; 32];
944 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
945 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
946 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
947 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
948 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
949 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
950 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
951 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
952 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
953 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
954 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
956 let payment_amt = 10_000;
957 let route_hints = vec![
958 nodes[1].node.get_phantom_route_hints(),
959 nodes[2].node.get_phantom_route_hints(),
962 let user_payment_preimage = PaymentPreimage([1; 32]);
963 let payment_hash = if user_generated_pmt_hash {
964 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
968 let non_default_invoice_expiry_secs = 4200;
971 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(
972 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
973 route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
975 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
976 let payment_preimage = if user_generated_pmt_hash {
977 user_payment_preimage
979 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
982 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
983 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
984 assert_eq!(invoice.route_hints().len(), 2);
985 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
986 assert!(!invoice.features().unwrap().supports_basic_mpp());
988 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
989 .with_features(invoice.features().unwrap().clone())
990 .with_route_hints(invoice.route_hints());
991 let params = RouteParameters {
993 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
994 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
996 let first_hops = nodes[0].node.list_usable_channels();
997 let network_graph = &node_cfgs[0].network_graph;
998 let logger = test_utils::TestLogger::new();
999 let scorer = test_utils::TestScorer::with_penalty(0);
1000 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
1001 let route = find_route(
1002 &nodes[0].node.get_our_node_id(), ¶ms, &network_graph,
1003 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
1005 let (payment_event, fwd_idx) = {
1006 let mut payment_hash = PaymentHash([0; 32]);
1007 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1008 nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
1009 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1010 assert_eq!(added_monitors.len(), 1);
1011 added_monitors.clear();
1013 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1014 assert_eq!(events.len(), 1);
1015 let fwd_idx = match events[0] {
1016 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1017 if node_id == nodes[1].node.get_our_node_id() {
1021 _ => panic!("Unexpected event")
1023 (SendEvent::from_event(events.remove(0)), fwd_idx)
1025 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1026 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1028 // Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
1029 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1030 // payments "look real" by taking more time.
1031 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1032 nodes[fwd_idx].node.process_pending_htlc_forwards();
1033 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1034 nodes[fwd_idx].node.process_pending_htlc_forwards();
1036 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1037 expect_payment_claimable!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt, route.paths[0].last().unwrap().pubkey);
1038 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage);
1039 let events = nodes[0].node.get_and_clear_pending_events();
1040 assert_eq!(events.len(), 2);
1042 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1043 assert_eq!(payment_preimage, *ev_preimage);
1044 assert_eq!(payment_hash, *ev_hash);
1045 assert_eq!(fee_paid_msat, &Some(0));
1047 _ => panic!("Unexpected event")
1050 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1051 assert_eq!(hash, Some(payment_hash));
1053 _ => panic!("Unexpected event")
1058 #[cfg(feature = "std")]
1059 fn test_multi_node_hints_has_htlc_min_max_values() {
1060 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1061 let seed_1 = [42 as u8; 32];
1062 let seed_2 = [43 as u8; 32];
1063 let cross_node_seed = [44 as u8; 32];
1064 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1065 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1066 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1067 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1068 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1070 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1071 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1073 let payment_amt = 20_000;
1074 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap();
1075 let route_hints = vec![
1076 nodes[1].node.get_phantom_route_hints(),
1077 nodes[2].node.get_phantom_route_hints(),
1080 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash), "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet).unwrap();
1082 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1083 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1084 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1086 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1087 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1088 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1092 #[cfg(feature = "std")]
1093 fn create_phantom_invoice_with_description_hash() {
1094 let chanmon_cfgs = create_chanmon_cfgs(3);
1095 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1096 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1097 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1099 let payment_amt = 20_000;
1100 let route_hints = vec![
1101 nodes[1].node.get_phantom_route_hints(),
1102 nodes[2].node.get_phantom_route_hints(),
1105 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1106 let non_default_invoice_expiry_secs = 4200;
1107 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1108 &test_utils::TestKeysInterface, &test_utils::TestLogger,
1110 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1111 route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
1114 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1115 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1116 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1117 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1121 #[cfg(feature = "std")]
1122 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1123 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1124 let seed_1 = [42 as u8; 32];
1125 let seed_2 = [43 as u8; 32];
1126 let cross_node_seed = [44 as u8; 32];
1127 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1128 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1129 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1130 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1131 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1133 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1134 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1136 let mut scid_aliases = HashSet::new();
1137 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1138 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1140 match_multi_node_invoice_routes(
1143 vec![&nodes[1], &nodes[2],],
1150 #[cfg(feature = "std")]
1151 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1152 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1153 let seed_1 = [42 as u8; 32];
1154 let seed_2 = [43 as u8; 32];
1155 let cross_node_seed = [44 as u8; 32];
1156 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1157 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1158 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1159 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1160 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1162 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1163 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1164 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1166 let mut scid_aliases = HashSet::new();
1167 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1168 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1169 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1171 match_multi_node_invoice_routes(
1174 vec![&nodes[2], &nodes[3],],
1181 #[cfg(feature = "std")]
1182 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1183 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1184 let seed_1 = [42 as u8; 32];
1185 let seed_2 = [43 as u8; 32];
1186 let cross_node_seed = [44 as u8; 32];
1187 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1188 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1189 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1190 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1191 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1193 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1194 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1196 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1197 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1198 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1199 let mut private_chan_cfg = UserConfig::default();
1200 private_chan_cfg.channel_handshake_config.announced_channel = false;
1201 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();
1202 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1203 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
1204 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1205 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
1207 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1209 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1210 confirm_transaction_at(&nodes[1], &tx, conf_height);
1211 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1212 confirm_transaction_at(&nodes[3], &tx, conf_height);
1213 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1214 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1215 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()));
1216 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1217 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1218 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1219 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1220 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1222 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1223 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1224 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1225 let mut scid_aliases = HashSet::new();
1226 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1227 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1229 match_multi_node_invoice_routes(
1232 vec![&nodes[2], &nodes[3],],
1239 #[cfg(feature = "std")]
1240 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1241 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1242 let seed_1 = [42 as u8; 32];
1243 let seed_2 = [43 as u8; 32];
1244 let cross_node_seed = [44 as u8; 32];
1245 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1246 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1247 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1248 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1249 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1251 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1253 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1254 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1255 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1257 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1258 // `chan_0_2` as `nodes[2]` only has public channels.
1259 let mut scid_aliases = HashSet::new();
1260 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1262 match_multi_node_invoice_routes(
1265 vec![&nodes[1], &nodes[2],],
1272 #[cfg(feature = "std")]
1273 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1274 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1275 let seed_1 = [42 as u8; 32];
1276 let seed_2 = [43 as u8; 32];
1277 let cross_node_seed = [44 as u8; 32];
1278 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1279 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1280 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1281 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1282 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1284 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1285 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1286 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1287 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1289 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1291 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1292 // channels for `nodes[2]` as it contains a mix of public and private channels.
1293 let mut scid_aliases = HashSet::new();
1294 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1296 match_multi_node_invoice_routes(
1299 vec![&nodes[2], &nodes[3],],
1306 #[cfg(feature = "std")]
1307 fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() {
1308 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1309 let seed_1 = [42 as u8; 32];
1310 let seed_2 = [43 as u8; 32];
1311 let cross_node_seed = [44 as u8; 32];
1312 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1313 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1314 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1315 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1316 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1318 let _chan_0_1_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1319 let chan_0_1_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1320 let _chan_0_1_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1321 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1323 let mut scid_aliases = HashSet::new();
1324 scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap());
1325 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1327 match_multi_node_invoice_routes(
1330 vec![&nodes[1], &nodes[2],],
1337 #[cfg(feature = "std")]
1338 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1339 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1340 let seed_1 = [42 as u8; 32];
1341 let seed_2 = [43 as u8; 32];
1342 let cross_node_seed = [44 as u8; 32];
1343 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1344 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1345 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1346 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1347 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1349 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1350 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1351 let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1353 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1354 let mut scid_aliases_99_000_001_msat = HashSet::new();
1355 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1356 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1358 match_multi_node_invoice_routes(
1361 vec![&nodes[2], &nodes[3],],
1362 scid_aliases_99_000_001_msat,
1366 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1367 let mut scid_aliases_99_000_000_msat = HashSet::new();
1368 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1369 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1370 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1372 match_multi_node_invoice_routes(
1375 vec![&nodes[2], &nodes[3],],
1376 scid_aliases_99_000_000_msat,
1380 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1381 // `nodes[2]` them should be included.
1382 let mut scid_aliases_300_000_000_msat = HashSet::new();
1383 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1384 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1385 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1387 match_multi_node_invoice_routes(
1390 vec![&nodes[2], &nodes[3],],
1391 scid_aliases_300_000_000_msat,
1395 // Since the no specified amount, all channels should included.
1396 let mut scid_aliases_no_specified_amount = HashSet::new();
1397 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1398 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1399 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1401 match_multi_node_invoice_routes(
1404 vec![&nodes[2], &nodes[3],],
1405 scid_aliases_no_specified_amount,
1410 #[cfg(feature = "std")]
1411 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1412 invoice_amt: Option<u64>,
1413 invoice_node: &Node<'a, 'b, 'c>,
1414 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1415 mut chan_ids_to_match: HashSet<u64>,
1416 nodes_contains_public_channels: bool
1418 let phantom_route_hints = network_multi_nodes.iter()
1419 .map(|node| node.node.get_phantom_route_hints())
1420 .collect::<Vec<PhantomRouteHints>>();
1421 let phantom_scids = phantom_route_hints.iter()
1422 .map(|route_hint| route_hint.phantom_scid)
1423 .collect::<HashSet<u64>>();
1425 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(), 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.logger, Currency::BitcoinTestnet).unwrap();
1427 let invoice_hints = invoice.private_routes();
1429 for hint in invoice_hints {
1430 let hints = &(hint.0).0;
1433 assert!(nodes_contains_public_channels);
1434 let phantom_scid = hints[0].short_channel_id;
1435 assert!(phantom_scids.contains(&phantom_scid));
1438 let hint_short_chan_id = hints[0].short_channel_id;
1439 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1440 let phantom_scid = hints[1].short_channel_id;
1441 assert!(phantom_scids.contains(&phantom_scid));
1443 _ => panic!("Incorrect hint length generated")
1446 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);