X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-invoice%2Fsrc%2Futils.rs;h=62820cfe11007027ecc2ec7802a5a4946767e1c6;hb=d0a1b2b220bc646953d64e3226cdc3cf35b79f14;hp=409fa803cab9cac20f423e21483d0bf58d8face8;hpb=35573bb3d7bf8c7f7b9d8759afa555aec2735a44;p=rust-lightning diff --git a/lightning-invoice/src/utils.rs b/lightning-invoice/src/utils.rs index 409fa803..62820cfe 100644 --- a/lightning-invoice/src/utils.rs +++ b/lightning-invoice/src/utils.rs @@ -1,17 +1,174 @@ //! Convenient utilities to create an invoice. -use {Currency, DEFAULT_EXPIRY_TIME, Invoice, InvoiceBuilder, SignOrCreationError, RawInvoice}; + +use {CreationError, Currency, DEFAULT_EXPIRY_TIME, Invoice, InvoiceBuilder, SignOrCreationError}; +use payment::{Payer, Router}; + +use crate::{prelude::*, Description, InvoiceDescription, Sha256}; use bech32::ToBase32; -use bitcoin_hashes::Hash; +use bitcoin_hashes::{Hash, sha256}; use lightning::chain; use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator}; -use lightning::chain::keysinterface::{Sign, KeysInterface}; -use lightning::ln::channelmanager::{ChannelManager, MIN_FINAL_CLTV_EXPIRY}; -use lightning::routing::network_graph::RoutingFees; -use lightning::routing::router::{RouteHint, RouteHintHop}; +use lightning::chain::keysinterface::{Recipient, KeysInterface, Sign}; +use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret}; +use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY}; +#[cfg(feature = "std")] +use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA}; +use lightning::ln::msgs::LightningError; +use lightning::routing::scoring::Score; +use lightning::routing::network_graph::{NetworkGraph, RoutingFees}; +use lightning::routing::router::{Route, RouteHint, RouteHintHop, RouteParameters, find_route}; use lightning::util::logger::Logger; -use std::convert::TryInto; -use std::ops::Deref; +use secp256k1::key::PublicKey; +use core::convert::TryInto; +use core::ops::Deref; +use core::time::Duration; +use sync::Mutex; + +#[cfg(feature = "std")] +/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice." +/// See [`PhantomKeysManager`] for more information on phantom node payments. +/// +/// `phantom_route_hints` parameter: +/// * Contains channel info for all nodes participating in the phantom invoice +/// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each +/// participating node +/// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is +/// updated when a channel becomes disabled or closes +/// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice +/// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared +/// down +/// +/// `payment_hash` and `payment_secret` come from [`ChannelManager::create_inbound_payment`] or +/// [`ChannelManager::create_inbound_payment_for_hash`]. These values can be retrieved from any +/// participating node. +/// +/// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom +/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this +/// requirement). +/// +/// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager +/// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints +/// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels +pub fn create_phantom_invoice( + amt_msat: Option, description: String, payment_hash: PaymentHash, payment_secret: PaymentSecret, + phantom_route_hints: Vec, keys_manager: K, network: Currency, +) -> Result> where K::Target: KeysInterface { + let description = Description::new(description).map_err(SignOrCreationError::CreationError)?; + let description = InvoiceDescription::Direct(&description,); + _create_phantom_invoice::( + amt_msat, description, payment_hash, payment_secret, phantom_route_hints, keys_manager, network, + ) +} + +#[cfg(feature = "std")] +/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice." +/// See [`PhantomKeysManager`] for more information on phantom node payments. +/// +/// `phantom_route_hints` parameter: +/// * Contains channel info for all nodes participating in the phantom invoice +/// * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each +/// participating node +/// * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is +/// updated when a channel becomes disabled or closes +/// * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice +/// may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared +/// down +/// +/// `description_hash` is a SHA-256 hash of the description text +/// +/// `payment_hash` and `payment_secret` come from [`ChannelManager::create_inbound_payment`] or +/// [`ChannelManager::create_inbound_payment_for_hash`]. These values can be retrieved from any +/// participating node. +/// +/// Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom +/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this +/// requirement). +/// +/// [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager +/// [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints +/// [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels +pub fn create_phantom_invoice_with_description_hash( + amt_msat: Option, description_hash: Sha256, payment_hash: PaymentHash, + payment_secret: PaymentSecret, phantom_route_hints: Vec, + keys_manager: K, network: Currency, +) -> Result> where K::Target: KeysInterface +{ + + _create_phantom_invoice::( + amt_msat, + InvoiceDescription::Hash(&description_hash), + payment_hash, payment_secret, phantom_route_hints, keys_manager, network, + ) +} + +#[cfg(feature = "std")] +fn _create_phantom_invoice( + amt_msat: Option, description: InvoiceDescription, payment_hash: PaymentHash, + payment_secret: PaymentSecret, phantom_route_hints: Vec, + keys_manager: K, network: Currency, +) -> Result> where K::Target: KeysInterface +{ + if phantom_route_hints.len() == 0 { + return Err(SignOrCreationError::CreationError( + CreationError::MissingRouteHints, + )); + } + let invoice = match description { + InvoiceDescription::Direct(description) => { + InvoiceBuilder::new(network).description(description.0.clone()) + } + InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0), + }; + + let mut invoice = invoice + .current_timestamp() + .payment_hash(Hash::from_slice(&payment_hash.0).unwrap()) + .payment_secret(payment_secret) + .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into()); + if let Some(amt) = amt_msat { + invoice = invoice.amount_milli_satoshis(amt); + } + + for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints { + let mut route_hints = filter_channels(channels, amt_msat); + + // If we have any public channel, the route hints from `filter_channels` will be empty. + // In that case we create a RouteHint on which we will push a single hop with the phantom + // route into the invoice, and let the sender find the path to the `real_node_pubkey` + // node by looking at our public channels. + if route_hints.is_empty() { + route_hints.push(RouteHint(vec![])) + } + for mut route_hint in route_hints { + route_hint.0.push(RouteHintHop { + src_node_id: real_node_pubkey, + short_channel_id: phantom_scid, + fees: RoutingFees { + base_msat: 0, + proportional_millionths: 0, + }, + cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA, + htlc_minimum_msat: None, + htlc_maximum_msat: None,}); + invoice = invoice.private_route(route_hint.clone()); + } + } + let raw_invoice = match invoice.build_raw() { + Ok(inv) => inv, + Err(e) => return Err(SignOrCreationError::CreationError(e)) + }; + let hrp_str = raw_invoice.hrp.to_string(); + let hrp_bytes = hrp_str.as_bytes(); + let data_without_signature = raw_invoice.data.to_base32(); + let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::PhantomNode)); + match signed_raw_invoice { + Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()), + Err(e) => Err(SignOrCreationError::SignError(e)) + } +} + +#[cfg(feature = "std")] /// Utility to construct an invoice. Generally, unless you want to do something like a custom /// cltv_expiry, this is what you should be using to create an invoice. The reason being, this /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user @@ -28,40 +185,116 @@ where F::Target: FeeEstimator, L::Target: Logger, { - // Marshall route hints. - let our_channels = channelmanager.list_usable_channels(); - let mut route_hints = vec![]; - for channel in our_channels { - let short_channel_id = match channel.short_channel_id { - Some(id) => id, - None => continue, - }; - let forwarding_info = match channel.counterparty.forwarding_info { - Some(info) => info, - None => continue, - }; - route_hints.push(RouteHint(vec![RouteHintHop { - src_node_id: channel.counterparty.node_id, - short_channel_id, - fees: RoutingFees { - base_msat: forwarding_info.fee_base_msat, - proportional_millionths: forwarding_info.fee_proportional_millionths, - }, - cltv_expiry_delta: forwarding_info.cltv_expiry_delta, - htlc_minimum_msat: None, - htlc_maximum_msat: None, - }])); - } + use std::time::SystemTime; + let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH) + .expect("for the foreseeable future this shouldn't happen"); + create_invoice_from_channelmanager_and_duration_since_epoch( + channelmanager, keys_manager, network, amt_msat, description, duration + ) +} - let (payment_hash, payment_secret) = channelmanager.create_inbound_payment( - amt_msat, - DEFAULT_EXPIRY_TIME.try_into().unwrap(), - 0, - ); +#[cfg(feature = "std")] +/// Utility to construct an invoice. Generally, unless you want to do something like a custom +/// cltv_expiry, this is what you should be using to create an invoice. The reason being, this +/// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user +/// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify +/// that the payment secret is valid when the invoice is paid. +/// Use this variant if you want to pass the `description_hash` to the invoice. +pub fn create_invoice_from_channelmanager_with_description_hash( + channelmanager: &ChannelManager, keys_manager: K, network: Currency, + amt_msat: Option, description_hash: Sha256, +) -> Result> +where + M::Target: chain::Watch, + T::Target: BroadcasterInterface, + K::Target: KeysInterface, + F::Target: FeeEstimator, + L::Target: Logger, +{ + use std::time::SystemTime; + + let duration = SystemTime::now() + .duration_since(SystemTime::UNIX_EPOCH) + .expect("for the foreseeable future this shouldn't happen"); + + create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( + channelmanager, keys_manager, network, amt_msat, description_hash, duration, + ) +} + +/// See [`create_invoice_from_channelmanager_with_description_hash`] +/// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not +/// available and the current time is supplied by the caller. +pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( + channelmanager: &ChannelManager, keys_manager: K, network: Currency, + amt_msat: Option, description_hash: Sha256, duration_since_epoch: Duration, +) -> Result> +where + M::Target: chain::Watch, + T::Target: BroadcasterInterface, + K::Target: KeysInterface, + F::Target: FeeEstimator, + L::Target: Logger, +{ + _create_invoice_from_channelmanager_and_duration_since_epoch( + channelmanager, keys_manager, network, amt_msat, + InvoiceDescription::Hash(&description_hash), + duration_since_epoch, + ) +} + +/// See [`create_invoice_from_channelmanager`] +/// This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not +/// available and the current time is supplied by the caller. +pub fn create_invoice_from_channelmanager_and_duration_since_epoch( + channelmanager: &ChannelManager, keys_manager: K, network: Currency, + amt_msat: Option, description: String, duration_since_epoch: Duration, +) -> Result> +where + M::Target: chain::Watch, + T::Target: BroadcasterInterface, + K::Target: KeysInterface, + F::Target: FeeEstimator, + L::Target: Logger, +{ + _create_invoice_from_channelmanager_and_duration_since_epoch( + channelmanager, keys_manager, network, amt_msat, + InvoiceDescription::Direct( + &Description::new(description).map_err(SignOrCreationError::CreationError)?, + ), + duration_since_epoch, + ) +} + +fn _create_invoice_from_channelmanager_and_duration_since_epoch( + channelmanager: &ChannelManager, keys_manager: K, network: Currency, + amt_msat: Option, description: InvoiceDescription, duration_since_epoch: Duration, +) -> Result> +where + M::Target: chain::Watch, + T::Target: BroadcasterInterface, + K::Target: KeysInterface, + F::Target: FeeEstimator, + L::Target: Logger, +{ + let route_hints = filter_channels(channelmanager.list_usable_channels(), amt_msat); + + // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin + // supply. + let (payment_hash, payment_secret) = channelmanager + .create_inbound_payment(amt_msat, DEFAULT_EXPIRY_TIME.try_into().unwrap()) + .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?; let our_node_pubkey = channelmanager.get_our_node_id(); - let mut invoice = InvoiceBuilder::new(network) - .description(description) - .current_timestamp() + + let invoice = match description { + InvoiceDescription::Direct(description) => { + InvoiceBuilder::new(network).description(description.0.clone()) + } + InvoiceDescription::Hash(hash) => InvoiceBuilder::new(network).description_hash(hash.0), + }; + + let mut invoice = invoice + .duration_since_epoch(duration_since_epoch) .payee_pub_key(our_node_pubkey) .payment_hash(Hash::from_slice(&payment_hash.0).unwrap()) .payment_secret(payment_secret) @@ -81,52 +314,210 @@ where let hrp_str = raw_invoice.hrp.to_string(); let hrp_bytes = hrp_str.as_bytes(); let data_without_signature = raw_invoice.data.to_base32(); - let invoice_preimage = RawInvoice::construct_invoice_preimage(hrp_bytes, &data_without_signature); - let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(invoice_preimage)); + let signed_raw_invoice = raw_invoice.sign(|_| keys_manager.sign_invoice(hrp_bytes, &data_without_signature, Recipient::Node)); match signed_raw_invoice { Ok(inv) => Ok(Invoice::from_signed(inv).unwrap()), Err(e) => Err(SignOrCreationError::SignError(e)) } } +/// Filters the `channels` for an invoice, and returns the corresponding `RouteHint`s to include +/// in the invoice. +/// +/// The filtering is based on the following criteria: +/// * Only one channel per counterparty node +/// * Always select the channel with the highest inbound capacity per counterparty node +/// * Filter out channels with a lower inbound capacity than `min_inbound_capacity_msat`, if any +/// channel with a higher or equal inbound capacity than `min_inbound_capacity_msat` exists +/// * If any public channel exists, the returned `RouteHint`s will be empty, and the sender will +/// need to find the path by looking at the public channels instead +fn filter_channels(channels: Vec, min_inbound_capacity_msat: Option) -> Vec{ + let mut filtered_channels: HashMap = HashMap::new(); + let min_inbound_capacity = min_inbound_capacity_msat.unwrap_or(0); + let mut min_capacity_channel_exists = false; + + for channel in channels.iter() { + if channel.get_inbound_payment_scid().is_none() || channel.counterparty.forwarding_info.is_none() { + continue; + } + + if channel.is_public { + // If any public channel exists, return no hints and let the sender + // look at the public channels instead. + return vec![] + } + + if channel.inbound_capacity_msat >= min_inbound_capacity { + min_capacity_channel_exists = true; + }; + match filtered_channels.entry(channel.counterparty.node_id) { + hash_map::Entry::Occupied(mut entry) => { + let current_max_capacity = entry.get().inbound_capacity_msat; + if channel.inbound_capacity_msat < current_max_capacity { + continue; + } + entry.insert(channel); + } + hash_map::Entry::Vacant(entry) => { + entry.insert(channel); + } + } + } + + let route_hint_from_channel = |channel: &ChannelDetails| { + let forwarding_info = channel.counterparty.forwarding_info.as_ref().unwrap(); + RouteHint(vec![RouteHintHop { + src_node_id: channel.counterparty.node_id, + short_channel_id: channel.get_inbound_payment_scid().unwrap(), + fees: RoutingFees { + base_msat: forwarding_info.fee_base_msat, + proportional_millionths: forwarding_info.fee_proportional_millionths, + }, + cltv_expiry_delta: forwarding_info.cltv_expiry_delta, + htlc_minimum_msat: None, + htlc_maximum_msat: None,}]) + }; + // If all channels are private, return the route hint for the highest inbound capacity channel + // per counterparty node. If channels with an higher inbound capacity than the + // min_inbound_capacity exists, filter out the channels with a lower capacity than that. + filtered_channels.into_iter() + .filter(|(_counterparty_id, channel)| { + min_capacity_channel_exists && channel.inbound_capacity_msat >= min_inbound_capacity || + !min_capacity_channel_exists + }) + .map(|(_counterparty_id, channel)| route_hint_from_channel(&channel)) + .collect::>() +} + +/// A [`Router`] implemented using [`find_route`]. +pub struct DefaultRouter, L: Deref> where L::Target: Logger { + network_graph: G, + logger: L, + random_seed_bytes: Mutex<[u8; 32]>, +} + +impl, L: Deref> DefaultRouter where L::Target: Logger { + /// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source + /// `random_seed_bytes`. + pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32]) -> Self { + let random_seed_bytes = Mutex::new(random_seed_bytes); + Self { network_graph, logger, random_seed_bytes } + } +} + +impl, L: Deref, S: Score> Router for DefaultRouter +where L::Target: Logger { + fn find_route( + &self, payer: &PublicKey, params: &RouteParameters, _payment_hash: &PaymentHash, + first_hops: Option<&[&ChannelDetails]>, scorer: &S + ) -> Result { + let random_seed_bytes = { + let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap(); + *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner(); + *locked_random_seed_bytes + }; + find_route(payer, params, &*self.network_graph, first_hops, &*self.logger, scorer, &random_seed_bytes) + } +} + +impl Payer for ChannelManager +where + M::Target: chain::Watch, + T::Target: BroadcasterInterface, + K::Target: KeysInterface, + F::Target: FeeEstimator, + L::Target: Logger, +{ + fn node_id(&self) -> PublicKey { + self.get_our_node_id() + } + + fn first_hops(&self) -> Vec { + self.list_usable_channels() + } + + fn send_payment( + &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option + ) -> Result { + self.send_payment(route, payment_hash, payment_secret) + } + + fn send_spontaneous_payment( + &self, route: &Route, payment_preimage: PaymentPreimage, + ) -> Result { + self.send_spontaneous_payment(route, Some(payment_preimage)) + .map(|(_, payment_id)| payment_id) + } + + fn retry_payment( + &self, route: &Route, payment_id: PaymentId + ) -> Result<(), PaymentSendFailure> { + self.retry_payment(route, payment_id) + } + + fn abandon_payment(&self, payment_id: PaymentId) { + self.abandon_payment(payment_id) + } +} + #[cfg(test)] mod test { + use core::time::Duration; use {Currency, Description, InvoiceDescription}; - use lightning::ln::PaymentHash; - use lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY; + use bitcoin_hashes::Hash; + use bitcoin_hashes::sha256::Hash as Sha256; + use lightning::chain::keysinterface::PhantomKeysManager; + use lightning::ln::{PaymentPreimage, PaymentHash}; + use lightning::ln::channelmanager::{PhantomRouteHints, MIN_FINAL_CLTV_EXPIRY}; use lightning::ln::functional_test_utils::*; use lightning::ln::features::InitFeatures; use lightning::ln::msgs::ChannelMessageHandler; - use lightning::routing::router; - use lightning::util::events::MessageSendEventsProvider; + use lightning::routing::router::{PaymentParameters, RouteParameters, find_route}; + use lightning::util::enforcing_trait_impls::EnforcingSigner; + use lightning::util::events::{MessageSendEvent, MessageSendEventsProvider, Event}; use lightning::util::test_utils; + use lightning::util::config::UserConfig; + use lightning::chain::keysinterface::KeysInterface; + use utils::create_invoice_from_channelmanager_and_duration_since_epoch; + use std::collections::HashSet; + #[test] fn test_from_channelmanager() { let chanmon_cfgs = create_chanmon_cfgs(2); let node_cfgs = create_node_cfgs(2, &chanmon_cfgs); let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]); let nodes = create_network(2, &node_cfgs, &node_chanmgrs); - let _chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()); - let invoice = ::utils::create_invoice_from_channelmanager(&nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), "test".to_string()).unwrap(); + create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let invoice = create_invoice_from_channelmanager_and_duration_since_epoch( + &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), "test".to_string(), + Duration::from_secs(1234567)).unwrap(); assert_eq!(invoice.amount_pico_btc(), Some(100_000)); assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string()))); - let amt_msat = invoice.amount_pico_btc().unwrap() / 10; + // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is + // available. + assert_eq!(invoice.route_hints().len(), 1); + assert_eq!(invoice.route_hints()[0].0.len(), 1); + assert_eq!(invoice.route_hints()[0].0[0].short_channel_id, + nodes[1].node.list_usable_channels()[0].inbound_scid_alias.unwrap()); + + let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key()) + .with_features(invoice.features().unwrap().clone()) + .with_route_hints(invoice.route_hints()); + let route_params = RouteParameters { + payment_params, + final_value_msat: invoice.amount_milli_satoshis().unwrap(), + final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32, + }; let first_hops = nodes[0].node.list_usable_channels(); - let last_hops = invoice.route_hints(); - let network_graph = &nodes[0].net_graph_msg_handler.network_graph; + let network_graph = node_cfgs[0].network_graph; let logger = test_utils::TestLogger::new(); - let route = router::get_route( - &nodes[0].node.get_our_node_id(), - network_graph, - &invoice.recover_payee_pub_key(), - Some(invoice.features().unwrap().clone()), - Some(&first_hops.iter().collect::>()), - &last_hops, - amt_msat, - invoice.min_final_cltv_expiry() as u32, - &logger, + let scorer = test_utils::TestScorer::with_penalty(0); + let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes(); + let route = find_route( + &nodes[0].node.get_our_node_id(), &route_params, network_graph, + Some(&first_hops.iter().collect::>()), &logger, &scorer, &random_seed_bytes ).unwrap(); let payment_event = { @@ -150,4 +541,652 @@ mod test { let events = nodes[1].node.get_and_clear_pending_msg_events(); assert_eq!(events.len(), 2); } + + #[test] + fn test_create_invoice_with_description_hash() { + let chanmon_cfgs = create_chanmon_cfgs(2); + let node_cfgs = create_node_cfgs(2, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]); + let nodes = create_network(2, &node_cfgs, &node_chanmgrs); + let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes())); + let invoice = ::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( + &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), + description_hash, Duration::from_secs(1234567), + ).unwrap(); + assert_eq!(invoice.amount_pico_btc(), Some(100_000)); + assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); + assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Testing description_hash".as_bytes())))); + } + + #[test] + fn test_hints_includes_single_channels_to_nodes() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + + let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_2_0.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(Some(5000), &nodes[0], scid_aliases); + } + + #[test] + fn test_hints_has_only_highest_inbound_capacity_channel() { + let chanmon_cfgs = create_chanmon_cfgs(2); + let node_cfgs = create_node_cfgs(2, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]); + let nodes = create_network(2, &node_cfgs, &node_chanmgrs); + let _chan_1_0_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_1_0_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0, InitFeatures::known(), InitFeatures::known()); + let _chan_1_0_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 1_000_000, 0, InitFeatures::known(), InitFeatures::known()); + + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_1_0_high_inbound_capacity.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(Some(5000), &nodes[0], scid_aliases); + } + + #[test] + fn test_forwarding_info_not_assigned_channel_excluded_from_hints() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + // Create an unannonced channel between `nodes[2]` and `nodes[0]`, for which the + // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate` + // is never handled, the `channel.counterparty.forwarding_info` is never assigned. + let mut private_chan_cfg = UserConfig::default(); + private_chan_cfg.channel_options.announced_channel = false; + 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(); + let open_channel = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id()); + nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &open_channel); + let accept_channel = get_event_msg!(nodes[0], MessageSendEvent::SendAcceptChannel, nodes[2].node.get_our_node_id()); + nodes[2].node.handle_accept_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &accept_channel); + + let tx = sign_funding_transaction(&nodes[2], &nodes[0], 1_000_000, temporary_channel_id); + + let conf_height = core::cmp::max(nodes[2].best_block_info().1 + 1, nodes[0].best_block_info().1 + 1); + confirm_transaction_at(&nodes[2], &tx, conf_height); + connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1); + confirm_transaction_at(&nodes[0], &tx, conf_height); + connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1); + let as_funding_locked = get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()); + nodes[2].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id())); + get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id()); + nodes[0].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &as_funding_locked); + get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id()); + + // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second + // channel, the channel will never be assigned any `counterparty.forwarding_info`. + // Therefore only `chan_1_0` should be included in the hints. + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_1_0.0.short_channel_id_alias.unwrap()); + match_invoice_routes(Some(5000), &nodes[0], scid_aliases); + } + + #[test] + fn test_no_hints_if_a_mix_between_public_and_private_channel_exists() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + let _chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1); + nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0); + + // Ensure that the invoice doesn't include any route hints for any of `nodes[0]` channels, + // even though all channels between `nodes[1]` and `nodes[0]` are private, as there is a + // public channel between `nodes[2]` and `nodes[0]` + match_invoice_routes(Some(5000), &nodes[0], HashSet::new()); + } + + #[test] + fn test_only_public_channels_includes_no_channels_in_hints() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + let chan_1_0 = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0.0); + nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0.1); + + let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1); + nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0); + + // As all of `nodes[0]` channels are public, no channels should be included in the hints + match_invoice_routes(Some(5000), &nodes[0], HashSet::new()); + } + + #[test] + fn test_channels_with_lower_inbound_capacity_than_invoice_amt_hints_filtering() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + let chan_1_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_2_0 = create_unannounced_chan_between_nodes_with_value(&nodes, 2, 0, 1_000_000, 0, InitFeatures::known(), InitFeatures::known()); + + // As the invoice amt is 1 msat above chan_1_0's inbound capacity, it shouldn't be included + let mut scid_aliases_99_000_001_msat = HashSet::new(); + scid_aliases_99_000_001_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(Some(99_000_001), &nodes[0], scid_aliases_99_000_001_msat); + + // As the invoice amt is exactly at chan_1_0's inbound capacity, it should be included + let mut scid_aliases_99_000_000_msat = HashSet::new(); + scid_aliases_99_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap()); + scid_aliases_99_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(Some(99_000_000), &nodes[0], scid_aliases_99_000_000_msat); + + // As the invoice amt is above all channels' inbound capacity, they will still be included + let mut scid_aliases_2_000_000_000_msat = HashSet::new(); + scid_aliases_2_000_000_000_msat.insert(chan_1_0.0.short_channel_id_alias.unwrap()); + scid_aliases_2_000_000_000_msat.insert(chan_2_0.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(Some(2_000_000_000), &nodes[0], scid_aliases_2_000_000_000_msat); + + // An invoice with no specified amount should include all channels in the route hints. + let mut scid_aliases_no_specified_amount = HashSet::new(); + scid_aliases_no_specified_amount.insert(chan_1_0.0.short_channel_id_alias.unwrap()); + scid_aliases_no_specified_amount.insert(chan_2_0.0.short_channel_id_alias.unwrap()); + + match_invoice_routes(None, &nodes[0], scid_aliases_no_specified_amount); + } + + fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>( + invoice_amt: Option, + invoice_node: &Node<'a, 'b, 'c>, + mut chan_ids_to_match: HashSet + ) { + let invoice = create_invoice_from_channelmanager_and_duration_since_epoch( + &invoice_node.node, invoice_node.keys_manager, Currency::BitcoinTestnet, invoice_amt, "test".to_string(), + Duration::from_secs(1234567)).unwrap(); + let hints = invoice.private_routes(); + + for hint in hints { + let hint_short_chan_id = (hint.0).0[0].short_channel_id; + assert!(chan_ids_to_match.remove(&hint_short_chan_id)); + } + assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_receive() { + do_test_multi_node_receive(true); + do_test_multi_node_receive(false); + } + + #[cfg(feature = "std")] + fn do_test_multi_node_receive(user_generated_pmt_hash: bool) { + let mut chanmon_cfgs = create_chanmon_cfgs(3); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_0_1.1); + nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_1.0); + let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1); + nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0); + + let payment_amt = 10_000; + let (payment_preimage, payment_hash, payment_secret) = { + if user_generated_pmt_hash { + let payment_preimage = PaymentPreimage([1; 32]); + let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()); + let payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(payment_amt), 3600).unwrap(); + (payment_preimage, payment_hash, payment_secret) + } else { + let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap(); + let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap(); + (payment_preimage, payment_hash, payment_secret) + } + }; + let route_hints = vec![ + nodes[1].node.get_phantom_route_hints(), + nodes[2].node.get_phantom_route_hints(), + ]; + let invoice = ::utils::create_phantom_invoice::(Some(payment_amt), "test".to_string(), payment_hash, payment_secret, route_hints, &nodes[1].keys_manager, Currency::BitcoinTestnet).unwrap(); + + assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); + assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string()))); + assert_eq!(invoice.route_hints().len(), 2); + assert!(!invoice.features().unwrap().supports_basic_mpp()); + + let payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key()) + .with_features(invoice.features().unwrap().clone()) + .with_route_hints(invoice.route_hints()); + let params = RouteParameters { + payment_params, + final_value_msat: invoice.amount_milli_satoshis().unwrap(), + final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32, + }; + let first_hops = nodes[0].node.list_usable_channels(); + let network_graph = node_cfgs[0].network_graph; + let logger = test_utils::TestLogger::new(); + let scorer = test_utils::TestScorer::with_penalty(0); + let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes(); + let route = find_route( + &nodes[0].node.get_our_node_id(), ¶ms, network_graph, + Some(&first_hops.iter().collect::>()), &logger, &scorer, &random_seed_bytes + ).unwrap(); + let (payment_event, fwd_idx) = { + let mut payment_hash = PaymentHash([0; 32]); + payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]); + nodes[0].node.send_payment(&route, payment_hash, &Some(invoice.payment_secret().clone())).unwrap(); + let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap(); + assert_eq!(added_monitors.len(), 1); + added_monitors.clear(); + + let mut events = nodes[0].node.get_and_clear_pending_msg_events(); + assert_eq!(events.len(), 1); + let fwd_idx = match events[0] { + MessageSendEvent::UpdateHTLCs { node_id, .. } => { + if node_id == nodes[1].node.get_our_node_id() { + 1 + } else { 2 } + }, + _ => panic!("Unexpected event") + }; + (SendEvent::from_event(events.remove(0)), fwd_idx) + }; + nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]); + commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true); + + // Note that we have to "forward pending HTLCs" twice before we see the PaymentReceived as + // this "emulates" the payment taking two hops, providing some privacy to make phantom node + // payments "look real" by taking more time. + expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]); + nodes[fwd_idx].node.process_pending_htlc_forwards(); + expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]); + nodes[fwd_idx].node.process_pending_htlc_forwards(); + + let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) }; + expect_payment_received!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt); + do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage); + let events = nodes[0].node.get_and_clear_pending_events(); + assert_eq!(events.len(), 2); + match events[0] { + Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => { + assert_eq!(payment_preimage, *ev_preimage); + assert_eq!(payment_hash, *ev_hash); + assert_eq!(fee_paid_msat, &Some(0)); + }, + _ => panic!("Unexpected event") + } + match events[1] { + Event::PaymentPathSuccessful { payment_hash: hash, .. } => { + assert_eq!(hash, Some(payment_hash)); + }, + _ => panic!("Unexpected event") + } + } + + #[test] + #[cfg(feature = "std")] + fn create_phantom_invoice_with_description_hash() { + let chanmon_cfgs = create_chanmon_cfgs(3); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + + let payment_amt = 20_000; + let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(payment_amt), 3600).unwrap(); + let route_hints = vec![ + nodes[1].node.get_phantom_route_hints(), + nodes[2].node.get_phantom_route_hints(), + ]; + + let description_hash = crate::Sha256(Hash::hash("Description hash phantom invoice".as_bytes())); + let invoice = ::utils::create_phantom_invoice_with_description_hash::(Some(payment_amt), description_hash, payment_hash, payment_secret, route_hints, &nodes[1].keys_manager, Currency::BitcoinTestnet).unwrap(); + + assert_eq!(invoice.amount_pico_btc(), Some(200_000)); + assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); + assert_eq!(invoice.description(), InvoiceDescription::Hash(&crate::Sha256(Sha256::hash("Description hash phantom invoice".as_bytes())))); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_hints_includes_single_channels_to_participating_nodes() { + let mut chanmon_cfgs = create_chanmon_cfgs(3); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + + let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[1], + vec![&nodes[1], &nodes[2],], + scid_aliases, + false + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_hints_includes_one_channel_of_each_counterparty_nodes_per_participating_node() { + let mut chanmon_cfgs = create_chanmon_cfgs(4); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(4, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]); + let nodes = create_network(4, &node_cfgs, &node_chanmgrs); + + let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, InitFeatures::known(), InitFeatures::known()); + let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 3_000_000, 10005, InitFeatures::known(), InitFeatures::known()); + + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_1_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases, + false + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_forwarding_info_not_assigned_channel_excluded_from_hints() { + let mut chanmon_cfgs = create_chanmon_cfgs(4); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[3].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(4, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]); + let nodes = create_network(4, &node_cfgs, &node_chanmgrs); + + let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 1000000, 10001, InitFeatures::known(), InitFeatures::known()); + + // Create an unannonced channel between `nodes[1]` and `nodes[3]`, for which the + // `msgs::ChannelUpdate` is never handled for the node(s). As the `msgs::ChannelUpdate` + // is never handled, the `channel.counterparty.forwarding_info` is never assigned. + let mut private_chan_cfg = UserConfig::default(); + private_chan_cfg.channel_options.announced_channel = false; + 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(); + let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[3].node.get_our_node_id()); + nodes[3].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel); + let accept_channel = get_event_msg!(nodes[3], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id()); + nodes[1].node.handle_accept_channel(&nodes[3].node.get_our_node_id(), InitFeatures::known(), &accept_channel); + + let tx = sign_funding_transaction(&nodes[1], &nodes[3], 1_000_000, temporary_channel_id); + + let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[3].best_block_info().1 + 1); + confirm_transaction_at(&nodes[1], &tx, conf_height); + connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1); + confirm_transaction_at(&nodes[3], &tx, conf_height); + connect_blocks(&nodes[3], CHAN_CONFIRM_DEPTH - 1); + let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[3].node.get_our_node_id()); + nodes[1].node.handle_funding_locked(&nodes[3].node.get_our_node_id(), &get_event_msg!(nodes[3], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id())); + get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id()); + nodes[3].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked); + get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id()); + + // As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third + // channel, the channel will never be assigned any `counterparty.forwarding_info`. + // Therefore only `chan_0_3` should be included in the hints for `nodes[3]`. + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases, + false + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_with_only_public_channels_hints_includes_only_phantom_route() { + let mut chanmon_cfgs = create_chanmon_cfgs(3); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + + let chan_0_1 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let chan_2_0 = create_announced_chan_between_nodes_with_value(&nodes, 2, 0, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1); + nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0); + + // Hints should include `chan_0_1` from as `nodes[1]` only have private channels, but not + // `chan_0_2` as `nodes[2]` only has public channels. + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_1.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[1], + vec![&nodes[1], &nodes[2],], + scid_aliases, + true + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_with_mixed_public_and_private_channel_hints_includes_only_phantom_route() { + let mut chanmon_cfgs = create_chanmon_cfgs(4); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(4, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]); + let nodes = create_network(4, &node_cfgs, &node_chanmgrs); + + let chan_0_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_0_2.1); + nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_0_2.0); + let _chan_1_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + // Hints should include `chan_0_3` from as `nodes[3]` only have private channels, and no + // channels for `nodes[2]` as it contains a mix of public and private channels. + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases, + true + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_hints_has_only_highest_inbound_capacity_channel() { + let mut chanmon_cfgs = create_chanmon_cfgs(3); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(3, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]); + let nodes = create_network(3, &node_cfgs, &node_chanmgrs); + + let _chan_0_1_low_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_0_1_high_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0, InitFeatures::known(), InitFeatures::known()); + let _chan_0_1_medium_inbound_capacity = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + + let mut scid_aliases = HashSet::new(); + scid_aliases.insert(chan_0_1_high_inbound_capacity.0.short_channel_id_alias.unwrap()); + scid_aliases.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(10_000), + &nodes[1], + vec![&nodes[1], &nodes[2],], + scid_aliases, + false + ); + } + + #[test] + #[cfg(feature = "std")] + fn test_multi_node_channels_inbound_capacity_lower_than_invoice_amt_filtering() { + let mut chanmon_cfgs = create_chanmon_cfgs(4); + let seed_1 = [42 as u8; 32]; + let seed_2 = [43 as u8; 32]; + let cross_node_seed = [44 as u8; 32]; + chanmon_cfgs[1].keys_manager.backing = PhantomKeysManager::new(&seed_1, 43, 44, &cross_node_seed); + chanmon_cfgs[2].keys_manager.backing = PhantomKeysManager::new(&seed_2, 43, 44, &cross_node_seed); + let node_cfgs = create_node_cfgs(4, &chanmon_cfgs); + let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]); + let nodes = create_network(4, &node_cfgs, &node_chanmgrs); + + let chan_0_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_0_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 0, 3, 100_000, 0, InitFeatures::known(), InitFeatures::known()); + let chan_1_3 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 3, 200_000, 0, InitFeatures::known(), InitFeatures::known()); + + // Since the invoice 1 msat above chan_0_3's inbound capacity, it should be filtered out. + let mut scid_aliases_99_000_001_msat = HashSet::new(); + scid_aliases_99_000_001_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases_99_000_001_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(99_000_001), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases_99_000_001_msat, + false + ); + + // Since the invoice is exactly at chan_0_3's inbound capacity, it should be included. + let mut scid_aliases_99_000_000_msat = HashSet::new(); + scid_aliases_99_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases_99_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + scid_aliases_99_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(99_000_000), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases_99_000_000_msat, + false + ); + + // Since the invoice is above all of `nodes[2]` channels' inbound capacity, all of + // `nodes[2]` them should be included. + let mut scid_aliases_300_000_000_msat = HashSet::new(); + scid_aliases_300_000_000_msat.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases_300_000_000_msat.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + scid_aliases_300_000_000_msat.insert(chan_1_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + Some(300_000_000), + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases_300_000_000_msat, + false + ); + + // Since the no specified amount, all channels should included. + let mut scid_aliases_no_specified_amount = HashSet::new(); + scid_aliases_no_specified_amount.insert(chan_0_2.0.short_channel_id_alias.unwrap()); + scid_aliases_no_specified_amount.insert(chan_0_3.0.short_channel_id_alias.unwrap()); + scid_aliases_no_specified_amount.insert(chan_1_3.0.short_channel_id_alias.unwrap()); + + match_multi_node_invoice_routes( + None, + &nodes[2], + vec![&nodes[2], &nodes[3],], + scid_aliases_no_specified_amount, + false + ); + } + + #[cfg(feature = "std")] + fn match_multi_node_invoice_routes<'a, 'b: 'a, 'c: 'b>( + invoice_amt: Option, + invoice_node: &Node<'a, 'b, 'c>, + network_multi_nodes: Vec<&Node<'a, 'b, 'c>>, + mut chan_ids_to_match: HashSet, + nodes_contains_public_channels: bool + ){ + let (payment_hash, payment_secret) = invoice_node.node.create_inbound_payment(invoice_amt, 3600).unwrap(); + let phantom_route_hints = network_multi_nodes.iter() + .map(|node| node.node.get_phantom_route_hints()) + .collect::>(); + let phantom_scids = phantom_route_hints.iter() + .map(|route_hint| route_hint.phantom_scid) + .collect::>(); + + let invoice = ::utils::create_phantom_invoice::(invoice_amt, "test".to_string(), payment_hash, payment_secret, phantom_route_hints, &invoice_node.keys_manager, Currency::BitcoinTestnet).unwrap(); + + let invoice_hints = invoice.private_routes(); + + for hint in invoice_hints { + let hints = &(hint.0).0; + match hints.len() { + 1 => { + assert!(nodes_contains_public_channels); + let phantom_scid = hints[0].short_channel_id; + assert!(phantom_scids.contains(&phantom_scid)); + }, + 2 => { + let hint_short_chan_id = hints[0].short_channel_id; + assert!(chan_ids_to_match.remove(&hint_short_chan_id)); + let phantom_scid = hints[1].short_channel_id; + assert!(phantom_scids.contains(&phantom_scid)); + }, + _ => panic!("Incorrect hint length generated") + } + } + assert!(chan_ids_to_match.is_empty(), "Unmatched short channel ids: {:?}", chan_ids_to_match); + } }