_ Git - rust-lightning/blob - lightning/src/routing/router.rs

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