1 //! The top-level routing/network map tracking logic lives here.
3 //! You probably want to create a Router and use that as your RoutingMessageHandler and then
4 //! interrogate it to get routes for your own payments.
6 use secp256k1::key::PublicKey;
7 use secp256k1::Secp256k1;
10 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
11 use bitcoin_hashes::Hash;
12 use bitcoin::blockdata::script::Builder;
13 use bitcoin::blockdata::opcodes;
15 use chain::chaininterface::{ChainError, ChainWatchInterface};
16 use ln::channelmanager;
17 use ln::features::{ChannelFeatures, NodeFeatures};
18 use ln::msgs::{DecodeError,ErrorAction,LightningError,RoutingMessageHandler,NetAddress};
20 use util::ser::{Writeable, Readable, Writer, ReadableArgs};
21 use util::logger::Logger;
24 use std::sync::{RwLock,Arc};
25 use std::sync::atomic::{AtomicUsize, Ordering};
26 use std::collections::{HashMap,BinaryHeap,BTreeMap};
27 use std::collections::btree_map::Entry as BtreeEntry;
31 #[derive(Clone, PartialEq)]
33 /// The node_id of the node at this hop.
34 pub pubkey: PublicKey,
35 /// The node_announcement features of the node at this hop. For the last hop, these may be
36 /// amended to match the features present in the invoice this node generated.
37 pub node_features: NodeFeatures,
38 /// The channel that should be used from the previous hop to reach this node.
39 pub short_channel_id: u64,
40 /// The channel_announcement features of the channel that should be used from the previous hop
41 /// to reach this node.
42 pub channel_features: ChannelFeatures,
43 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
45 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
46 /// expected at the destination, in excess of the current block height.
47 pub cltv_expiry_delta: u32,
50 /// A route from us through the network to a destination
51 #[derive(Clone, PartialEq)]
53 /// The list of hops, NOT INCLUDING our own, where the last hop is the destination. Thus, this
54 /// must always be at least length one. By protocol rules, this may not currently exceed 20 in
56 pub hops: Vec<RouteHop>,
59 impl Writeable for Route {
60 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
61 (self.hops.len() as u8).write(writer)?;
62 for hop in self.hops.iter() {
63 hop.pubkey.write(writer)?;
64 hop.node_features.write(writer)?;
65 hop.short_channel_id.write(writer)?;
66 hop.channel_features.write(writer)?;
67 hop.fee_msat.write(writer)?;
68 hop.cltv_expiry_delta.write(writer)?;
74 impl Readable for Route {
75 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
76 let hops_count: u8 = Readable::read(reader)?;
77 let mut hops = Vec::with_capacity(hops_count as usize);
78 for _ in 0..hops_count {
80 pubkey: Readable::read(reader)?,
81 node_features: Readable::read(reader)?,
82 short_channel_id: Readable::read(reader)?,
83 channel_features: Readable::read(reader)?,
84 fee_msat: Readable::read(reader)?,
85 cltv_expiry_delta: Readable::read(reader)?,
95 struct DirectionalChannelInfo {
96 src_node_id: PublicKey,
99 cltv_expiry_delta: u16,
100 htlc_minimum_msat: u64,
102 fee_proportional_millionths: u32,
103 last_update_message: Option<msgs::ChannelUpdate>,
106 impl std::fmt::Display for DirectionalChannelInfo {
107 fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
108 write!(f, "src_node_id {}, last_update {}, enabled {}, cltv_expiry_delta {}, htlc_minimum_msat {}, fee_base_msat {}, fee_proportional_millionths {}", log_pubkey!(self.src_node_id), self.last_update, self.enabled, self.cltv_expiry_delta, self.htlc_minimum_msat, self.fee_base_msat, self.fee_proportional_millionths)?;
113 impl_writeable!(DirectionalChannelInfo, 0, {
120 fee_proportional_millionths,
126 features: ChannelFeatures,
127 one_to_two: DirectionalChannelInfo,
128 two_to_one: DirectionalChannelInfo,
129 //this is cached here so we can send out it later if required by route_init_sync
130 //keep an eye on this to see if the extra memory is a problem
131 announcement_message: Option<msgs::ChannelAnnouncement>,
134 impl std::fmt::Display for ChannelInfo {
135 fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
136 write!(f, "features: {}, one_to_two: {}, two_to_one: {}", log_bytes!(self.features.encode()), self.one_to_two, self.two_to_one)?;
141 impl_writeable!(ChannelInfo, 0, {
150 #[cfg(feature = "non_bitcoin_chain_hash_routing")]
151 channels: Vec<(u64, Sha256dHash)>,
152 #[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
155 lowest_inbound_channel_fee_base_msat: u32,
156 lowest_inbound_channel_fee_proportional_millionths: u32,
158 features: NodeFeatures,
159 /// Unlike for channels, we may have a NodeInfo entry before having received a node_update.
160 /// Thus, we have to be able to capture "no update has been received", which we do with an
162 last_update: Option<u32>,
165 addresses: Vec<NetAddress>,
166 //this is cached here so we can send out it later if required by route_init_sync
167 //keep an eye on this to see if the extra memory is a problem
168 announcement_message: Option<msgs::NodeAnnouncement>,
171 impl std::fmt::Display for NodeInfo {
172 fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
173 write!(f, "features: {}, last_update: {:?}, lowest_inbound_channel_fee_base_msat: {}, lowest_inbound_channel_fee_proportional_millionths: {}, channels: {:?}", log_bytes!(self.features.encode()), self.last_update, self.lowest_inbound_channel_fee_base_msat, self.lowest_inbound_channel_fee_proportional_millionths, &self.channels[..])?;
178 impl Writeable for NodeInfo {
179 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
180 (self.channels.len() as u64).write(writer)?;
181 for ref chan in self.channels.iter() {
184 self.lowest_inbound_channel_fee_base_msat.write(writer)?;
185 self.lowest_inbound_channel_fee_proportional_millionths.write(writer)?;
186 self.features.write(writer)?;
187 self.last_update.write(writer)?;
188 self.rgb.write(writer)?;
189 self.alias.write(writer)?;
190 (self.addresses.len() as u64).write(writer)?;
191 for ref addr in &self.addresses {
194 self.announcement_message.write(writer)?;
199 const MAX_ALLOC_SIZE: u64 = 64*1024;
201 impl Readable for NodeInfo {
202 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<NodeInfo, DecodeError> {
203 let channels_count: u64 = Readable::read(reader)?;
204 let mut channels = Vec::with_capacity(cmp::min(channels_count, MAX_ALLOC_SIZE / 8) as usize);
205 for _ in 0..channels_count {
206 channels.push(Readable::read(reader)?);
208 let lowest_inbound_channel_fee_base_msat = Readable::read(reader)?;
209 let lowest_inbound_channel_fee_proportional_millionths = Readable::read(reader)?;
210 let features = Readable::read(reader)?;
211 let last_update = Readable::read(reader)?;
212 let rgb = Readable::read(reader)?;
213 let alias = Readable::read(reader)?;
214 let addresses_count: u64 = Readable::read(reader)?;
215 let mut addresses = Vec::with_capacity(cmp::min(addresses_count, MAX_ALLOC_SIZE / 40) as usize);
216 for _ in 0..addresses_count {
217 match Readable::read(reader) {
218 Ok(Ok(addr)) => { addresses.push(addr); },
219 Ok(Err(_)) => return Err(DecodeError::InvalidValue),
220 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
224 let announcement_message = Readable::read(reader)?;
227 lowest_inbound_channel_fee_base_msat,
228 lowest_inbound_channel_fee_proportional_millionths,
241 #[cfg(feature = "non_bitcoin_chain_hash_routing")]
242 channels: BTreeMap<(u64, Sha256dHash), ChannelInfo>,
243 #[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
244 channels: BTreeMap<u64, ChannelInfo>,
246 our_node_id: PublicKey,
247 nodes: BTreeMap<PublicKey, NodeInfo>,
250 impl Writeable for NetworkMap {
251 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
252 (self.channels.len() as u64).write(writer)?;
253 for (ref chan_id, ref chan_info) in self.channels.iter() {
254 (*chan_id).write(writer)?;
255 chan_info.write(writer)?;
257 self.our_node_id.write(writer)?;
258 (self.nodes.len() as u64).write(writer)?;
259 for (ref node_id, ref node_info) in self.nodes.iter() {
260 node_id.write(writer)?;
261 node_info.write(writer)?;
267 impl Readable for NetworkMap {
268 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<NetworkMap, DecodeError> {
269 let channels_count: u64 = Readable::read(reader)?;
270 let mut channels = BTreeMap::new();
271 for _ in 0..channels_count {
272 let chan_id: u64 = Readable::read(reader)?;
273 let chan_info = Readable::read(reader)?;
274 channels.insert(chan_id, chan_info);
276 let our_node_id = Readable::read(reader)?;
277 let nodes_count: u64 = Readable::read(reader)?;
278 let mut nodes = BTreeMap::new();
279 for _ in 0..nodes_count {
280 let node_id = Readable::read(reader)?;
281 let node_info = Readable::read(reader)?;
282 nodes.insert(node_id, node_info);
292 impl std::fmt::Display for NetworkMap {
293 fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
294 write!(f, "Node id {} network map\n[Channels]\n", log_pubkey!(self.our_node_id))?;
295 for (key, val) in self.channels.iter() {
296 write!(f, " {}: {}\n", key, val)?;
298 write!(f, "[Nodes]\n")?;
299 for (key, val) in self.nodes.iter() {
300 write!(f, " {}: {}\n", log_pubkey!(key), val)?;
307 #[cfg(feature = "non_bitcoin_chain_hash_routing")]
309 fn get_key(short_channel_id: u64, chain_hash: Sha256dHash) -> (u64, Sha256dHash) {
310 (short_channel_id, chain_hash)
313 #[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
315 fn get_key(short_channel_id: u64, _: Sha256dHash) -> u64 {
319 #[cfg(feature = "non_bitcoin_chain_hash_routing")]
321 fn get_short_id(id: &(u64, Sha256dHash)) -> &u64 {
325 #[cfg(not(feature = "non_bitcoin_chain_hash_routing"))]
327 fn get_short_id(id: &u64) -> &u64 {
332 /// A channel descriptor which provides a last-hop route to get_route
333 pub struct RouteHint {
334 /// The node_id of the non-target end of the route
335 pub src_node_id: PublicKey,
336 /// The short_channel_id of this channel
337 pub short_channel_id: u64,
338 /// The static msat-denominated fee which must be paid to use this channel
339 pub fee_base_msat: u32,
340 /// The dynamic proportional fee which must be paid to use this channel, denominated in
341 /// millionths of the value being forwarded to the next hop.
342 pub fee_proportional_millionths: u32,
343 /// The difference in CLTV values between this node and the next node.
344 pub cltv_expiry_delta: u16,
345 /// The minimum value, in msat, which must be relayed to the next hop.
346 pub htlc_minimum_msat: u64,
349 /// Tracks a view of the network, receiving updates from peers and generating Routes to
350 /// payment destinations.
352 secp_ctx: Secp256k1<secp256k1::VerifyOnly>,
353 network_map: RwLock<NetworkMap>,
354 full_syncs_requested: AtomicUsize,
355 chain_monitor: Arc<ChainWatchInterface>,
359 const SERIALIZATION_VERSION: u8 = 1;
360 const MIN_SERIALIZATION_VERSION: u8 = 1;
362 impl Writeable for Router {
363 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
364 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
365 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
367 let network = self.network_map.read().unwrap();
368 network.write(writer)?;
373 /// Arguments for the creation of a Router that are not deserialized.
374 /// At a high-level, the process for deserializing a Router and resuming normal operation is:
375 /// 1) Deserialize the Router by filling in this struct and calling <Router>::read(reaser, args).
376 /// 2) Register the new Router with your ChainWatchInterface
377 pub struct RouterReadArgs {
378 /// The ChainWatchInterface for use in the Router in the future.
380 /// No calls to the ChainWatchInterface will be made during deserialization.
381 pub chain_monitor: Arc<ChainWatchInterface>,
382 /// The Logger for use in the ChannelManager and which may be used to log information during
384 pub logger: Arc<Logger>,
387 impl ReadableArgs<RouterReadArgs> for Router {
388 fn read<R: ::std::io::Read>(reader: &mut R, args: RouterReadArgs) -> Result<Router, DecodeError> {
389 let _ver: u8 = Readable::read(reader)?;
390 let min_ver: u8 = Readable::read(reader)?;
391 if min_ver > SERIALIZATION_VERSION {
392 return Err(DecodeError::UnknownVersion);
394 let network_map = Readable::read(reader)?;
396 secp_ctx: Secp256k1::verification_only(),
397 network_map: RwLock::new(network_map),
398 full_syncs_requested: AtomicUsize::new(0),
399 chain_monitor: args.chain_monitor,
405 macro_rules! secp_verify_sig {
406 ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr ) => {
407 match $secp_ctx.verify($msg, $sig, $pubkey) {
409 Err(_) => return Err(LightningError{err: "Invalid signature from remote node", action: ErrorAction::IgnoreError}),
414 impl RoutingMessageHandler for Router {
416 fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
417 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
418 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.signature, &msg.contents.node_id);
420 let mut network = self.network_map.write().unwrap();
421 match network.nodes.get_mut(&msg.contents.node_id) {
422 None => Err(LightningError{err: "No existing channels for node_announcement", action: ErrorAction::IgnoreError}),
424 match node.last_update {
425 Some(last_update) => if last_update >= msg.contents.timestamp {
426 return Err(LightningError{err: "Update older than last processed update", action: ErrorAction::IgnoreError});
431 node.features = msg.contents.features.clone();
432 node.last_update = Some(msg.contents.timestamp);
433 node.rgb = msg.contents.rgb;
434 node.alias = msg.contents.alias;
435 node.addresses = msg.contents.addresses.clone();
437 let should_relay = msg.contents.excess_data.is_empty() && msg.contents.excess_address_data.is_empty();
438 node.announcement_message = if should_relay { Some(msg.clone()) } else { None };
444 fn handle_channel_announcement(&self, msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
445 if msg.contents.node_id_1 == msg.contents.node_id_2 || msg.contents.bitcoin_key_1 == msg.contents.bitcoin_key_2 {
446 return Err(LightningError{err: "Channel announcement node had a channel with itself", action: ErrorAction::IgnoreError});
449 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
450 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_1, &msg.contents.node_id_1);
451 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_2, &msg.contents.node_id_2);
452 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_1, &msg.contents.bitcoin_key_1);
453 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_2, &msg.contents.bitcoin_key_2);
455 let checked_utxo = match self.chain_monitor.get_chain_utxo(msg.contents.chain_hash, msg.contents.short_channel_id) {
456 Ok((script_pubkey, _value)) => {
457 let expected_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
458 .push_slice(&msg.contents.bitcoin_key_1.serialize())
459 .push_slice(&msg.contents.bitcoin_key_2.serialize())
460 .push_opcode(opcodes::all::OP_PUSHNUM_2)
461 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
462 if script_pubkey != expected_script {
463 return Err(LightningError{err: "Channel announcement keys didn't match on-chain script", action: ErrorAction::IgnoreError});
465 //TODO: Check if value is worth storing, use it to inform routing, and compare it
466 //to the new HTLC max field in channel_update
469 Err(ChainError::NotSupported) => {
470 // Tentatively accept, potentially exposing us to DoS attacks
473 Err(ChainError::NotWatched) => {
474 return Err(LightningError{err: "Channel announced on an unknown chain", action: ErrorAction::IgnoreError});
476 Err(ChainError::UnknownTx) => {
477 return Err(LightningError{err: "Channel announced without corresponding UTXO entry", action: ErrorAction::IgnoreError});
481 let mut network_lock = self.network_map.write().unwrap();
482 let network = &mut *network_lock;
484 let should_relay = msg.contents.excess_data.is_empty();
486 let chan_info = ChannelInfo {
487 features: msg.contents.features.clone(),
488 one_to_two: DirectionalChannelInfo {
489 src_node_id: msg.contents.node_id_1.clone(),
492 cltv_expiry_delta: u16::max_value(),
493 htlc_minimum_msat: u64::max_value(),
494 fee_base_msat: u32::max_value(),
495 fee_proportional_millionths: u32::max_value(),
496 last_update_message: None,
498 two_to_one: DirectionalChannelInfo {
499 src_node_id: msg.contents.node_id_2.clone(),
502 cltv_expiry_delta: u16::max_value(),
503 htlc_minimum_msat: u64::max_value(),
504 fee_base_msat: u32::max_value(),
505 fee_proportional_millionths: u32::max_value(),
506 last_update_message: None,
508 announcement_message: if should_relay { Some(msg.clone()) } else { None },
511 match network.channels.entry(NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)) {
512 BtreeEntry::Occupied(mut entry) => {
513 //TODO: because asking the blockchain if short_channel_id is valid is only optional
514 //in the blockchain API, we need to handle it smartly here, though it's unclear
517 // Either our UTXO provider is busted, there was a reorg, or the UTXO provider
518 // only sometimes returns results. In any case remove the previous entry. Note
519 // that the spec expects us to "blacklist" the node_ids involved, but we can't
521 // a) we don't *require* a UTXO provider that always returns results.
522 // b) we don't track UTXOs of channels we know about and remove them if they
524 // c) it's unclear how to do so without exposing ourselves to massive DoS risk.
525 Self::remove_channel_in_nodes(&mut network.nodes, &entry.get(), msg.contents.short_channel_id);
526 *entry.get_mut() = chan_info;
528 return Err(LightningError{err: "Already have knowledge of channel", action: ErrorAction::IgnoreError})
531 BtreeEntry::Vacant(entry) => {
532 entry.insert(chan_info);
536 macro_rules! add_channel_to_node {
537 ( $node_id: expr ) => {
538 match network.nodes.entry($node_id) {
539 BtreeEntry::Occupied(node_entry) => {
540 node_entry.into_mut().channels.push(NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash));
542 BtreeEntry::Vacant(node_entry) => {
543 node_entry.insert(NodeInfo {
544 channels: vec!(NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)),
545 lowest_inbound_channel_fee_base_msat: u32::max_value(),
546 lowest_inbound_channel_fee_proportional_millionths: u32::max_value(),
547 features: NodeFeatures::empty(),
551 addresses: Vec::new(),
552 announcement_message: None,
559 add_channel_to_node!(msg.contents.node_id_1);
560 add_channel_to_node!(msg.contents.node_id_2);
565 fn handle_htlc_fail_channel_update(&self, update: &msgs::HTLCFailChannelUpdate) {
567 &msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg } => {
568 let _ = self.handle_channel_update(msg);
570 &msgs::HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
571 let mut network = self.network_map.write().unwrap();
573 if let Some(chan) = network.channels.remove(short_channel_id) {
574 Self::remove_channel_in_nodes(&mut network.nodes, &chan, *short_channel_id);
577 if let Some(chan) = network.channels.get_mut(short_channel_id) {
578 chan.one_to_two.enabled = false;
579 chan.two_to_one.enabled = false;
583 &msgs::HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
585 //TODO: Wholly remove the node
587 self.mark_node_bad(node_id, false);
593 fn handle_channel_update(&self, msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
594 let mut network = self.network_map.write().unwrap();
596 let chan_enabled = msg.contents.flags & (1 << 1) != (1 << 1);
597 let chan_was_enabled;
599 match network.channels.get_mut(&NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)) {
600 None => return Err(LightningError{err: "Couldn't find channel for update", action: ErrorAction::IgnoreError}),
602 macro_rules! maybe_update_channel_info {
603 ( $target: expr) => {
604 if $target.last_update >= msg.contents.timestamp {
605 return Err(LightningError{err: "Update older than last processed update", action: ErrorAction::IgnoreError});
607 chan_was_enabled = $target.enabled;
608 $target.last_update = msg.contents.timestamp;
609 $target.enabled = chan_enabled;
610 $target.cltv_expiry_delta = msg.contents.cltv_expiry_delta;
611 $target.htlc_minimum_msat = msg.contents.htlc_minimum_msat;
612 $target.fee_base_msat = msg.contents.fee_base_msat;
613 $target.fee_proportional_millionths = msg.contents.fee_proportional_millionths;
614 $target.last_update_message = if msg.contents.excess_data.is_empty() {
621 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
622 if msg.contents.flags & 1 == 1 {
623 dest_node_id = channel.one_to_two.src_node_id.clone();
624 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.signature, &channel.two_to_one.src_node_id);
625 maybe_update_channel_info!(channel.two_to_one);
627 dest_node_id = channel.two_to_one.src_node_id.clone();
628 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.signature, &channel.one_to_two.src_node_id);
629 maybe_update_channel_info!(channel.one_to_two);
635 let node = network.nodes.get_mut(&dest_node_id).unwrap();
636 node.lowest_inbound_channel_fee_base_msat = cmp::min(node.lowest_inbound_channel_fee_base_msat, msg.contents.fee_base_msat);
637 node.lowest_inbound_channel_fee_proportional_millionths = cmp::min(node.lowest_inbound_channel_fee_proportional_millionths, msg.contents.fee_proportional_millionths);
638 } else if chan_was_enabled {
639 let mut lowest_inbound_channel_fee_base_msat = u32::max_value();
640 let mut lowest_inbound_channel_fee_proportional_millionths = u32::max_value();
643 let node = network.nodes.get(&dest_node_id).unwrap();
645 for chan_id in node.channels.iter() {
646 let chan = network.channels.get(chan_id).unwrap();
647 if chan.one_to_two.src_node_id == dest_node_id {
648 lowest_inbound_channel_fee_base_msat = cmp::min(lowest_inbound_channel_fee_base_msat, chan.two_to_one.fee_base_msat);
649 lowest_inbound_channel_fee_proportional_millionths = cmp::min(lowest_inbound_channel_fee_proportional_millionths, chan.two_to_one.fee_proportional_millionths);
651 lowest_inbound_channel_fee_base_msat = cmp::min(lowest_inbound_channel_fee_base_msat, chan.one_to_two.fee_base_msat);
652 lowest_inbound_channel_fee_proportional_millionths = cmp::min(lowest_inbound_channel_fee_proportional_millionths, chan.one_to_two.fee_proportional_millionths);
657 //TODO: satisfy the borrow-checker without a double-map-lookup :(
658 let mut_node = network.nodes.get_mut(&dest_node_id).unwrap();
659 mut_node.lowest_inbound_channel_fee_base_msat = lowest_inbound_channel_fee_base_msat;
660 mut_node.lowest_inbound_channel_fee_proportional_millionths = lowest_inbound_channel_fee_proportional_millionths;
663 Ok(msg.contents.excess_data.is_empty())
667 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, msgs::ChannelUpdate,msgs::ChannelUpdate)> {
668 let mut result = Vec::with_capacity(batch_amount as usize);
669 let network = self.network_map.read().unwrap();
670 let mut iter = network.channels.range(starting_point..);
671 while result.len() < batch_amount as usize {
672 if let Some((_, ref chan)) = iter.next() {
673 if chan.announcement_message.is_some() &&
674 chan.one_to_two.last_update_message.is_some() &&
675 chan.two_to_one.last_update_message.is_some() {
676 result.push((chan.announcement_message.clone().unwrap(),
677 chan.one_to_two.last_update_message.clone().unwrap(),
678 chan.two_to_one.last_update_message.clone().unwrap()));
680 // TODO: We may end up sending un-announced channel_updates if we are sending
681 // initial sync data while receiving announce/updates for this channel.
690 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
691 let mut result = Vec::with_capacity(batch_amount as usize);
692 let network = self.network_map.read().unwrap();
693 let mut iter = if let Some(pubkey) = starting_point {
694 let mut iter = network.nodes.range((*pubkey)..);
698 network.nodes.range(..)
700 while result.len() < batch_amount as usize {
701 if let Some((_, ref node)) = iter.next() {
702 if node.announcement_message.is_some() {
703 result.push(node.announcement_message.clone().unwrap());
712 fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
713 //TODO: Determine whether to request a full sync based on the network map.
714 const FULL_SYNCS_TO_REQUEST: usize = 5;
715 if self.full_syncs_requested.load(Ordering::Acquire) < FULL_SYNCS_TO_REQUEST {
716 self.full_syncs_requested.fetch_add(1, Ordering::AcqRel);
724 #[derive(Eq, PartialEq)]
725 struct RouteGraphNode {
727 lowest_fee_to_peer_through_node: u64,
728 lowest_fee_to_node: u64,
731 impl cmp::Ord for RouteGraphNode {
732 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
733 other.lowest_fee_to_peer_through_node.cmp(&self.lowest_fee_to_peer_through_node)
734 .then_with(|| other.pubkey.serialize().cmp(&self.pubkey.serialize()))
738 impl cmp::PartialOrd for RouteGraphNode {
739 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
740 Some(self.cmp(other))
744 struct DummyDirectionalChannelInfo {
745 src_node_id: PublicKey,
746 cltv_expiry_delta: u32,
747 htlc_minimum_msat: u64,
749 fee_proportional_millionths: u32,
753 /// Creates a new router with the given node_id to be used as the source for get_route()
754 pub fn new(our_pubkey: PublicKey, chain_monitor: Arc<ChainWatchInterface>, logger: Arc<Logger>) -> Router {
755 let mut nodes = BTreeMap::new();
756 nodes.insert(our_pubkey.clone(), NodeInfo {
757 channels: Vec::new(),
758 lowest_inbound_channel_fee_base_msat: u32::max_value(),
759 lowest_inbound_channel_fee_proportional_millionths: u32::max_value(),
760 features: NodeFeatures::empty(),
764 addresses: Vec::new(),
765 announcement_message: None,
768 secp_ctx: Secp256k1::verification_only(),
769 network_map: RwLock::new(NetworkMap {
770 channels: BTreeMap::new(),
771 our_node_id: our_pubkey,
774 full_syncs_requested: AtomicUsize::new(0),
780 /// Dumps the entire network view of this Router to the logger provided in the constructor at
782 pub fn trace_state(&self) {
783 log_trace!(self, "{}", self.network_map.read().unwrap());
786 /// Get network addresses by node id
787 pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
788 let network = self.network_map.read().unwrap();
789 network.nodes.get(pubkey).map(|n| n.addresses.clone())
792 /// Marks a node as having failed a route. This will avoid re-using the node in routes for now,
793 /// with an exponential decay in node "badness". Note that there is deliberately no
794 /// mark_channel_bad as a node may simply lie and suggest that an upstream channel from it is
795 /// what failed the route and not the node itself. Instead, setting the blamed_upstream_node
796 /// boolean will reduce the penalty, returning the node to usability faster. If the node is
797 /// behaving correctly, it will disable the failing channel and we will use it again next time.
798 pub fn mark_node_bad(&self, _node_id: &PublicKey, _blamed_upstream_node: bool) {
802 fn remove_channel_in_nodes(nodes: &mut BTreeMap<PublicKey, NodeInfo>, chan: &ChannelInfo, short_channel_id: u64) {
803 macro_rules! remove_from_node {
804 ($node_id: expr) => {
805 if let BtreeEntry::Occupied(mut entry) = nodes.entry($node_id) {
806 entry.get_mut().channels.retain(|chan_id| {
807 short_channel_id != *NetworkMap::get_short_id(chan_id)
809 if entry.get().channels.is_empty() {
810 entry.remove_entry();
813 panic!("Had channel that pointed to unknown node (ie inconsistent network map)!");
817 remove_from_node!(chan.one_to_two.src_node_id);
818 remove_from_node!(chan.two_to_one.src_node_id);
821 /// Gets a route from us to the given target node.
823 /// Extra routing hops between known nodes and the target will be used if they are included in
826 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
827 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
828 /// (this Router's) view of our local channels will be ignored, and only those in first_hops
831 /// Panics if first_hops contains channels without short_channel_ids
832 /// (ChannelManager::list_usable_channels will never include such channels).
834 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
835 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
836 /// *is* checked as they may change based on the receiving node.
837 pub fn get_route(&self, target: &PublicKey, first_hops: Option<&[channelmanager::ChannelDetails]>, last_hops: &[RouteHint], final_value_msat: u64, final_cltv: u32) -> Result<Route, LightningError> {
838 // TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
839 // uptime/success in using a node in the past.
840 let network = self.network_map.read().unwrap();
842 if *target == network.our_node_id {
843 return Err(LightningError{err: "Cannot generate a route to ourselves", action: ErrorAction::IgnoreError});
846 if final_value_msat > 21_000_000 * 1_0000_0000 * 1000 {
847 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis", action: ErrorAction::IgnoreError});
850 // We do a dest-to-source Dijkstra's sorting by each node's distance from the destination
851 // plus the minimum per-HTLC fee to get from it to another node (aka "shitty A*").
852 // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
853 // to use as the A* heuristic beyond just the cost to get one node further than the current
856 let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
857 src_node_id: network.our_node_id.clone(),
858 cltv_expiry_delta: 0,
859 htlc_minimum_msat: 0,
861 fee_proportional_millionths: 0,
864 let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
865 let mut dist = HashMap::with_capacity(network.nodes.len());
867 let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
868 if let Some(hops) = first_hops {
870 let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
871 if chan.remote_network_id == *target {
873 hops: vec![RouteHop {
874 pubkey: chan.remote_network_id,
875 node_features: NodeFeatures::with_known_relevant_init_flags(&chan.counterparty_features),
877 channel_features: ChannelFeatures::with_known_relevant_init_flags(&chan.counterparty_features),
878 fee_msat: final_value_msat,
879 cltv_expiry_delta: final_cltv,
883 first_hop_targets.insert(chan.remote_network_id, (short_channel_id, chan.counterparty_features.clone()));
885 if first_hop_targets.is_empty() {
886 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us", action: ErrorAction::IgnoreError});
890 macro_rules! add_entry {
891 // Adds entry which goes from the node pointed to by $directional_info to
892 // $dest_node_id over the channel with id $chan_id with fees described in
893 // $directional_info.
894 ( $chan_id: expr, $dest_node_id: expr, $directional_info: expr, $chan_features: expr, $starting_fee_msat: expr ) => {
895 //TODO: Explore simply adding fee to hit htlc_minimum_msat
896 if $starting_fee_msat as u64 + final_value_msat >= $directional_info.htlc_minimum_msat {
897 let proportional_fee_millions = ($starting_fee_msat + final_value_msat).checked_mul($directional_info.fee_proportional_millionths as u64);
898 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
899 ($directional_info.fee_base_msat as u64).checked_add(part / 1000000) })
901 let mut total_fee = $starting_fee_msat as u64;
902 let hm_entry = dist.entry(&$directional_info.src_node_id);
903 let old_entry = hm_entry.or_insert_with(|| {
904 let node = network.nodes.get(&$directional_info.src_node_id).unwrap();
906 node.lowest_inbound_channel_fee_base_msat,
907 node.lowest_inbound_channel_fee_proportional_millionths,
909 pubkey: $dest_node_id.clone(),
910 node_features: NodeFeatures::empty(),
912 channel_features: $chan_features.clone(),
914 cltv_expiry_delta: 0,
917 if $directional_info.src_node_id != network.our_node_id {
918 // Ignore new_fee for channel-from-us as we assume all channels-from-us
919 // will have the same effective-fee
920 total_fee += new_fee;
921 if let Some(fee_inc) = final_value_msat.checked_add(total_fee).and_then(|inc| { (old_entry.2 as u64).checked_mul(inc) }) {
922 total_fee += fee_inc / 1000000 + (old_entry.1 as u64);
924 // max_value means we'll always fail the old_entry.0 > total_fee check
925 total_fee = u64::max_value();
928 let new_graph_node = RouteGraphNode {
929 pubkey: $directional_info.src_node_id,
930 lowest_fee_to_peer_through_node: total_fee,
931 lowest_fee_to_node: $starting_fee_msat as u64 + new_fee,
933 if old_entry.0 > total_fee {
934 targets.push(new_graph_node);
935 old_entry.0 = total_fee;
936 old_entry.3 = RouteHop {
937 pubkey: $dest_node_id.clone(),
938 node_features: NodeFeatures::empty(),
939 short_channel_id: $chan_id.clone(),
940 channel_features: $chan_features.clone(),
941 fee_msat: new_fee, // This field is ignored on the last-hop anyway
942 cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
950 macro_rules! add_entries_to_cheapest_to_target_node {
951 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr ) => {
952 if first_hops.is_some() {
953 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&$node_id) {
954 add_entry!(first_hop, $node_id, dummy_directional_info, ChannelFeatures::with_known_relevant_init_flags(&features), $fee_to_target_msat);
958 if !$node.features.requires_unknown_bits() {
959 for chan_id in $node.channels.iter() {
960 let chan = network.channels.get(chan_id).unwrap();
961 if !chan.features.requires_unknown_bits() {
962 if chan.one_to_two.src_node_id == *$node_id {
963 // ie $node is one, ie next hop in A* is two, via the two_to_one channel
964 if first_hops.is_none() || chan.two_to_one.src_node_id != network.our_node_id {
965 if chan.two_to_one.enabled {
966 add_entry!(chan_id, chan.one_to_two.src_node_id, chan.two_to_one, chan.features, $fee_to_target_msat);
970 if first_hops.is_none() || chan.one_to_two.src_node_id != network.our_node_id {
971 if chan.one_to_two.enabled {
972 add_entry!(chan_id, chan.two_to_one.src_node_id, chan.one_to_two, chan.features, $fee_to_target_msat);
982 match network.nodes.get(target) {
985 add_entries_to_cheapest_to_target_node!(node, target, 0);
989 for hop in last_hops.iter() {
990 if first_hops.is_none() || hop.src_node_id != network.our_node_id { // first_hop overrules last_hops
991 if network.nodes.get(&hop.src_node_id).is_some() {
992 if first_hops.is_some() {
993 if let Some(&(ref first_hop, ref features)) = first_hop_targets.get(&hop.src_node_id) {
994 // Currently there are no channel-context features defined, so we are a
995 // bit lazy here. In the future, we should pull them out via our
996 // ChannelManager, but there's no reason to waste the space until we
998 add_entry!(first_hop, hop.src_node_id, dummy_directional_info, ChannelFeatures::with_known_relevant_init_flags(&features), 0);
1001 // BOLT 11 doesn't allow inclusion of features for the last hop hints, which
1002 // really sucks, cause we're gonna need that eventually.
1003 add_entry!(hop.short_channel_id, target, hop, ChannelFeatures::empty(), 0);
1008 while let Some(RouteGraphNode { pubkey, lowest_fee_to_node, .. }) = targets.pop() {
1009 if pubkey == network.our_node_id {
1010 let mut res = vec!(dist.remove(&network.our_node_id).unwrap().3);
1012 if let Some(&(_, ref features)) = first_hop_targets.get(&res.last().unwrap().pubkey) {
1013 res.last_mut().unwrap().node_features = NodeFeatures::with_known_relevant_init_flags(&features);
1014 } else if let Some(node) = network.nodes.get(&res.last().unwrap().pubkey) {
1015 res.last_mut().unwrap().node_features = node.features.clone();
1017 // We should be able to fill in features for everything except the last
1018 // hop, if the last hop was provided via a BOLT 11 invoice (though we
1019 // should be able to extend it further as BOLT 11 does have feature
1020 // flags for the last hop node itself).
1021 assert!(res.last().unwrap().pubkey == *target);
1023 if res.last().unwrap().pubkey == *target {
1027 let new_entry = match dist.remove(&res.last().unwrap().pubkey) {
1029 None => return Err(LightningError{err: "Failed to find a non-fee-overflowing path to the given destination", action: ErrorAction::IgnoreError}),
1031 res.last_mut().unwrap().fee_msat = new_entry.fee_msat;
1032 res.last_mut().unwrap().cltv_expiry_delta = new_entry.cltv_expiry_delta;
1033 res.push(new_entry);
1035 res.last_mut().unwrap().fee_msat = final_value_msat;
1036 res.last_mut().unwrap().cltv_expiry_delta = final_cltv;
1037 let route = Route { hops: res };
1038 log_trace!(self, "Got route: {}", log_route!(route));
1042 match network.nodes.get(&pubkey) {
1045 add_entries_to_cheapest_to_target_node!(node, &pubkey, lowest_fee_to_node);
1050 Err(LightningError{err: "Failed to find a path to the given destination", action: ErrorAction::IgnoreError})
1056 use chain::chaininterface;
1057 use ln::channelmanager;
1058 use ln::router::{Router,NodeInfo,NetworkMap,ChannelInfo,DirectionalChannelInfo,RouteHint};
1059 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
1060 use ln::msgs::{ErrorAction, LightningError, RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
1061 UnsignedChannelAnnouncement, ChannelAnnouncement};
1062 use util::test_utils;
1063 use util::test_utils::TestVecWriter;
1064 use util::logger::Logger;
1065 use util::ser::{Writeable, Readable};
1067 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
1068 use bitcoin_hashes::Hash;
1069 use bitcoin::network::constants::Network;
1070 use bitcoin::blockdata::constants::genesis_block;
1071 use bitcoin::util::hash::BitcoinHash;
1075 use secp256k1::key::{PublicKey,SecretKey};
1077 use secp256k1::Secp256k1;
1081 fn create_router() -> (Secp256k1<All>, PublicKey, Router) {
1082 let secp_ctx = Secp256k1::new();
1083 let our_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap());
1084 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1085 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
1086 let router = Router::new(our_id, chain_monitor, Arc::clone(&logger));
1087 (secp_ctx, our_id, router)
1092 let (secp_ctx, our_id, router) = create_router();
1094 // Build network from our_id to node8:
1096 // -1(1)2- node1 -1(3)2-
1098 // our_id -1(12)2- node8 -1(13)2--- node3
1100 // -1(2)2- node2 -1(4)2-
1103 // chan1 1-to-2: disabled
1104 // chan1 2-to-1: enabled, 0 fee
1106 // chan2 1-to-2: enabled, ignored fee
1107 // chan2 2-to-1: enabled, 0 fee
1109 // chan3 1-to-2: enabled, 0 fee
1110 // chan3 2-to-1: enabled, 100 msat fee
1112 // chan4 1-to-2: enabled, 100% fee
1113 // chan4 2-to-1: enabled, 0 fee
1115 // chan12 1-to-2: enabled, ignored fee
1116 // chan12 2-to-1: enabled, 0 fee
1118 // chan13 1-to-2: enabled, 200% fee
1119 // chan13 2-to-1: enabled, 0 fee
1122 // -1(5)2- node4 -1(8)2--
1126 // node3--1(6)2- node5 -1(9)2--- node7 (not in global route map)
1128 // -1(7)2- node6 -1(10)2-
1130 // chan5 1-to-2: enabled, 100 msat fee
1131 // chan5 2-to-1: enabled, 0 fee
1133 // chan6 1-to-2: enabled, 0 fee
1134 // chan6 2-to-1: enabled, 0 fee
1136 // chan7 1-to-2: enabled, 100% fee
1137 // chan7 2-to-1: enabled, 0 fee
1139 // chan8 1-to-2: enabled, variable fee (0 then 1000 msat)
1140 // chan8 2-to-1: enabled, 0 fee
1142 // chan9 1-to-2: enabled, 1001 msat fee
1143 // chan9 2-to-1: enabled, 0 fee
1145 // chan10 1-to-2: enabled, 0 fee
1146 // chan10 2-to-1: enabled, 0 fee
1148 // chan11 1-to-2: enabled, 0 fee
1149 // chan11 2-to-1: enabled, 0 fee
1151 let node1 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1152 let node2 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()[..]).unwrap());
1153 let node3 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()[..]).unwrap());
1154 let node4 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()[..]).unwrap());
1155 let node5 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0606060606060606060606060606060606060606060606060606060606060606").unwrap()[..]).unwrap());
1156 let node6 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0707070707070707070707070707070707070707070707070707070707070707").unwrap()[..]).unwrap());
1157 let node7 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0808080808080808080808080808080808080808080808080808080808080808").unwrap()[..]).unwrap());
1158 let node8 = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0909090909090909090909090909090909090909090909090909090909090909").unwrap()[..]).unwrap());
1160 let zero_hash = Sha256dHash::hash(&[0; 32]);
1162 macro_rules! id_to_feature_flags {
1163 // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
1164 // test for it later.
1166 let idx = ($id - 1) * 2 + 1;
1168 vec![1 << (idx - 8*3), 0, 0, 0]
1169 } else if idx > 8*2 {
1170 vec![1 << (idx - 8*2), 0, 0]
1171 } else if idx > 8*1 {
1172 vec![1 << (idx - 8*1), 0]
1180 let mut network = router.network_map.write().unwrap();
1182 network.nodes.insert(node1.clone(), NodeInfo {
1183 channels: vec!(NetworkMap::get_key(1, zero_hash.clone()), NetworkMap::get_key(3, zero_hash.clone())),
1184 lowest_inbound_channel_fee_base_msat: 100,
1185 lowest_inbound_channel_fee_proportional_millionths: 0,
1186 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(1)),
1187 last_update: Some(1),
1190 addresses: Vec::new(),
1191 announcement_message: None,
1193 network.channels.insert(NetworkMap::get_key(1, zero_hash.clone()), ChannelInfo {
1194 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(1)),
1195 one_to_two: DirectionalChannelInfo {
1196 src_node_id: our_id.clone(),
1199 cltv_expiry_delta: u16::max_value(), // This value should be ignored
1200 htlc_minimum_msat: 0,
1201 fee_base_msat: u32::max_value(), // This value should be ignored
1202 fee_proportional_millionths: u32::max_value(), // This value should be ignored
1203 last_update_message: None,
1204 }, two_to_one: DirectionalChannelInfo {
1205 src_node_id: node1.clone(),
1208 cltv_expiry_delta: 0,
1209 htlc_minimum_msat: 0,
1211 fee_proportional_millionths: 0,
1212 last_update_message: None,
1214 announcement_message: None,
1216 network.nodes.insert(node2.clone(), NodeInfo {
1217 channels: vec!(NetworkMap::get_key(2, zero_hash.clone()), NetworkMap::get_key(4, zero_hash.clone())),
1218 lowest_inbound_channel_fee_base_msat: 0,
1219 lowest_inbound_channel_fee_proportional_millionths: 0,
1220 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(2)),
1221 last_update: Some(1),
1224 addresses: Vec::new(),
1225 announcement_message: None,
1227 network.channels.insert(NetworkMap::get_key(2, zero_hash.clone()), ChannelInfo {
1228 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(2)),
1229 one_to_two: DirectionalChannelInfo {
1230 src_node_id: our_id.clone(),
1233 cltv_expiry_delta: u16::max_value(), // This value should be ignored
1234 htlc_minimum_msat: 0,
1235 fee_base_msat: u32::max_value(), // This value should be ignored
1236 fee_proportional_millionths: u32::max_value(), // This value should be ignored
1237 last_update_message: None,
1238 }, two_to_one: DirectionalChannelInfo {
1239 src_node_id: node2.clone(),
1242 cltv_expiry_delta: 0,
1243 htlc_minimum_msat: 0,
1245 fee_proportional_millionths: 0,
1246 last_update_message: None,
1248 announcement_message: None,
1250 network.nodes.insert(node8.clone(), NodeInfo {
1251 channels: vec!(NetworkMap::get_key(12, zero_hash.clone()), NetworkMap::get_key(13, zero_hash.clone())),
1252 lowest_inbound_channel_fee_base_msat: 0,
1253 lowest_inbound_channel_fee_proportional_millionths: 0,
1254 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(8)),
1255 last_update: Some(1),
1258 addresses: Vec::new(),
1259 announcement_message: None,
1261 network.channels.insert(NetworkMap::get_key(12, zero_hash.clone()), ChannelInfo {
1262 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(12)),
1263 one_to_two: DirectionalChannelInfo {
1264 src_node_id: our_id.clone(),
1267 cltv_expiry_delta: u16::max_value(), // This value should be ignored
1268 htlc_minimum_msat: 0,
1269 fee_base_msat: u32::max_value(), // This value should be ignored
1270 fee_proportional_millionths: u32::max_value(), // This value should be ignored
1271 last_update_message: None,
1272 }, two_to_one: DirectionalChannelInfo {
1273 src_node_id: node8.clone(),
1276 cltv_expiry_delta: 0,
1277 htlc_minimum_msat: 0,
1279 fee_proportional_millionths: 0,
1280 last_update_message: None,
1282 announcement_message: None,
1284 network.nodes.insert(node3.clone(), NodeInfo {
1286 NetworkMap::get_key(3, zero_hash.clone()),
1287 NetworkMap::get_key(4, zero_hash.clone()),
1288 NetworkMap::get_key(13, zero_hash.clone()),
1289 NetworkMap::get_key(5, zero_hash.clone()),
1290 NetworkMap::get_key(6, zero_hash.clone()),
1291 NetworkMap::get_key(7, zero_hash.clone())),
1292 lowest_inbound_channel_fee_base_msat: 0,
1293 lowest_inbound_channel_fee_proportional_millionths: 0,
1294 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(3)),
1295 last_update: Some(1),
1298 addresses: Vec::new(),
1299 announcement_message: None,
1301 network.channels.insert(NetworkMap::get_key(3, zero_hash.clone()), ChannelInfo {
1302 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(3)),
1303 one_to_two: DirectionalChannelInfo {
1304 src_node_id: node1.clone(),
1307 cltv_expiry_delta: (3 << 8) | 1,
1308 htlc_minimum_msat: 0,
1310 fee_proportional_millionths: 0,
1311 last_update_message: None,
1312 }, two_to_one: DirectionalChannelInfo {
1313 src_node_id: node3.clone(),
1316 cltv_expiry_delta: (3 << 8) | 2,
1317 htlc_minimum_msat: 0,
1319 fee_proportional_millionths: 0,
1320 last_update_message: None,
1322 announcement_message: None,
1324 network.channels.insert(NetworkMap::get_key(4, zero_hash.clone()), ChannelInfo {
1325 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(4)),
1326 one_to_two: DirectionalChannelInfo {
1327 src_node_id: node2.clone(),
1330 cltv_expiry_delta: (4 << 8) | 1,
1331 htlc_minimum_msat: 0,
1333 fee_proportional_millionths: 1000000,
1334 last_update_message: None,
1335 }, two_to_one: DirectionalChannelInfo {
1336 src_node_id: node3.clone(),
1339 cltv_expiry_delta: (4 << 8) | 2,
1340 htlc_minimum_msat: 0,
1342 fee_proportional_millionths: 0,
1343 last_update_message: None,
1345 announcement_message: None,
1347 network.channels.insert(NetworkMap::get_key(13, zero_hash.clone()), ChannelInfo {
1348 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(13)),
1349 one_to_two: DirectionalChannelInfo {
1350 src_node_id: node8.clone(),
1353 cltv_expiry_delta: (13 << 8) | 1,
1354 htlc_minimum_msat: 0,
1356 fee_proportional_millionths: 2000000,
1357 last_update_message: None,
1358 }, two_to_one: DirectionalChannelInfo {
1359 src_node_id: node3.clone(),
1362 cltv_expiry_delta: (13 << 8) | 2,
1363 htlc_minimum_msat: 0,
1365 fee_proportional_millionths: 0,
1366 last_update_message: None,
1368 announcement_message: None,
1370 network.nodes.insert(node4.clone(), NodeInfo {
1371 channels: vec!(NetworkMap::get_key(5, zero_hash.clone()), NetworkMap::get_key(11, zero_hash.clone())),
1372 lowest_inbound_channel_fee_base_msat: 0,
1373 lowest_inbound_channel_fee_proportional_millionths: 0,
1374 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(4)),
1375 last_update: Some(1),
1378 addresses: Vec::new(),
1379 announcement_message: None,
1381 network.channels.insert(NetworkMap::get_key(5, zero_hash.clone()), ChannelInfo {
1382 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(5)),
1383 one_to_two: DirectionalChannelInfo {
1384 src_node_id: node3.clone(),
1387 cltv_expiry_delta: (5 << 8) | 1,
1388 htlc_minimum_msat: 0,
1390 fee_proportional_millionths: 0,
1391 last_update_message: None,
1392 }, two_to_one: DirectionalChannelInfo {
1393 src_node_id: node4.clone(),
1396 cltv_expiry_delta: (5 << 8) | 2,
1397 htlc_minimum_msat: 0,
1399 fee_proportional_millionths: 0,
1400 last_update_message: None,
1402 announcement_message: None,
1404 network.nodes.insert(node5.clone(), NodeInfo {
1405 channels: vec!(NetworkMap::get_key(6, zero_hash.clone()), NetworkMap::get_key(11, zero_hash.clone())),
1406 lowest_inbound_channel_fee_base_msat: 0,
1407 lowest_inbound_channel_fee_proportional_millionths: 0,
1408 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(5)),
1409 last_update: Some(1),
1412 addresses: Vec::new(),
1413 announcement_message: None,
1415 network.channels.insert(NetworkMap::get_key(6, zero_hash.clone()), ChannelInfo {
1416 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(6)),
1417 one_to_two: DirectionalChannelInfo {
1418 src_node_id: node3.clone(),
1421 cltv_expiry_delta: (6 << 8) | 1,
1422 htlc_minimum_msat: 0,
1424 fee_proportional_millionths: 0,
1425 last_update_message: None,
1426 }, two_to_one: DirectionalChannelInfo {
1427 src_node_id: node5.clone(),
1430 cltv_expiry_delta: (6 << 8) | 2,
1431 htlc_minimum_msat: 0,
1433 fee_proportional_millionths: 0,
1434 last_update_message: None,
1436 announcement_message: None,
1438 network.channels.insert(NetworkMap::get_key(11, zero_hash.clone()), ChannelInfo {
1439 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(11)),
1440 one_to_two: DirectionalChannelInfo {
1441 src_node_id: node5.clone(),
1444 cltv_expiry_delta: (11 << 8) | 1,
1445 htlc_minimum_msat: 0,
1447 fee_proportional_millionths: 0,
1448 last_update_message: None,
1449 }, two_to_one: DirectionalChannelInfo {
1450 src_node_id: node4.clone(),
1453 cltv_expiry_delta: (11 << 8) | 2,
1454 htlc_minimum_msat: 0,
1456 fee_proportional_millionths: 0,
1457 last_update_message: None,
1459 announcement_message: None,
1461 network.nodes.insert(node6.clone(), NodeInfo {
1462 channels: vec!(NetworkMap::get_key(7, zero_hash.clone())),
1463 lowest_inbound_channel_fee_base_msat: 0,
1464 lowest_inbound_channel_fee_proportional_millionths: 0,
1465 features: NodeFeatures::from_le_bytes(id_to_feature_flags!(6)),
1466 last_update: Some(1),
1469 addresses: Vec::new(),
1470 announcement_message: None,
1472 network.channels.insert(NetworkMap::get_key(7, zero_hash.clone()), ChannelInfo {
1473 features: ChannelFeatures::from_le_bytes(id_to_feature_flags!(7)),
1474 one_to_two: DirectionalChannelInfo {
1475 src_node_id: node3.clone(),
1478 cltv_expiry_delta: (7 << 8) | 1,
1479 htlc_minimum_msat: 0,
1481 fee_proportional_millionths: 1000000,
1482 last_update_message: None,
1483 }, two_to_one: DirectionalChannelInfo {
1484 src_node_id: node6.clone(),
1487 cltv_expiry_delta: (7 << 8) | 2,
1488 htlc_minimum_msat: 0,
1490 fee_proportional_millionths: 0,
1491 last_update_message: None,
1493 announcement_message: None,
1497 { // Simple route to 3 via 2
1498 let route = router.get_route(&node3, None, &Vec::new(), 100, 42).unwrap();
1499 assert_eq!(route.hops.len(), 2);
1501 assert_eq!(route.hops[0].pubkey, node2);
1502 assert_eq!(route.hops[0].short_channel_id, 2);
1503 assert_eq!(route.hops[0].fee_msat, 100);
1504 assert_eq!(route.hops[0].cltv_expiry_delta, (4 << 8) | 1);
1505 assert_eq!(route.hops[0].node_features.le_flags(), &id_to_feature_flags!(2));
1506 assert_eq!(route.hops[0].channel_features.le_flags(), &id_to_feature_flags!(2));
1508 assert_eq!(route.hops[1].pubkey, node3);
1509 assert_eq!(route.hops[1].short_channel_id, 4);
1510 assert_eq!(route.hops[1].fee_msat, 100);
1511 assert_eq!(route.hops[1].cltv_expiry_delta, 42);
1512 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1513 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(4));
1516 { // Disable channels 4 and 12 by requiring unknown feature bits
1517 let mut network = router.network_map.write().unwrap();
1518 network.channels.get_mut(&NetworkMap::get_key(4, zero_hash.clone())).unwrap().features.set_require_unknown_bits();
1519 network.channels.get_mut(&NetworkMap::get_key(12, zero_hash.clone())).unwrap().features.set_require_unknown_bits();
1522 { // If all the channels require some features we don't understand, route should fail
1523 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = router.get_route(&node3, None, &Vec::new(), 100, 42) {
1524 assert_eq!(err, "Failed to find a path to the given destination");
1525 } else { panic!(); }
1528 { // If we specify a channel to node8, that overrides our local channel view and that gets used
1529 let our_chans = vec![channelmanager::ChannelDetails {
1530 channel_id: [0; 32],
1531 short_channel_id: Some(42),
1532 remote_network_id: node8.clone(),
1533 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1534 channel_value_satoshis: 0,
1536 outbound_capacity_msat: 0,
1537 inbound_capacity_msat: 0,
1540 let route = router.get_route(&node3, Some(&our_chans), &Vec::new(), 100, 42).unwrap();
1541 assert_eq!(route.hops.len(), 2);
1543 assert_eq!(route.hops[0].pubkey, node8);
1544 assert_eq!(route.hops[0].short_channel_id, 42);
1545 assert_eq!(route.hops[0].fee_msat, 200);
1546 assert_eq!(route.hops[0].cltv_expiry_delta, (13 << 8) | 1);
1547 assert_eq!(route.hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
1548 assert_eq!(route.hops[0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1550 assert_eq!(route.hops[1].pubkey, node3);
1551 assert_eq!(route.hops[1].short_channel_id, 13);
1552 assert_eq!(route.hops[1].fee_msat, 100);
1553 assert_eq!(route.hops[1].cltv_expiry_delta, 42);
1554 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1555 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(13));
1558 { // Re-enable channels 4 and 12 by wiping the unknown feature bits
1559 let mut network = router.network_map.write().unwrap();
1560 network.channels.get_mut(&NetworkMap::get_key(4, zero_hash.clone())).unwrap().features.clear_require_unknown_bits();
1561 network.channels.get_mut(&NetworkMap::get_key(12, zero_hash.clone())).unwrap().features.clear_require_unknown_bits();
1564 { // Disable nodes 1, 2, and 8 by requiring unknown feature bits
1565 let mut network = router.network_map.write().unwrap();
1566 network.nodes.get_mut(&node1).unwrap().features.set_require_unknown_bits();
1567 network.nodes.get_mut(&node2).unwrap().features.set_require_unknown_bits();
1568 network.nodes.get_mut(&node8).unwrap().features.set_require_unknown_bits();
1571 { // If all nodes require some features we don't understand, route should fail
1572 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = router.get_route(&node3, None, &Vec::new(), 100, 42) {
1573 assert_eq!(err, "Failed to find a path to the given destination");
1574 } else { panic!(); }
1577 { // If we specify a channel to node8, that overrides our local channel view and that gets used
1578 let our_chans = vec![channelmanager::ChannelDetails {
1579 channel_id: [0; 32],
1580 short_channel_id: Some(42),
1581 remote_network_id: node8.clone(),
1582 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1583 channel_value_satoshis: 0,
1585 outbound_capacity_msat: 0,
1586 inbound_capacity_msat: 0,
1589 let route = router.get_route(&node3, Some(&our_chans), &Vec::new(), 100, 42).unwrap();
1590 assert_eq!(route.hops.len(), 2);
1592 assert_eq!(route.hops[0].pubkey, node8);
1593 assert_eq!(route.hops[0].short_channel_id, 42);
1594 assert_eq!(route.hops[0].fee_msat, 200);
1595 assert_eq!(route.hops[0].cltv_expiry_delta, (13 << 8) | 1);
1596 assert_eq!(route.hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
1597 assert_eq!(route.hops[0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1599 assert_eq!(route.hops[1].pubkey, node3);
1600 assert_eq!(route.hops[1].short_channel_id, 13);
1601 assert_eq!(route.hops[1].fee_msat, 100);
1602 assert_eq!(route.hops[1].cltv_expiry_delta, 42);
1603 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1604 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(13));
1607 { // Re-enable nodes 1, 2, and 8
1608 let mut network = router.network_map.write().unwrap();
1609 network.nodes.get_mut(&node1).unwrap().features.clear_require_unknown_bits();
1610 network.nodes.get_mut(&node2).unwrap().features.clear_require_unknown_bits();
1611 network.nodes.get_mut(&node8).unwrap().features.clear_require_unknown_bits();
1614 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
1615 // naively) assume that the user checked the feature bits on the invoice, which override
1616 // the node_announcement.
1618 { // Route to 1 via 2 and 3 because our channel to 1 is disabled
1619 let route = router.get_route(&node1, None, &Vec::new(), 100, 42).unwrap();
1620 assert_eq!(route.hops.len(), 3);
1622 assert_eq!(route.hops[0].pubkey, node2);
1623 assert_eq!(route.hops[0].short_channel_id, 2);
1624 assert_eq!(route.hops[0].fee_msat, 200);
1625 assert_eq!(route.hops[0].cltv_expiry_delta, (4 << 8) | 1);
1626 assert_eq!(route.hops[0].node_features.le_flags(), &id_to_feature_flags!(2));
1627 assert_eq!(route.hops[0].channel_features.le_flags(), &id_to_feature_flags!(2));
1629 assert_eq!(route.hops[1].pubkey, node3);
1630 assert_eq!(route.hops[1].short_channel_id, 4);
1631 assert_eq!(route.hops[1].fee_msat, 100);
1632 assert_eq!(route.hops[1].cltv_expiry_delta, (3 << 8) | 2);
1633 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1634 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(4));
1636 assert_eq!(route.hops[2].pubkey, node1);
1637 assert_eq!(route.hops[2].short_channel_id, 3);
1638 assert_eq!(route.hops[2].fee_msat, 100);
1639 assert_eq!(route.hops[2].cltv_expiry_delta, 42);
1640 assert_eq!(route.hops[2].node_features.le_flags(), &id_to_feature_flags!(1));
1641 assert_eq!(route.hops[2].channel_features.le_flags(), &id_to_feature_flags!(3));
1644 { // If we specify a channel to node8, that overrides our local channel view and that gets used
1645 let our_chans = vec![channelmanager::ChannelDetails {
1646 channel_id: [0; 32],
1647 short_channel_id: Some(42),
1648 remote_network_id: node8.clone(),
1649 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1650 channel_value_satoshis: 0,
1652 outbound_capacity_msat: 0,
1653 inbound_capacity_msat: 0,
1656 let route = router.get_route(&node3, Some(&our_chans), &Vec::new(), 100, 42).unwrap();
1657 assert_eq!(route.hops.len(), 2);
1659 assert_eq!(route.hops[0].pubkey, node8);
1660 assert_eq!(route.hops[0].short_channel_id, 42);
1661 assert_eq!(route.hops[0].fee_msat, 200);
1662 assert_eq!(route.hops[0].cltv_expiry_delta, (13 << 8) | 1);
1663 assert_eq!(route.hops[0].node_features.le_flags(), &vec![0b11]);
1664 assert_eq!(route.hops[0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1666 assert_eq!(route.hops[1].pubkey, node3);
1667 assert_eq!(route.hops[1].short_channel_id, 13);
1668 assert_eq!(route.hops[1].fee_msat, 100);
1669 assert_eq!(route.hops[1].cltv_expiry_delta, 42);
1670 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1671 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(13));
1674 let mut last_hops = vec!(RouteHint {
1675 src_node_id: node4.clone(),
1676 short_channel_id: 8,
1678 fee_proportional_millionths: 0,
1679 cltv_expiry_delta: (8 << 8) | 1,
1680 htlc_minimum_msat: 0,
1682 src_node_id: node5.clone(),
1683 short_channel_id: 9,
1684 fee_base_msat: 1001,
1685 fee_proportional_millionths: 0,
1686 cltv_expiry_delta: (9 << 8) | 1,
1687 htlc_minimum_msat: 0,
1689 src_node_id: node6.clone(),
1690 short_channel_id: 10,
1692 fee_proportional_millionths: 0,
1693 cltv_expiry_delta: (10 << 8) | 1,
1694 htlc_minimum_msat: 0,
1697 { // Simple test across 2, 3, 5, and 4 via a last_hop channel
1698 let route = router.get_route(&node7, None, &last_hops, 100, 42).unwrap();
1699 assert_eq!(route.hops.len(), 5);
1701 assert_eq!(route.hops[0].pubkey, node2);
1702 assert_eq!(route.hops[0].short_channel_id, 2);
1703 assert_eq!(route.hops[0].fee_msat, 100);
1704 assert_eq!(route.hops[0].cltv_expiry_delta, (4 << 8) | 1);
1705 assert_eq!(route.hops[0].node_features.le_flags(), &id_to_feature_flags!(2));
1706 assert_eq!(route.hops[0].channel_features.le_flags(), &id_to_feature_flags!(2));
1708 assert_eq!(route.hops[1].pubkey, node3);
1709 assert_eq!(route.hops[1].short_channel_id, 4);
1710 assert_eq!(route.hops[1].fee_msat, 0);
1711 assert_eq!(route.hops[1].cltv_expiry_delta, (6 << 8) | 1);
1712 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1713 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(4));
1715 assert_eq!(route.hops[2].pubkey, node5);
1716 assert_eq!(route.hops[2].short_channel_id, 6);
1717 assert_eq!(route.hops[2].fee_msat, 0);
1718 assert_eq!(route.hops[2].cltv_expiry_delta, (11 << 8) | 1);
1719 assert_eq!(route.hops[2].node_features.le_flags(), &id_to_feature_flags!(5));
1720 assert_eq!(route.hops[2].channel_features.le_flags(), &id_to_feature_flags!(6));
1722 assert_eq!(route.hops[3].pubkey, node4);
1723 assert_eq!(route.hops[3].short_channel_id, 11);
1724 assert_eq!(route.hops[3].fee_msat, 0);
1725 assert_eq!(route.hops[3].cltv_expiry_delta, (8 << 8) | 1);
1726 // If we have a peer in the node map, we'll use their features here since we don't have
1727 // a way of figuring out their features from the invoice:
1728 assert_eq!(route.hops[3].node_features.le_flags(), &id_to_feature_flags!(4));
1729 assert_eq!(route.hops[3].channel_features.le_flags(), &id_to_feature_flags!(11));
1731 assert_eq!(route.hops[4].pubkey, node7);
1732 assert_eq!(route.hops[4].short_channel_id, 8);
1733 assert_eq!(route.hops[4].fee_msat, 100);
1734 assert_eq!(route.hops[4].cltv_expiry_delta, 42);
1735 assert_eq!(route.hops[4].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1736 assert_eq!(route.hops[4].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1739 { // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
1740 let our_chans = vec![channelmanager::ChannelDetails {
1741 channel_id: [0; 32],
1742 short_channel_id: Some(42),
1743 remote_network_id: node4.clone(),
1744 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1745 channel_value_satoshis: 0,
1747 outbound_capacity_msat: 0,
1748 inbound_capacity_msat: 0,
1751 let route = router.get_route(&node7, Some(&our_chans), &last_hops, 100, 42).unwrap();
1752 assert_eq!(route.hops.len(), 2);
1754 assert_eq!(route.hops[0].pubkey, node4);
1755 assert_eq!(route.hops[0].short_channel_id, 42);
1756 assert_eq!(route.hops[0].fee_msat, 0);
1757 assert_eq!(route.hops[0].cltv_expiry_delta, (8 << 8) | 1);
1758 assert_eq!(route.hops[0].node_features.le_flags(), &vec![0b11]);
1759 assert_eq!(route.hops[0].channel_features.le_flags(), &Vec::new()); // No feature flags will meet the relevant-to-channel conversion
1761 assert_eq!(route.hops[1].pubkey, node7);
1762 assert_eq!(route.hops[1].short_channel_id, 8);
1763 assert_eq!(route.hops[1].fee_msat, 100);
1764 assert_eq!(route.hops[1].cltv_expiry_delta, 42);
1765 assert_eq!(route.hops[1].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1766 assert_eq!(route.hops[1].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1769 last_hops[0].fee_base_msat = 1000;
1771 { // Revert to via 6 as the fee on 8 goes up
1772 let route = router.get_route(&node7, None, &last_hops, 100, 42).unwrap();
1773 assert_eq!(route.hops.len(), 4);
1775 assert_eq!(route.hops[0].pubkey, node2);
1776 assert_eq!(route.hops[0].short_channel_id, 2);
1777 assert_eq!(route.hops[0].fee_msat, 200); // fee increased as its % of value transferred across node
1778 assert_eq!(route.hops[0].cltv_expiry_delta, (4 << 8) | 1);
1779 assert_eq!(route.hops[0].node_features.le_flags(), &id_to_feature_flags!(2));
1780 assert_eq!(route.hops[0].channel_features.le_flags(), &id_to_feature_flags!(2));
1782 assert_eq!(route.hops[1].pubkey, node3);
1783 assert_eq!(route.hops[1].short_channel_id, 4);
1784 assert_eq!(route.hops[1].fee_msat, 100);
1785 assert_eq!(route.hops[1].cltv_expiry_delta, (7 << 8) | 1);
1786 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1787 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(4));
1789 assert_eq!(route.hops[2].pubkey, node6);
1790 assert_eq!(route.hops[2].short_channel_id, 7);
1791 assert_eq!(route.hops[2].fee_msat, 0);
1792 assert_eq!(route.hops[2].cltv_expiry_delta, (10 << 8) | 1);
1793 // If we have a peer in the node map, we'll use their features here since we don't have
1794 // a way of figuring out their features from the invoice:
1795 assert_eq!(route.hops[2].node_features.le_flags(), &id_to_feature_flags!(6));
1796 assert_eq!(route.hops[2].channel_features.le_flags(), &id_to_feature_flags!(7));
1798 assert_eq!(route.hops[3].pubkey, node7);
1799 assert_eq!(route.hops[3].short_channel_id, 10);
1800 assert_eq!(route.hops[3].fee_msat, 100);
1801 assert_eq!(route.hops[3].cltv_expiry_delta, 42);
1802 assert_eq!(route.hops[3].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1803 assert_eq!(route.hops[3].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1806 { // ...but still use 8 for larger payments as 6 has a variable feerate
1807 let route = router.get_route(&node7, None, &last_hops, 2000, 42).unwrap();
1808 assert_eq!(route.hops.len(), 5);
1810 assert_eq!(route.hops[0].pubkey, node2);
1811 assert_eq!(route.hops[0].short_channel_id, 2);
1812 assert_eq!(route.hops[0].fee_msat, 3000);
1813 assert_eq!(route.hops[0].cltv_expiry_delta, (4 << 8) | 1);
1814 assert_eq!(route.hops[0].node_features.le_flags(), &id_to_feature_flags!(2));
1815 assert_eq!(route.hops[0].channel_features.le_flags(), &id_to_feature_flags!(2));
1817 assert_eq!(route.hops[1].pubkey, node3);
1818 assert_eq!(route.hops[1].short_channel_id, 4);
1819 assert_eq!(route.hops[1].fee_msat, 0);
1820 assert_eq!(route.hops[1].cltv_expiry_delta, (6 << 8) | 1);
1821 assert_eq!(route.hops[1].node_features.le_flags(), &id_to_feature_flags!(3));
1822 assert_eq!(route.hops[1].channel_features.le_flags(), &id_to_feature_flags!(4));
1824 assert_eq!(route.hops[2].pubkey, node5);
1825 assert_eq!(route.hops[2].short_channel_id, 6);
1826 assert_eq!(route.hops[2].fee_msat, 0);
1827 assert_eq!(route.hops[2].cltv_expiry_delta, (11 << 8) | 1);
1828 assert_eq!(route.hops[2].node_features.le_flags(), &id_to_feature_flags!(5));
1829 assert_eq!(route.hops[2].channel_features.le_flags(), &id_to_feature_flags!(6));
1831 assert_eq!(route.hops[3].pubkey, node4);
1832 assert_eq!(route.hops[3].short_channel_id, 11);
1833 assert_eq!(route.hops[3].fee_msat, 1000);
1834 assert_eq!(route.hops[3].cltv_expiry_delta, (8 << 8) | 1);
1835 // If we have a peer in the node map, we'll use their features here since we don't have
1836 // a way of figuring out their features from the invoice:
1837 assert_eq!(route.hops[3].node_features.le_flags(), &id_to_feature_flags!(4));
1838 assert_eq!(route.hops[3].channel_features.le_flags(), &id_to_feature_flags!(11));
1840 assert_eq!(route.hops[4].pubkey, node7);
1841 assert_eq!(route.hops[4].short_channel_id, 8);
1842 assert_eq!(route.hops[4].fee_msat, 2000);
1843 assert_eq!(route.hops[4].cltv_expiry_delta, 42);
1844 assert_eq!(route.hops[4].node_features.le_flags(), &Vec::new()); // We dont pass flags in from invoices yet
1845 assert_eq!(route.hops[4].channel_features.le_flags(), &Vec::new()); // We can't learn any flags from invoices, sadly
1848 { // Test Router serialization/deserialization
1849 let mut w = TestVecWriter(Vec::new());
1850 let network = router.network_map.read().unwrap();
1851 assert!(!network.channels.is_empty());
1852 assert!(!network.nodes.is_empty());
1853 network.write(&mut w).unwrap();
1854 assert!(<NetworkMap>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap() == *network);
1859 fn request_full_sync_finite_times() {
1860 let (secp_ctx, _, router) = create_router();
1861 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1863 assert!(router.should_request_full_sync(&node_id));
1864 assert!(router.should_request_full_sync(&node_id));
1865 assert!(router.should_request_full_sync(&node_id));
1866 assert!(router.should_request_full_sync(&node_id));
1867 assert!(router.should_request_full_sync(&node_id));
1868 assert!(!router.should_request_full_sync(&node_id));
1872 fn handling_node_announcements() {
1873 let (secp_ctx, _, router) = create_router();
1875 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1876 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1877 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1878 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1879 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1880 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1881 let zero_hash = Sha256dHash::hash(&[0; 32]);
1882 let first_announcement_time = 500;
1884 let mut unsigned_announcement = UnsignedNodeAnnouncement {
1885 features: NodeFeatures::supported(),
1886 timestamp: first_announcement_time,
1890 addresses: Vec::new(),
1891 excess_address_data: Vec::new(),
1892 excess_data: Vec::new(),
1894 let mut msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1895 let valid_announcement = NodeAnnouncement {
1896 signature: secp_ctx.sign(&msghash, node_1_privkey),
1897 contents: unsigned_announcement.clone()
1900 match router.handle_node_announcement(&valid_announcement) {
1902 Err(e) => assert_eq!("No existing channels for node_announcement", e.err)
1906 // Announce a channel to add a corresponding node.
1907 let unsigned_announcement = UnsignedChannelAnnouncement {
1908 features: ChannelFeatures::supported(),
1909 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
1910 short_channel_id: 0,
1913 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1914 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1915 excess_data: Vec::new(),
1918 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1919 let valid_announcement = ChannelAnnouncement {
1920 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1921 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1922 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1923 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1924 contents: unsigned_announcement.clone(),
1926 match router.handle_channel_announcement(&valid_announcement) {
1927 Ok(res) => assert!(res),
1932 match router.handle_node_announcement(&valid_announcement) {
1933 Ok(res) => assert!(res),
1937 let fake_msghash = hash_to_message!(&zero_hash);
1938 match router.handle_node_announcement(
1940 signature: secp_ctx.sign(&fake_msghash, node_1_privkey),
1941 contents: unsigned_announcement.clone()
1944 Err(e) => assert_eq!(e.err, "Invalid signature from remote node")
1947 unsigned_announcement.timestamp += 1000;
1948 unsigned_announcement.excess_data.push(1);
1949 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1950 let announcement_with_data = NodeAnnouncement {
1951 signature: secp_ctx.sign(&msghash, node_1_privkey),
1952 contents: unsigned_announcement.clone()
1954 // Return false because contains excess data.
1955 match router.handle_node_announcement(&announcement_with_data) {
1956 Ok(res) => assert!(!res),
1959 unsigned_announcement.excess_data = Vec::new();
1961 // Even though previous announcement was not relayed further, we still accepted it,
1962 // so we now won't accept announcements before the previous one.
1963 unsigned_announcement.timestamp -= 10;
1964 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1965 let outdated_announcement = NodeAnnouncement {
1966 signature: secp_ctx.sign(&msghash, node_1_privkey),
1967 contents: unsigned_announcement.clone()
1969 match router.handle_node_announcement(&outdated_announcement) {
1971 Err(e) => assert_eq!(e.err, "Update older than last processed update")