From: Matt Corallo <git@bluematt.me>
Date: Sun, 22 Jul 2018 17:11:58 +0000 (-0400)
Subject: Clarify get_peer_node_ids docs a bit
X-Git-Tag: v0.0.12~382^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=951c1d41458b432bf4f036520f547d8377c41ce7;p=rust-lightning

Clarify get_peer_node_ids docs a bit
---

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<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 		}
 	}
 
-	/// 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<PublicKey> {
 		let peers = self.peers.lock().unwrap();
 		peers.peers.values().filter_map(|p| p.their_node_id).collect()