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 network map tracking logic lives here.
12 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
13 use bitcoin::secp256k1::PublicKey;
14 use bitcoin::secp256k1::Secp256k1;
15 use bitcoin::secp256k1;
17 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
18 use bitcoin::hashes::Hash;
19 use bitcoin::blockdata::script::Builder;
20 use bitcoin::blockdata::transaction::TxOut;
21 use bitcoin::blockdata::opcodes;
22 use bitcoin::hash_types::BlockHash;
26 use ln::features::{ChannelFeatures, NodeFeatures};
27 use ln::msgs::{DecodeError, ErrorAction, Init, LightningError, RoutingMessageHandler, NetAddress, MAX_VALUE_MSAT};
28 use ln::msgs::{ChannelAnnouncement, ChannelUpdate, NodeAnnouncement, GossipTimestampFilter};
29 use ln::msgs::{QueryChannelRange, ReplyChannelRange, QueryShortChannelIds, ReplyShortChannelIdsEnd};
31 use util::ser::{Readable, ReadableArgs, Writeable, Writer, MaybeReadable};
32 use util::logger::{Logger, Level};
33 use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
34 use util::scid_utils::{block_from_scid, scid_from_parts, MAX_SCID_BLOCK};
37 use io_extras::{copy, sink};
39 use alloc::collections::{BTreeMap, btree_map::Entry as BtreeEntry};
41 use sync::{RwLock, RwLockReadGuard};
42 use core::sync::atomic::{AtomicUsize, Ordering};
44 use core::ops::{Bound, Deref};
45 use bitcoin::hashes::hex::ToHex;
47 #[cfg(feature = "std")]
48 use std::time::{SystemTime, UNIX_EPOCH};
50 /// We remove stale channel directional info two weeks after the last update, per BOLT 7's
52 const STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS: u64 = 60 * 60 * 24 * 14;
54 /// The maximum number of extra bytes which we do not understand in a gossip message before we will
55 /// refuse to relay the message.
56 const MAX_EXCESS_BYTES_FOR_RELAY: usize = 1024;
58 /// Maximum number of short_channel_ids that will be encoded in one gossip reply message.
59 /// This value ensures a reply fits within the 65k payload limit and is consistent with other implementations.
60 const MAX_SCIDS_PER_REPLY: usize = 8000;
62 /// Represents the compressed public key of a node
63 #[derive(Clone, Copy)]
64 pub struct NodeId([u8; PUBLIC_KEY_SIZE]);
67 /// Create a new NodeId from a public key
68 pub fn from_pubkey(pubkey: &PublicKey) -> Self {
69 NodeId(pubkey.serialize())
72 /// Get the public key slice from this NodeId
73 pub fn as_slice(&self) -> &[u8] {
78 impl fmt::Debug for NodeId {
79 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
80 write!(f, "NodeId({})", log_bytes!(self.0))
84 impl core::hash::Hash for NodeId {
85 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
92 impl PartialEq for NodeId {
93 fn eq(&self, other: &Self) -> bool {
94 self.0[..] == other.0[..]
98 impl cmp::PartialOrd for NodeId {
99 fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
100 Some(self.cmp(other))
104 impl Ord for NodeId {
105 fn cmp(&self, other: &Self) -> cmp::Ordering {
106 self.0[..].cmp(&other.0[..])
110 impl Writeable for NodeId {
111 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
112 writer.write_all(&self.0)?;
117 impl Readable for NodeId {
118 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
119 let mut buf = [0; PUBLIC_KEY_SIZE];
120 reader.read_exact(&mut buf)?;
125 /// Represents the network as nodes and channels between them
126 pub struct NetworkGraph<L: Deref> where L::Target: Logger {
127 secp_ctx: Secp256k1<secp256k1::VerifyOnly>,
128 last_rapid_gossip_sync_timestamp: Mutex<Option<u32>>,
129 genesis_hash: BlockHash,
131 // Lock order: channels -> nodes
132 channels: RwLock<BTreeMap<u64, ChannelInfo>>,
133 nodes: RwLock<BTreeMap<NodeId, NodeInfo>>,
136 /// A read-only view of [`NetworkGraph`].
137 pub struct ReadOnlyNetworkGraph<'a> {
138 channels: RwLockReadGuard<'a, BTreeMap<u64, ChannelInfo>>,
139 nodes: RwLockReadGuard<'a, BTreeMap<NodeId, NodeInfo>>,
142 /// Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
143 /// return packet by a node along the route. See [BOLT #4] for details.
145 /// [BOLT #4]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
146 #[derive(Clone, Debug, PartialEq)]
147 pub enum NetworkUpdate {
148 /// An error indicating a `channel_update` messages should be applied via
149 /// [`NetworkGraph::update_channel`].
150 ChannelUpdateMessage {
151 /// The update to apply via [`NetworkGraph::update_channel`].
154 /// An error indicating that a channel failed to route a payment, which should be applied via
155 /// [`NetworkGraph::channel_failed`].
157 /// The short channel id of the closed channel.
158 short_channel_id: u64,
159 /// Whether the channel should be permanently removed or temporarily disabled until a new
160 /// `channel_update` message is received.
163 /// An error indicating that a node failed to route a payment, which should be applied via
164 /// [`NetworkGraph::node_failed`].
166 /// The node id of the failed node.
168 /// Whether the node should be permanently removed from consideration or can be restored
169 /// when a new `channel_update` message is received.
174 impl_writeable_tlv_based_enum_upgradable!(NetworkUpdate,
175 (0, ChannelUpdateMessage) => {
178 (2, ChannelFailure) => {
179 (0, short_channel_id, required),
180 (2, is_permanent, required),
182 (4, NodeFailure) => {
183 (0, node_id, required),
184 (2, is_permanent, required),
188 /// Receives and validates network updates from peers,
189 /// stores authentic and relevant data as a network graph.
190 /// This network graph is then used for routing payments.
191 /// Provides interface to help with initial routing sync by
192 /// serving historical announcements.
194 /// Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
195 /// [`NetworkGraph`].
196 pub struct P2PGossipSync<G: Deref<Target=NetworkGraph<L>>, C: Deref, L: Deref>
197 where C::Target: chain::Access, L::Target: Logger
200 chain_access: Option<C>,
201 full_syncs_requested: AtomicUsize,
202 pending_events: Mutex<Vec<MessageSendEvent>>,
206 impl<G: Deref<Target=NetworkGraph<L>>, C: Deref, L: Deref> P2PGossipSync<G, C, L>
207 where C::Target: chain::Access, L::Target: Logger
209 /// Creates a new tracker of the actual state of the network of channels and nodes,
210 /// assuming an existing Network Graph.
211 /// Chain monitor is used to make sure announced channels exist on-chain,
212 /// channel data is correct, and that the announcement is signed with
213 /// channel owners' keys.
214 pub fn new(network_graph: G, chain_access: Option<C>, logger: L) -> Self {
217 full_syncs_requested: AtomicUsize::new(0),
219 pending_events: Mutex::new(vec![]),
224 /// Adds a provider used to check new announcements. Does not affect
225 /// existing announcements unless they are updated.
226 /// Add, update or remove the provider would replace the current one.
227 pub fn add_chain_access(&mut self, chain_access: Option<C>) {
228 self.chain_access = chain_access;
231 /// Gets a reference to the underlying [`NetworkGraph`] which was provided in
232 /// [`P2PGossipSync::new`].
234 /// (C-not exported) as bindings don't support a reference-to-a-reference yet
235 pub fn network_graph(&self) -> &G {
239 /// Returns true when a full routing table sync should be performed with a peer.
240 fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
241 //TODO: Determine whether to request a full sync based on the network map.
242 const FULL_SYNCS_TO_REQUEST: usize = 5;
243 if self.full_syncs_requested.load(Ordering::Acquire) < FULL_SYNCS_TO_REQUEST {
244 self.full_syncs_requested.fetch_add(1, Ordering::AcqRel);
252 impl<L: Deref> EventHandler for NetworkGraph<L> where L::Target: Logger {
253 fn handle_event(&self, event: &Event) {
254 if let Event::PaymentPathFailed { network_update, .. } = event {
255 if let Some(network_update) = network_update {
256 match *network_update {
257 NetworkUpdate::ChannelUpdateMessage { ref msg } => {
258 let short_channel_id = msg.contents.short_channel_id;
259 let is_enabled = msg.contents.flags & (1 << 1) != (1 << 1);
260 let status = if is_enabled { "enabled" } else { "disabled" };
261 log_debug!(self.logger, "Updating channel with channel_update from a payment failure. Channel {} is {}.", short_channel_id, status);
262 let _ = self.update_channel(msg);
264 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } => {
265 let action = if is_permanent { "Removing" } else { "Disabling" };
266 log_debug!(self.logger, "{} channel graph entry for {} due to a payment failure.", action, short_channel_id);
267 self.channel_failed(short_channel_id, is_permanent);
269 NetworkUpdate::NodeFailure { ref node_id, is_permanent } => {
270 let action = if is_permanent { "Removing" } else { "Disabling" };
271 log_debug!(self.logger, "{} node graph entry for {} due to a payment failure.", action, node_id);
272 self.node_failed(node_id, is_permanent);
280 macro_rules! secp_verify_sig {
281 ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr, $msg_type: expr ) => {
282 match $secp_ctx.verify_ecdsa($msg, $sig, $pubkey) {
285 return Err(LightningError {
286 err: format!("Invalid signature on {} message", $msg_type),
287 action: ErrorAction::SendWarningMessage {
288 msg: msgs::WarningMessage {
290 data: format!("Invalid signature on {} message", $msg_type),
292 log_level: Level::Trace,
300 impl<G: Deref<Target=NetworkGraph<L>>, C: Deref, L: Deref> RoutingMessageHandler for P2PGossipSync<G, C, L>
301 where C::Target: chain::Access, L::Target: Logger
303 fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
304 self.network_graph.update_node_from_announcement(msg)?;
305 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
306 msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
307 msg.contents.excess_data.len() + msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
310 fn handle_channel_announcement(&self, msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
311 self.network_graph.update_channel_from_announcement(msg, &self.chain_access)?;
312 log_gossip!(self.logger, "Added channel_announcement for {}{}", msg.contents.short_channel_id, if !msg.contents.excess_data.is_empty() { " with excess uninterpreted data!" } else { "" });
313 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
316 fn handle_channel_update(&self, msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
317 self.network_graph.update_channel(msg)?;
318 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
321 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)> {
322 let channels = self.network_graph.channels.read().unwrap();
323 for (_, ref chan) in channels.range(starting_point..) {
324 if chan.announcement_message.is_some() {
325 let chan_announcement = chan.announcement_message.clone().unwrap();
326 let mut one_to_two_announcement: Option<msgs::ChannelUpdate> = None;
327 let mut two_to_one_announcement: Option<msgs::ChannelUpdate> = None;
328 if let Some(one_to_two) = chan.one_to_two.as_ref() {
329 one_to_two_announcement = one_to_two.last_update_message.clone();
331 if let Some(two_to_one) = chan.two_to_one.as_ref() {
332 two_to_one_announcement = two_to_one.last_update_message.clone();
334 return Some((chan_announcement, one_to_two_announcement, two_to_one_announcement));
336 // TODO: We may end up sending un-announced channel_updates if we are sending
337 // initial sync data while receiving announce/updates for this channel.
343 fn get_next_node_announcement(&self, starting_point: Option<&PublicKey>) -> Option<NodeAnnouncement> {
344 let nodes = self.network_graph.nodes.read().unwrap();
345 let iter = if let Some(pubkey) = starting_point {
346 nodes.range((Bound::Excluded(NodeId::from_pubkey(pubkey)), Bound::Unbounded))
350 for (_, ref node) in iter {
351 if let Some(node_info) = node.announcement_info.as_ref() {
352 if let Some(msg) = node_info.announcement_message.clone() {
360 /// Initiates a stateless sync of routing gossip information with a peer
361 /// using gossip_queries. The default strategy used by this implementation
362 /// is to sync the full block range with several peers.
364 /// We should expect one or more reply_channel_range messages in response
365 /// to our query_channel_range. Each reply will enqueue a query_scid message
366 /// to request gossip messages for each channel. The sync is considered complete
367 /// when the final reply_scids_end message is received, though we are not
368 /// tracking this directly.
369 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &Init) {
370 // We will only perform a sync with peers that support gossip_queries.
371 if !init_msg.features.supports_gossip_queries() {
375 // The lightning network's gossip sync system is completely broken in numerous ways.
377 // Given no broadly-available set-reconciliation protocol, the only reasonable approach is
378 // to do a full sync from the first few peers we connect to, and then receive gossip
379 // updates from all our peers normally.
381 // Originally, we could simply tell a peer to dump us the entire gossip table on startup,
382 // wasting lots of bandwidth but ensuring we have the full network graph. After the initial
383 // dump peers would always send gossip and we'd stay up-to-date with whatever our peer has
386 // In order to reduce the bandwidth waste, "gossip queries" were introduced, allowing you
387 // to ask for the SCIDs of all channels in your peer's routing graph, and then only request
388 // channel data which you are missing. Except there was no way at all to identify which
389 // `channel_update`s you were missing, so you still had to request everything, just in a
390 // very complicated way with some queries instead of just getting the dump.
392 // Later, an option was added to fetch the latest timestamps of the `channel_update`s to
393 // make efficient sync possible, however it has yet to be implemented in lnd, which makes
394 // relying on it useless.
396 // After gossip queries were introduced, support for receiving a full gossip table dump on
397 // connection was removed from several nodes, making it impossible to get a full sync
398 // without using the "gossip queries" messages.
400 // Once you opt into "gossip queries" the only way to receive any gossip updates that a
401 // peer receives after you connect, you must send a `gossip_timestamp_filter` message. This
402 // message, as the name implies, tells the peer to not forward any gossip messages with a
403 // timestamp older than a given value (not the time the peer received the filter, but the
404 // timestamp in the update message, which is often hours behind when the peer received the
407 // Obnoxiously, `gossip_timestamp_filter` isn't *just* a filter, but its also a request for
408 // your peer to send you the full routing graph (subject to the filter). Thus, in order to
409 // tell a peer to send you any updates as it sees them, you have to also ask for the full
410 // routing graph to be synced. If you set a timestamp filter near the current time, peers
411 // will simply not forward any new updates they see to you which were generated some time
412 // ago (which is not uncommon). If you instead set a timestamp filter near 0 (or two weeks
413 // ago), you will always get the full routing graph from all your peers.
415 // Most lightning nodes today opt to simply turn off receiving gossip data which only
416 // propagated some time after it was generated, and, worse, often disable gossiping with
417 // several peers after their first connection. The second behavior can cause gossip to not
418 // propagate fully if there are cuts in the gossiping subgraph.
420 // In an attempt to cut a middle ground between always fetching the full graph from all of
421 // our peers and never receiving gossip from peers at all, we send all of our peers a
422 // `gossip_timestamp_filter`, with the filter time set either two weeks ago or an hour ago.
424 // For no-std builds, we bury our head in the sand and do a full sync on each connection.
425 let should_request_full_sync = self.should_request_full_sync(&their_node_id);
426 #[allow(unused_mut, unused_assignments)]
427 let mut gossip_start_time = 0;
428 #[cfg(feature = "std")]
430 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
431 if should_request_full_sync {
432 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
434 gossip_start_time -= 60 * 60; // an hour ago
438 let mut pending_events = self.pending_events.lock().unwrap();
439 pending_events.push(MessageSendEvent::SendGossipTimestampFilter {
440 node_id: their_node_id.clone(),
441 msg: GossipTimestampFilter {
442 chain_hash: self.network_graph.genesis_hash,
443 first_timestamp: gossip_start_time as u32, // 2106 issue!
444 timestamp_range: u32::max_value(),
449 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: ReplyChannelRange) -> Result<(), LightningError> {
450 // We don't make queries, so should never receive replies. If, in the future, the set
451 // reconciliation extensions to gossip queries become broadly supported, we should revert
452 // this code to its state pre-0.0.106.
456 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError> {
457 // We don't make queries, so should never receive replies. If, in the future, the set
458 // reconciliation extensions to gossip queries become broadly supported, we should revert
459 // this code to its state pre-0.0.106.
463 /// Processes a query from a peer by finding announced/public channels whose funding UTXOs
464 /// are in the specified block range. Due to message size limits, large range
465 /// queries may result in several reply messages. This implementation enqueues
466 /// all reply messages into pending events. Each message will allocate just under 65KiB. A full
467 /// sync of the public routing table with 128k channels will generated 16 messages and allocate ~1MB.
468 /// Logic can be changed to reduce allocation if/when a full sync of the routing table impacts
469 /// memory constrained systems.
470 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError> {
471 log_debug!(self.logger, "Handling query_channel_range peer={}, first_blocknum={}, number_of_blocks={}", log_pubkey!(their_node_id), msg.first_blocknum, msg.number_of_blocks);
473 let inclusive_start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0);
475 // We might receive valid queries with end_blocknum that would overflow SCID conversion.
476 // If so, we manually cap the ending block to avoid this overflow.
477 let exclusive_end_scid = scid_from_parts(cmp::min(msg.end_blocknum() as u64, MAX_SCID_BLOCK), 0, 0);
479 // Per spec, we must reply to a query. Send an empty message when things are invalid.
480 if msg.chain_hash != self.network_graph.genesis_hash || inclusive_start_scid.is_err() || exclusive_end_scid.is_err() || msg.number_of_blocks == 0 {
481 let mut pending_events = self.pending_events.lock().unwrap();
482 pending_events.push(MessageSendEvent::SendReplyChannelRange {
483 node_id: their_node_id.clone(),
484 msg: ReplyChannelRange {
485 chain_hash: msg.chain_hash.clone(),
486 first_blocknum: msg.first_blocknum,
487 number_of_blocks: msg.number_of_blocks,
489 short_channel_ids: vec![],
492 return Err(LightningError {
493 err: String::from("query_channel_range could not be processed"),
494 action: ErrorAction::IgnoreError,
498 // Creates channel batches. We are not checking if the channel is routable
499 // (has at least one update). A peer may still want to know the channel
500 // exists even if its not yet routable.
501 let mut batches: Vec<Vec<u64>> = vec![Vec::with_capacity(MAX_SCIDS_PER_REPLY)];
502 let channels = self.network_graph.channels.read().unwrap();
503 for (_, ref chan) in channels.range(inclusive_start_scid.unwrap()..exclusive_end_scid.unwrap()) {
504 if let Some(chan_announcement) = &chan.announcement_message {
505 // Construct a new batch if last one is full
506 if batches.last().unwrap().len() == batches.last().unwrap().capacity() {
507 batches.push(Vec::with_capacity(MAX_SCIDS_PER_REPLY));
510 let batch = batches.last_mut().unwrap();
511 batch.push(chan_announcement.contents.short_channel_id);
516 let mut pending_events = self.pending_events.lock().unwrap();
517 let batch_count = batches.len();
518 let mut prev_batch_endblock = msg.first_blocknum;
519 for (batch_index, batch) in batches.into_iter().enumerate() {
520 // Per spec, the initial `first_blocknum` needs to be <= the query's `first_blocknum`
521 // and subsequent `first_blocknum`s must be >= the prior reply's `first_blocknum`.
523 // Additionally, c-lightning versions < 0.10 require that the `first_blocknum` of each
524 // reply is >= the previous reply's `first_blocknum` and either exactly the previous
525 // reply's `first_blocknum + number_of_blocks` or exactly one greater. This is a
526 // significant diversion from the requirements set by the spec, and, in case of blocks
527 // with no channel opens (e.g. empty blocks), requires that we use the previous value
528 // and *not* derive the first_blocknum from the actual first block of the reply.
529 let first_blocknum = prev_batch_endblock;
531 // Each message carries the number of blocks (from the `first_blocknum`) its contents
532 // fit in. Though there is no requirement that we use exactly the number of blocks its
533 // contents are from, except for the bogus requirements c-lightning enforces, above.
535 // Per spec, the last end block (ie `first_blocknum + number_of_blocks`) needs to be
536 // >= the query's end block. Thus, for the last reply, we calculate the difference
537 // between the query's end block and the start of the reply.
539 // Overflow safe since end_blocknum=msg.first_block_num+msg.number_of_blocks and
540 // first_blocknum will be either msg.first_blocknum or a higher block height.
541 let (sync_complete, number_of_blocks) = if batch_index == batch_count-1 {
542 (true, msg.end_blocknum() - first_blocknum)
544 // Prior replies should use the number of blocks that fit into the reply. Overflow
545 // safe since first_blocknum is always <= last SCID's block.
547 (false, block_from_scid(batch.last().unwrap()) - first_blocknum)
550 prev_batch_endblock = first_blocknum + number_of_blocks;
552 pending_events.push(MessageSendEvent::SendReplyChannelRange {
553 node_id: their_node_id.clone(),
554 msg: ReplyChannelRange {
555 chain_hash: msg.chain_hash.clone(),
559 short_channel_ids: batch,
567 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: QueryShortChannelIds) -> Result<(), LightningError> {
570 err: String::from("Not implemented"),
571 action: ErrorAction::IgnoreError,
576 impl<G: Deref<Target=NetworkGraph<L>>, C: Deref, L: Deref> MessageSendEventsProvider for P2PGossipSync<G, C, L>
578 C::Target: chain::Access,
581 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
582 let mut ret = Vec::new();
583 let mut pending_events = self.pending_events.lock().unwrap();
584 core::mem::swap(&mut ret, &mut pending_events);
589 #[derive(Clone, Debug, PartialEq)]
590 /// Details about one direction of a channel as received within a [`ChannelUpdate`].
591 pub struct ChannelUpdateInfo {
592 /// When the last update to the channel direction was issued.
593 /// Value is opaque, as set in the announcement.
594 pub last_update: u32,
595 /// Whether the channel can be currently used for payments (in this one direction).
597 /// The difference in CLTV values that you must have when routing through this channel.
598 pub cltv_expiry_delta: u16,
599 /// The minimum value, which must be relayed to the next hop via the channel
600 pub htlc_minimum_msat: u64,
601 /// The maximum value which may be relayed to the next hop via the channel.
602 pub htlc_maximum_msat: u64,
603 /// Fees charged when the channel is used for routing
604 pub fees: RoutingFees,
605 /// Most recent update for the channel received from the network
606 /// Mostly redundant with the data we store in fields explicitly.
607 /// Everything else is useful only for sending out for initial routing sync.
608 /// Not stored if contains excess data to prevent DoS.
609 pub last_update_message: Option<ChannelUpdate>,
612 impl fmt::Display for ChannelUpdateInfo {
613 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
614 write!(f, "last_update {}, enabled {}, cltv_expiry_delta {}, htlc_minimum_msat {}, fees {:?}", self.last_update, self.enabled, self.cltv_expiry_delta, self.htlc_minimum_msat, self.fees)?;
619 impl Writeable for ChannelUpdateInfo {
620 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
621 write_tlv_fields!(writer, {
622 (0, self.last_update, required),
623 (2, self.enabled, required),
624 (4, self.cltv_expiry_delta, required),
625 (6, self.htlc_minimum_msat, required),
626 // Writing htlc_maximum_msat as an Option<u64> is required to maintain backwards
627 // compatibility with LDK versions prior to v0.0.110.
628 (8, Some(self.htlc_maximum_msat), required),
629 (10, self.fees, required),
630 (12, self.last_update_message, required),
636 impl Readable for ChannelUpdateInfo {
637 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
638 init_tlv_field_var!(last_update, required);
639 init_tlv_field_var!(enabled, required);
640 init_tlv_field_var!(cltv_expiry_delta, required);
641 init_tlv_field_var!(htlc_minimum_msat, required);
642 init_tlv_field_var!(htlc_maximum_msat, option);
643 init_tlv_field_var!(fees, required);
644 init_tlv_field_var!(last_update_message, required);
646 read_tlv_fields!(reader, {
647 (0, last_update, required),
648 (2, enabled, required),
649 (4, cltv_expiry_delta, required),
650 (6, htlc_minimum_msat, required),
651 (8, htlc_maximum_msat, required),
652 (10, fees, required),
653 (12, last_update_message, required)
656 if let Some(htlc_maximum_msat) = htlc_maximum_msat {
657 Ok(ChannelUpdateInfo {
658 last_update: init_tlv_based_struct_field!(last_update, required),
659 enabled: init_tlv_based_struct_field!(enabled, required),
660 cltv_expiry_delta: init_tlv_based_struct_field!(cltv_expiry_delta, required),
661 htlc_minimum_msat: init_tlv_based_struct_field!(htlc_minimum_msat, required),
663 fees: init_tlv_based_struct_field!(fees, required),
664 last_update_message: init_tlv_based_struct_field!(last_update_message, required),
667 Err(DecodeError::InvalidValue)
672 #[derive(Clone, Debug, PartialEq)]
673 /// Details about a channel (both directions).
674 /// Received within a channel announcement.
675 pub struct ChannelInfo {
676 /// Protocol features of a channel communicated during its announcement
677 pub features: ChannelFeatures,
678 /// Source node of the first direction of a channel
679 pub node_one: NodeId,
680 /// Details about the first direction of a channel
681 pub one_to_two: Option<ChannelUpdateInfo>,
682 /// Source node of the second direction of a channel
683 pub node_two: NodeId,
684 /// Details about the second direction of a channel
685 pub two_to_one: Option<ChannelUpdateInfo>,
686 /// The channel capacity as seen on-chain, if chain lookup is available.
687 pub capacity_sats: Option<u64>,
688 /// An initial announcement of the channel
689 /// Mostly redundant with the data we store in fields explicitly.
690 /// Everything else is useful only for sending out for initial routing sync.
691 /// Not stored if contains excess data to prevent DoS.
692 pub announcement_message: Option<ChannelAnnouncement>,
693 /// The timestamp when we received the announcement, if we are running with feature = "std"
694 /// (which we can probably assume we are - no-std environments probably won't have a full
695 /// network graph in memory!).
696 announcement_received_time: u64,
700 /// Returns a [`DirectedChannelInfo`] for the channel directed to the given `target` from a
701 /// returned `source`, or `None` if `target` is not one of the channel's counterparties.
702 pub fn as_directed_to(&self, target: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
703 let (direction, source) = {
704 if target == &self.node_one {
705 (self.two_to_one.as_ref(), &self.node_two)
706 } else if target == &self.node_two {
707 (self.one_to_two.as_ref(), &self.node_one)
712 Some((DirectedChannelInfo::new(self, direction), source))
715 /// Returns a [`DirectedChannelInfo`] for the channel directed from the given `source` to a
716 /// returned `target`, or `None` if `source` is not one of the channel's counterparties.
717 pub fn as_directed_from(&self, source: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
718 let (direction, target) = {
719 if source == &self.node_one {
720 (self.one_to_two.as_ref(), &self.node_two)
721 } else if source == &self.node_two {
722 (self.two_to_one.as_ref(), &self.node_one)
727 Some((DirectedChannelInfo::new(self, direction), target))
730 /// Returns a [`ChannelUpdateInfo`] based on the direction implied by the channel_flag.
731 pub fn get_directional_info(&self, channel_flags: u8) -> Option<&ChannelUpdateInfo> {
732 let direction = channel_flags & 1u8;
734 self.one_to_two.as_ref()
736 self.two_to_one.as_ref()
741 impl fmt::Display for ChannelInfo {
742 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
743 write!(f, "features: {}, node_one: {}, one_to_two: {:?}, node_two: {}, two_to_one: {:?}",
744 log_bytes!(self.features.encode()), log_bytes!(self.node_one.as_slice()), self.one_to_two, log_bytes!(self.node_two.as_slice()), self.two_to_one)?;
749 impl Writeable for ChannelInfo {
750 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
751 write_tlv_fields!(writer, {
752 (0, self.features, required),
753 (1, self.announcement_received_time, (default_value, 0)),
754 (2, self.node_one, required),
755 (4, self.one_to_two, required),
756 (6, self.node_two, required),
757 (8, self.two_to_one, required),
758 (10, self.capacity_sats, required),
759 (12, self.announcement_message, required),
765 // A wrapper allowing for the optional deseralization of ChannelUpdateInfo. Utilizing this is
766 // necessary to maintain backwards compatibility with previous serializations of `ChannelUpdateInfo`
767 // that may have no `htlc_maximum_msat` field set. In case the field is absent, we simply ignore
768 // the error and continue reading the `ChannelInfo`. Hopefully, we'll then eventually receive newer
769 // channel updates via the gossip network.
770 struct ChannelUpdateInfoDeserWrapper(Option<ChannelUpdateInfo>);
772 impl MaybeReadable for ChannelUpdateInfoDeserWrapper {
773 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
774 match ::util::ser::Readable::read(reader) {
775 Ok(channel_update_option) => Ok(Some(Self(channel_update_option))),
776 Err(DecodeError::ShortRead) => Ok(None),
777 Err(DecodeError::InvalidValue) => Ok(None),
778 Err(err) => Err(err),
783 impl Readable for ChannelInfo {
784 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
785 init_tlv_field_var!(features, required);
786 init_tlv_field_var!(announcement_received_time, (default_value, 0));
787 init_tlv_field_var!(node_one, required);
788 let mut one_to_two_wrap: Option<ChannelUpdateInfoDeserWrapper> = None;
789 init_tlv_field_var!(node_two, required);
790 let mut two_to_one_wrap: Option<ChannelUpdateInfoDeserWrapper> = None;
791 init_tlv_field_var!(capacity_sats, required);
792 init_tlv_field_var!(announcement_message, required);
793 read_tlv_fields!(reader, {
794 (0, features, required),
795 (1, announcement_received_time, (default_value, 0)),
796 (2, node_one, required),
797 (4, one_to_two_wrap, ignorable),
798 (6, node_two, required),
799 (8, two_to_one_wrap, ignorable),
800 (10, capacity_sats, required),
801 (12, announcement_message, required),
805 features: init_tlv_based_struct_field!(features, required),
806 node_one: init_tlv_based_struct_field!(node_one, required),
807 one_to_two: one_to_two_wrap.map(|w| w.0).unwrap_or(None),
808 node_two: init_tlv_based_struct_field!(node_two, required),
809 two_to_one: two_to_one_wrap.map(|w| w.0).unwrap_or(None),
810 capacity_sats: init_tlv_based_struct_field!(capacity_sats, required),
811 announcement_message: init_tlv_based_struct_field!(announcement_message, required),
812 announcement_received_time: init_tlv_based_struct_field!(announcement_received_time, (default_value, 0)),
817 /// A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
818 /// source node to a target node.
820 pub struct DirectedChannelInfo<'a> {
821 channel: &'a ChannelInfo,
822 direction: Option<&'a ChannelUpdateInfo>,
823 htlc_maximum_msat: u64,
824 effective_capacity: EffectiveCapacity,
827 impl<'a> DirectedChannelInfo<'a> {
829 fn new(channel: &'a ChannelInfo, direction: Option<&'a ChannelUpdateInfo>) -> Self {
830 let htlc_maximum_msat = direction.map(|direction| direction.htlc_maximum_msat);
831 let capacity_msat = channel.capacity_sats.map(|capacity_sats| capacity_sats * 1000);
833 let (htlc_maximum_msat, effective_capacity) = match (htlc_maximum_msat, capacity_msat) {
834 (Some(amount_msat), Some(capacity_msat)) => {
835 let htlc_maximum_msat = cmp::min(amount_msat, capacity_msat);
836 (htlc_maximum_msat, EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat: Some(htlc_maximum_msat) })
838 (Some(amount_msat), None) => {
839 (amount_msat, EffectiveCapacity::MaximumHTLC { amount_msat })
841 (None, Some(capacity_msat)) => {
842 (capacity_msat, EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat: None })
844 (None, None) => (EffectiveCapacity::Unknown.as_msat(), EffectiveCapacity::Unknown),
848 channel, direction, htlc_maximum_msat, effective_capacity
852 /// Returns information for the channel.
853 pub fn channel(&self) -> &'a ChannelInfo { self.channel }
855 /// Returns information for the direction.
856 pub fn direction(&self) -> Option<&'a ChannelUpdateInfo> { self.direction }
858 /// Returns the maximum HTLC amount allowed over the channel in the direction.
859 pub fn htlc_maximum_msat(&self) -> u64 {
860 self.htlc_maximum_msat
863 /// Returns the [`EffectiveCapacity`] of the channel in the direction.
865 /// This is either the total capacity from the funding transaction, if known, or the
866 /// `htlc_maximum_msat` for the direction as advertised by the gossip network, if known,
868 pub fn effective_capacity(&self) -> EffectiveCapacity {
869 self.effective_capacity
872 /// Returns `Some` if [`ChannelUpdateInfo`] is available in the direction.
873 pub(super) fn with_update(self) -> Option<DirectedChannelInfoWithUpdate<'a>> {
874 match self.direction {
875 Some(_) => Some(DirectedChannelInfoWithUpdate { inner: self }),
881 impl<'a> fmt::Debug for DirectedChannelInfo<'a> {
882 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
883 f.debug_struct("DirectedChannelInfo")
884 .field("channel", &self.channel)
889 /// A [`DirectedChannelInfo`] with [`ChannelUpdateInfo`] available in its direction.
891 pub(super) struct DirectedChannelInfoWithUpdate<'a> {
892 inner: DirectedChannelInfo<'a>,
895 impl<'a> DirectedChannelInfoWithUpdate<'a> {
896 /// Returns information for the channel.
898 pub(super) fn channel(&self) -> &'a ChannelInfo { &self.inner.channel }
900 /// Returns information for the direction.
902 pub(super) fn direction(&self) -> &'a ChannelUpdateInfo { self.inner.direction.unwrap() }
904 /// Returns the [`EffectiveCapacity`] of the channel in the direction.
906 pub(super) fn effective_capacity(&self) -> EffectiveCapacity { self.inner.effective_capacity() }
909 impl<'a> fmt::Debug for DirectedChannelInfoWithUpdate<'a> {
910 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
915 /// The effective capacity of a channel for routing purposes.
917 /// While this may be smaller than the actual channel capacity, amounts greater than
918 /// [`Self::as_msat`] should not be routed through the channel.
919 #[derive(Clone, Copy)]
920 pub enum EffectiveCapacity {
921 /// The available liquidity in the channel known from being a channel counterparty, and thus a
924 /// Either the inbound or outbound liquidity depending on the direction, denominated in
928 /// The maximum HTLC amount in one direction as advertised on the gossip network.
930 /// The maximum HTLC amount denominated in millisatoshi.
933 /// The total capacity of the channel as determined by the funding transaction.
935 /// The funding amount denominated in millisatoshi.
937 /// The maximum HTLC amount denominated in millisatoshi.
938 htlc_maximum_msat: Option<u64>
940 /// A capacity sufficient to route any payment, typically used for private channels provided by
943 /// A capacity that is unknown possibly because either the chain state is unavailable to know
944 /// the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
948 /// The presumed channel capacity denominated in millisatoshi for [`EffectiveCapacity::Unknown`] to
949 /// use when making routing decisions.
950 pub const UNKNOWN_CHANNEL_CAPACITY_MSAT: u64 = 250_000 * 1000;
952 impl EffectiveCapacity {
953 /// Returns the effective capacity denominated in millisatoshi.
954 pub fn as_msat(&self) -> u64 {
956 EffectiveCapacity::ExactLiquidity { liquidity_msat } => *liquidity_msat,
957 EffectiveCapacity::MaximumHTLC { amount_msat } => *amount_msat,
958 EffectiveCapacity::Total { capacity_msat, .. } => *capacity_msat,
959 EffectiveCapacity::Infinite => u64::max_value(),
960 EffectiveCapacity::Unknown => UNKNOWN_CHANNEL_CAPACITY_MSAT,
965 /// Fees for routing via a given channel or a node
966 #[derive(Eq, PartialEq, Copy, Clone, Debug, Hash)]
967 pub struct RoutingFees {
968 /// Flat routing fee in satoshis
970 /// Liquidity-based routing fee in millionths of a routed amount.
971 /// In other words, 10000 is 1%.
972 pub proportional_millionths: u32,
975 impl_writeable_tlv_based!(RoutingFees, {
976 (0, base_msat, required),
977 (2, proportional_millionths, required)
980 #[derive(Clone, Debug, PartialEq)]
981 /// Information received in the latest node_announcement from this node.
982 pub struct NodeAnnouncementInfo {
983 /// Protocol features the node announced support for
984 pub features: NodeFeatures,
985 /// When the last known update to the node state was issued.
986 /// Value is opaque, as set in the announcement.
987 pub last_update: u32,
988 /// Color assigned to the node
990 /// Moniker assigned to the node.
991 /// May be invalid or malicious (eg control chars),
992 /// should not be exposed to the user.
993 pub alias: NodeAlias,
994 /// Internet-level addresses via which one can connect to the node
995 pub addresses: Vec<NetAddress>,
996 /// An initial announcement of the node
997 /// Mostly redundant with the data we store in fields explicitly.
998 /// Everything else is useful only for sending out for initial routing sync.
999 /// Not stored if contains excess data to prevent DoS.
1000 pub announcement_message: Option<NodeAnnouncement>
1003 impl_writeable_tlv_based!(NodeAnnouncementInfo, {
1004 (0, features, required),
1005 (2, last_update, required),
1007 (6, alias, required),
1008 (8, announcement_message, option),
1009 (10, addresses, vec_type),
1012 /// A user-defined name for a node, which may be used when displaying the node in a graph.
1014 /// Since node aliases are provided by third parties, they are a potential avenue for injection
1015 /// attacks. Care must be taken when processing.
1016 #[derive(Clone, Debug, PartialEq)]
1017 pub struct NodeAlias(pub [u8; 32]);
1019 impl fmt::Display for NodeAlias {
1020 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1021 let control_symbol = core::char::REPLACEMENT_CHARACTER;
1022 let first_null = self.0.iter().position(|b| *b == 0).unwrap_or(self.0.len());
1023 let bytes = self.0.split_at(first_null).0;
1024 match core::str::from_utf8(bytes) {
1026 for c in alias.chars() {
1027 let mut bytes = [0u8; 4];
1028 let c = if !c.is_control() { c } else { control_symbol };
1029 f.write_str(c.encode_utf8(&mut bytes))?;
1033 for c in bytes.iter().map(|b| *b as char) {
1034 // Display printable ASCII characters
1035 let mut bytes = [0u8; 4];
1036 let c = if c >= '\x20' && c <= '\x7e' { c } else { control_symbol };
1037 f.write_str(c.encode_utf8(&mut bytes))?;
1045 impl Writeable for NodeAlias {
1046 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1051 impl Readable for NodeAlias {
1052 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
1053 Ok(NodeAlias(Readable::read(r)?))
1057 #[derive(Clone, Debug, PartialEq)]
1058 /// Details about a node in the network, known from the network announcement.
1059 pub struct NodeInfo {
1060 /// All valid channels a node has announced
1061 pub channels: Vec<u64>,
1062 /// Lowest fees enabling routing via any of the enabled, known channels to a node.
1063 /// The two fields (flat and proportional fee) are independent,
1064 /// meaning they don't have to refer to the same channel.
1065 pub lowest_inbound_channel_fees: Option<RoutingFees>,
1066 /// More information about a node from node_announcement.
1067 /// Optional because we store a Node entry after learning about it from
1068 /// a channel announcement, but before receiving a node announcement.
1069 pub announcement_info: Option<NodeAnnouncementInfo>
1072 impl fmt::Display for NodeInfo {
1073 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1074 write!(f, "lowest_inbound_channel_fees: {:?}, channels: {:?}, announcement_info: {:?}",
1075 self.lowest_inbound_channel_fees, &self.channels[..], self.announcement_info)?;
1080 impl Writeable for NodeInfo {
1081 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1082 write_tlv_fields!(writer, {
1083 (0, self.lowest_inbound_channel_fees, option),
1084 (2, self.announcement_info, option),
1085 (4, self.channels, vec_type),
1091 // A wrapper allowing for the optional deseralization of `NodeAnnouncementInfo`. Utilizing this is
1092 // necessary to maintain compatibility with previous serializations of `NetAddress` that have an
1093 // invalid hostname set. We ignore and eat all errors until we are either able to read a
1094 // `NodeAnnouncementInfo` or hit a `ShortRead`, i.e., read the TLV field to the end.
1095 struct NodeAnnouncementInfoDeserWrapper(NodeAnnouncementInfo);
1097 impl MaybeReadable for NodeAnnouncementInfoDeserWrapper {
1098 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
1099 match ::util::ser::Readable::read(reader) {
1100 Ok(node_announcement_info) => return Ok(Some(Self(node_announcement_info))),
1102 copy(reader, &mut sink()).unwrap();
1109 impl Readable for NodeInfo {
1110 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1111 init_tlv_field_var!(lowest_inbound_channel_fees, option);
1112 let mut announcement_info_wrap: Option<NodeAnnouncementInfoDeserWrapper> = None;
1113 init_tlv_field_var!(channels, vec_type);
1115 read_tlv_fields!(reader, {
1116 (0, lowest_inbound_channel_fees, option),
1117 (2, announcement_info_wrap, ignorable),
1118 (4, channels, vec_type),
1122 lowest_inbound_channel_fees: init_tlv_based_struct_field!(lowest_inbound_channel_fees, option),
1123 announcement_info: announcement_info_wrap.map(|w| w.0),
1124 channels: init_tlv_based_struct_field!(channels, vec_type),
1129 const SERIALIZATION_VERSION: u8 = 1;
1130 const MIN_SERIALIZATION_VERSION: u8 = 1;
1132 impl<L: Deref> Writeable for NetworkGraph<L> where L::Target: Logger {
1133 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1134 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
1136 self.genesis_hash.write(writer)?;
1137 let channels = self.channels.read().unwrap();
1138 (channels.len() as u64).write(writer)?;
1139 for (ref chan_id, ref chan_info) in channels.iter() {
1140 (*chan_id).write(writer)?;
1141 chan_info.write(writer)?;
1143 let nodes = self.nodes.read().unwrap();
1144 (nodes.len() as u64).write(writer)?;
1145 for (ref node_id, ref node_info) in nodes.iter() {
1146 node_id.write(writer)?;
1147 node_info.write(writer)?;
1150 let last_rapid_gossip_sync_timestamp = self.get_last_rapid_gossip_sync_timestamp();
1151 write_tlv_fields!(writer, {
1152 (1, last_rapid_gossip_sync_timestamp, option),
1158 impl<L: Deref> ReadableArgs<L> for NetworkGraph<L> where L::Target: Logger {
1159 fn read<R: io::Read>(reader: &mut R, logger: L) -> Result<NetworkGraph<L>, DecodeError> {
1160 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
1162 let genesis_hash: BlockHash = Readable::read(reader)?;
1163 let channels_count: u64 = Readable::read(reader)?;
1164 let mut channels = BTreeMap::new();
1165 for _ in 0..channels_count {
1166 let chan_id: u64 = Readable::read(reader)?;
1167 let chan_info = Readable::read(reader)?;
1168 channels.insert(chan_id, chan_info);
1170 let nodes_count: u64 = Readable::read(reader)?;
1171 let mut nodes = BTreeMap::new();
1172 for _ in 0..nodes_count {
1173 let node_id = Readable::read(reader)?;
1174 let node_info = Readable::read(reader)?;
1175 nodes.insert(node_id, node_info);
1178 let mut last_rapid_gossip_sync_timestamp: Option<u32> = None;
1179 read_tlv_fields!(reader, {
1180 (1, last_rapid_gossip_sync_timestamp, option),
1184 secp_ctx: Secp256k1::verification_only(),
1187 channels: RwLock::new(channels),
1188 nodes: RwLock::new(nodes),
1189 last_rapid_gossip_sync_timestamp: Mutex::new(last_rapid_gossip_sync_timestamp),
1194 impl<L: Deref> fmt::Display for NetworkGraph<L> where L::Target: Logger {
1195 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1196 writeln!(f, "Network map\n[Channels]")?;
1197 for (key, val) in self.channels.read().unwrap().iter() {
1198 writeln!(f, " {}: {}", key, val)?;
1200 writeln!(f, "[Nodes]")?;
1201 for (&node_id, val) in self.nodes.read().unwrap().iter() {
1202 writeln!(f, " {}: {}", log_bytes!(node_id.as_slice()), val)?;
1208 impl<L: Deref> PartialEq for NetworkGraph<L> where L::Target: Logger {
1209 fn eq(&self, other: &Self) -> bool {
1210 self.genesis_hash == other.genesis_hash &&
1211 *self.channels.read().unwrap() == *other.channels.read().unwrap() &&
1212 *self.nodes.read().unwrap() == *other.nodes.read().unwrap()
1216 impl<L: Deref> NetworkGraph<L> where L::Target: Logger {
1217 /// Creates a new, empty, network graph.
1218 pub fn new(genesis_hash: BlockHash, logger: L) -> NetworkGraph<L> {
1220 secp_ctx: Secp256k1::verification_only(),
1223 channels: RwLock::new(BTreeMap::new()),
1224 nodes: RwLock::new(BTreeMap::new()),
1225 last_rapid_gossip_sync_timestamp: Mutex::new(None),
1229 /// Returns a read-only view of the network graph.
1230 pub fn read_only(&'_ self) -> ReadOnlyNetworkGraph<'_> {
1231 let channels = self.channels.read().unwrap();
1232 let nodes = self.nodes.read().unwrap();
1233 ReadOnlyNetworkGraph {
1239 /// The unix timestamp provided by the most recent rapid gossip sync.
1240 /// It will be set by the rapid sync process after every sync completion.
1241 pub fn get_last_rapid_gossip_sync_timestamp(&self) -> Option<u32> {
1242 self.last_rapid_gossip_sync_timestamp.lock().unwrap().clone()
1245 /// Update the unix timestamp provided by the most recent rapid gossip sync.
1246 /// This should be done automatically by the rapid sync process after every sync completion.
1247 pub fn set_last_rapid_gossip_sync_timestamp(&self, last_rapid_gossip_sync_timestamp: u32) {
1248 self.last_rapid_gossip_sync_timestamp.lock().unwrap().replace(last_rapid_gossip_sync_timestamp);
1251 /// Clears the `NodeAnnouncementInfo` field for all nodes in the `NetworkGraph` for testing
1254 pub fn clear_nodes_announcement_info(&self) {
1255 for node in self.nodes.write().unwrap().iter_mut() {
1256 node.1.announcement_info = None;
1260 /// For an already known node (from channel announcements), update its stored properties from a
1261 /// given node announcement.
1263 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1264 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1265 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1266 pub fn update_node_from_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<(), LightningError> {
1267 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1268 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.signature, &msg.contents.node_id, "node_announcement");
1269 self.update_node_from_announcement_intern(&msg.contents, Some(&msg))
1272 /// For an already known node (from channel announcements), update its stored properties from a
1273 /// given node announcement without verifying the associated signatures. Because we aren't
1274 /// given the associated signatures here we cannot relay the node announcement to any of our
1276 pub fn update_node_from_unsigned_announcement(&self, msg: &msgs::UnsignedNodeAnnouncement) -> Result<(), LightningError> {
1277 self.update_node_from_announcement_intern(msg, None)
1280 fn update_node_from_announcement_intern(&self, msg: &msgs::UnsignedNodeAnnouncement, full_msg: Option<&msgs::NodeAnnouncement>) -> Result<(), LightningError> {
1281 match self.nodes.write().unwrap().get_mut(&NodeId::from_pubkey(&msg.node_id)) {
1282 None => Err(LightningError{err: "No existing channels for node_announcement".to_owned(), action: ErrorAction::IgnoreError}),
1284 if let Some(node_info) = node.announcement_info.as_ref() {
1285 // The timestamp field is somewhat of a misnomer - the BOLTs use it to order
1286 // updates to ensure you always have the latest one, only vaguely suggesting
1287 // that it be at least the current time.
1288 if node_info.last_update > msg.timestamp {
1289 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1290 } else if node_info.last_update == msg.timestamp {
1291 return Err(LightningError{err: "Update had the same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1296 msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1297 msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1298 msg.excess_data.len() + msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY;
1299 node.announcement_info = Some(NodeAnnouncementInfo {
1300 features: msg.features.clone(),
1301 last_update: msg.timestamp,
1303 alias: NodeAlias(msg.alias),
1304 addresses: msg.addresses.clone(),
1305 announcement_message: if should_relay { full_msg.cloned() } else { None },
1313 /// Store or update channel info from a channel announcement.
1315 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1316 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1317 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1319 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1320 /// the corresponding UTXO exists on chain and is correctly-formatted.
1321 pub fn update_channel_from_announcement<C: Deref>(
1322 &self, msg: &msgs::ChannelAnnouncement, chain_access: &Option<C>,
1323 ) -> Result<(), LightningError>
1325 C::Target: chain::Access,
1327 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1328 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_1, &msg.contents.node_id_1, "channel_announcement");
1329 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_2, &msg.contents.node_id_2, "channel_announcement");
1330 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_1, &msg.contents.bitcoin_key_1, "channel_announcement");
1331 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_2, &msg.contents.bitcoin_key_2, "channel_announcement");
1332 self.update_channel_from_unsigned_announcement_intern(&msg.contents, Some(msg), chain_access)
1335 /// Store or update channel info from a channel announcement without verifying the associated
1336 /// signatures. Because we aren't given the associated signatures here we cannot relay the
1337 /// channel announcement to any of our peers.
1339 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1340 /// the corresponding UTXO exists on chain and is correctly-formatted.
1341 pub fn update_channel_from_unsigned_announcement<C: Deref>(
1342 &self, msg: &msgs::UnsignedChannelAnnouncement, chain_access: &Option<C>
1343 ) -> Result<(), LightningError>
1345 C::Target: chain::Access,
1347 self.update_channel_from_unsigned_announcement_intern(msg, None, chain_access)
1350 /// Update channel from partial announcement data received via rapid gossip sync
1352 /// `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
1353 /// rapid gossip sync server)
1355 /// All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
1356 pub fn add_channel_from_partial_announcement(&self, short_channel_id: u64, timestamp: u64, features: ChannelFeatures, node_id_1: PublicKey, node_id_2: PublicKey) -> Result<(), LightningError> {
1357 if node_id_1 == node_id_2 {
1358 return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1361 let node_1 = NodeId::from_pubkey(&node_id_1);
1362 let node_2 = NodeId::from_pubkey(&node_id_2);
1363 let channel_info = ChannelInfo {
1365 node_one: node_1.clone(),
1367 node_two: node_2.clone(),
1369 capacity_sats: None,
1370 announcement_message: None,
1371 announcement_received_time: timestamp,
1374 self.add_channel_between_nodes(short_channel_id, channel_info, None)
1377 fn add_channel_between_nodes(&self, short_channel_id: u64, channel_info: ChannelInfo, utxo_value: Option<u64>) -> Result<(), LightningError> {
1378 let mut channels = self.channels.write().unwrap();
1379 let mut nodes = self.nodes.write().unwrap();
1381 let node_id_a = channel_info.node_one.clone();
1382 let node_id_b = channel_info.node_two.clone();
1384 match channels.entry(short_channel_id) {
1385 BtreeEntry::Occupied(mut entry) => {
1386 //TODO: because asking the blockchain if short_channel_id is valid is only optional
1387 //in the blockchain API, we need to handle it smartly here, though it's unclear
1389 if utxo_value.is_some() {
1390 // Either our UTXO provider is busted, there was a reorg, or the UTXO provider
1391 // only sometimes returns results. In any case remove the previous entry. Note
1392 // that the spec expects us to "blacklist" the node_ids involved, but we can't
1394 // a) we don't *require* a UTXO provider that always returns results.
1395 // b) we don't track UTXOs of channels we know about and remove them if they
1397 // c) it's unclear how to do so without exposing ourselves to massive DoS risk.
1398 Self::remove_channel_in_nodes(&mut nodes, &entry.get(), short_channel_id);
1399 *entry.get_mut() = channel_info;
1401 return Err(LightningError{err: "Already have knowledge of channel".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1404 BtreeEntry::Vacant(entry) => {
1405 entry.insert(channel_info);
1409 for current_node_id in [node_id_a, node_id_b].iter() {
1410 match nodes.entry(current_node_id.clone()) {
1411 BtreeEntry::Occupied(node_entry) => {
1412 node_entry.into_mut().channels.push(short_channel_id);
1414 BtreeEntry::Vacant(node_entry) => {
1415 node_entry.insert(NodeInfo {
1416 channels: vec!(short_channel_id),
1417 lowest_inbound_channel_fees: None,
1418 announcement_info: None,
1427 fn update_channel_from_unsigned_announcement_intern<C: Deref>(
1428 &self, msg: &msgs::UnsignedChannelAnnouncement, full_msg: Option<&msgs::ChannelAnnouncement>, chain_access: &Option<C>
1429 ) -> Result<(), LightningError>
1431 C::Target: chain::Access,
1433 if msg.node_id_1 == msg.node_id_2 || msg.bitcoin_key_1 == msg.bitcoin_key_2 {
1434 return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1437 let utxo_value = match &chain_access {
1439 // Tentatively accept, potentially exposing us to DoS attacks
1442 &Some(ref chain_access) => {
1443 match chain_access.get_utxo(&msg.chain_hash, msg.short_channel_id) {
1444 Ok(TxOut { value, script_pubkey }) => {
1445 let expected_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1446 .push_slice(&msg.bitcoin_key_1.serialize())
1447 .push_slice(&msg.bitcoin_key_2.serialize())
1448 .push_opcode(opcodes::all::OP_PUSHNUM_2)
1449 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
1450 if script_pubkey != expected_script {
1451 return Err(LightningError{err: format!("Channel announcement key ({}) didn't match on-chain script ({})", script_pubkey.to_hex(), expected_script.to_hex()), action: ErrorAction::IgnoreError});
1453 //TODO: Check if value is worth storing, use it to inform routing, and compare it
1454 //to the new HTLC max field in channel_update
1457 Err(chain::AccessError::UnknownChain) => {
1458 return Err(LightningError{err: format!("Channel announced on an unknown chain ({})", msg.chain_hash.encode().to_hex()), action: ErrorAction::IgnoreError});
1460 Err(chain::AccessError::UnknownTx) => {
1461 return Err(LightningError{err: "Channel announced without corresponding UTXO entry".to_owned(), action: ErrorAction::IgnoreError});
1467 #[allow(unused_mut, unused_assignments)]
1468 let mut announcement_received_time = 0;
1469 #[cfg(feature = "std")]
1471 announcement_received_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1474 let chan_info = ChannelInfo {
1475 features: msg.features.clone(),
1476 node_one: NodeId::from_pubkey(&msg.node_id_1),
1478 node_two: NodeId::from_pubkey(&msg.node_id_2),
1480 capacity_sats: utxo_value,
1481 announcement_message: if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1482 { full_msg.cloned() } else { None },
1483 announcement_received_time,
1486 self.add_channel_between_nodes(msg.short_channel_id, chan_info, utxo_value)
1489 /// Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
1490 /// If permanent, removes a channel from the local storage.
1491 /// May cause the removal of nodes too, if this was their last channel.
1492 /// If not permanent, makes channels unavailable for routing.
1493 pub fn channel_failed(&self, short_channel_id: u64, is_permanent: bool) {
1494 let mut channels = self.channels.write().unwrap();
1496 if let Some(chan) = channels.remove(&short_channel_id) {
1497 let mut nodes = self.nodes.write().unwrap();
1498 Self::remove_channel_in_nodes(&mut nodes, &chan, short_channel_id);
1501 if let Some(chan) = channels.get_mut(&short_channel_id) {
1502 if let Some(one_to_two) = chan.one_to_two.as_mut() {
1503 one_to_two.enabled = false;
1505 if let Some(two_to_one) = chan.two_to_one.as_mut() {
1506 two_to_one.enabled = false;
1512 /// Marks a node in the graph as failed.
1513 pub fn node_failed(&self, _node_id: &PublicKey, is_permanent: bool) {
1515 // TODO: Wholly remove the node
1517 // TODO: downgrade the node
1521 #[cfg(feature = "std")]
1522 /// Removes information about channels that we haven't heard any updates about in some time.
1523 /// This can be used regularly to prune the network graph of channels that likely no longer
1526 /// While there is no formal requirement that nodes regularly re-broadcast their channel
1527 /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1528 /// pruning occur for updates which are at least two weeks old, which we implement here.
1530 /// Note that for users of the `lightning-background-processor` crate this method may be
1531 /// automatically called regularly for you.
1533 /// This method is only available with the `std` feature. See
1534 /// [`NetworkGraph::remove_stale_channels_with_time`] for `no-std` use.
1535 pub fn remove_stale_channels(&self) {
1536 let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1537 self.remove_stale_channels_with_time(time);
1540 /// Removes information about channels that we haven't heard any updates about in some time.
1541 /// This can be used regularly to prune the network graph of channels that likely no longer
1544 /// While there is no formal requirement that nodes regularly re-broadcast their channel
1545 /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1546 /// pruning occur for updates which are at least two weeks old, which we implement here.
1548 /// This function takes the current unix time as an argument. For users with the `std` feature
1549 /// enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
1550 pub fn remove_stale_channels_with_time(&self, current_time_unix: u64) {
1551 let mut channels = self.channels.write().unwrap();
1552 // Time out if we haven't received an update in at least 14 days.
1553 if current_time_unix > u32::max_value() as u64 { return; } // Remove by 2106
1554 if current_time_unix < STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS { return; }
1555 let min_time_unix: u32 = (current_time_unix - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS) as u32;
1556 // Sadly BTreeMap::retain was only stabilized in 1.53 so we can't switch to it for some
1558 let mut scids_to_remove = Vec::new();
1559 for (scid, info) in channels.iter_mut() {
1560 if info.one_to_two.is_some() && info.one_to_two.as_ref().unwrap().last_update < min_time_unix {
1561 info.one_to_two = None;
1563 if info.two_to_one.is_some() && info.two_to_one.as_ref().unwrap().last_update < min_time_unix {
1564 info.two_to_one = None;
1566 if info.one_to_two.is_none() && info.two_to_one.is_none() {
1567 // We check the announcement_received_time here to ensure we don't drop
1568 // announcements that we just received and are just waiting for our peer to send a
1569 // channel_update for.
1570 if info.announcement_received_time < min_time_unix as u64 {
1571 scids_to_remove.push(*scid);
1575 if !scids_to_remove.is_empty() {
1576 let mut nodes = self.nodes.write().unwrap();
1577 for scid in scids_to_remove {
1578 let info = channels.remove(&scid).expect("We just accessed this scid, it should be present");
1579 Self::remove_channel_in_nodes(&mut nodes, &info, scid);
1584 /// For an already known (from announcement) channel, update info about one of the directions
1587 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1588 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1589 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1591 /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1592 /// materially in the future will be rejected.
1593 pub fn update_channel(&self, msg: &msgs::ChannelUpdate) -> Result<(), LightningError> {
1594 self.update_channel_intern(&msg.contents, Some(&msg), Some(&msg.signature))
1597 /// For an already known (from announcement) channel, update info about one of the directions
1598 /// of the channel without verifying the associated signatures. Because we aren't given the
1599 /// associated signatures here we cannot relay the channel update to any of our peers.
1601 /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1602 /// materially in the future will be rejected.
1603 pub fn update_channel_unsigned(&self, msg: &msgs::UnsignedChannelUpdate) -> Result<(), LightningError> {
1604 self.update_channel_intern(msg, None, None)
1607 fn update_channel_intern(&self, msg: &msgs::UnsignedChannelUpdate, full_msg: Option<&msgs::ChannelUpdate>, sig: Option<&secp256k1::ecdsa::Signature>) -> Result<(), LightningError> {
1609 let chan_enabled = msg.flags & (1 << 1) != (1 << 1);
1610 let chan_was_enabled;
1612 #[cfg(all(feature = "std", not(test), not(feature = "_test_utils")))]
1614 // Note that many tests rely on being able to set arbitrarily old timestamps, thus we
1615 // disable this check during tests!
1616 let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1617 if (msg.timestamp as u64) < time - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS {
1618 return Err(LightningError{err: "channel_update is older than two weeks old".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1620 if msg.timestamp as u64 > time + 60 * 60 * 24 {
1621 return Err(LightningError{err: "channel_update has a timestamp more than a day in the future".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1625 let mut channels = self.channels.write().unwrap();
1626 match channels.get_mut(&msg.short_channel_id) {
1627 None => return Err(LightningError{err: "Couldn't find channel for update".to_owned(), action: ErrorAction::IgnoreError}),
1629 if msg.htlc_maximum_msat > MAX_VALUE_MSAT {
1630 return Err(LightningError{err:
1631 "htlc_maximum_msat is larger than maximum possible msats".to_owned(),
1632 action: ErrorAction::IgnoreError});
1635 if let Some(capacity_sats) = channel.capacity_sats {
1636 // It's possible channel capacity is available now, although it wasn't available at announcement (so the field is None).
1637 // Don't query UTXO set here to reduce DoS risks.
1638 if capacity_sats > MAX_VALUE_MSAT / 1000 || msg.htlc_maximum_msat > capacity_sats * 1000 {
1639 return Err(LightningError{err:
1640 "htlc_maximum_msat is larger than channel capacity or capacity is bogus".to_owned(),
1641 action: ErrorAction::IgnoreError});
1644 macro_rules! check_update_latest {
1645 ($target: expr) => {
1646 if let Some(existing_chan_info) = $target.as_ref() {
1647 // The timestamp field is somewhat of a misnomer - the BOLTs use it to
1648 // order updates to ensure you always have the latest one, only
1649 // suggesting that it be at least the current time. For
1650 // channel_updates specifically, the BOLTs discuss the possibility of
1651 // pruning based on the timestamp field being more than two weeks old,
1652 // but only in the non-normative section.
1653 if existing_chan_info.last_update > msg.timestamp {
1654 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1655 } else if existing_chan_info.last_update == msg.timestamp {
1656 return Err(LightningError{err: "Update had same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1658 chan_was_enabled = existing_chan_info.enabled;
1660 chan_was_enabled = false;
1665 macro_rules! get_new_channel_info {
1667 let last_update_message = if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1668 { full_msg.cloned() } else { None };
1670 let updated_channel_update_info = ChannelUpdateInfo {
1671 enabled: chan_enabled,
1672 last_update: msg.timestamp,
1673 cltv_expiry_delta: msg.cltv_expiry_delta,
1674 htlc_minimum_msat: msg.htlc_minimum_msat,
1675 htlc_maximum_msat: msg.htlc_maximum_msat,
1677 base_msat: msg.fee_base_msat,
1678 proportional_millionths: msg.fee_proportional_millionths,
1682 Some(updated_channel_update_info)
1686 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1687 if msg.flags & 1 == 1 {
1688 dest_node_id = channel.node_one.clone();
1689 check_update_latest!(channel.two_to_one);
1690 if let Some(sig) = sig {
1691 secp_verify_sig!(self.secp_ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_two.as_slice()).map_err(|_| LightningError{
1692 err: "Couldn't parse source node pubkey".to_owned(),
1693 action: ErrorAction::IgnoreAndLog(Level::Debug)
1694 })?, "channel_update");
1696 channel.two_to_one = get_new_channel_info!();
1698 dest_node_id = channel.node_two.clone();
1699 check_update_latest!(channel.one_to_two);
1700 if let Some(sig) = sig {
1701 secp_verify_sig!(self.secp_ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_one.as_slice()).map_err(|_| LightningError{
1702 err: "Couldn't parse destination node pubkey".to_owned(),
1703 action: ErrorAction::IgnoreAndLog(Level::Debug)
1704 })?, "channel_update");
1706 channel.one_to_two = get_new_channel_info!();
1711 let mut nodes = self.nodes.write().unwrap();
1713 let node = nodes.get_mut(&dest_node_id).unwrap();
1714 let mut base_msat = msg.fee_base_msat;
1715 let mut proportional_millionths = msg.fee_proportional_millionths;
1716 if let Some(fees) = node.lowest_inbound_channel_fees {
1717 base_msat = cmp::min(base_msat, fees.base_msat);
1718 proportional_millionths = cmp::min(proportional_millionths, fees.proportional_millionths);
1720 node.lowest_inbound_channel_fees = Some(RoutingFees {
1722 proportional_millionths
1724 } else if chan_was_enabled {
1725 let node = nodes.get_mut(&dest_node_id).unwrap();
1726 let mut lowest_inbound_channel_fees = None;
1728 for chan_id in node.channels.iter() {
1729 let chan = channels.get(chan_id).unwrap();
1731 if chan.node_one == dest_node_id {
1732 chan_info_opt = chan.two_to_one.as_ref();
1734 chan_info_opt = chan.one_to_two.as_ref();
1736 if let Some(chan_info) = chan_info_opt {
1737 if chan_info.enabled {
1738 let fees = lowest_inbound_channel_fees.get_or_insert(RoutingFees {
1739 base_msat: u32::max_value(), proportional_millionths: u32::max_value() });
1740 fees.base_msat = cmp::min(fees.base_msat, chan_info.fees.base_msat);
1741 fees.proportional_millionths = cmp::min(fees.proportional_millionths, chan_info.fees.proportional_millionths);
1746 node.lowest_inbound_channel_fees = lowest_inbound_channel_fees;
1752 fn remove_channel_in_nodes(nodes: &mut BTreeMap<NodeId, NodeInfo>, chan: &ChannelInfo, short_channel_id: u64) {
1753 macro_rules! remove_from_node {
1754 ($node_id: expr) => {
1755 if let BtreeEntry::Occupied(mut entry) = nodes.entry($node_id) {
1756 entry.get_mut().channels.retain(|chan_id| {
1757 short_channel_id != *chan_id
1759 if entry.get().channels.is_empty() {
1760 entry.remove_entry();
1763 panic!("Had channel that pointed to unknown node (ie inconsistent network map)!");
1768 remove_from_node!(chan.node_one);
1769 remove_from_node!(chan.node_two);
1773 impl ReadOnlyNetworkGraph<'_> {
1774 /// Returns all known valid channels' short ids along with announced channel info.
1776 /// (C-not exported) because we have no mapping for `BTreeMap`s
1777 pub fn channels(&self) -> &BTreeMap<u64, ChannelInfo> {
1781 /// Returns information on a channel with the given id.
1782 pub fn channel(&self, short_channel_id: u64) -> Option<&ChannelInfo> {
1783 self.channels.get(&short_channel_id)
1786 #[cfg(c_bindings)] // Non-bindings users should use `channels`
1787 /// Returns the list of channels in the graph
1788 pub fn list_channels(&self) -> Vec<u64> {
1789 self.channels.keys().map(|c| *c).collect()
1792 /// Returns all known nodes' public keys along with announced node info.
1794 /// (C-not exported) because we have no mapping for `BTreeMap`s
1795 pub fn nodes(&self) -> &BTreeMap<NodeId, NodeInfo> {
1799 /// Returns information on a node with the given id.
1800 pub fn node(&self, node_id: &NodeId) -> Option<&NodeInfo> {
1801 self.nodes.get(node_id)
1804 #[cfg(c_bindings)] // Non-bindings users should use `nodes`
1805 /// Returns the list of nodes in the graph
1806 pub fn list_nodes(&self) -> Vec<NodeId> {
1807 self.nodes.keys().map(|n| *n).collect()
1810 /// Get network addresses by node id.
1811 /// Returns None if the requested node is completely unknown,
1812 /// or if node announcement for the node was never received.
1813 pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
1814 if let Some(node) = self.nodes.get(&NodeId::from_pubkey(&pubkey)) {
1815 if let Some(node_info) = node.announcement_info.as_ref() {
1816 return Some(node_info.addresses.clone())
1826 use ln::PaymentHash;
1827 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
1828 use routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate, NodeAlias, MAX_EXCESS_BYTES_FOR_RELAY, NodeId, RoutingFees, ChannelUpdateInfo, ChannelInfo, NodeAnnouncementInfo, NodeInfo};
1829 use ln::msgs::{Init, RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
1830 UnsignedChannelAnnouncement, ChannelAnnouncement, UnsignedChannelUpdate, ChannelUpdate,
1831 ReplyChannelRange, QueryChannelRange, QueryShortChannelIds, MAX_VALUE_MSAT};
1832 use util::test_utils;
1833 use util::ser::{ReadableArgs, Writeable};
1834 use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
1835 use util::scid_utils::scid_from_parts;
1837 use super::STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS;
1839 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1840 use bitcoin::hashes::Hash;
1841 use bitcoin::network::constants::Network;
1842 use bitcoin::blockdata::constants::genesis_block;
1843 use bitcoin::blockdata::script::{Builder, Script};
1844 use bitcoin::blockdata::transaction::TxOut;
1845 use bitcoin::blockdata::opcodes;
1849 use bitcoin::secp256k1::{PublicKey, SecretKey};
1850 use bitcoin::secp256k1::{All, Secp256k1};
1853 use bitcoin::secp256k1;
1857 fn create_network_graph() -> NetworkGraph<Arc<test_utils::TestLogger>> {
1858 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1859 let logger = Arc::new(test_utils::TestLogger::new());
1860 NetworkGraph::new(genesis_hash, logger)
1863 fn create_gossip_sync(network_graph: &NetworkGraph<Arc<test_utils::TestLogger>>) -> (
1864 Secp256k1<All>, P2PGossipSync<&NetworkGraph<Arc<test_utils::TestLogger>>,
1865 Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>
1867 let secp_ctx = Secp256k1::new();
1868 let logger = Arc::new(test_utils::TestLogger::new());
1869 let gossip_sync = P2PGossipSync::new(network_graph, None, Arc::clone(&logger));
1870 (secp_ctx, gossip_sync)
1874 fn request_full_sync_finite_times() {
1875 let network_graph = create_network_graph();
1876 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
1877 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1879 assert!(gossip_sync.should_request_full_sync(&node_id));
1880 assert!(gossip_sync.should_request_full_sync(&node_id));
1881 assert!(gossip_sync.should_request_full_sync(&node_id));
1882 assert!(gossip_sync.should_request_full_sync(&node_id));
1883 assert!(gossip_sync.should_request_full_sync(&node_id));
1884 assert!(!gossip_sync.should_request_full_sync(&node_id));
1887 fn get_signed_node_announcement<F: Fn(&mut UnsignedNodeAnnouncement)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> NodeAnnouncement {
1888 let node_id = PublicKey::from_secret_key(&secp_ctx, node_key);
1889 let mut unsigned_announcement = UnsignedNodeAnnouncement {
1890 features: NodeFeatures::known(),
1895 addresses: Vec::new(),
1896 excess_address_data: Vec::new(),
1897 excess_data: Vec::new(),
1899 f(&mut unsigned_announcement);
1900 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1902 signature: secp_ctx.sign_ecdsa(&msghash, node_key),
1903 contents: unsigned_announcement
1907 fn get_signed_channel_announcement<F: Fn(&mut UnsignedChannelAnnouncement)>(f: F, node_1_key: &SecretKey, node_2_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> ChannelAnnouncement {
1908 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_key);
1909 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_key);
1910 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1911 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1913 let mut unsigned_announcement = UnsignedChannelAnnouncement {
1914 features: ChannelFeatures::known(),
1915 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1916 short_channel_id: 0,
1919 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1920 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1921 excess_data: Vec::new(),
1923 f(&mut unsigned_announcement);
1924 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1925 ChannelAnnouncement {
1926 node_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_key),
1927 node_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_key),
1928 bitcoin_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_btckey),
1929 bitcoin_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_btckey),
1930 contents: unsigned_announcement,
1934 fn get_channel_script(secp_ctx: &Secp256k1<secp256k1::All>) -> Script {
1935 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1936 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1937 Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1938 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_1_btckey).serialize())
1939 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_2_btckey).serialize())
1940 .push_opcode(opcodes::all::OP_PUSHNUM_2)
1941 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
1945 fn get_signed_channel_update<F: Fn(&mut UnsignedChannelUpdate)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> ChannelUpdate {
1946 let mut unsigned_channel_update = UnsignedChannelUpdate {
1947 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1948 short_channel_id: 0,
1951 cltv_expiry_delta: 144,
1952 htlc_minimum_msat: 1_000_000,
1953 htlc_maximum_msat: 1_000_000,
1954 fee_base_msat: 10_000,
1955 fee_proportional_millionths: 20,
1956 excess_data: Vec::new()
1958 f(&mut unsigned_channel_update);
1959 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1961 signature: secp_ctx.sign_ecdsa(&msghash, node_key),
1962 contents: unsigned_channel_update
1967 fn handling_node_announcements() {
1968 let network_graph = create_network_graph();
1969 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
1971 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1972 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1973 let zero_hash = Sha256dHash::hash(&[0; 32]);
1975 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
1976 match gossip_sync.handle_node_announcement(&valid_announcement) {
1978 Err(e) => assert_eq!("No existing channels for node_announcement", e.err)
1982 // Announce a channel to add a corresponding node.
1983 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
1984 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1985 Ok(res) => assert!(res),
1990 match gossip_sync.handle_node_announcement(&valid_announcement) {
1991 Ok(res) => assert!(res),
1995 let fake_msghash = hash_to_message!(&zero_hash);
1996 match gossip_sync.handle_node_announcement(
1998 signature: secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey),
1999 contents: valid_announcement.contents.clone()
2002 Err(e) => assert_eq!(e.err, "Invalid signature on node_announcement message")
2005 let announcement_with_data = get_signed_node_announcement(|unsigned_announcement| {
2006 unsigned_announcement.timestamp += 1000;
2007 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2008 }, node_1_privkey, &secp_ctx);
2009 // Return false because contains excess data.
2010 match gossip_sync.handle_node_announcement(&announcement_with_data) {
2011 Ok(res) => assert!(!res),
2015 // Even though previous announcement was not relayed further, we still accepted it,
2016 // so we now won't accept announcements before the previous one.
2017 let outdated_announcement = get_signed_node_announcement(|unsigned_announcement| {
2018 unsigned_announcement.timestamp += 1000 - 10;
2019 }, node_1_privkey, &secp_ctx);
2020 match gossip_sync.handle_node_announcement(&outdated_announcement) {
2022 Err(e) => assert_eq!(e.err, "Update older than last processed update")
2027 fn handling_channel_announcements() {
2028 let secp_ctx = Secp256k1::new();
2029 let logger = test_utils::TestLogger::new();
2031 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2032 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2034 let good_script = get_channel_script(&secp_ctx);
2035 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2037 // Test if the UTXO lookups were not supported
2038 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2039 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2040 let mut gossip_sync = P2PGossipSync::new(&network_graph, None, &logger);
2041 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2042 Ok(res) => assert!(res),
2047 match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
2053 // If we receive announcement for the same channel (with UTXO lookups disabled),
2054 // drop new one on the floor, since we can't see any changes.
2055 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2057 Err(e) => assert_eq!(e.err, "Already have knowledge of channel")
2060 // Test if an associated transaction were not on-chain (or not confirmed).
2061 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2062 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
2063 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2064 gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2066 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2067 unsigned_announcement.short_channel_id += 1;
2068 }, node_1_privkey, node_2_privkey, &secp_ctx);
2069 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2071 Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
2074 // Now test if the transaction is found in the UTXO set and the script is correct.
2075 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script.clone() });
2076 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2077 unsigned_announcement.short_channel_id += 2;
2078 }, node_1_privkey, node_2_privkey, &secp_ctx);
2079 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2080 Ok(res) => assert!(res),
2085 match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
2091 // If we receive announcement for the same channel (but TX is not confirmed),
2092 // drop new one on the floor, since we can't see any changes.
2093 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
2094 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2096 Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
2099 // But if it is confirmed, replace the channel
2100 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script });
2101 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2102 unsigned_announcement.features = ChannelFeatures::empty();
2103 unsigned_announcement.short_channel_id += 2;
2104 }, node_1_privkey, node_2_privkey, &secp_ctx);
2105 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2106 Ok(res) => assert!(res),
2110 match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
2111 Some(channel_entry) => {
2112 assert_eq!(channel_entry.features, ChannelFeatures::empty());
2118 // Don't relay valid channels with excess data
2119 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2120 unsigned_announcement.short_channel_id += 3;
2121 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2122 }, node_1_privkey, node_2_privkey, &secp_ctx);
2123 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2124 Ok(res) => assert!(!res),
2128 let mut invalid_sig_announcement = valid_announcement.clone();
2129 invalid_sig_announcement.contents.excess_data = Vec::new();
2130 match gossip_sync.handle_channel_announcement(&invalid_sig_announcement) {
2132 Err(e) => assert_eq!(e.err, "Invalid signature on channel_announcement message")
2135 let channel_to_itself_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_1_privkey, &secp_ctx);
2136 match gossip_sync.handle_channel_announcement(&channel_to_itself_announcement) {
2138 Err(e) => assert_eq!(e.err, "Channel announcement node had a channel with itself")
2143 fn handling_channel_update() {
2144 let secp_ctx = Secp256k1::new();
2145 let logger = test_utils::TestLogger::new();
2146 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2147 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2148 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2149 let gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2151 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2152 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2154 let amount_sats = 1000_000;
2155 let short_channel_id;
2158 // Announce a channel we will update
2159 let good_script = get_channel_script(&secp_ctx);
2160 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: amount_sats, script_pubkey: good_script.clone() });
2162 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2163 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2164 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2171 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2172 match gossip_sync.handle_channel_update(&valid_channel_update) {
2173 Ok(res) => assert!(res),
2178 match network_graph.read_only().channels().get(&short_channel_id) {
2180 Some(channel_info) => {
2181 assert_eq!(channel_info.one_to_two.as_ref().unwrap().cltv_expiry_delta, 144);
2182 assert!(channel_info.two_to_one.is_none());
2187 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2188 unsigned_channel_update.timestamp += 100;
2189 unsigned_channel_update.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2190 }, node_1_privkey, &secp_ctx);
2191 // Return false because contains excess data
2192 match gossip_sync.handle_channel_update(&valid_channel_update) {
2193 Ok(res) => assert!(!res),
2197 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2198 unsigned_channel_update.timestamp += 110;
2199 unsigned_channel_update.short_channel_id += 1;
2200 }, node_1_privkey, &secp_ctx);
2201 match gossip_sync.handle_channel_update(&valid_channel_update) {
2203 Err(e) => assert_eq!(e.err, "Couldn't find channel for update")
2206 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2207 unsigned_channel_update.htlc_maximum_msat = MAX_VALUE_MSAT + 1;
2208 unsigned_channel_update.timestamp += 110;
2209 }, node_1_privkey, &secp_ctx);
2210 match gossip_sync.handle_channel_update(&valid_channel_update) {
2212 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than maximum possible msats")
2215 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2216 unsigned_channel_update.htlc_maximum_msat = amount_sats * 1000 + 1;
2217 unsigned_channel_update.timestamp += 110;
2218 }, node_1_privkey, &secp_ctx);
2219 match gossip_sync.handle_channel_update(&valid_channel_update) {
2221 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than channel capacity or capacity is bogus")
2224 // Even though previous update was not relayed further, we still accepted it,
2225 // so we now won't accept update before the previous one.
2226 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2227 unsigned_channel_update.timestamp += 100;
2228 }, node_1_privkey, &secp_ctx);
2229 match gossip_sync.handle_channel_update(&valid_channel_update) {
2231 Err(e) => assert_eq!(e.err, "Update had same timestamp as last processed update")
2234 let mut invalid_sig_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2235 unsigned_channel_update.timestamp += 500;
2236 }, node_1_privkey, &secp_ctx);
2237 let zero_hash = Sha256dHash::hash(&[0; 32]);
2238 let fake_msghash = hash_to_message!(&zero_hash);
2239 invalid_sig_channel_update.signature = secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey);
2240 match gossip_sync.handle_channel_update(&invalid_sig_channel_update) {
2242 Err(e) => assert_eq!(e.err, "Invalid signature on channel_update message")
2247 fn handling_network_update() {
2248 let logger = test_utils::TestLogger::new();
2249 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2250 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2251 let secp_ctx = Secp256k1::new();
2253 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2254 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2257 // There is no nodes in the table at the beginning.
2258 assert_eq!(network_graph.read_only().nodes().len(), 0);
2261 let short_channel_id;
2263 // Announce a channel we will update
2264 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2265 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2266 let chain_source: Option<&test_utils::TestChainSource> = None;
2267 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source).is_ok());
2268 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2270 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2271 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2273 network_graph.handle_event(&Event::PaymentPathFailed {
2275 payment_hash: PaymentHash([0; 32]),
2276 rejected_by_dest: false,
2277 all_paths_failed: true,
2279 network_update: Some(NetworkUpdate::ChannelUpdateMessage {
2280 msg: valid_channel_update,
2282 short_channel_id: None,
2288 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2291 // Non-permanent closing just disables a channel
2293 match network_graph.read_only().channels().get(&short_channel_id) {
2295 Some(channel_info) => {
2296 assert!(channel_info.one_to_two.as_ref().unwrap().enabled);
2300 network_graph.handle_event(&Event::PaymentPathFailed {
2302 payment_hash: PaymentHash([0; 32]),
2303 rejected_by_dest: false,
2304 all_paths_failed: true,
2306 network_update: Some(NetworkUpdate::ChannelFailure {
2308 is_permanent: false,
2310 short_channel_id: None,
2316 match network_graph.read_only().channels().get(&short_channel_id) {
2318 Some(channel_info) => {
2319 assert!(!channel_info.one_to_two.as_ref().unwrap().enabled);
2324 // Permanent closing deletes a channel
2325 network_graph.handle_event(&Event::PaymentPathFailed {
2327 payment_hash: PaymentHash([0; 32]),
2328 rejected_by_dest: false,
2329 all_paths_failed: true,
2331 network_update: Some(NetworkUpdate::ChannelFailure {
2335 short_channel_id: None,
2341 assert_eq!(network_graph.read_only().channels().len(), 0);
2342 // Nodes are also deleted because there are no associated channels anymore
2343 assert_eq!(network_graph.read_only().nodes().len(), 0);
2344 // TODO: Test NetworkUpdate::NodeFailure, which is not implemented yet.
2348 fn test_channel_timeouts() {
2349 // Test the removal of channels with `remove_stale_channels`.
2350 let logger = test_utils::TestLogger::new();
2351 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2352 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2353 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2354 let gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2355 let secp_ctx = Secp256k1::new();
2357 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2358 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2360 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2361 let short_channel_id = valid_channel_announcement.contents.short_channel_id;
2362 let chain_source: Option<&test_utils::TestChainSource> = None;
2363 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source).is_ok());
2364 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2366 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2367 assert!(gossip_sync.handle_channel_update(&valid_channel_update).is_ok());
2368 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2370 network_graph.remove_stale_channels_with_time(100 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2371 assert_eq!(network_graph.read_only().channels().len(), 1);
2372 assert_eq!(network_graph.read_only().nodes().len(), 2);
2374 network_graph.remove_stale_channels_with_time(101 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2375 #[cfg(feature = "std")]
2377 // In std mode, a further check is performed before fully removing the channel -
2378 // the channel_announcement must have been received at least two weeks ago. We
2379 // fudge that here by indicating the time has jumped two weeks. Note that the
2380 // directional channel information will have been removed already..
2381 assert_eq!(network_graph.read_only().channels().len(), 1);
2382 assert_eq!(network_graph.read_only().nodes().len(), 2);
2383 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2385 use std::time::{SystemTime, UNIX_EPOCH};
2386 let announcement_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2387 network_graph.remove_stale_channels_with_time(announcement_time + 1 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2390 assert_eq!(network_graph.read_only().channels().len(), 0);
2391 assert_eq!(network_graph.read_only().nodes().len(), 0);
2395 fn getting_next_channel_announcements() {
2396 let network_graph = create_network_graph();
2397 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2398 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2399 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2401 // Channels were not announced yet.
2402 let channels_with_announcements = gossip_sync.get_next_channel_announcement(0);
2403 assert!(channels_with_announcements.is_none());
2405 let short_channel_id;
2407 // Announce a channel we will update
2408 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2409 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2410 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2416 // Contains initial channel announcement now.
2417 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2418 if let Some(channel_announcements) = channels_with_announcements {
2419 let (_, ref update_1, ref update_2) = channel_announcements;
2420 assert_eq!(update_1, &None);
2421 assert_eq!(update_2, &None);
2427 // Valid channel update
2428 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2429 unsigned_channel_update.timestamp = 101;
2430 }, node_1_privkey, &secp_ctx);
2431 match gossip_sync.handle_channel_update(&valid_channel_update) {
2437 // Now contains an initial announcement and an update.
2438 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2439 if let Some(channel_announcements) = channels_with_announcements {
2440 let (_, ref update_1, ref update_2) = channel_announcements;
2441 assert_ne!(update_1, &None);
2442 assert_eq!(update_2, &None);
2448 // Channel update with excess data.
2449 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2450 unsigned_channel_update.timestamp = 102;
2451 unsigned_channel_update.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2452 }, node_1_privkey, &secp_ctx);
2453 match gossip_sync.handle_channel_update(&valid_channel_update) {
2459 // Test that announcements with excess data won't be returned
2460 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2461 if let Some(channel_announcements) = channels_with_announcements {
2462 let (_, ref update_1, ref update_2) = channel_announcements;
2463 assert_eq!(update_1, &None);
2464 assert_eq!(update_2, &None);
2469 // Further starting point have no channels after it
2470 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id + 1000);
2471 assert!(channels_with_announcements.is_none());
2475 fn getting_next_node_announcements() {
2476 let network_graph = create_network_graph();
2477 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2478 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2479 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2480 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2483 let next_announcements = gossip_sync.get_next_node_announcement(None);
2484 assert!(next_announcements.is_none());
2487 // Announce a channel to add 2 nodes
2488 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2489 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2495 // Nodes were never announced
2496 let next_announcements = gossip_sync.get_next_node_announcement(None);
2497 assert!(next_announcements.is_none());
2500 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2501 match gossip_sync.handle_node_announcement(&valid_announcement) {
2506 let valid_announcement = get_signed_node_announcement(|_| {}, node_2_privkey, &secp_ctx);
2507 match gossip_sync.handle_node_announcement(&valid_announcement) {
2513 let next_announcements = gossip_sync.get_next_node_announcement(None);
2514 assert!(next_announcements.is_some());
2516 // Skip the first node.
2517 let next_announcements = gossip_sync.get_next_node_announcement(Some(&node_id_1));
2518 assert!(next_announcements.is_some());
2521 // Later announcement which should not be relayed (excess data) prevent us from sharing a node
2522 let valid_announcement = get_signed_node_announcement(|unsigned_announcement| {
2523 unsigned_announcement.timestamp += 10;
2524 unsigned_announcement.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2525 }, node_2_privkey, &secp_ctx);
2526 match gossip_sync.handle_node_announcement(&valid_announcement) {
2527 Ok(res) => assert!(!res),
2532 let next_announcements = gossip_sync.get_next_node_announcement(Some(&node_id_1));
2533 assert!(next_announcements.is_none());
2537 fn network_graph_serialization() {
2538 let network_graph = create_network_graph();
2539 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2541 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2542 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2544 // Announce a channel to add a corresponding node.
2545 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2546 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2547 Ok(res) => assert!(res),
2551 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2552 match gossip_sync.handle_node_announcement(&valid_announcement) {
2557 let mut w = test_utils::TestVecWriter(Vec::new());
2558 assert!(!network_graph.read_only().nodes().is_empty());
2559 assert!(!network_graph.read_only().channels().is_empty());
2560 network_graph.write(&mut w).unwrap();
2562 let logger = Arc::new(test_utils::TestLogger::new());
2563 assert!(<NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), logger).unwrap() == network_graph);
2567 fn network_graph_tlv_serialization() {
2568 let network_graph = create_network_graph();
2569 network_graph.set_last_rapid_gossip_sync_timestamp(42);
2571 let mut w = test_utils::TestVecWriter(Vec::new());
2572 network_graph.write(&mut w).unwrap();
2574 let logger = Arc::new(test_utils::TestLogger::new());
2575 let reassembled_network_graph: NetworkGraph<_> = ReadableArgs::read(&mut io::Cursor::new(&w.0), logger).unwrap();
2576 assert!(reassembled_network_graph == network_graph);
2577 assert_eq!(reassembled_network_graph.get_last_rapid_gossip_sync_timestamp().unwrap(), 42);
2581 #[cfg(feature = "std")]
2582 fn calling_sync_routing_table() {
2583 use std::time::{SystemTime, UNIX_EPOCH};
2585 let network_graph = create_network_graph();
2586 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2587 let node_privkey_1 = &SecretKey::from_slice(&[42; 32]).unwrap();
2588 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_privkey_1);
2590 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2592 // It should ignore if gossip_queries feature is not enabled
2594 let init_msg = Init { features: InitFeatures::known().clear_gossip_queries(), remote_network_address: None };
2595 gossip_sync.peer_connected(&node_id_1, &init_msg);
2596 let events = gossip_sync.get_and_clear_pending_msg_events();
2597 assert_eq!(events.len(), 0);
2600 // It should send a gossip_timestamp_filter with the correct information
2602 let init_msg = Init { features: InitFeatures::known(), remote_network_address: None };
2603 gossip_sync.peer_connected(&node_id_1, &init_msg);
2604 let events = gossip_sync.get_and_clear_pending_msg_events();
2605 assert_eq!(events.len(), 1);
2607 MessageSendEvent::SendGossipTimestampFilter{ node_id, msg } => {
2608 assert_eq!(node_id, &node_id_1);
2609 assert_eq!(msg.chain_hash, chain_hash);
2610 let expected_timestamp = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2611 assert!((msg.first_timestamp as u64) >= expected_timestamp - 60*60*24*7*2);
2612 assert!((msg.first_timestamp as u64) < expected_timestamp - 60*60*24*7*2 + 10);
2613 assert_eq!(msg.timestamp_range, u32::max_value());
2615 _ => panic!("Expected MessageSendEvent::SendChannelRangeQuery")
2621 fn handling_query_channel_range() {
2622 let network_graph = create_network_graph();
2623 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2625 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2626 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2627 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2628 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2630 let mut scids: Vec<u64> = vec![
2631 scid_from_parts(0xfffffe, 0xffffff, 0xffff).unwrap(), // max
2632 scid_from_parts(0xffffff, 0xffffff, 0xffff).unwrap(), // never
2635 // used for testing multipart reply across blocks
2636 for block in 100000..=108001 {
2637 scids.push(scid_from_parts(block, 0, 0).unwrap());
2640 // used for testing resumption on same block
2641 scids.push(scid_from_parts(108001, 1, 0).unwrap());
2644 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2645 unsigned_announcement.short_channel_id = scid;
2646 }, node_1_privkey, node_2_privkey, &secp_ctx);
2647 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2653 // Error when number_of_blocks=0
2654 do_handling_query_channel_range(
2658 chain_hash: chain_hash.clone(),
2660 number_of_blocks: 0,
2663 vec![ReplyChannelRange {
2664 chain_hash: chain_hash.clone(),
2666 number_of_blocks: 0,
2667 sync_complete: true,
2668 short_channel_ids: vec![]
2672 // Error when wrong chain
2673 do_handling_query_channel_range(
2677 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2679 number_of_blocks: 0xffff_ffff,
2682 vec![ReplyChannelRange {
2683 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2685 number_of_blocks: 0xffff_ffff,
2686 sync_complete: true,
2687 short_channel_ids: vec![],
2691 // Error when first_blocknum > 0xffffff
2692 do_handling_query_channel_range(
2696 chain_hash: chain_hash.clone(),
2697 first_blocknum: 0x01000000,
2698 number_of_blocks: 0xffff_ffff,
2701 vec![ReplyChannelRange {
2702 chain_hash: chain_hash.clone(),
2703 first_blocknum: 0x01000000,
2704 number_of_blocks: 0xffff_ffff,
2705 sync_complete: true,
2706 short_channel_ids: vec![]
2710 // Empty reply when max valid SCID block num
2711 do_handling_query_channel_range(
2715 chain_hash: chain_hash.clone(),
2716 first_blocknum: 0xffffff,
2717 number_of_blocks: 1,
2722 chain_hash: chain_hash.clone(),
2723 first_blocknum: 0xffffff,
2724 number_of_blocks: 1,
2725 sync_complete: true,
2726 short_channel_ids: vec![]
2731 // No results in valid query range
2732 do_handling_query_channel_range(
2736 chain_hash: chain_hash.clone(),
2737 first_blocknum: 1000,
2738 number_of_blocks: 1000,
2743 chain_hash: chain_hash.clone(),
2744 first_blocknum: 1000,
2745 number_of_blocks: 1000,
2746 sync_complete: true,
2747 short_channel_ids: vec![],
2752 // Overflow first_blocknum + number_of_blocks
2753 do_handling_query_channel_range(
2757 chain_hash: chain_hash.clone(),
2758 first_blocknum: 0xfe0000,
2759 number_of_blocks: 0xffffffff,
2764 chain_hash: chain_hash.clone(),
2765 first_blocknum: 0xfe0000,
2766 number_of_blocks: 0xffffffff - 0xfe0000,
2767 sync_complete: true,
2768 short_channel_ids: vec![
2769 0xfffffe_ffffff_ffff, // max
2775 // Single block exactly full
2776 do_handling_query_channel_range(
2780 chain_hash: chain_hash.clone(),
2781 first_blocknum: 100000,
2782 number_of_blocks: 8000,
2787 chain_hash: chain_hash.clone(),
2788 first_blocknum: 100000,
2789 number_of_blocks: 8000,
2790 sync_complete: true,
2791 short_channel_ids: (100000..=107999)
2792 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2798 // Multiple split on new block
2799 do_handling_query_channel_range(
2803 chain_hash: chain_hash.clone(),
2804 first_blocknum: 100000,
2805 number_of_blocks: 8001,
2810 chain_hash: chain_hash.clone(),
2811 first_blocknum: 100000,
2812 number_of_blocks: 7999,
2813 sync_complete: false,
2814 short_channel_ids: (100000..=107999)
2815 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2819 chain_hash: chain_hash.clone(),
2820 first_blocknum: 107999,
2821 number_of_blocks: 2,
2822 sync_complete: true,
2823 short_channel_ids: vec![
2824 scid_from_parts(108000, 0, 0).unwrap(),
2830 // Multiple split on same block
2831 do_handling_query_channel_range(
2835 chain_hash: chain_hash.clone(),
2836 first_blocknum: 100002,
2837 number_of_blocks: 8000,
2842 chain_hash: chain_hash.clone(),
2843 first_blocknum: 100002,
2844 number_of_blocks: 7999,
2845 sync_complete: false,
2846 short_channel_ids: (100002..=108001)
2847 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2851 chain_hash: chain_hash.clone(),
2852 first_blocknum: 108001,
2853 number_of_blocks: 1,
2854 sync_complete: true,
2855 short_channel_ids: vec![
2856 scid_from_parts(108001, 1, 0).unwrap(),
2863 fn do_handling_query_channel_range(
2864 gossip_sync: &P2PGossipSync<&NetworkGraph<Arc<test_utils::TestLogger>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2865 test_node_id: &PublicKey,
2866 msg: QueryChannelRange,
2868 expected_replies: Vec<ReplyChannelRange>
2870 let mut max_firstblocknum = msg.first_blocknum.saturating_sub(1);
2871 let mut c_lightning_0_9_prev_end_blocknum = max_firstblocknum;
2872 let query_end_blocknum = msg.end_blocknum();
2873 let result = gossip_sync.handle_query_channel_range(test_node_id, msg);
2876 assert!(result.is_ok());
2878 assert!(result.is_err());
2881 let events = gossip_sync.get_and_clear_pending_msg_events();
2882 assert_eq!(events.len(), expected_replies.len());
2884 for i in 0..events.len() {
2885 let expected_reply = &expected_replies[i];
2887 MessageSendEvent::SendReplyChannelRange { node_id, msg } => {
2888 assert_eq!(node_id, test_node_id);
2889 assert_eq!(msg.chain_hash, expected_reply.chain_hash);
2890 assert_eq!(msg.first_blocknum, expected_reply.first_blocknum);
2891 assert_eq!(msg.number_of_blocks, expected_reply.number_of_blocks);
2892 assert_eq!(msg.sync_complete, expected_reply.sync_complete);
2893 assert_eq!(msg.short_channel_ids, expected_reply.short_channel_ids);
2895 // Enforce exactly the sequencing requirements present on c-lightning v0.9.3
2896 assert!(msg.first_blocknum == c_lightning_0_9_prev_end_blocknum || msg.first_blocknum == c_lightning_0_9_prev_end_blocknum.saturating_add(1));
2897 assert!(msg.first_blocknum >= max_firstblocknum);
2898 max_firstblocknum = msg.first_blocknum;
2899 c_lightning_0_9_prev_end_blocknum = msg.first_blocknum.saturating_add(msg.number_of_blocks);
2901 // Check that the last block count is >= the query's end_blocknum
2902 if i == events.len() - 1 {
2903 assert!(msg.first_blocknum.saturating_add(msg.number_of_blocks) >= query_end_blocknum);
2906 _ => panic!("expected MessageSendEvent::SendReplyChannelRange"),
2912 fn handling_query_short_channel_ids() {
2913 let network_graph = create_network_graph();
2914 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2915 let node_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2916 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2918 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2920 let result = gossip_sync.handle_query_short_channel_ids(&node_id, QueryShortChannelIds {
2922 short_channel_ids: vec![0x0003e8_000000_0000],
2924 assert!(result.is_err());
2928 fn displays_node_alias() {
2929 let format_str_alias = |alias: &str| {
2930 let mut bytes = [0u8; 32];
2931 bytes[..alias.as_bytes().len()].copy_from_slice(alias.as_bytes());
2932 format!("{}", NodeAlias(bytes))
2935 assert_eq!(format_str_alias("I\u{1F496}LDK! \u{26A1}"), "I\u{1F496}LDK! \u{26A1}");
2936 assert_eq!(format_str_alias("I\u{1F496}LDK!\0\u{26A1}"), "I\u{1F496}LDK!");
2937 assert_eq!(format_str_alias("I\u{1F496}LDK!\t\u{26A1}"), "I\u{1F496}LDK!\u{FFFD}\u{26A1}");
2939 let format_bytes_alias = |alias: &[u8]| {
2940 let mut bytes = [0u8; 32];
2941 bytes[..alias.len()].copy_from_slice(alias);
2942 format!("{}", NodeAlias(bytes))
2945 assert_eq!(format_bytes_alias(b"\xFFI <heart> LDK!"), "\u{FFFD}I <heart> LDK!");
2946 assert_eq!(format_bytes_alias(b"\xFFI <heart>\0LDK!"), "\u{FFFD}I <heart>");
2947 assert_eq!(format_bytes_alias(b"\xFFI <heart>\tLDK!"), "\u{FFFD}I <heart>\u{FFFD}LDK!");
2951 fn channel_info_is_readable() {
2952 let chanmon_cfgs = ::ln::functional_test_utils::create_chanmon_cfgs(2);
2953 let node_cfgs = ::ln::functional_test_utils::create_node_cfgs(2, &chanmon_cfgs);
2954 let node_chanmgrs = ::ln::functional_test_utils::create_node_chanmgrs(2, &node_cfgs, &[None, None, None, None]);
2955 let nodes = ::ln::functional_test_utils::create_network(2, &node_cfgs, &node_chanmgrs);
2957 // 1. Test encoding/decoding of ChannelUpdateInfo
2958 let chan_update_info = ChannelUpdateInfo {
2961 cltv_expiry_delta: 42,
2962 htlc_minimum_msat: 1234,
2963 htlc_maximum_msat: 5678,
2964 fees: RoutingFees { base_msat: 9, proportional_millionths: 10 },
2965 last_update_message: None,
2968 let mut encoded_chan_update_info: Vec<u8> = Vec::new();
2969 assert!(chan_update_info.write(&mut encoded_chan_update_info).is_ok());
2971 // First make sure we can read ChannelUpdateInfos we just wrote
2972 let read_chan_update_info: ChannelUpdateInfo = ::util::ser::Readable::read(&mut encoded_chan_update_info.as_slice()).unwrap();
2973 assert_eq!(chan_update_info, read_chan_update_info);
2975 // Check the serialization hasn't changed.
2976 let legacy_chan_update_info_with_some: Vec<u8> = hex::decode("340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c0100").unwrap();
2977 assert_eq!(encoded_chan_update_info, legacy_chan_update_info_with_some);
2979 // Check we fail if htlc_maximum_msat is not present in either the ChannelUpdateInfo itself
2980 // or the ChannelUpdate enclosed with `last_update_message`.
2981 let legacy_chan_update_info_with_some_and_fail_update: Vec<u8> = hex::decode("b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f42400000271000000014").unwrap();
2982 let read_chan_update_info_res: Result<ChannelUpdateInfo, ::ln::msgs::DecodeError> = ::util::ser::Readable::read(&mut legacy_chan_update_info_with_some_and_fail_update.as_slice());
2983 assert!(read_chan_update_info_res.is_err());
2985 let legacy_chan_update_info_with_none: Vec<u8> = hex::decode("2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c0100").unwrap();
2986 let read_chan_update_info_res: Result<ChannelUpdateInfo, ::ln::msgs::DecodeError> = ::util::ser::Readable::read(&mut legacy_chan_update_info_with_none.as_slice());
2987 assert!(read_chan_update_info_res.is_err());
2989 // 2. Test encoding/decoding of ChannelInfo
2990 // Check we can encode/decode ChannelInfo without ChannelUpdateInfo fields present.
2991 let chan_info_none_updates = ChannelInfo {
2992 features: ChannelFeatures::known(),
2993 node_one: NodeId::from_pubkey(&nodes[0].node.get_our_node_id()),
2995 node_two: NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
2997 capacity_sats: None,
2998 announcement_message: None,
2999 announcement_received_time: 87654,
3002 let mut encoded_chan_info: Vec<u8> = Vec::new();
3003 assert!(chan_info_none_updates.write(&mut encoded_chan_info).is_ok());
3005 let read_chan_info: ChannelInfo = ::util::ser::Readable::read(&mut encoded_chan_info.as_slice()).unwrap();
3006 assert_eq!(chan_info_none_updates, read_chan_info);
3008 // Check we can encode/decode ChannelInfo with ChannelUpdateInfo fields present.
3009 let chan_info_some_updates = ChannelInfo {
3010 features: ChannelFeatures::known(),
3011 node_one: NodeId::from_pubkey(&nodes[0].node.get_our_node_id()),
3012 one_to_two: Some(chan_update_info.clone()),
3013 node_two: NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
3014 two_to_one: Some(chan_update_info.clone()),
3015 capacity_sats: None,
3016 announcement_message: None,
3017 announcement_received_time: 87654,
3020 let mut encoded_chan_info: Vec<u8> = Vec::new();
3021 assert!(chan_info_some_updates.write(&mut encoded_chan_info).is_ok());
3023 let read_chan_info: ChannelInfo = ::util::ser::Readable::read(&mut encoded_chan_info.as_slice()).unwrap();
3024 assert_eq!(chan_info_some_updates, read_chan_info);
3026 // Check the serialization hasn't changed.
3027 let legacy_chan_info_with_some: Vec<u8> = hex::decode("ca00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce88043636340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c010006210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c23083636340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c01000a01000c0100").unwrap();
3028 assert_eq!(encoded_chan_info, legacy_chan_info_with_some);
3030 // Check we can decode legacy ChannelInfo, even if the `two_to_one` / `one_to_two` /
3031 // `last_update_message` fields fail to decode due to missing htlc_maximum_msat.
3032 let legacy_chan_info_with_some_and_fail_update = hex::decode("fd01ca00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce8804b6b6b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f4240000027100000001406210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c2308b6b6b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f424000002710000000140a01000c0100").unwrap();
3033 let read_chan_info: ChannelInfo = ::util::ser::Readable::read(&mut legacy_chan_info_with_some_and_fail_update.as_slice()).unwrap();
3034 assert_eq!(read_chan_info.announcement_received_time, 87654);
3035 assert_eq!(read_chan_info.one_to_two, None);
3036 assert_eq!(read_chan_info.two_to_one, None);
3038 let legacy_chan_info_with_none: Vec<u8> = hex::decode("ba00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce88042e2e2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c010006210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c23082e2e2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c01000a01000c0100").unwrap();
3039 let read_chan_info: ChannelInfo = ::util::ser::Readable::read(&mut legacy_chan_info_with_none.as_slice()).unwrap();
3040 assert_eq!(read_chan_info.announcement_received_time, 87654);
3041 assert_eq!(read_chan_info.one_to_two, None);
3042 assert_eq!(read_chan_info.two_to_one, None);
3046 fn node_info_is_readable() {
3047 use std::convert::TryFrom;
3049 // 1. Check we can read a valid NodeAnnouncementInfo and fail on an invalid one
3050 let valid_netaddr = ::ln::msgs::NetAddress::Hostname { hostname: ::util::ser::Hostname::try_from("A".to_string()).unwrap(), port: 1234 };
3051 let valid_node_ann_info = NodeAnnouncementInfo {
3052 features: NodeFeatures::known(),
3055 alias: NodeAlias([0u8; 32]),
3056 addresses: vec![valid_netaddr],
3057 announcement_message: None,
3060 let mut encoded_valid_node_ann_info = Vec::new();
3061 assert!(valid_node_ann_info.write(&mut encoded_valid_node_ann_info).is_ok());
3062 let read_valid_node_ann_info: NodeAnnouncementInfo = ::util::ser::Readable::read(&mut encoded_valid_node_ann_info.as_slice()).unwrap();
3063 assert_eq!(read_valid_node_ann_info, valid_node_ann_info);
3065 let encoded_invalid_node_ann_info = hex::decode("3f0009000788a000080a51a20204000000000403000000062000000000000000000000000000000000000000000000000000000000000000000a0505014004d2").unwrap();
3066 let read_invalid_node_ann_info_res: Result<NodeAnnouncementInfo, ::ln::msgs::DecodeError> = ::util::ser::Readable::read(&mut encoded_invalid_node_ann_info.as_slice());
3067 assert!(read_invalid_node_ann_info_res.is_err());
3069 // 2. Check we can read a NodeInfo anyways, but set the NodeAnnouncementInfo to None if invalid
3070 let valid_node_info = NodeInfo {
3071 channels: Vec::new(),
3072 lowest_inbound_channel_fees: None,
3073 announcement_info: Some(valid_node_ann_info),
3076 let mut encoded_valid_node_info = Vec::new();
3077 assert!(valid_node_info.write(&mut encoded_valid_node_info).is_ok());
3078 let read_valid_node_info: NodeInfo = ::util::ser::Readable::read(&mut encoded_valid_node_info.as_slice()).unwrap();
3079 assert_eq!(read_valid_node_info, valid_node_info);
3081 let encoded_invalid_node_info_hex = hex::decode("4402403f0009000788a000080a51a20204000000000403000000062000000000000000000000000000000000000000000000000000000000000000000a0505014004d20400").unwrap();
3082 let read_invalid_node_info: NodeInfo = ::util::ser::Readable::read(&mut encoded_invalid_node_info_hex.as_slice()).unwrap();
3083 assert_eq!(read_invalid_node_info.announcement_info, None);
3087 #[cfg(all(test, feature = "_bench_unstable"))]
3095 fn read_network_graph(bench: &mut Bencher) {
3096 let logger = ::util::test_utils::TestLogger::new();
3097 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
3098 let mut v = Vec::new();
3099 d.read_to_end(&mut v).unwrap();
3101 let _ = NetworkGraph::read(&mut std::io::Cursor::new(&v), &logger).unwrap();
3106 fn write_network_graph(bench: &mut Bencher) {
3107 let logger = ::util::test_utils::TestLogger::new();
3108 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
3109 let net_graph = NetworkGraph::read(&mut d, &logger).unwrap();
3111 let _ = net_graph.encode();