1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level routing/network map tracking logic lives here.
12 //! You probably want to create a NetGraphMsgHandler and use that as your RoutingMessageHandler and then
13 //! interrogate it to get routes for your own payments.
15 use bitcoin::secp256k1::key::PublicKey;
17 use ln::channelmanager::ChannelDetails;
18 use ln::features::{ChannelFeatures, NodeFeatures};
19 use ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT};
20 use routing::network_graph::{NetworkGraph, RoutingFees};
21 use util::ser::{Writeable, Readable};
22 use util::logger::Logger;
25 use std::collections::{HashMap,BinaryHeap};
29 #[derive(Clone, PartialEq)]
31 /// The node_id of the node at this hop.
32 pub pubkey: PublicKey,
33 /// The node_announcement features of the node at this hop. For the last hop, these may be
34 /// amended to match the features present in the invoice this node generated.
35 pub node_features: NodeFeatures,
36 /// The channel that should be used from the previous hop to reach this node.
37 pub short_channel_id: u64,
38 /// The channel_announcement features of the channel that should be used from the previous hop
39 /// to reach this node.
40 pub channel_features: ChannelFeatures,
41 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
43 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
44 /// expected at the destination, in excess of the current block height.
45 pub cltv_expiry_delta: u32,
48 impl Writeable for Vec<RouteHop> {
49 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
50 (self.len() as u8).write(writer)?;
51 for hop in self.iter() {
52 hop.pubkey.write(writer)?;
53 hop.node_features.write(writer)?;
54 hop.short_channel_id.write(writer)?;
55 hop.channel_features.write(writer)?;
56 hop.fee_msat.write(writer)?;
57 hop.cltv_expiry_delta.write(writer)?;
63 impl Readable for Vec<RouteHop> {
64 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Vec<RouteHop>, DecodeError> {
65 let hops_count: u8 = Readable::read(reader)?;
66 let mut hops = Vec::with_capacity(hops_count as usize);
67 for _ in 0..hops_count {
69 pubkey: Readable::read(reader)?,
70 node_features: Readable::read(reader)?,
71 short_channel_id: Readable::read(reader)?,
72 channel_features: Readable::read(reader)?,
73 fee_msat: Readable::read(reader)?,
74 cltv_expiry_delta: Readable::read(reader)?,
81 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
82 /// it can take multiple paths. Each path is composed of one or more hops through the network.
83 #[derive(Clone, PartialEq)]
85 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
86 /// last RouteHop in each path must be the same.
87 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
88 /// destination. Thus, this must always be at least length one. While the maximum length of any
89 /// given path is variable, keeping the length of any path to less than 20 should currently
90 /// ensure it is viable.
91 pub paths: Vec<Vec<RouteHop>>,
94 impl Writeable for Route {
95 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
96 (self.paths.len() as u64).write(writer)?;
97 for hops in self.paths.iter() {
104 impl Readable for Route {
105 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
106 let path_count: u64 = Readable::read(reader)?;
107 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
108 for _ in 0..path_count {
109 paths.push(Readable::read(reader)?);
115 /// A channel descriptor which provides a last-hop route to get_route
116 pub struct RouteHint {
117 /// The node_id of the non-target end of the route
118 pub src_node_id: PublicKey,
119 /// The short_channel_id of this channel
120 pub short_channel_id: u64,
121 /// The fees which must be paid to use this channel
122 pub fees: RoutingFees,
123 /// The difference in CLTV values between this node and the next node.
124 pub cltv_expiry_delta: u16,
125 /// The minimum value, in msat, which must be relayed to the next hop.
126 pub htlc_minimum_msat: u64,
129 #[derive(Eq, PartialEq)]
130 struct RouteGraphNode {
132 lowest_fee_to_peer_through_node: u64,
133 lowest_fee_to_node: u64,
136 impl cmp::Ord for RouteGraphNode {
137 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
138 other.lowest_fee_to_peer_through_node.cmp(&self.lowest_fee_to_peer_through_node)
139 .then_with(|| other.pubkey.serialize().cmp(&self.pubkey.serialize()))
143 impl cmp::PartialOrd for RouteGraphNode {
144 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
145 Some(self.cmp(other))
149 struct DummyDirectionalChannelInfo {
150 cltv_expiry_delta: u32,
151 htlc_minimum_msat: u64,
156 /// Gets a route from us to the given target node.
158 /// Extra routing hops between known nodes and the target will be used if they are included in
161 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
162 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
163 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those in first_hops
166 /// Panics if first_hops contains channels without short_channel_ids
167 /// (ChannelManager::list_usable_channels will never include such channels).
169 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
170 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
171 /// *is* checked as they may change based on the receiving node.
172 pub fn get_route<L: Deref>(our_node_id: &PublicKey, network: &NetworkGraph, target: &PublicKey, first_hops: Option<&[&ChannelDetails]>,
173 last_hops: &[&RouteHint], final_value_msat: u64, final_cltv: u32, logger: L) -> Result<Route, LightningError> where L::Target: Logger {
174 // TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
175 // uptime/success in using a node in the past.
176 if *target == *our_node_id {
177 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
180 if final_value_msat > MAX_VALUE_MSAT {
181 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
184 // We do a dest-to-source Dijkstra's sorting by each node's distance from the destination
185 // plus the minimum per-HTLC fee to get from it to another node (aka "shitty A*").
186 // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
187 // to use as the A* heuristic beyond just the cost to get one node further than the current
190 let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
191 cltv_expiry_delta: 0,
192 htlc_minimum_msat: 0,
195 proportional_millionths: 0,
199 let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
200 let mut dist = HashMap::with_capacity(network.get_nodes().len());
202 let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
203 if let Some(hops) = first_hops {
205 let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
206 if chan.remote_network_id == *target {
208 paths: vec![vec![RouteHop {
209 pubkey: chan.remote_network_id,
210 node_features: chan.counterparty_features.to_context(),
212 channel_features: chan.counterparty_features.to_context(),
213 fee_msat: final_value_msat,
214 cltv_expiry_delta: final_cltv,
218 first_hop_targets.insert(chan.remote_network_id, (short_channel_id, chan.counterparty_features.clone()));
220 if first_hop_targets.is_empty() {
221 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
225 macro_rules! add_entry {
226 // Adds entry which goes from $src_node_id to $dest_node_id
227 // over the channel with id $chan_id with fees described in
228 // $directional_info.
229 ( $chan_id: expr, $src_node_id: expr, $dest_node_id: expr, $directional_info: expr, $chan_features: expr, $starting_fee_msat: expr ) => {
230 //TODO: Explore simply adding fee to hit htlc_minimum_msat
231 if $starting_fee_msat as u64 + final_value_msat >= $directional_info.htlc_minimum_msat {
232 let proportional_fee_millions = ($starting_fee_msat + final_value_msat).checked_mul($directional_info.fees.proportional_millionths as u64);
233 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
234 ($directional_info.fees.base_msat as u64).checked_add(part / 1000000) })
236 let mut total_fee = $starting_fee_msat as u64;
237 let hm_entry = dist.entry(&$src_node_id);
238 let old_entry = hm_entry.or_insert_with(|| {
239 let node = network.get_nodes().get(&$src_node_id).unwrap();
240 let mut fee_base_msat = u32::max_value();
241 let mut fee_proportional_millionths = u32::max_value();
242 if let Some(fees) = node.lowest_inbound_channel_fees {
243 fee_base_msat = fees.base_msat;
244 fee_proportional_millionths = fees.proportional_millionths;
248 fee_proportional_millionths,
250 pubkey: $dest_node_id.clone(),
251 node_features: NodeFeatures::empty(),
253 channel_features: $chan_features.clone(),
255 cltv_expiry_delta: 0,
259 if $src_node_id != *our_node_id {
260 // Ignore new_fee for channel-from-us as we assume all channels-from-us
261 // will have the same effective-fee
262 total_fee += new_fee;
263 if let Some(fee_inc) = final_value_msat.checked_add(total_fee).and_then(|inc| { (old_entry.2 as u64).checked_mul(inc) }) {
264 total_fee += fee_inc / 1000000 + (old_entry.1 as u64);
266 // max_value means we'll always fail the old_entry.0 > total_fee check
267 total_fee = u64::max_value();
270 let new_graph_node = RouteGraphNode {
271 pubkey: $src_node_id,
272 lowest_fee_to_peer_through_node: total_fee,
273 lowest_fee_to_node: $starting_fee_msat as u64 + new_fee,
275 if old_entry.0 > total_fee {
276 targets.push(new_graph_node);
277 old_entry.0 = total_fee;
278 old_entry.3 = RouteHop {
279 pubkey: $dest_node_id.clone(),
280 node_features: NodeFeatures::empty(),
281 short_channel_id: $chan_id.clone(),
282 channel_features: $chan_features.clone(),
283 fee_msat: new_fee, // This field is ignored on the last-hop anyway
284 cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
292 macro_rules! add_entries_to_cheapest_to_target_node {
293 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr ) => {
294 if first_hops.is_some() {
295 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&$node_id) {
296 add_entry!(first_hop, *our_node_id, $node_id, dummy_directional_info, features.to_context(), $fee_to_target_msat);
301 if let Some(node_info) = $node.announcement_info.as_ref() {
302 features = node_info.features.clone();
304 features = NodeFeatures::empty();
307 if !features.requires_unknown_bits() {
308 for chan_id in $node.channels.iter() {
309 let chan = network.get_channels().get(chan_id).unwrap();
310 if !chan.features.requires_unknown_bits() {
311 if chan.node_one == *$node_id {
312 // ie $node is one, ie next hop in A* is two, via the two_to_one channel
313 if first_hops.is_none() || chan.node_two != *our_node_id {
314 if let Some(two_to_one) = chan.two_to_one.as_ref() {
315 if two_to_one.enabled {
316 add_entry!(chan_id, chan.node_two, chan.node_one, two_to_one, chan.features, $fee_to_target_msat);
321 if first_hops.is_none() || chan.node_one != *our_node_id {
322 if let Some(one_to_two) = chan.one_to_two.as_ref() {
323 if one_to_two.enabled {
324 add_entry!(chan_id, chan.node_one, chan.node_two, one_to_two, chan.features, $fee_to_target_msat);
336 match network.get_nodes().get(target) {
339 add_entries_to_cheapest_to_target_node!(node, target, 0);
343 for hop in last_hops.iter() {
344 if first_hops.is_none() || hop.src_node_id != *our_node_id { // first_hop overrules last_hops
345 if network.get_nodes().get(&hop.src_node_id).is_some() {
346 if first_hops.is_some() {
347 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&hop.src_node_id) {
348 // Currently there are no channel-context features defined, so we are a
349 // bit lazy here. In the future, we should pull them out via our
350 // ChannelManager, but there's no reason to waste the space until we
352 add_entry!(first_hop, *our_node_id , hop.src_node_id, dummy_directional_info, features.to_context(), 0);
355 // BOLT 11 doesn't allow inclusion of features for the last hop hints, which
356 // really sucks, cause we're gonna need that eventually.
357 add_entry!(hop.short_channel_id, hop.src_node_id, target, hop, ChannelFeatures::empty(), 0);
362 while let Some(RouteGraphNode { pubkey, lowest_fee_to_node, .. }) = targets.pop() {
363 if pubkey == *our_node_id {
364 let mut res = vec!(dist.remove(&our_node_id).unwrap().3);
366 if let Some(&(_, ref features)) = first_hop_targets.get(&res.last().unwrap().pubkey) {
367 res.last_mut().unwrap().node_features = features.to_context();
368 } else if let Some(node) = network.get_nodes().get(&res.last().unwrap().pubkey) {
369 if let Some(node_info) = node.announcement_info.as_ref() {
370 res.last_mut().unwrap().node_features = node_info.features.clone();
372 res.last_mut().unwrap().node_features = NodeFeatures::empty();
375 // We should be able to fill in features for everything except the last
376 // hop, if the last hop was provided via a BOLT 11 invoice (though we
377 // should be able to extend it further as BOLT 11 does have feature
378 // flags for the last hop node itself).
379 assert!(res.last().unwrap().pubkey == *target);
381 if res.last().unwrap().pubkey == *target {
385 let new_entry = match dist.remove(&res.last().unwrap().pubkey) {
387 None => return Err(LightningError{err: "Failed to find a non-fee-overflowing path to the given destination".to_owned(), action: ErrorAction::IgnoreError}),
389 res.last_mut().unwrap().fee_msat = new_entry.fee_msat;
390 res.last_mut().unwrap().cltv_expiry_delta = new_entry.cltv_expiry_delta;
393 res.last_mut().unwrap().fee_msat = final_value_msat;
394 res.last_mut().unwrap().cltv_expiry_delta = final_cltv;
395 let route = Route { paths: vec![res] };
396 log_trace!(logger, "Got route: {}", log_route!(route));
400 match network.get_nodes().get(&pubkey) {
403 add_entries_to_cheapest_to_target_node!(node, &pubkey, lowest_fee_to_node);
408 Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError})
413 use routing::router::{get_route, RouteHint, RoutingFees};
414 use routing::network_graph::NetGraphMsgHandler;
415 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
416 use ln::msgs::{ErrorAction, LightningError, OptionalField, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler,
417 NodeAnnouncement, UnsignedNodeAnnouncement, ChannelUpdate, UnsignedChannelUpdate};
418 use ln::channelmanager;
419 use util::test_utils;
420 use util::ser::Writeable;
422 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
423 use bitcoin::hashes::Hash;
424 use bitcoin::network::constants::Network;
425 use bitcoin::blockdata::constants::genesis_block;
429 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
430 use bitcoin::secp256k1::{Secp256k1, All};
434 // Using the same keys for LN and BTC ids
435 fn add_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_1_privkey: &SecretKey,
436 node_2_privkey: &SecretKey, features: ChannelFeatures, short_channel_id: u64) {
437 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
438 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
440 let unsigned_announcement = UnsignedChannelAnnouncement {
442 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
446 bitcoin_key_1: node_id_1,
447 bitcoin_key_2: node_id_2,
448 excess_data: Vec::new(),
451 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
452 let valid_announcement = ChannelAnnouncement {
453 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
454 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
455 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
456 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
457 contents: unsigned_announcement.clone(),
459 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
460 Ok(res) => assert!(res),
465 fn update_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, update: UnsignedChannelUpdate) {
466 let msghash = hash_to_message!(&Sha256dHash::hash(&update.encode()[..])[..]);
467 let valid_channel_update = ChannelUpdate {
468 signature: secp_ctx.sign(&msghash, node_privkey),
469 contents: update.clone()
472 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
473 Ok(res) => assert!(res),
474 // Err(_) => panic!()
475 Err(e) => println!("{:?}", e.err)
480 fn add_or_update_node(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey,
481 features: NodeFeatures, timestamp: u32) {
482 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
483 let unsigned_announcement = UnsignedNodeAnnouncement {
489 addresses: Vec::new(),
490 excess_address_data: Vec::new(),
491 excess_data: Vec::new(),
493 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
494 let valid_announcement = NodeAnnouncement {
495 signature: secp_ctx.sign(&msghash, node_privkey),
496 contents: unsigned_announcement.clone()
499 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
505 fn get_nodes(secp_ctx: &Secp256k1<All>) -> (SecretKey, PublicKey, Vec<SecretKey>, Vec<PublicKey>) {
506 let privkeys: Vec<SecretKey> = (2..10).map(|i| {
507 SecretKey::from_slice(&hex::decode(format!("{:02}", i).repeat(32)).unwrap()[..]).unwrap()
510 let pubkeys = privkeys.iter().map(|secret| PublicKey::from_secret_key(&secp_ctx, secret)).collect();
512 let our_privkey = SecretKey::from_slice(&hex::decode("01".repeat(32)).unwrap()[..]).unwrap();
513 let our_id = PublicKey::from_secret_key(&secp_ctx, &our_privkey);
515 (our_privkey, our_id, privkeys, pubkeys)
518 fn id_to_feature_flags(id: u8) -> Vec<u8> {
519 // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
520 // test for it later.
521 let idx = (id - 1) * 2 + 1;
523 vec![1 << (idx - 8*3), 0, 0, 0]
524 } else if idx > 8*2 {
525 vec![1 << (idx - 8*2), 0, 0]
526 } else if idx > 8*1 {
527 vec![1 << (idx - 8*1), 0]
533 fn build_graph() -> (Secp256k1<All>, NetGraphMsgHandler<std::sync::Arc<crate::util::test_utils::TestChainSource>, std::sync::Arc<crate::util::test_utils::TestLogger>>, std::sync::Arc<test_utils::TestLogger>) {
534 let secp_ctx = Secp256k1::new();
535 let logger = Arc::new(test_utils::TestLogger::new());
536 let net_graph_msg_handler = NetGraphMsgHandler::new(None, Arc::clone(&logger));
537 // Build network from our_id to node7:
539 // -1(1)2- node0 -1(3)2-
541 // our_id -1(12)2- node7 -1(13)2--- node2
543 // -1(2)2- node1 -1(4)2-
546 // chan1 1-to-2: disabled
547 // chan1 2-to-1: enabled, 0 fee
549 // chan2 1-to-2: enabled, ignored fee
550 // chan2 2-to-1: enabled, 0 fee
552 // chan3 1-to-2: enabled, 0 fee
553 // chan3 2-to-1: enabled, 100 msat fee
555 // chan4 1-to-2: enabled, 100% fee
556 // chan4 2-to-1: enabled, 0 fee
558 // chan12 1-to-2: enabled, ignored fee
559 // chan12 2-to-1: enabled, 0 fee
561 // chan13 1-to-2: enabled, 200% fee
562 // chan13 2-to-1: enabled, 0 fee
565 // -1(5)2- node3 -1(8)2--
569 // node2--1(6)2- node4 -1(9)2--- node6 (not in global route map)
571 // -1(7)2- node5 -1(10)2-
573 // chan5 1-to-2: enabled, 100 msat fee
574 // chan5 2-to-1: enabled, 0 fee
576 // chan6 1-to-2: enabled, 0 fee
577 // chan6 2-to-1: enabled, 0 fee
579 // chan7 1-to-2: enabled, 100% fee
580 // chan7 2-to-1: enabled, 0 fee
582 // chan8 1-to-2: enabled, variable fee (0 then 1000 msat)
583 // chan8 2-to-1: enabled, 0 fee
585 // chan9 1-to-2: enabled, 1001 msat fee
586 // chan9 2-to-1: enabled, 0 fee
588 // chan10 1-to-2: enabled, 0 fee
589 // chan10 2-to-1: enabled, 0 fee
591 // chan11 1-to-2: enabled, 0 fee
592 // chan11 2-to-1: enabled, 0 fee
594 let (our_privkey, _, privkeys, _) = get_nodes(&secp_ctx);
596 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[0], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
597 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
598 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
602 cltv_expiry_delta: 0,
603 htlc_minimum_msat: 0,
604 htlc_maximum_msat: OptionalField::Absent,
606 fee_proportional_millionths: 0,
607 excess_data: Vec::new()
610 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
612 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[1], 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.block_hash(),
618 cltv_expiry_delta: u16::max_value(),
619 htlc_minimum_msat: 0,
620 htlc_maximum_msat: OptionalField::Absent,
621 fee_base_msat: u32::max_value(),
622 fee_proportional_millionths: u32::max_value(),
623 excess_data: Vec::new()
625 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
626 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
630 cltv_expiry_delta: 0,
631 htlc_minimum_msat: 0,
632 htlc_maximum_msat: OptionalField::Absent,
634 fee_proportional_millionths: 0,
635 excess_data: Vec::new()
638 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
640 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[7], ChannelFeatures::from_le_bytes(id_to_feature_flags(12)), 12);
641 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
642 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
643 short_channel_id: 12,
646 cltv_expiry_delta: u16::max_value(),
647 htlc_minimum_msat: 0,
648 htlc_maximum_msat: OptionalField::Absent,
649 fee_base_msat: u32::max_value(),
650 fee_proportional_millionths: u32::max_value(),
651 excess_data: Vec::new()
653 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
654 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
655 short_channel_id: 12,
658 cltv_expiry_delta: 0,
659 htlc_minimum_msat: 0,
660 htlc_maximum_msat: OptionalField::Absent,
662 fee_proportional_millionths: 0,
663 excess_data: Vec::new()
666 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], NodeFeatures::from_le_bytes(id_to_feature_flags(8)), 0);
668 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
669 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
670 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
674 cltv_expiry_delta: (3 << 8) | 1,
675 htlc_minimum_msat: 0,
676 htlc_maximum_msat: OptionalField::Absent,
678 fee_proportional_millionths: 0,
679 excess_data: Vec::new()
681 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
682 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
686 cltv_expiry_delta: (3 << 8) | 2,
687 htlc_minimum_msat: 0,
688 htlc_maximum_msat: OptionalField::Absent,
690 fee_proportional_millionths: 0,
691 excess_data: Vec::new()
694 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
695 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
696 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
700 cltv_expiry_delta: (4 << 8) | 1,
701 htlc_minimum_msat: 0,
702 htlc_maximum_msat: OptionalField::Absent,
704 fee_proportional_millionths: 1000000,
705 excess_data: Vec::new()
707 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
708 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
712 cltv_expiry_delta: (4 << 8) | 2,
713 htlc_minimum_msat: 0,
714 htlc_maximum_msat: OptionalField::Absent,
716 fee_proportional_millionths: 0,
717 excess_data: Vec::new()
720 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(13)), 13);
721 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
722 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
723 short_channel_id: 13,
726 cltv_expiry_delta: (13 << 8) | 1,
727 htlc_minimum_msat: 0,
728 htlc_maximum_msat: OptionalField::Absent,
730 fee_proportional_millionths: 2000000,
731 excess_data: Vec::new()
733 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
734 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
735 short_channel_id: 13,
738 cltv_expiry_delta: (13 << 8) | 2,
739 htlc_minimum_msat: 0,
740 htlc_maximum_msat: OptionalField::Absent,
742 fee_proportional_millionths: 0,
743 excess_data: Vec::new()
746 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
748 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
749 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
750 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
754 cltv_expiry_delta: (6 << 8) | 1,
755 htlc_minimum_msat: 0,
756 htlc_maximum_msat: OptionalField::Absent,
758 fee_proportional_millionths: 0,
759 excess_data: Vec::new()
761 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
762 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
766 cltv_expiry_delta: (6 << 8) | 2,
767 htlc_minimum_msat: 0,
768 htlc_maximum_msat: OptionalField::Absent,
770 fee_proportional_millionths: 0,
771 excess_data: Vec::new(),
774 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(11)), 11);
775 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
776 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
777 short_channel_id: 11,
780 cltv_expiry_delta: (11 << 8) | 1,
781 htlc_minimum_msat: 0,
782 htlc_maximum_msat: OptionalField::Absent,
784 fee_proportional_millionths: 0,
785 excess_data: Vec::new()
787 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
788 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
789 short_channel_id: 11,
792 cltv_expiry_delta: (11 << 8) | 2,
793 htlc_minimum_msat: 0,
794 htlc_maximum_msat: OptionalField::Absent,
796 fee_proportional_millionths: 0,
797 excess_data: Vec::new()
800 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(5)), 0);
802 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
804 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[5], ChannelFeatures::from_le_bytes(id_to_feature_flags(7)), 7);
805 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
806 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
810 cltv_expiry_delta: (7 << 8) | 1,
811 htlc_minimum_msat: 0,
812 htlc_maximum_msat: OptionalField::Absent,
814 fee_proportional_millionths: 1000000,
815 excess_data: Vec::new()
817 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[5], UnsignedChannelUpdate {
818 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
822 cltv_expiry_delta: (7 << 8) | 2,
823 htlc_minimum_msat: 0,
824 htlc_maximum_msat: OptionalField::Absent,
826 fee_proportional_millionths: 0,
827 excess_data: Vec::new()
830 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[5], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
832 (secp_ctx, net_graph_msg_handler, logger)
836 fn simple_route_test() {
837 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
838 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
840 // Simple route to 3 via 2
841 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
842 assert_eq!(route.paths[0].len(), 2);
844 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
845 assert_eq!(route.paths[0][0].short_channel_id, 2);
846 assert_eq!(route.paths[0][0].fee_msat, 100);
847 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
848 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
849 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
851 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
852 assert_eq!(route.paths[0][1].short_channel_id, 4);
853 assert_eq!(route.paths[0][1].fee_msat, 100);
854 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
855 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
856 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
860 fn disable_channels_test() {
861 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
862 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
864 // // Disable channels 4 and 12 by flags=2
865 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
866 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
869 flags: 2, // to disable
870 cltv_expiry_delta: 0,
871 htlc_minimum_msat: 0,
872 htlc_maximum_msat: OptionalField::Absent,
874 fee_proportional_millionths: 0,
875 excess_data: Vec::new()
877 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
878 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
879 short_channel_id: 12,
881 flags: 2, // to disable
882 cltv_expiry_delta: 0,
883 htlc_minimum_msat: 0,
884 htlc_maximum_msat: OptionalField::Absent,
886 fee_proportional_millionths: 0,
887 excess_data: Vec::new()
890 // If all the channels require some features we don't understand, route should fail
891 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
892 assert_eq!(err, "Failed to find a path to the given destination");
895 // If we specify a channel to node7, that overrides our local channel view and that gets used
896 let our_chans = vec![channelmanager::ChannelDetails {
898 short_channel_id: Some(42),
899 remote_network_id: nodes[7].clone(),
900 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
901 channel_value_satoshis: 0,
903 outbound_capacity_msat: 0,
904 inbound_capacity_msat: 0,
907 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
908 assert_eq!(route.paths[0].len(), 2);
910 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
911 assert_eq!(route.paths[0][0].short_channel_id, 42);
912 assert_eq!(route.paths[0][0].fee_msat, 200);
913 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
914 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
915 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
917 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
918 assert_eq!(route.paths[0][1].short_channel_id, 13);
919 assert_eq!(route.paths[0][1].fee_msat, 100);
920 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
921 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
922 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
926 fn disable_node_test() {
927 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
928 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
930 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
931 let mut unknown_features = NodeFeatures::known();
932 unknown_features.set_required_unknown_bits();
933 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
934 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
935 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
937 // If all nodes require some features we don't understand, route should fail
938 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
939 assert_eq!(err, "Failed to find a path to the given destination");
942 // If we specify a channel to node7, that overrides our local channel view and that gets used
943 let our_chans = vec![channelmanager::ChannelDetails {
945 short_channel_id: Some(42),
946 remote_network_id: nodes[7].clone(),
947 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
948 channel_value_satoshis: 0,
950 outbound_capacity_msat: 0,
951 inbound_capacity_msat: 0,
954 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
955 assert_eq!(route.paths[0].len(), 2);
957 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
958 assert_eq!(route.paths[0][0].short_channel_id, 42);
959 assert_eq!(route.paths[0][0].fee_msat, 200);
960 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
961 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
962 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
964 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
965 assert_eq!(route.paths[0][1].short_channel_id, 13);
966 assert_eq!(route.paths[0][1].fee_msat, 100);
967 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
968 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
969 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
971 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
972 // naively) assume that the user checked the feature bits on the invoice, which override
973 // the node_announcement.
977 fn our_chans_test() {
978 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
979 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
981 // Route to 1 via 2 and 3 because our channel to 1 is disabled
982 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0], None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
983 assert_eq!(route.paths[0].len(), 3);
985 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
986 assert_eq!(route.paths[0][0].short_channel_id, 2);
987 assert_eq!(route.paths[0][0].fee_msat, 200);
988 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
989 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
990 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
992 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
993 assert_eq!(route.paths[0][1].short_channel_id, 4);
994 assert_eq!(route.paths[0][1].fee_msat, 100);
995 assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 8) | 2);
996 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
997 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
999 assert_eq!(route.paths[0][2].pubkey, nodes[0]);
1000 assert_eq!(route.paths[0][2].short_channel_id, 3);
1001 assert_eq!(route.paths[0][2].fee_msat, 100);
1002 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
1003 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(1));
1004 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(3));
1006 // If we specify a channel to node7, that overrides our local channel view and that gets used
1007 let our_chans = vec![channelmanager::ChannelDetails {
1008 channel_id: [0; 32],
1009 short_channel_id: Some(42),
1010 remote_network_id: nodes[7].clone(),
1011 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1012 channel_value_satoshis: 0,
1014 outbound_capacity_msat: 0,
1015 inbound_capacity_msat: 0,
1018 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1019 assert_eq!(route.paths[0].len(), 2);
1021 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
1022 assert_eq!(route.paths[0][0].short_channel_id, 42);
1023 assert_eq!(route.paths[0][0].fee_msat, 200);
1024 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1025 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1026 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1028 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1029 assert_eq!(route.paths[0][1].short_channel_id, 13);
1030 assert_eq!(route.paths[0][1].fee_msat, 100);
1031 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1032 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1033 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
1036 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
1037 let zero_fees = RoutingFees {
1039 proportional_millionths: 0,
1042 src_node_id: nodes[3].clone(),
1043 short_channel_id: 8,
1045 cltv_expiry_delta: (8 << 8) | 1,
1046 htlc_minimum_msat: 0,
1048 src_node_id: nodes[4].clone(),
1049 short_channel_id: 9,
1052 proportional_millionths: 0,
1054 cltv_expiry_delta: (9 << 8) | 1,
1055 htlc_minimum_msat: 0,
1057 src_node_id: nodes[5].clone(),
1058 short_channel_id: 10,
1060 cltv_expiry_delta: (10 << 8) | 1,
1061 htlc_minimum_msat: 0,
1066 fn last_hops_test() {
1067 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
1068 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1070 // Simple test across 2, 3, 5, and 4 via a last_hop channel
1071 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops(&nodes).iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1072 assert_eq!(route.paths[0].len(), 5);
1074 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1075 assert_eq!(route.paths[0][0].short_channel_id, 2);
1076 assert_eq!(route.paths[0][0].fee_msat, 100);
1077 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1078 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1079 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1081 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1082 assert_eq!(route.paths[0][1].short_channel_id, 4);
1083 assert_eq!(route.paths[0][1].fee_msat, 0);
1084 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1085 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1086 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1088 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
1089 assert_eq!(route.paths[0][2].short_channel_id, 6);
1090 assert_eq!(route.paths[0][2].fee_msat, 0);
1091 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1092 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
1093 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
1095 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
1096 assert_eq!(route.paths[0][3].short_channel_id, 11);
1097 assert_eq!(route.paths[0][3].fee_msat, 0);
1098 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1099 // If we have a peer in the node map, we'll use their features here since we don't have
1100 // a way of figuring out their features from the invoice:
1101 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
1102 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
1104 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
1105 assert_eq!(route.paths[0][4].short_channel_id, 8);
1106 assert_eq!(route.paths[0][4].fee_msat, 100);
1107 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1108 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1109 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1113 fn our_chans_last_hop_connect_test() {
1114 let (secp_ctx, net_graph_msg_handler, logger) = build_graph();
1115 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1117 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
1118 let our_chans = vec![channelmanager::ChannelDetails {
1119 channel_id: [0; 32],
1120 short_channel_id: Some(42),
1121 remote_network_id: nodes[3].clone(),
1122 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1123 channel_value_satoshis: 0,
1125 outbound_capacity_msat: 0,
1126 inbound_capacity_msat: 0,
1129 let mut last_hops = last_hops(&nodes);
1130 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], Some(&our_chans.iter().collect::<Vec<_>>()), &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1131 assert_eq!(route.paths[0].len(), 2);
1133 assert_eq!(route.paths[0][0].pubkey, nodes[3]);
1134 assert_eq!(route.paths[0][0].short_channel_id, 42);
1135 assert_eq!(route.paths[0][0].fee_msat, 0);
1136 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1);
1137 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1138 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1140 assert_eq!(route.paths[0][1].pubkey, nodes[6]);
1141 assert_eq!(route.paths[0][1].short_channel_id, 8);
1142 assert_eq!(route.paths[0][1].fee_msat, 100);
1143 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1144 assert_eq!(route.paths[0][1].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1145 assert_eq!(route.paths[0][1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1147 last_hops[0].fees.base_msat = 1000;
1149 // Revert to via 6 as the fee on 8 goes up
1150 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
1151 assert_eq!(route.paths[0].len(), 4);
1153 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1154 assert_eq!(route.paths[0][0].short_channel_id, 2);
1155 assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node
1156 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1157 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1158 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1160 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1161 assert_eq!(route.paths[0][1].short_channel_id, 4);
1162 assert_eq!(route.paths[0][1].fee_msat, 100);
1163 assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 8) | 1);
1164 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1165 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1167 assert_eq!(route.paths[0][2].pubkey, nodes[5]);
1168 assert_eq!(route.paths[0][2].short_channel_id, 7);
1169 assert_eq!(route.paths[0][2].fee_msat, 0);
1170 assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 8) | 1);
1171 // If we have a peer in the node map, we'll use their features here since we don't have
1172 // a way of figuring out their features from the invoice:
1173 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
1174 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(7));
1176 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
1177 assert_eq!(route.paths[0][3].short_channel_id, 10);
1178 assert_eq!(route.paths[0][3].fee_msat, 100);
1179 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
1180 assert_eq!(route.paths[0][3].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1181 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
1183 // ...but still use 8 for larger payments as 6 has a variable feerate
1184 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, &last_hops.iter().collect::<Vec<_>>(), 2000, 42, Arc::clone(&logger)).unwrap();
1185 assert_eq!(route.paths[0].len(), 5);
1187 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1188 assert_eq!(route.paths[0][0].short_channel_id, 2);
1189 assert_eq!(route.paths[0][0].fee_msat, 3000);
1190 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1191 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1192 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1194 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1195 assert_eq!(route.paths[0][1].short_channel_id, 4);
1196 assert_eq!(route.paths[0][1].fee_msat, 0);
1197 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
1198 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1199 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1201 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
1202 assert_eq!(route.paths[0][2].short_channel_id, 6);
1203 assert_eq!(route.paths[0][2].fee_msat, 0);
1204 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
1205 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
1206 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
1208 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
1209 assert_eq!(route.paths[0][3].short_channel_id, 11);
1210 assert_eq!(route.paths[0][3].fee_msat, 1000);
1211 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
1212 // If we have a peer in the node map, we'll use their features here since we don't have
1213 // a way of figuring out their features from the invoice:
1214 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
1215 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
1217 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
1218 assert_eq!(route.paths[0][4].short_channel_id, 8);
1219 assert_eq!(route.paths[0][4].fee_msat, 2000);
1220 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
1221 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
1222 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly