Rename OnionMessagePath::addresses
authorJeffrey Czyz <jkczyz@gmail.com>
Fri, 8 Dec 2023 04:38:00 +0000 (22:38 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Fri, 8 Dec 2023 05:44:41 +0000 (23:44 -0600)
The name itself doesn't provide much meaning to what the addresses
correspond to.

fuzz/src/onion_message.rs
lightning/src/onion_message/functional_tests.rs
lightning/src/onion_message/messenger.rs

index 76cd98cea2dfb68abc8c6af4a37f96da1f2177f0..1051083d36be759d633b108a8078575d95d2287a 100644 (file)
@@ -79,7 +79,7 @@ impl MessageRouter for TestMessageRouter {
                Ok(OnionMessagePath {
                        intermediate_nodes: vec![],
                        destination,
-                       addresses: None,
+                       first_node_addresses: None,
                })
        }
 }
index e8e800d5e921534de98527c1fcab12cb08e62746..9323be5fff2d36b2d586a9ed60948d71993daa64 100644 (file)
@@ -51,7 +51,8 @@ impl MessageRouter for TestMessageRouter {
                Ok(OnionMessagePath {
                        intermediate_nodes: vec![],
                        destination,
-                       addresses: Some(vec![SocketAddress::TcpIpV4 { addr: [127, 0, 0, 1], port: 1000 }]),
+                       first_node_addresses:
+                               Some(vec![SocketAddress::TcpIpV4 { addr: [127, 0, 0, 1], port: 1000 }]),
                })
        }
 }
@@ -227,7 +228,7 @@ fn one_unblinded_hop() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::Node(nodes[1].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
        nodes[1].custom_message_handler.expect_message(TestCustomMessage::Response);
@@ -242,7 +243,7 @@ fn two_unblinded_hops() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![nodes[1].node_id],
                destination: Destination::Node(nodes[2].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
        nodes[2].custom_message_handler.expect_message(TestCustomMessage::Response);
@@ -259,7 +260,7 @@ fn one_blinded_hop() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
        nodes[1].custom_message_handler.expect_message(TestCustomMessage::Response);
@@ -276,7 +277,7 @@ fn two_unblinded_two_blinded() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![nodes[1].node_id, nodes[2].node_id],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
 
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
@@ -294,7 +295,7 @@ fn three_blinded_hops() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
 
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
@@ -313,7 +314,7 @@ fn too_big_packet_error() {
        let path = OnionMessagePath {
                intermediate_nodes: hops,
                destination: Destination::Node(hop_node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        let err = nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap_err();
        assert_eq!(err, SendError::TooBigPacket);
@@ -331,7 +332,7 @@ fn we_are_intro_node() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
 
        nodes[0].messenger.send_onion_message_using_path(path, test_msg.clone(), None).unwrap();
@@ -343,7 +344,7 @@ fn we_are_intro_node() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
        nodes[1].custom_message_handler.expect_message(TestCustomMessage::Response);
@@ -364,7 +365,7 @@ fn invalid_blinded_path_error() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
        let err = nodes[0].messenger.send_onion_message_using_path(path, test_msg.clone(), None).unwrap_err();
        assert_eq!(err, SendError::TooFewBlindedHops);
@@ -380,7 +381,7 @@ fn reply_path() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![nodes[1].node_id, nodes[2].node_id],
                destination: Destination::Node(nodes[3].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        let reply_path = BlindedPath::new_for_message(&[nodes[2].node_id, nodes[1].node_id, nodes[0].node_id], &*nodes[0].entropy_source, &secp_ctx).unwrap();
        nodes[0].messenger.send_onion_message_using_path(path, test_msg.clone(), Some(reply_path)).unwrap();
@@ -396,7 +397,7 @@ fn reply_path() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::BlindedPath(blinded_path),
-               addresses: None,
+               first_node_addresses: None,
        };
        let reply_path = BlindedPath::new_for_message(&[nodes[2].node_id, nodes[1].node_id, nodes[0].node_id], &*nodes[0].entropy_source, &secp_ctx).unwrap();
 
@@ -431,7 +432,7 @@ fn invalid_custom_message_type() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::Node(nodes[1].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        let err = nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap_err();
        assert_eq!(err, SendError::InvalidMessage);
@@ -444,7 +445,7 @@ fn peer_buffer_full() {
        let path = OnionMessagePath {
                intermediate_nodes: vec![],
                destination: Destination::Node(nodes[1].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        for _ in 0..188 { // Based on MAX_PER_PEER_BUFFER_SIZE in OnionMessenger
                nodes[0].messenger.send_onion_message_using_path(path.clone(), test_msg.clone(), None).unwrap();
@@ -469,7 +470,7 @@ fn many_hops() {
        let path = OnionMessagePath {
                intermediate_nodes,
                destination: Destination::Node(nodes[num_nodes-1].node_id),
-               addresses: None,
+               first_node_addresses: None,
        };
        nodes[0].messenger.send_onion_message_using_path(path, test_msg, None).unwrap();
        nodes[num_nodes-1].custom_message_handler.expect_message(TestCustomMessage::Response);
index 52acc20d477614fc536ca9db770b18d96715ea76..a6f11bf6a7d75e07be52442569c42ed87d610870 100644 (file)
@@ -87,7 +87,7 @@ pub(super) const MAX_TIMER_TICKS: usize = 2;
 /// #         Ok(OnionMessagePath {
 /// #             intermediate_nodes: vec![hop_node_id1, hop_node_id2],
 /// #             destination,
-/// #             addresses: None,
+/// #             first_node_addresses: None,
 /// #         })
 /// #     }
 /// # }
@@ -292,7 +292,9 @@ where
        ) -> Result<OnionMessagePath, ()> {
                let first_node = destination.first_node();
                if peers.contains(&first_node) {
-                       Ok(OnionMessagePath { intermediate_nodes: vec![], destination, addresses: None })
+                       Ok(OnionMessagePath {
+                               intermediate_nodes: vec![], destination, first_node_addresses: None
+                       })
                } else {
                        let network_graph = self.network_graph.deref().read_only();
                        let node_announcement = network_graph
@@ -303,8 +305,10 @@ where
 
                        match node_announcement {
                                Some(node_announcement) if node_announcement.features.supports_onion_messages() => {
-                                       let addresses = Some(node_announcement.addresses.clone());
-                                       Ok(OnionMessagePath { intermediate_nodes: vec![], destination, addresses })
+                                       let first_node_addresses = Some(node_announcement.addresses.clone());
+                                       Ok(OnionMessagePath {
+                                               intermediate_nodes: vec![], destination, first_node_addresses
+                                       })
                                },
                                _ => Err(()),
                        }
@@ -325,7 +329,7 @@ pub struct OnionMessagePath {
        ///
        /// Only needs to be set if a connection to the node is required. [`OnionMessenger`] may use
        /// this to initiate such a connection.
-       pub addresses: Option<Vec<SocketAddress>>,
+       pub first_node_addresses: Option<Vec<SocketAddress>>,
 }
 
 impl OnionMessagePath {
@@ -469,7 +473,7 @@ where
        ES::Target: EntropySource,
        NS::Target: NodeSigner,
 {
-       let OnionMessagePath { intermediate_nodes, mut destination, addresses } = path;
+       let OnionMessagePath { intermediate_nodes, mut destination, first_node_addresses } = path;
        if let Destination::BlindedPath(BlindedPath { ref blinded_hops, .. }) = destination {
                if blinded_hops.is_empty() {
                        return Err(SendError::TooFewBlindedHops);
@@ -511,7 +515,7 @@ where
                packet_payloads, packet_keys, prng_seed).map_err(|()| SendError::TooBigPacket)?;
 
        let message = OnionMessage { blinding_point, onion_routing_packet };
-       Ok((first_node_id, message, addresses))
+       Ok((first_node_id, message, first_node_addresses))
 }
 
 /// Decode one layer of an incoming [`OnionMessage`].