Make routing fees an optional struct for a node info

Author: naumenkogs

lightning/src/ln/network_graph.rs

@@ -40,8 +40,7 @@ impl NetworkGraph {
 		let mut nodes = BTreeMap::new();
 		nodes.insert(our_pubkey.clone(), NodeInfo {
 			channels: Vec::new(),
-			lowest_inbound_channel_fee_base_msat: u32::max_value(),
-			lowest_inbound_channel_fee_proportional_millionths: u32::max_value(),
+			lowest_inbound_channel_fees: None,
 			features: NodeFeatures::empty(),
 			last_update: None,
 			rgb: [0; 3],
@@ -229,15 +228,43 @@ impl_writeable!(ChannelInfo, 0, {
 	announcement_message
 });
 
+
+/// Fees for routing via a given channel or a node
+#[derive(Eq, PartialEq, Copy, Clone, Debug)]
+pub struct RoutingFees {
+	/// Flat routing fee
+	pub base_msat: u32,
+	/// Liquidity-based routing fee
+	pub proportional_millionths: u32,
+}
+
+impl Readable for RoutingFees{
+	fn read<R: ::std::io::Read>(reader: &mut R) -> Result<RoutingFees, DecodeError> {
+		let base_msat: u32 = Readable::read(reader)?;
+		let proportional_millionths: u32 = Readable::read(reader)?;
+		Ok(RoutingFees {
+			base_msat,
+			proportional_millionths,
+		})
+	}
+}
+
+impl Writeable for RoutingFees {
+	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+		self.base_msat.write(writer)?;
+		self.proportional_millionths.write(writer)?;
+		Ok(())
+	}
+}
+
+
 #[derive(PartialEq)]
 /// Details regarding a node in the network
 pub struct NodeInfo {
 	/// All valid channels a node has announced
 	pub channels: Vec<u64>,
-	/// Lowest flat routing fee of all known channels to the node
-	pub lowest_inbound_channel_fee_base_msat: u32,
-	/// Lowest liquidity-based routing fee of all known channels to the node
-	pub lowest_inbound_channel_fee_proportional_millionths: u32,
+	/// Lowest fees enabling routing via any of the known channels to a node
+	pub lowest_inbound_channel_fees: Option<RoutingFees>,
 	/// Protocol features the node announced support for
 	pub features: NodeFeatures,
 	/// When the last known update to the node state was issued
@@ -259,7 +286,7 @@ pub struct NodeInfo {
 
 impl std::fmt::Display for NodeInfo {
 	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
-		write!(f, "features: {}, last_update: {:?}, lowest_inbound_channel_fee_base_msat: {}, lowest_inbound_channel_fee_proportional_millionths: {}, channels: {:?}", log_bytes!(self.features.encode()), self.last_update, self.lowest_inbound_channel_fee_base_msat, self.lowest_inbound_channel_fee_proportional_millionths, &self.channels[..])?;
+		write!(f, "features: {}, last_update: {:?}, lowest_inbound_channel_fees: {:?}, channels: {:?}", log_bytes!(self.features.encode()), self.last_update, self.lowest_inbound_channel_fees, &self.channels[..])?;
 		Ok(())
 	}
 }
@@ -270,8 +297,7 @@ impl Writeable for NodeInfo {
 		for ref chan in self.channels.iter() {
 			chan.write(writer)?;
 		}
-		self.lowest_inbound_channel_fee_base_msat.write(writer)?;
-		self.lowest_inbound_channel_fee_proportional_millionths.write(writer)?;
+		self.lowest_inbound_channel_fees.write(writer)?;
 		self.features.write(writer)?;
 		self.last_update.write(writer)?;
 		self.rgb.write(writer)?;
@@ -294,8 +320,7 @@ impl Readable for NodeInfo {
 		for _ in 0..channels_count {
 			channels.push(Readable::read(reader)?);
 		}
-		let lowest_inbound_channel_fee_base_msat = Readable::read(reader)?;
-		let lowest_inbound_channel_fee_proportional_millionths = Readable::read(reader)?;
+		let lowest_inbound_channel_fees = Readable::read(reader)?;
 		let features = Readable::read(reader)?;
 		let last_update = Readable::read(reader)?;
 		let rgb = Readable::read(reader)?;
@@ -313,8 +338,7 @@ impl Readable for NodeInfo {
 		let announcement_message = Readable::read(reader)?;
 		Ok(NodeInfo {
 			channels,
-			lowest_inbound_channel_fee_base_msat,
-			lowest_inbound_channel_fee_proportional_millionths,
+			lowest_inbound_channel_fees,
 			features,
 			last_update,
 			rgb,
@@ -538,8 +562,7 @@ impl RoutingMessageHandler for NetworkGraph {
 					BtreeEntry::Vacant(node_entry) => {
 						node_entry.insert(NodeInfo {
 							channels: vec!(NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)),
-							lowest_inbound_channel_fee_base_msat: u32::max_value(),
-							lowest_inbound_channel_fee_proportional_millionths: u32::max_value(),
+							lowest_inbound_channel_fees: None,
 							features: NodeFeatures::empty(),
 							last_update: None,
 							rgb: [0; 3],
@@ -630,8 +653,16 @@ impl RoutingMessageHandler for NetworkGraph {
 
 		if chan_enabled {
 			let node = network.nodes.get_mut(&dest_node_id).unwrap();
-			node.lowest_inbound_channel_fee_base_msat = cmp::min(node.lowest_inbound_channel_fee_base_msat, msg.contents.fee_base_msat);
-			node.lowest_inbound_channel_fee_proportional_millionths = cmp::min(node.lowest_inbound_channel_fee_proportional_millionths, msg.contents.fee_proportional_millionths);
+			let mut base_msat = msg.contents.fee_base_msat;
+			let mut proportional_millionths = msg.contents.fee_proportional_millionths;
+			if let Some(fees) = node.lowest_inbound_channel_fees {
+				base_msat = cmp::min(base_msat, fees.base_msat);
+				proportional_millionths = cmp::min(proportional_millionths, fees.proportional_millionths);
+			}
+			node.lowest_inbound_channel_fees = Some(RoutingFees {
+				base_msat,
+				proportional_millionths
+			});
 		} else if chan_was_enabled {
 			let mut lowest_inbound_channel_fee_base_msat = u32::max_value();
 			let mut lowest_inbound_channel_fee_proportional_millionths = u32::max_value();
@@ -653,8 +684,12 @@ impl RoutingMessageHandler for NetworkGraph {
 
 			//TODO: satisfy the borrow-checker without a double-map-lookup :(
 			let mut_node = network.nodes.get_mut(&dest_node_id).unwrap();
-			mut_node.lowest_inbound_channel_fee_base_msat = lowest_inbound_channel_fee_base_msat;
-			mut_node.lowest_inbound_channel_fee_proportional_millionths = lowest_inbound_channel_fee_proportional_millionths;
+			if mut_node.channels.len() > 0 {
+				mut_node.lowest_inbound_channel_fees = Some(RoutingFees {
+					base_msat: lowest_inbound_channel_fee_base_msat,
+					proportional_millionths: lowest_inbound_channel_fee_proportional_millionths
+				});
+			}
 		}
 
 		Ok(msg.contents.excess_data.is_empty())
@@ -720,7 +755,7 @@ impl RoutingMessageHandler for NetworkGraph {
 mod tests {
 	use chain::chaininterface;
 	use ln::features::{ChannelFeatures, NodeFeatures};
-	use ln::network_graph::{NetworkGraph, NetworkMap, DirectionalChannelInfo, ChannelInfo, NodeInfo};
+	use ln::network_graph::{NetworkGraph, NetworkMap, DirectionalChannelInfo, ChannelInfo, NodeInfo, RoutingFees};
 	use ln::msgs::{RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
 	   UnsignedChannelAnnouncement, ChannelAnnouncement, UnsignedChannelUpdate, ChannelUpdate, HTLCFailChannelUpdate};
 	use util::test_utils;
@@ -1541,10 +1576,14 @@ mod tests {
 		let mut network = network_graph.network_map.write().unwrap();
 		let zero_hash = Sha256dHash::hash(&[0; 32]);
 
+
+		let node_routing_fees = RoutingFees {
+			base_msat: 100,
+			proportional_millionths: 0,
+		};
 		network.nodes.insert(node1.clone(), NodeInfo {
 			channels: vec!(NetworkMap::get_key(1, zero_hash.clone()), NetworkMap::get_key(3, zero_hash.clone())),
-			lowest_inbound_channel_fee_base_msat: 100,
-			lowest_inbound_channel_fee_proportional_millionths: 0,
+			lowest_inbound_channel_fees: Some(node_routing_fees),
 			features: NodeFeatures::supported(),
 			last_update: Some(1),
 			rgb: [0; 3],

lightning/src/ln/router.rs

@@ -8,7 +8,7 @@ use secp256k1::key::PublicKey;
 use ln::channelmanager;
 use ln::features::{ChannelFeatures, NodeFeatures};
 use ln::msgs::{DecodeError,ErrorAction,LightningError};
-use ln::network_graph::NetworkGraph;
+use ln::network_graph::{NetworkGraph};
 use util::ser::{Writeable, Readable};
 use util::logger::Logger;
 
@@ -245,9 +245,15 @@ impl Router {
 						let hm_entry = dist.entry(&$directional_info.src_node_id);
 						let old_entry = hm_entry.or_insert_with(|| {
 							let node = network.nodes.get(&$directional_info.src_node_id).unwrap();
+							let mut fee_base_msat = 0;
+							let mut fee_proportional_millionths = 0;
+							if let Some(fees) = node.lowest_inbound_channel_fees {
+								fee_base_msat = fees.base_msat;
+								fee_proportional_millionths = fees.proportional_millionths;
+							};
 							(u64::max_value(),
-								node.lowest_inbound_channel_fee_base_msat,
-								node.lowest_inbound_channel_fee_proportional_millionths,
+								fee_base_msat,
+								fee_proportional_millionths,
 								RouteHop {
 									pubkey: $dest_node_id.clone(),
 									node_features: NodeFeatures::empty(),
@@ -397,7 +403,7 @@ impl Router {
 #[cfg(test)]
 mod tests {
 	use chain::chaininterface;
-	use ln::network_graph::{NetworkGraph, NodeInfo, NetworkMap, ChannelInfo, DirectionalChannelInfo};
+	use ln::network_graph::{NetworkGraph, NodeInfo, NetworkMap, ChannelInfo, DirectionalChannelInfo, RoutingFees};
 	use ln::router::{Router, RouteHint};
 	use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
 	use ln::msgs::{ErrorAction, LightningError};
@@ -512,10 +518,13 @@ mod tests {
 		{
 			let mut network = network_graph.network_map.write().unwrap();
 
+			let routing_fees = RoutingFees {
+				base_msat: 100,
+				proportional_millionths: 0
+			};
 			network.nodes.insert(node1.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(1, zero_hash.clone()), NetworkMap::get_key(3, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 100,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(1)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -546,10 +555,13 @@ mod tests {
 				},
 				announcement_message: None,
 			});
+			let routing_fees = RoutingFees {
+				base_msat: 0,
+				proportional_millionths: 0
+			};
 			network.nodes.insert(node2.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(2, zero_hash.clone()), NetworkMap::get_key(4, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(2)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -582,8 +594,7 @@ mod tests {
 			});
 			network.nodes.insert(node8.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(12, zero_hash.clone()), NetworkMap::get_key(13, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(8)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -622,8 +633,7 @@ mod tests {
 					NetworkMap::get_key(5, zero_hash.clone()),
 					NetworkMap::get_key(6, zero_hash.clone()),
 					NetworkMap::get_key(7, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(3)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -702,8 +712,7 @@ mod tests {
 			});
 			network.nodes.insert(node4.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(5, zero_hash.clone()), NetworkMap::get_key(11, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(4)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -736,8 +745,7 @@ mod tests {
 			});
 			network.nodes.insert(node5.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(6, zero_hash.clone()), NetworkMap::get_key(11, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(5)),
 				last_update: Some(1),
 				rgb: [0; 3],
@@ -793,8 +801,7 @@ mod tests {
 			});
 			network.nodes.insert(node6.clone(), NodeInfo {
 				channels: vec!(NetworkMap::get_key(7, zero_hash.clone())),
-				lowest_inbound_channel_fee_base_msat: 0,
-				lowest_inbound_channel_fee_proportional_millionths: 0,
+				lowest_inbound_channel_fees: Some(routing_fees.clone()),
 				features: NodeFeatures::from_le_bytes(id_to_feature_flags!(6)),
 				last_update: Some(1),
 				rgb: [0; 3],