Merge pull request #2823 from valentinewallace/2024-01-blinded-forwarding-tests
authorMatt Corallo <649246+TheBlueMatt@users.noreply.github.com>
Fri, 8 Mar 2024 21:32:40 +0000 (21:32 +0000)
committerGitHub <noreply@github.com>
Fri, 8 Mar 2024 21:32:40 +0000 (21:32 +0000)
Test blinded forwarding

1  2 
lightning/src/ln/offers_tests.rs

index e16c0ed515f5836195d867fed906ea203e763007,c7e2755e23a844a0282e47fca55d97c4676a1385..f5e8bc2afdb0a1a0626de669d38f986a1b3b9668
@@@ -45,7 -45,7 +45,7 @@@ use crate::blinded_path::BlindedPath
  use crate::events::{Event, MessageSendEventsProvider, PaymentPurpose};
  use crate::ln::channelmanager::{PaymentId, RecentPaymentDetails, Retry, self};
  use crate::ln::functional_test_utils::*;
 -use crate::ln::msgs::{ChannelMessageHandler, Init, OnionMessage, OnionMessageHandler};
 +use crate::ln::msgs::{ChannelMessageHandler, Init, NodeAnnouncement, OnionMessage, OnionMessageHandler, RoutingMessageHandler, SocketAddress, UnsignedGossipMessage, UnsignedNodeAnnouncement};
  use crate::offers::invoice::Bolt12Invoice;
  use crate::offers::invoice_error::InvoiceError;
  use crate::offers::invoice_request::InvoiceRequest;
@@@ -53,8 -53,6 +53,8 @@@ use crate::offers::parse::Bolt12Semanti
  use crate::onion_message::messenger::PeeledOnion;
  use crate::onion_message::offers::OffersMessage;
  use crate::onion_message::packet::ParsedOnionMessageContents;
 +use crate::routing::gossip::{NodeAlias, NodeId};
 +use crate::sign::{NodeSigner, Recipient};
  
  use crate::prelude::*;
  
@@@ -100,37 -98,6 +100,37 @@@ fn disconnect_peers<'a, 'b, 'c>(node_a
        }
  }
  
 +fn announce_node_address<'a, 'b, 'c>(
 +      node: &Node<'a, 'b, 'c>, peers: &[&Node<'a, 'b, 'c>], address: SocketAddress,
 +) {
 +      let features = node.onion_messenger.provided_node_features()
 +              | node.gossip_sync.provided_node_features();
 +      let rgb = [0u8; 3];
 +      let announcement = UnsignedNodeAnnouncement {
 +              features,
 +              timestamp: 1000,
 +              node_id: NodeId::from_pubkey(&node.keys_manager.get_node_id(Recipient::Node).unwrap()),
 +              rgb,
 +              alias: NodeAlias([0u8; 32]),
 +              addresses: vec![address],
 +              excess_address_data: Vec::new(),
 +              excess_data: Vec::new(),
 +      };
 +      let signature = node.keys_manager.sign_gossip_message(
 +              UnsignedGossipMessage::NodeAnnouncement(&announcement)
 +      ).unwrap();
 +
 +      let msg = NodeAnnouncement {
 +              signature,
 +              contents: announcement
 +      };
 +
 +      node.gossip_sync.handle_node_announcement(&msg).unwrap();
 +      for peer in peers {
 +              peer.gossip_sync.handle_node_announcement(&msg).unwrap();
 +      }
 +}
 +
  fn route_bolt12_payment<'a, 'b, 'c>(
        node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], invoice: &Bolt12Invoice
  ) {
        // invoice contains the payment_hash but it was encrypted inside an onion message.
        let amount_msats = invoice.amount_msats();
        let payment_hash = invoice.payment_hash();
-       do_pass_along_path(
-               node, path, amount_msats, payment_hash, None, ev, false, false, None, false
-       );
+       let args = PassAlongPathArgs::new(node, path, amount_msats, payment_hash, ev)
+               .without_clearing_recipient_events();
+       do_pass_along_path(args);
  }
  
  fn claim_bolt12_payment<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>]) {
@@@ -211,123 -178,6 +211,123 @@@ fn extract_invoice_error<'a, 'b, 'c>
        }
  }
  
 +/// Checks that blinded paths without Tor-only nodes are preferred when constructing an offer.
 +#[test]
 +fn prefers_non_tor_nodes_in_blinded_paths() {
 +      let mut accept_forward_cfg = test_default_channel_config();
 +      accept_forward_cfg.accept_forwards_to_priv_channels = true;
 +
 +      let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
 +      features.set_onion_messages_optional();
 +      features.set_route_blinding_optional();
 +
 +      let chanmon_cfgs = create_chanmon_cfgs(6);
 +      let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
 +
 +      *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
 +
 +      let node_chanmgrs = create_node_chanmgrs(
 +              6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
 +      );
 +      let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
 +
 +      create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
 +      create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
 +
 +      // Add an extra channel so that more than one of Bob's peers have MIN_PEER_CHANNELS.
 +      create_announced_chan_between_nodes_with_value(&nodes, 4, 5, 10_000_000, 1_000_000_000);
 +
 +      let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
 +      let bob_id = bob.node.get_our_node_id();
 +      let charlie_id = charlie.node.get_our_node_id();
 +
 +      disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
 +      disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 +
 +      let tor = SocketAddress::OnionV2([255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]);
 +      announce_node_address(charlie, &[alice, bob, david, &nodes[4], &nodes[5]], tor.clone());
 +
 +      let offer = bob.node
 +              .create_offer_builder("coffee".to_string()).unwrap()
 +              .amount_msats(10_000_000)
 +              .build().unwrap();
 +      assert_ne!(offer.signing_pubkey(), bob_id);
 +      assert!(!offer.paths().is_empty());
 +      for path in offer.paths() {
 +              assert_ne!(path.introduction_node_id, bob_id);
 +              assert_ne!(path.introduction_node_id, charlie_id);
 +      }
 +
 +      // Use a one-hop blinded path when Bob is announced and all his peers are Tor-only.
 +      announce_node_address(&nodes[4], &[alice, bob, charlie, david, &nodes[5]], tor.clone());
 +      announce_node_address(&nodes[5], &[alice, bob, charlie, david, &nodes[4]], tor.clone());
 +
 +      let offer = bob.node
 +              .create_offer_builder("coffee".to_string()).unwrap()
 +              .amount_msats(10_000_000)
 +              .build().unwrap();
 +      assert_ne!(offer.signing_pubkey(), bob_id);
 +      assert!(!offer.paths().is_empty());
 +      for path in offer.paths() {
 +              assert_eq!(path.introduction_node_id, bob_id);
 +      }
 +}
 +
 +/// Checks that blinded paths prefer an introduction node that is the most connected.
 +#[test]
 +fn prefers_more_connected_nodes_in_blinded_paths() {
 +      let mut accept_forward_cfg = test_default_channel_config();
 +      accept_forward_cfg.accept_forwards_to_priv_channels = true;
 +
 +      let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
 +      features.set_onion_messages_optional();
 +      features.set_route_blinding_optional();
 +
 +      let chanmon_cfgs = create_chanmon_cfgs(6);
 +      let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
 +
 +      *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
 +
 +      let node_chanmgrs = create_node_chanmgrs(
 +              6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
 +      );
 +      let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
 +
 +      create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
 +      create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
 +
 +      // Add extra channels so that more than one of Bob's peers have MIN_PEER_CHANNELS and one has
 +      // more than the others.
 +      create_announced_chan_between_nodes_with_value(&nodes, 0, 4, 10_000_000, 1_000_000_000);
 +      create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 10_000_000, 1_000_000_000);
 +
 +      let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
 +      let bob_id = bob.node.get_our_node_id();
 +
 +      disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
 +      disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 +
 +      let offer = bob.node
 +              .create_offer_builder("coffee".to_string()).unwrap()
 +              .amount_msats(10_000_000)
 +              .build().unwrap();
 +      assert_ne!(offer.signing_pubkey(), bob_id);
 +      assert!(!offer.paths().is_empty());
 +      for path in offer.paths() {
 +              assert_eq!(path.introduction_node_id, nodes[4].node.get_our_node_id());
 +      }
 +}
 +
  /// Checks that an offer can be paid through blinded paths and that ephemeral pubkeys are used
  /// rather than exposing a node's pubkey.
  #[test]