X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-invoice%2Fsrc%2Futils.rs;h=62820cfe11007027ecc2ec7802a5a4946767e1c6;hb=39201577655947f8b02fddc4b0216817f0ed21c4;hp=619045eee466cd2bf04fb3e82dc1b4f09af0a270;hpb=43cc81c893fdd8b3e9d8b150fedc0839e29e40a9;p=rust-lightning diff --git a/lightning-invoice/src/utils.rs b/lightning-invoice/src/utils.rs index 619045ee..62820cfe 100644 --- a/lightning-invoice/src/utils.rs +++ b/lightning-invoice/src/utils.rs @@ -3,9 +3,9 @@ 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, sha256}; -use crate::prelude::*; use lightning::chain; use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator}; use lightning::chain::keysinterface::{Recipient, KeysInterface, Sign}; @@ -50,14 +50,77 @@ use sync::Mutex; /// [`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 + 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)) + return Err(SignOrCreationError::CreationError( + CreationError::MissingRouteHints, + )); } - let mut invoice = InvoiceBuilder::new(network) - .description(description) + 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) @@ -126,12 +189,57 @@ where 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 + channelmanager, keys_manager, network, amt_msat, description, duration + ) +} + +#[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, ) } @@ -142,6 +250,26 @@ pub fn create_invoice_from_channelmanager_and_duration_since_epoch, 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, @@ -153,12 +281,19 @@ where // `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()) + 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) + + 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()) @@ -333,7 +468,7 @@ mod test { use bitcoin_hashes::sha256::Hash as Sha256; use lightning::chain::keysinterface::PhantomKeysManager; use lightning::ln::{PaymentPreimage, PaymentHash}; - use lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY; + 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; @@ -407,6 +542,22 @@ mod test { 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); @@ -687,4 +838,355 @@ mod test { _ => 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); + } }