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