_ Git - rust-lightning/blob - 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::{Payer, ScoringRouter};
   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};
  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::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
  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<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::<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<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::<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<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<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 239         channelmanager: &ChannelManager<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<<K::Target as KeysInterface>::Signer>,
 244         T::Target: BroadcasterInterface,
 245         K::Target: KeysInterface,
 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<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 269         channelmanager: &ChannelManager<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<<K::Target as KeysInterface>::Signer>,
 275         T::Target: BroadcasterInterface,
 276         K::Target: KeysInterface,
 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<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 296         channelmanager: &ChannelManager<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<<K::Target as KeysInterface>::Signer>,
 302         T::Target: BroadcasterInterface,
 303         K::Target: KeysInterface,
 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<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 318         channelmanager: &ChannelManager<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<<K::Target as KeysInterface>::Signer>,
 324         T::Target: BroadcasterInterface,
 325         K::Target: KeysInterface,
 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<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 339         channelmanager: &ChannelManager<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<<K::Target as KeysInterface>::Signer>,
 345         T::Target: BroadcasterInterface,
 346         K::Target: KeysInterface,
 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, first_hops: Option<&[&ChannelDetails]>,
 556                 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
 572 impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
 573         L::Target: Logger,
 574         S::Target: for <'a> LockableScore<'a>,
 575 {
 576         fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 577                 self.scorer.lock().payment_path_failed(path, short_channel_id);
 578         }
 579
 580         fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 581                 self.scorer.lock().payment_path_successful(path);
 582         }
 583
 584         fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 585                 self.scorer.lock().probe_successful(path);
 586         }
 587
 588         fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 589                 self.scorer.lock().probe_failed(path, short_channel_id);
 590         }
 591 }
 592
 593 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
 594 where
 595         M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
 596         T::Target: BroadcasterInterface,
 597         K::Target: KeysInterface,
 598         F::Target: FeeEstimator,
 599         L::Target: Logger,
 600 {
 601         fn node_id(&self) -> PublicKey {
 602                 self.get_our_node_id()
 603         }
 604
 605         fn first_hops(&self) -> Vec<ChannelDetails> {
 606                 self.list_usable_channels()
 607         }
 608
 609         fn send_payment(
 610                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 611                 payment_id: PaymentId
 612         ) -> Result<(), PaymentSendFailure> {
 613                 self.send_payment(route, payment_hash, payment_secret, payment_id)
 614         }
 615
 616         fn send_spontaneous_payment(
 617                 &self, route: &Route, payment_preimage: PaymentPreimage, payment_id: PaymentId,
 618         ) -> Result<(), PaymentSendFailure> {
 619                 self.send_spontaneous_payment(route, Some(payment_preimage), payment_id).map(|_| ())
 620         }
 621
 622         fn retry_payment(
 623                 &self, route: &Route, payment_id: PaymentId
 624         ) -> Result<(), PaymentSendFailure> {
 625                 self.retry_payment(route, payment_id)
 626         }
 627
 628         fn abandon_payment(&self, payment_id: PaymentId) {
 629                 self.abandon_payment(payment_id)
 630         }
 631 }
 632
 633
 634 /// Used to store information about all the HTLCs that are inflight across all payment attempts.
 635 pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
 636         scorer: &'a mut S,
 637         /// Maps a channel's short channel id and its direction to the liquidity used up.
 638         inflight_htlcs: InFlightHtlcs,
 639 }
 640
 641 impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
 642         pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 643                 ScorerAccountingForInFlightHtlcs {
 644                         scorer,
 645                         inflight_htlcs
 646                 }
 647         }
 648 }
 649
 650 #[cfg(c_bindings)]
 651 impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
 652         fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
 653 }
 654
 655 impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
 656         fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 657                 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 658                         source, target, short_channel_id
 659                 ) {
 660                         let usage = ChannelUsage {
 661                                 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 662                                 ..usage
 663                         };
 664
 665                         self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 666                 } else {
 667                         self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 668                 }
 669         }
 670
 671         fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
 672
 673         fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
 674
 675         fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }
 676
 677         fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
 678 }
 679
 680
 681 #[cfg(test)]
 682 mod test {
 683         use core::time::Duration;
 684         use crate::{Currency, Description, InvoiceDescription};
 685         use bitcoin_hashes::Hash;
 686         use bitcoin_hashes::sha256::Hash as Sha256;
 687         use lightning::chain::keysinterface::PhantomKeysManager;
 688         use lightning::ln::{PaymentPreimage, PaymentHash};
 689         use lightning::ln::channelmanager::{self, PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY, PaymentId};
 690         use lightning::ln::functional_test_utils::*;
 691         use lightning::ln::msgs::ChannelMessageHandler;
 692         use lightning::routing::router::{PaymentParameters, RouteParameters, find_route};
 693         use lightning::util::events::{MessageSendEvent, MessageSendEventsProvider, Event};
 694         use lightning::util::test_utils;
 695         use lightning::util::config::UserConfig;
 696         use lightning::chain::keysinterface::KeysInterface;
 697         use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
 698         use std::collections::HashSet;
 699
 700         #[test]
 701         fn test_from_channelmanager() {
 702                 let chanmon_cfgs = create_chanmon_cfgs(2);
 703                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 704                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 705                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 706                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 707                 let non_default_invoice_expiry_secs = 4200;
 708                 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
 709                         &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
 710                         Some(10_000), "test".to_string(), Duration::from_secs(1234567),
 711                         non_default_invoice_expiry_secs).unwrap();
 712                 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
 713                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
 714                 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
 715                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
 716
 717                 // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is
 718                 // available.
 719                 let chan = &nodes[1].node.list_usable_channels()[0];
 720                 assert_eq!(invoice.route_hints().len(), 1);
 721                 assert_eq!(invoice.route_hints()[0].0.len(), 1);
 722                 assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, chan.inbound_scid_alias.unwrap());
 723
 724                 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan.inbound_htlc_minimum_msat);
 725                 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan.inbound_htlc_maximum_msat);
 726
 727                 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
 728                         .with_features(invoice.features().unwrap().clone())
 729                         .with_route_hints(invoice.route_hints());
 730                 let route_params = RouteParameters {
 731                         payment_params,
 732                         final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 733                         final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
 734                 };
 735                 let first_hops = nodes[0].node.list_usable_channels();
 736                 let network_graph = &node_cfgs[0].network_graph;
 737                 let logger = test_utils::TestLogger::new();
 738                 let scorer = test_utils::TestScorer::with_penalty(0);
 739                 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
 740                 let route = find_route(
 741                         &nodes[0].node.get_our_node_id(), &route_params, &network_graph,
 742                         Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
 743                 ).unwrap();
 744
 745                 let payment_event = {
 746                         let mut payment_hash = PaymentHash([0; 32]);
 747                         payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
 748                         nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
 749                         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 750                         assert_eq!(added_monitors.len(), 1);
 751                         added_monitors.clear();
 752
 753                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 754                         assert_eq!(events.len(), 1);
 755                         SendEvent::from_event(events.remove(0))
 756
 757                 };
 758                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 759                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
 760                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 761                 assert_eq!(added_monitors.len(), 1);
 762                 added_monitors.clear();
 763                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 764                 assert_eq!(events.len(), 2);
 765         }
 766
 767         #[test]
 768         fn test_create_invoice_with_description_hash() {
 769                 let chanmon_cfgs = create_chanmon_cfgs(2);
 770                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 771                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 772                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 773                 let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes()));
 774                 let invoice = crate::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
 775                         &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::BitcoinTestnet,
 776                         Some(10_000), description_hash, Duration::from_secs(1234567), 3600
 777                 ).unwrap();
 778                 assert_eq!(invoice.amount_pico_btc(), Some(100_000));
 779                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
 780                 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes()))));
 781         }
 782
 783         #[test]
 784         fn test_hints_includes_single_channels_to_nodes() {
 785                 let chanmon_cfgs = create_chanmon_cfgs(3);
 786                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 787                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 788                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 789
 790                 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 791                 let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 792
 793                 let mut scid_aliases = HashSet::new();
 794                 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
 795                 scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap());
 796
 797                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
 798         }
 799
 800         #[test]
 801         fn test_hints_has_only_highest_inbound_capacity_channel() {
 802                 let chanmon_cfgs = create_chanmon_cfgs(2);
 803                 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 804                 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 805                 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 806                 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());
 807                 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());
 808                 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());
 809
 810                 let mut scid_aliases = HashSet::new();
 811                 scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap());
 812
 813                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
 814         }
 815
 816         #[test]
 817         fn test_hints_has_only_online_channels() {
 818                 let chanmon_cfgs = create_chanmon_cfgs(4);
 819                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 820                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 821                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 822                 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());
 823                 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());
 824                 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());
 825
 826                 // With all peers connected we should get all hints that have sufficient value
 827                 let mut scid_aliases = HashSet::new();
 828                 scid_aliases.insert(chan_a.0.short_channel_id_alias.unwrap());
 829                 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
 830
 831                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
 832
 833                 // With only one sufficient-value peer connected we should only get its hint
 834                 scid_aliases.remove(&chan_b.0.short_channel_id_alias.unwrap());
 835                 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
 836                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases.clone());
 837
 838                 // If we don't have any sufficient-value peers connected we should get all hints with
 839                 // sufficient value, even though there is a connected insufficient-value peer.
 840                 scid_aliases.insert(chan_b.0.short_channel_id_alias.unwrap());
 841                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 842                 match_invoice_routes(Some(1_000_000_000), &nodes[0], scid_aliases);
 843         }
 844
 845         #[test]
 846         fn test_forwarding_info_not_assigned_channel_excluded_from_hints() {
 847                 let chanmon_cfgs = create_chanmon_cfgs(3);
 848                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 849                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 850                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 851                 let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 852
 853                 // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the
 854                 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
 855                 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
 856                 let mut private_chan_cfg = UserConfig::default();
 857                 private_chan_cfg.channel_handshake_config.announced_channel = false;
 858                 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();
 859                 let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
 860                 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
 861                 let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id());
 862                 nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
 863
 864                 let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id);
 865
 866                 let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1);
 867                 confirm_transaction_at(&nodes[2], &tx, conf_height);
 868                 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
 869                 confirm_transaction_at(&nodes[0], &tx, conf_height);
 870                 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 871                 let as_channel_ready = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
 872                 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()));
 873                 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
 874                 nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
 875                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
 876                 expect_channel_ready_event(&nodes[0], &nodes[2].node.get_our_node_id());
 877                 expect_channel_ready_event(&nodes[2], &nodes[0].node.get_our_node_id());
 878
 879                 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
 880                 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
 881                 // Therefore only `chan_1_0` should be included in the hints.
 882                 let mut scid_aliases = HashSet::new();
 883                 scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap());
 884                 match_invoice_routes(Some(5000), &nodes[0], scid_aliases);
 885         }
 886
 887         #[test]
 888         fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() {
 889                 let chanmon_cfgs = create_chanmon_cfgs(3);
 890                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 891                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 892                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 893                 let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 894
 895                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 896                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
 897                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
 898
 899                 // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels,
 900                 // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a
 901                 // public channel between `nodes[2]` and `nodes[0]`
 902                 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
 903         }
 904
 905         #[test]
 906         fn test_only_public_channels_includes_no_channels_in_hints() {
 907                 let chanmon_cfgs = create_chanmon_cfgs(3);
 908                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 909                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 910                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 911                 let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 912                 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0);
 913                 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1);
 914
 915                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 916                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
 917                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
 918
 919                 // As all of `nodes[0]` channels are public, no channels should be included in the hints
 920                 match_invoice_routes(Some(5000), &nodes[0], HashSet::new());
 921         }
 922
 923         #[test]
 924         fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() {
 925                 let chanmon_cfgs = create_chanmon_cfgs(3);
 926                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 927                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 928                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 929                 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());
 930                 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());
 931
 932                 // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included
 933                 let mut scid_aliases_99_000_001_msat = HashSet::new();
 934                 scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
 935
 936                 match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat);
 937
 938                 // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included
 939                 let mut scid_aliases_99_000_000_msat = HashSet::new();
 940                 scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
 941                 scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
 942
 943                 match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat);
 944
 945                 // As the invoice amt is above all channels' inbound capacity, they will still be included
 946                 let mut scid_aliases_2_000_000_000_msat = HashSet::new();
 947                 scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap());
 948                 scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap());
 949
 950                 match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat);
 951
 952                 // An invoice with no specified amount should include all channels in the route hints.
 953                 let mut scid_aliases_no_specified_amount = HashSet::new();
 954                 scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap());
 955                 scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap());
 956
 957                 match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount);
 958         }
 959
 960         fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
 961                 invoice_amt: Option<u64>,
 962                 invoice_node: &Node<'a, 'b, 'c>,
 963                 mut chan_ids_to_match: HashSet<u64>
 964         ) {
 965                 let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
 966                         &invoice_node.node, invoice_node.keys_manager, invoice_node.logger,
 967                         Currency::BitcoinTestnet, invoice_amt, "test".to_string(), Duration::from_secs(1234567),
 968                         3600).unwrap();
 969                 let hints = invoice.private_routes();
 970
 971                 for hint in hints {
 972                         let hint_short_chan_id = (hint.0).0[0].short_channel_id;
 973                         assert!(chan_ids_to_match.remove(&hint_short_chan_id));
 974                 }
 975                 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
 976         }
 977
 978         #[test]
 979         #[cfg(feature = "std")]
 980         fn test_multi_node_receive() {
 981                 do_test_multi_node_receive(true);
 982                 do_test_multi_node_receive(false);
 983         }
 984
 985         #[cfg(feature = "std")]
 986         fn do_test_multi_node_receive(user_generated_pmt_hash: bool) {
 987                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
 988                 let seed_1 = [42 as u8; 32];
 989                 let seed_2 = [43 as u8; 32];
 990                 let cross_node_seed = [44 as u8; 32];
 991                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
 992                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
 993                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 994                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 995                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 996                 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 997                 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1);
 998                 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0);
 999                 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1000                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1001                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1002
1003                 let payment_amt = 10_000;
1004                 let route_hints = vec![
1005                         nodes[1].node.get_phantom_route_hints(),
1006                         nodes[2].node.get_phantom_route_hints(),
1007                 ];
1008
1009                 let user_payment_preimage = PaymentPreimage([1; 32]);
1010                 let payment_hash = if user_generated_pmt_hash {
1011                         Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()))
1012                 } else {
1013                         None
1014                 };
1015                 let non_default_invoice_expiry_secs = 4200;
1016
1017                 let invoice =
1018                         crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(
1019                                 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
1020                                 route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
1021                         ).unwrap();
1022                 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
1023                 let payment_preimage = if user_generated_pmt_hash {
1024                         user_payment_preimage
1025                 } else {
1026                         nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap()
1027                 };
1028
1029                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1030                 assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string())));
1031                 assert_eq!(invoice.route_hints().len(), 2);
1032                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1033                 assert!(!invoice.features().unwrap().supports_basic_mpp());
1034
1035                 let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
1036                         .with_features(invoice.features().unwrap().clone())
1037                         .with_route_hints(invoice.route_hints());
1038                 let params = RouteParameters {
1039                         payment_params,
1040                         final_value_msat: invoice.amount_milli_satoshis().unwrap(),
1041                         final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
1042                 };
1043                 let first_hops = nodes[0].node.list_usable_channels();
1044                 let network_graph = &node_cfgs[0].network_graph;
1045                 let logger = test_utils::TestLogger::new();
1046                 let scorer = test_utils::TestScorer::with_penalty(0);
1047                 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
1048                 let route = find_route(
1049                         &nodes[0].node.get_our_node_id(), &params, &network_graph,
1050                         Some(&first_hops.iter().collect::<Vec<_>>()), &logger, &scorer, &random_seed_bytes
1051                 ).unwrap();
1052                 let (payment_event, fwd_idx) = {
1053                         let mut payment_hash = PaymentHash([0; 32]);
1054                         payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
1055                         nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone()), PaymentId(payment_hash.0)).unwrap();
1056                         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1057                         assert_eq!(added_monitors.len(), 1);
1058                         added_monitors.clear();
1059
1060                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1061                         assert_eq!(events.len(), 1);
1062                         let fwd_idx = match events[0] {
1063                                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
1064                                         if node_id == nodes[1].node.get_our_node_id() {
1065                                                 1
1066                                         } else { 2 }
1067                                 },
1068                                 _ => panic!("Unexpected event")
1069                         };
1070                         (SendEvent::from_event(events.remove(0)), fwd_idx)
1071                 };
1072                 nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1073                 commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
1074
1075                 // Note that we have to "forward pending HTLCs" twice before we see the PaymentReceived as
1076                 // this "emulates" the payment taking two hops, providing some privacy to make phantom node
1077                 // payments "look real" by taking more time.
1078                 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1079                 nodes[fwd_idx].node.process_pending_htlc_forwards();
1080                 expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
1081                 nodes[fwd_idx].node.process_pending_htlc_forwards();
1082
1083                 let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
1084                 expect_payment_received!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt);
1085                 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage);
1086                 let events = nodes[0].node.get_and_clear_pending_events();
1087                 assert_eq!(events.len(), 2);
1088                 match events[0] {
1089                         Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1090                                 assert_eq!(payment_preimage, *ev_preimage);
1091                                 assert_eq!(payment_hash, *ev_hash);
1092                                 assert_eq!(fee_paid_msat, &Some(0));
1093                         },
1094                         _ => panic!("Unexpected event")
1095                 }
1096                 match events[1] {
1097                         Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1098                                 assert_eq!(hash, Some(payment_hash));
1099                         },
1100                         _ => panic!("Unexpected event")
1101                 }
1102         }
1103
1104         #[test]
1105         #[cfg(feature = "std")]
1106         fn test_multi_node_hints_has_htlc_min_max_values() {
1107                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1108                 let seed_1 = [42 as u8; 32];
1109                 let seed_2 = [43 as u8; 32];
1110                 let cross_node_seed = [44 as u8; 32];
1111                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1112                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1113                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1114                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1115                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1116
1117                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1118                 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1119
1120                 let payment_amt = 20_000;
1121                 let (payment_hash, _payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap();
1122                 let route_hints = vec![
1123                         nodes[1].node.get_phantom_route_hints(),
1124                         nodes[2].node.get_phantom_route_hints(),
1125                 ];
1126
1127                 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash), "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet).unwrap();
1128
1129                 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
1130                 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
1131                 assert_eq!(invoice.route_hints()[0].0[0].htlc_maximum_msat, chan_0_1.inbound_htlc_maximum_msat);
1132
1133                 let chan_0_2 = &nodes[2].node.list_usable_channels()[0];
1134                 assert_eq!(invoice.route_hints()[1].0[0].htlc_minimum_msat, chan_0_2.inbound_htlc_minimum_msat);
1135                 assert_eq!(invoice.route_hints()[1].0[0].htlc_maximum_msat, chan_0_2.inbound_htlc_maximum_msat);
1136         }
1137
1138         #[test]
1139         #[cfg(feature = "std")]
1140         fn create_phantom_invoice_with_description_hash() {
1141                 let chanmon_cfgs = create_chanmon_cfgs(3);
1142                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1143                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1144                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1145
1146                 let payment_amt = 20_000;
1147                 let route_hints = vec![
1148                         nodes[1].node.get_phantom_route_hints(),
1149                         nodes[2].node.get_phantom_route_hints(),
1150                 ];
1151
1152                 let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes()));
1153                 let non_default_invoice_expiry_secs = 4200;
1154                 let invoice = crate::utils::create_phantom_invoice_with_description_hash::<
1155                         &test_utils::TestKeysInterface, &test_utils::TestLogger,
1156                 >(
1157                         Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
1158                         route_hints, &nodes[1].keys_manager, &nodes[1].logger, Currency::BitcoinTestnet
1159                 )
1160                 .unwrap();
1161                 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
1162                 assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64);
1163                 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
1164                 assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes()))));
1165         }
1166
1167         #[test]
1168         #[cfg(feature = "std")]
1169         fn test_multi_node_hints_includes_single_channels_to_participating_nodes() {
1170                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1171                 let seed_1 = [42 as u8; 32];
1172                 let seed_2 = [43 as u8; 32];
1173                 let cross_node_seed = [44 as u8; 32];
1174                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1175                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1176                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1177                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1178                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1179
1180                 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1181                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1182
1183                 let mut scid_aliases = HashSet::new();
1184                 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1185                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1186
1187                 match_multi_node_invoice_routes(
1188                         Some(10_000),
1189                         &nodes[1],
1190                         vec![&nodes[1], &nodes[2],],
1191                         scid_aliases,
1192                         false
1193                 );
1194         }
1195
1196         #[test]
1197         #[cfg(feature = "std")]
1198         fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() {
1199                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1200                 let seed_1 = [42 as u8; 32];
1201                 let seed_2 = [43 as u8; 32];
1202                 let cross_node_seed = [44 as u8; 32];
1203                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1204                 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1205                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1206                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1207                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1208
1209                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1210                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1211                 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());
1212
1213                 let mut scid_aliases = HashSet::new();
1214                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1215                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1216                 scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1217
1218                 match_multi_node_invoice_routes(
1219                         Some(10_000),
1220                         &nodes[2],
1221                         vec![&nodes[2], &nodes[3],],
1222                         scid_aliases,
1223                         false
1224                 );
1225         }
1226
1227         #[test]
1228         #[cfg(feature = "std")]
1229         fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() {
1230                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1231                 let seed_1 = [42 as u8; 32];
1232                 let seed_2 = [43 as u8; 32];
1233                 let cross_node_seed = [44 as u8; 32];
1234                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1235                 chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1236                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1237                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1238                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1239
1240                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1241                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1242
1243                 // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the
1244                 // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate`
1245                 // is never handled, the `channel.counterparty.forwarding_info` is never assigned.
1246                 let mut private_chan_cfg = UserConfig::default();
1247                 private_chan_cfg.channel_handshake_config.announced_channel = false;
1248                 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();
1249                 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id());
1250                 nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
1251                 let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
1252                 nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
1253
1254                 let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id);
1255
1256                 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1);
1257                 confirm_transaction_at(&nodes[1], &tx, conf_height);
1258                 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
1259                 confirm_transaction_at(&nodes[3], &tx, conf_height);
1260                 connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1);
1261                 let as_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[3].node.get_our_node_id());
1262                 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()));
1263                 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
1264                 nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
1265                 get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1266                 expect_channel_ready_event(&nodes[1], &nodes[3].node.get_our_node_id());
1267                 expect_channel_ready_event(&nodes[3], &nodes[1].node.get_our_node_id());
1268
1269                 // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
1270                 // channel, the channel will never be assigned any `counterparty.forwarding_info`.
1271                 // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`.
1272                 let mut scid_aliases = HashSet::new();
1273                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1274                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1275
1276                 match_multi_node_invoice_routes(
1277                         Some(10_000),
1278                         &nodes[2],
1279                         vec![&nodes[2], &nodes[3],],
1280                         scid_aliases,
1281                         false
1282                 );
1283         }
1284
1285         #[test]
1286         #[cfg(feature = "std")]
1287         fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() {
1288                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1289                 let seed_1 = [42 as u8; 32];
1290                 let seed_2 = [43 as u8; 32];
1291                 let cross_node_seed = [44 as u8; 32];
1292                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1293                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1294                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1295                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1296                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1297
1298                 let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1299
1300                 let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1301                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
1302                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
1303
1304                 // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not
1305                 // `chan_0_2` as `nodes[2]` only has public channels.
1306                 let mut scid_aliases = HashSet::new();
1307                 scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap());
1308
1309                 match_multi_node_invoice_routes(
1310                         Some(10_000),
1311                         &nodes[1],
1312                         vec![&nodes[1], &nodes[2],],
1313                         scid_aliases,
1314                         true
1315                 );
1316         }
1317
1318         #[test]
1319         #[cfg(feature = "std")]
1320         fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() {
1321                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1322                 let seed_1 = [42 as u8; 32];
1323                 let seed_2 = [43 as u8; 32];
1324                 let cross_node_seed = [44 as u8; 32];
1325                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1326                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1327                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1328                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1329                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1330
1331                 let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1332                 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1);
1333                 nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0);
1334                 let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1335
1336                 let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1337
1338                 // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no
1339                 // channels for `nodes[2]` as it contains a mix of public and private channels.
1340                 let mut scid_aliases = HashSet::new();
1341                 scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1342
1343                 match_multi_node_invoice_routes(
1344                         Some(10_000),
1345                         &nodes[2],
1346                         vec![&nodes[2], &nodes[3],],
1347                         scid_aliases,
1348                         true
1349                 );
1350         }
1351
1352         #[test]
1353         #[cfg(feature = "std")]
1354         fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() {
1355                 let mut chanmon_cfgs = create_chanmon_cfgs(3);
1356                 let seed_1 = [42 as u8; 32];
1357                 let seed_2 = [43 as u8; 32];
1358                 let cross_node_seed = [44 as u8; 32];
1359                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1360                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1361                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1362                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1363                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1364
1365                 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());
1366                 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());
1367                 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());
1368                 let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1369
1370                 let mut scid_aliases = HashSet::new();
1371                 scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap());
1372                 scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1373
1374                 match_multi_node_invoice_routes(
1375                         Some(10_000),
1376                         &nodes[1],
1377                         vec![&nodes[1], &nodes[2],],
1378                         scid_aliases,
1379                         false
1380                 );
1381         }
1382
1383         #[test]
1384         #[cfg(feature = "std")]
1385         fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() {
1386                 let mut chanmon_cfgs = create_chanmon_cfgs(4);
1387                 let seed_1 = [42 as u8; 32];
1388                 let seed_2 = [43 as u8; 32];
1389                 let cross_node_seed = [44 as u8; 32];
1390                 chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed);
1391                 chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed);
1392                 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1393                 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1394                 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1395
1396                 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());
1397                 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());
1398                 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());
1399
1400                 // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out.
1401                 let mut scid_aliases_99_000_001_msat = HashSet::new();
1402                 scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1403                 scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1404
1405                 match_multi_node_invoice_routes(
1406                         Some(99_000_001),
1407                         &nodes[2],
1408                         vec![&nodes[2], &nodes[3],],
1409                         scid_aliases_99_000_001_msat,
1410                         false
1411                 );
1412
1413                 // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included.
1414                 let mut scid_aliases_99_000_000_msat = HashSet::new();
1415                 scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1416                 scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1417                 scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1418
1419                 match_multi_node_invoice_routes(
1420                         Some(99_000_000),
1421                         &nodes[2],
1422                         vec![&nodes[2], &nodes[3],],
1423                         scid_aliases_99_000_000_msat,
1424                         false
1425                 );
1426
1427                 // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of
1428                 // `nodes[2]` them should be included.
1429                 let mut scid_aliases_300_000_000_msat = HashSet::new();
1430                 scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1431                 scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1432                 scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1433
1434                 match_multi_node_invoice_routes(
1435                         Some(300_000_000),
1436                         &nodes[2],
1437                         vec![&nodes[2], &nodes[3],],
1438                         scid_aliases_300_000_000_msat,
1439                         false
1440                 );
1441
1442                 // Since the no specified amount, all channels should included.
1443                 let mut scid_aliases_no_specified_amount = HashSet::new();
1444                 scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap());
1445                 scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap());
1446                 scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap());
1447
1448                 match_multi_node_invoice_routes(
1449                         None,
1450                         &nodes[2],
1451                         vec![&nodes[2], &nodes[3],],
1452                         scid_aliases_no_specified_amount,
1453                         false
1454                 );
1455         }
1456
1457         #[cfg(feature = "std")]
1458         fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>(
1459                 invoice_amt: Option<u64>,
1460                 invoice_node: &Node<'a, 'b, 'c>,
1461                 network_multi_nodes: Vec<&Node<'a, 'b, 'c>>,
1462                 mut chan_ids_to_match: HashSet<u64>,
1463                 nodes_contains_public_channels: bool
1464         ){
1465                 let phantom_route_hints = network_multi_nodes.iter()
1466                         .map(|node| node.node.get_phantom_route_hints())
1467                         .collect::<Vec<PhantomRouteHints>>();
1468                 let phantom_scids = phantom_route_hints.iter()
1469                         .map(|route_hint| route_hint.phantom_scid)
1470                         .collect::<HashSet<u64>>();
1471
1472                 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(), 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.logger, Currency::BitcoinTestnet).unwrap();
1473
1474                 let invoice_hints = invoice.private_routes();
1475
1476                 for hint in invoice_hints {
1477                         let hints = &(hint.0).0;
1478                         match hints.len() {
1479                                 1 => {
1480                                         assert!(nodes_contains_public_channels);
1481                                         let phantom_scid = hints[0].short_channel_id;
1482                                         assert!(phantom_scids.contains(&phantom_scid));
1483                                 },
1484                                 2 => {
1485                                         let hint_short_chan_id = hints[0].short_channel_id;
1486                                         assert!(chan_ids_to_match.remove(&hint_short_chan_id));
1487                                         let phantom_scid = hints[1].short_channel_id;
1488                                         assert!(phantom_scids.contains(&phantom_scid));
1489                                 },
1490                                 _ => panic!("Incorrect hint length generated")
1491                         }
1492                 }
1493                 assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match);
1494         }
1495 }