use bitcoin::util::hash::Sha256dHash;
+use ln::channelmanager;
use ln::msgs::{ErrorAction,HandleError,RoutingMessageHandler,MsgEncodable,NetAddress,GlobalFeatures};
use ln::msgs;
/// The fee taken on this hop. For the last hop, this should be the full value of the payment.
pub fee_msat: u64,
/// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
- /// expected at the destination, NOT a delta.
+ /// expected at the destination, in excess of the current block height.
pub cltv_expiry_delta: u32,
}
( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr ) => {
match $secp_ctx.verify($msg, $sig, $pubkey) {
Ok(_) => {},
- Err(_) => return Err(HandleError{err: "Invalid signature from remote node", msg: None}),
+ Err(_) => return Err(HandleError{err: "Invalid signature from remote node", action: None}),
}
};
}
let mut network = self.network_map.write().unwrap();
match network.nodes.get_mut(&msg.contents.node_id) {
- None => Err(HandleError{err: "No existing channels for node_announcement", msg: Some(ErrorAction::IgnoreError)}),
+ None => Err(HandleError{err: "No existing channels for node_announcement", action: Some(ErrorAction::IgnoreError)}),
Some(node) => {
if node.last_update >= msg.contents.timestamp {
- return Err(HandleError{err: "Update older than last processed update", msg: Some(ErrorAction::IgnoreError)});
+ return Err(HandleError{err: "Update older than last processed update", action: Some(ErrorAction::IgnoreError)});
}
node.features = msg.contents.features.clone();
//TODO: Only allow bitcoin chain_hash
if msg.contents.features.requires_unknown_bits() {
- return Err(HandleError{err: "Channel announcement required unknown feature flags", msg: None});
+ return Err(HandleError{err: "Channel announcement required unknown feature flags", action: None});
}
let mut network = self.network_map.write().unwrap();
//TODO: because asking the blockchain if short_channel_id is valid is only optional
//in the blockchain API, we need to handle it smartly here, though its unclear
//exactly how...
- return Err(HandleError{err: "Already have knowledge of channel", msg: Some(ErrorAction::IgnoreError)})
+ return Err(HandleError{err: "Already have knowledge of channel", action: Some(ErrorAction::IgnoreError)})
},
Entry::Vacant(entry) => {
entry.insert(ChannelInfo {
let chan_was_enabled;
match network.channels.get_mut(&NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)) {
- None => return Err(HandleError{err: "Couldn't find channel for update", msg: Some(ErrorAction::IgnoreError)}),
+ None => return Err(HandleError{err: "Couldn't find channel for update", action: Some(ErrorAction::IgnoreError)}),
Some(channel) => {
macro_rules! maybe_update_channel_info {
( $target: expr) => {
if $target.last_update >= msg.contents.timestamp {
- return Err(HandleError{err: "Update older than last processed update", msg: Some(ErrorAction::IgnoreError)});
+ return Err(HandleError{err: "Update older than last processed update", action: Some(ErrorAction::IgnoreError)});
}
chan_was_enabled = $target.enabled;
$target.last_update = msg.contents.timestamp;
}
}
+struct DummyDirectionalChannelInfo {
+ src_node_id: PublicKey,
+ cltv_expiry_delta: u32,
+ htlc_minimum_msat: u64,
+ fee_base_msat: u32,
+ fee_proportional_millionths: u32,
+}
+
impl Router {
pub fn new(our_pubkey: PublicKey) -> Router {
let mut nodes = HashMap::new();
}
}
+ /// Get network addresses by node id
+ pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
+ let network = self.network_map.read().unwrap();
+ network.nodes.get(pubkey).map(|n| n.addresses.clone())
+ }
+
/// Marks a node as having failed a route. This will avoid re-using the node in routes for now,
/// with an expotnential decay in node "badness". Note that there is deliberately no
/// mark_channel_bad as a node may simply lie and suggest that an upstream channel from it is
/// Gets a route from us to the given target node.
/// Extra routing hops between known nodes and the target will be used if they are included in
/// last_hops.
+ /// If some channels aren't announced, it may be useful to fill in a first_hops with the
+ /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
+ /// (this Router's) view of our local channels will be ignored, and only those in first_hops
+ /// will be used. Panics if first_hops contains channels without short_channel_ids
+ /// (ChannelManager::list_usable_channels will never include such channels).
/// The fees on channels from us to next-hops are ignored (as they are assumed to all be
/// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
/// *is* checked as they may change based on the receiving node.
- pub fn get_route(&self, target: &PublicKey, last_hops: &Vec<RouteHint>, final_value_msat: u64, final_cltv: u32) -> Result<Route, HandleError> {
+ pub fn get_route(&self, target: &PublicKey, first_hops: Option<&[channelmanager::ChannelDetails]>, last_hops: &[RouteHint], final_value_msat: u64, final_cltv: u32) -> Result<Route, HandleError> {
// TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
// uptime/success in using a node in the past.
let network = self.network_map.read().unwrap();
if *target == network.our_node_id {
- return Err(HandleError{err: "Cannot generate a route to ourselves", msg: None});
+ return Err(HandleError{err: "Cannot generate a route to ourselves", action: None});
}
// We do a dest-to-source Dijkstra's sorting by each node's distance from the destination
// to use as the A* heuristic beyond just the cost to get one node further than the current
// one.
+ let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
+ src_node_id: network.our_node_id.clone(),
+ cltv_expiry_delta: 0,
+ htlc_minimum_msat: 0,
+ fee_base_msat: 0,
+ fee_proportional_millionths: 0,
+ };
+
let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
let mut dist = HashMap::with_capacity(network.nodes.len());
- for (key, node) in network.nodes.iter() {
- dist.insert(key.clone(), (u64::max_value(),
- node.lowest_inbound_channel_fee_base_msat as u64,
- node.lowest_inbound_channel_fee_proportional_millionths as u64,
- RouteHop {
- pubkey: PublicKey::new(),
- short_channel_id: 0,
- fee_msat: 0,
- cltv_expiry_delta: 0,
- }));
+
+ let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
+ if let Some(hops) = first_hops {
+ for chan in hops {
+ let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
+ if chan.remote_network_id == *target {
+ return Ok(Route {
+ hops: vec![RouteHop {
+ pubkey: chan.remote_network_id,
+ short_channel_id,
+ fee_msat: final_value_msat,
+ cltv_expiry_delta: final_cltv,
+ }],
+ });
+ }
+ first_hop_targets.insert(chan.remote_network_id, short_channel_id);
+ }
+ if first_hop_targets.is_empty() {
+ return Err(HandleError{err: "Cannot route when there are no outbound routes away from us", action: None});
+ }
}
macro_rules! add_entry {
( $chan_id: expr, $dest_node_id: expr, $directional_info: expr, $starting_fee_msat: expr ) => {
//TODO: Explore simply adding fee to hit htlc_minimum_msat
if $starting_fee_msat as u64 + final_value_msat > $directional_info.htlc_minimum_msat {
- let new_fee = $directional_info.fee_base_msat as u64 + ($starting_fee_msat + final_value_msat) * ($directional_info.fee_proportional_millionths as u64) / 1000000;
- let mut total_fee = $starting_fee_msat as u64;
- let old_entry = dist.get_mut(&$directional_info.src_node_id).unwrap();
- if $directional_info.src_node_id != network.our_node_id {
- // Ignore new_fee for channel-from-us as we assume all channels-from-us
- // will have the same effective-fee
- total_fee += new_fee;
- total_fee += old_entry.2 * (final_value_msat + total_fee) / 1000000 + old_entry.1;
- }
- let new_graph_node = RouteGraphNode {
- pubkey: $directional_info.src_node_id,
- lowest_fee_to_peer_through_node: total_fee,
- };
- if old_entry.0 > total_fee {
- targets.push(new_graph_node);
- old_entry.0 = total_fee;
- old_entry.3 = RouteHop {
- pubkey: $dest_node_id.clone(),
- short_channel_id: $chan_id.clone(),
- fee_msat: new_fee, // This field is ignored on the last-hop anyway
- cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
+ let proportional_fee_millions = ($starting_fee_msat + final_value_msat).checked_mul($directional_info.fee_proportional_millionths as u64);
+ if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
+ ($directional_info.fee_base_msat as u64).checked_add(part / 1000000) })
+ {
+ let mut total_fee = $starting_fee_msat as u64;
+ 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();
+ (u64::max_value(),
+ node.lowest_inbound_channel_fee_base_msat as u64,
+ node.lowest_inbound_channel_fee_proportional_millionths as u64,
+ RouteHop {
+ pubkey: PublicKey::new(),
+ short_channel_id: 0,
+ fee_msat: 0,
+ cltv_expiry_delta: 0,
+ })
+ });
+ if $directional_info.src_node_id != network.our_node_id {
+ // Ignore new_fee for channel-from-us as we assume all channels-from-us
+ // will have the same effective-fee
+ total_fee += new_fee;
+ total_fee += old_entry.2 * (final_value_msat + total_fee) / 1000000 + old_entry.1;
+ }
+ let new_graph_node = RouteGraphNode {
+ pubkey: $directional_info.src_node_id,
+ lowest_fee_to_peer_through_node: total_fee,
+ };
+ if old_entry.0 > total_fee {
+ targets.push(new_graph_node);
+ old_entry.0 = total_fee;
+ old_entry.3 = RouteHop {
+ pubkey: $dest_node_id.clone(),
+ short_channel_id: $chan_id.clone(),
+ fee_msat: new_fee, // This field is ignored on the last-hop anyway
+ cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
+ }
}
}
}
macro_rules! add_entries_to_cheapest_to_target_node {
( $node: expr, $node_id: expr, $fee_to_target_msat: expr ) => {
+ if first_hops.is_some() {
+ if let Some(first_hop) = first_hop_targets.get(&$node_id) {
+ add_entry!(first_hop, $node_id, dummy_directional_info, $fee_to_target_msat);
+ }
+ }
+
for chan_id in $node.channels.iter() {
let chan = network.channels.get(chan_id).unwrap();
if chan.one_to_two.src_node_id == *$node_id {
// ie $node is one, ie next hop in A* is two, via the two_to_one channel
- if chan.two_to_one.enabled {
- add_entry!(chan_id, chan.one_to_two.src_node_id, chan.two_to_one, $fee_to_target_msat);
+ if first_hops.is_none() || chan.two_to_one.src_node_id != network.our_node_id {
+ if chan.two_to_one.enabled {
+ add_entry!(chan_id, chan.one_to_two.src_node_id, chan.two_to_one, $fee_to_target_msat);
+ }
}
} else {
- if chan.one_to_two.enabled {
- add_entry!(chan_id, chan.two_to_one.src_node_id, chan.one_to_two, $fee_to_target_msat);
+ if first_hops.is_none() || chan.one_to_two.src_node_id != network.our_node_id {
+ if chan.one_to_two.enabled {
+ add_entry!(chan_id, chan.two_to_one.src_node_id, chan.one_to_two, $fee_to_target_msat);
+ }
}
}
}
}
for hop in last_hops.iter() {
- if network.nodes.get(&hop.src_node_id).is_some() {
- add_entry!(hop.short_channel_id, target, hop, 0);
+ if first_hops.is_none() || hop.src_node_id != network.our_node_id { // first_hop overrules last_hops
+ if network.nodes.get(&hop.src_node_id).is_some() {
+ if first_hops.is_some() {
+ if let Some(first_hop) = first_hop_targets.get(&hop.src_node_id) {
+ add_entry!(first_hop, hop.src_node_id, dummy_directional_info, 0);
+ }
+ }
+ add_entry!(hop.short_channel_id, target, hop, 0);
+ }
}
}
}
}
- Err(HandleError{err: "Failed to find a path to the given destination", msg: None})
+ Err(HandleError{err: "Failed to find a path to the given destination", action: None})
}
}
#[cfg(test)]
mod tests {
+ use ln::channelmanager;
use ln::router::{Router,NodeInfo,NetworkMap,ChannelInfo,DirectionalChannelInfo,RouteHint};
use ln::msgs::GlobalFeatures;
// Build network from our_id to node8:
//
- // -1(1)2- node1 -1(3)2-
- // / \
- // our_id - node3
- // \ /
- // -1(2)2- node2 -1(4)2-
+ // -1(1)2- node1 -1(3)2-
+ // / \
+ // our_id -1(12)2- node8 -1(13)2--- node3
+ // \ /
+ // -1(2)2- node2 -1(4)2-
+ //
//
+ // chan1 1-to-2: disabled
+ // chan1 2-to-1: enabled, 0 fee
//
- // chan1 1-to-2: disabled
- // chan1 2-to-1: enabled, 0 fee
+ // chan2 1-to-2: enabled, ignored fee
+ // chan2 2-to-1: enabled, 0 fee
//
- // chan2 1-to-2: enabled, ignored fee
- // chan2 2-to-1: enabled, 0 fee
+ // chan3 1-to-2: enabled, 0 fee
+ // chan3 2-to-1: enabled, 100 msat fee
//
- // chan3 1-to-2: enabled, 0 fee
- // chan3 2-to-1: enabled, 100 msat fee
+ // chan4 1-to-2: enabled, 100% fee
+ // chan4 2-to-1: enabled, 0 fee
//
- // chan4 1-to-2: enabled, 100% fee
- // chan4 2-to-1: enabled, 0 fee
+ // chan12 1-to-2: enabled, ignored fee
+ // chan12 2-to-1: enabled, 0 fee
//
+ // chan13 1-to-2: enabled, 200% fee
+ // chan13 2-to-1: enabled, 0 fee
//
//
// -1(5)2- node4 -1(8)2--
let node5 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex_bytes("0606060606060606060606060606060606060606060606060606060606060606").unwrap()[..]).unwrap()).unwrap();
let node6 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex_bytes("0707070707070707070707070707070707070707070707070707070707070707").unwrap()[..]).unwrap()).unwrap();
let node7 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex_bytes("0808080808080808080808080808080808080808080808080808080808080808").unwrap()[..]).unwrap()).unwrap();
+ let node8 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex_bytes("0909090909090909090909090909090909090909090909090909090909090909").unwrap()[..]).unwrap()).unwrap();
let zero_hash = Sha256dHash::from_data(&[0; 32]);
fee_proportional_millionths: 0,
},
});
+ 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,
+ features: GlobalFeatures::new(),
+ last_update: 1,
+ rgb: [0; 3],
+ alias: [0; 32],
+ addresses: Vec::new(),
+ });
+ network.channels.insert(NetworkMap::get_key(12, zero_hash.clone()), ChannelInfo {
+ features: GlobalFeatures::new(),
+ one_to_two: DirectionalChannelInfo {
+ src_node_id: our_id.clone(),
+ last_update: 0,
+ enabled: true,
+ cltv_expiry_delta: u16::max_value(), // This value should be ignored
+ htlc_minimum_msat: 0,
+ fee_base_msat: u32::max_value(), // This value should be ignored
+ fee_proportional_millionths: u32::max_value(), // This value should be ignored
+ }, two_to_one: DirectionalChannelInfo {
+ src_node_id: node8.clone(),
+ last_update: 0,
+ enabled: true,
+ cltv_expiry_delta: 0,
+ htlc_minimum_msat: 0,
+ fee_base_msat: 0,
+ fee_proportional_millionths: 0,
+ },
+ });
network.nodes.insert(node3.clone(), NodeInfo {
channels: vec!(
NetworkMap::get_key(3, zero_hash.clone()),
NetworkMap::get_key(4, zero_hash.clone()),
+ NetworkMap::get_key(13, zero_hash.clone()),
NetworkMap::get_key(5, zero_hash.clone()),
NetworkMap::get_key(6, zero_hash.clone()),
NetworkMap::get_key(7, zero_hash.clone())),
fee_proportional_millionths: 0,
},
});
+ network.channels.insert(NetworkMap::get_key(13, zero_hash.clone()), ChannelInfo {
+ features: GlobalFeatures::new(),
+ one_to_two: DirectionalChannelInfo {
+ src_node_id: node8.clone(),
+ last_update: 0,
+ enabled: true,
+ cltv_expiry_delta: (13 << 8) | 1,
+ htlc_minimum_msat: 0,
+ fee_base_msat: 0,
+ fee_proportional_millionths: 2000000,
+ }, two_to_one: DirectionalChannelInfo {
+ src_node_id: node3.clone(),
+ last_update: 0,
+ enabled: true,
+ cltv_expiry_delta: (13 << 8) | 2,
+ htlc_minimum_msat: 0,
+ fee_base_msat: 0,
+ fee_proportional_millionths: 0,
+ },
+ });
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,
}
{ // Simple route to 3 via 2
- let route = router.get_route(&node3, &Vec::new(), 100, 42).unwrap();
+ let route = router.get_route(&node3, None, &Vec::new(), 100, 42).unwrap();
assert_eq!(route.hops.len(), 2);
assert_eq!(route.hops[0].pubkey, node2);
}
{ // Route to 1 via 2 and 3 because our channel to 1 is disabled
- let route = router.get_route(&node1, &Vec::new(), 100, 42).unwrap();
+ let route = router.get_route(&node1, None, &Vec::new(), 100, 42).unwrap();
assert_eq!(route.hops.len(), 3);
assert_eq!(route.hops[0].pubkey, node2);
assert_eq!(route.hops[2].cltv_expiry_delta, 42);
}
+ { // If we specify a channel to node8, that overrides our local channel view and that gets used
+ let our_chans = vec![channelmanager::ChannelDetails {
+ channel_id: [0; 32],
+ short_channel_id: Some(42),
+ remote_network_id: node8.clone(),
+ channel_value_satoshis: 0,
+ user_id: 0,
+ }];
+ let route = router.get_route(&node3, Some(&our_chans), &Vec::new(), 100, 42).unwrap();
+ assert_eq!(route.hops.len(), 2);
+
+ assert_eq!(route.hops[0].pubkey, node8);
+ assert_eq!(route.hops[0].short_channel_id, 42);
+ assert_eq!(route.hops[0].fee_msat, 200);
+ assert_eq!(route.hops[0].cltv_expiry_delta, (13 << 8) | 1);
+
+ assert_eq!(route.hops[1].pubkey, node3);
+ assert_eq!(route.hops[1].short_channel_id, 13);
+ assert_eq!(route.hops[1].fee_msat, 100);
+ assert_eq!(route.hops[1].cltv_expiry_delta, 42);
+ }
+
let mut last_hops = vec!(RouteHint {
src_node_id: node4.clone(),
short_channel_id: 8,
});
{ // Simple test across 2, 3, 5, and 4 via a last_hop channel
- let route = router.get_route(&node7, &last_hops, 100, 42).unwrap();
+ let route = router.get_route(&node7, None, &last_hops, 100, 42).unwrap();
assert_eq!(route.hops.len(), 5);
assert_eq!(route.hops[0].pubkey, node2);
assert_eq!(route.hops[4].cltv_expiry_delta, 42);
}
+ { // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
+ let our_chans = vec![channelmanager::ChannelDetails {
+ channel_id: [0; 32],
+ short_channel_id: Some(42),
+ remote_network_id: node4.clone(),
+ channel_value_satoshis: 0,
+ user_id: 0,
+ }];
+ let route = router.get_route(&node7, Some(&our_chans), &last_hops, 100, 42).unwrap();
+ assert_eq!(route.hops.len(), 2);
+
+ assert_eq!(route.hops[0].pubkey, node4);
+ assert_eq!(route.hops[0].short_channel_id, 42);
+ assert_eq!(route.hops[0].fee_msat, 0);
+ assert_eq!(route.hops[0].cltv_expiry_delta, (8 << 8) | 1);
+
+ assert_eq!(route.hops[1].pubkey, node7);
+ assert_eq!(route.hops[1].short_channel_id, 8);
+ assert_eq!(route.hops[1].fee_msat, 100);
+ assert_eq!(route.hops[1].cltv_expiry_delta, 42);
+ }
+
last_hops[0].fee_base_msat = 1000;
{ // Revert to via 6 as the fee on 8 goes up
- let route = router.get_route(&node7, &last_hops, 100, 42).unwrap();
+ let route = router.get_route(&node7, None, &last_hops, 100, 42).unwrap();
assert_eq!(route.hops.len(), 4);
assert_eq!(route.hops[0].pubkey, node2);
}
{ // ...but still use 8 for larger payments as 6 has a variable feerate
- let route = router.get_route(&node7, &last_hops, 2000, 42).unwrap();
+ let route = router.get_route(&node7, None, &last_hops, 2000, 42).unwrap();
assert_eq!(route.hops.len(), 5);
assert_eq!(route.hops[0].pubkey, node2);
projects / rust-lightning / blobdiff