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 [`NetworkGraph`] stores the network gossip and [`P2PGossipSync`] fetches it from peers
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::transaction::TxOut;
20 use bitcoin::hash_types::BlockHash;
22 use crate::ln::chan_utils::make_funding_redeemscript_from_slices;
23 use crate::ln::features::{ChannelFeatures, NodeFeatures, InitFeatures};
24 use crate::ln::msgs::{DecodeError, ErrorAction, Init, LightningError, RoutingMessageHandler, NetAddress, MAX_VALUE_MSAT};
25 use crate::ln::msgs::{ChannelAnnouncement, ChannelUpdate, NodeAnnouncement, GossipTimestampFilter};
26 use crate::ln::msgs::{QueryChannelRange, ReplyChannelRange, QueryShortChannelIds, ReplyShortChannelIdsEnd};
28 use crate::routing::utxo::{UtxoLookup, UtxoLookupError};
29 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer, MaybeReadable};
30 use crate::util::logger::{Logger, Level};
31 use crate::util::events::{MessageSendEvent, MessageSendEventsProvider};
32 use crate::util::scid_utils::{block_from_scid, scid_from_parts, MAX_SCID_BLOCK};
33 use crate::util::string::PrintableString;
34 use crate::util::indexed_map::{IndexedMap, Entry as IndexedMapEntry};
37 use crate::io_extras::{copy, sink};
38 use crate::prelude::*;
40 use crate::sync::{RwLock, RwLockReadGuard};
41 #[cfg(feature = "std")]
42 use core::sync::atomic::{AtomicUsize, Ordering};
43 use crate::sync::Mutex;
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 /// We stop tracking the removal of permanently failed nodes and channels one week after removal
55 const REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS: u64 = 60 * 60 * 24 * 7;
57 /// The maximum number of extra bytes which we do not understand in a gossip message before we will
58 /// refuse to relay the message.
59 const MAX_EXCESS_BYTES_FOR_RELAY: usize = 1024;
61 /// Maximum number of short_channel_ids that will be encoded in one gossip reply message.
62 /// This value ensures a reply fits within the 65k payload limit and is consistent with other implementations.
63 const MAX_SCIDS_PER_REPLY: usize = 8000;
65 /// Represents the compressed public key of a node
66 #[derive(Clone, Copy)]
67 pub struct NodeId([u8; PUBLIC_KEY_SIZE]);
70 /// Create a new NodeId from a public key
71 pub fn from_pubkey(pubkey: &PublicKey) -> Self {
72 NodeId(pubkey.serialize())
75 /// Get the public key slice from this NodeId
76 pub fn as_slice(&self) -> &[u8] {
81 impl fmt::Debug for NodeId {
82 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
83 write!(f, "NodeId({})", log_bytes!(self.0))
86 impl fmt::Display for NodeId {
87 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
88 write!(f, "{}", log_bytes!(self.0))
92 impl core::hash::Hash for NodeId {
93 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
100 impl PartialEq for NodeId {
101 fn eq(&self, other: &Self) -> bool {
102 self.0[..] == other.0[..]
106 impl cmp::PartialOrd for NodeId {
107 fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
108 Some(self.cmp(other))
112 impl Ord for NodeId {
113 fn cmp(&self, other: &Self) -> cmp::Ordering {
114 self.0[..].cmp(&other.0[..])
118 impl Writeable for NodeId {
119 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
120 writer.write_all(&self.0)?;
125 impl Readable for NodeId {
126 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
127 let mut buf = [0; PUBLIC_KEY_SIZE];
128 reader.read_exact(&mut buf)?;
133 /// Represents the network as nodes and channels between them
134 pub struct NetworkGraph<L: Deref> where L::Target: Logger {
135 secp_ctx: Secp256k1<secp256k1::VerifyOnly>,
136 last_rapid_gossip_sync_timestamp: Mutex<Option<u32>>,
137 genesis_hash: BlockHash,
139 // Lock order: channels -> nodes
140 channels: RwLock<IndexedMap<u64, ChannelInfo>>,
141 nodes: RwLock<IndexedMap<NodeId, NodeInfo>>,
142 // Lock order: removed_channels -> removed_nodes
144 // NOTE: In the following `removed_*` maps, we use seconds since UNIX epoch to track time instead
145 // of `std::time::Instant`s for a few reasons:
146 // * We want it to be possible to do tracking in no-std environments where we can compare
147 // a provided current UNIX timestamp with the time at which we started tracking.
148 // * In the future, if we decide to persist these maps, they will already be serializable.
149 // * Although we lose out on the platform's monotonic clock, the system clock in a std
150 // environment should be practical over the time period we are considering (on the order of a
153 /// Keeps track of short channel IDs for channels we have explicitly removed due to permanent
154 /// failure so that we don't resync them from gossip. Each SCID is mapped to the time (in seconds)
155 /// it was removed so that once some time passes, we can potentially resync it from gossip again.
156 removed_channels: Mutex<HashMap<u64, Option<u64>>>,
157 /// Keeps track of `NodeId`s we have explicitly removed due to permanent failure so that we don't
158 /// resync them from gossip. Each `NodeId` is mapped to the time (in seconds) it was removed so
159 /// that once some time passes, we can potentially resync it from gossip again.
160 removed_nodes: Mutex<HashMap<NodeId, Option<u64>>>,
163 /// A read-only view of [`NetworkGraph`].
164 pub struct ReadOnlyNetworkGraph<'a> {
165 channels: RwLockReadGuard<'a, IndexedMap<u64, ChannelInfo>>,
166 nodes: RwLockReadGuard<'a, IndexedMap<NodeId, NodeInfo>>,
169 /// Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
170 /// return packet by a node along the route. See [BOLT #4] for details.
172 /// [BOLT #4]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
173 #[derive(Clone, Debug, PartialEq, Eq)]
174 pub enum NetworkUpdate {
175 /// An error indicating a `channel_update` messages should be applied via
176 /// [`NetworkGraph::update_channel`].
177 ChannelUpdateMessage {
178 /// The update to apply via [`NetworkGraph::update_channel`].
181 /// An error indicating that a channel failed to route a payment, which should be applied via
182 /// [`NetworkGraph::channel_failed`].
184 /// The short channel id of the closed channel.
185 short_channel_id: u64,
186 /// Whether the channel should be permanently removed or temporarily disabled until a new
187 /// `channel_update` message is received.
190 /// An error indicating that a node failed to route a payment, which should be applied via
191 /// [`NetworkGraph::node_failed_permanent`] if permanent.
193 /// The node id of the failed node.
195 /// Whether the node should be permanently removed from consideration or can be restored
196 /// when a new `channel_update` message is received.
201 impl_writeable_tlv_based_enum_upgradable!(NetworkUpdate,
202 (0, ChannelUpdateMessage) => {
205 (2, ChannelFailure) => {
206 (0, short_channel_id, required),
207 (2, is_permanent, required),
209 (4, NodeFailure) => {
210 (0, node_id, required),
211 (2, is_permanent, required),
215 /// Receives and validates network updates from peers,
216 /// stores authentic and relevant data as a network graph.
217 /// This network graph is then used for routing payments.
218 /// Provides interface to help with initial routing sync by
219 /// serving historical announcements.
220 pub struct P2PGossipSync<G: Deref<Target=NetworkGraph<L>>, U: Deref, L: Deref>
221 where U::Target: UtxoLookup, L::Target: Logger
224 utxo_lookup: Option<U>,
225 #[cfg(feature = "std")]
226 full_syncs_requested: AtomicUsize,
227 pending_events: Mutex<Vec<MessageSendEvent>>,
231 impl<G: Deref<Target=NetworkGraph<L>>, U: Deref, L: Deref> P2PGossipSync<G, U, L>
232 where U::Target: UtxoLookup, L::Target: Logger
234 /// Creates a new tracker of the actual state of the network of channels and nodes,
235 /// assuming an existing Network Graph.
236 /// UTXO lookup is used to make sure announced channels exist on-chain, channel data is
237 /// correct, and the announcement is signed with channel owners' keys.
238 pub fn new(network_graph: G, utxo_lookup: Option<U>, logger: L) -> Self {
241 #[cfg(feature = "std")]
242 full_syncs_requested: AtomicUsize::new(0),
244 pending_events: Mutex::new(vec![]),
249 /// Adds a provider used to check new announcements. Does not affect
250 /// existing announcements unless they are updated.
251 /// Add, update or remove the provider would replace the current one.
252 pub fn add_utxo_lookup(&mut self, utxo_lookup: Option<U>) {
253 self.utxo_lookup = utxo_lookup;
256 /// Gets a reference to the underlying [`NetworkGraph`] which was provided in
257 /// [`P2PGossipSync::new`].
259 /// (C-not exported) as bindings don't support a reference-to-a-reference yet
260 pub fn network_graph(&self) -> &G {
264 #[cfg(feature = "std")]
265 /// Returns true when a full routing table sync should be performed with a peer.
266 fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
267 //TODO: Determine whether to request a full sync based on the network map.
268 const FULL_SYNCS_TO_REQUEST: usize = 5;
269 if self.full_syncs_requested.load(Ordering::Acquire) < FULL_SYNCS_TO_REQUEST {
270 self.full_syncs_requested.fetch_add(1, Ordering::AcqRel);
278 impl<L: Deref> NetworkGraph<L> where L::Target: Logger {
279 /// Handles any network updates originating from [`Event`]s.
281 /// [`Event`]: crate::util::events::Event
282 pub fn handle_network_update(&self, network_update: &NetworkUpdate) {
283 match *network_update {
284 NetworkUpdate::ChannelUpdateMessage { ref msg } => {
285 let short_channel_id = msg.contents.short_channel_id;
286 let is_enabled = msg.contents.flags & (1 << 1) != (1 << 1);
287 let status = if is_enabled { "enabled" } else { "disabled" };
288 log_debug!(self.logger, "Updating channel with channel_update from a payment failure. Channel {} is {}.", short_channel_id, status);
289 let _ = self.update_channel(msg);
291 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } => {
292 let action = if is_permanent { "Removing" } else { "Disabling" };
293 log_debug!(self.logger, "{} channel graph entry for {} due to a payment failure.", action, short_channel_id);
294 self.channel_failed(short_channel_id, is_permanent);
296 NetworkUpdate::NodeFailure { ref node_id, is_permanent } => {
298 log_debug!(self.logger,
299 "Removed node graph entry for {} due to a payment failure.", log_pubkey!(node_id));
300 self.node_failed_permanent(node_id);
307 macro_rules! secp_verify_sig {
308 ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr, $msg_type: expr ) => {
309 match $secp_ctx.verify_ecdsa($msg, $sig, $pubkey) {
312 return Err(LightningError {
313 err: format!("Invalid signature on {} message", $msg_type),
314 action: ErrorAction::SendWarningMessage {
315 msg: msgs::WarningMessage {
317 data: format!("Invalid signature on {} message", $msg_type),
319 log_level: Level::Trace,
327 macro_rules! get_pubkey_from_node_id {
328 ( $node_id: expr, $msg_type: expr ) => {
329 PublicKey::from_slice($node_id.as_slice())
330 .map_err(|_| LightningError {
331 err: format!("Invalid public key on {} message", $msg_type),
332 action: ErrorAction::SendWarningMessage {
333 msg: msgs::WarningMessage {
335 data: format!("Invalid public key on {} message", $msg_type),
337 log_level: Level::Trace
343 impl<G: Deref<Target=NetworkGraph<L>>, U: Deref, L: Deref> RoutingMessageHandler for P2PGossipSync<G, U, L>
344 where U::Target: UtxoLookup, L::Target: Logger
346 fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
347 self.network_graph.update_node_from_announcement(msg)?;
348 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
349 msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
350 msg.contents.excess_data.len() + msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
353 fn handle_channel_announcement(&self, msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
354 self.network_graph.update_channel_from_announcement(msg, &self.utxo_lookup)?;
355 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 { "" });
356 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
359 fn handle_channel_update(&self, msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
360 self.network_graph.update_channel(msg)?;
361 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
364 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)> {
365 let channels = self.network_graph.channels.read().unwrap();
366 for (_, ref chan) in channels.range(starting_point..) {
367 if chan.announcement_message.is_some() {
368 let chan_announcement = chan.announcement_message.clone().unwrap();
369 let mut one_to_two_announcement: Option<msgs::ChannelUpdate> = None;
370 let mut two_to_one_announcement: Option<msgs::ChannelUpdate> = None;
371 if let Some(one_to_two) = chan.one_to_two.as_ref() {
372 one_to_two_announcement = one_to_two.last_update_message.clone();
374 if let Some(two_to_one) = chan.two_to_one.as_ref() {
375 two_to_one_announcement = two_to_one.last_update_message.clone();
377 return Some((chan_announcement, one_to_two_announcement, two_to_one_announcement));
379 // TODO: We may end up sending un-announced channel_updates if we are sending
380 // initial sync data while receiving announce/updates for this channel.
386 fn get_next_node_announcement(&self, starting_point: Option<&NodeId>) -> Option<NodeAnnouncement> {
387 let nodes = self.network_graph.nodes.read().unwrap();
388 let iter = if let Some(node_id) = starting_point {
389 nodes.range((Bound::Excluded(node_id), Bound::Unbounded))
393 for (_, ref node) in iter {
394 if let Some(node_info) = node.announcement_info.as_ref() {
395 if let Some(msg) = node_info.announcement_message.clone() {
403 /// Initiates a stateless sync of routing gossip information with a peer
404 /// using gossip_queries. The default strategy used by this implementation
405 /// is to sync the full block range with several peers.
407 /// We should expect one or more reply_channel_range messages in response
408 /// to our query_channel_range. Each reply will enqueue a query_scid message
409 /// to request gossip messages for each channel. The sync is considered complete
410 /// when the final reply_scids_end message is received, though we are not
411 /// tracking this directly.
412 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &Init) -> Result<(), ()> {
413 // We will only perform a sync with peers that support gossip_queries.
414 if !init_msg.features.supports_gossip_queries() {
415 // Don't disconnect peers for not supporting gossip queries. We may wish to have
416 // channels with peers even without being able to exchange gossip.
420 // The lightning network's gossip sync system is completely broken in numerous ways.
422 // Given no broadly-available set-reconciliation protocol, the only reasonable approach is
423 // to do a full sync from the first few peers we connect to, and then receive gossip
424 // updates from all our peers normally.
426 // Originally, we could simply tell a peer to dump us the entire gossip table on startup,
427 // wasting lots of bandwidth but ensuring we have the full network graph. After the initial
428 // dump peers would always send gossip and we'd stay up-to-date with whatever our peer has
431 // In order to reduce the bandwidth waste, "gossip queries" were introduced, allowing you
432 // to ask for the SCIDs of all channels in your peer's routing graph, and then only request
433 // channel data which you are missing. Except there was no way at all to identify which
434 // `channel_update`s you were missing, so you still had to request everything, just in a
435 // very complicated way with some queries instead of just getting the dump.
437 // Later, an option was added to fetch the latest timestamps of the `channel_update`s to
438 // make efficient sync possible, however it has yet to be implemented in lnd, which makes
439 // relying on it useless.
441 // After gossip queries were introduced, support for receiving a full gossip table dump on
442 // connection was removed from several nodes, making it impossible to get a full sync
443 // without using the "gossip queries" messages.
445 // Once you opt into "gossip queries" the only way to receive any gossip updates that a
446 // peer receives after you connect, you must send a `gossip_timestamp_filter` message. This
447 // message, as the name implies, tells the peer to not forward any gossip messages with a
448 // timestamp older than a given value (not the time the peer received the filter, but the
449 // timestamp in the update message, which is often hours behind when the peer received the
452 // Obnoxiously, `gossip_timestamp_filter` isn't *just* a filter, but its also a request for
453 // your peer to send you the full routing graph (subject to the filter). Thus, in order to
454 // tell a peer to send you any updates as it sees them, you have to also ask for the full
455 // routing graph to be synced. If you set a timestamp filter near the current time, peers
456 // will simply not forward any new updates they see to you which were generated some time
457 // ago (which is not uncommon). If you instead set a timestamp filter near 0 (or two weeks
458 // ago), you will always get the full routing graph from all your peers.
460 // Most lightning nodes today opt to simply turn off receiving gossip data which only
461 // propagated some time after it was generated, and, worse, often disable gossiping with
462 // several peers after their first connection. The second behavior can cause gossip to not
463 // propagate fully if there are cuts in the gossiping subgraph.
465 // In an attempt to cut a middle ground between always fetching the full graph from all of
466 // our peers and never receiving gossip from peers at all, we send all of our peers a
467 // `gossip_timestamp_filter`, with the filter time set either two weeks ago or an hour ago.
469 // For no-std builds, we bury our head in the sand and do a full sync on each connection.
470 #[allow(unused_mut, unused_assignments)]
471 let mut gossip_start_time = 0;
472 #[cfg(feature = "std")]
474 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
475 if self.should_request_full_sync(&their_node_id) {
476 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
478 gossip_start_time -= 60 * 60; // an hour ago
482 let mut pending_events = self.pending_events.lock().unwrap();
483 pending_events.push(MessageSendEvent::SendGossipTimestampFilter {
484 node_id: their_node_id.clone(),
485 msg: GossipTimestampFilter {
486 chain_hash: self.network_graph.genesis_hash,
487 first_timestamp: gossip_start_time as u32, // 2106 issue!
488 timestamp_range: u32::max_value(),
494 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: ReplyChannelRange) -> Result<(), LightningError> {
495 // We don't make queries, so should never receive replies. If, in the future, the set
496 // reconciliation extensions to gossip queries become broadly supported, we should revert
497 // this code to its state pre-0.0.106.
501 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError> {
502 // We don't make queries, so should never receive replies. If, in the future, the set
503 // reconciliation extensions to gossip queries become broadly supported, we should revert
504 // this code to its state pre-0.0.106.
508 /// Processes a query from a peer by finding announced/public channels whose funding UTXOs
509 /// are in the specified block range. Due to message size limits, large range
510 /// queries may result in several reply messages. This implementation enqueues
511 /// all reply messages into pending events. Each message will allocate just under 65KiB. A full
512 /// sync of the public routing table with 128k channels will generated 16 messages and allocate ~1MB.
513 /// Logic can be changed to reduce allocation if/when a full sync of the routing table impacts
514 /// memory constrained systems.
515 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError> {
516 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);
518 let inclusive_start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0);
520 // We might receive valid queries with end_blocknum that would overflow SCID conversion.
521 // If so, we manually cap the ending block to avoid this overflow.
522 let exclusive_end_scid = scid_from_parts(cmp::min(msg.end_blocknum() as u64, MAX_SCID_BLOCK), 0, 0);
524 // Per spec, we must reply to a query. Send an empty message when things are invalid.
525 if msg.chain_hash != self.network_graph.genesis_hash || inclusive_start_scid.is_err() || exclusive_end_scid.is_err() || msg.number_of_blocks == 0 {
526 let mut pending_events = self.pending_events.lock().unwrap();
527 pending_events.push(MessageSendEvent::SendReplyChannelRange {
528 node_id: their_node_id.clone(),
529 msg: ReplyChannelRange {
530 chain_hash: msg.chain_hash.clone(),
531 first_blocknum: msg.first_blocknum,
532 number_of_blocks: msg.number_of_blocks,
534 short_channel_ids: vec![],
537 return Err(LightningError {
538 err: String::from("query_channel_range could not be processed"),
539 action: ErrorAction::IgnoreError,
543 // Creates channel batches. We are not checking if the channel is routable
544 // (has at least one update). A peer may still want to know the channel
545 // exists even if its not yet routable.
546 let mut batches: Vec<Vec<u64>> = vec![Vec::with_capacity(MAX_SCIDS_PER_REPLY)];
547 let channels = self.network_graph.channels.read().unwrap();
548 for (_, ref chan) in channels.range(inclusive_start_scid.unwrap()..exclusive_end_scid.unwrap()) {
549 if let Some(chan_announcement) = &chan.announcement_message {
550 // Construct a new batch if last one is full
551 if batches.last().unwrap().len() == batches.last().unwrap().capacity() {
552 batches.push(Vec::with_capacity(MAX_SCIDS_PER_REPLY));
555 let batch = batches.last_mut().unwrap();
556 batch.push(chan_announcement.contents.short_channel_id);
561 let mut pending_events = self.pending_events.lock().unwrap();
562 let batch_count = batches.len();
563 let mut prev_batch_endblock = msg.first_blocknum;
564 for (batch_index, batch) in batches.into_iter().enumerate() {
565 // Per spec, the initial `first_blocknum` needs to be <= the query's `first_blocknum`
566 // and subsequent `first_blocknum`s must be >= the prior reply's `first_blocknum`.
568 // Additionally, c-lightning versions < 0.10 require that the `first_blocknum` of each
569 // reply is >= the previous reply's `first_blocknum` and either exactly the previous
570 // reply's `first_blocknum + number_of_blocks` or exactly one greater. This is a
571 // significant diversion from the requirements set by the spec, and, in case of blocks
572 // with no channel opens (e.g. empty blocks), requires that we use the previous value
573 // and *not* derive the first_blocknum from the actual first block of the reply.
574 let first_blocknum = prev_batch_endblock;
576 // Each message carries the number of blocks (from the `first_blocknum`) its contents
577 // fit in. Though there is no requirement that we use exactly the number of blocks its
578 // contents are from, except for the bogus requirements c-lightning enforces, above.
580 // Per spec, the last end block (ie `first_blocknum + number_of_blocks`) needs to be
581 // >= the query's end block. Thus, for the last reply, we calculate the difference
582 // between the query's end block and the start of the reply.
584 // Overflow safe since end_blocknum=msg.first_block_num+msg.number_of_blocks and
585 // first_blocknum will be either msg.first_blocknum or a higher block height.
586 let (sync_complete, number_of_blocks) = if batch_index == batch_count-1 {
587 (true, msg.end_blocknum() - first_blocknum)
589 // Prior replies should use the number of blocks that fit into the reply. Overflow
590 // safe since first_blocknum is always <= last SCID's block.
592 (false, block_from_scid(batch.last().unwrap()) - first_blocknum)
595 prev_batch_endblock = first_blocknum + number_of_blocks;
597 pending_events.push(MessageSendEvent::SendReplyChannelRange {
598 node_id: their_node_id.clone(),
599 msg: ReplyChannelRange {
600 chain_hash: msg.chain_hash.clone(),
604 short_channel_ids: batch,
612 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: QueryShortChannelIds) -> Result<(), LightningError> {
615 err: String::from("Not implemented"),
616 action: ErrorAction::IgnoreError,
620 fn provided_node_features(&self) -> NodeFeatures {
621 let mut features = NodeFeatures::empty();
622 features.set_gossip_queries_optional();
626 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
627 let mut features = InitFeatures::empty();
628 features.set_gossip_queries_optional();
633 impl<G: Deref<Target=NetworkGraph<L>>, U: Deref, L: Deref> MessageSendEventsProvider for P2PGossipSync<G, U, L>
635 U::Target: UtxoLookup,
638 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
639 let mut ret = Vec::new();
640 let mut pending_events = self.pending_events.lock().unwrap();
641 core::mem::swap(&mut ret, &mut pending_events);
646 #[derive(Clone, Debug, PartialEq, Eq)]
647 /// Details about one direction of a channel as received within a [`ChannelUpdate`].
648 pub struct ChannelUpdateInfo {
649 /// When the last update to the channel direction was issued.
650 /// Value is opaque, as set in the announcement.
651 pub last_update: u32,
652 /// Whether the channel can be currently used for payments (in this one direction).
654 /// The difference in CLTV values that you must have when routing through this channel.
655 pub cltv_expiry_delta: u16,
656 /// The minimum value, which must be relayed to the next hop via the channel
657 pub htlc_minimum_msat: u64,
658 /// The maximum value which may be relayed to the next hop via the channel.
659 pub htlc_maximum_msat: u64,
660 /// Fees charged when the channel is used for routing
661 pub fees: RoutingFees,
662 /// Most recent update for the channel received from the network
663 /// Mostly redundant with the data we store in fields explicitly.
664 /// Everything else is useful only for sending out for initial routing sync.
665 /// Not stored if contains excess data to prevent DoS.
666 pub last_update_message: Option<ChannelUpdate>,
669 impl fmt::Display for ChannelUpdateInfo {
670 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
671 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)?;
676 impl Writeable for ChannelUpdateInfo {
677 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
678 write_tlv_fields!(writer, {
679 (0, self.last_update, required),
680 (2, self.enabled, required),
681 (4, self.cltv_expiry_delta, required),
682 (6, self.htlc_minimum_msat, required),
683 // Writing htlc_maximum_msat as an Option<u64> is required to maintain backwards
684 // compatibility with LDK versions prior to v0.0.110.
685 (8, Some(self.htlc_maximum_msat), required),
686 (10, self.fees, required),
687 (12, self.last_update_message, required),
693 impl Readable for ChannelUpdateInfo {
694 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
695 _init_tlv_field_var!(last_update, required);
696 _init_tlv_field_var!(enabled, required);
697 _init_tlv_field_var!(cltv_expiry_delta, required);
698 _init_tlv_field_var!(htlc_minimum_msat, required);
699 _init_tlv_field_var!(htlc_maximum_msat, option);
700 _init_tlv_field_var!(fees, required);
701 _init_tlv_field_var!(last_update_message, required);
703 read_tlv_fields!(reader, {
704 (0, last_update, required),
705 (2, enabled, required),
706 (4, cltv_expiry_delta, required),
707 (6, htlc_minimum_msat, required),
708 (8, htlc_maximum_msat, required),
709 (10, fees, required),
710 (12, last_update_message, required)
713 if let Some(htlc_maximum_msat) = htlc_maximum_msat {
714 Ok(ChannelUpdateInfo {
715 last_update: _init_tlv_based_struct_field!(last_update, required),
716 enabled: _init_tlv_based_struct_field!(enabled, required),
717 cltv_expiry_delta: _init_tlv_based_struct_field!(cltv_expiry_delta, required),
718 htlc_minimum_msat: _init_tlv_based_struct_field!(htlc_minimum_msat, required),
720 fees: _init_tlv_based_struct_field!(fees, required),
721 last_update_message: _init_tlv_based_struct_field!(last_update_message, required),
724 Err(DecodeError::InvalidValue)
729 #[derive(Clone, Debug, PartialEq, Eq)]
730 /// Details about a channel (both directions).
731 /// Received within a channel announcement.
732 pub struct ChannelInfo {
733 /// Protocol features of a channel communicated during its announcement
734 pub features: ChannelFeatures,
735 /// Source node of the first direction of a channel
736 pub node_one: NodeId,
737 /// Details about the first direction of a channel
738 pub one_to_two: Option<ChannelUpdateInfo>,
739 /// Source node of the second direction of a channel
740 pub node_two: NodeId,
741 /// Details about the second direction of a channel
742 pub two_to_one: Option<ChannelUpdateInfo>,
743 /// The channel capacity as seen on-chain, if chain lookup is available.
744 pub capacity_sats: Option<u64>,
745 /// An initial announcement of the channel
746 /// Mostly redundant with the data we store in fields explicitly.
747 /// Everything else is useful only for sending out for initial routing sync.
748 /// Not stored if contains excess data to prevent DoS.
749 pub announcement_message: Option<ChannelAnnouncement>,
750 /// The timestamp when we received the announcement, if we are running with feature = "std"
751 /// (which we can probably assume we are - no-std environments probably won't have a full
752 /// network graph in memory!).
753 announcement_received_time: u64,
757 /// Returns a [`DirectedChannelInfo`] for the channel directed to the given `target` from a
758 /// returned `source`, or `None` if `target` is not one of the channel's counterparties.
759 pub fn as_directed_to(&self, target: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
760 let (direction, source) = {
761 if target == &self.node_one {
762 (self.two_to_one.as_ref(), &self.node_two)
763 } else if target == &self.node_two {
764 (self.one_to_two.as_ref(), &self.node_one)
769 direction.map(|dir| (DirectedChannelInfo::new(self, dir), source))
772 /// Returns a [`DirectedChannelInfo`] for the channel directed from the given `source` to a
773 /// returned `target`, or `None` if `source` is not one of the channel's counterparties.
774 pub fn as_directed_from(&self, source: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
775 let (direction, target) = {
776 if source == &self.node_one {
777 (self.one_to_two.as_ref(), &self.node_two)
778 } else if source == &self.node_two {
779 (self.two_to_one.as_ref(), &self.node_one)
784 direction.map(|dir| (DirectedChannelInfo::new(self, dir), target))
787 /// Returns a [`ChannelUpdateInfo`] based on the direction implied by the channel_flag.
788 pub fn get_directional_info(&self, channel_flags: u8) -> Option<&ChannelUpdateInfo> {
789 let direction = channel_flags & 1u8;
791 self.one_to_two.as_ref()
793 self.two_to_one.as_ref()
798 impl fmt::Display for ChannelInfo {
799 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
800 write!(f, "features: {}, node_one: {}, one_to_two: {:?}, node_two: {}, two_to_one: {:?}",
801 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)?;
806 impl Writeable for ChannelInfo {
807 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
808 write_tlv_fields!(writer, {
809 (0, self.features, required),
810 (1, self.announcement_received_time, (default_value, 0)),
811 (2, self.node_one, required),
812 (4, self.one_to_two, required),
813 (6, self.node_two, required),
814 (8, self.two_to_one, required),
815 (10, self.capacity_sats, required),
816 (12, self.announcement_message, required),
822 // A wrapper allowing for the optional deseralization of ChannelUpdateInfo. Utilizing this is
823 // necessary to maintain backwards compatibility with previous serializations of `ChannelUpdateInfo`
824 // that may have no `htlc_maximum_msat` field set. In case the field is absent, we simply ignore
825 // the error and continue reading the `ChannelInfo`. Hopefully, we'll then eventually receive newer
826 // channel updates via the gossip network.
827 struct ChannelUpdateInfoDeserWrapper(Option<ChannelUpdateInfo>);
829 impl MaybeReadable for ChannelUpdateInfoDeserWrapper {
830 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
831 match crate::util::ser::Readable::read(reader) {
832 Ok(channel_update_option) => Ok(Some(Self(channel_update_option))),
833 Err(DecodeError::ShortRead) => Ok(None),
834 Err(DecodeError::InvalidValue) => Ok(None),
835 Err(err) => Err(err),
840 impl Readable for ChannelInfo {
841 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
842 _init_tlv_field_var!(features, required);
843 _init_tlv_field_var!(announcement_received_time, (default_value, 0));
844 _init_tlv_field_var!(node_one, required);
845 let mut one_to_two_wrap: Option<ChannelUpdateInfoDeserWrapper> = None;
846 _init_tlv_field_var!(node_two, required);
847 let mut two_to_one_wrap: Option<ChannelUpdateInfoDeserWrapper> = None;
848 _init_tlv_field_var!(capacity_sats, required);
849 _init_tlv_field_var!(announcement_message, required);
850 read_tlv_fields!(reader, {
851 (0, features, required),
852 (1, announcement_received_time, (default_value, 0)),
853 (2, node_one, required),
854 (4, one_to_two_wrap, ignorable),
855 (6, node_two, required),
856 (8, two_to_one_wrap, ignorable),
857 (10, capacity_sats, required),
858 (12, announcement_message, required),
862 features: _init_tlv_based_struct_field!(features, required),
863 node_one: _init_tlv_based_struct_field!(node_one, required),
864 one_to_two: one_to_two_wrap.map(|w| w.0).unwrap_or(None),
865 node_two: _init_tlv_based_struct_field!(node_two, required),
866 two_to_one: two_to_one_wrap.map(|w| w.0).unwrap_or(None),
867 capacity_sats: _init_tlv_based_struct_field!(capacity_sats, required),
868 announcement_message: _init_tlv_based_struct_field!(announcement_message, required),
869 announcement_received_time: _init_tlv_based_struct_field!(announcement_received_time, (default_value, 0)),
874 /// A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
875 /// source node to a target node.
877 pub struct DirectedChannelInfo<'a> {
878 channel: &'a ChannelInfo,
879 direction: &'a ChannelUpdateInfo,
880 htlc_maximum_msat: u64,
881 effective_capacity: EffectiveCapacity,
884 impl<'a> DirectedChannelInfo<'a> {
886 fn new(channel: &'a ChannelInfo, direction: &'a ChannelUpdateInfo) -> Self {
887 let mut htlc_maximum_msat = direction.htlc_maximum_msat;
888 let capacity_msat = channel.capacity_sats.map(|capacity_sats| capacity_sats * 1000);
890 let effective_capacity = match capacity_msat {
891 Some(capacity_msat) => {
892 htlc_maximum_msat = cmp::min(htlc_maximum_msat, capacity_msat);
893 EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat: htlc_maximum_msat }
895 None => EffectiveCapacity::MaximumHTLC { amount_msat: htlc_maximum_msat },
899 channel, direction, htlc_maximum_msat, effective_capacity
903 /// Returns information for the channel.
905 pub fn channel(&self) -> &'a ChannelInfo { self.channel }
907 /// Returns the maximum HTLC amount allowed over the channel in the direction.
909 pub fn htlc_maximum_msat(&self) -> u64 {
910 self.htlc_maximum_msat
913 /// Returns the [`EffectiveCapacity`] of the channel in the direction.
915 /// This is either the total capacity from the funding transaction, if known, or the
916 /// `htlc_maximum_msat` for the direction as advertised by the gossip network, if known,
918 pub fn effective_capacity(&self) -> EffectiveCapacity {
919 self.effective_capacity
922 /// Returns information for the direction.
924 pub(super) fn direction(&self) -> &'a ChannelUpdateInfo { self.direction }
927 impl<'a> fmt::Debug for DirectedChannelInfo<'a> {
928 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
929 f.debug_struct("DirectedChannelInfo")
930 .field("channel", &self.channel)
935 /// The effective capacity of a channel for routing purposes.
937 /// While this may be smaller than the actual channel capacity, amounts greater than
938 /// [`Self::as_msat`] should not be routed through the channel.
939 #[derive(Clone, Copy, Debug)]
940 pub enum EffectiveCapacity {
941 /// The available liquidity in the channel known from being a channel counterparty, and thus a
944 /// Either the inbound or outbound liquidity depending on the direction, denominated in
948 /// The maximum HTLC amount in one direction as advertised on the gossip network.
950 /// The maximum HTLC amount denominated in millisatoshi.
953 /// The total capacity of the channel as determined by the funding transaction.
955 /// The funding amount denominated in millisatoshi.
957 /// The maximum HTLC amount denominated in millisatoshi.
958 htlc_maximum_msat: u64
960 /// A capacity sufficient to route any payment, typically used for private channels provided by
963 /// A capacity that is unknown possibly because either the chain state is unavailable to know
964 /// the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
968 /// The presumed channel capacity denominated in millisatoshi for [`EffectiveCapacity::Unknown`] to
969 /// use when making routing decisions.
970 pub const UNKNOWN_CHANNEL_CAPACITY_MSAT: u64 = 250_000 * 1000;
972 impl EffectiveCapacity {
973 /// Returns the effective capacity denominated in millisatoshi.
974 pub fn as_msat(&self) -> u64 {
976 EffectiveCapacity::ExactLiquidity { liquidity_msat } => *liquidity_msat,
977 EffectiveCapacity::MaximumHTLC { amount_msat } => *amount_msat,
978 EffectiveCapacity::Total { capacity_msat, .. } => *capacity_msat,
979 EffectiveCapacity::Infinite => u64::max_value(),
980 EffectiveCapacity::Unknown => UNKNOWN_CHANNEL_CAPACITY_MSAT,
985 /// Fees for routing via a given channel or a node
986 #[derive(Eq, PartialEq, Copy, Clone, Debug, Hash)]
987 pub struct RoutingFees {
988 /// Flat routing fee in satoshis
990 /// Liquidity-based routing fee in millionths of a routed amount.
991 /// In other words, 10000 is 1%.
992 pub proportional_millionths: u32,
995 impl_writeable_tlv_based!(RoutingFees, {
996 (0, base_msat, required),
997 (2, proportional_millionths, required)
1000 #[derive(Clone, Debug, PartialEq, Eq)]
1001 /// Information received in the latest node_announcement from this node.
1002 pub struct NodeAnnouncementInfo {
1003 /// Protocol features the node announced support for
1004 pub features: NodeFeatures,
1005 /// When the last known update to the node state was issued.
1006 /// Value is opaque, as set in the announcement.
1007 pub last_update: u32,
1008 /// Color assigned to the node
1010 /// Moniker assigned to the node.
1011 /// May be invalid or malicious (eg control chars),
1012 /// should not be exposed to the user.
1013 pub alias: NodeAlias,
1014 /// Internet-level addresses via which one can connect to the node
1015 pub addresses: Vec<NetAddress>,
1016 /// An initial announcement of the node
1017 /// Mostly redundant with the data we store in fields explicitly.
1018 /// Everything else is useful only for sending out for initial routing sync.
1019 /// Not stored if contains excess data to prevent DoS.
1020 pub announcement_message: Option<NodeAnnouncement>
1023 impl_writeable_tlv_based!(NodeAnnouncementInfo, {
1024 (0, features, required),
1025 (2, last_update, required),
1027 (6, alias, required),
1028 (8, announcement_message, option),
1029 (10, addresses, vec_type),
1032 /// A user-defined name for a node, which may be used when displaying the node in a graph.
1034 /// Since node aliases are provided by third parties, they are a potential avenue for injection
1035 /// attacks. Care must be taken when processing.
1036 #[derive(Clone, Debug, PartialEq, Eq)]
1037 pub struct NodeAlias(pub [u8; 32]);
1039 impl fmt::Display for NodeAlias {
1040 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1041 let first_null = self.0.iter().position(|b| *b == 0).unwrap_or(self.0.len());
1042 let bytes = self.0.split_at(first_null).0;
1043 match core::str::from_utf8(bytes) {
1044 Ok(alias) => PrintableString(alias).fmt(f)?,
1046 use core::fmt::Write;
1047 for c in bytes.iter().map(|b| *b as char) {
1048 // Display printable ASCII characters
1049 let control_symbol = core::char::REPLACEMENT_CHARACTER;
1050 let c = if c >= '\x20' && c <= '\x7e' { c } else { control_symbol };
1059 impl Writeable for NodeAlias {
1060 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1065 impl Readable for NodeAlias {
1066 fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
1067 Ok(NodeAlias(Readable::read(r)?))
1071 #[derive(Clone, Debug, PartialEq, Eq)]
1072 /// Details about a node in the network, known from the network announcement.
1073 pub struct NodeInfo {
1074 /// All valid channels a node has announced
1075 pub channels: Vec<u64>,
1076 /// More information about a node from node_announcement.
1077 /// Optional because we store a Node entry after learning about it from
1078 /// a channel announcement, but before receiving a node announcement.
1079 pub announcement_info: Option<NodeAnnouncementInfo>
1082 impl fmt::Display for NodeInfo {
1083 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1084 write!(f, " channels: {:?}, announcement_info: {:?}",
1085 &self.channels[..], self.announcement_info)?;
1090 impl Writeable for NodeInfo {
1091 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1092 write_tlv_fields!(writer, {
1093 // Note that older versions of LDK wrote the lowest inbound fees here at type 0
1094 (2, self.announcement_info, option),
1095 (4, self.channels, vec_type),
1101 // A wrapper allowing for the optional deseralization of `NodeAnnouncementInfo`. Utilizing this is
1102 // necessary to maintain compatibility with previous serializations of `NetAddress` that have an
1103 // invalid hostname set. We ignore and eat all errors until we are either able to read a
1104 // `NodeAnnouncementInfo` or hit a `ShortRead`, i.e., read the TLV field to the end.
1105 struct NodeAnnouncementInfoDeserWrapper(NodeAnnouncementInfo);
1107 impl MaybeReadable for NodeAnnouncementInfoDeserWrapper {
1108 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
1109 match crate::util::ser::Readable::read(reader) {
1110 Ok(node_announcement_info) => return Ok(Some(Self(node_announcement_info))),
1112 copy(reader, &mut sink()).unwrap();
1119 impl Readable for NodeInfo {
1120 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1121 // Historically, we tracked the lowest inbound fees for any node in order to use it as an
1122 // A* heuristic when routing. Sadly, these days many, many nodes have at least one channel
1123 // with zero inbound fees, causing that heuristic to provide little gain. Worse, because it
1124 // requires additional complexity and lookups during routing, it ends up being a
1125 // performance loss. Thus, we simply ignore the old field here and no longer track it.
1126 let mut _lowest_inbound_channel_fees: Option<RoutingFees> = None;
1127 let mut announcement_info_wrap: Option<NodeAnnouncementInfoDeserWrapper> = None;
1128 _init_tlv_field_var!(channels, vec_type);
1130 read_tlv_fields!(reader, {
1131 (0, _lowest_inbound_channel_fees, option),
1132 (2, announcement_info_wrap, ignorable),
1133 (4, channels, vec_type),
1137 announcement_info: announcement_info_wrap.map(|w| w.0),
1138 channels: _init_tlv_based_struct_field!(channels, vec_type),
1143 const SERIALIZATION_VERSION: u8 = 1;
1144 const MIN_SERIALIZATION_VERSION: u8 = 1;
1146 impl<L: Deref> Writeable for NetworkGraph<L> where L::Target: Logger {
1147 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1148 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
1150 self.genesis_hash.write(writer)?;
1151 let channels = self.channels.read().unwrap();
1152 (channels.len() as u64).write(writer)?;
1153 for (ref chan_id, ref chan_info) in channels.unordered_iter() {
1154 (*chan_id).write(writer)?;
1155 chan_info.write(writer)?;
1157 let nodes = self.nodes.read().unwrap();
1158 (nodes.len() as u64).write(writer)?;
1159 for (ref node_id, ref node_info) in nodes.unordered_iter() {
1160 node_id.write(writer)?;
1161 node_info.write(writer)?;
1164 let last_rapid_gossip_sync_timestamp = self.get_last_rapid_gossip_sync_timestamp();
1165 write_tlv_fields!(writer, {
1166 (1, last_rapid_gossip_sync_timestamp, option),
1172 impl<L: Deref> ReadableArgs<L> for NetworkGraph<L> where L::Target: Logger {
1173 fn read<R: io::Read>(reader: &mut R, logger: L) -> Result<NetworkGraph<L>, DecodeError> {
1174 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
1176 let genesis_hash: BlockHash = Readable::read(reader)?;
1177 let channels_count: u64 = Readable::read(reader)?;
1178 let mut channels = IndexedMap::new();
1179 for _ in 0..channels_count {
1180 let chan_id: u64 = Readable::read(reader)?;
1181 let chan_info = Readable::read(reader)?;
1182 channels.insert(chan_id, chan_info);
1184 let nodes_count: u64 = Readable::read(reader)?;
1185 let mut nodes = IndexedMap::new();
1186 for _ in 0..nodes_count {
1187 let node_id = Readable::read(reader)?;
1188 let node_info = Readable::read(reader)?;
1189 nodes.insert(node_id, node_info);
1192 let mut last_rapid_gossip_sync_timestamp: Option<u32> = None;
1193 read_tlv_fields!(reader, {
1194 (1, last_rapid_gossip_sync_timestamp, option),
1198 secp_ctx: Secp256k1::verification_only(),
1201 channels: RwLock::new(channels),
1202 nodes: RwLock::new(nodes),
1203 last_rapid_gossip_sync_timestamp: Mutex::new(last_rapid_gossip_sync_timestamp),
1204 removed_nodes: Mutex::new(HashMap::new()),
1205 removed_channels: Mutex::new(HashMap::new()),
1210 impl<L: Deref> fmt::Display for NetworkGraph<L> where L::Target: Logger {
1211 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1212 writeln!(f, "Network map\n[Channels]")?;
1213 for (key, val) in self.channels.read().unwrap().unordered_iter() {
1214 writeln!(f, " {}: {}", key, val)?;
1216 writeln!(f, "[Nodes]")?;
1217 for (&node_id, val) in self.nodes.read().unwrap().unordered_iter() {
1218 writeln!(f, " {}: {}", log_bytes!(node_id.as_slice()), val)?;
1224 impl<L: Deref> Eq for NetworkGraph<L> where L::Target: Logger {}
1225 impl<L: Deref> PartialEq for NetworkGraph<L> where L::Target: Logger {
1226 fn eq(&self, other: &Self) -> bool {
1227 self.genesis_hash == other.genesis_hash &&
1228 *self.channels.read().unwrap() == *other.channels.read().unwrap() &&
1229 *self.nodes.read().unwrap() == *other.nodes.read().unwrap()
1233 impl<L: Deref> NetworkGraph<L> where L::Target: Logger {
1234 /// Creates a new, empty, network graph.
1235 pub fn new(genesis_hash: BlockHash, logger: L) -> NetworkGraph<L> {
1237 secp_ctx: Secp256k1::verification_only(),
1240 channels: RwLock::new(IndexedMap::new()),
1241 nodes: RwLock::new(IndexedMap::new()),
1242 last_rapid_gossip_sync_timestamp: Mutex::new(None),
1243 removed_channels: Mutex::new(HashMap::new()),
1244 removed_nodes: Mutex::new(HashMap::new()),
1248 /// Returns a read-only view of the network graph.
1249 pub fn read_only(&'_ self) -> ReadOnlyNetworkGraph<'_> {
1250 let channels = self.channels.read().unwrap();
1251 let nodes = self.nodes.read().unwrap();
1252 ReadOnlyNetworkGraph {
1258 /// The unix timestamp provided by the most recent rapid gossip sync.
1259 /// It will be set by the rapid sync process after every sync completion.
1260 pub fn get_last_rapid_gossip_sync_timestamp(&self) -> Option<u32> {
1261 self.last_rapid_gossip_sync_timestamp.lock().unwrap().clone()
1264 /// Update the unix timestamp provided by the most recent rapid gossip sync.
1265 /// This should be done automatically by the rapid sync process after every sync completion.
1266 pub fn set_last_rapid_gossip_sync_timestamp(&self, last_rapid_gossip_sync_timestamp: u32) {
1267 self.last_rapid_gossip_sync_timestamp.lock().unwrap().replace(last_rapid_gossip_sync_timestamp);
1270 /// Clears the `NodeAnnouncementInfo` field for all nodes in the `NetworkGraph` for testing
1273 pub fn clear_nodes_announcement_info(&self) {
1274 for node in self.nodes.write().unwrap().unordered_iter_mut() {
1275 node.1.announcement_info = None;
1279 /// For an already known node (from channel announcements), update its stored properties from a
1280 /// given node announcement.
1282 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1283 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1284 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1285 pub fn update_node_from_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<(), LightningError> {
1286 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1287 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.signature, &get_pubkey_from_node_id!(msg.contents.node_id, "node_announcement"), "node_announcement");
1288 self.update_node_from_announcement_intern(&msg.contents, Some(&msg))
1291 /// For an already known node (from channel announcements), update its stored properties from a
1292 /// given node announcement without verifying the associated signatures. Because we aren't
1293 /// given the associated signatures here we cannot relay the node announcement to any of our
1295 pub fn update_node_from_unsigned_announcement(&self, msg: &msgs::UnsignedNodeAnnouncement) -> Result<(), LightningError> {
1296 self.update_node_from_announcement_intern(msg, None)
1299 fn update_node_from_announcement_intern(&self, msg: &msgs::UnsignedNodeAnnouncement, full_msg: Option<&msgs::NodeAnnouncement>) -> Result<(), LightningError> {
1300 match self.nodes.write().unwrap().get_mut(&msg.node_id) {
1301 None => Err(LightningError{err: "No existing channels for node_announcement".to_owned(), action: ErrorAction::IgnoreError}),
1303 if let Some(node_info) = node.announcement_info.as_ref() {
1304 // The timestamp field is somewhat of a misnomer - the BOLTs use it to order
1305 // updates to ensure you always have the latest one, only vaguely suggesting
1306 // that it be at least the current time.
1307 if node_info.last_update > msg.timestamp {
1308 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1309 } else if node_info.last_update == msg.timestamp {
1310 return Err(LightningError{err: "Update had the same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1315 msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1316 msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1317 msg.excess_data.len() + msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY;
1318 node.announcement_info = Some(NodeAnnouncementInfo {
1319 features: msg.features.clone(),
1320 last_update: msg.timestamp,
1322 alias: NodeAlias(msg.alias),
1323 addresses: msg.addresses.clone(),
1324 announcement_message: if should_relay { full_msg.cloned() } else { None },
1332 /// Store or update channel info from a channel announcement.
1334 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1335 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1336 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1338 /// If a [`UtxoLookup`] object is provided via `utxo_lookup`, it will be called to verify
1339 /// the corresponding UTXO exists on chain and is correctly-formatted.
1340 pub fn update_channel_from_announcement<U: Deref>(
1341 &self, msg: &msgs::ChannelAnnouncement, utxo_lookup: &Option<U>,
1342 ) -> Result<(), LightningError>
1344 U::Target: UtxoLookup,
1346 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1347 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_1, &get_pubkey_from_node_id!(msg.contents.node_id_1, "channel_announcement"), "channel_announcement");
1348 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.node_signature_2, &get_pubkey_from_node_id!(msg.contents.node_id_2, "channel_announcement"), "channel_announcement");
1349 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_1, &get_pubkey_from_node_id!(msg.contents.bitcoin_key_1, "channel_announcement"), "channel_announcement");
1350 secp_verify_sig!(self.secp_ctx, &msg_hash, &msg.bitcoin_signature_2, &get_pubkey_from_node_id!(msg.contents.bitcoin_key_2, "channel_announcement"), "channel_announcement");
1351 self.update_channel_from_unsigned_announcement_intern(&msg.contents, Some(msg), utxo_lookup)
1354 /// Store or update channel info from a channel announcement without verifying the associated
1355 /// signatures. Because we aren't given the associated signatures here we cannot relay the
1356 /// channel announcement to any of our peers.
1358 /// If a [`UtxoLookup`] object is provided via `utxo_lookup`, it will be called to verify
1359 /// the corresponding UTXO exists on chain and is correctly-formatted.
1360 pub fn update_channel_from_unsigned_announcement<U: Deref>(
1361 &self, msg: &msgs::UnsignedChannelAnnouncement, utxo_lookup: &Option<U>
1362 ) -> Result<(), LightningError>
1364 U::Target: UtxoLookup,
1366 self.update_channel_from_unsigned_announcement_intern(msg, None, utxo_lookup)
1369 /// Update channel from partial announcement data received via rapid gossip sync
1371 /// `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
1372 /// rapid gossip sync server)
1374 /// All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
1375 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> {
1376 if node_id_1 == node_id_2 {
1377 return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1380 let node_1 = NodeId::from_pubkey(&node_id_1);
1381 let node_2 = NodeId::from_pubkey(&node_id_2);
1382 let channel_info = ChannelInfo {
1384 node_one: node_1.clone(),
1386 node_two: node_2.clone(),
1388 capacity_sats: None,
1389 announcement_message: None,
1390 announcement_received_time: timestamp,
1393 self.add_channel_between_nodes(short_channel_id, channel_info, None)
1396 fn add_channel_between_nodes(&self, short_channel_id: u64, channel_info: ChannelInfo, utxo_value: Option<u64>) -> Result<(), LightningError> {
1397 let mut channels = self.channels.write().unwrap();
1398 let mut nodes = self.nodes.write().unwrap();
1400 let node_id_a = channel_info.node_one.clone();
1401 let node_id_b = channel_info.node_two.clone();
1403 match channels.entry(short_channel_id) {
1404 IndexedMapEntry::Occupied(mut entry) => {
1405 //TODO: because asking the blockchain if short_channel_id is valid is only optional
1406 //in the blockchain API, we need to handle it smartly here, though it's unclear
1408 if utxo_value.is_some() {
1409 // Either our UTXO provider is busted, there was a reorg, or the UTXO provider
1410 // only sometimes returns results. In any case remove the previous entry. Note
1411 // that the spec expects us to "blacklist" the node_ids involved, but we can't
1413 // a) we don't *require* a UTXO provider that always returns results.
1414 // b) we don't track UTXOs of channels we know about and remove them if they
1416 // c) it's unclear how to do so without exposing ourselves to massive DoS risk.
1417 Self::remove_channel_in_nodes(&mut nodes, &entry.get(), short_channel_id);
1418 *entry.get_mut() = channel_info;
1420 return Err(LightningError{err: "Already have knowledge of channel".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1423 IndexedMapEntry::Vacant(entry) => {
1424 entry.insert(channel_info);
1428 for current_node_id in [node_id_a, node_id_b].iter() {
1429 match nodes.entry(current_node_id.clone()) {
1430 IndexedMapEntry::Occupied(node_entry) => {
1431 node_entry.into_mut().channels.push(short_channel_id);
1433 IndexedMapEntry::Vacant(node_entry) => {
1434 node_entry.insert(NodeInfo {
1435 channels: vec!(short_channel_id),
1436 announcement_info: None,
1445 fn update_channel_from_unsigned_announcement_intern<U: Deref>(
1446 &self, msg: &msgs::UnsignedChannelAnnouncement, full_msg: Option<&msgs::ChannelAnnouncement>, utxo_lookup: &Option<U>
1447 ) -> Result<(), LightningError>
1449 U::Target: UtxoLookup,
1451 if msg.node_id_1 == msg.node_id_2 || msg.bitcoin_key_1 == msg.bitcoin_key_2 {
1452 return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1456 let channels = self.channels.read().unwrap();
1458 if let Some(chan) = channels.get(&msg.short_channel_id) {
1459 if chan.capacity_sats.is_some() {
1460 // If we'd previously looked up the channel on-chain and checked the script
1461 // against what appears on-chain, ignore the duplicate announcement.
1463 // Because a reorg could replace one channel with another at the same SCID, if
1464 // the channel appears to be different, we re-validate. This doesn't expose us
1465 // to any more DoS risk than not, as a peer can always flood us with
1466 // randomly-generated SCID values anyway.
1468 // We use the Node IDs rather than the bitcoin_keys to check for "equivalence"
1469 // as we didn't (necessarily) store the bitcoin keys, and we only really care
1470 // if the peers on the channel changed anyway.
1471 if msg.node_id_1 == chan.node_one && msg.node_id_2 == chan.node_two {
1472 return Err(LightningError {
1473 err: "Already have chain-validated channel".to_owned(),
1474 action: ErrorAction::IgnoreDuplicateGossip
1477 } else if utxo_lookup.is_none() {
1478 // Similarly, if we can't check the chain right now anyway, ignore the
1479 // duplicate announcement without bothering to take the channels write lock.
1480 return Err(LightningError {
1481 err: "Already have non-chain-validated channel".to_owned(),
1482 action: ErrorAction::IgnoreDuplicateGossip
1489 let removed_channels = self.removed_channels.lock().unwrap();
1490 let removed_nodes = self.removed_nodes.lock().unwrap();
1491 if removed_channels.contains_key(&msg.short_channel_id) ||
1492 removed_nodes.contains_key(&msg.node_id_1) ||
1493 removed_nodes.contains_key(&msg.node_id_2) {
1494 return Err(LightningError{
1495 err: format!("Channel with SCID {} or one of its nodes was removed from our network graph recently", &msg.short_channel_id),
1496 action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1500 let utxo_value = match &utxo_lookup {
1502 // Tentatively accept, potentially exposing us to DoS attacks
1505 &Some(ref utxo_lookup) => {
1506 match utxo_lookup.get_utxo(&msg.chain_hash, msg.short_channel_id) {
1507 Ok(TxOut { value, script_pubkey }) => {
1508 let expected_script =
1509 make_funding_redeemscript_from_slices(msg.bitcoin_key_1.as_slice(), msg.bitcoin_key_2.as_slice()).to_v0_p2wsh();
1510 if script_pubkey != expected_script {
1511 return Err(LightningError{err: format!("Channel announcement key ({}) didn't match on-chain script ({})", expected_script.to_hex(), script_pubkey.to_hex()), action: ErrorAction::IgnoreError});
1513 //TODO: Check if value is worth storing, use it to inform routing, and compare it
1514 //to the new HTLC max field in channel_update
1517 Err(UtxoLookupError::UnknownChain) => {
1518 return Err(LightningError{err: format!("Channel announced on an unknown chain ({})", msg.chain_hash.encode().to_hex()), action: ErrorAction::IgnoreError});
1520 Err(UtxoLookupError::UnknownTx) => {
1521 return Err(LightningError{err: "Channel announced without corresponding UTXO entry".to_owned(), action: ErrorAction::IgnoreError});
1527 #[allow(unused_mut, unused_assignments)]
1528 let mut announcement_received_time = 0;
1529 #[cfg(feature = "std")]
1531 announcement_received_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1534 let chan_info = ChannelInfo {
1535 features: msg.features.clone(),
1536 node_one: msg.node_id_1,
1538 node_two: msg.node_id_2,
1540 capacity_sats: utxo_value,
1541 announcement_message: if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1542 { full_msg.cloned() } else { None },
1543 announcement_received_time,
1546 self.add_channel_between_nodes(msg.short_channel_id, chan_info, utxo_value)
1549 /// Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
1550 /// If permanent, removes a channel from the local storage.
1551 /// May cause the removal of nodes too, if this was their last channel.
1552 /// If not permanent, makes channels unavailable for routing.
1553 pub fn channel_failed(&self, short_channel_id: u64, is_permanent: bool) {
1554 #[cfg(feature = "std")]
1555 let current_time_unix = Some(SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs());
1556 #[cfg(not(feature = "std"))]
1557 let current_time_unix = None;
1559 self.channel_failed_with_time(short_channel_id, is_permanent, current_time_unix)
1562 /// Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
1563 /// If permanent, removes a channel from the local storage.
1564 /// May cause the removal of nodes too, if this was their last channel.
1565 /// If not permanent, makes channels unavailable for routing.
1566 fn channel_failed_with_time(&self, short_channel_id: u64, is_permanent: bool, current_time_unix: Option<u64>) {
1567 let mut channels = self.channels.write().unwrap();
1569 if let Some(chan) = channels.remove(&short_channel_id) {
1570 let mut nodes = self.nodes.write().unwrap();
1571 self.removed_channels.lock().unwrap().insert(short_channel_id, current_time_unix);
1572 Self::remove_channel_in_nodes(&mut nodes, &chan, short_channel_id);
1575 if let Some(chan) = channels.get_mut(&short_channel_id) {
1576 if let Some(one_to_two) = chan.one_to_two.as_mut() {
1577 one_to_two.enabled = false;
1579 if let Some(two_to_one) = chan.two_to_one.as_mut() {
1580 two_to_one.enabled = false;
1586 /// Marks a node in the graph as permanently failed, effectively removing it and its channels
1587 /// from local storage.
1588 pub fn node_failed_permanent(&self, node_id: &PublicKey) {
1589 #[cfg(feature = "std")]
1590 let current_time_unix = Some(SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs());
1591 #[cfg(not(feature = "std"))]
1592 let current_time_unix = None;
1594 let node_id = NodeId::from_pubkey(node_id);
1595 let mut channels = self.channels.write().unwrap();
1596 let mut nodes = self.nodes.write().unwrap();
1597 let mut removed_channels = self.removed_channels.lock().unwrap();
1598 let mut removed_nodes = self.removed_nodes.lock().unwrap();
1600 if let Some(node) = nodes.remove(&node_id) {
1601 for scid in node.channels.iter() {
1602 if let Some(chan_info) = channels.remove(scid) {
1603 let other_node_id = if node_id == chan_info.node_one { chan_info.node_two } else { chan_info.node_one };
1604 if let IndexedMapEntry::Occupied(mut other_node_entry) = nodes.entry(other_node_id) {
1605 other_node_entry.get_mut().channels.retain(|chan_id| {
1608 if other_node_entry.get().channels.is_empty() {
1609 other_node_entry.remove_entry();
1612 removed_channels.insert(*scid, current_time_unix);
1615 removed_nodes.insert(node_id, current_time_unix);
1619 #[cfg(feature = "std")]
1620 /// Removes information about channels that we haven't heard any updates about in some time.
1621 /// This can be used regularly to prune the network graph of channels that likely no longer
1624 /// While there is no formal requirement that nodes regularly re-broadcast their channel
1625 /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1626 /// pruning occur for updates which are at least two weeks old, which we implement here.
1628 /// Note that for users of the `lightning-background-processor` crate this method may be
1629 /// automatically called regularly for you.
1631 /// This method will also cause us to stop tracking removed nodes and channels if they have been
1632 /// in the map for a while so that these can be resynced from gossip in the future.
1634 /// This method is only available with the `std` feature. See
1635 /// [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] for `no-std` use.
1636 pub fn remove_stale_channels_and_tracking(&self) {
1637 let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1638 self.remove_stale_channels_and_tracking_with_time(time);
1641 /// Removes information about channels that we haven't heard any updates about in some time.
1642 /// This can be used regularly to prune the network graph of channels that likely no longer
1645 /// While there is no formal requirement that nodes regularly re-broadcast their channel
1646 /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1647 /// pruning occur for updates which are at least two weeks old, which we implement here.
1649 /// This method will also cause us to stop tracking removed nodes and channels if they have been
1650 /// in the map for a while so that these can be resynced from gossip in the future.
1652 /// This function takes the current unix time as an argument. For users with the `std` feature
1653 /// enabled, [`NetworkGraph::remove_stale_channels_and_tracking`] may be preferable.
1654 pub fn remove_stale_channels_and_tracking_with_time(&self, current_time_unix: u64) {
1655 let mut channels = self.channels.write().unwrap();
1656 // Time out if we haven't received an update in at least 14 days.
1657 if current_time_unix > u32::max_value() as u64 { return; } // Remove by 2106
1658 if current_time_unix < STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS { return; }
1659 let min_time_unix: u32 = (current_time_unix - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS) as u32;
1660 // Sadly BTreeMap::retain was only stabilized in 1.53 so we can't switch to it for some
1662 let mut scids_to_remove = Vec::new();
1663 for (scid, info) in channels.unordered_iter_mut() {
1664 if info.one_to_two.is_some() && info.one_to_two.as_ref().unwrap().last_update < min_time_unix {
1665 info.one_to_two = None;
1667 if info.two_to_one.is_some() && info.two_to_one.as_ref().unwrap().last_update < min_time_unix {
1668 info.two_to_one = None;
1670 if info.one_to_two.is_none() || info.two_to_one.is_none() {
1671 // We check the announcement_received_time here to ensure we don't drop
1672 // announcements that we just received and are just waiting for our peer to send a
1673 // channel_update for.
1674 if info.announcement_received_time < min_time_unix as u64 {
1675 scids_to_remove.push(*scid);
1679 if !scids_to_remove.is_empty() {
1680 let mut nodes = self.nodes.write().unwrap();
1681 for scid in scids_to_remove {
1682 let info = channels.remove(&scid).expect("We just accessed this scid, it should be present");
1683 Self::remove_channel_in_nodes(&mut nodes, &info, scid);
1684 self.removed_channels.lock().unwrap().insert(scid, Some(current_time_unix));
1688 let should_keep_tracking = |time: &mut Option<u64>| {
1689 if let Some(time) = time {
1690 current_time_unix.saturating_sub(*time) < REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS
1692 // NOTE: In the case of no-std, we won't have access to the current UNIX time at the time of removal,
1693 // so we'll just set the removal time here to the current UNIX time on the very next invocation
1694 // of this function.
1695 #[cfg(feature = "no-std")]
1697 let mut tracked_time = Some(current_time_unix);
1698 core::mem::swap(time, &mut tracked_time);
1701 #[allow(unreachable_code)]
1705 self.removed_channels.lock().unwrap().retain(|_, time| should_keep_tracking(time));
1706 self.removed_nodes.lock().unwrap().retain(|_, time| should_keep_tracking(time));
1709 /// For an already known (from announcement) channel, update info about one of the directions
1712 /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1713 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1714 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1716 /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1717 /// materially in the future will be rejected.
1718 pub fn update_channel(&self, msg: &msgs::ChannelUpdate) -> Result<(), LightningError> {
1719 self.update_channel_intern(&msg.contents, Some(&msg), Some(&msg.signature))
1722 /// For an already known (from announcement) channel, update info about one of the directions
1723 /// of the channel without verifying the associated signatures. Because we aren't given the
1724 /// associated signatures here we cannot relay the channel update to any of our peers.
1726 /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1727 /// materially in the future will be rejected.
1728 pub fn update_channel_unsigned(&self, msg: &msgs::UnsignedChannelUpdate) -> Result<(), LightningError> {
1729 self.update_channel_intern(msg, None, None)
1732 fn update_channel_intern(&self, msg: &msgs::UnsignedChannelUpdate, full_msg: Option<&msgs::ChannelUpdate>, sig: Option<&secp256k1::ecdsa::Signature>) -> Result<(), LightningError> {
1733 let chan_enabled = msg.flags & (1 << 1) != (1 << 1);
1735 #[cfg(all(feature = "std", not(test), not(feature = "_test_utils")))]
1737 // Note that many tests rely on being able to set arbitrarily old timestamps, thus we
1738 // disable this check during tests!
1739 let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1740 if (msg.timestamp as u64) < time - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS {
1741 return Err(LightningError{err: "channel_update is older than two weeks old".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1743 if msg.timestamp as u64 > time + 60 * 60 * 24 {
1744 return Err(LightningError{err: "channel_update has a timestamp more than a day in the future".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1748 let mut channels = self.channels.write().unwrap();
1749 match channels.get_mut(&msg.short_channel_id) {
1750 None => return Err(LightningError{err: "Couldn't find channel for update".to_owned(), action: ErrorAction::IgnoreError}),
1752 if msg.htlc_maximum_msat > MAX_VALUE_MSAT {
1753 return Err(LightningError{err:
1754 "htlc_maximum_msat is larger than maximum possible msats".to_owned(),
1755 action: ErrorAction::IgnoreError});
1758 if let Some(capacity_sats) = channel.capacity_sats {
1759 // It's possible channel capacity is available now, although it wasn't available at announcement (so the field is None).
1760 // Don't query UTXO set here to reduce DoS risks.
1761 if capacity_sats > MAX_VALUE_MSAT / 1000 || msg.htlc_maximum_msat > capacity_sats * 1000 {
1762 return Err(LightningError{err:
1763 "htlc_maximum_msat is larger than channel capacity or capacity is bogus".to_owned(),
1764 action: ErrorAction::IgnoreError});
1767 macro_rules! check_update_latest {
1768 ($target: expr) => {
1769 if let Some(existing_chan_info) = $target.as_ref() {
1770 // The timestamp field is somewhat of a misnomer - the BOLTs use it to
1771 // order updates to ensure you always have the latest one, only
1772 // suggesting that it be at least the current time. For
1773 // channel_updates specifically, the BOLTs discuss the possibility of
1774 // pruning based on the timestamp field being more than two weeks old,
1775 // but only in the non-normative section.
1776 if existing_chan_info.last_update > msg.timestamp {
1777 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1778 } else if existing_chan_info.last_update == msg.timestamp {
1779 return Err(LightningError{err: "Update had same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1785 macro_rules! get_new_channel_info {
1787 let last_update_message = if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1788 { full_msg.cloned() } else { None };
1790 let updated_channel_update_info = ChannelUpdateInfo {
1791 enabled: chan_enabled,
1792 last_update: msg.timestamp,
1793 cltv_expiry_delta: msg.cltv_expiry_delta,
1794 htlc_minimum_msat: msg.htlc_minimum_msat,
1795 htlc_maximum_msat: msg.htlc_maximum_msat,
1797 base_msat: msg.fee_base_msat,
1798 proportional_millionths: msg.fee_proportional_millionths,
1802 Some(updated_channel_update_info)
1806 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1807 if msg.flags & 1 == 1 {
1808 check_update_latest!(channel.two_to_one);
1809 if let Some(sig) = sig {
1810 secp_verify_sig!(self.secp_ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_two.as_slice()).map_err(|_| LightningError{
1811 err: "Couldn't parse source node pubkey".to_owned(),
1812 action: ErrorAction::IgnoreAndLog(Level::Debug)
1813 })?, "channel_update");
1815 channel.two_to_one = get_new_channel_info!();
1817 check_update_latest!(channel.one_to_two);
1818 if let Some(sig) = sig {
1819 secp_verify_sig!(self.secp_ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_one.as_slice()).map_err(|_| LightningError{
1820 err: "Couldn't parse destination node pubkey".to_owned(),
1821 action: ErrorAction::IgnoreAndLog(Level::Debug)
1822 })?, "channel_update");
1824 channel.one_to_two = get_new_channel_info!();
1832 fn remove_channel_in_nodes(nodes: &mut IndexedMap<NodeId, NodeInfo>, chan: &ChannelInfo, short_channel_id: u64) {
1833 macro_rules! remove_from_node {
1834 ($node_id: expr) => {
1835 if let IndexedMapEntry::Occupied(mut entry) = nodes.entry($node_id) {
1836 entry.get_mut().channels.retain(|chan_id| {
1837 short_channel_id != *chan_id
1839 if entry.get().channels.is_empty() {
1840 entry.remove_entry();
1843 panic!("Had channel that pointed to unknown node (ie inconsistent network map)!");
1848 remove_from_node!(chan.node_one);
1849 remove_from_node!(chan.node_two);
1853 impl ReadOnlyNetworkGraph<'_> {
1854 /// Returns all known valid channels' short ids along with announced channel info.
1856 /// (C-not exported) because we don't want to return lifetime'd references
1857 pub fn channels(&self) -> &IndexedMap<u64, ChannelInfo> {
1861 /// Returns information on a channel with the given id.
1862 pub fn channel(&self, short_channel_id: u64) -> Option<&ChannelInfo> {
1863 self.channels.get(&short_channel_id)
1866 #[cfg(c_bindings)] // Non-bindings users should use `channels`
1867 /// Returns the list of channels in the graph
1868 pub fn list_channels(&self) -> Vec<u64> {
1869 self.channels.unordered_keys().map(|c| *c).collect()
1872 /// Returns all known nodes' public keys along with announced node info.
1874 /// (C-not exported) because we don't want to return lifetime'd references
1875 pub fn nodes(&self) -> &IndexedMap<NodeId, NodeInfo> {
1879 /// Returns information on a node with the given id.
1880 pub fn node(&self, node_id: &NodeId) -> Option<&NodeInfo> {
1881 self.nodes.get(node_id)
1884 #[cfg(c_bindings)] // Non-bindings users should use `nodes`
1885 /// Returns the list of nodes in the graph
1886 pub fn list_nodes(&self) -> Vec<NodeId> {
1887 self.nodes.unordered_keys().map(|n| *n).collect()
1890 /// Get network addresses by node id.
1891 /// Returns None if the requested node is completely unknown,
1892 /// or if node announcement for the node was never received.
1893 pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
1894 if let Some(node) = self.nodes.get(&NodeId::from_pubkey(&pubkey)) {
1895 if let Some(node_info) = node.announcement_info.as_ref() {
1896 return Some(node_info.addresses.clone())
1905 use crate::ln::channelmanager;
1906 use crate::ln::chan_utils::make_funding_redeemscript;
1907 #[cfg(feature = "std")]
1908 use crate::ln::features::InitFeatures;
1909 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate, NodeAlias, MAX_EXCESS_BYTES_FOR_RELAY, NodeId, RoutingFees, ChannelUpdateInfo, ChannelInfo, NodeAnnouncementInfo, NodeInfo};
1910 use crate::routing::utxo::UtxoLookupError;
1911 use crate::ln::msgs::{RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
1912 UnsignedChannelAnnouncement, ChannelAnnouncement, UnsignedChannelUpdate, ChannelUpdate,
1913 ReplyChannelRange, QueryChannelRange, QueryShortChannelIds, MAX_VALUE_MSAT};
1914 use crate::util::config::UserConfig;
1915 use crate::util::test_utils;
1916 use crate::util::ser::{ReadableArgs, Writeable};
1917 use crate::util::events::{MessageSendEvent, MessageSendEventsProvider};
1918 use crate::util::scid_utils::scid_from_parts;
1920 use crate::routing::gossip::REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS;
1921 use super::STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS;
1923 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1924 use bitcoin::hashes::Hash;
1925 use bitcoin::network::constants::Network;
1926 use bitcoin::blockdata::constants::genesis_block;
1927 use bitcoin::blockdata::script::Script;
1928 use bitcoin::blockdata::transaction::TxOut;
1932 use bitcoin::secp256k1::{PublicKey, SecretKey};
1933 use bitcoin::secp256k1::{All, Secp256k1};
1936 use bitcoin::secp256k1;
1937 use crate::prelude::*;
1938 use crate::sync::Arc;
1940 fn create_network_graph() -> NetworkGraph<Arc<test_utils::TestLogger>> {
1941 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1942 let logger = Arc::new(test_utils::TestLogger::new());
1943 NetworkGraph::new(genesis_hash, logger)
1946 fn create_gossip_sync(network_graph: &NetworkGraph<Arc<test_utils::TestLogger>>) -> (
1947 Secp256k1<All>, P2PGossipSync<&NetworkGraph<Arc<test_utils::TestLogger>>,
1948 Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>
1950 let secp_ctx = Secp256k1::new();
1951 let logger = Arc::new(test_utils::TestLogger::new());
1952 let gossip_sync = P2PGossipSync::new(network_graph, None, Arc::clone(&logger));
1953 (secp_ctx, gossip_sync)
1957 #[cfg(feature = "std")]
1958 fn request_full_sync_finite_times() {
1959 let network_graph = create_network_graph();
1960 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
1961 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1963 assert!(gossip_sync.should_request_full_sync(&node_id));
1964 assert!(gossip_sync.should_request_full_sync(&node_id));
1965 assert!(gossip_sync.should_request_full_sync(&node_id));
1966 assert!(gossip_sync.should_request_full_sync(&node_id));
1967 assert!(gossip_sync.should_request_full_sync(&node_id));
1968 assert!(!gossip_sync.should_request_full_sync(&node_id));
1971 fn get_signed_node_announcement<F: Fn(&mut UnsignedNodeAnnouncement)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> NodeAnnouncement {
1972 let node_id = NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, node_key));
1973 let mut unsigned_announcement = UnsignedNodeAnnouncement {
1974 features: channelmanager::provided_node_features(&UserConfig::default()),
1979 addresses: Vec::new(),
1980 excess_address_data: Vec::new(),
1981 excess_data: Vec::new(),
1983 f(&mut unsigned_announcement);
1984 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1986 signature: secp_ctx.sign_ecdsa(&msghash, node_key),
1987 contents: unsigned_announcement
1991 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 {
1992 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_key);
1993 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_key);
1994 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1995 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1997 let mut unsigned_announcement = UnsignedChannelAnnouncement {
1998 features: channelmanager::provided_channel_features(&UserConfig::default()),
1999 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2000 short_channel_id: 0,
2001 node_id_1: NodeId::from_pubkey(&node_id_1),
2002 node_id_2: NodeId::from_pubkey(&node_id_2),
2003 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, node_1_btckey)),
2004 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, node_2_btckey)),
2005 excess_data: Vec::new(),
2007 f(&mut unsigned_announcement);
2008 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2009 ChannelAnnouncement {
2010 node_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_key),
2011 node_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_key),
2012 bitcoin_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_btckey),
2013 bitcoin_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_btckey),
2014 contents: unsigned_announcement,
2018 fn get_channel_script(secp_ctx: &Secp256k1<secp256k1::All>) -> Script {
2019 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
2020 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
2021 make_funding_redeemscript(&PublicKey::from_secret_key(secp_ctx, &node_1_btckey),
2022 &PublicKey::from_secret_key(secp_ctx, &node_2_btckey)).to_v0_p2wsh()
2025 fn get_signed_channel_update<F: Fn(&mut UnsignedChannelUpdate)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> ChannelUpdate {
2026 let mut unsigned_channel_update = UnsignedChannelUpdate {
2027 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2028 short_channel_id: 0,
2031 cltv_expiry_delta: 144,
2032 htlc_minimum_msat: 1_000_000,
2033 htlc_maximum_msat: 1_000_000,
2034 fee_base_msat: 10_000,
2035 fee_proportional_millionths: 20,
2036 excess_data: Vec::new()
2038 f(&mut unsigned_channel_update);
2039 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
2041 signature: secp_ctx.sign_ecdsa(&msghash, node_key),
2042 contents: unsigned_channel_update
2047 fn handling_node_announcements() {
2048 let network_graph = create_network_graph();
2049 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2051 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2052 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2053 let zero_hash = Sha256dHash::hash(&[0; 32]);
2055 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2056 match gossip_sync.handle_node_announcement(&valid_announcement) {
2058 Err(e) => assert_eq!("No existing channels for node_announcement", e.err)
2062 // Announce a channel to add a corresponding node.
2063 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2064 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2065 Ok(res) => assert!(res),
2070 match gossip_sync.handle_node_announcement(&valid_announcement) {
2071 Ok(res) => assert!(res),
2075 let fake_msghash = hash_to_message!(&zero_hash);
2076 match gossip_sync.handle_node_announcement(
2078 signature: secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey),
2079 contents: valid_announcement.contents.clone()
2082 Err(e) => assert_eq!(e.err, "Invalid signature on node_announcement message")
2085 let announcement_with_data = get_signed_node_announcement(|unsigned_announcement| {
2086 unsigned_announcement.timestamp += 1000;
2087 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2088 }, node_1_privkey, &secp_ctx);
2089 // Return false because contains excess data.
2090 match gossip_sync.handle_node_announcement(&announcement_with_data) {
2091 Ok(res) => assert!(!res),
2095 // Even though previous announcement was not relayed further, we still accepted it,
2096 // so we now won't accept announcements before the previous one.
2097 let outdated_announcement = get_signed_node_announcement(|unsigned_announcement| {
2098 unsigned_announcement.timestamp += 1000 - 10;
2099 }, node_1_privkey, &secp_ctx);
2100 match gossip_sync.handle_node_announcement(&outdated_announcement) {
2102 Err(e) => assert_eq!(e.err, "Update older than last processed update")
2107 fn handling_channel_announcements() {
2108 let secp_ctx = Secp256k1::new();
2109 let logger = test_utils::TestLogger::new();
2111 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2112 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2114 let good_script = get_channel_script(&secp_ctx);
2115 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2117 // Test if the UTXO lookups were not supported
2118 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2119 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2120 let mut gossip_sync = P2PGossipSync::new(&network_graph, None, &logger);
2121 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2122 Ok(res) => assert!(res),
2127 match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
2133 // If we receive announcement for the same channel (with UTXO lookups disabled),
2134 // drop new one on the floor, since we can't see any changes.
2135 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2137 Err(e) => assert_eq!(e.err, "Already have non-chain-validated channel")
2140 // Test if an associated transaction were not on-chain (or not confirmed).
2141 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2142 *chain_source.utxo_ret.lock().unwrap() = Err(UtxoLookupError::UnknownTx);
2143 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2144 gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2146 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2147 unsigned_announcement.short_channel_id += 1;
2148 }, node_1_privkey, node_2_privkey, &secp_ctx);
2149 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2151 Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
2154 // Now test if the transaction is found in the UTXO set and the script is correct.
2155 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script.clone() });
2156 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2157 unsigned_announcement.short_channel_id += 2;
2158 }, node_1_privkey, node_2_privkey, &secp_ctx);
2159 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2160 Ok(res) => assert!(res),
2165 match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
2171 // If we receive announcement for the same channel, once we've validated it against the
2172 // chain, we simply ignore all new (duplicate) announcements.
2173 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script });
2174 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2176 Err(e) => assert_eq!(e.err, "Already have chain-validated channel")
2179 #[cfg(feature = "std")]
2181 use std::time::{SystemTime, UNIX_EPOCH};
2183 let tracking_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2184 // Mark a node as permanently failed so it's tracked as removed.
2185 gossip_sync.network_graph().node_failed_permanent(&PublicKey::from_secret_key(&secp_ctx, node_1_privkey));
2187 // Return error and ignore valid channel announcement if one of the nodes has been tracked as removed.
2188 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2189 unsigned_announcement.short_channel_id += 3;
2190 }, node_1_privkey, node_2_privkey, &secp_ctx);
2191 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2193 Err(e) => assert_eq!(e.err, "Channel with SCID 3 or one of its nodes was removed from our network graph recently")
2196 gossip_sync.network_graph().remove_stale_channels_and_tracking_with_time(tracking_time + REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS);
2198 // The above channel announcement should be handled as per normal now.
2199 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2200 Ok(res) => assert!(res),
2205 // Don't relay valid channels with excess data
2206 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2207 unsigned_announcement.short_channel_id += 4;
2208 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2209 }, node_1_privkey, node_2_privkey, &secp_ctx);
2210 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2211 Ok(res) => assert!(!res),
2215 let mut invalid_sig_announcement = valid_announcement.clone();
2216 invalid_sig_announcement.contents.excess_data = Vec::new();
2217 match gossip_sync.handle_channel_announcement(&invalid_sig_announcement) {
2219 Err(e) => assert_eq!(e.err, "Invalid signature on channel_announcement message")
2222 let channel_to_itself_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_1_privkey, &secp_ctx);
2223 match gossip_sync.handle_channel_announcement(&channel_to_itself_announcement) {
2225 Err(e) => assert_eq!(e.err, "Channel announcement node had a channel with itself")
2230 fn handling_channel_update() {
2231 let secp_ctx = Secp256k1::new();
2232 let logger = test_utils::TestLogger::new();
2233 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2234 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2235 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2236 let gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2238 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2239 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2241 let amount_sats = 1000_000;
2242 let short_channel_id;
2245 // Announce a channel we will update
2246 let good_script = get_channel_script(&secp_ctx);
2247 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: amount_sats, script_pubkey: good_script.clone() });
2249 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2250 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2251 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2258 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2259 match gossip_sync.handle_channel_update(&valid_channel_update) {
2260 Ok(res) => assert!(res),
2265 match network_graph.read_only().channels().get(&short_channel_id) {
2267 Some(channel_info) => {
2268 assert_eq!(channel_info.one_to_two.as_ref().unwrap().cltv_expiry_delta, 144);
2269 assert!(channel_info.two_to_one.is_none());
2274 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2275 unsigned_channel_update.timestamp += 100;
2276 unsigned_channel_update.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2277 }, node_1_privkey, &secp_ctx);
2278 // Return false because contains excess data
2279 match gossip_sync.handle_channel_update(&valid_channel_update) {
2280 Ok(res) => assert!(!res),
2284 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2285 unsigned_channel_update.timestamp += 110;
2286 unsigned_channel_update.short_channel_id += 1;
2287 }, node_1_privkey, &secp_ctx);
2288 match gossip_sync.handle_channel_update(&valid_channel_update) {
2290 Err(e) => assert_eq!(e.err, "Couldn't find channel for update")
2293 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2294 unsigned_channel_update.htlc_maximum_msat = MAX_VALUE_MSAT + 1;
2295 unsigned_channel_update.timestamp += 110;
2296 }, node_1_privkey, &secp_ctx);
2297 match gossip_sync.handle_channel_update(&valid_channel_update) {
2299 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than maximum possible msats")
2302 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2303 unsigned_channel_update.htlc_maximum_msat = amount_sats * 1000 + 1;
2304 unsigned_channel_update.timestamp += 110;
2305 }, node_1_privkey, &secp_ctx);
2306 match gossip_sync.handle_channel_update(&valid_channel_update) {
2308 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than channel capacity or capacity is bogus")
2311 // Even though previous update was not relayed further, we still accepted it,
2312 // so we now won't accept update before the previous one.
2313 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2314 unsigned_channel_update.timestamp += 100;
2315 }, node_1_privkey, &secp_ctx);
2316 match gossip_sync.handle_channel_update(&valid_channel_update) {
2318 Err(e) => assert_eq!(e.err, "Update had same timestamp as last processed update")
2321 let mut invalid_sig_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2322 unsigned_channel_update.timestamp += 500;
2323 }, node_1_privkey, &secp_ctx);
2324 let zero_hash = Sha256dHash::hash(&[0; 32]);
2325 let fake_msghash = hash_to_message!(&zero_hash);
2326 invalid_sig_channel_update.signature = secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey);
2327 match gossip_sync.handle_channel_update(&invalid_sig_channel_update) {
2329 Err(e) => assert_eq!(e.err, "Invalid signature on channel_update message")
2334 fn handling_network_update() {
2335 let logger = test_utils::TestLogger::new();
2336 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2337 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2338 let secp_ctx = Secp256k1::new();
2340 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2341 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2342 let node_2_id = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2345 // There is no nodes in the table at the beginning.
2346 assert_eq!(network_graph.read_only().nodes().len(), 0);
2349 let short_channel_id;
2351 // Announce a channel we will update
2352 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2353 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2354 let chain_source: Option<&test_utils::TestChainSource> = None;
2355 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source).is_ok());
2356 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2358 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2359 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2361 network_graph.handle_network_update(&NetworkUpdate::ChannelUpdateMessage {
2362 msg: valid_channel_update,
2365 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2368 // Non-permanent closing just disables a channel
2370 match network_graph.read_only().channels().get(&short_channel_id) {
2372 Some(channel_info) => {
2373 assert!(channel_info.one_to_two.as_ref().unwrap().enabled);
2377 network_graph.handle_network_update(&NetworkUpdate::ChannelFailure {
2379 is_permanent: false,
2382 match network_graph.read_only().channels().get(&short_channel_id) {
2384 Some(channel_info) => {
2385 assert!(!channel_info.one_to_two.as_ref().unwrap().enabled);
2390 // Permanent closing deletes a channel
2391 network_graph.handle_network_update(&NetworkUpdate::ChannelFailure {
2396 assert_eq!(network_graph.read_only().channels().len(), 0);
2397 // Nodes are also deleted because there are no associated channels anymore
2398 assert_eq!(network_graph.read_only().nodes().len(), 0);
2401 // Get a new network graph since we don't want to track removed nodes in this test with "std"
2402 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2404 // Announce a channel to test permanent node failure
2405 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2406 let short_channel_id = valid_channel_announcement.contents.short_channel_id;
2407 let chain_source: Option<&test_utils::TestChainSource> = None;
2408 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source).is_ok());
2409 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2411 // Non-permanent node failure does not delete any nodes or channels
2412 network_graph.handle_network_update(&NetworkUpdate::NodeFailure {
2414 is_permanent: false,
2417 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2418 assert!(network_graph.read_only().nodes().get(&NodeId::from_pubkey(&node_2_id)).is_some());
2420 // Permanent node failure deletes node and its channels
2421 network_graph.handle_network_update(&NetworkUpdate::NodeFailure {
2426 assert_eq!(network_graph.read_only().nodes().len(), 0);
2427 // Channels are also deleted because the associated node has been deleted
2428 assert_eq!(network_graph.read_only().channels().len(), 0);
2433 fn test_channel_timeouts() {
2434 // Test the removal of channels with `remove_stale_channels_and_tracking`.
2435 let logger = test_utils::TestLogger::new();
2436 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2437 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2438 let network_graph = NetworkGraph::new(genesis_hash, &logger);
2439 let gossip_sync = P2PGossipSync::new(&network_graph, Some(&chain_source), &logger);
2440 let secp_ctx = Secp256k1::new();
2442 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2443 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2445 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2446 let short_channel_id = valid_channel_announcement.contents.short_channel_id;
2447 let chain_source: Option<&test_utils::TestChainSource> = None;
2448 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source).is_ok());
2449 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2451 // Submit two channel updates for each channel direction (update.flags bit).
2452 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2453 assert!(gossip_sync.handle_channel_update(&valid_channel_update).is_ok());
2454 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2456 let valid_channel_update_2 = get_signed_channel_update(|update| {update.flags |=1;}, node_2_privkey, &secp_ctx);
2457 gossip_sync.handle_channel_update(&valid_channel_update_2).unwrap();
2458 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().two_to_one.is_some());
2460 network_graph.remove_stale_channels_and_tracking_with_time(100 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2461 assert_eq!(network_graph.read_only().channels().len(), 1);
2462 assert_eq!(network_graph.read_only().nodes().len(), 2);
2464 network_graph.remove_stale_channels_and_tracking_with_time(101 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2465 #[cfg(not(feature = "std"))] {
2466 // Make sure removed channels are tracked.
2467 assert_eq!(network_graph.removed_channels.lock().unwrap().len(), 1);
2469 network_graph.remove_stale_channels_and_tracking_with_time(101 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS +
2470 REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS);
2472 #[cfg(feature = "std")]
2474 // In std mode, a further check is performed before fully removing the channel -
2475 // the channel_announcement must have been received at least two weeks ago. We
2476 // fudge that here by indicating the time has jumped two weeks.
2477 assert_eq!(network_graph.read_only().channels().len(), 1);
2478 assert_eq!(network_graph.read_only().nodes().len(), 2);
2480 // Note that the directional channel information will have been removed already..
2481 // We want to check that this will work even if *one* of the channel updates is recent,
2482 // so we should add it with a recent timestamp.
2483 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2484 use std::time::{SystemTime, UNIX_EPOCH};
2485 let announcement_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2486 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2487 unsigned_channel_update.timestamp = (announcement_time + 1 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS) as u32;
2488 }, node_1_privkey, &secp_ctx);
2489 assert!(gossip_sync.handle_channel_update(&valid_channel_update).is_ok());
2490 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2491 network_graph.remove_stale_channels_and_tracking_with_time(announcement_time + 1 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2492 // Make sure removed channels are tracked.
2493 assert_eq!(network_graph.removed_channels.lock().unwrap().len(), 1);
2494 // Provide a later time so that sufficient time has passed
2495 network_graph.remove_stale_channels_and_tracking_with_time(announcement_time + 1 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS +
2496 REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS);
2499 assert_eq!(network_graph.read_only().channels().len(), 0);
2500 assert_eq!(network_graph.read_only().nodes().len(), 0);
2501 assert!(network_graph.removed_channels.lock().unwrap().is_empty());
2503 #[cfg(feature = "std")]
2505 use std::time::{SystemTime, UNIX_EPOCH};
2507 let tracking_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2509 // Clear tracked nodes and channels for clean slate
2510 network_graph.removed_channels.lock().unwrap().clear();
2511 network_graph.removed_nodes.lock().unwrap().clear();
2513 // Add a channel and nodes from channel announcement. So our network graph will
2514 // now only consist of two nodes and one channel between them.
2515 assert!(network_graph.update_channel_from_announcement(
2516 &valid_channel_announcement, &chain_source).is_ok());
2518 // Mark the channel as permanently failed. This will also remove the two nodes
2519 // and all of the entries will be tracked as removed.
2520 network_graph.channel_failed_with_time(short_channel_id, true, Some(tracking_time));
2522 // Should not remove from tracking if insufficient time has passed
2523 network_graph.remove_stale_channels_and_tracking_with_time(
2524 tracking_time + REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS - 1);
2525 assert_eq!(network_graph.removed_channels.lock().unwrap().len(), 1, "Removed channel count ≠1 with tracking_time {}", tracking_time);
2527 // Provide a later time so that sufficient time has passed
2528 network_graph.remove_stale_channels_and_tracking_with_time(
2529 tracking_time + REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS);
2530 assert!(network_graph.removed_channels.lock().unwrap().is_empty(), "Unexpectedly removed channels with tracking_time {}", tracking_time);
2531 assert!(network_graph.removed_nodes.lock().unwrap().is_empty(), "Unexpectedly removed nodes with tracking_time {}", tracking_time);
2534 #[cfg(not(feature = "std"))]
2536 // When we don't have access to the system clock, the time we started tracking removal will only
2537 // be that provided by the first call to `remove_stale_channels_and_tracking_with_time`. Hence,
2538 // only if sufficient time has passed after that first call, will the next call remove it from
2540 let removal_time = 1664619654;
2542 // Clear removed nodes and channels for clean slate
2543 network_graph.removed_channels.lock().unwrap().clear();
2544 network_graph.removed_nodes.lock().unwrap().clear();
2546 // Add a channel and nodes from channel announcement. So our network graph will
2547 // now only consist of two nodes and one channel between them.
2548 assert!(network_graph.update_channel_from_announcement(
2549 &valid_channel_announcement, &chain_source).is_ok());
2551 // Mark the channel as permanently failed. This will also remove the two nodes
2552 // and all of the entries will be tracked as removed.
2553 network_graph.channel_failed(short_channel_id, true);
2555 // The first time we call the following, the channel will have a removal time assigned.
2556 network_graph.remove_stale_channels_and_tracking_with_time(removal_time);
2557 assert_eq!(network_graph.removed_channels.lock().unwrap().len(), 1);
2559 // Provide a later time so that sufficient time has passed
2560 network_graph.remove_stale_channels_and_tracking_with_time(
2561 removal_time + REMOVED_ENTRIES_TRACKING_AGE_LIMIT_SECS);
2562 assert!(network_graph.removed_channels.lock().unwrap().is_empty());
2563 assert!(network_graph.removed_nodes.lock().unwrap().is_empty());
2568 fn getting_next_channel_announcements() {
2569 let network_graph = create_network_graph();
2570 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2571 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2572 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2574 // Channels were not announced yet.
2575 let channels_with_announcements = gossip_sync.get_next_channel_announcement(0);
2576 assert!(channels_with_announcements.is_none());
2578 let short_channel_id;
2580 // Announce a channel we will update
2581 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2582 short_channel_id = valid_channel_announcement.contents.short_channel_id;
2583 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2589 // Contains initial channel announcement now.
2590 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2591 if let Some(channel_announcements) = channels_with_announcements {
2592 let (_, ref update_1, ref update_2) = channel_announcements;
2593 assert_eq!(update_1, &None);
2594 assert_eq!(update_2, &None);
2600 // Valid channel update
2601 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2602 unsigned_channel_update.timestamp = 101;
2603 }, node_1_privkey, &secp_ctx);
2604 match gossip_sync.handle_channel_update(&valid_channel_update) {
2610 // Now contains an initial announcement and an update.
2611 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2612 if let Some(channel_announcements) = channels_with_announcements {
2613 let (_, ref update_1, ref update_2) = channel_announcements;
2614 assert_ne!(update_1, &None);
2615 assert_eq!(update_2, &None);
2621 // Channel update with excess data.
2622 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2623 unsigned_channel_update.timestamp = 102;
2624 unsigned_channel_update.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2625 }, node_1_privkey, &secp_ctx);
2626 match gossip_sync.handle_channel_update(&valid_channel_update) {
2632 // Test that announcements with excess data won't be returned
2633 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id);
2634 if let Some(channel_announcements) = channels_with_announcements {
2635 let (_, ref update_1, ref update_2) = channel_announcements;
2636 assert_eq!(update_1, &None);
2637 assert_eq!(update_2, &None);
2642 // Further starting point have no channels after it
2643 let channels_with_announcements = gossip_sync.get_next_channel_announcement(short_channel_id + 1000);
2644 assert!(channels_with_announcements.is_none());
2648 fn getting_next_node_announcements() {
2649 let network_graph = create_network_graph();
2650 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2651 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2652 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2653 let node_id_1 = NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, node_1_privkey));
2656 let next_announcements = gossip_sync.get_next_node_announcement(None);
2657 assert!(next_announcements.is_none());
2660 // Announce a channel to add 2 nodes
2661 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2662 match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2668 // Nodes were never announced
2669 let next_announcements = gossip_sync.get_next_node_announcement(None);
2670 assert!(next_announcements.is_none());
2673 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2674 match gossip_sync.handle_node_announcement(&valid_announcement) {
2679 let valid_announcement = get_signed_node_announcement(|_| {}, node_2_privkey, &secp_ctx);
2680 match gossip_sync.handle_node_announcement(&valid_announcement) {
2686 let next_announcements = gossip_sync.get_next_node_announcement(None);
2687 assert!(next_announcements.is_some());
2689 // Skip the first node.
2690 let next_announcements = gossip_sync.get_next_node_announcement(Some(&node_id_1));
2691 assert!(next_announcements.is_some());
2694 // Later announcement which should not be relayed (excess data) prevent us from sharing a node
2695 let valid_announcement = get_signed_node_announcement(|unsigned_announcement| {
2696 unsigned_announcement.timestamp += 10;
2697 unsigned_announcement.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2698 }, node_2_privkey, &secp_ctx);
2699 match gossip_sync.handle_node_announcement(&valid_announcement) {
2700 Ok(res) => assert!(!res),
2705 let next_announcements = gossip_sync.get_next_node_announcement(Some(&node_id_1));
2706 assert!(next_announcements.is_none());
2710 fn network_graph_serialization() {
2711 let network_graph = create_network_graph();
2712 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2714 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2715 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2717 // Announce a channel to add a corresponding node.
2718 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2719 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2720 Ok(res) => assert!(res),
2724 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2725 match gossip_sync.handle_node_announcement(&valid_announcement) {
2730 let mut w = test_utils::TestVecWriter(Vec::new());
2731 assert!(!network_graph.read_only().nodes().is_empty());
2732 assert!(!network_graph.read_only().channels().is_empty());
2733 network_graph.write(&mut w).unwrap();
2735 let logger = Arc::new(test_utils::TestLogger::new());
2736 assert!(<NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), logger).unwrap() == network_graph);
2740 fn network_graph_tlv_serialization() {
2741 let network_graph = create_network_graph();
2742 network_graph.set_last_rapid_gossip_sync_timestamp(42);
2744 let mut w = test_utils::TestVecWriter(Vec::new());
2745 network_graph.write(&mut w).unwrap();
2747 let logger = Arc::new(test_utils::TestLogger::new());
2748 let reassembled_network_graph: NetworkGraph<_> = ReadableArgs::read(&mut io::Cursor::new(&w.0), logger).unwrap();
2749 assert!(reassembled_network_graph == network_graph);
2750 assert_eq!(reassembled_network_graph.get_last_rapid_gossip_sync_timestamp().unwrap(), 42);
2754 #[cfg(feature = "std")]
2755 fn calling_sync_routing_table() {
2756 use std::time::{SystemTime, UNIX_EPOCH};
2757 use crate::ln::msgs::Init;
2759 let network_graph = create_network_graph();
2760 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2761 let node_privkey_1 = &SecretKey::from_slice(&[42; 32]).unwrap();
2762 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_privkey_1);
2764 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2766 // It should ignore if gossip_queries feature is not enabled
2768 let init_msg = Init { features: InitFeatures::empty(), remote_network_address: None };
2769 gossip_sync.peer_connected(&node_id_1, &init_msg).unwrap();
2770 let events = gossip_sync.get_and_clear_pending_msg_events();
2771 assert_eq!(events.len(), 0);
2774 // It should send a gossip_timestamp_filter with the correct information
2776 let mut features = InitFeatures::empty();
2777 features.set_gossip_queries_optional();
2778 let init_msg = Init { features, remote_network_address: None };
2779 gossip_sync.peer_connected(&node_id_1, &init_msg).unwrap();
2780 let events = gossip_sync.get_and_clear_pending_msg_events();
2781 assert_eq!(events.len(), 1);
2783 MessageSendEvent::SendGossipTimestampFilter{ node_id, msg } => {
2784 assert_eq!(node_id, &node_id_1);
2785 assert_eq!(msg.chain_hash, chain_hash);
2786 let expected_timestamp = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2787 assert!((msg.first_timestamp as u64) >= expected_timestamp - 60*60*24*7*2);
2788 assert!((msg.first_timestamp as u64) < expected_timestamp - 60*60*24*7*2 + 10);
2789 assert_eq!(msg.timestamp_range, u32::max_value());
2791 _ => panic!("Expected MessageSendEvent::SendChannelRangeQuery")
2797 fn handling_query_channel_range() {
2798 let network_graph = create_network_graph();
2799 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2801 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2802 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2803 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2804 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2806 let mut scids: Vec<u64> = vec![
2807 scid_from_parts(0xfffffe, 0xffffff, 0xffff).unwrap(), // max
2808 scid_from_parts(0xffffff, 0xffffff, 0xffff).unwrap(), // never
2811 // used for testing multipart reply across blocks
2812 for block in 100000..=108001 {
2813 scids.push(scid_from_parts(block, 0, 0).unwrap());
2816 // used for testing resumption on same block
2817 scids.push(scid_from_parts(108001, 1, 0).unwrap());
2820 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2821 unsigned_announcement.short_channel_id = scid;
2822 }, node_1_privkey, node_2_privkey, &secp_ctx);
2823 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2829 // Error when number_of_blocks=0
2830 do_handling_query_channel_range(
2834 chain_hash: chain_hash.clone(),
2836 number_of_blocks: 0,
2839 vec![ReplyChannelRange {
2840 chain_hash: chain_hash.clone(),
2842 number_of_blocks: 0,
2843 sync_complete: true,
2844 short_channel_ids: vec![]
2848 // Error when wrong chain
2849 do_handling_query_channel_range(
2853 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2855 number_of_blocks: 0xffff_ffff,
2858 vec![ReplyChannelRange {
2859 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2861 number_of_blocks: 0xffff_ffff,
2862 sync_complete: true,
2863 short_channel_ids: vec![],
2867 // Error when first_blocknum > 0xffffff
2868 do_handling_query_channel_range(
2872 chain_hash: chain_hash.clone(),
2873 first_blocknum: 0x01000000,
2874 number_of_blocks: 0xffff_ffff,
2877 vec![ReplyChannelRange {
2878 chain_hash: chain_hash.clone(),
2879 first_blocknum: 0x01000000,
2880 number_of_blocks: 0xffff_ffff,
2881 sync_complete: true,
2882 short_channel_ids: vec![]
2886 // Empty reply when max valid SCID block num
2887 do_handling_query_channel_range(
2891 chain_hash: chain_hash.clone(),
2892 first_blocknum: 0xffffff,
2893 number_of_blocks: 1,
2898 chain_hash: chain_hash.clone(),
2899 first_blocknum: 0xffffff,
2900 number_of_blocks: 1,
2901 sync_complete: true,
2902 short_channel_ids: vec![]
2907 // No results in valid query range
2908 do_handling_query_channel_range(
2912 chain_hash: chain_hash.clone(),
2913 first_blocknum: 1000,
2914 number_of_blocks: 1000,
2919 chain_hash: chain_hash.clone(),
2920 first_blocknum: 1000,
2921 number_of_blocks: 1000,
2922 sync_complete: true,
2923 short_channel_ids: vec![],
2928 // Overflow first_blocknum + number_of_blocks
2929 do_handling_query_channel_range(
2933 chain_hash: chain_hash.clone(),
2934 first_blocknum: 0xfe0000,
2935 number_of_blocks: 0xffffffff,
2940 chain_hash: chain_hash.clone(),
2941 first_blocknum: 0xfe0000,
2942 number_of_blocks: 0xffffffff - 0xfe0000,
2943 sync_complete: true,
2944 short_channel_ids: vec![
2945 0xfffffe_ffffff_ffff, // max
2951 // Single block exactly full
2952 do_handling_query_channel_range(
2956 chain_hash: chain_hash.clone(),
2957 first_blocknum: 100000,
2958 number_of_blocks: 8000,
2963 chain_hash: chain_hash.clone(),
2964 first_blocknum: 100000,
2965 number_of_blocks: 8000,
2966 sync_complete: true,
2967 short_channel_ids: (100000..=107999)
2968 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2974 // Multiple split on new block
2975 do_handling_query_channel_range(
2979 chain_hash: chain_hash.clone(),
2980 first_blocknum: 100000,
2981 number_of_blocks: 8001,
2986 chain_hash: chain_hash.clone(),
2987 first_blocknum: 100000,
2988 number_of_blocks: 7999,
2989 sync_complete: false,
2990 short_channel_ids: (100000..=107999)
2991 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2995 chain_hash: chain_hash.clone(),
2996 first_blocknum: 107999,
2997 number_of_blocks: 2,
2998 sync_complete: true,
2999 short_channel_ids: vec![
3000 scid_from_parts(108000, 0, 0).unwrap(),
3006 // Multiple split on same block
3007 do_handling_query_channel_range(
3011 chain_hash: chain_hash.clone(),
3012 first_blocknum: 100002,
3013 number_of_blocks: 8000,
3018 chain_hash: chain_hash.clone(),
3019 first_blocknum: 100002,
3020 number_of_blocks: 7999,
3021 sync_complete: false,
3022 short_channel_ids: (100002..=108001)
3023 .map(|block| scid_from_parts(block, 0, 0).unwrap())
3027 chain_hash: chain_hash.clone(),
3028 first_blocknum: 108001,
3029 number_of_blocks: 1,
3030 sync_complete: true,
3031 short_channel_ids: vec![
3032 scid_from_parts(108001, 1, 0).unwrap(),
3039 fn do_handling_query_channel_range(
3040 gossip_sync: &P2PGossipSync<&NetworkGraph<Arc<test_utils::TestLogger>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
3041 test_node_id: &PublicKey,
3042 msg: QueryChannelRange,
3044 expected_replies: Vec<ReplyChannelRange>
3046 let mut max_firstblocknum = msg.first_blocknum.saturating_sub(1);
3047 let mut c_lightning_0_9_prev_end_blocknum = max_firstblocknum;
3048 let query_end_blocknum = msg.end_blocknum();
3049 let result = gossip_sync.handle_query_channel_range(test_node_id, msg);
3052 assert!(result.is_ok());
3054 assert!(result.is_err());
3057 let events = gossip_sync.get_and_clear_pending_msg_events();
3058 assert_eq!(events.len(), expected_replies.len());
3060 for i in 0..events.len() {
3061 let expected_reply = &expected_replies[i];
3063 MessageSendEvent::SendReplyChannelRange { node_id, msg } => {
3064 assert_eq!(node_id, test_node_id);
3065 assert_eq!(msg.chain_hash, expected_reply.chain_hash);
3066 assert_eq!(msg.first_blocknum, expected_reply.first_blocknum);
3067 assert_eq!(msg.number_of_blocks, expected_reply.number_of_blocks);
3068 assert_eq!(msg.sync_complete, expected_reply.sync_complete);
3069 assert_eq!(msg.short_channel_ids, expected_reply.short_channel_ids);
3071 // Enforce exactly the sequencing requirements present on c-lightning v0.9.3
3072 assert!(msg.first_blocknum == c_lightning_0_9_prev_end_blocknum || msg.first_blocknum == c_lightning_0_9_prev_end_blocknum.saturating_add(1));
3073 assert!(msg.first_blocknum >= max_firstblocknum);
3074 max_firstblocknum = msg.first_blocknum;
3075 c_lightning_0_9_prev_end_blocknum = msg.first_blocknum.saturating_add(msg.number_of_blocks);
3077 // Check that the last block count is >= the query's end_blocknum
3078 if i == events.len() - 1 {
3079 assert!(msg.first_blocknum.saturating_add(msg.number_of_blocks) >= query_end_blocknum);
3082 _ => panic!("expected MessageSendEvent::SendReplyChannelRange"),
3088 fn handling_query_short_channel_ids() {
3089 let network_graph = create_network_graph();
3090 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
3091 let node_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
3092 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
3094 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
3096 let result = gossip_sync.handle_query_short_channel_ids(&node_id, QueryShortChannelIds {
3098 short_channel_ids: vec![0x0003e8_000000_0000],
3100 assert!(result.is_err());
3104 fn displays_node_alias() {
3105 let format_str_alias = |alias: &str| {
3106 let mut bytes = [0u8; 32];
3107 bytes[..alias.as_bytes().len()].copy_from_slice(alias.as_bytes());
3108 format!("{}", NodeAlias(bytes))
3111 assert_eq!(format_str_alias("I\u{1F496}LDK! \u{26A1}"), "I\u{1F496}LDK! \u{26A1}");
3112 assert_eq!(format_str_alias("I\u{1F496}LDK!\0\u{26A1}"), "I\u{1F496}LDK!");
3113 assert_eq!(format_str_alias("I\u{1F496}LDK!\t\u{26A1}"), "I\u{1F496}LDK!\u{FFFD}\u{26A1}");
3115 let format_bytes_alias = |alias: &[u8]| {
3116 let mut bytes = [0u8; 32];
3117 bytes[..alias.len()].copy_from_slice(alias);
3118 format!("{}", NodeAlias(bytes))
3121 assert_eq!(format_bytes_alias(b"\xFFI <heart> LDK!"), "\u{FFFD}I <heart> LDK!");
3122 assert_eq!(format_bytes_alias(b"\xFFI <heart>\0LDK!"), "\u{FFFD}I <heart>");
3123 assert_eq!(format_bytes_alias(b"\xFFI <heart>\tLDK!"), "\u{FFFD}I <heart>\u{FFFD}LDK!");
3127 fn channel_info_is_readable() {
3128 let chanmon_cfgs = crate::ln::functional_test_utils::create_chanmon_cfgs(2);
3129 let node_cfgs = crate::ln::functional_test_utils::create_node_cfgs(2, &chanmon_cfgs);
3130 let node_chanmgrs = crate::ln::functional_test_utils::create_node_chanmgrs(2, &node_cfgs, &[None, None, None, None]);
3131 let nodes = crate::ln::functional_test_utils::create_network(2, &node_cfgs, &node_chanmgrs);
3132 let config = crate::ln::functional_test_utils::test_default_channel_config();
3134 // 1. Test encoding/decoding of ChannelUpdateInfo
3135 let chan_update_info = ChannelUpdateInfo {
3138 cltv_expiry_delta: 42,
3139 htlc_minimum_msat: 1234,
3140 htlc_maximum_msat: 5678,
3141 fees: RoutingFees { base_msat: 9, proportional_millionths: 10 },
3142 last_update_message: None,
3145 let mut encoded_chan_update_info: Vec<u8> = Vec::new();
3146 assert!(chan_update_info.write(&mut encoded_chan_update_info).is_ok());
3148 // First make sure we can read ChannelUpdateInfos we just wrote
3149 let read_chan_update_info: ChannelUpdateInfo = crate::util::ser::Readable::read(&mut encoded_chan_update_info.as_slice()).unwrap();
3150 assert_eq!(chan_update_info, read_chan_update_info);
3152 // Check the serialization hasn't changed.
3153 let legacy_chan_update_info_with_some: Vec<u8> = hex::decode("340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c0100").unwrap();
3154 assert_eq!(encoded_chan_update_info, legacy_chan_update_info_with_some);
3156 // Check we fail if htlc_maximum_msat is not present in either the ChannelUpdateInfo itself
3157 // or the ChannelUpdate enclosed with `last_update_message`.
3158 let legacy_chan_update_info_with_some_and_fail_update: Vec<u8> = hex::decode("b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f42400000271000000014").unwrap();
3159 let read_chan_update_info_res: Result<ChannelUpdateInfo, crate::ln::msgs::DecodeError> = crate::util::ser::Readable::read(&mut legacy_chan_update_info_with_some_and_fail_update.as_slice());
3160 assert!(read_chan_update_info_res.is_err());
3162 let legacy_chan_update_info_with_none: Vec<u8> = hex::decode("2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c0100").unwrap();
3163 let read_chan_update_info_res: Result<ChannelUpdateInfo, crate::ln::msgs::DecodeError> = crate::util::ser::Readable::read(&mut legacy_chan_update_info_with_none.as_slice());
3164 assert!(read_chan_update_info_res.is_err());
3166 // 2. Test encoding/decoding of ChannelInfo
3167 // Check we can encode/decode ChannelInfo without ChannelUpdateInfo fields present.
3168 let chan_info_none_updates = ChannelInfo {
3169 features: channelmanager::provided_channel_features(&config),
3170 node_one: NodeId::from_pubkey(&nodes[0].node.get_our_node_id()),
3172 node_two: NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
3174 capacity_sats: None,
3175 announcement_message: None,
3176 announcement_received_time: 87654,
3179 let mut encoded_chan_info: Vec<u8> = Vec::new();
3180 assert!(chan_info_none_updates.write(&mut encoded_chan_info).is_ok());
3182 let read_chan_info: ChannelInfo = crate::util::ser::Readable::read(&mut encoded_chan_info.as_slice()).unwrap();
3183 assert_eq!(chan_info_none_updates, read_chan_info);
3185 // Check we can encode/decode ChannelInfo with ChannelUpdateInfo fields present.
3186 let chan_info_some_updates = ChannelInfo {
3187 features: channelmanager::provided_channel_features(&config),
3188 node_one: NodeId::from_pubkey(&nodes[0].node.get_our_node_id()),
3189 one_to_two: Some(chan_update_info.clone()),
3190 node_two: NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
3191 two_to_one: Some(chan_update_info.clone()),
3192 capacity_sats: None,
3193 announcement_message: None,
3194 announcement_received_time: 87654,
3197 let mut encoded_chan_info: Vec<u8> = Vec::new();
3198 assert!(chan_info_some_updates.write(&mut encoded_chan_info).is_ok());
3200 let read_chan_info: ChannelInfo = crate::util::ser::Readable::read(&mut encoded_chan_info.as_slice()).unwrap();
3201 assert_eq!(chan_info_some_updates, read_chan_info);
3203 // Check the serialization hasn't changed.
3204 let legacy_chan_info_with_some: Vec<u8> = hex::decode("ca00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce88043636340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c010006210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c23083636340004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c01000a01000c0100").unwrap();
3205 assert_eq!(encoded_chan_info, legacy_chan_info_with_some);
3207 // Check we can decode legacy ChannelInfo, even if the `two_to_one` / `one_to_two` /
3208 // `last_update_message` fields fail to decode due to missing htlc_maximum_msat.
3209 let legacy_chan_info_with_some_and_fail_update = hex::decode("fd01ca00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce8804b6b6b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f4240000027100000001406210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c2308b6b6b40004000000170201010402002a060800000000000004d2080909000000000000162e0a0d0c00040000000902040000000a0c8181d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f00083a840000034d013413a70000009000000000000f424000002710000000140a01000c0100").unwrap();
3210 let read_chan_info: ChannelInfo = crate::util::ser::Readable::read(&mut legacy_chan_info_with_some_and_fail_update.as_slice()).unwrap();
3211 assert_eq!(read_chan_info.announcement_received_time, 87654);
3212 assert_eq!(read_chan_info.one_to_two, None);
3213 assert_eq!(read_chan_info.two_to_one, None);
3215 let legacy_chan_info_with_none: Vec<u8> = hex::decode("ba00020000010800000000000156660221027f921585f2ac0c7c70e36110adecfd8fd14b8a99bfb3d000a283fcac358fce88042e2e2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c010006210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c23082e2e2c0004000000170201010402002a060800000000000004d20801000a0d0c00040000000902040000000a0c01000a01000c0100").unwrap();
3216 let read_chan_info: ChannelInfo = crate::util::ser::Readable::read(&mut legacy_chan_info_with_none.as_slice()).unwrap();
3217 assert_eq!(read_chan_info.announcement_received_time, 87654);
3218 assert_eq!(read_chan_info.one_to_two, None);
3219 assert_eq!(read_chan_info.two_to_one, None);
3223 fn node_info_is_readable() {
3224 use std::convert::TryFrom;
3226 // 1. Check we can read a valid NodeAnnouncementInfo and fail on an invalid one
3227 let valid_netaddr = crate::ln::msgs::NetAddress::Hostname { hostname: crate::util::ser::Hostname::try_from("A".to_string()).unwrap(), port: 1234 };
3228 let valid_node_ann_info = NodeAnnouncementInfo {
3229 features: channelmanager::provided_node_features(&UserConfig::default()),
3232 alias: NodeAlias([0u8; 32]),
3233 addresses: vec![valid_netaddr],
3234 announcement_message: None,
3237 let mut encoded_valid_node_ann_info = Vec::new();
3238 assert!(valid_node_ann_info.write(&mut encoded_valid_node_ann_info).is_ok());
3239 let read_valid_node_ann_info: NodeAnnouncementInfo = crate::util::ser::Readable::read(&mut encoded_valid_node_ann_info.as_slice()).unwrap();
3240 assert_eq!(read_valid_node_ann_info, valid_node_ann_info);
3242 let encoded_invalid_node_ann_info = hex::decode("3f0009000788a000080a51a20204000000000403000000062000000000000000000000000000000000000000000000000000000000000000000a0505014004d2").unwrap();
3243 let read_invalid_node_ann_info_res: Result<NodeAnnouncementInfo, crate::ln::msgs::DecodeError> = crate::util::ser::Readable::read(&mut encoded_invalid_node_ann_info.as_slice());
3244 assert!(read_invalid_node_ann_info_res.is_err());
3246 // 2. Check we can read a NodeInfo anyways, but set the NodeAnnouncementInfo to None if invalid
3247 let valid_node_info = NodeInfo {
3248 channels: Vec::new(),
3249 announcement_info: Some(valid_node_ann_info),
3252 let mut encoded_valid_node_info = Vec::new();
3253 assert!(valid_node_info.write(&mut encoded_valid_node_info).is_ok());
3254 let read_valid_node_info: NodeInfo = crate::util::ser::Readable::read(&mut encoded_valid_node_info.as_slice()).unwrap();
3255 assert_eq!(read_valid_node_info, valid_node_info);
3257 let encoded_invalid_node_info_hex = hex::decode("4402403f0009000788a000080a51a20204000000000403000000062000000000000000000000000000000000000000000000000000000000000000000a0505014004d20400").unwrap();
3258 let read_invalid_node_info: NodeInfo = crate::util::ser::Readable::read(&mut encoded_invalid_node_info_hex.as_slice()).unwrap();
3259 assert_eq!(read_invalid_node_info.announcement_info, None);
3263 #[cfg(all(test, feature = "_bench_unstable"))]
3271 fn read_network_graph(bench: &mut Bencher) {
3272 let logger = crate::util::test_utils::TestLogger::new();
3273 let mut d = crate::routing::router::bench_utils::get_route_file().unwrap();
3274 let mut v = Vec::new();
3275 d.read_to_end(&mut v).unwrap();
3277 let _ = NetworkGraph::read(&mut std::io::Cursor::new(&v), &logger).unwrap();
3282 fn write_network_graph(bench: &mut Bencher) {
3283 let logger = crate::util::test_utils::TestLogger::new();
3284 let mut d = crate::routing::router::bench_utils::get_route_file().unwrap();
3285 let net_graph = NetworkGraph::read(&mut d, &logger).unwrap();
3287 let _ = net_graph.encode();