Move node announcement fields into a separate struct
[rust-lightning] / lightning / src / routing / router.rs
1 //! The top-level routing/network map tracking logic lives here.
2 //!
3 //! You probably want to create a Router and use that as your RoutingMessageHandler and then
4 //! interrogate it to get routes for your own payments.
5
6 use bitcoin::secp256k1::key::PublicKey;
7
8 use ln::channelmanager;
9 use ln::features::{ChannelFeatures, NodeFeatures};
10 use ln::msgs::{DecodeError,ErrorAction,LightningError};
11 use routing::network_graph::{NetGraphMsgHandler, RoutingFees};
12 use util::ser::{Writeable, Readable};
13 use util::logger::{Logger, LogHolder};
14
15 use std::cmp;
16 use std::sync::Arc;
17 use std::collections::{HashMap,BinaryHeap};
18
19 /// A hop in a route
20 #[derive(Clone, PartialEq)]
21 pub struct RouteHop {
22         /// The node_id of the node at this hop.
23         pub pubkey: PublicKey,
24         /// The node_announcement features of the node at this hop. For the last hop, these may be
25         /// amended to match the features present in the invoice this node generated.
26         pub node_features: NodeFeatures,
27         /// The channel that should be used from the previous hop to reach this node.
28         pub short_channel_id: u64,
29         /// The channel_announcement features of the channel that should be used from the previous hop
30         /// to reach this node.
31         pub channel_features: ChannelFeatures,
32         /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
33         pub fee_msat: u64,
34         /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
35         /// expected at the destination, in excess of the current block height.
36         pub cltv_expiry_delta: u32,
37 }
38
39 impl Writeable for Vec<RouteHop> {
40         fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
41                 (self.len() as u8).write(writer)?;
42                 for hop in self.iter() {
43                         hop.pubkey.write(writer)?;
44                         hop.node_features.write(writer)?;
45                         hop.short_channel_id.write(writer)?;
46                         hop.channel_features.write(writer)?;
47                         hop.fee_msat.write(writer)?;
48                         hop.cltv_expiry_delta.write(writer)?;
49                 }
50                 Ok(())
51         }
52 }
53
54 impl Readable for Vec<RouteHop> {
55         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Vec<RouteHop>, DecodeError> {
56                 let hops_count: u8 = Readable::read(reader)?;
57                 let mut hops = Vec::with_capacity(hops_count as usize);
58                 for _ in 0..hops_count {
59                         hops.push(RouteHop {
60                                 pubkey: Readable::read(reader)?,
61                                 node_features: Readable::read(reader)?,
62                                 short_channel_id: Readable::read(reader)?,
63                                 channel_features: Readable::read(reader)?,
64                                 fee_msat: Readable::read(reader)?,
65                                 cltv_expiry_delta: Readable::read(reader)?,
66                         });
67                 }
68                 Ok(hops)
69         }
70 }
71
72 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
73 /// it can take multiple paths. Each path is composed of one or more hops through the network.
74 #[derive(Clone, PartialEq)]
75 pub struct Route {
76         /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
77         /// last RouteHop in each path must be the same.
78         /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
79         /// destination. Thus, this must always be at least length one. While the maximum length of any
80         /// given path is variable, keeping the length of any path to less than 20 should currently
81         /// ensure it is viable.
82         pub paths: Vec<Vec<RouteHop>>,
83 }
84
85 impl Writeable for Route {
86         fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
87                 (self.paths.len() as u64).write(writer)?;
88                 for hops in self.paths.iter() {
89                         hops.write(writer)?;
90                 }
91                 Ok(())
92         }
93 }
94
95 impl Readable for Route {
96         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
97                 let path_count: u64 = Readable::read(reader)?;
98                 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
99                 for _ in 0..path_count {
100                         paths.push(Readable::read(reader)?);
101                 }
102                 Ok(Route { paths })
103         }
104 }
105
106 /// A channel descriptor which provides a last-hop route to get_route
107 pub struct RouteHint {
108         /// The node_id of the non-target end of the route
109         pub src_node_id: PublicKey,
110         /// The short_channel_id of this channel
111         pub short_channel_id: u64,
112         /// The fees which must be paid to use this channel
113         pub fees: RoutingFees,
114         /// The difference in CLTV values between this node and the next node.
115         pub cltv_expiry_delta: u16,
116         /// The minimum value, in msat, which must be relayed to the next hop.
117         pub htlc_minimum_msat: u64,
118 }
119
120 #[derive(Eq, PartialEq)]
121 struct RouteGraphNode {
122         pubkey: PublicKey,
123         lowest_fee_to_peer_through_node: u64,
124         lowest_fee_to_node: u64,
125 }
126
127 impl cmp::Ord for RouteGraphNode {
128         fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
129                 other.lowest_fee_to_peer_through_node.cmp(&self.lowest_fee_to_peer_through_node)
130                         .then_with(|| other.pubkey.serialize().cmp(&self.pubkey.serialize()))
131         }
132 }
133
134 impl cmp::PartialOrd for RouteGraphNode {
135         fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
136                 Some(self.cmp(other))
137         }
138 }
139
140 struct DummyDirectionalChannelInfo {
141         src_node_id: PublicKey,
142         cltv_expiry_delta: u32,
143         htlc_minimum_msat: u64,
144         fees: RoutingFees,
145 }
146
147
148 /// Gets a route from us (as specified in the provided NetGraphMsgHandler) to the given target node.
149 ///
150 /// Extra routing hops between known nodes and the target will be used if they are included in
151 /// last_hops.
152 ///
153 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
154 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
155 /// (this Router's) view of our local channels will be ignored, and only those in first_hops
156 /// will be used.
157 ///
158 /// Panics if first_hops contains channels without short_channel_ids
159 /// (ChannelManager::list_usable_channels will never include such channels).
160 ///
161 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
162 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
163 /// *is* checked as they may change based on the receiving node.
164 pub fn get_route(our_node_id: &PublicKey, net_graph_msg_handler: &NetGraphMsgHandler, target: &PublicKey, first_hops: Option<&[channelmanager::ChannelDetails]>,
165         last_hops: &[RouteHint], final_value_msat: u64, final_cltv: u32, logger: Arc<Logger>) -> Result<Route, LightningError> {
166         // TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
167         // uptime/success in using a node in the past.
168         if *target == *our_node_id {
169                 return Err(LightningError{err: "Cannot generate a route to ourselves", action: ErrorAction::IgnoreError});
170         }
171
172         if final_value_msat > 21_000_000 * 1_0000_0000 * 1000 {
173                 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis", action: ErrorAction::IgnoreError});
174         }
175
176         // We do a dest-to-source Dijkstra's sorting by each node's distance from the destination
177         // plus the minimum per-HTLC fee to get from it to another node (aka "shitty A*").
178         // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
179         // to use as the A* heuristic beyond just the cost to get one node further than the current
180         // one.
181
182         let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
183                 src_node_id: our_node_id.clone(),
184                 cltv_expiry_delta: 0,
185                 htlc_minimum_msat: 0,
186                 fees: RoutingFees {
187                         base_msat: 0,
188                         proportional_millionths: 0,
189                 }
190         };
191
192         let network = net_graph_msg_handler.network_graph.read().unwrap();
193         let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
194         let mut dist = HashMap::with_capacity(network.get_nodes().len());
195
196         let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
197         if let Some(hops) = first_hops {
198                 for chan in hops {
199                         let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
200                         if chan.remote_network_id == *target {
201                                 return Ok(Route {
202                                         paths: vec![vec![RouteHop {
203                                                 pubkey: chan.remote_network_id,
204                                                 node_features: chan.counterparty_features.to_context(),
205                                                 short_channel_id,
206                                                 channel_features: chan.counterparty_features.to_context(),
207                                                 fee_msat: final_value_msat,
208                                                 cltv_expiry_delta: final_cltv,
209                                         }]],
210                                 });
211                         }
212                         first_hop_targets.insert(chan.remote_network_id, (short_channel_id, chan.counterparty_features.clone()));
213                 }
214                 if first_hop_targets.is_empty() {
215                         return Err(LightningError{err: "Cannot route when there are no outbound routes away from us", action: ErrorAction::IgnoreError});
216                 }
217         }
218
219         macro_rules! add_entry {
220                 // Adds entry which goes from the node pointed to by $directional_info to
221                 // $dest_node_id over the channel with id $chan_id with fees described in
222                 // $directional_info.
223                 ( $chan_id: expr, $dest_node_id: expr, $directional_info: expr, $chan_features: expr, $starting_fee_msat: expr ) => {
224                         //TODO: Explore simply adding fee to hit htlc_minimum_msat
225                         if $starting_fee_msat as u64 + final_value_msat >= $directional_info.htlc_minimum_msat {
226                                 let proportional_fee_millions = ($starting_fee_msat + final_value_msat).checked_mul($directional_info.fees.proportional_millionths as u64);
227                                 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
228                                                 ($directional_info.fees.base_msat as u64).checked_add(part / 1000000) })
229                                 {
230                                         let mut total_fee = $starting_fee_msat as u64;
231                                         let hm_entry = dist.entry(&$directional_info.src_node_id);
232                                         let old_entry = hm_entry.or_insert_with(|| {
233                                                 let node = network.get_nodes().get(&$directional_info.src_node_id).unwrap();
234                                                 let mut fee_base_msat = u32::max_value();
235                                                 let mut fee_proportional_millionths = u32::max_value();
236                                                 if let Some(fees) = node.lowest_inbound_channel_fees {
237                                                         fee_base_msat = fees.base_msat;
238                                                         fee_proportional_millionths = fees.proportional_millionths;
239                                                 };
240                                                 (u64::max_value(),
241                                                         fee_base_msat,
242                                                         fee_proportional_millionths,
243                                                         RouteHop {
244                                                                 pubkey: $dest_node_id.clone(),
245                                                                 node_features: NodeFeatures::empty(),
246                                                                 short_channel_id: 0,
247                                                                 channel_features: $chan_features.clone(),
248                                                                 fee_msat: 0,
249                                                                 cltv_expiry_delta: 0,
250                                                 })
251                                         });
252                                         if $directional_info.src_node_id != *our_node_id {
253                                                 // Ignore new_fee for channel-from-us as we assume all channels-from-us
254                                                 // will have the same effective-fee
255                                                 total_fee += new_fee;
256                                                 if let Some(fee_inc) = final_value_msat.checked_add(total_fee).and_then(|inc| { (old_entry.2 as u64).checked_mul(inc) }) {
257                                                         total_fee += fee_inc / 1000000 + (old_entry.1 as u64);
258                                                 } else {
259                                                         // max_value means we'll always fail the old_entry.0 > total_fee check
260                                                         total_fee = u64::max_value();
261                                                 }
262                                         }
263                                         let new_graph_node = RouteGraphNode {
264                                                 pubkey: $directional_info.src_node_id,
265                                                 lowest_fee_to_peer_through_node: total_fee,
266                                                 lowest_fee_to_node: $starting_fee_msat as u64 + new_fee,
267                                         };
268                                         if old_entry.0 > total_fee {
269                                                 targets.push(new_graph_node);
270                                                 old_entry.0 = total_fee;
271                                                 old_entry.3 = RouteHop {
272                                                         pubkey: $dest_node_id.clone(),
273                                                         node_features: NodeFeatures::empty(),
274                                                         short_channel_id: $chan_id.clone(),
275                                                         channel_features: $chan_features.clone(),
276                                                         fee_msat: new_fee, // This field is ignored on the last-hop anyway
277                                                         cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
278                                                 }
279                                         }
280                                 }
281                         }
282                 };
283         }
284
285         macro_rules! add_entries_to_cheapest_to_target_node {
286                 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr ) => {
287                         if first_hops.is_some() {
288                                 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&$node_id) {
289                                         add_entry!(first_hop, $node_id, dummy_directional_info, features.to_context(), $fee_to_target_msat);
290                                 }
291                         }
292
293                         let features;
294                         if let Some(node_info) = $node.announcement_info.as_ref() {
295                                 features = node_info.features.clone();
296                         } else {
297                                 features = NodeFeatures::empty();
298                         }
299
300                         if !features.requires_unknown_bits() {
301                                 for chan_id in $node.channels.iter() {
302                                         let chan = network.get_channels().get(chan_id).unwrap();
303                                         if !chan.features.requires_unknown_bits() {
304                                                 if chan.one_to_two.src_node_id == *$node_id {
305                                                         // ie $node is one, ie next hop in A* is two, via the two_to_one channel
306                                                         if first_hops.is_none() || chan.two_to_one.src_node_id != *our_node_id {
307                                                                 if chan.two_to_one.enabled {
308                                                                         add_entry!(chan_id, chan.one_to_two.src_node_id, chan.two_to_one, chan.features, $fee_to_target_msat);
309                                                                 }
310                                                         }
311                                                 } else {
312                                                         if first_hops.is_none() || chan.one_to_two.src_node_id != *our_node_id {
313                                                                 if chan.one_to_two.enabled {
314                                                                         add_entry!(chan_id, chan.two_to_one.src_node_id, chan.one_to_two, chan.features, $fee_to_target_msat);
315                                                                 }
316                                                         }
317                                                 }
318                                         }
319                                 }
320                         }
321                 };
322         }
323
324         match network.get_nodes().get(target) {
325                 None => {},
326                 Some(node) => {
327                         add_entries_to_cheapest_to_target_node!(node, target, 0);
328                 },
329         }
330
331         for hop in last_hops.iter() {
332                 if first_hops.is_none() || hop.src_node_id != *our_node_id { // first_hop overrules last_hops
333                         if network.get_nodes().get(&hop.src_node_id).is_some() {
334                                 if first_hops.is_some() {
335                                         if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&hop.src_node_id) {
336                                                 // Currently there are no channel-context features defined, so we are a
337                                                 // bit lazy here. In the future, we should pull them out via our
338                                                 // ChannelManager, but there's no reason to waste the space until we
339                                                 // need them.
340                                                 add_entry!(first_hop, hop.src_node_id, dummy_directional_info, features.to_context(), 0);
341                                         }
342                                 }
343                                 // BOLT 11 doesn't allow inclusion of features for the last hop hints, which
344                                 // really sucks, cause we're gonna need that eventually.
345                                 add_entry!(hop.short_channel_id, target, hop, ChannelFeatures::empty(), 0);
346                         }
347                 }
348         }
349
350         while let Some(RouteGraphNode { pubkey, lowest_fee_to_node, .. }) = targets.pop() {
351                 if pubkey == *our_node_id {
352                         let mut res = vec!(dist.remove(&our_node_id).unwrap().3);
353                         loop {
354                                 if let Some(&(_, ref features)) = first_hop_targets.get(&res.last().unwrap().pubkey) {
355                                         res.last_mut().unwrap().node_features = features.to_context();
356                                 } else if let Some(node) = network.get_nodes().get(&res.last().unwrap().pubkey) {
357                                         if let Some(node_info) = node.announcement_info.as_ref() {
358                                                 res.last_mut().unwrap().node_features = node_info.features.clone();
359                                         } else {
360                                                 res.last_mut().unwrap().node_features = NodeFeatures::empty();
361                                         }
362                                 } else {
363                                         // We should be able to fill in features for everything except the last
364                                         // hop, if the last hop was provided via a BOLT 11 invoice (though we
365                                         // should be able to extend it further as BOLT 11 does have feature
366                                         // flags for the last hop node itself).
367                                         assert!(res.last().unwrap().pubkey == *target);
368                                 }
369                                 if res.last().unwrap().pubkey == *target {
370                                         break;
371                                 }
372
373                                 let new_entry = match dist.remove(&res.last().unwrap().pubkey) {
374                                         Some(hop) => hop.3,
375                                         None => return Err(LightningError{err: "Failed to find a non-fee-overflowing path to the given destination", action: ErrorAction::IgnoreError}),
376                                 };
377                                 res.last_mut().unwrap().fee_msat = new_entry.fee_msat;
378                                 res.last_mut().unwrap().cltv_expiry_delta = new_entry.cltv_expiry_delta;
379                                 res.push(new_entry);
380                         }
381                         res.last_mut().unwrap().fee_msat = final_value_msat;
382                         res.last_mut().unwrap().cltv_expiry_delta = final_cltv;
383                         let route = Route { paths: vec![res] };
384                         let log_holder = LogHolder { logger: &logger };
385                         log_trace!(log_holder, "Got route: {}", log_route!(route));
386                         return Ok(route);
387                 }
388
389                 match network.get_nodes().get(&pubkey) {
390                         None => {},
391                         Some(node) => {
392                                 add_entries_to_cheapest_to_target_node!(node, &pubkey, lowest_fee_to_node);
393                         },
394                 }
395         }
396
397         Err(LightningError{err: "Failed to find a path to the given destination", action: ErrorAction::IgnoreError})
398 }
399
400 #[cfg(test)]
401 mod tests {
402         use chain::chaininterface;
403         use routing::router::{NetGraphMsgHandler, RoutingFees};
404         use routing::router::{get_route, RouteHint};
405         use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
406         use ln::msgs::{ErrorAction, LightningError, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler,
407            NodeAnnouncement, UnsignedNodeAnnouncement, ChannelUpdate, UnsignedChannelUpdate};
408         use ln::channelmanager;
409         use util::test_utils;
410         use util::logger::Logger;
411         use util::ser::Writeable;
412
413         use bitcoin::hashes::sha256d::Hash as Sha256dHash;
414         use bitcoin::hashes::Hash;
415         use bitcoin::network::constants::Network;
416         use bitcoin::blockdata::constants::genesis_block;
417         use bitcoin::util::hash::BitcoinHash;
418
419         use hex;
420
421         use bitcoin::secp256k1::key::{PublicKey,SecretKey};
422         use bitcoin::secp256k1::{Secp256k1, All};
423
424         use std::sync::Arc;
425
426         // Using the same keys for LN and BTC ids
427         fn add_channel(net_graph_msg_handler: &NetGraphMsgHandler, secp_ctx: &Secp256k1<All>, node_1_privkey: &SecretKey,
428            node_2_privkey: &SecretKey, features: ChannelFeatures, short_channel_id: u64) {
429                 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
430                 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
431
432                 let unsigned_announcement = UnsignedChannelAnnouncement {
433                         features,
434                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
435                         short_channel_id,
436                         node_id_1,
437                         node_id_2,
438                         bitcoin_key_1: node_id_1,
439                         bitcoin_key_2: node_id_2,
440                         excess_data: Vec::new(),
441                 };
442
443                 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
444                 let valid_announcement = ChannelAnnouncement {
445                         node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
446                         node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
447                         bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
448                         bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
449                         contents: unsigned_announcement.clone(),
450                 };
451                 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
452                         Ok(res) => assert!(res),
453                         _ => panic!()
454                 };
455         }
456
457         fn update_channel(net_graph_msg_handler: &NetGraphMsgHandler, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, update: UnsignedChannelUpdate) {
458                 let msghash = hash_to_message!(&Sha256dHash::hash(&update.encode()[..])[..]);
459                 let valid_channel_update = ChannelUpdate {
460                         signature: secp_ctx.sign(&msghash, node_privkey),
461                         contents: update.clone()
462                 };
463
464                 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
465                         Ok(res) => assert!(res),
466                         // Err(_) => panic!()
467                         Err(e) => println!("{:?}", e.err)
468                 };
469         }
470
471
472         fn add_or_update_node(net_graph_msg_handler: &NetGraphMsgHandler, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey,
473            features: NodeFeatures, timestamp: u32) {
474                 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
475                 let unsigned_announcement = UnsignedNodeAnnouncement {
476                         features,
477                         timestamp,
478                         node_id,
479                         rgb: [0; 3],
480                         alias: [0; 32],
481                         addresses: Vec::new(),
482                         excess_address_data: Vec::new(),
483                         excess_data: Vec::new(),
484                 };
485                 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
486                 let valid_announcement = NodeAnnouncement {
487                         signature: secp_ctx.sign(&msghash, node_privkey),
488                         contents: unsigned_announcement.clone()
489                 };
490
491                 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
492                         Ok(_) => (),
493                         Err(_) => panic!()
494                 };
495         }
496
497         #[test]
498         fn route_test() {
499                 let secp_ctx = Secp256k1::new();
500                 let our_privkey = &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
501                 let our_id = PublicKey::from_secret_key(&secp_ctx, our_privkey);
502                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
503                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
504                 let net_graph_msg_handler = NetGraphMsgHandler::new(chain_monitor, Arc::clone(&logger));
505                 // Build network from our_id to node8:
506                 //
507                 //        -1(1)2-  node1  -1(3)2-
508                 //       /                       \
509                 // our_id -1(12)2- node8 -1(13)2--- node3
510                 //       \                       /
511                 //        -1(2)2-  node2  -1(4)2-
512                 //
513                 //
514                 // chan1  1-to-2: disabled
515                 // chan1  2-to-1: enabled, 0 fee
516                 //
517                 // chan2  1-to-2: enabled, ignored fee
518                 // chan2  2-to-1: enabled, 0 fee
519                 //
520                 // chan3  1-to-2: enabled, 0 fee
521                 // chan3  2-to-1: enabled, 100 msat fee
522                 //
523                 // chan4  1-to-2: enabled, 100% fee
524                 // chan4  2-to-1: enabled, 0 fee
525                 //
526                 // chan12 1-to-2: enabled, ignored fee
527                 // chan12 2-to-1: enabled, 0 fee
528                 //
529                 // chan13 1-to-2: enabled, 200% fee
530                 // chan13 2-to-1: enabled, 0 fee
531                 //
532                 //
533                 //       -1(5)2- node4 -1(8)2--
534                 //       |         2          |
535                 //       |       (11)         |
536                 //      /          1           \
537                 // node3--1(6)2- node5 -1(9)2--- node7 (not in global route map)
538                 //      \                      /
539                 //       -1(7)2- node6 -1(10)2-
540                 //
541                 // chan5  1-to-2: enabled, 100 msat fee
542                 // chan5  2-to-1: enabled, 0 fee
543                 //
544                 // chan6  1-to-2: enabled, 0 fee
545                 // chan6  2-to-1: enabled, 0 fee
546                 //
547                 // chan7  1-to-2: enabled, 100% fee
548                 // chan7  2-to-1: enabled, 0 fee
549                 //
550                 // chan8  1-to-2: enabled, variable fee (0 then 1000 msat)
551                 // chan8  2-to-1: enabled, 0 fee
552                 //
553                 // chan9  1-to-2: enabled, 1001 msat fee
554                 // chan9  2-to-1: enabled, 0 fee
555                 //
556                 // chan10 1-to-2: enabled, 0 fee
557                 // chan10 2-to-1: enabled, 0 fee
558                 //
559                 // chan11 1-to-2: enabled, 0 fee
560                 // chan11 2-to-1: enabled, 0 fee
561
562                 let node1_privkey = &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap();
563                 let node2_privkey = &SecretKey::from_slice(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()[..]).unwrap();
564                 let node3_privkey = &SecretKey::from_slice(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()[..]).unwrap();
565                 let node4_privkey = &SecretKey::from_slice(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()[..]).unwrap();
566                 let node5_privkey = &SecretKey::from_slice(&hex::decode("0606060606060606060606060606060606060606060606060606060606060606").unwrap()[..]).unwrap();
567                 let node6_privkey = &SecretKey::from_slice(&hex::decode("0707070707070707070707070707070707070707070707070707070707070707").unwrap()[..]).unwrap();
568                 let node7_privkey = &SecretKey::from_slice(&hex::decode("0808080808080808080808080808080808080808080808080808080808080808").unwrap()[..]).unwrap();
569                 let node8_privkey = &SecretKey::from_slice(&hex::decode("0909090909090909090909090909090909090909090909090909090909090909").unwrap()[..]).unwrap();
570
571
572                 let node1 = PublicKey::from_secret_key(&secp_ctx, node1_privkey);
573                 let node2 = PublicKey::from_secret_key(&secp_ctx, node2_privkey);
574                 let node3 = PublicKey::from_secret_key(&secp_ctx, node3_privkey);
575                 let node4 = PublicKey::from_secret_key(&secp_ctx, node4_privkey);
576                 let node5 = PublicKey::from_secret_key(&secp_ctx, node5_privkey);
577                 let node6 = PublicKey::from_secret_key(&secp_ctx, node6_privkey);
578                 let node7 = PublicKey::from_secret_key(&secp_ctx, node7_privkey);
579                 let node8 = PublicKey::from_secret_key(&secp_ctx, node8_privkey);
580
581                 macro_rules! id_to_feature_flags {
582                         // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
583                         // test for it later.
584                         ($id: expr) => { {
585                                 let idx = ($id - 1) * 2 + 1;
586                                 if idx > 8*3 {
587                                         vec![1 << (idx - 8*3), 0, 0, 0]
588                                 } else if idx > 8*2 {
589                                         vec![1 << (idx - 8*2), 0, 0]
590                                 } else if idx > 8*1 {
591                                         vec![1 << (idx - 8*1), 0]
592                                 } else {
593                                         vec![1 << idx]
594                                 }
595                         } }
596                 }
597
598                 add_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, node1_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(1)), 1);
599                 update_channel(&net_graph_msg_handler, &secp_ctx, node1_privkey, UnsignedChannelUpdate {
600                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
601                         short_channel_id: 1,
602                         timestamp: 1,
603                         flags: 1,
604                         cltv_expiry_delta: 0,
605                         htlc_minimum_msat: 0,
606                         fee_base_msat: 0,
607                         fee_proportional_millionths: 0,
608                         excess_data: Vec::new()
609                 });
610                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node1_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(1)), 0);
611
612                 add_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, node2_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(2)), 2);
613                 update_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, UnsignedChannelUpdate {
614                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
615                         short_channel_id: 2,
616                         timestamp: 1,
617                         flags: 0,
618                         cltv_expiry_delta: u16::max_value(),
619                         htlc_minimum_msat: 0,
620                         fee_base_msat: u32::max_value(),
621                         fee_proportional_millionths: u32::max_value(),
622                         excess_data: Vec::new()
623                 });
624                 update_channel(&net_graph_msg_handler, &secp_ctx, node2_privkey, UnsignedChannelUpdate {
625                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
626                         short_channel_id: 2,
627                         timestamp: 1,
628                         flags: 1,
629                         cltv_expiry_delta: 0,
630                         htlc_minimum_msat: 0,
631                         fee_base_msat: 0,
632                         fee_proportional_millionths: 0,
633                         excess_data: Vec::new()
634                 });
635
636                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node2_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(2)), 0);
637
638                 add_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, node8_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(12)), 12);
639                 update_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, UnsignedChannelUpdate {
640                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
641                         short_channel_id: 12,
642                         timestamp: 1,
643                         flags: 0,
644                         cltv_expiry_delta: u16::max_value(),
645                         htlc_minimum_msat: 0,
646                         fee_base_msat: u32::max_value(),
647                         fee_proportional_millionths: u32::max_value(),
648                         excess_data: Vec::new()
649                 });
650                 update_channel(&net_graph_msg_handler, &secp_ctx, node8_privkey, UnsignedChannelUpdate {
651                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
652                         short_channel_id: 12,
653                         timestamp: 1,
654                         flags: 1,
655                         cltv_expiry_delta: 0,
656                         htlc_minimum_msat: 0,
657                         fee_base_msat: 0,
658                         fee_proportional_millionths: 0,
659                         excess_data: Vec::new()
660                 });
661
662
663                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node8_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(8)), 0);
664
665                 add_channel(&net_graph_msg_handler, &secp_ctx, node1_privkey, node3_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(3)), 3);
666                 update_channel(&net_graph_msg_handler, &secp_ctx, node1_privkey, UnsignedChannelUpdate {
667                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
668                         short_channel_id: 3,
669                         timestamp: 1,
670                         flags: 0,
671                         cltv_expiry_delta: (3 << 8) | 1,
672                         htlc_minimum_msat: 0,
673                         fee_base_msat: 0,
674                         fee_proportional_millionths: 0,
675                         excess_data: Vec::new()
676                 });
677                 update_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, UnsignedChannelUpdate {
678                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
679                         short_channel_id: 3,
680                         timestamp: 1,
681                         flags: 1,
682                         cltv_expiry_delta: (3 << 8) | 2,
683                         htlc_minimum_msat: 0,
684                         fee_base_msat: 100,
685                         fee_proportional_millionths: 0,
686                         excess_data: Vec::new()
687                 });
688
689
690                 add_channel(&net_graph_msg_handler, &secp_ctx, node2_privkey, node3_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(4)), 4);
691                 update_channel(&net_graph_msg_handler, &secp_ctx, node2_privkey, UnsignedChannelUpdate {
692                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
693                         short_channel_id: 4,
694                         timestamp: 1,
695                         flags: 0,
696                         cltv_expiry_delta: (4 << 8) | 1,
697                         htlc_minimum_msat: 0,
698                         fee_base_msat: 0,
699                         fee_proportional_millionths: 1000000,
700                         excess_data: Vec::new()
701                 });
702                 update_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, UnsignedChannelUpdate {
703                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
704                         short_channel_id: 4,
705                         timestamp: 1,
706                         flags: 1,
707                         cltv_expiry_delta: (4 << 8) | 2,
708                         htlc_minimum_msat: 0,
709                         fee_base_msat: 0,
710                         fee_proportional_millionths: 0,
711                         excess_data: Vec::new()
712                 });
713
714                 add_channel(&net_graph_msg_handler, &secp_ctx, node8_privkey, node3_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(13)), 13);
715                 update_channel(&net_graph_msg_handler, &secp_ctx, node8_privkey, UnsignedChannelUpdate {
716                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
717                         short_channel_id: 13,
718                         timestamp: 1,
719                         flags: 0,
720                         cltv_expiry_delta: (13 << 8) | 1,
721                         htlc_minimum_msat: 0,
722                         fee_base_msat: 0,
723                         fee_proportional_millionths: 2000000,
724                         excess_data: Vec::new()
725                 });
726                 update_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, UnsignedChannelUpdate {
727                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
728                         short_channel_id: 13,
729                         timestamp: 1,
730                         flags: 1,
731                         cltv_expiry_delta: (13 << 8) | 2,
732                         htlc_minimum_msat: 0,
733                         fee_base_msat: 0,
734                         fee_proportional_millionths: 0,
735                         excess_data: Vec::new()
736                 });
737                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node3_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(3)), 0);
738                 add_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, node5_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(6)), 6);
739
740                 update_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, UnsignedChannelUpdate {
741                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
742                         short_channel_id: 6,
743                         timestamp: 1,
744                         flags: 0,
745                         cltv_expiry_delta: (6 << 8) | 1,
746                         htlc_minimum_msat: 0,
747                         fee_base_msat: 0,
748                         fee_proportional_millionths: 0,
749                         excess_data: Vec::new()
750                 });
751                 update_channel(&net_graph_msg_handler, &secp_ctx, node5_privkey, UnsignedChannelUpdate {
752                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
753                         short_channel_id: 6,
754                         timestamp: 1,
755                         flags: 1,
756                         cltv_expiry_delta: (6 << 8) | 2,
757                         htlc_minimum_msat: 0,
758                         fee_base_msat: 0,
759                         fee_proportional_millionths: 0,
760                         excess_data: Vec::new()
761                 });
762
763                 add_channel(&net_graph_msg_handler, &secp_ctx, node5_privkey, node4_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(11)), 11);
764                 update_channel(&net_graph_msg_handler, &secp_ctx, node5_privkey, UnsignedChannelUpdate {
765                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
766                         short_channel_id: 11,
767                         timestamp: 1,
768                         flags: 0,
769                         cltv_expiry_delta: (11 << 8) | 1,
770                         htlc_minimum_msat: 0,
771                         fee_base_msat: 0,
772                         fee_proportional_millionths: 0,
773                         excess_data: Vec::new()
774                 });
775                 update_channel(&net_graph_msg_handler, &secp_ctx, node4_privkey, UnsignedChannelUpdate {
776                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
777                         short_channel_id: 11,
778                         timestamp: 1,
779                         flags: 1,
780                         cltv_expiry_delta: (11 << 8) | 2,
781                         htlc_minimum_msat: 0,
782                         fee_base_msat: 0,
783                         fee_proportional_millionths: 0,
784                         excess_data: Vec::new()
785                 });
786                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node5_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(5)), 0);
787                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node4_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(4)), 0);
788
789                 add_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, node6_privkey, ChannelFeatures::from_le_bytes(id_to_feature_flags!(7)), 7);
790
791                 update_channel(&net_graph_msg_handler, &secp_ctx, node3_privkey, UnsignedChannelUpdate {
792                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
793                         short_channel_id: 7,
794                         timestamp: 1,
795                         flags: 0,
796                         cltv_expiry_delta: (7 << 8) | 1,
797                         htlc_minimum_msat: 0,
798                         fee_base_msat: 0,
799                         fee_proportional_millionths: 1000000,
800                         excess_data: Vec::new()
801                 });
802                 update_channel(&net_graph_msg_handler, &secp_ctx, node6_privkey, UnsignedChannelUpdate {
803                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
804                         short_channel_id: 7,
805                         timestamp: 1,
806                         flags: 1,
807                         cltv_expiry_delta: (7 << 8) | 2,
808                         htlc_minimum_msat: 0,
809                         fee_base_msat: 0,
810                         fee_proportional_millionths: 0,
811                         excess_data: Vec::new()
812                 });
813
814                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node6_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(6)), 0);
815
816                 // Simple route to 3 via 2
817                 let route = get_route(&our_id, &net_graph_msg_handler, &node3, None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
818                 assert_eq!(route.paths[0].len(), 2);
819
820                 assert_eq!(route.paths[0][0].pubkey, node2);
821                 assert_eq!(route.paths[0][0].short_channel_id, 2);
822                 assert_eq!(route.paths[0][0].fee_msat, 100);
823                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
824                 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags!(2));
825                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags!(2));
826
827                 assert_eq!(route.paths[0][1].pubkey, node3);
828                 assert_eq!(route.paths[0][1].short_channel_id, 4);
829                 assert_eq!(route.paths[0][1].fee_msat, 100);
830                 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
831                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
832                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(4));
833
834
835                 // // Disable channels 4 and 12 by flags=2
836                 update_channel(&net_graph_msg_handler, &secp_ctx, node2_privkey, UnsignedChannelUpdate {
837                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
838                         short_channel_id: 4,
839                         timestamp: 2,
840                         flags: 2, // to disable
841                         cltv_expiry_delta: 0,
842                         htlc_minimum_msat: 0,
843                         fee_base_msat: 0,
844                         fee_proportional_millionths: 0,
845                         excess_data: Vec::new()
846                 });
847                 update_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, UnsignedChannelUpdate {
848                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
849                         short_channel_id: 12,
850                         timestamp: 2,
851                         flags: 2, // to disable
852                         cltv_expiry_delta: 0,
853                         htlc_minimum_msat: 0,
854                         fee_base_msat: 0,
855                         fee_proportional_millionths: 0,
856                         excess_data: Vec::new()
857                 });
858
859                 // If all the channels require some features we don't understand, route should fail
860                 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler, &node3, None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
861                         assert_eq!(err, "Failed to find a path to the given destination");
862                 } else { panic!(); }
863
864                 // If we specify a channel to node8, that overrides our local channel view and that gets used
865                 let our_chans = vec![channelmanager::ChannelDetails {
866                         channel_id: [0; 32],
867                         short_channel_id: Some(42),
868                         remote_network_id: node8.clone(),
869                         counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
870                         channel_value_satoshis: 0,
871                         user_id: 0,
872                         outbound_capacity_msat: 0,
873                         inbound_capacity_msat: 0,
874                         is_live: true,
875                 }];
876                 let route = get_route(&our_id, &net_graph_msg_handler, &node3, Some(&our_chans),  &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
877                 assert_eq!(route.paths[0].len(), 2);
878
879                 assert_eq!(route.paths[0][0].pubkey, node8);
880                 assert_eq!(route.paths[0][0].short_channel_id, 42);
881                 assert_eq!(route.paths[0][0].fee_msat, 200);
882                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
883                 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
884                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
885
886                 assert_eq!(route.paths[0][1].pubkey, node3);
887                 assert_eq!(route.paths[0][1].short_channel_id, 13);
888                 assert_eq!(route.paths[0][1].fee_msat, 100);
889                 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
890                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
891                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(13));
892
893                 // Re-enable channels 4 and 12
894                 update_channel(&net_graph_msg_handler, &secp_ctx, node2_privkey, UnsignedChannelUpdate {
895                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
896                         short_channel_id: 4,
897                         timestamp: 3,
898                         flags: 0, // to enable
899                         cltv_expiry_delta: (4 << 8) | 1,
900                         htlc_minimum_msat: 0,
901                         fee_base_msat: 0,
902                         fee_proportional_millionths: 1000000,
903                         excess_data: Vec::new()
904                 });
905                 update_channel(&net_graph_msg_handler, &secp_ctx, our_privkey, UnsignedChannelUpdate {
906                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
907                         short_channel_id: 12,
908                         timestamp: 3,
909                         flags: 0, // to enable
910                         cltv_expiry_delta: u16::max_value(),
911                         htlc_minimum_msat: 0,
912                         fee_base_msat: u32::max_value(),
913                         fee_proportional_millionths: u32::max_value(),
914                         excess_data: Vec::new()
915                 });
916                 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
917                 let mut unknown_features = NodeFeatures::known();
918                 unknown_features.set_required_unknown_bits();
919                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node1_privkey, unknown_features.clone(), 1);
920                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node2_privkey, unknown_features.clone(), 1);
921                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node8_privkey, unknown_features.clone(), 1);
922
923                 // // If all nodes require some features we don't understand, route should fail
924                 // if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler, &node3, None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
925                 //      assert_eq!(err, "Failed to find a path to the given destination");
926                 // } else { panic!(); }
927
928                 // If we specify a channel to node8, that overrides our local channel view and that gets used
929                 let our_chans = vec![channelmanager::ChannelDetails {
930                         channel_id: [0; 32],
931                         short_channel_id: Some(42),
932                         remote_network_id: node8.clone(),
933                         counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
934                         channel_value_satoshis: 0,
935                         user_id: 0,
936                         outbound_capacity_msat: 0,
937                         inbound_capacity_msat: 0,
938                         is_live: true,
939                 }];
940                 let route = get_route(&our_id, &net_graph_msg_handler, &node3, Some(&our_chans), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
941                 assert_eq!(route.paths[0].len(), 2);
942
943                 assert_eq!(route.paths[0][0].pubkey, node8);
944                 assert_eq!(route.paths[0][0].short_channel_id, 42);
945                 assert_eq!(route.paths[0][0].fee_msat, 200);
946                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
947                 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
948                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
949
950                 assert_eq!(route.paths[0][1].pubkey, node3);
951                 assert_eq!(route.paths[0][1].short_channel_id, 13);
952                 assert_eq!(route.paths[0][1].fee_msat, 100);
953                 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
954                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
955                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(13));
956
957                 // Re-enable nodes 1, 2, and 8
958                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node1_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(1)), 2);
959                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node2_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(2)), 2);
960                 add_or_update_node(&net_graph_msg_handler, &secp_ctx, node8_privkey, NodeFeatures::from_le_bytes(id_to_feature_flags!(8)), 2);
961
962                 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
963                 // naively) assume that the user checked the feature bits on the invoice, which override
964                 // the node_announcement.
965
966                 // Route to 1 via 2 and 3 because our channel to 1 is disabled
967                 let route = get_route(&our_id, &net_graph_msg_handler, &node1, None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
968                 assert_eq!(route.paths[0].len(), 3);
969
970                 assert_eq!(route.paths[0][0].pubkey, node2);
971                 assert_eq!(route.paths[0][0].short_channel_id, 2);
972                 assert_eq!(route.paths[0][0].fee_msat, 200);
973                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
974                 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags!(2));
975                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags!(2));
976
977                 assert_eq!(route.paths[0][1].pubkey, node3);
978                 assert_eq!(route.paths[0][1].short_channel_id, 4);
979                 assert_eq!(route.paths[0][1].fee_msat, 100);
980                 assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 8) | 2);
981                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
982                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(4));
983
984                 assert_eq!(route.paths[0][2].pubkey, node1);
985                 assert_eq!(route.paths[0][2].short_channel_id, 3);
986                 assert_eq!(route.paths[0][2].fee_msat, 100);
987                 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
988                 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags!(1));
989                 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags!(3));
990
991                 // If we specify a channel to node8, that overrides our local channel view and that gets used
992                 let our_chans = vec![channelmanager::ChannelDetails {
993                         channel_id: [0; 32],
994                         short_channel_id: Some(42),
995                         remote_network_id: node8.clone(),
996                         counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
997                         channel_value_satoshis: 0,
998                         user_id: 0,
999                         outbound_capacity_msat: 0,
1000                         inbound_capacity_msat: 0,
1001                         is_live: true,
1002                 }];
1003                 let route = get_route(&our_id, &net_graph_msg_handler, &node3, Some(&our_chans), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1004                 assert_eq!(route.paths[0].len(), 2);
1005
1006                 assert_eq!(route.paths[0][0].pubkey, node8);
1007                 assert_eq!(route.paths[0][0].short_channel_id, 42);
1008                 assert_eq!(route.paths[0][0].fee_msat, 200);
1009                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1010                 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1011                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1012
1013                 assert_eq!(route.paths[0][1].pubkey, node3);
1014                 assert_eq!(route.paths[0][1].short_channel_id, 13);
1015                 assert_eq!(route.paths[0][1].fee_msat, 100);
1016                 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1017                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
1018                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(13));
1019
1020                 let zero_fees = RoutingFees {
1021                         base_msat: 0,
1022                         proportional_millionths: 0,
1023                 };
1024                 let mut last_hops = vec!(RouteHint {
1025                                 src_node_id: node4.clone(),
1026                                 short_channel_id: 8,
1027                                 fees: zero_fees,
1028                                 cltv_expiry_delta: (8 << 8) | 1,
1029                                 htlc_minimum_msat: 0,
1030                         }, RouteHint {
1031                                 src_node_id: node5.clone(),
1032                                 short_channel_id: 9,
1033                                 fees: RoutingFees {
1034                                         base_msat: 1001,
1035                                         proportional_millionths: 0,
1036                                 },
1037                                 cltv_expiry_delta: (9 << 8) | 1,
1038                                 htlc_minimum_msat: 0,
1039                         }, RouteHint {
1040                                 src_node_id: node6.clone(),
1041                                 short_channel_id: 10,
1042                                 fees: zero_fees,
1043                                 cltv_expiry_delta: (10 << 8) | 1,
1044                                 htlc_minimum_msat: 0,
1045                         });
1046
1047                 // Simple test across 2, 3, 5, and 4 via a last_hop channel
1048                 let route = get_route(&our_id, &net_graph_msg_handler, &node7, None, &last_hops, 100, 42, Arc::clone(&logger)).unwrap();
1049                 assert_eq!(route.paths[0].len(), 5);
1050
1051                 assert_eq!(route.paths[0][0].pubkey, node2);
1052                 assert_eq!(route.paths[0][0].short_channel_id, 2);
1053                 assert_eq!(route.paths[0][0].fee_msat, 100);
1054                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1055                 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags!(2));
1056                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags!(2));
1057
1058                 assert_eq!(route.paths[0][1].pubkey, node3);
1059                 assert_eq!(route.paths[0][1].short_channel_id, 4);
1060                 assert_eq!(route.paths[0][1].fee_msat, 0);
1061                 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1062                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
1063                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(4));
1064
1065                 assert_eq!(route.paths[0][2].pubkey, node5);
1066                 assert_eq!(route.paths[0][2].short_channel_id, 6);
1067                 assert_eq!(route.paths[0][2].fee_msat, 0);
1068                 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1069                 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags!(5));
1070                 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags!(6));
1071
1072                 assert_eq!(route.paths[0][3].pubkey, node4);
1073                 assert_eq!(route.paths[0][3].short_channel_id, 11);
1074                 assert_eq!(route.paths[0][3].fee_msat, 0);
1075                 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1076                 // If we have a peer in the node map, we'll use their features here since we don't have
1077                 // a way of figuring out their features from the invoice:
1078                 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags!(4));
1079                 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags!(11));
1080
1081                 assert_eq!(route.paths[0][4].pubkey, node7);
1082                 assert_eq!(route.paths[0][4].short_channel_id, 8);
1083                 assert_eq!(route.paths[0][4].fee_msat, 100);
1084                 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1085                 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1086                 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1087
1088                 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
1089                 let our_chans = vec![channelmanager::ChannelDetails {
1090                         channel_id: [0; 32],
1091                         short_channel_id: Some(42),
1092                         remote_network_id: node4.clone(),
1093                         counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1094                         channel_value_satoshis: 0,
1095                         user_id: 0,
1096                         outbound_capacity_msat: 0,
1097                         inbound_capacity_msat: 0,
1098                         is_live: true,
1099                 }];
1100                 let route = get_route(&our_id, &net_graph_msg_handler, &node7, Some(&our_chans), &last_hops, 100, 42, Arc::clone(&logger)).unwrap();
1101                 assert_eq!(route.paths[0].len(), 2);
1102
1103                 assert_eq!(route.paths[0][0].pubkey, node4);
1104                 assert_eq!(route.paths[0][0].short_channel_id, 42);
1105                 assert_eq!(route.paths[0][0].fee_msat, 0);
1106                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1);
1107                 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1108                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1109
1110                 assert_eq!(route.paths[0][1].pubkey, node7);
1111                 assert_eq!(route.paths[0][1].short_channel_id, 8);
1112                 assert_eq!(route.paths[0][1].fee_msat, 100);
1113                 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1114                 assert_eq!(route.paths[0][1].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1115                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1116
1117                 last_hops[0].fees.base_msat = 1000;
1118
1119                 // Revert to via 6 as the fee on 8 goes up
1120                 let route = get_route(&our_id, &net_graph_msg_handler, &node7, None, &last_hops, 100, 42, Arc::clone(&logger)).unwrap();
1121                 assert_eq!(route.paths[0].len(), 4);
1122
1123                 assert_eq!(route.paths[0][0].pubkey, node2);
1124                 assert_eq!(route.paths[0][0].short_channel_id, 2);
1125                 assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node
1126                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1127                 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags!(2));
1128                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags!(2));
1129
1130                 assert_eq!(route.paths[0][1].pubkey, node3);
1131                 assert_eq!(route.paths[0][1].short_channel_id, 4);
1132                 assert_eq!(route.paths[0][1].fee_msat, 100);
1133                 assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 8) | 1);
1134                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
1135                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(4));
1136
1137                 assert_eq!(route.paths[0][2].pubkey, node6);
1138                 assert_eq!(route.paths[0][2].short_channel_id, 7);
1139                 assert_eq!(route.paths[0][2].fee_msat, 0);
1140                 assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 8) | 1);
1141                 // If we have a peer in the node map, we'll use their features here since we don't have
1142                 // a way of figuring out their features from the invoice:
1143                 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags!(6));
1144                 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags!(7));
1145
1146                 assert_eq!(route.paths[0][3].pubkey, node7);
1147                 assert_eq!(route.paths[0][3].short_channel_id, 10);
1148                 assert_eq!(route.paths[0][3].fee_msat, 100);
1149                 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
1150                 assert_eq!(route.paths[0][3].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1151                 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1152
1153                 // ...but still use 8 for larger payments as 6 has a variable feerate
1154                 let route = get_route(&our_id, &net_graph_msg_handler, &node7, None, &last_hops, 2000, 42, Arc::clone(&logger)).unwrap();
1155                 assert_eq!(route.paths[0].len(), 5);
1156
1157                 assert_eq!(route.paths[0][0].pubkey, node2);
1158                 assert_eq!(route.paths[0][0].short_channel_id, 2);
1159                 assert_eq!(route.paths[0][0].fee_msat, 3000);
1160                 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1161                 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags!(2));
1162                 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags!(2));
1163
1164                 assert_eq!(route.paths[0][1].pubkey, node3);
1165                 assert_eq!(route.paths[0][1].short_channel_id, 4);
1166                 assert_eq!(route.paths[0][1].fee_msat, 0);
1167                 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1168                 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags!(3));
1169                 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags!(4));
1170
1171                 assert_eq!(route.paths[0][2].pubkey, node5);
1172                 assert_eq!(route.paths[0][2].short_channel_id, 6);
1173                 assert_eq!(route.paths[0][2].fee_msat, 0);
1174                 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1175                 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags!(5));
1176                 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags!(6));
1177
1178                 assert_eq!(route.paths[0][3].pubkey, node4);
1179                 assert_eq!(route.paths[0][3].short_channel_id, 11);
1180                 assert_eq!(route.paths[0][3].fee_msat, 1000);
1181                 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1182                 // If we have a peer in the node map, we'll use their features here since we don't have
1183                 // a way of figuring out their features from the invoice:
1184                 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags!(4));
1185                 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags!(11));
1186
1187                 assert_eq!(route.paths[0][4].pubkey, node7);
1188                 assert_eq!(route.paths[0][4].short_channel_id, 8);
1189                 assert_eq!(route.paths[0][4].fee_msat, 2000);
1190                 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1191                 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1192                 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1193         }
1194 }