From 951c1d41458b432bf4f036520f547d8377c41ce7 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Sun, 22 Jul 2018 13:11:58 -0400 Subject: [PATCH] Clarify get_peer_node_ids docs a bit --- src/ln/peer_handler.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/ln/peer_handler.rs b/src/ln/peer_handler.rs index 5adb07f69..e735b0b65 100644 --- a/src/ln/peer_handler.rs +++ b/src/ln/peer_handler.rs @@ -121,7 +121,10 @@ impl PeerManager { } } - /// Get the list of known node ids + /// Get the list of node ids for peers which have completed the initial handshake. + /// For outbound connections, this will be the same as the their_node_id parameter passed in to + /// new_outbound_connection, however entries will only appear once the initial handshake has + /// completed and we are sure the remote peer has the private key for the given node_id. pub fn get_peer_node_ids(&self) -> Vec { let peers = self.peers.lock().unwrap(); peers.peers.values().filter_map(|p| p.their_node_id).collect() -- 2.39.5