1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level routing/network map tracking logic lives here.
12 //! You probably want to create a NetGraphMsgHandler and use that as your RoutingMessageHandler and then
13 //! interrogate it to get routes for your own payments.
15 use bitcoin::secp256k1::key::PublicKey;
17 use ln::channelmanager::ChannelDetails;
18 use ln::features::{ChannelFeatures, NodeFeatures};
19 use ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT};
20 use routing::network_graph::{NetworkGraph, RoutingFees};
21 use util::ser::{Writeable, Readable};
22 use util::logger::Logger;
25 use std::collections::{HashMap,BinaryHeap};
29 #[derive(Clone, PartialEq)]
31 /// The node_id of the node at this hop.
32 pub pubkey: PublicKey,
33 /// The node_announcement features of the node at this hop. For the last hop, these may be
34 /// amended to match the features present in the invoice this node generated.
35 pub node_features: NodeFeatures,
36 /// The channel that should be used from the previous hop to reach this node.
37 pub short_channel_id: u64,
38 /// The channel_announcement features of the channel that should be used from the previous hop
39 /// to reach this node.
40 pub channel_features: ChannelFeatures,
41 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
43 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
44 /// expected at the destination, in excess of the current block height.
45 pub cltv_expiry_delta: u32,
48 impl Writeable for Vec<RouteHop> {
49 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
50 (self.len() as u8).write(writer)?;
51 for hop in self.iter() {
52 hop.pubkey.write(writer)?;
53 hop.node_features.write(writer)?;
54 hop.short_channel_id.write(writer)?;
55 hop.channel_features.write(writer)?;
56 hop.fee_msat.write(writer)?;
57 hop.cltv_expiry_delta.write(writer)?;
63 impl Readable for Vec<RouteHop> {
64 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Vec<RouteHop>, DecodeError> {
65 let hops_count: u8 = Readable::read(reader)?;
66 let mut hops = Vec::with_capacity(hops_count as usize);
67 for _ in 0..hops_count {
69 pubkey: Readable::read(reader)?,
70 node_features: Readable::read(reader)?,
71 short_channel_id: Readable::read(reader)?,
72 channel_features: Readable::read(reader)?,
73 fee_msat: Readable::read(reader)?,
74 cltv_expiry_delta: Readable::read(reader)?,
81 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
82 /// it can take multiple paths. Each path is composed of one or more hops through the network.
83 #[derive(Clone, PartialEq)]
85 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
86 /// last RouteHop in each path must be the same.
87 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
88 /// destination. Thus, this must always be at least length one. While the maximum length of any
89 /// given path is variable, keeping the length of any path to less than 20 should currently
90 /// ensure it is viable.
91 pub paths: Vec<Vec<RouteHop>>,
94 impl Writeable for Route {
95 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
96 (self.paths.len() as u64).write(writer)?;
97 for hops in self.paths.iter() {
104 impl Readable for Route {
105 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
106 let path_count: u64 = Readable::read(reader)?;
107 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
108 for _ in 0..path_count {
109 paths.push(Readable::read(reader)?);
115 /// A channel descriptor which provides a last-hop route to get_route
116 pub struct RouteHint {
117 /// The node_id of the non-target end of the route
118 pub src_node_id: PublicKey,
119 /// The short_channel_id of this channel
120 pub short_channel_id: u64,
121 /// The fees which must be paid to use this channel
122 pub fees: RoutingFees,
123 /// The difference in CLTV values between this node and the next node.
124 pub cltv_expiry_delta: u16,
125 /// The minimum value, in msat, which must be relayed to the next hop.
126 pub htlc_minimum_msat: u64,
129 #[derive(Eq, PartialEq)]
130 struct RouteGraphNode {
132 lowest_fee_to_peer_through_node: u64,
133 lowest_fee_to_node: u64,
136 impl cmp::Ord for RouteGraphNode {
137 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
138 other.lowest_fee_to_peer_through_node.cmp(&self.lowest_fee_to_peer_through_node)
139 .then_with(|| other.pubkey.serialize().cmp(&self.pubkey.serialize()))
143 impl cmp::PartialOrd for RouteGraphNode {
144 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
145 Some(self.cmp(other))
149 struct DummyDirectionalChannelInfo {
150 cltv_expiry_delta: u32,
151 htlc_minimum_msat: u64,
156 /// Gets a route from us to the given target node.
158 /// Extra routing hops between known nodes and the target will be used if they are included in
161 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
162 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
163 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those in first_hops
166 /// Panics if first_hops contains channels without short_channel_ids
167 /// (ChannelManager::list_usable_channels will never include such channels).
169 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
170 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
171 /// *is* checked as they may change based on the receiving node.
172 pub fn get_route<L: Deref>(our_node_id: &PublicKey, network: &NetworkGraph, target: &PublicKey, first_hops: Option<&[&ChannelDetails]>,
173 last_hops: &[&RouteHint], final_value_msat: u64, final_cltv: u32, logger: L) -> Result<Route, LightningError> where L::Target: Logger {
174 // TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
175 // uptime/success in using a node in the past.
176 if *target == *our_node_id {
177 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
180 if final_value_msat > MAX_VALUE_MSAT {
181 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
184 // We do a dest-to-source Dijkstra's sorting by each node's distance from the destination
185 // plus the minimum per-HTLC fee to get from it to another node (aka "shitty A*").
186 // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
187 // to use as the A* heuristic beyond just the cost to get one node further than the current
190 let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
191 cltv_expiry_delta: 0,
192 htlc_minimum_msat: 0,
195 proportional_millionths: 0,
199 let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
200 let mut dist = HashMap::with_capacity(network.get_nodes().len());
202 let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
203 if let Some(hops) = first_hops {
205 let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
206 if chan.remote_network_id == *target {
208 paths: vec![vec![RouteHop {
209 pubkey: chan.remote_network_id,
210 node_features: chan.counterparty_features.to_context(),
212 channel_features: chan.counterparty_features.to_context(),
213 fee_msat: final_value_msat,
214 cltv_expiry_delta: final_cltv,
218 first_hop_targets.insert(chan.remote_network_id, (short_channel_id, chan.counterparty_features.clone()));
220 if first_hop_targets.is_empty() {
221 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
225 macro_rules! add_entry {
226 // Adds entry which goes from $src_node_id to $dest_node_id
227 // over the channel with id $chan_id with fees described in
228 // $directional_info.
229 ( $chan_id: expr, $src_node_id: expr, $dest_node_id: expr, $directional_info: expr, $chan_features: expr, $starting_fee_msat: expr ) => {
230 //TODO: Explore simply adding fee to hit htlc_minimum_msat
231 if $starting_fee_msat as u64 + final_value_msat >= $directional_info.htlc_minimum_msat {
232 let proportional_fee_millions = ($starting_fee_msat + final_value_msat).checked_mul($directional_info.fees.proportional_millionths as u64);
233 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
234 ($directional_info.fees.base_msat as u64).checked_add(part / 1000000) })
236 let mut total_fee = $starting_fee_msat as u64;
237 let hm_entry = dist.entry(&$src_node_id);
238 let old_entry = hm_entry.or_insert_with(|| {
239 let node = network.get_nodes().get(&$src_node_id).unwrap();
240 let mut fee_base_msat = u32::max_value();
241 let mut fee_proportional_millionths = u32::max_value();
242 if let Some(fees) = node.lowest_inbound_channel_fees {
243 fee_base_msat = fees.base_msat;
244 fee_proportional_millionths = fees.proportional_millionths;
248 fee_proportional_millionths,
250 pubkey: $dest_node_id.clone(),
251 node_features: NodeFeatures::empty(),
253 channel_features: $chan_features.clone(),
255 cltv_expiry_delta: 0,
259 if $src_node_id != *our_node_id {
260 // Ignore new_fee for channel-from-us as we assume all channels-from-us
261 // will have the same effective-fee
262 total_fee += new_fee;
263 if let Some(fee_inc) = final_value_msat.checked_add(total_fee).and_then(|inc| { (old_entry.2 as u64).checked_mul(inc) }) {
264 total_fee += fee_inc / 1000000 + (old_entry.1 as u64);
266 // max_value means we'll always fail the old_entry.0 > total_fee check
267 total_fee = u64::max_value();
270 let new_graph_node = RouteGraphNode {
271 pubkey: $src_node_id,
272 lowest_fee_to_peer_through_node: total_fee,
273 lowest_fee_to_node: $starting_fee_msat as u64 + new_fee,
275 if old_entry.0 > total_fee {
276 targets.push(new_graph_node);
277 old_entry.0 = total_fee;
278 old_entry.3 = RouteHop {
279 pubkey: $dest_node_id.clone(),
280 node_features: NodeFeatures::empty(),
281 short_channel_id: $chan_id.clone(),
282 channel_features: $chan_features.clone(),
283 fee_msat: new_fee, // This field is ignored on the last-hop anyway
284 cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
292 macro_rules! add_entries_to_cheapest_to_target_node {
293 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr ) => {
294 if first_hops.is_some() {
295 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&$node_id) {
296 add_entry!(first_hop, *our_node_id, $node_id, dummy_directional_info, features.to_context(), $fee_to_target_msat);
301 if let Some(node_info) = $node.announcement_info.as_ref() {
302 features = node_info.features.clone();
304 features = NodeFeatures::empty();
307 if !features.requires_unknown_bits() {
308 for chan_id in $node.channels.iter() {
309 let chan = network.get_channels().get(chan_id).unwrap();
310 if !chan.features.requires_unknown_bits() {
311 if chan.node_one == *$node_id {
312 // ie $node is one, ie next hop in A* is two, via the two_to_one channel
313 if first_hops.is_none() || chan.node_two != *our_node_id {
314 if let Some(two_to_one) = chan.two_to_one.as_ref() {
315 if two_to_one.enabled {
316 add_entry!(chan_id, chan.node_two, chan.node_one, two_to_one, chan.features, $fee_to_target_msat);
321 if first_hops.is_none() || chan.node_one != *our_node_id {
322 if let Some(one_to_two) = chan.one_to_two.as_ref() {
323 if one_to_two.enabled {
324 add_entry!(chan_id, chan.node_one, chan.node_two, one_to_two, chan.features, $fee_to_target_msat);
336 match network.get_nodes().get(target) {
339 add_entries_to_cheapest_to_target_node!(node, target, 0);
343 for hop in last_hops.iter() {
344 if first_hops.is_none() || hop.src_node_id != *our_node_id { // first_hop overrules last_hops
345 if network.get_nodes().get(&hop.src_node_id).is_some() {
346 if first_hops.is_some() {
347 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&hop.src_node_id) {
348 // Currently there are no channel-context features defined, so we are a
349 // bit lazy here. In the future, we should pull them out via our
350 // ChannelManager, but there's no reason to waste the space until we
352 add_entry!(first_hop, *our_node_id , hop.src_node_id, dummy_directional_info, features.to_context(), 0);
355 // BOLT 11 doesn't allow inclusion of features for the last hop hints, which
356 // really sucks, cause we're gonna need that eventually.
357 add_entry!(hop.short_channel_id, hop.src_node_id, target, hop, ChannelFeatures::empty(), 0);
362 while let Some(RouteGraphNode { pubkey, lowest_fee_to_node, .. }) = targets.pop() {
363 if pubkey == *our_node_id {
364 let mut res = vec!(dist.remove(&our_node_id).unwrap().3);
366 if let Some(&(_, ref features)) = first_hop_targets.get(&res.last().unwrap().pubkey) {
367 res.last_mut().unwrap().node_features = features.to_context();
368 } else if let Some(node) = network.get_nodes().get(&res.last().unwrap().pubkey) {
369 if let Some(node_info) = node.announcement_info.as_ref() {
370 res.last_mut().unwrap().node_features = node_info.features.clone();
372 res.last_mut().unwrap().node_features = NodeFeatures::empty();
375 // We should be able to fill in features for everything except the last
376 // hop, if the last hop was provided via a BOLT 11 invoice (though we
377 // should be able to extend it further as BOLT 11 does have feature
378 // flags for the last hop node itself).
379 assert!(res.last().unwrap().pubkey == *target);
381 if res.last().unwrap().pubkey == *target {
385 let new_entry = match dist.remove(&res.last().unwrap().pubkey) {
387 None => return Err(LightningError{err: "Failed to find a non-fee-overflowing path to the given destination".to_owned(), action: ErrorAction::IgnoreError}),
389 res.last_mut().unwrap().fee_msat = new_entry.fee_msat;
390 res.last_mut().unwrap().cltv_expiry_delta = new_entry.cltv_expiry_delta;
393 res.last_mut().unwrap().fee_msat = final_value_msat;
394 res.last_mut().unwrap().cltv_expiry_delta = final_cltv;
395 let route = Route { paths: vec![res] };
396 log_trace!(logger, "Got route: {}", log_route!(route));
400 match network.get_nodes().get(&pubkey) {
403 add_entries_to_cheapest_to_target_node!(node, &pubkey, lowest_fee_to_node);
408 Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError})
413 use chain::chaininterface;
414 use routing::router::{get_route, RouteHint, RoutingFees};
415 use routing::network_graph::NetGraphMsgHandler;
416 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
417 use ln::msgs::{ErrorAction, LightningError, OptionalField, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler,
418 NodeAnnouncement, UnsignedNodeAnnouncement, ChannelUpdate, UnsignedChannelUpdate};
419 use ln::channelmanager;
420 use util::test_utils;
421 use util::ser::Writeable;
423 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
424 use bitcoin::hashes::Hash;
425 use bitcoin::network::constants::Network;
426 use bitcoin::blockdata::constants::genesis_block;
430 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
431 use bitcoin::secp256k1::{Secp256k1, All};
435 // Using the same keys for LN and BTC ids
436 fn add_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<chaininterface::ChainWatchInterfaceUtil>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_1_privkey: &SecretKey,
437 node_2_privkey: &SecretKey, features: ChannelFeatures, short_channel_id: u64) {
438 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
439 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
441 let unsigned_announcement = UnsignedChannelAnnouncement {
443 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
447 bitcoin_key_1: node_id_1,
448 bitcoin_key_2: node_id_2,
449 excess_data: Vec::new(),
452 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
453 let valid_announcement = ChannelAnnouncement {
454 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
455 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
456 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
457 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
458 contents: unsigned_announcement.clone(),
460 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
461 Ok(res) => assert!(res),
466 fn update_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<chaininterface::ChainWatchInterfaceUtil>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, update: UnsignedChannelUpdate) {
467 let msghash = hash_to_message!(&Sha256dHash::hash(&update.encode()[..])[..]);
468 let valid_channel_update = ChannelUpdate {
469 signature: secp_ctx.sign(&msghash, node_privkey),
470 contents: update.clone()
473 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
474 Ok(res) => assert!(res),
475 // Err(_) => panic!()
476 Err(e) => println!("{:?}", e.err)
481 fn add_or_update_node(net_graph_msg_handler: &NetGraphMsgHandler<Arc<chaininterface::ChainWatchInterfaceUtil>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey,
482 features: NodeFeatures, timestamp: u32) {
483 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
484 let unsigned_announcement = UnsignedNodeAnnouncement {
490 addresses: Vec::new(),
491 excess_address_data: Vec::new(),
492 excess_data: Vec::new(),
494 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
495 let valid_announcement = NodeAnnouncement {
496 signature: secp_ctx.sign(&msghash, node_privkey),
497 contents: unsigned_announcement.clone()
500 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
506 fn get_nodes(secp_ctx: &Secp256k1<All>) -> (SecretKey, PublicKey, Vec<SecretKey>, Vec<PublicKey>) {
507 let privkeys: Vec<SecretKey> = (2..10).map(|i| {
508 SecretKey::from_slice(&hex::decode(format!("{:02}", i).repeat(32)).unwrap()[..]).unwrap()
511 let pubkeys = privkeys.iter().map(|secret| PublicKey::from_secret_key(&secp_ctx, secret)).collect();
513 let our_privkey = SecretKey::from_slice(&hex::decode("01".repeat(32)).unwrap()[..]).unwrap();
514 let our_id = PublicKey::from_secret_key(&secp_ctx, &our_privkey);
516 (our_privkey, our_id, privkeys, pubkeys)
519 fn id_to_feature_flags(id: u8) -> Vec<u8> {
520 // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
521 // test for it later.
522 let idx = (id - 1) * 2 + 1;
524 vec![1 << (idx - 8*3), 0, 0, 0]
525 } else if idx > 8*2 {
526 vec![1 << (idx - 8*2), 0, 0]
527 } else if idx > 8*1 {
528 vec![1 << (idx - 8*1), 0]
534 fn build_graph() -> (Secp256k1<All>, NetGraphMsgHandler<std::sync::Arc<crate::chain::chaininterface::ChainWatchInterfaceUtil>, std::sync::Arc<crate::util::test_utils::TestLogger>>, std::sync::Arc<test_utils::TestLogger>) {
535 let secp_ctx = Secp256k1::new();
536 let logger = Arc::new(test_utils::TestLogger::new());
537 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet));
538 let net_graph_msg_handler = NetGraphMsgHandler::new(chain_monitor, Arc::clone(&logger));
539 // Build network from our_id to node7:
541 // -1(1)2- node0 -1(3)2-
543 // our_id -1(12)2- node7 -1(13)2--- node2
545 // -1(2)2- node1 -1(4)2-
548 // chan1 1-to-2: disabled
549 // chan1 2-to-1: enabled, 0 fee
551 // chan2 1-to-2: enabled, ignored fee
552 // chan2 2-to-1: enabled, 0 fee
554 // chan3 1-to-2: enabled, 0 fee
555 // chan3 2-to-1: enabled, 100 msat fee
557 // chan4 1-to-2: enabled, 100% fee
558 // chan4 2-to-1: enabled, 0 fee
560 // chan12 1-to-2: enabled, ignored fee
561 // chan12 2-to-1: enabled, 0 fee
563 // chan13 1-to-2: enabled, 200% fee
564 // chan13 2-to-1: enabled, 0 fee
567 // -1(5)2- node3 -1(8)2--
571 // node2--1(6)2- node4 -1(9)2--- node6 (not in global route map)
573 // -1(7)2- node5 -1(10)2-
575 // chan5 1-to-2: enabled, 100 msat fee
576 // chan5 2-to-1: enabled, 0 fee
578 // chan6 1-to-2: enabled, 0 fee
579 // chan6 2-to-1: enabled, 0 fee
581 // chan7 1-to-2: enabled, 100% fee
582 // chan7 2-to-1: enabled, 0 fee
584 // chan8 1-to-2: enabled, variable fee (0 then 1000 msat)
585 // chan8 2-to-1: enabled, 0 fee
587 // chan9 1-to-2: enabled, 1001 msat fee
588 // chan9 2-to-1: enabled, 0 fee
590 // chan10 1-to-2: enabled, 0 fee
591 // chan10 2-to-1: enabled, 0 fee
593 // chan11 1-to-2: enabled, 0 fee
594 // chan11 2-to-1: enabled, 0 fee
596 let (our_privkey, _, privkeys, _) = get_nodes(&secp_ctx);
598 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[0], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
599 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
600 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
604 cltv_expiry_delta: 0,
605 htlc_minimum_msat: 0,
606 htlc_maximum_msat: OptionalField::Absent,
608 fee_proportional_millionths: 0,
609 excess_data: Vec::new()
612 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
614 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
615 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
616 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
620 cltv_expiry_delta: u16::max_value(),
621 htlc_minimum_msat: 0,
622 htlc_maximum_msat: OptionalField::Absent,
623 fee_base_msat: u32::max_value(),
624 fee_proportional_millionths: u32::max_value(),
625 excess_data: Vec::new()
627 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
628 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
632 cltv_expiry_delta: 0,
633 htlc_minimum_msat: 0,
634 htlc_maximum_msat: OptionalField::Absent,
636 fee_proportional_millionths: 0,
637 excess_data: Vec::new()
640 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
642 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[7], ChannelFeatures::from_le_bytes(id_to_feature_flags(12)), 12);
643 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
644 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
645 short_channel_id: 12,
648 cltv_expiry_delta: u16::max_value(),
649 htlc_minimum_msat: 0,
650 htlc_maximum_msat: OptionalField::Absent,
651 fee_base_msat: u32::max_value(),
652 fee_proportional_millionths: u32::max_value(),
653 excess_data: Vec::new()
655 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
656 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
657 short_channel_id: 12,
660 cltv_expiry_delta: 0,
661 htlc_minimum_msat: 0,
662 htlc_maximum_msat: OptionalField::Absent,
664 fee_proportional_millionths: 0,
665 excess_data: Vec::new()
668 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], NodeFeatures::from_le_bytes(id_to_feature_flags(8)), 0);
670 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
671 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
672 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
676 cltv_expiry_delta: (3 << 8) | 1,
677 htlc_minimum_msat: 0,
678 htlc_maximum_msat: OptionalField::Absent,
680 fee_proportional_millionths: 0,
681 excess_data: Vec::new()
683 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
684 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
688 cltv_expiry_delta: (3 << 8) | 2,
689 htlc_minimum_msat: 0,
690 htlc_maximum_msat: OptionalField::Absent,
692 fee_proportional_millionths: 0,
693 excess_data: Vec::new()
696 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
697 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
698 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
702 cltv_expiry_delta: (4 << 8) | 1,
703 htlc_minimum_msat: 0,
704 htlc_maximum_msat: OptionalField::Absent,
706 fee_proportional_millionths: 1000000,
707 excess_data: Vec::new()
709 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
710 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
714 cltv_expiry_delta: (4 << 8) | 2,
715 htlc_minimum_msat: 0,
716 htlc_maximum_msat: OptionalField::Absent,
718 fee_proportional_millionths: 0,
719 excess_data: Vec::new()
722 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(13)), 13);
723 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
724 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
725 short_channel_id: 13,
728 cltv_expiry_delta: (13 << 8) | 1,
729 htlc_minimum_msat: 0,
730 htlc_maximum_msat: OptionalField::Absent,
732 fee_proportional_millionths: 2000000,
733 excess_data: Vec::new()
735 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
736 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
737 short_channel_id: 13,
740 cltv_expiry_delta: (13 << 8) | 2,
741 htlc_minimum_msat: 0,
742 htlc_maximum_msat: OptionalField::Absent,
744 fee_proportional_millionths: 0,
745 excess_data: Vec::new()
748 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
750 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
751 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
752 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
756 cltv_expiry_delta: (6 << 8) | 1,
757 htlc_minimum_msat: 0,
758 htlc_maximum_msat: OptionalField::Absent,
760 fee_proportional_millionths: 0,
761 excess_data: Vec::new()
763 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
764 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
768 cltv_expiry_delta: (6 << 8) | 2,
769 htlc_minimum_msat: 0,
770 htlc_maximum_msat: OptionalField::Absent,
772 fee_proportional_millionths: 0,
773 excess_data: Vec::new(),
776 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(11)), 11);
777 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
778 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
779 short_channel_id: 11,
782 cltv_expiry_delta: (11 << 8) | 1,
783 htlc_minimum_msat: 0,
784 htlc_maximum_msat: OptionalField::Absent,
786 fee_proportional_millionths: 0,
787 excess_data: Vec::new()
789 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
790 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
791 short_channel_id: 11,
794 cltv_expiry_delta: (11 << 8) | 2,
795 htlc_minimum_msat: 0,
796 htlc_maximum_msat: OptionalField::Absent,
798 fee_proportional_millionths: 0,
799 excess_data: Vec::new()
802 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(5)), 0);
804 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
806 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[5], ChannelFeatures::from_le_bytes(id_to_feature_flags(7)), 7);
807 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
808 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
812 cltv_expiry_delta: (7 << 8) | 1,
813 htlc_minimum_msat: 0,
814 htlc_maximum_msat: OptionalField::Absent,
816 fee_proportional_millionths: 1000000,
817 excess_data: Vec::new()
819 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[5], UnsignedChannelUpdate {
820 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
824 cltv_expiry_delta: (7 << 8) | 2,
825 htlc_minimum_msat: 0,
826 htlc_maximum_msat: OptionalField::Absent,
828 fee_proportional_millionths: 0,
829 excess_data: Vec::new()
832 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[5], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
834 (secp_ctx, net_graph_msg_handler, logger)
838 fn simple_route_test() {
839 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
840 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
842 // Simple route to 3 via 2
843 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
844 assert_eq!(route.paths[0].len(), 2);
846 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
847 assert_eq!(route.paths[0][0].short_channel_id, 2);
848 assert_eq!(route.paths[0][0].fee_msat, 100);
849 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
850 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
851 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
853 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
854 assert_eq!(route.paths[0][1].short_channel_id, 4);
855 assert_eq!(route.paths[0][1].fee_msat, 100);
856 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
857 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
858 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
862 fn disable_channels_test() {
863 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
864 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
866 // // Disable channels 4 and 12 by flags=2
867 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
868 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
871 flags: 2, // to disable
872 cltv_expiry_delta: 0,
873 htlc_minimum_msat: 0,
874 htlc_maximum_msat: OptionalField::Absent,
876 fee_proportional_millionths: 0,
877 excess_data: Vec::new()
879 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
880 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
881 short_channel_id: 12,
883 flags: 2, // to disable
884 cltv_expiry_delta: 0,
885 htlc_minimum_msat: 0,
886 htlc_maximum_msat: OptionalField::Absent,
888 fee_proportional_millionths: 0,
889 excess_data: Vec::new()
892 // If all the channels require some features we don't understand, route should fail
893 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
894 assert_eq!(err, "Failed to find a path to the given destination");
897 // If we specify a channel to node7, that overrides our local channel view and that gets used
898 let our_chans = vec![channelmanager::ChannelDetails {
900 short_channel_id: Some(42),
901 remote_network_id: nodes[7].clone(),
902 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
903 channel_value_satoshis: 0,
905 outbound_capacity_msat: 0,
906 inbound_capacity_msat: 0,
909 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
910 assert_eq!(route.paths[0].len(), 2);
912 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
913 assert_eq!(route.paths[0][0].short_channel_id, 42);
914 assert_eq!(route.paths[0][0].fee_msat, 200);
915 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
916 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
917 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
919 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
920 assert_eq!(route.paths[0][1].short_channel_id, 13);
921 assert_eq!(route.paths[0][1].fee_msat, 100);
922 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
923 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
924 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
928 fn disable_node_test() {
929 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
930 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
932 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
933 let mut unknown_features = NodeFeatures::known();
934 unknown_features.set_required_unknown_bits();
935 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
936 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
937 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
939 // If all nodes require some features we don't understand, route should fail
940 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
941 assert_eq!(err, "Failed to find a path to the given destination");
944 // If we specify a channel to node7, that overrides our local channel view and that gets used
945 let our_chans = vec![channelmanager::ChannelDetails {
947 short_channel_id: Some(42),
948 remote_network_id: nodes[7].clone(),
949 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
950 channel_value_satoshis: 0,
952 outbound_capacity_msat: 0,
953 inbound_capacity_msat: 0,
956 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
957 assert_eq!(route.paths[0].len(), 2);
959 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
960 assert_eq!(route.paths[0][0].short_channel_id, 42);
961 assert_eq!(route.paths[0][0].fee_msat, 200);
962 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
963 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
964 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
966 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
967 assert_eq!(route.paths[0][1].short_channel_id, 13);
968 assert_eq!(route.paths[0][1].fee_msat, 100);
969 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
970 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
971 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
973 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
974 // naively) assume that the user checked the feature bits on the invoice, which override
975 // the node_announcement.
979 fn our_chans_test() {
980 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
981 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
983 // Route to 1 via 2 and 3 because our channel to 1 is disabled
984 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0], None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
985 assert_eq!(route.paths[0].len(), 3);
987 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
988 assert_eq!(route.paths[0][0].short_channel_id, 2);
989 assert_eq!(route.paths[0][0].fee_msat, 200);
990 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
991 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
992 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
994 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
995 assert_eq!(route.paths[0][1].short_channel_id, 4);
996 assert_eq!(route.paths[0][1].fee_msat, 100);
997 assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 8) | 2);
998 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
999 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1001 assert_eq!(route.paths[0][2].pubkey, nodes[0]);
1002 assert_eq!(route.paths[0][2].short_channel_id, 3);
1003 assert_eq!(route.paths[0][2].fee_msat, 100);
1004 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
1005 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(1));
1006 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(3));
1008 // If we specify a channel to node7, that overrides our local channel view and that gets used
1009 let our_chans = vec![channelmanager::ChannelDetails {
1010 channel_id: [0; 32],
1011 short_channel_id: Some(42),
1012 remote_network_id: nodes[7].clone(),
1013 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1014 channel_value_satoshis: 0,
1016 outbound_capacity_msat: 0,
1017 inbound_capacity_msat: 0,
1020 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1021 assert_eq!(route.paths[0].len(), 2);
1023 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
1024 assert_eq!(route.paths[0][0].short_channel_id, 42);
1025 assert_eq!(route.paths[0][0].fee_msat, 200);
1026 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1027 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1028 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1030 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1031 assert_eq!(route.paths[0][1].short_channel_id, 13);
1032 assert_eq!(route.paths[0][1].fee_msat, 100);
1033 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1034 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1035 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
1038 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
1039 let zero_fees = RoutingFees {
1041 proportional_millionths: 0,
1044 src_node_id: nodes[3].clone(),
1045 short_channel_id: 8,
1047 cltv_expiry_delta: (8 << 8) | 1,
1048 htlc_minimum_msat: 0,
1050 src_node_id: nodes[4].clone(),
1051 short_channel_id: 9,
1054 proportional_millionths: 0,
1056 cltv_expiry_delta: (9 << 8) | 1,
1057 htlc_minimum_msat: 0,
1059 src_node_id: nodes[5].clone(),
1060 short_channel_id: 10,
1062 cltv_expiry_delta: (10 << 8) | 1,
1063 htlc_minimum_msat: 0,
1068 fn last_hops_test() {
1069 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
1070 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1072 // Simple test across 2, 3, 5, and 4 via a last_hop channel
1073 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops(&nodes).iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1074 assert_eq!(route.paths[0].len(), 5);
1076 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1077 assert_eq!(route.paths[0][0].short_channel_id, 2);
1078 assert_eq!(route.paths[0][0].fee_msat, 100);
1079 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1080 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1081 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1083 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1084 assert_eq!(route.paths[0][1].short_channel_id, 4);
1085 assert_eq!(route.paths[0][1].fee_msat, 0);
1086 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1087 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1088 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1090 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
1091 assert_eq!(route.paths[0][2].short_channel_id, 6);
1092 assert_eq!(route.paths[0][2].fee_msat, 0);
1093 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1094 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
1095 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
1097 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
1098 assert_eq!(route.paths[0][3].short_channel_id, 11);
1099 assert_eq!(route.paths[0][3].fee_msat, 0);
1100 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1101 // If we have a peer in the node map, we'll use their features here since we don't have
1102 // a way of figuring out their features from the invoice:
1103 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
1104 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
1106 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
1107 assert_eq!(route.paths[0][4].short_channel_id, 8);
1108 assert_eq!(route.paths[0][4].fee_msat, 100);
1109 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1110 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1111 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1115 fn our_chans_last_hop_connect_test() {
1116 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
1117 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1119 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
1120 let our_chans = vec![channelmanager::ChannelDetails {
1121 channel_id: [0; 32],
1122 short_channel_id: Some(42),
1123 remote_network_id: nodes[3].clone(),
1124 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1125 channel_value_satoshis: 0,
1127 outbound_capacity_msat: 0,
1128 inbound_capacity_msat: 0,
1131 let mut last_hops = last_hops(&nodes);
1132 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], Some(&our_chans.iter().collect::<Vec<_>>()), &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1133 assert_eq!(route.paths[0].len(), 2);
1135 assert_eq!(route.paths[0][0].pubkey, nodes[3]);
1136 assert_eq!(route.paths[0][0].short_channel_id, 42);
1137 assert_eq!(route.paths[0][0].fee_msat, 0);
1138 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1);
1139 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1140 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1142 assert_eq!(route.paths[0][1].pubkey, nodes[6]);
1143 assert_eq!(route.paths[0][1].short_channel_id, 8);
1144 assert_eq!(route.paths[0][1].fee_msat, 100);
1145 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1146 assert_eq!(route.paths[0][1].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1147 assert_eq!(route.paths[0][1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1149 last_hops[0].fees.base_msat = 1000;
1151 // Revert to via 6 as the fee on 8 goes up
1152 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1153 assert_eq!(route.paths[0].len(), 4);
1155 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1156 assert_eq!(route.paths[0][0].short_channel_id, 2);
1157 assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node
1158 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1159 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1160 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1162 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1163 assert_eq!(route.paths[0][1].short_channel_id, 4);
1164 assert_eq!(route.paths[0][1].fee_msat, 100);
1165 assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 8) | 1);
1166 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1167 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1169 assert_eq!(route.paths[0][2].pubkey, nodes[5]);
1170 assert_eq!(route.paths[0][2].short_channel_id, 7);
1171 assert_eq!(route.paths[0][2].fee_msat, 0);
1172 assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 8) | 1);
1173 // If we have a peer in the node map, we'll use their features here since we don't have
1174 // a way of figuring out their features from the invoice:
1175 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
1176 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(7));
1178 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
1179 assert_eq!(route.paths[0][3].short_channel_id, 10);
1180 assert_eq!(route.paths[0][3].fee_msat, 100);
1181 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
1182 assert_eq!(route.paths[0][3].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1183 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1185 // ...but still use 8 for larger payments as 6 has a variable feerate
1186 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops.iter().collect::<Vec<_>>(), 2000, 42, Arc::clone(&logger)).unwrap();
1187 assert_eq!(route.paths[0].len(), 5);
1189 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1190 assert_eq!(route.paths[0][0].short_channel_id, 2);
1191 assert_eq!(route.paths[0][0].fee_msat, 3000);
1192 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1193 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1194 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1196 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1197 assert_eq!(route.paths[0][1].short_channel_id, 4);
1198 assert_eq!(route.paths[0][1].fee_msat, 0);
1199 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1200 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1201 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1203 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
1204 assert_eq!(route.paths[0][2].short_channel_id, 6);
1205 assert_eq!(route.paths[0][2].fee_msat, 0);
1206 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1207 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
1208 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
1210 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
1211 assert_eq!(route.paths[0][3].short_channel_id, 11);
1212 assert_eq!(route.paths[0][3].fee_msat, 1000);
1213 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1214 // If we have a peer in the node map, we'll use their features here since we don't have
1215 // a way of figuring out their features from the invoice:
1216 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
1217 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
1219 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
1220 assert_eq!(route.paths[0][4].short_channel_id, 8);
1221 assert_eq!(route.paths[0][4].fee_msat, 2000);
1222 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1223 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1224 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly