]> git.bitcoin.ninja Git - rust-lightning/blob - lightning-invoice/src/utils.rs
cf397ee5c36a290cd420ff016c6627c42664d936
[rust-lightning] / lightning-invoice / src / utils.rs
1 //! Convenient utilities to create an invoice.
2
3 use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
4 use crate::payment::{InFlightHtlcs, Payer, Router};
5
6 use crate::{prelude::*, Description, InvoiceDescription, Sha256};
7 use bech32::ToBase32;
8 use bitcoin_hashes::{Hash, sha256};
9 use lightning::chain;
10 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
11 use lightning::chain::keysinterface::{Recipient, KeysInterface, Sign};
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::ln::msgs::LightningError;
18 use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
19 use lightning::routing::router::{Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop};
20 use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
21 use lightning::util::logger::Logger;
22 use secp256k1::PublicKey;
23 use core::ops::Deref;
24 use core::time::Duration;
25 use crate::sync::Mutex;
26
27 #[cfg(feature = "std")]
28 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
29 /// See [`PhantomKeysManager`] for more information on phantom node payments.
30 ///
31 /// `phantom_route_hints` parameter:
32 /// * Contains channel info for all nodes participating in the phantom invoice
33 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
34 ///   participating node
35 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
36 ///   updated when a channel becomes disabled or closes
37 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
38 ///   may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
39 ///   down
40 ///
41 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
42 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
43 /// If `None` is provided for `payment_hash`, then one will be created.
44 ///
45 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
46 /// in excess of the current time.
47 ///
48 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
49 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
50 /// requirement).
51 ///
52 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
53 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
54 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
55 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
56 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
57 pub fn create_phantom_invoice<Signer: Sign, K: Deref, L: Deref>(
58         amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
59         invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
60         logger: L, network: Currency,
61 ) -> Result<Invoice, SignOrCreationError<()>>
62 where
63         K::Target: KeysInterface,
64         L::Target: Logger,
65 {
66         let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
67         let description = InvoiceDescription::Direct(&description,);
68         _create_phantom_invoice::<Signer, K, L>(
69                 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
70                 keys_manager, logger, network,
71         )
72 }
73
74 #[cfg(feature = "std")]
75 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
76 /// See [`PhantomKeysManager`] for more information on phantom node payments.
77 ///
78 /// `phantom_route_hints` parameter:
79 /// * Contains channel info for all nodes participating in the phantom invoice
80 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
81 ///   participating node
82 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
83 ///   updated when a channel becomes disabled or closes
84 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
85 ///   may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
86 ///   down
87 ///
88 /// `description_hash` is a SHA-256 hash of the description text
89 ///
90 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
91 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
92 /// If `None` is provided for `payment_hash`, then one will be created.
93 ///
94 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
95 /// in excess of the current time.
96 ///
97 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
98 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
99 /// requirement).
100 ///
101 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
102 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
103 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
104 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
105 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
106 pub fn create_phantom_invoice_with_description_hash<Signer: Sign, K: Deref, L: Deref>(
107         amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
108         description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
109         logger: L, network: Currency
110 ) -> Result<Invoice, SignOrCreationError<()>>
111 where
112         K::Target: KeysInterface,
113         L::Target: Logger,
114 {
115         _create_phantom_invoice::<Signer, K, L>(
116                 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
117                 invoice_expiry_delta_secs, phantom_route_hints, keys_manager, logger, network,
118         )
119 }
120
121 #[cfg(feature = "std")]
122 fn _create_phantom_invoice<Signer: Sign, K: Deref, L: Deref>(
123         amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
124         invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K,
125         logger: L, network: Currency,
126 ) -> Result<Invoice, SignOrCreationError<()>>
127 where
128         K::Target: KeysInterface,
129         L::Target: Logger,
130 {
131         use std::time::{SystemTime, UNIX_EPOCH};
132
133         if phantom_route_hints.len() == 0 {
134                 return Err(SignOrCreationError::CreationError(
135                         CreationError::MissingRouteHints,
136                 ));
137         }
138
139         let invoice = match description {
140                 InvoiceDescription::Direct(description) => {
141                         InvoiceBuilder::new(network).description(description.0.clone())
142                 }
143                 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
144         };
145
146         // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
147         let keys = ExpandedKey::new(&keys_manager.get_inbound_payment_key_material());
148         let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
149                 let payment_secret = create_from_hash(
150                         &keys,
151                         amt_msat,
152                         payment_hash,
153                         invoice_expiry_delta_secs,
154                         SystemTime::now()
155                                 .duration_since(UNIX_EPOCH)
156                                 .expect("Time must be > 1970")
157                                 .as_secs(),
158                 )
159                 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
160                 (payment_hash, payment_secret)
161         } else {
162                 create(
163                         &keys,
164                         amt_msat,
165                         invoice_expiry_delta_secs,
166                         &keys_manager,
167                         SystemTime::now()
168                                 .duration_since(UNIX_EPOCH)
169                                 .expect("Time must be > 1970")
170                                 .as_secs(),
171                 )
172                 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
173         };
174
175         log_trace!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
176                 phantom_route_hints.len(), log_bytes!(payment_hash.0));
177
178         let mut invoice = invoice
179                 .current_timestamp()
180                 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
181                 .payment_secret(payment_secret)
182                 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
183                 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
184         if let Some(amt) = amt_msat {
185                 invoice = invoice.amount_milli_satoshis(amt);
186         }
187
188         for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
189                 log_trace!(logger, "Generating phantom route hints for node {}",
190                         log_pubkey!(real_node_pubkey));
191                 let mut route_hints = filter_channels(channels, amt_msat, &logger);
192
193                 // If we have any public channel, the route hints from `filter_channels` will be empty.
194                 // In that case we create a RouteHint on which we will push a single hop with the phantom
195                 // route into the invoice, and let the sender find the path to the `real_node_pubkey`
196                 // node by looking at our public channels.
197                 if route_hints.is_empty() {
198                         route_hints.push(RouteHint(vec![]))
199                 }
200                 for mut route_hint in route_hints {
201                         route_hint.0.push(RouteHintHop {
202                                 src_node_id: real_node_pubkey,
203                                 short_channel_id: phantom_scid,
204                                 fees: RoutingFees {
205                                         base_msat: 0,
206                                         proportional_millionths: 0,
207                                 },
208                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
209                                 htlc_minimum_msat: None,
210                                 htlc_maximum_msat: None,});
211                         invoice = invoice.private_route(route_hint.clone());
212                 }
213         }
214
215         let raw_invoice = match invoice.build_raw() {
216                 Ok(inv) => inv,
217                 Err(e) => return Err(SignOrCreationError::CreationError(e))
218         };
219         let hrp_str = raw_invoice.hrp.to_string();
220         let hrp_bytes = hrp_str.as_bytes();
221         let data_without_signature = raw_invoice.data.to_base32();
222         let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
223         match signed_raw_invoice {
224                 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
225                 Err(e) => Err(SignOrCreationError::SignError(e))
226         }
227 }
228
229 #[cfg(feature = "std")]
230 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
231 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
232 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
233 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
234 /// that the payment secret is valid when the invoice is paid.
235 ///
236 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
237 /// in excess of the current time.
238 pub fn create_invoice_from_channelmanager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
239         channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, logger: L,
240         network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32
241 ) -> Result<Invoice, SignOrCreationError<()>>
242 where
243         M::Target: chain::Watch<Signer>,
244         T::Target: BroadcasterInterface,
245         K::Target: KeysInterface<Signer = Signer>,
246         F::Target: FeeEstimator,
247         L::Target: Logger,
248 {
249         use std::time::SystemTime;
250         let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
251                 .expect("for the foreseeable future this shouldn't happen");
252         create_invoice_from_channelmanager_and_duration_since_epoch(
253                 channelmanager, keys_manager, logger, network, amt_msat, description, duration,
254                 invoice_expiry_delta_secs
255         )
256 }
257
258 #[cfg(feature = "std")]
259 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
260 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
261 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
262 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
263 /// that the payment secret is valid when the invoice is paid.
264 /// Use this variant if you want to pass the `description_hash` to the invoice.
265 ///
266 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
267 /// in excess of the current time.
268 pub fn create_invoice_from_channelmanager_with_description_hash<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
269         channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, logger: L,
270         network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
271         invoice_expiry_delta_secs: u32
272 ) -> Result<Invoice, SignOrCreationError<()>>
273 where
274         M::Target: chain::Watch<Signer>,
275         T::Target: BroadcasterInterface,
276         K::Target: KeysInterface<Signer = Signer>,
277         F::Target: FeeEstimator,
278         L::Target: Logger,
279 {
280         use std::time::SystemTime;
281
282         let duration = SystemTime::now()
283                 .duration_since(SystemTime::UNIX_EPOCH)
284                 .expect("for the foreseeable future this shouldn't happen");
285
286         create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
287                 channelmanager, keys_manager, logger, network, amt_msat,
288                 description_hash, duration, invoice_expiry_delta_secs
289         )
290 }
291
292 /// See [`create_invoice_from_channelmanager_with_description_hash`]
293 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
294 /// available and the current time is supplied by the caller.
295 pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
296         channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, logger: L,
297         network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
298         duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
299 ) -> Result<Invoice, SignOrCreationError<()>>
300 where
301         M::Target: chain::Watch<Signer>,
302         T::Target: BroadcasterInterface,
303         K::Target: KeysInterface<Signer = Signer>,
304         F::Target: FeeEstimator,
305         L::Target: Logger,
306 {
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
311         )
312 }
313
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<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
318         channelmanager: &ChannelManager<Signer, M, T, K, F, 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<()>>
322 where
323         M::Target: chain::Watch<Signer>,
324         T::Target: BroadcasterInterface,
325         K::Target: KeysInterface<Signer = Signer>,
326         F::Target: FeeEstimator,
327         L::Target: Logger,
328 {
329         _create_invoice_from_channelmanager_and_duration_since_epoch(
330                 channelmanager, keys_manager, logger, network, amt_msat,
331                 InvoiceDescription::Direct(
332                         &Description::new(description).map_err(SignOrCreationError::CreationError)?,
333                 ),
334                 duration_since_epoch, invoice_expiry_delta_secs
335         )
336 }
337
338 fn _create_invoice_from_channelmanager_and_duration_since_epoch<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
339         channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, logger: L,
340         network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
341         duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
342 ) -> Result<Invoice, SignOrCreationError<()>>
343 where
344         M::Target: chain::Watch<Signer>,
345         T::Target: BroadcasterInterface,
346         K::Target: KeysInterface<Signer = Signer>,
347         F::Target: FeeEstimator,
348         L::Target: Logger,
349 {
350         // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
351         // supply.
352         let (payment_hash, payment_secret) = channelmanager
353                 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs)
354                 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
355         let our_node_pubkey = channelmanager.get_our_node_id();
356         let channels = channelmanager.list_channels();
357
358         log_trace!(logger, "Creating invoice with payment hash {}", log_bytes!(payment_hash.0));
359
360         let invoice = match description {
361                 InvoiceDescription::Direct(description) => {
362                         InvoiceBuilder::new(network).description(description.0.clone())
363                 }
364                 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
365         };
366
367         let mut invoice = invoice
368                 .duration_since_epoch(duration_since_epoch)
369                 .payee_pub_key(our_node_pubkey)
370                 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
371                 .payment_secret(payment_secret)
372                 .basic_mpp()
373                 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
374                 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
375         if let Some(amt) = amt_msat {
376                 invoice = invoice.amount_milli_satoshis(amt);
377         }
378
379         let route_hints = filter_channels(channels, amt_msat, &logger);
380         for hint in route_hints {
381                 invoice = invoice.private_route(hint);
382         }
383
384         let raw_invoice = match invoice.build_raw() {
385                 Ok(inv) => inv,
386                 Err(e) => return Err(SignOrCreationError::CreationError(e))
387         };
388         let hrp_str = raw_invoice.hrp.to_string();
389         let hrp_bytes = hrp_str.as_bytes();
390         let data_without_signature = raw_invoice.data.to_base32();
391         let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
392         match signed_raw_invoice {
393                 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
394                 Err(e) => Err(SignOrCreationError::SignError(e))
395         }
396 }
397
398 /// Filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
399 /// in the invoice.
400 ///
401 /// The filtering is based on the following criteria:
402 /// * Only one channel per counterparty node
403 /// * Always select the channel with the highest inbound capacity per counterparty node
404 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
405 ///   `is_usable` (i.e. the peer is connected).
406 /// * If any public channel exists, the returned `RouteHint`s will be empty, and the sender will
407 ///   need to find the path by looking at the public channels instead
408 fn filter_channels<L: Deref>(
409         channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>, logger: &L
410 ) -> Vec<RouteHint> where L::Target: Logger {
411         let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
412         let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
413         let mut min_capacity_channel_exists = false;
414         let mut online_channel_exists = false;
415         let mut online_min_capacity_channel_exists = false;
416
417         log_trace!(logger, "Considering {} channels for invoice route hints", channels.len());
418         for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
419                 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
420                         log_trace!(logger, "Ignoring channel {} for invoice route hints", log_bytes!(channel.channel_id));
421                         continue;
422                 }
423
424                 if channel.is_public {
425                         // If any public channel exists, return no hints and let the sender
426                         // look at the public channels instead.
427                         log_trace!(logger, "Not including channels in invoice route hints on account of public channel {}",
428                                 log_bytes!(channel.channel_id));
429                         return vec![]
430                 }
431
432                 if channel.inbound_capacity_msat >= min_inbound_capacity {
433                         if !min_capacity_channel_exists {
434                                 log_trace!(logger, "Channel with enough inbound capacity exists for invoice route hints");
435                                 min_capacity_channel_exists = true;
436                         }
437
438                         if channel.is_usable {
439                                 online_min_capacity_channel_exists = true;
440                         }
441                 }
442
443                 if channel.is_usable {
444                         if !online_channel_exists {
445                                 log_trace!(logger, "Channel with connected peer exists for invoice route hints");
446                                 online_channel_exists = true;
447                         }
448                 }
449
450                 match filtered_channels.entry(channel.counterparty.node_id) {
451                         hash_map::Entry::Occupied(mut entry) => {
452                                 let current_max_capacity = entry.get().inbound_capacity_msat;
453                                 if channel.inbound_capacity_msat < current_max_capacity {
454                                         log_trace!(logger,
455                                                 "Preferring counterparty {} channel {} ({} msats) over {} ({} msats) for invoice route hints",
456                                                 log_pubkey!(channel.counterparty.node_id),
457                                                 log_bytes!(entry.get().channel_id), current_max_capacity,
458                                                 log_bytes!(channel.channel_id), channel.inbound_capacity_msat);
459                                         continue;
460                                 }
461                                 log_trace!(logger,
462                                         "Preferring counterparty {} channel {} ({} msats) over {} ({} msats) for invoice route hints",
463                                         log_pubkey!(channel.counterparty.node_id),
464                                         log_bytes!(channel.channel_id), channel.inbound_capacity_msat,
465                                         log_bytes!(entry.get().channel_id), current_max_capacity);
466                                 entry.insert(channel);
467                         }
468                         hash_map::Entry::Vacant(entry) => {
469                                 entry.insert(channel);
470                         }
471                 }
472         }
473
474         let route_hint_from_channel = |channel: ChannelDetails| {
475                 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
476                 RouteHint(vec![RouteHintHop {
477                         src_node_id: channel.counterparty.node_id,
478                         short_channel_id: channel.get_inbound_payment_scid().unwrap(),
479                         fees: RoutingFees {
480                                 base_msat: forwarding_info.fee_base_msat,
481                                 proportional_millionths: forwarding_info.fee_proportional_millionths,
482                         },
483                         cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
484                         htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
485                         htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
486         };
487         // If all channels are private, prefer to return route hints which have a higher capacity than
488         // the payment value and where we're currently connected to the channel counterparty.
489         // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
490         // those which meet at least one criteria.
491         filtered_channels
492                 .into_iter()
493                 .map(|(_, channel)| channel)
494                 .filter(|channel| {
495                         let has_enough_capacity = channel.inbound_capacity_msat >= min_inbound_capacity;
496                         let include_channel = if online_min_capacity_channel_exists {
497                                 has_enough_capacity && channel.is_usable
498                         } else if min_capacity_channel_exists && online_channel_exists {
499                                 // If there are some online channels and some min_capacity channels, but no
500                                 // online-and-min_capacity channels, just include the min capacity ones and ignore
501                                 // online-ness.
502                                 has_enough_capacity
503                         } else if min_capacity_channel_exists {
504                                 has_enough_capacity
505                         } else if online_channel_exists {
506                                 channel.is_usable
507                         } else { true };
508
509                         if include_channel {
510                                 log_trace!(logger, "Including channel {} in invoice route hints",
511                                         log_bytes!(channel.channel_id));
512                         } else if !has_enough_capacity {
513                                 log_trace!(logger, "Ignoring channel {} without enough capacity for invoice route hints",
514                                         log_bytes!(channel.channel_id));
515                         } else {
516                                 debug_assert!(!channel.is_usable);
517                                 log_trace!(logger, "Ignoring channel {} with disconnected peer",
518                                         log_bytes!(channel.channel_id));
519                         }
520
521                         include_channel
522                 })
523                 .map(route_hint_from_channel)
524                 .collect::<Vec<RouteHint>>()
525 }
526
527 /// A [`Router`] implemented using [`find_route`].
528 pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
529         L::Target: Logger,
530         S::Target: for <'a> LockableScore<'a>,
531 {
532         network_graph: G,
533         logger: L,
534         random_seed_bytes: Mutex<[u8; 32]>,
535         scorer: S
536 }
537
538 impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
539         L::Target: Logger,
540         S::Target: for <'a> LockableScore<'a>,
541 {
542         /// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
543         /// `random_seed_bytes`.
544         pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
545                 let random_seed_bytes = Mutex::new(random_seed_bytes);
546                 Self { network_graph, logger, random_seed_bytes, scorer }
547         }
548 }
549
550 impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
551         L::Target: Logger,
552         S::Target: for <'a> LockableScore<'a>,
553 {
554         fn find_route(
555                 &self, payer: &PublicKey, params: &RouteParameters, _payment_hash: &PaymentHash,
556                 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
557         ) -> Result<Route, LightningError> {
558                 let random_seed_bytes = {
559                         let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
560                         *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
561                         *locked_random_seed_bytes
562                 };
563
564                 find_route(
565                         payer, params, &self.network_graph, first_hops, &*self.logger,
566                         &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
567                         &random_seed_bytes
568                 )
569         }
570
571         fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
572                 self.scorer.lock().payment_path_failed(path, short_channel_id);
573         }
574
575         fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
576                 self.scorer.lock().payment_path_successful(path);
577         }
578
579         fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
580                 self.scorer.lock().probe_successful(path);
581         }
582
583         fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
584                 self.scorer.lock().probe_failed(path, short_channel_id);
585         }
586 }
587
588 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<Signer, M, T, K, F, L>
589 where
590         M::Target: chain::Watch<Signer>,
591         T::Target: BroadcasterInterface,
592         K::Target: KeysInterface<Signer = Signer>,
593         F::Target: FeeEstimator,
594         L::Target: Logger,
595 {
596         fn node_id(&self) -> PublicKey {
597                 self.get_our_node_id()
598         }
599
600         fn first_hops(&self) -> Vec<ChannelDetails> {
601                 self.list_usable_channels()
602         }
603
604         fn send_payment(
605                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
606                 payment_id: PaymentId
607         ) -> Result<(), PaymentSendFailure> {
608                 self.send_payment(route, payment_hash, payment_secret, payment_id)
609         }
610
611         fn send_spontaneous_payment(
612                 &self, route: &Route, payment_preimage: PaymentPreimage, payment_id: PaymentId,
613         ) -> Result<(), PaymentSendFailure> {
614                 self.send_spontaneous_payment(route, Some(payment_preimage), payment_id).map(|_| ())
615         }
616
617         fn retry_payment(
618                 &self, route: &Route, payment_id: PaymentId
619         ) -> Result<(), PaymentSendFailure> {
620                 self.retry_payment(route, payment_id)
621         }
622
623         fn abandon_payment(&self, payment_id: PaymentId) {
624                 self.abandon_payment(payment_id)
625         }
626 }
627
628
629 /// Used to store information about all the HTLCs that are inflight across all payment attempts.
630 pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
631         scorer: &'a mut S,
632         /// Maps a channel's short channel id and its direction to the liquidity used up.
633         inflight_htlcs: InFlightHtlcs,
634 }
635
636 impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
637         pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
638                 ScorerAccountingForInFlightHtlcs {
639                         scorer,
640                         inflight_htlcs
641                 }
642         }
643 }
644
645 #[cfg(c_bindings)]
646 impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
647         fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
648 }
649
650 impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
651         fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
652                 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
653                         source, target, short_channel_id
654                 ) {
655                         let usage = ChannelUsage {
656                                 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
657                                 ..usage
658                         };
659
660                         self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
661                 } else {
662                         self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
663                 }
664         }
665
666         fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
667
668         fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
669
670         fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
671
672         fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
673 }
674
675
676 #[cfg(test)]
677 mod test {
678         use core::time::Duration;
679         use crate::{Currency, Description, InvoiceDescription};
680         use bitcoin_hashes::Hash;
681         use bitcoin_hashes::sha256::Hash as Sha256;
682         use lightning::chain::keysinterface::PhantomKeysManager;
683         use lightning::ln::{PaymentPreimage, PaymentHash};
684         use lightning::ln::channelmanager::{self, PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY, PaymentId};
685         use lightning::ln::functional_test_utils::*;
686         use lightning::ln::msgs::ChannelMessageHandler;
687         use lightning::routing::router::{PaymentParameters, RouteParameters, find_route};
688         use lightning::util::enforcing_trait_impls::EnforcingSigner;
689         use lightning::util::events::{MessageSendEvent, MessageSendEventsProvider, Event};
690         use lightning::util::test_utils;
691         use lightning::util::config::UserConfig;
692         use lightning::chain::keysinterface::KeysInterface;
693         use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
694         use std::collections::HashSet;
695
696         #[test]
697         fn test_from_channelmanager() {
698                 let chanmon_cfgs = create_chanmon_cfgs(2);
699                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
700                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
701                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
702                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
703                 let non_default_invoice_expiry_secs = 4200;
704                 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
705                         &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
706                         Some(10_000), "test".to_string(), Duration::from_secs(1234567),
707                         non_default_invoice_expiry_secs).unwrap();
708                 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
709                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
710                 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
711                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
712
713                 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
714                 // available.
715                 let chan = &nodes[1].node.list_usable_channels()[0];
716                 assert_eq!(invoice.route_hints().len(), 1);
717                 assert_eq!(invoice.route_hints()[0].0.len(), 1);
718                 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
719
720                 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
721                 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
722
723                 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
724                         .with_features(invoice.features().unwrap().clone())
725                         .with_route_hints(invoice.route_hints());
726                 let route_params = RouteParameters {
727                         payment_params,
728                         final_value_msat: invoice.amount_milli_satoshis().unwrap(),
729                         final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
730                 };
731                 let first_hops = nodes[0].node.list_usable_channels();
732                 let network_graph = &node_cfgs[0].network_graph;
733                 let logger = test_utils::TestLogger::new();
734                 let scorer = test_utils::TestScorer::with_penalty(0);
735                 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
736                 let route = find_route(
737                         &nodes[0].node.get_our_node_id(), &route_params, &network_graph,
738                         Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
739                 ).unwrap();
740
741                 let payment_event = {
742                         let mut payment_hash = PaymentHash([0; 32]);
743                         payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
744                         nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
745                         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
746                         assert_eq!(added_monitors.len(), 1);
747                         added_monitors.clear();
748
749                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
750                         assert_eq!(events.len(), 1);
751                         SendEvent::from_event(events.remove(0))
752
753                 };
754                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
755                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
756                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
757                 assert_eq!(added_monitors.len(), 1);
758                 added_monitors.clear();
759                 let events = nodes[1].node.get_and_clear_pending_msg_events();
760                 assert_eq!(events.len(), 2);
761         }
762
763         #[test]
764         fn test_create_invoice_with_description_hash() {
765                 let chanmon_cfgs = create_chanmon_cfgs(2);
766                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
767                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
768                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
769                 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
770                 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
771                         &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
772                         Some(10_000), description_hash, Duration::from_secs(1234567), 3600
773                 ).unwrap();
774                 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
775                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
776                 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
777         }
778
779         #[test]
780         fn test_hints_includes_single_channels_to_nodes() {
781                 let chanmon_cfgs = create_chanmon_cfgs(3);
782                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
783                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
784                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
785
786                 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
787                 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
788
789                 let mut scid_aliases = HashSet::new();
790                 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
791                 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
792
793                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
794         }
795
796         #[test]
797         fn test_hints_has_only_highest_inbound_capacity_channel() {
798                 let chanmon_cfgs = create_chanmon_cfgs(2);
799                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
800                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
801                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
802                 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());
803                 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());
804                 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());
805
806                 let mut scid_aliases = HashSet::new();
807                 scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap());
808
809                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
810         }
811
812         #[test]
813         fn test_hints_has_only_online_channels() {
814                 let chanmon_cfgs = create_chanmon_cfgs(4);
815                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
816                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
817                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
818                 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());
819                 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());
820                 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());
821
822                 // With all peers connected we should get all hints that have sufficient value
823                 let mut scid_aliases = HashSet::new();
824                 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
825                 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
826
827                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
828
829                 // With only one sufficient-value peer connected we should only get its hint
830                 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
831                 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
832                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
833
834                 // If we don't have any sufficient-value peers connected we should get all hints with
835                 // sufficient value, even though there is a connected insufficient-value peer.
836                 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
837                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
838                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
839         }
840
841         #[test]
842         fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
843                 let chanmon_cfgs = create_chanmon_cfgs(3);
844                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
845                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
846                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
847                 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
849                 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
850                 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
851                 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
852                 let mut private_chan_cfg = UserConfig::default();
853                 private_chan_cfg.channel_handshake_config.announced_channel = false;
854                 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();
855                 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
856                 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
857                 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
858                 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
859
860                 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
861
862                 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
863                 confirm_transaction_at(&nodes[2], &tx, conf_height);
864                 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
865                 confirm_transaction_at(&nodes[0], &tx, conf_height);
866                 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
867                 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
868                 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()));
869                 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
870                 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
871                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
872
873                 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
874                 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
875                 // Therefore only `chan_1_0` should be included in the hints.
876                 let mut scid_aliases = HashSet::new();
877                 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
878                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
879         }
880
881         #[test]
882         fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
883                 let chanmon_cfgs = create_chanmon_cfgs(3);
884                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
885                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
886                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
887                 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
888
889                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
890                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
891                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
892
893                 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
894                 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
895                 // public channel between `nodes[2]` and `nodes[0]`
896                 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
897         }
898
899         #[test]
900         fn test_only_public_channels_includes_no_channels_in_hints() {
901                 let chanmon_cfgs = create_chanmon_cfgs(3);
902                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
903                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
904                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
905                 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
906                 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
907                 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
908
909                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
910                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
911                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
912
913                 // As all of `nodes[0]` channels are public, no channels should be included in the hints
914                 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
915         }
916
917         #[test]
918         fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
919                 let chanmon_cfgs = create_chanmon_cfgs(3);
920                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
921                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
922                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
923                 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());
924                 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());
925
926                 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
927                 let mut scid_aliases_99_000_001_msat = HashSet::new();
928                 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
929
930                 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
931
932                 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
933                 let mut scid_aliases_99_000_000_msat = HashSet::new();
934                 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
935                 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
936
937                 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
938
939                 // As the invoice amt is above all channels' inbound capacity, they will still be included
940                 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
941                 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
942                 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
943
944                 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
945
946                 // An invoice with no specified amount should include all channels in the route hints.
947                 let mut scid_aliases_no_specified_amount = HashSet::new();
948                 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
949                 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
950
951                 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
952         }
953
954         fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
955                 invoice_amt: Option<u64>,
956                 invoice_node: &Node<'a, 'b, 'c>,
957                 mut chan_ids_to_match: HashSet<u64>
958         ) {
959                 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
960                         &invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
961                         Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
962                         3600).unwrap();
963                 let hints = invoice.private_routes();
964
965                 for hint in hints {
966                         let hint_short_chan_id = (hint.0).0[0].short_channel_id;
967                         assert!(chan_ids_to_match.remove(&hint_short_chan_id));
968                 }
969                 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
970         }
971
972         #[test]
973         #[cfg(feature = "std")]
974         fn test_multi_node_receive() {
975                 do_test_multi_node_receive(true);
976                 do_test_multi_node_receive(false);
977         }
978
979         #[cfg(feature = "std")]
980         fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
981                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
982                 let seed_1 = [42 as u8; 32];
983                 let seed_2 = [43 as u8; 32];
984                 let cross_node_seed = [44 as u8; 32];
985                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
986                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
987                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
988                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
989                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
990                 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
991                 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
992                 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
993                 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
994                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
995                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
996
997                 let payment_amt = 10_000;
998                 let route_hints = vec![
999                         nodes[1].node.get_phantom_route_hints(),
1000                         nodes[2].node.get_phantom_route_hints(),
1001                 ];
1002
1003                 let user_payment_preimage = PaymentPreimage([1; 32]);
1004                 let payment_hash = if user_generated_pmt_hash {
1005                         Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
1006                 } else {
1007                         None
1008                 };
1009                 let non_default_invoice_expiry_secs = 4200;
1010
1011                 let invoice =
1012                         crate::utils::create_phantom_invoice::<EnforcingSigner, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
1013                                 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1014                                 route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
1015                         ).unwrap();
1016                 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
1017                 let payment_preimage = if user_generated_pmt_hash {
1018                         user_payment_preimage
1019                 } else {
1020                         nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1021                 };
1022
1023                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1024                 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
1025                 assert_eq!(invoice.route_hints().len(), 2);
1026                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1027                 assert!(!invoice.features().unwrap().supports_basic_mpp());
1028
1029                 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
1030                         .with_features(invoice.features().unwrap().clone())
1031                         .with_route_hints(invoice.route_hints());
1032                 let params = RouteParameters {
1033                         payment_params,
1034                         final_value_msat: invoice.amount_milli_satoshis().unwrap(),
1035                         final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
1036                 };
1037                 let first_hops = nodes[0].node.list_usable_channels();
1038                 let network_graph = &node_cfgs[0].network_graph;
1039                 let logger = test_utils::TestLogger::new();
1040                 let scorer = test_utils::TestScorer::with_penalty(0);
1041                 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
1042                 let route = find_route(
1043                         &nodes[0].node.get_our_node_id(), &params, &network_graph,
1044                         Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
1045                 ).unwrap();
1046                 let (payment_event, fwd_idx) = {
1047                         let mut payment_hash = PaymentHash([0; 32]);
1048                         payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1049                         nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
1050                         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1051                         assert_eq!(added_monitors.len(), 1);
1052                         added_monitors.clear();
1053
1054                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1055                         assert_eq!(events.len(), 1);
1056                         let fwd_idx = match events[0] {
1057                                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1058                                         if node_id == nodes[1].node.get_our_node_id() {
1059                                                 1
1060                                         } else { 2 }
1061                                 },
1062                                 _ => panic!("Unexpected event")
1063                         };
1064                         (SendEvent::from_event(events.remove(0)), fwd_idx)
1065                 };
1066                 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1067                 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1068
1069                 // Note that we have to "forward pending HTLCs" twice before we see the PaymentReceived as
1070                 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1071                 // payments "look real" by taking more time.
1072                 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1073                 nodes[fwd_idx].node.process_pending_htlc_forwards();
1074                 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1075                 nodes[fwd_idx].node.process_pending_htlc_forwards();
1076
1077                 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1078                 expect_payment_received!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt);
1079                 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage);
1080                 let events = nodes[0].node.get_and_clear_pending_events();
1081                 assert_eq!(events.len(), 2);
1082                 match events[0] {
1083                         Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1084                                 assert_eq!(payment_preimage, *ev_preimage);
1085                                 assert_eq!(payment_hash, *ev_hash);
1086                                 assert_eq!(fee_paid_msat, &Some(0));
1087                         },
1088                         _ => panic!("Unexpected event")
1089                 }
1090                 match events[1] {
1091                         Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1092                                 assert_eq!(hash, Some(payment_hash));
1093                         },
1094                         _ => panic!("Unexpected event")
1095                 }
1096         }
1097
1098         #[test]
1099         #[cfg(feature = "std")]
1100         fn test_multi_node_hints_has_htlc_min_max_values() {
1101                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1102                 let seed_1 = [42 as u8; 32];
1103                 let seed_2 = [43 as u8; 32];
1104                 let cross_node_seed = [44 as u8; 32];
1105                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1106                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1107                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1108                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1109                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1110
1111                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1112                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1113
1114                 let payment_amt = 20_000;
1115                 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap();
1116                 let route_hints = vec![
1117                         nodes[1].node.get_phantom_route_hints(),
1118                         nodes[2].node.get_phantom_route_hints(),
1119                 ];
1120
1121                 let invoice = crate::utils::create_phantom_invoice::<EnforcingSigner, &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();
1122
1123                 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1124                 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1125                 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1126
1127                 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1128                 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1129                 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1130         }
1131
1132         #[test]
1133         #[cfg(feature = "std")]
1134         fn create_phantom_invoice_with_description_hash() {
1135                 let chanmon_cfgs = create_chanmon_cfgs(3);
1136                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1137                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1138                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1139
1140                 let payment_amt = 20_000;
1141                 let route_hints = vec![
1142                         nodes[1].node.get_phantom_route_hints(),
1143                         nodes[2].node.get_phantom_route_hints(),
1144                 ];
1145
1146                 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1147                 let non_default_invoice_expiry_secs = 4200;
1148                 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1149                         EnforcingSigner, &test_utils::TestKeysInterface, &test_utils::TestLogger,
1150                 >(
1151                         Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1152                         route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
1153                 )
1154                 .unwrap();
1155                 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1156                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1157                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1158                 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1159         }
1160
1161         #[test]
1162         #[cfg(feature = "std")]
1163         fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1164                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1165                 let seed_1 = [42 as u8; 32];
1166                 let seed_2 = [43 as u8; 32];
1167                 let cross_node_seed = [44 as u8; 32];
1168                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1169                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1170                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1171                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1172                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1173
1174                 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1175                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1176
1177                 let mut scid_aliases = HashSet::new();
1178                 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1179                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1180
1181                 match_multi_node_invoice_routes(
1182                         Some(10_000),
1183                         &nodes[1],
1184                         vec![&nodes[1], &nodes[2],],
1185                         scid_aliases,
1186                         false
1187                 );
1188         }
1189
1190         #[test]
1191         #[cfg(feature = "std")]
1192         fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1193                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1194                 let seed_1 = [42 as u8; 32];
1195                 let seed_2 = [43 as u8; 32];
1196                 let cross_node_seed = [44 as u8; 32];
1197                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1198                 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1199                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1200                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1201                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1202
1203                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1204                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1205                 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());
1206
1207                 let mut scid_aliases = HashSet::new();
1208                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1209                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1210                 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1211
1212                 match_multi_node_invoice_routes(
1213                         Some(10_000),
1214                         &nodes[2],
1215                         vec![&nodes[2], &nodes[3],],
1216                         scid_aliases,
1217                         false
1218                 );
1219         }
1220
1221         #[test]
1222         #[cfg(feature = "std")]
1223         fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1224                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1225                 let seed_1 = [42 as u8; 32];
1226                 let seed_2 = [43 as u8; 32];
1227                 let cross_node_seed = [44 as u8; 32];
1228                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1229                 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1230                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1231                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1232                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1233
1234                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1235                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1236
1237                 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1238                 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1239                 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1240                 let mut private_chan_cfg = UserConfig::default();
1241                 private_chan_cfg.channel_handshake_config.announced_channel = false;
1242                 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();
1243                 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1244                 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
1245                 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1246                 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
1247
1248                 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1249
1250                 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1251                 confirm_transaction_at(&nodes[1], &tx, conf_height);
1252                 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1253                 confirm_transaction_at(&nodes[3], &tx, conf_height);
1254                 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1255                 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1256                 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()));
1257                 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1258                 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1259                 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1260
1261                 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1262                 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1263                 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1264                 let mut scid_aliases = HashSet::new();
1265                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1266                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1267
1268                 match_multi_node_invoice_routes(
1269                         Some(10_000),
1270                         &nodes[2],
1271                         vec![&nodes[2], &nodes[3],],
1272                         scid_aliases,
1273                         false
1274                 );
1275         }
1276
1277         #[test]
1278         #[cfg(feature = "std")]
1279         fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1280                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1281                 let seed_1 = [42 as u8; 32];
1282                 let seed_2 = [43 as u8; 32];
1283                 let cross_node_seed = [44 as u8; 32];
1284                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1285                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1286                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1287                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1288                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1289
1290                 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1291
1292                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1293                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1294                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1295
1296                 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1297                 // `chan_0_2` as `nodes[2]` only has public channels.
1298                 let mut scid_aliases = HashSet::new();
1299                 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1300
1301                 match_multi_node_invoice_routes(
1302                         Some(10_000),
1303                         &nodes[1],
1304                         vec![&nodes[1], &nodes[2],],
1305                         scid_aliases,
1306                         true
1307                 );
1308         }
1309
1310         #[test]
1311         #[cfg(feature = "std")]
1312         fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1313                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1314                 let seed_1 = [42 as u8; 32];
1315                 let seed_2 = [43 as u8; 32];
1316                 let cross_node_seed = [44 as u8; 32];
1317                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1318                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1319                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1320                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1321                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1322
1323                 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1324                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1325                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1326                 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1327
1328                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1329
1330                 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1331                 // channels for `nodes[2]` as it contains a mix of public and private channels.
1332                 let mut scid_aliases = HashSet::new();
1333                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1334
1335                 match_multi_node_invoice_routes(
1336                         Some(10_000),
1337                         &nodes[2],
1338                         vec![&nodes[2], &nodes[3],],
1339                         scid_aliases,
1340                         true
1341                 );
1342         }
1343
1344         #[test]
1345         #[cfg(feature = "std")]
1346         fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() {
1347                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1348                 let seed_1 = [42 as u8; 32];
1349                 let seed_2 = [43 as u8; 32];
1350                 let cross_node_seed = [44 as u8; 32];
1351                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1352                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1353                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1354                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1355                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1356
1357                 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());
1358                 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());
1359                 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());
1360                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1361
1362                 let mut scid_aliases = HashSet::new();
1363                 scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap());
1364                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1365
1366                 match_multi_node_invoice_routes(
1367                         Some(10_000),
1368                         &nodes[1],
1369                         vec![&nodes[1], &nodes[2],],
1370                         scid_aliases,
1371                         false
1372                 );
1373         }
1374
1375         #[test]
1376         #[cfg(feature = "std")]
1377         fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1378                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1379                 let seed_1 = [42 as u8; 32];
1380                 let seed_2 = [43 as u8; 32];
1381                 let cross_node_seed = [44 as u8; 32];
1382                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1383                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1384                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1385                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1386                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1387
1388                 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());
1389                 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());
1390                 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());
1391
1392                 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1393                 let mut scid_aliases_99_000_001_msat = HashSet::new();
1394                 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1395                 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1396
1397                 match_multi_node_invoice_routes(
1398                         Some(99_000_001),
1399                         &nodes[2],
1400                         vec![&nodes[2], &nodes[3],],
1401                         scid_aliases_99_000_001_msat,
1402                         false
1403                 );
1404
1405                 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1406                 let mut scid_aliases_99_000_000_msat = HashSet::new();
1407                 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1408                 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1409                 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1410
1411                 match_multi_node_invoice_routes(
1412                         Some(99_000_000),
1413                         &nodes[2],
1414                         vec![&nodes[2], &nodes[3],],
1415                         scid_aliases_99_000_000_msat,
1416                         false
1417                 );
1418
1419                 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1420                 // `nodes[2]` them should be included.
1421                 let mut scid_aliases_300_000_000_msat = HashSet::new();
1422                 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1423                 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1424                 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1425
1426                 match_multi_node_invoice_routes(
1427                         Some(300_000_000),
1428                         &nodes[2],
1429                         vec![&nodes[2], &nodes[3],],
1430                         scid_aliases_300_000_000_msat,
1431                         false
1432                 );
1433
1434                 // Since the no specified amount, all channels should included.
1435                 let mut scid_aliases_no_specified_amount = HashSet::new();
1436                 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1437                 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1438                 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1439
1440                 match_multi_node_invoice_routes(
1441                         None,
1442                         &nodes[2],
1443                         vec![&nodes[2], &nodes[3],],
1444                         scid_aliases_no_specified_amount,
1445                         false
1446                 );
1447         }
1448
1449         #[cfg(feature = "std")]
1450         fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1451                 invoice_amt: Option<u64>,
1452                 invoice_node: &Node<'a, 'b, 'c>,
1453                 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1454                 mut chan_ids_to_match: HashSet<u64>,
1455                 nodes_contains_public_channels: bool
1456         ){
1457                 let phantom_route_hints = network_multi_nodes.iter()
1458                         .map(|node| node.node.get_phantom_route_hints())
1459                         .collect::<Vec<PhantomRouteHints>>();
1460                 let phantom_scids = phantom_route_hints.iter()
1461                         .map(|route_hint| route_hint.phantom_scid)
1462                         .collect::<HashSet<u64>>();
1463
1464                 let invoice = crate::utils::create_phantom_invoice::<EnforcingSigner, &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();
1465
1466                 let invoice_hints = invoice.private_routes();
1467
1468                 for hint in invoice_hints {
1469                         let hints = &(hint.0).0;
1470                         match hints.len() {
1471                                 1 => {
1472                                         assert!(nodes_contains_public_channels);
1473                                         let phantom_scid = hints[0].short_channel_id;
1474                                         assert!(phantom_scids.contains(&phantom_scid));
1475                                 },
1476                                 2 => {
1477                                         let hint_short_chan_id = hints[0].short_channel_id;
1478                                         assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1479                                         let phantom_scid = hints[1].short_channel_id;
1480                                         assert!(phantom_scids.contains(&phantom_scid));
1481                                 },
1482                                 _ => panic!("Incorrect hint length generated")
1483                         }
1484                 }
1485                 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1486         }
1487 }