Add tests for create invoice route hints filtering

Author: ViktorT-11

lightning-invoice/src/utils.rs

@@ -356,7 +356,9 @@ mod test {
 	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 utils::create_invoice_from_channelmanager_and_duration_since_epoch;
+	use std::collections::HashSet;
 
 	#[test]
 	fn test_from_channelmanager() {
@@ -411,6 +413,148 @@ mod test {
 		assert_eq!(events.len(), 2);
 	}
 
+	#[test]
+	fn test_hints_includes_single_public_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_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[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
+		nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
+
+		let mut short_chan_ids = HashSet::new();
+		short_chan_ids.insert(chan_1_0.0.contents.short_channel_id.clone());
+		short_chan_ids.insert(chan_2_0.0.contents.short_channel_id.clone());
+
+		match_invoice_routes(
+			Some(5000),
+			&nodes[0],
+			short_chan_ids.clone(),
+		);
+	}
+
+	#[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_announced_chan_between_nodes_with_value(&nodes, 1, 0, 100_000, 0, InitFeatures::known(), InitFeatures::known());
+		nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0_low_inbound_capacity.0);
+		nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0_low_inbound_capacity.1);
+		let chan_1_0_high_inbound_capacity = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 10_000_000, 0, InitFeatures::known(), InitFeatures::known());
+		nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0_high_inbound_capacity.0);
+		nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0_high_inbound_capacity.1);
+		let chan_1_0_medium_inbound_capacity = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
+		nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan_1_0_medium_inbound_capacity.0);
+		nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_1_0_medium_inbound_capacity.1);
+
+		let mut short_chan_ids = HashSet::new();
+		short_chan_ids.insert(chan_1_0_high_inbound_capacity.0.contents.short_channel_id.clone());
+
+		match_invoice_routes(
+			Some(5000),
+			&nodes[0],
+			short_chan_ids.clone(),
+		);
+	}
+
+	#[test]
+	fn test_no_hints_if_any_private_channels_exists() {
+		let mut nodes_2_priv_channels_conf = UserConfig::default();
+		nodes_2_priv_channels_conf.channel_options.announced_channel = false;
+		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, Some(nodes_2_priv_channels_conf)]);
+		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_private_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 public, as there is a
+		// private channel between `nodes[2]` and `nodes[0]`
+		let invoice = create_invoice_from_channelmanager_and_duration_since_epoch(
+			&nodes[0].node, nodes[0].keys_manager, Currency::BitcoinTestnet, Some(5000), "test".to_string(),
+			Duration::from_secs(1234567)).unwrap();
+		let hints = invoice.private_routes();
+
+		assert!(hints.is_empty());
+	}
+
+	#[test]
+	fn test_hints_has_no_channels_with_lower_inbound_capacity_than_invoice_amt() {
+		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, 100_000, 0, 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, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
+		nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan_2_0.0);
+		nodes[2].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &chan_2_0.1);
+
+		// 1 msat above chan_1_0's inbound capacity
+		let mut short_chan_ids_99_000_001_msat = HashSet::new();
+		short_chan_ids_99_000_001_msat.insert(chan_2_0.0.contents.short_channel_id.clone());
+
+		match_invoice_routes(
+			Some(99_000_001),
+			&nodes[0],
+			short_chan_ids_99_000_001_msat.clone(),
+		);
+
+		// Exactly at chan_1_0's inbound capacity
+		let mut short_chan_ids_99_000_000_msat = HashSet::new();
+		short_chan_ids_99_000_000_msat.insert(chan_1_0.0.contents.short_channel_id.clone());
+		short_chan_ids_99_000_000_msat.insert(chan_2_0.0.contents.short_channel_id.clone());
+
+		match_invoice_routes(
+			Some(99_000_000),
+			&nodes[0],
+			short_chan_ids_99_000_000_msat.clone(),
+		);
+
+		// An invoice with no specified amount should include all route hints.
+		let mut short_chan_ids_no_specified_amount = HashSet::new();
+		short_chan_ids_no_specified_amount.insert(chan_1_0.0.contents.short_channel_id.clone());
+		short_chan_ids_no_specified_amount.insert(chan_2_0.0.contents.short_channel_id.clone());
+
+		match_invoice_routes(
+			None,
+			&nodes[0],
+			short_chan_ids_no_specified_amount.clone(),
+		);
+	}
+
+	fn match_invoice_routes<'a, 'b: 'a, 'c: 'b>(
+		invoice_amt: Option<u64>,
+		invoice_node: &Node<'a, 'b, 'c>,
+		mut chan_ids_to_match: HashSet<u64>
+	){
+		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();
+
+		assert_eq!(hints.len(), chan_ids_to_match.len());
+
+		for hint in hints {
+			let hint_short_chan_id = (hint.0).0[0].short_channel_id;
+			assert!(chan_ids_to_match.contains(&hint_short_chan_id));
+			chan_ids_to_match.remove(&hint_short_chan_id);
+		}
+	}
+
 	#[test]
 	#[cfg(feature = "std")]
 	fn test_multi_node_receive() {