Return connection state of peer in list_peers

Author: jurvis

bindings/ldk_node.udl

@@ -51,7 +51,7 @@ interface Node {
 	[Throws=NodeError]
 	Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
 	PaymentInfo? payment_info([ByRef]PaymentHash payment_hash);
-	sequence<PublicKey> list_peers();
+	sequence<PeerDetails> list_peers();
 	sequence<ChannelDetails> list_channels();
 };
 
@@ -135,6 +135,11 @@ dictionary ChannelDetails {
     u16? cltv_expiry_delta;
 };
 
+dictionary PeerDetails {
+    PublicKey node_id;
+    boolean is_connected;
+};
+
 [Custom]
 typedef string SocketAddr;
 

src/lib.rs

@@ -102,7 +102,7 @@ pub use payment_store::{PaymentDirection, PaymentInfo, PaymentStatus};
 use peer_store::{PeerInfo, PeerInfoStorage};
 use types::{
 	ChainMonitor, ChannelDetails, ChannelManager, GossipSync, KeysManager, Network, NetworkGraph,
-	OnionMessenger, OutPoint, PeerManager, Scorer,
+	OnionMessenger, OutPoint, PeerDetails, PeerManager, Scorer,
 };
 pub use types::{ChannelId, UserChannelId};
 use wallet::Wallet;
@@ -1343,8 +1343,17 @@ impl Node {
 	}
 
 	/// List node's connected peers.
-	pub fn list_peers(&self) -> Vec<PublicKey> {
-		self.peer_manager.get_peer_node_ids().iter().map(|(pubkey, _)| *pubkey).collect::<Vec<_>>()
+	pub fn list_peers(&self) -> Vec<PeerDetails> {
+		let active_connected_peers: Vec<PublicKey> =
+			self.peer_manager.get_peer_node_ids().iter().map(|p| p.0).collect();
+		self.peer_store
+			.list_peers()
+			.iter()
+			.map(|p| PeerDetails {
+				node_id: p.pubkey,
+				is_connected: active_connected_peers.contains(&p.pubkey),
+			})
+			.collect()
 	}
 }
 

src/test/functional_tests.rs

@@ -37,7 +37,10 @@ fn channel_full_cycle() {
 		.connect_open_channel(&node_b.node_id(), &node_b.listening_address().unwrap(), 50000, true)
 		.unwrap();
 
-	assert_eq!(node_a.list_peers(), [node_b.node_id()]);
+	assert_eq!(
+		node_a.list_peers().iter().map(|p| p.node_id).collect::<Vec<_>>(),
+		[node_b.node_id()]
+	);
 
 	let funding_txo = loop {
 		let details = node_a.channel_manager.list_channels();

src/types.rs

@@ -431,3 +431,13 @@ impl From<LdkOutpoint> for OutPoint {
 		OutPoint { txid: value.txid.to_string(), index: value.index }
 	}
 }
+
+/// Details about peers the user is connected to. As returned by [`Node::list_peers`].
+///
+/// [`Node::list_peers`]: [`crate::Node::list_peers`]
+pub struct PeerDetails {
+	/// Our peer's node ID.
+	pub node_id: PublicKey,
+	/// Indicates whether or not the user is currently has an active connection with the peer.
+	pub is_connected: bool,
+}