1 //! Convenient utilities to create an invoice.
3 use {CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
4 use payment::{InFlightHtlcs, Payer, Router};
6 use crate::{prelude::*, Description, InvoiceDescription, Sha256};
8 use bitcoin_hashes::{Hash, sha256};
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;
24 use core::time::Duration;
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.
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
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.
45 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
46 /// in excess of the current time.
48 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
49 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
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>(
58 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String, invoice_expiry_delta_secs: u32,
59 phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K, network: Currency,
60 ) -> Result<Invoice, SignOrCreationError<()>> where K::Target: KeysInterface {
61 let description = Description::new(description).map_err(SignOrCreationError::CreationError)?;
62 let description = InvoiceDescription::Direct(&description,);
63 _create_phantom_invoice::<Signer, K>(
64 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints, keys_manager, network,
68 #[cfg(feature = "std")]
69 /// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
70 /// See [`PhantomKeysManager`] for more information on phantom node payments.
72 /// `phantom_route_hints` parameter:
73 /// * Contains channel info for all nodes participating in the phantom invoice
74 /// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
75 /// participating node
76 /// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
77 /// updated when a channel becomes disabled or closes
78 /// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
79 /// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
82 /// `description_hash` is a SHA-256 hash of the description text
84 /// `payment_hash` can be specified if you have a specific need for a custom payment hash (see the difference
85 /// between [`ChannelManager::create_inbound_payment`] and [`ChannelManager::create_inbound_payment_for_hash`]).
86 /// If `None` is provided for `payment_hash`, then one will be created.
88 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
89 /// in excess of the current time.
91 /// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
92 /// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
95 /// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
96 /// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
97 /// [`ChannelManager::create_inbound_payment`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment
98 /// [`ChannelManager::create_inbound_payment_for_hash`]: lightning::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
99 /// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
100 pub fn create_phantom_invoice_with_description_hash<Signer: Sign, K: Deref>(
101 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
102 description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K, network: Currency,
103 ) -> Result<Invoice, SignOrCreationError<()>> where K::Target: KeysInterface
105 _create_phantom_invoice::<Signer, K>(
106 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
107 invoice_expiry_delta_secs, phantom_route_hints, keys_manager, network,
111 #[cfg(feature = "std")]
112 fn _create_phantom_invoice<Signer: Sign, K: Deref>(
113 amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
114 invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, keys_manager: K, network: Currency,
115 ) -> Result<Invoice, SignOrCreationError<()>> where K::Target: KeysInterface
117 use std::time::{SystemTime, UNIX_EPOCH};
119 if phantom_route_hints.len() == 0 {
120 return Err(SignOrCreationError::CreationError(
121 CreationError::MissingRouteHints,
124 let invoice = match description {
125 InvoiceDescription::Direct(description) => {
126 InvoiceBuilder::new(network).description(description.0.clone())
128 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
131 // If we ever see performance here being too slow then we should probably take this ExpandedKey as a parameter instead.
132 let keys = ExpandedKey::new(&keys_manager.get_inbound_payment_key_material());
133 let (payment_hash, payment_secret) = if let Some(payment_hash) = payment_hash {
134 let payment_secret = create_from_hash(
138 invoice_expiry_delta_secs,
140 .duration_since(UNIX_EPOCH)
141 .expect("Time must be > 1970")
144 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
145 (payment_hash, payment_secret)
150 invoice_expiry_delta_secs,
153 .duration_since(UNIX_EPOCH)
154 .expect("Time must be > 1970")
157 .map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
160 let mut invoice = invoice
162 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
163 .payment_secret(payment_secret)
164 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
165 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
166 if let Some(amt) = amt_msat {
167 invoice = invoice.amount_milli_satoshis(amt);
170 for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
171 let mut route_hints = filter_channels(channels, amt_msat);
173 // If we have any public channel, the route hints from `filter_channels` will be empty.
174 // In that case we create a RouteHint on which we will push a single hop with the phantom
175 // route into the invoice, and let the sender find the path to the `real_node_pubkey`
176 // node by looking at our public channels.
177 if route_hints.is_empty() {
178 route_hints.push(RouteHint(vec![]))
180 for mut route_hint in route_hints {
181 route_hint.0.push(RouteHintHop {
182 src_node_id: real_node_pubkey,
183 short_channel_id: phantom_scid,
186 proportional_millionths: 0,
188 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
189 htlc_minimum_msat: None,
190 htlc_maximum_msat: None,});
191 invoice = invoice.private_route(route_hint.clone());
195 let raw_invoice = match invoice.build_raw() {
197 Err(e) => return Err(SignOrCreationError::CreationError(e))
199 let hrp_str = raw_invoice.hrp.to_string();
200 let hrp_bytes = hrp_str.as_bytes();
201 let data_without_signature = raw_invoice.data.to_base32();
202 let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode));
203 match signed_raw_invoice {
204 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
205 Err(e) => Err(SignOrCreationError::SignError(e))
209 #[cfg(feature = "std")]
210 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
211 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
212 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
213 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
214 /// that the payment secret is valid when the invoice is paid.
216 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
217 /// in excess of the current time.
218 pub fn create_invoice_from_channelmanager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
219 channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, network: Currency,
220 amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32
221 ) -> Result<Invoice, SignOrCreationError<()>>
223 M::Target: chain::Watch<Signer>,
224 T::Target: BroadcasterInterface,
225 K::Target: KeysInterface<Signer = Signer>,
226 F::Target: FeeEstimator,
229 use std::time::SystemTime;
230 let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
231 .expect("for the foreseeable future this shouldn't happen");
232 create_invoice_from_channelmanager_and_duration_since_epoch(
233 channelmanager, keys_manager, network, amt_msat, description, duration,
234 invoice_expiry_delta_secs
238 #[cfg(feature = "std")]
239 /// Utility to construct an invoice. Generally, unless you want to do something like a custom
240 /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this
241 /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
242 /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
243 /// that the payment secret is valid when the invoice is paid.
244 /// Use this variant if you want to pass the `description_hash` to the invoice.
246 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
247 /// in excess of the current time.
248 pub fn create_invoice_from_channelmanager_with_description_hash<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
249 channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, network: Currency,
250 amt_msat: Option<u64>, description_hash: Sha256, invoice_expiry_delta_secs: u32
251 ) -> Result<Invoice, SignOrCreationError<()>>
253 M::Target: chain::Watch<Signer>,
254 T::Target: BroadcasterInterface,
255 K::Target: KeysInterface<Signer = Signer>,
256 F::Target: FeeEstimator,
259 use std::time::SystemTime;
261 let duration = SystemTime::now()
262 .duration_since(SystemTime::UNIX_EPOCH)
263 .expect("for the foreseeable future this shouldn't happen");
265 create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
266 channelmanager, keys_manager, network, amt_msat,
267 description_hash, duration, invoice_expiry_delta_secs
271 /// See [`create_invoice_from_channelmanager_with_description_hash`]
272 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
273 /// available and the current time is supplied by the caller.
274 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>(
275 channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, network: Currency,
276 amt_msat: Option<u64>, description_hash: Sha256, duration_since_epoch: Duration,
277 invoice_expiry_delta_secs: u32
278 ) -> Result<Invoice, SignOrCreationError<()>>
280 M::Target: chain::Watch<Signer>,
281 T::Target: BroadcasterInterface,
282 K::Target: KeysInterface<Signer = Signer>,
283 F::Target: FeeEstimator,
286 _create_invoice_from_channelmanager_and_duration_since_epoch(
287 channelmanager, keys_manager, network, amt_msat,
288 InvoiceDescription::Hash(&description_hash),
289 duration_since_epoch, invoice_expiry_delta_secs
293 /// See [`create_invoice_from_channelmanager`]
294 /// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
295 /// available and the current time is supplied by the caller.
296 pub fn create_invoice_from_channelmanager_and_duration_since_epoch<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
297 channelmanager: &ChannelManager<Signer, M, T, K, F, L>, keys_manager: K, network: Currency,
298 amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
299 invoice_expiry_delta_secs: u32
300 ) -> Result<Invoice, SignOrCreationError<()>>
302 M::Target: chain::Watch<Signer>,
303 T::Target: BroadcasterInterface,
304 K::Target: KeysInterface<Signer = Signer>,
305 F::Target: FeeEstimator,
308 _create_invoice_from_channelmanager_and_duration_since_epoch(
309 channelmanager, keys_manager, network, amt_msat,
310 InvoiceDescription::Direct(
311 &Description::new(description).map_err(SignOrCreationError::CreationError)?,
313 duration_since_epoch, invoice_expiry_delta_secs
317 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, network: Currency,
319 amt_msat: Option<u64>, description: InvoiceDescription, duration_since_epoch: Duration,
320 invoice_expiry_delta_secs: u32
321 ) -> Result<Invoice, SignOrCreationError<()>>
323 M::Target: chain::Watch<Signer>,
324 T::Target: BroadcasterInterface,
325 K::Target: KeysInterface<Signer = Signer>,
326 F::Target: FeeEstimator,
329 let route_hints = filter_channels(channelmanager.list_channels(), amt_msat);
331 // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
333 let (payment_hash, payment_secret) = channelmanager
334 .create_inbound_payment(amt_msat, invoice_expiry_delta_secs)
335 .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
336 let our_node_pubkey = channelmanager.get_our_node_id();
338 let invoice = match description {
339 InvoiceDescription::Direct(description) => {
340 InvoiceBuilder::new(network).description(description.0.clone())
342 InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0),
345 let mut invoice = invoice
346 .duration_since_epoch(duration_since_epoch)
347 .payee_pub_key(our_node_pubkey)
348 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
349 .payment_secret(payment_secret)
351 .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into())
352 .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into()));
353 if let Some(amt) = amt_msat {
354 invoice = invoice.amount_milli_satoshis(amt);
356 for hint in route_hints {
357 invoice = invoice.private_route(hint);
360 let raw_invoice = match invoice.build_raw() {
362 Err(e) => return Err(SignOrCreationError::CreationError(e))
364 let hrp_str = raw_invoice.hrp.to_string();
365 let hrp_bytes = hrp_str.as_bytes();
366 let data_without_signature = raw_invoice.data.to_base32();
367 let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node));
368 match signed_raw_invoice {
369 Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()),
370 Err(e) => Err(SignOrCreationError::SignError(e))
374 /// Filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include
377 /// The filtering is based on the following criteria:
378 /// * Only one channel per counterparty node
379 /// * Always select the channel with the highest inbound capacity per counterparty node
380 /// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
381 /// `is_usable` (i.e. the peer is connected).
382 /// * If any public channel exists, the returned `RouteHint`s will be empty, and the sender will
383 /// need to find the path by looking at the public channels instead
384 fn filter_channels(channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>) -> Vec<RouteHint>{
385 let mut filtered_channels: HashMap<PublicKey, ChannelDetails> = HashMap::new();
386 let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0);
387 let mut min_capacity_channel_exists = false;
388 let mut online_channel_exists = false;
389 let mut online_min_capacity_channel_exists = false;
391 for channel in channels.into_iter().filter(|chan| chan.is_channel_ready) {
392 if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() {
396 if channel.is_public {
397 // If any public channel exists, return no hints and let the sender
398 // look at the public channels instead.
402 if channel.inbound_capacity_msat >= min_inbound_capacity {
403 min_capacity_channel_exists = true;
404 if channel.is_usable {
405 online_min_capacity_channel_exists = true;
408 if channel.is_usable {
409 online_channel_exists = true;
411 match filtered_channels.entry(channel.counterparty.node_id) {
412 hash_map::Entry::Occupied(mut entry) => {
413 let current_max_capacity = entry.get().inbound_capacity_msat;
414 if channel.inbound_capacity_msat < current_max_capacity {
417 entry.insert(channel);
419 hash_map::Entry::Vacant(entry) => {
420 entry.insert(channel);
425 let route_hint_from_channel = |channel: ChannelDetails| {
426 let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap();
427 RouteHint(vec![RouteHintHop {
428 src_node_id: channel.counterparty.node_id,
429 short_channel_id: channel.get_inbound_payment_scid().unwrap(),
431 base_msat: forwarding_info.fee_base_msat,
432 proportional_millionths: forwarding_info.fee_proportional_millionths,
434 cltv_expiry_delta: forwarding_info.cltv_expiry_delta,
435 htlc_minimum_msat: channel.inbound_htlc_minimum_msat,
436 htlc_maximum_msat: channel.inbound_htlc_maximum_msat,}])
438 // If all channels are private, prefer to return route hints which have a higher capacity than
439 // the payment value and where we're currently connected to the channel counterparty.
440 // Even if we cannot satisfy both goals, always ensure we include *some* hints, preferring
441 // those which meet at least one criteria.
444 .map(|(_, channel)| channel)
446 if online_min_capacity_channel_exists {
447 channel.inbound_capacity_msat >= min_inbound_capacity && channel.is_usable
448 } else if min_capacity_channel_exists && online_channel_exists {
449 // If there are some online channels and some min_capacity channels, but no
450 // online-and-min_capacity channels, just include the min capacity ones and ignore
452 channel.inbound_capacity_msat >= min_inbound_capacity
453 } else if min_capacity_channel_exists {
454 channel.inbound_capacity_msat >= min_inbound_capacity
455 } else if online_channel_exists {
459 .map(route_hint_from_channel)
460 .collect::<Vec<RouteHint>>()
463 /// A [`Router`] implemented using [`find_route`].
464 pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
466 S::Target: for <'a> LockableScore<'a>,
470 random_seed_bytes: Mutex<[u8; 32]>,
474 impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
476 S::Target: for <'a> LockableScore<'a>,
478 /// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
479 /// `random_seed_bytes`.
480 pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
481 let random_seed_bytes = Mutex::new(random_seed_bytes);
482 Self { network_graph, logger, random_seed_bytes, scorer }
486 impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
488 S::Target: for <'a> LockableScore<'a>,
491 &self, payer: &PublicKey, params: &RouteParameters, _payment_hash: &PaymentHash,
492 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
493 ) -> Result<Route, LightningError> {
494 let random_seed_bytes = {
495 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
496 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
497 *locked_random_seed_bytes
501 payer, params, &self.network_graph, first_hops, &*self.logger,
502 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
507 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
508 self.scorer.lock().payment_path_failed(path, short_channel_id);
511 fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
512 self.scorer.lock().payment_path_successful(path);
515 fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
516 self.scorer.lock().probe_successful(path);
519 fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
520 self.scorer.lock().probe_failed(path, short_channel_id);
524 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<Signer, M, T, K, F, L>
526 M::Target: chain::Watch<Signer>,
527 T::Target: BroadcasterInterface,
528 K::Target: KeysInterface<Signer = Signer>,
529 F::Target: FeeEstimator,
532 fn node_id(&self) -> PublicKey {
533 self.get_our_node_id()
536 fn first_hops(&self) -> Vec<ChannelDetails> {
537 self.list_usable_channels()
541 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
542 ) -> Result<PaymentId, PaymentSendFailure> {
543 self.send_payment(route, payment_hash, payment_secret)
546 fn send_spontaneous_payment(
547 &self, route: &Route, payment_preimage: PaymentPreimage,
548 ) -> Result<PaymentId, PaymentSendFailure> {
549 self.send_spontaneous_payment(route, Some(payment_preimage))
550 .map(|(_, payment_id)| payment_id)
554 &self, route: &Route, payment_id: PaymentId
555 ) -> Result<(), PaymentSendFailure> {
556 self.retry_payment(route, payment_id)
559 fn abandon_payment(&self, payment_id: PaymentId) {
560 self.abandon_payment(payment_id)
565 /// Used to store information about all the HTLCs that are inflight across all payment attempts.
566 pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
568 /// Maps a channel's short channel id and its direction to the liquidity used up.
569 inflight_htlcs: InFlightHtlcs,
572 impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
573 pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
574 ScorerAccountingForInFlightHtlcs {
582 impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
583 fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
586 impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
587 fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
588 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
589 source, target, short_channel_id
591 let usage = ChannelUsage {
592 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
596 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
598 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
602 fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
604 fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
606 fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
608 fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
614 use core::time::Duration;
615 use {Currency, Description, InvoiceDescription};
616 use bitcoin_hashes::Hash;
617 use bitcoin_hashes::sha256::Hash as Sha256;
618 use lightning::chain::keysinterface::PhantomKeysManager;
619 use lightning::ln::{PaymentPreimage, PaymentHash};
620 use lightning::ln::channelmanager::{self, PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY};
621 use lightning::ln::functional_test_utils::*;
622 use lightning::ln::msgs::ChannelMessageHandler;
623 use lightning::routing::router::{PaymentParameters, RouteParameters, find_route};
624 use lightning::util::enforcing_trait_impls::EnforcingSigner;
625 use lightning::util::events::{MessageSendEvent, MessageSendEventsProvider, Event};
626 use lightning::util::test_utils;
627 use lightning::util::config::UserConfig;
628 use lightning::chain::keysinterface::KeysInterface;
629 use utils::create_invoice_from_channelmanager_and_duration_since_epoch;
630 use std::collections::HashSet;
633 fn test_from_channelmanager() {
634 let chanmon_cfgs = create_chanmon_cfgs(2);
635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
638 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
639 let non_default_invoice_expiry_secs = 4200;
640 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
641 &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), "test".to_string(),
642 Duration::from_secs(1234567), non_default_invoice_expiry_secs).unwrap();
643 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
644 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
645 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
646 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
648 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
650 let chan = &nodes[1].node.list_usable_channels()[0];
651 assert_eq!(invoice.route_hints().len(), 1);
652 assert_eq!(invoice.route_hints()[0].0.len(), 1);
653 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
655 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
656 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
658 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
659 .with_features(invoice.features().unwrap().clone())
660 .with_route_hints(invoice.route_hints());
661 let route_params = RouteParameters {
663 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
664 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
666 let first_hops = nodes[0].node.list_usable_channels();
667 let network_graph = &node_cfgs[0].network_graph;
668 let logger = test_utils::TestLogger::new();
669 let scorer = test_utils::TestScorer::with_penalty(0);
670 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
671 let route = find_route(
672 &nodes[0].node.get_our_node_id(), &route_params, &network_graph,
673 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
676 let payment_event = {
677 let mut payment_hash = PaymentHash([0; 32]);
678 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
679 nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone())).unwrap();
680 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
681 assert_eq!(added_monitors.len(), 1);
682 added_monitors.clear();
684 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
685 assert_eq!(events.len(), 1);
686 SendEvent::from_event(events.remove(0))
689 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
690 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
691 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
692 assert_eq!(added_monitors.len(), 1);
693 added_monitors.clear();
694 let events = nodes[1].node.get_and_clear_pending_msg_events();
695 assert_eq!(events.len(), 2);
699 fn test_create_invoice_with_description_hash() {
700 let chanmon_cfgs = create_chanmon_cfgs(2);
701 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
702 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
703 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
704 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
705 let invoice = ::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
706 &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000),
707 description_hash, Duration::from_secs(1234567), 3600
709 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
710 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
711 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
715 fn test_hints_includes_single_channels_to_nodes() {
716 let chanmon_cfgs = create_chanmon_cfgs(3);
717 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
718 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
719 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
721 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
722 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
724 let mut scid_aliases = HashSet::new();
725 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
726 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
728 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
732 fn test_hints_has_only_highest_inbound_capacity_channel() {
733 let chanmon_cfgs = create_chanmon_cfgs(2);
734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
736 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
737 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());
738 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());
739 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());
741 let mut scid_aliases = HashSet::new();
742 scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap());
744 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
748 fn test_hints_has_only_online_channels() {
749 let chanmon_cfgs = create_chanmon_cfgs(4);
750 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
751 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
752 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
753 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());
754 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());
755 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());
757 // With all peers connected we should get all hints that have sufficient value
758 let mut scid_aliases = HashSet::new();
759 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
760 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
762 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
764 // With only one sufficient-value peer connected we should only get its hint
765 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
766 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
767 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
769 // If we don't have any sufficient-value peers connected we should get all hints with
770 // sufficient value, even though there is a connected insufficient-value peer.
771 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
772 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
773 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
777 fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
778 let chanmon_cfgs = create_chanmon_cfgs(3);
779 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
780 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
781 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
782 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
784 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
785 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
786 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
787 let mut private_chan_cfg = UserConfig::default();
788 private_chan_cfg.channel_handshake_config.announced_channel = false;
789 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();
790 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
791 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
792 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
793 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
795 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
797 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
798 confirm_transaction_at(&nodes[2], &tx, conf_height);
799 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
800 confirm_transaction_at(&nodes[0], &tx, conf_height);
801 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
802 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
803 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()));
804 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
805 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
806 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
808 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
809 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
810 // Therefore only `chan_1_0` should be included in the hints.
811 let mut scid_aliases = HashSet::new();
812 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
813 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
817 fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
818 let chanmon_cfgs = create_chanmon_cfgs(3);
819 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
820 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
821 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
822 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
824 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
825 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
826 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
828 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
829 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
830 // public channel between `nodes[2]` and `nodes[0]`
831 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
835 fn test_only_public_channels_includes_no_channels_in_hints() {
836 let chanmon_cfgs = create_chanmon_cfgs(3);
837 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
838 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
839 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
840 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
841 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
842 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
844 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
845 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
846 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
848 // As all of `nodes[0]` channels are public, no channels should be included in the hints
849 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
853 fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
854 let chanmon_cfgs = create_chanmon_cfgs(3);
855 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
856 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
857 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
858 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());
859 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());
861 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
862 let mut scid_aliases_99_000_001_msat = HashSet::new();
863 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
865 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
867 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
868 let mut scid_aliases_99_000_000_msat = HashSet::new();
869 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
870 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
872 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
874 // As the invoice amt is above all channels' inbound capacity, they will still be included
875 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
876 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
877 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
879 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
881 // An invoice with no specified amount should include all channels in the route hints.
882 let mut scid_aliases_no_specified_amount = HashSet::new();
883 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
884 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
886 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
889 fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
890 invoice_amt: Option<u64>,
891 invoice_node: &Node<'a, 'b, 'c>,
892 mut chan_ids_to_match: HashSet<u64>
894 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
895 &invoice_node.node, invoice_node.keys_manager, Currency::BitcoinTestnet, invoice_amt, "test".to_string(),
896 Duration::from_secs(1234567), 3600).unwrap();
897 let hints = invoice.private_routes();
900 let hint_short_chan_id = (hint.0).0[0].short_channel_id;
901 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
903 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
907 #[cfg(feature = "std")]
908 fn test_multi_node_receive() {
909 do_test_multi_node_receive(true);
910 do_test_multi_node_receive(false);
913 #[cfg(feature = "std")]
914 fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
915 let mut chanmon_cfgs = create_chanmon_cfgs(3);
916 let seed_1 = [42 as u8; 32];
917 let seed_2 = [43 as u8; 32];
918 let cross_node_seed = [44 as u8; 32];
919 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
920 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
921 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
922 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
923 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
924 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
925 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
926 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
927 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
928 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
929 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
931 let payment_amt = 10_000;
932 let route_hints = vec![
933 nodes[1].node.get_phantom_route_hints(),
934 nodes[2].node.get_phantom_route_hints(),
937 let user_payment_preimage = PaymentPreimage([1; 32]);
938 let payment_hash = if user_generated_pmt_hash {
939 Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
943 let non_default_invoice_expiry_secs = 4200;
946 ::utils::create_phantom_invoice::<EnforcingSigner, &test_utils::TestKeysInterface>(
947 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
948 route_hints, &nodes[1].keys_manager, Currency::BitcoinTestnet
950 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
951 let payment_preimage = if user_generated_pmt_hash {
952 user_payment_preimage
954 nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
957 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
958 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
959 assert_eq!(invoice.route_hints().len(), 2);
960 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
961 assert!(!invoice.features().unwrap().supports_basic_mpp());
963 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
964 .with_features(invoice.features().unwrap().clone())
965 .with_route_hints(invoice.route_hints());
966 let params = RouteParameters {
968 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
969 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
971 let first_hops = nodes[0].node.list_usable_channels();
972 let network_graph = &node_cfgs[0].network_graph;
973 let logger = test_utils::TestLogger::new();
974 let scorer = test_utils::TestScorer::with_penalty(0);
975 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
976 let route = find_route(
977 &nodes[0].node.get_our_node_id(), ¶ms, &network_graph,
978 Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
980 let (payment_event, fwd_idx) = {
981 let mut payment_hash = PaymentHash([0; 32]);
982 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
983 nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone())).unwrap();
984 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
985 assert_eq!(added_monitors.len(), 1);
986 added_monitors.clear();
988 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
989 assert_eq!(events.len(), 1);
990 let fwd_idx = match events[0] {
991 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
992 if node_id == nodes[1].node.get_our_node_id() {
996 _ => panic!("Unexpected event")
998 (SendEvent::from_event(events.remove(0)), fwd_idx)
1000 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1001 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1003 // Note that we have to "forward pending HTLCs" twice before we see the PaymentReceived as
1004 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1005 // payments "look real" by taking more time.
1006 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1007 nodes[fwd_idx].node.process_pending_htlc_forwards();
1008 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1009 nodes[fwd_idx].node.process_pending_htlc_forwards();
1011 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1012 expect_payment_received!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt);
1013 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage);
1014 let events = nodes[0].node.get_and_clear_pending_events();
1015 assert_eq!(events.len(), 2);
1017 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1018 assert_eq!(payment_preimage, *ev_preimage);
1019 assert_eq!(payment_hash, *ev_hash);
1020 assert_eq!(fee_paid_msat, &Some(0));
1022 _ => panic!("Unexpected event")
1025 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1026 assert_eq!(hash, Some(payment_hash));
1028 _ => panic!("Unexpected event")
1033 #[cfg(feature = "std")]
1034 fn test_multi_node_hints_has_htlc_min_max_values() {
1035 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1036 let seed_1 = [42 as u8; 32];
1037 let seed_2 = [43 as u8; 32];
1038 let cross_node_seed = [44 as u8; 32];
1039 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1040 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1041 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1042 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1043 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1045 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1046 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1048 let payment_amt = 20_000;
1049 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap();
1050 let route_hints = vec![
1051 nodes[1].node.get_phantom_route_hints(),
1052 nodes[2].node.get_phantom_route_hints(),
1055 let invoice = ::utils::create_phantom_invoice::<EnforcingSigner, &test_utils::TestKeysInterface>(Some(payment_amt), Some(payment_hash), "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, Currency::BitcoinTestnet).unwrap();
1057 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1058 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1059 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1061 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1062 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1063 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1067 #[cfg(feature = "std")]
1068 fn create_phantom_invoice_with_description_hash() {
1069 let chanmon_cfgs = create_chanmon_cfgs(3);
1070 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1071 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1072 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1074 let payment_amt = 20_000;
1075 let route_hints = vec![
1076 nodes[1].node.get_phantom_route_hints(),
1077 nodes[2].node.get_phantom_route_hints(),
1080 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1081 let non_default_invoice_expiry_secs = 4200;
1082 let invoice = ::utils::create_phantom_invoice_with_description_hash::<
1083 EnforcingSigner, &test_utils::TestKeysInterface,
1085 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1086 route_hints, &nodes[1].keys_manager, Currency::BitcoinTestnet
1089 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1090 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1091 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1092 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1096 #[cfg(feature = "std")]
1097 fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1098 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1099 let seed_1 = [42 as u8; 32];
1100 let seed_2 = [43 as u8; 32];
1101 let cross_node_seed = [44 as u8; 32];
1102 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1103 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1104 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1105 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1106 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1108 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1109 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1111 let mut scid_aliases = HashSet::new();
1112 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1113 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1115 match_multi_node_invoice_routes(
1118 vec![&nodes[1], &nodes[2],],
1125 #[cfg(feature = "std")]
1126 fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1127 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1128 let seed_1 = [42 as u8; 32];
1129 let seed_2 = [43 as u8; 32];
1130 let cross_node_seed = [44 as u8; 32];
1131 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1132 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1133 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1134 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1135 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1137 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1138 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1139 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());
1141 let mut scid_aliases = HashSet::new();
1142 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1143 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1144 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1146 match_multi_node_invoice_routes(
1149 vec![&nodes[2], &nodes[3],],
1156 #[cfg(feature = "std")]
1157 fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1158 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1159 let seed_1 = [42 as u8; 32];
1160 let seed_2 = [43 as u8; 32];
1161 let cross_node_seed = [44 as u8; 32];
1162 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1163 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1164 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1165 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1166 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1168 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1169 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1171 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1172 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1173 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1174 let mut private_chan_cfg = UserConfig::default();
1175 private_chan_cfg.channel_handshake_config.announced_channel = false;
1176 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();
1177 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1178 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
1179 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1180 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
1182 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1184 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1185 confirm_transaction_at(&nodes[1], &tx, conf_height);
1186 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1187 confirm_transaction_at(&nodes[3], &tx, conf_height);
1188 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1189 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1190 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()));
1191 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1192 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1193 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1195 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1196 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1197 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1198 let mut scid_aliases = HashSet::new();
1199 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1200 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1202 match_multi_node_invoice_routes(
1205 vec![&nodes[2], &nodes[3],],
1212 #[cfg(feature = "std")]
1213 fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1214 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1215 let seed_1 = [42 as u8; 32];
1216 let seed_2 = [43 as u8; 32];
1217 let cross_node_seed = [44 as u8; 32];
1218 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1219 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1220 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1221 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1222 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1224 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1226 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1227 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1228 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1230 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1231 // `chan_0_2` as `nodes[2]` only has public channels.
1232 let mut scid_aliases = HashSet::new();
1233 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1235 match_multi_node_invoice_routes(
1238 vec![&nodes[1], &nodes[2],],
1245 #[cfg(feature = "std")]
1246 fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1247 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1248 let seed_1 = [42 as u8; 32];
1249 let seed_2 = [43 as u8; 32];
1250 let cross_node_seed = [44 as u8; 32];
1251 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1252 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1253 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1254 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1255 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1257 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1258 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1259 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1260 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1262 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1264 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1265 // channels for `nodes[2]` as it contains a mix of public and private channels.
1266 let mut scid_aliases = HashSet::new();
1267 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1269 match_multi_node_invoice_routes(
1272 vec![&nodes[2], &nodes[3],],
1279 #[cfg(feature = "std")]
1280 fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() {
1281 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1282 let seed_1 = [42 as u8; 32];
1283 let seed_2 = [43 as u8; 32];
1284 let cross_node_seed = [44 as u8; 32];
1285 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1286 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1287 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1288 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1289 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1291 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());
1292 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());
1293 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());
1294 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1296 let mut scid_aliases = HashSet::new();
1297 scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap());
1298 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1300 match_multi_node_invoice_routes(
1303 vec![&nodes[1], &nodes[2],],
1310 #[cfg(feature = "std")]
1311 fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1312 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1313 let seed_1 = [42 as u8; 32];
1314 let seed_2 = [43 as u8; 32];
1315 let cross_node_seed = [44 as u8; 32];
1316 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1317 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1318 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1319 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1320 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1322 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());
1323 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());
1324 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());
1326 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1327 let mut scid_aliases_99_000_001_msat = HashSet::new();
1328 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1329 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1331 match_multi_node_invoice_routes(
1334 vec![&nodes[2], &nodes[3],],
1335 scid_aliases_99_000_001_msat,
1339 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1340 let mut scid_aliases_99_000_000_msat = HashSet::new();
1341 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1342 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1343 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1345 match_multi_node_invoice_routes(
1348 vec![&nodes[2], &nodes[3],],
1349 scid_aliases_99_000_000_msat,
1353 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1354 // `nodes[2]` them should be included.
1355 let mut scid_aliases_300_000_000_msat = HashSet::new();
1356 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1357 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1358 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1360 match_multi_node_invoice_routes(
1363 vec![&nodes[2], &nodes[3],],
1364 scid_aliases_300_000_000_msat,
1368 // Since the no specified amount, all channels should included.
1369 let mut scid_aliases_no_specified_amount = HashSet::new();
1370 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1371 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1372 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1374 match_multi_node_invoice_routes(
1377 vec![&nodes[2], &nodes[3],],
1378 scid_aliases_no_specified_amount,
1383 #[cfg(feature = "std")]
1384 fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1385 invoice_amt: Option<u64>,
1386 invoice_node: &Node<'a, 'b, 'c>,
1387 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1388 mut chan_ids_to_match: HashSet<u64>,
1389 nodes_contains_public_channels: bool
1391 let phantom_route_hints = network_multi_nodes.iter()
1392 .map(|node| node.node.get_phantom_route_hints())
1393 .collect::<Vec<PhantomRouteHints>>();
1394 let phantom_scids = phantom_route_hints.iter()
1395 .map(|route_hint| route_hint.phantom_scid)
1396 .collect::<HashSet<u64>>();
1398 let invoice = ::utils::create_phantom_invoice::<EnforcingSigner, &test_utils::TestKeysInterface>(invoice_amt, None, "test".to_string(), 3600, phantom_route_hints, &invoice_node.keys_manager, Currency::BitcoinTestnet).unwrap();
1400 let invoice_hints = invoice.private_routes();
1402 for hint in invoice_hints {
1403 let hints = &(hint.0).0;
1406 assert!(nodes_contains_public_channels);
1407 let phantom_scid = hints[0].short_channel_id;
1408 assert!(phantom_scids.contains(&phantom_scid));
1411 let hint_short_chan_id = hints[0].short_channel_id;
1412 assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1413 let phantom_scid = hints[1].short_channel_id;
1414 assert!(phantom_scids.contains(&phantom_scid));
1416 _ => panic!("Incorrect hint length generated")
1419 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);