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