Add Display trait on network structs for routing bug track

Author: Antoine Riard

src/ln/router.rs

@@ -12,6 +12,7 @@ use std::cmp;
 use std::sync::{RwLock,Arc};
 use std::collections::{HashMap,BinaryHeap};
 use std::collections::hash_map::Entry;
+use std;
 
 /// A hop in a route
 #[derive(Clone)]
@@ -35,31 +36,46 @@ pub struct Route {
 	pub hops: Vec<RouteHop>,
 }
 
-//Here, DirectionalChannelInfo, ChannelInfo, NodeInfo and NetworkMap are pub(crate) only for log_* macros access
-pub(crate) struct DirectionalChannelInfo {
-	pub(crate) src_node_id: PublicKey,
-	pub(crate) last_update: u32,
-	pub(crate) enabled: bool,
-	pub(crate) cltv_expiry_delta: u16,
-	pub(crate) htlc_minimum_msat: u64,
-	pub(crate) fee_base_msat: u32,
-	pub(crate) fee_proportional_millionths: u32,
+struct DirectionalChannelInfo {
+	src_node_id: PublicKey,
+	last_update: u32,
+	enabled: bool,
+	cltv_expiry_delta: u16,
+	htlc_minimum_msat: u64,
+	fee_base_msat: u32,
+	fee_proportional_millionths: u32,
 }
 
-pub(crate) struct ChannelInfo {
-	pub(crate) features: GlobalFeatures,
-	pub(crate) one_to_two: DirectionalChannelInfo,
-	pub(crate) two_to_one: DirectionalChannelInfo,
+impl std::fmt::Display for DirectionalChannelInfo {
+	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+		write!(f, " node id {} last_update {} enabled {} cltv_expiry_delta {} htlc_minimum_msat {} fee_base_msat {} fee_proportional_millionths {}\n", log_pubkey!(self.src_node_id), self.last_update, self.enabled, self.cltv_expiry_delta, self.htlc_minimum_msat, self.fee_base_msat, self.fee_proportional_millionths)?;
+		Ok(())
+	}
 }
 
-pub(crate) struct NodeInfo {
+struct ChannelInfo {
+	features: GlobalFeatures,
+	one_to_two: DirectionalChannelInfo,
+	two_to_one: DirectionalChannelInfo,
+}
+
+impl std::fmt::Display for ChannelInfo {
+	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+		//TODO: GlobalFeatures
+		write!(f, " one_to_two {}", self.one_to_two)?;
+		write!(f, " two_to_one {}", self.two_to_one)?;
+		Ok(())
+	}
+}
+
+struct NodeInfo {
 	#[cfg(feature = "non_bitcoin_chain_hash_routing")]
 	channels: Vec<(u64, Sha256dHash)>,
 	#[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
-	pub(crate) channels: Vec<u64>,
+	channels: Vec<u64>,
 
-	pub(crate) lowest_inbound_channel_fee_base_msat: u32,
-	pub(crate) lowest_inbound_channel_fee_proportional_millionths: u32,
+	lowest_inbound_channel_fee_base_msat: u32,
+	lowest_inbound_channel_fee_proportional_millionths: u32,
 
 	features: GlobalFeatures,
 	last_update: u32,
@@ -68,14 +84,41 @@ pub(crate) struct NodeInfo {
 	addresses: Vec<NetAddress>,
 }
 
-pub(crate) struct NetworkMap {
+impl std::fmt::Display for NodeInfo {
+	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+		write!(f, " Channels\n")?;
+		for c in self.channels.iter() {
+			write!(f, " {}\n", c)?;
+		}
+		write!(f, " lowest_inbound_channel_fee_base_msat {}\n", self.lowest_inbound_channel_fee_base_msat)?;
+		write!(f, " lowest_inbound_channel_fee_proportional_millionths {}\n", self.lowest_inbound_channel_fee_proportional_millionths)?;
+		//TODO: GlobalFeatures, last_update, rgb, alias, addresses
+		Ok(())
+	}
+}
+
+struct NetworkMap {
 	#[cfg(feature = "non_bitcoin_chain_hash_routing")]
 	channels: HashMap<(u64, Sha256dHash), ChannelInfo>,
 	#[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
-	pub(crate) channels: HashMap<u64, ChannelInfo>,
+	channels: HashMap<u64, ChannelInfo>,
 
-	pub(crate) our_node_id: PublicKey,
-	pub(crate) nodes: HashMap<PublicKey, NodeInfo>,
+	our_node_id: PublicKey,
+	nodes: HashMap<PublicKey, NodeInfo>,
+}
+
+impl std::fmt::Display for NetworkMap {
+	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+		write!(f, "Node id {} network map\n[Channels]\n", log_pubkey!(self.our_node_id))?;
+		for (key, val) in self.channels.iter() {
+			write!(f, " {} :\n {}\n", key, val)?;
+		}
+		write!(f, "[Nodes]\n")?;
+		for (key, val) in self.nodes.iter() {
+			write!(f, " {} :\n {}\n", log_pubkey!(key), val)?;
+		}
+		Ok(())
+	}
 }
 
 impl NetworkMap {

src/util/macro_logger.rs

@@ -52,6 +52,7 @@ macro_rules! log_funding_channel_id {
 	}
 }
 
+#[allow(dead_code)]
 pub(crate) struct DebugRoute<'a>(pub &'a Route);
 impl<'a> std::fmt::Display for DebugRoute<'a> {
 	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
@@ -61,6 +62,7 @@ impl<'a> std::fmt::Display for DebugRoute<'a> {
 		Ok(())
 	}
 }
+#[allow(unused_macros)]
 macro_rules! log_route {
 	($obj: expr) => {
 		::util::macro_logger::DebugRoute(&$obj)