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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! The top-level network map tracking logic lives here.
  11
  12 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
  13 use bitcoin::secp256k1::PublicKey;
  14 use bitcoin::secp256k1::Secp256k1;
  15 use bitcoin::secp256k1;
  16
  17 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  18 use bitcoin::hashes::Hash;
  19 use bitcoin::blockdata::script::Builder;
  20 use bitcoin::blockdata::transaction::TxOut;
  21 use bitcoin::blockdata::opcodes;
  22 use bitcoin::hash_types::BlockHash;
  23
  24 use chain;
  25 use chain::Access;
  26 use ln::features::{ChannelFeatures, NodeFeatures};
  27 use ln::msgs::{DecodeError, ErrorAction, Init, LightningError, RoutingMessageHandler, NetAddress, MAX_VALUE_MSAT};
  28 use ln::msgs::{ChannelAnnouncement, ChannelUpdate, NodeAnnouncement, OptionalField, GossipTimestampFilter};
  29 use ln::msgs::{QueryChannelRange, ReplyChannelRange, QueryShortChannelIds, ReplyShortChannelIdsEnd};
  30 use ln::msgs;
  31 use util::ser::{Writeable, Readable, Writer};
  32 use util::logger::{Logger, Level};
  33 use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
  34 use util::scid_utils::{block_from_scid, scid_from_parts, MAX_SCID_BLOCK};
  35
  36 use io;
  37 use prelude::*;
  38 use alloc::collections::{BTreeMap, btree_map::Entry as BtreeEntry};
  39 use core::{cmp, fmt};
  40 use sync::{RwLock, RwLockReadGuard};
  41 use core::sync::atomic::{AtomicUsize, Ordering};
  42 use sync::Mutex;
  43 use core::ops::Deref;
  44 use bitcoin::hashes::hex::ToHex;
  45
  46 #[cfg(feature = "std")]
  47 use std::time::{SystemTime, UNIX_EPOCH};
  48
  49 /// We remove stale channel directional info two weeks after the last update, per BOLT 7's
  50 /// suggestion.
  51 const STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS: u64 = 60 * 60 * 24 * 14;
  52
  53 /// The maximum number of extra bytes which we do not understand in a gossip message before we will
  54 /// refuse to relay the message.
  55 const MAX_EXCESS_BYTES_FOR_RELAY: usize = 1024;
  56
  57 /// Maximum number of short_channel_ids that will be encoded in one gossip reply message.
  58 /// This value ensures a reply fits within the 65k payload limit and is consistent with other implementations.
  59 const MAX_SCIDS_PER_REPLY: usize = 8000;
  60
  61 /// Represents the compressed public key of a node
  62 #[derive(Clone, Copy)]
  63 pub struct NodeId([u8; PUBLIC_KEY_SIZE]);
  64
  65 impl NodeId {
  66         /// Create a new NodeId from a public key
  67         pub fn from_pubkey(pubkey: &PublicKey) -> Self {
  68                 NodeId(pubkey.serialize())
  69         }
  70
  71         /// Get the public key slice from this NodeId
  72         pub fn as_slice(&self) -> &[u8] {
  73                 &self.0
  74         }
  75 }
  76
  77 impl fmt::Debug for NodeId {
  78         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  79                 write!(f, "NodeId({})", log_bytes!(self.0))
  80         }
  81 }
  82
  83 impl core::hash::Hash for NodeId {
  84         fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
  85                 self.0.hash(hasher);
  86         }
  87 }
  88
  89 impl Eq for NodeId {}
  90
  91 impl PartialEq for NodeId {
  92         fn eq(&self, other: &Self) -> bool {
  93                 self.0[..] == other.0[..]
  94         }
  95 }
  96
  97 impl cmp::PartialOrd for NodeId {
  98         fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
  99                 Some(self.cmp(other))
 100         }
 101 }
 102
 103 impl Ord for NodeId {
 104         fn cmp(&self, other: &Self) -> cmp::Ordering {
 105                 self.0[..].cmp(&other.0[..])
 106         }
 107 }
 108
 109 impl Writeable for NodeId {
 110         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 111                 writer.write_all(&self.0)?;
 112                 Ok(())
 113         }
 114 }
 115
 116 impl Readable for NodeId {
 117         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 118                 let mut buf = [0; PUBLIC_KEY_SIZE];
 119                 reader.read_exact(&mut buf)?;
 120                 Ok(Self(buf))
 121         }
 122 }
 123
 124 /// Represents the network as nodes and channels between them
 125 pub struct NetworkGraph {
 126         last_rapid_gossip_sync_timestamp: Mutex<Option<u32>>,
 127         genesis_hash: BlockHash,
 128         // Lock order: channels -> nodes
 129         channels: RwLock<BTreeMap<u64, ChannelInfo>>,
 130         nodes: RwLock<BTreeMap<NodeId, NodeInfo>>,
 131 }
 132
 133 impl Clone for NetworkGraph {
 134         fn clone(&self) -> Self {
 135                 let channels = self.channels.read().unwrap();
 136                 let nodes = self.nodes.read().unwrap();
 137                 let last_rapid_gossip_sync_timestamp = self.get_last_rapid_gossip_sync_timestamp();
 138                 Self {
 139                         genesis_hash: self.genesis_hash.clone(),
 140                         channels: RwLock::new(channels.clone()),
 141                         nodes: RwLock::new(nodes.clone()),
 142                         last_rapid_gossip_sync_timestamp: Mutex::new(last_rapid_gossip_sync_timestamp)
 143                 }
 144         }
 145 }
 146
 147 /// A read-only view of [`NetworkGraph`].
 148 pub struct ReadOnlyNetworkGraph<'a> {
 149         channels: RwLockReadGuard<'a, BTreeMap<u64, ChannelInfo>>,
 150         nodes: RwLockReadGuard<'a, BTreeMap<NodeId, NodeInfo>>,
 151 }
 152
 153 /// Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
 154 /// return packet by a node along the route. See [BOLT #4] for details.
 155 ///
 156 /// [BOLT #4]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
 157 #[derive(Clone, Debug, PartialEq)]
 158 pub enum NetworkUpdate {
 159         /// An error indicating a `channel_update` messages should be applied via
 160         /// [`NetworkGraph::update_channel`].
 161         ChannelUpdateMessage {
 162                 /// The update to apply via [`NetworkGraph::update_channel`].
 163                 msg: ChannelUpdate,
 164         },
 165         /// An error indicating that a channel failed to route a payment, which should be applied via
 166         /// [`NetworkGraph::channel_failed`].
 167         ChannelFailure {
 168                 /// The short channel id of the closed channel.
 169                 short_channel_id: u64,
 170                 /// Whether the channel should be permanently removed or temporarily disabled until a new
 171                 /// `channel_update` message is received.
 172                 is_permanent: bool,
 173         },
 174         /// An error indicating that a node failed to route a payment, which should be applied via
 175         /// [`NetworkGraph::node_failed`].
 176         NodeFailure {
 177                 /// The node id of the failed node.
 178                 node_id: PublicKey,
 179                 /// Whether the node should be permanently removed from consideration or can be restored
 180                 /// when a new `channel_update` message is received.
 181                 is_permanent: bool,
 182         }
 183 }
 184
 185 impl_writeable_tlv_based_enum_upgradable!(NetworkUpdate,
 186         (0, ChannelUpdateMessage) => {
 187                 (0, msg, required),
 188         },
 189         (2, ChannelFailure) => {
 190                 (0, short_channel_id, required),
 191                 (2, is_permanent, required),
 192         },
 193         (4, NodeFailure) => {
 194                 (0, node_id, required),
 195                 (2, is_permanent, required),
 196         },
 197 );
 198
 199 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> EventHandler for P2PGossipSync<G, C, L>
 200 where C::Target: chain::Access, L::Target: Logger {
 201         fn handle_event(&self, event: &Event) {
 202                 if let Event::PaymentPathFailed { payment_hash: _, rejected_by_dest: _, network_update, .. } = event {
 203                         if let Some(network_update) = network_update {
 204                                 self.handle_network_update(network_update);
 205                         }
 206                 }
 207         }
 208 }
 209
 210 /// Receives and validates network updates from peers,
 211 /// stores authentic and relevant data as a network graph.
 212 /// This network graph is then used for routing payments.
 213 /// Provides interface to help with initial routing sync by
 214 /// serving historical announcements.
 215 ///
 216 /// Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
 217 /// [`NetworkGraph`].
 218 pub struct P2PGossipSync<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref>
 219 where C::Target: chain::Access, L::Target: Logger
 220 {
 221         secp_ctx: Secp256k1<secp256k1::VerifyOnly>,
 222         network_graph: G,
 223         chain_access: Option<C>,
 224         full_syncs_requested: AtomicUsize,
 225         pending_events: Mutex<Vec<MessageSendEvent>>,
 226         logger: L,
 227 }
 228
 229 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> P2PGossipSync<G, C, L>
 230 where C::Target: chain::Access, L::Target: Logger
 231 {
 232         /// Creates a new tracker of the actual state of the network of channels and nodes,
 233         /// assuming an existing Network Graph.
 234         /// Chain monitor is used to make sure announced channels exist on-chain,
 235         /// channel data is correct, and that the announcement is signed with
 236         /// channel owners' keys.
 237         pub fn new(network_graph: G, chain_access: Option<C>, logger: L) -> Self {
 238                 P2PGossipSync {
 239                         secp_ctx: Secp256k1::verification_only(),
 240                         network_graph,
 241                         full_syncs_requested: AtomicUsize::new(0),
 242                         chain_access,
 243                         pending_events: Mutex::new(vec![]),
 244                         logger,
 245                 }
 246         }
 247
 248         /// Adds a provider used to check new announcements. Does not affect
 249         /// existing announcements unless they are updated.
 250         /// Add, update or remove the provider would replace the current one.
 251         pub fn add_chain_access(&mut self, chain_access: Option<C>) {
 252                 self.chain_access = chain_access;
 253         }
 254
 255         /// Gets a reference to the underlying [`NetworkGraph`] which was provided in
 256         /// [`P2PGossipSync::new`].
 257         ///
 258         /// (C-not exported) as bindings don't support a reference-to-a-reference yet
 259         pub fn network_graph(&self) -> &G {
 260                 &self.network_graph
 261         }
 262
 263         /// Returns true when a full routing table sync should be performed with a peer.
 264         fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
 265                 //TODO: Determine whether to request a full sync based on the network map.
 266                 const FULL_SYNCS_TO_REQUEST: usize = 5;
 267                 if self.full_syncs_requested.load(Ordering::Acquire) < FULL_SYNCS_TO_REQUEST {
 268                         self.full_syncs_requested.fetch_add(1, Ordering::AcqRel);
 269                         true
 270                 } else {
 271                         false
 272                 }
 273         }
 274
 275         /// Applies changes to the [`NetworkGraph`] from the given update.
 276         fn handle_network_update(&self, update: &NetworkUpdate) {
 277                 match *update {
 278                         NetworkUpdate::ChannelUpdateMessage { ref msg } => {
 279                                 let short_channel_id = msg.contents.short_channel_id;
 280                                 let is_enabled = msg.contents.flags & (1 << 1) != (1 << 1);
 281                                 let status = if is_enabled { "enabled" } else { "disabled" };
 282                                 log_debug!(self.logger, "Updating channel with channel_update from a payment failure. Channel {} is {}.", short_channel_id, status);
 283                                 let _ = self.network_graph.update_channel(msg, &self.secp_ctx);
 284                         },
 285                         NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } => {
 286                                 let action = if is_permanent { "Removing" } else { "Disabling" };
 287                                 log_debug!(self.logger, "{} channel graph entry for {} due to a payment failure.", action, short_channel_id);
 288                                 self.network_graph.channel_failed(short_channel_id, is_permanent);
 289                         },
 290                         NetworkUpdate::NodeFailure { ref node_id, is_permanent } => {
 291                                 let action = if is_permanent { "Removing" } else { "Disabling" };
 292                                 log_debug!(self.logger, "{} node graph entry for {} due to a payment failure.", action, node_id);
 293                                 self.network_graph.node_failed(node_id, is_permanent);
 294                         },
 295                 }
 296         }
 297 }
 298
 299 macro_rules! secp_verify_sig {
 300         ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr, $msg_type: expr ) => {
 301                 match $secp_ctx.verify_ecdsa($msg, $sig, $pubkey) {
 302                         Ok(_) => {},
 303                         Err(_) => {
 304                                 return Err(LightningError {
 305                                         err: format!("Invalid signature on {} message", $msg_type),
 306                                         action: ErrorAction::SendWarningMessage {
 307                                                 msg: msgs::WarningMessage {
 308                                                         channel_id: [0; 32],
 309                                                         data: format!("Invalid signature on {} message", $msg_type),
 310                                                 },
 311                                                 log_level: Level::Trace,
 312                                         },
 313                                 });
 314                         },
 315                 }
 316         };
 317 }
 318
 319 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> RoutingMessageHandler for P2PGossipSync<G, C, L>
 320 where C::Target: chain::Access, L::Target: Logger
 321 {
 322         fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
 323                 self.network_graph.update_node_from_announcement(msg, &self.secp_ctx)?;
 324                 Ok(msg.contents.excess_data.len() <=  MAX_EXCESS_BYTES_FOR_RELAY &&
 325                    msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
 326                    msg.contents.excess_data.len() + msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
 327         }
 328
 329         fn handle_channel_announcement(&self, msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
 330                 self.network_graph.update_channel_from_announcement(msg, &self.chain_access, &self.secp_ctx)?;
 331                 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 { "" });
 332                 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
 333         }
 334
 335         fn handle_channel_update(&self, msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
 336                 self.network_graph.update_channel(msg, &self.secp_ctx)?;
 337                 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
 338         }
 339
 340         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)> {
 341                 let mut result = Vec::with_capacity(batch_amount as usize);
 342                 let channels = self.network_graph.channels.read().unwrap();
 343                 let mut iter = channels.range(starting_point..);
 344                 while result.len() < batch_amount as usize {
 345                         if let Some((_, ref chan)) = iter.next() {
 346                                 if chan.announcement_message.is_some() {
 347                                         let chan_announcement = chan.announcement_message.clone().unwrap();
 348                                         let mut one_to_two_announcement: Option<msgs::ChannelUpdate> = None;
 349                                         let mut two_to_one_announcement: Option<msgs::ChannelUpdate> = None;
 350                                         if let Some(one_to_two) = chan.one_to_two.as_ref() {
 351                                                 one_to_two_announcement = one_to_two.last_update_message.clone();
 352                                         }
 353                                         if let Some(two_to_one) = chan.two_to_one.as_ref() {
 354                                                 two_to_one_announcement = two_to_one.last_update_message.clone();
 355                                         }
 356                                         result.push((chan_announcement, one_to_two_announcement, two_to_one_announcement));
 357                                 } else {
 358                                         // TODO: We may end up sending un-announced channel_updates if we are sending
 359                                         // initial sync data while receiving announce/updates for this channel.
 360                                 }
 361                         } else {
 362                                 return result;
 363                         }
 364                 }
 365                 result
 366         }
 367
 368         fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement> {
 369                 let mut result = Vec::with_capacity(batch_amount as usize);
 370                 let nodes = self.network_graph.nodes.read().unwrap();
 371                 let mut iter = if let Some(pubkey) = starting_point {
 372                                 let mut iter = nodes.range(NodeId::from_pubkey(pubkey)..);
 373                                 iter.next();
 374                                 iter
 375                         } else {
 376                                 nodes.range::<NodeId, _>(..)
 377                         };
 378                 while result.len() < batch_amount as usize {
 379                         if let Some((_, ref node)) = iter.next() {
 380                                 if let Some(node_info) = node.announcement_info.as_ref() {
 381                                         if node_info.announcement_message.is_some() {
 382                                                 result.push(node_info.announcement_message.clone().unwrap());
 383                                         }
 384                                 }
 385                         } else {
 386                                 return result;
 387                         }
 388                 }
 389                 result
 390         }
 391
 392         /// Initiates a stateless sync of routing gossip information with a peer
 393         /// using gossip_queries. The default strategy used by this implementation
 394         /// is to sync the full block range with several peers.
 395         ///
 396         /// We should expect one or more reply_channel_range messages in response
 397         /// to our query_channel_range. Each reply will enqueue a query_scid message
 398         /// to request gossip messages for each channel. The sync is considered complete
 399         /// when the final reply_scids_end message is received, though we are not
 400         /// tracking this directly.
 401         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &Init) {
 402                 // We will only perform a sync with peers that support gossip_queries.
 403                 if !init_msg.features.supports_gossip_queries() {
 404                         return ();
 405                 }
 406
 407                 // The lightning network's gossip sync system is completely broken in numerous ways.
 408                 //
 409                 // Given no broadly-available set-reconciliation protocol, the only reasonable approach is
 410                 // to do a full sync from the first few peers we connect to, and then receive gossip
 411                 // updates from all our peers normally.
 412                 //
 413                 // Originally, we could simply tell a peer to dump us the entire gossip table on startup,
 414                 // wasting lots of bandwidth but ensuring we have the full network graph. After the initial
 415                 // dump peers would always send gossip and we'd stay up-to-date with whatever our peer has
 416                 // seen.
 417                 //
 418                 // In order to reduce the bandwidth waste, "gossip queries" were introduced, allowing you
 419                 // to ask for the SCIDs of all channels in your peer's routing graph, and then only request
 420                 // channel data which you are missing. Except there was no way at all to identify which
 421                 // `channel_update`s you were missing, so you still had to request everything, just in a
 422                 // very complicated way with some queries instead of just getting the dump.
 423                 //
 424                 // Later, an option was added to fetch the latest timestamps of the `channel_update`s to
 425                 // make efficient sync possible, however it has yet to be implemented in lnd, which makes
 426                 // relying on it useless.
 427                 //
 428                 // After gossip queries were introduced, support for receiving a full gossip table dump on
 429                 // connection was removed from several nodes, making it impossible to get a full sync
 430                 // without using the "gossip queries" messages.
 431                 //
 432                 // Once you opt into "gossip queries" the only way to receive any gossip updates that a
 433                 // peer receives after you connect, you must send a `gossip_timestamp_filter` message. This
 434                 // message, as the name implies, tells the peer to not forward any gossip messages with a
 435                 // timestamp older than a given value (not the time the peer received the filter, but the
 436                 // timestamp in the update message, which is often hours behind when the peer received the
 437                 // message).
 438                 //
 439                 // Obnoxiously, `gossip_timestamp_filter` isn't *just* a filter, but its also a request for
 440                 // your peer to send you the full routing graph (subject to the filter). Thus, in order to
 441                 // tell a peer to send you any updates as it sees them, you have to also ask for the full
 442                 // routing graph to be synced. If you set a timestamp filter near the current time, peers
 443                 // will simply not forward any new updates they see to you which were generated some time
 444                 // ago (which is not uncommon). If you instead set a timestamp filter near 0 (or two weeks
 445                 // ago), you will always get the full routing graph from all your peers.
 446                 //
 447                 // Most lightning nodes today opt to simply turn off receiving gossip data which only
 448                 // propagated some time after it was generated, and, worse, often disable gossiping with
 449                 // several peers after their first connection. The second behavior can cause gossip to not
 450                 // propagate fully if there are cuts in the gossiping subgraph.
 451                 //
 452                 // In an attempt to cut a middle ground between always fetching the full graph from all of
 453                 // our peers and never receiving gossip from peers at all, we send all of our peers a
 454                 // `gossip_timestamp_filter`, with the filter time set either two weeks ago or an hour ago.
 455                 //
 456                 // For no-std builds, we bury our head in the sand and do a full sync on each connection.
 457                 let should_request_full_sync = self.should_request_full_sync(&their_node_id);
 458                 #[allow(unused_mut, unused_assignments)]
 459                 let mut gossip_start_time = 0;
 460                 #[cfg(feature = "std")]
 461                 {
 462                         gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
 463                         if should_request_full_sync {
 464                                 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
 465                         } else {
 466                                 gossip_start_time -= 60 * 60; // an hour ago
 467                         }
 468                 }
 469
 470                 let mut pending_events = self.pending_events.lock().unwrap();
 471                 pending_events.push(MessageSendEvent::SendGossipTimestampFilter {
 472                         node_id: their_node_id.clone(),
 473                         msg: GossipTimestampFilter {
 474                                 chain_hash: self.network_graph.genesis_hash,
 475                                 first_timestamp: gossip_start_time as u32, // 2106 issue!
 476                                 timestamp_range: u32::max_value(),
 477                         },
 478                 });
 479         }
 480
 481         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: ReplyChannelRange) -> Result<(), LightningError> {
 482                 // We don't make queries, so should never receive replies. If, in the future, the set
 483                 // reconciliation extensions to gossip queries become broadly supported, we should revert
 484                 // this code to its state pre-0.0.106.
 485                 Ok(())
 486         }
 487
 488         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError> {
 489                 // We don't make queries, so should never receive replies. If, in the future, the set
 490                 // reconciliation extensions to gossip queries become broadly supported, we should revert
 491                 // this code to its state pre-0.0.106.
 492                 Ok(())
 493         }
 494
 495         /// Processes a query from a peer by finding announced/public channels whose funding UTXOs
 496         /// are in the specified block range. Due to message size limits, large range
 497         /// queries may result in several reply messages. This implementation enqueues
 498         /// all reply messages into pending events. Each message will allocate just under 65KiB. A full
 499         /// sync of the public routing table with 128k channels will generated 16 messages and allocate ~1MB.
 500         /// Logic can be changed to reduce allocation if/when a full sync of the routing table impacts
 501         /// memory constrained systems.
 502         fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError> {
 503                 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);
 504
 505                 let inclusive_start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0);
 506
 507                 // We might receive valid queries with end_blocknum that would overflow SCID conversion.
 508                 // If so, we manually cap the ending block to avoid this overflow.
 509                 let exclusive_end_scid = scid_from_parts(cmp::min(msg.end_blocknum() as u64, MAX_SCID_BLOCK), 0, 0);
 510
 511                 // Per spec, we must reply to a query. Send an empty message when things are invalid.
 512                 if msg.chain_hash != self.network_graph.genesis_hash || inclusive_start_scid.is_err() || exclusive_end_scid.is_err() || msg.number_of_blocks == 0 {
 513                         let mut pending_events = self.pending_events.lock().unwrap();
 514                         pending_events.push(MessageSendEvent::SendReplyChannelRange {
 515                                 node_id: their_node_id.clone(),
 516                                 msg: ReplyChannelRange {
 517                                         chain_hash: msg.chain_hash.clone(),
 518                                         first_blocknum: msg.first_blocknum,
 519                                         number_of_blocks: msg.number_of_blocks,
 520                                         sync_complete: true,
 521                                         short_channel_ids: vec![],
 522                                 }
 523                         });
 524                         return Err(LightningError {
 525                                 err: String::from("query_channel_range could not be processed"),
 526                                 action: ErrorAction::IgnoreError,
 527                         });
 528                 }
 529
 530                 // Creates channel batches. We are not checking if the channel is routable
 531                 // (has at least one update). A peer may still want to know the channel
 532                 // exists even if its not yet routable.
 533                 let mut batches: Vec<Vec<u64>> = vec![Vec::with_capacity(MAX_SCIDS_PER_REPLY)];
 534                 let channels = self.network_graph.channels.read().unwrap();
 535                 for (_, ref chan) in channels.range(inclusive_start_scid.unwrap()..exclusive_end_scid.unwrap()) {
 536                         if let Some(chan_announcement) = &chan.announcement_message {
 537                                 // Construct a new batch if last one is full
 538                                 if batches.last().unwrap().len() == batches.last().unwrap().capacity() {
 539                                         batches.push(Vec::with_capacity(MAX_SCIDS_PER_REPLY));
 540                                 }
 541
 542                                 let batch = batches.last_mut().unwrap();
 543                                 batch.push(chan_announcement.contents.short_channel_id);
 544                         }
 545                 }
 546                 drop(channels);
 547
 548                 let mut pending_events = self.pending_events.lock().unwrap();
 549                 let batch_count = batches.len();
 550                 let mut prev_batch_endblock = msg.first_blocknum;
 551                 for (batch_index, batch) in batches.into_iter().enumerate() {
 552                         // Per spec, the initial `first_blocknum` needs to be <= the query's `first_blocknum`
 553                         // and subsequent `first_blocknum`s must be >= the prior reply's `first_blocknum`.
 554                         //
 555                         // Additionally, c-lightning versions < 0.10 require that the `first_blocknum` of each
 556                         // reply is >= the previous reply's `first_blocknum` and either exactly the previous
 557                         // reply's `first_blocknum + number_of_blocks` or exactly one greater. This is a
 558                         // significant diversion from the requirements set by the spec, and, in case of blocks
 559                         // with no channel opens (e.g. empty blocks), requires that we use the previous value
 560                         // and *not* derive the first_blocknum from the actual first block of the reply.
 561                         let first_blocknum = prev_batch_endblock;
 562
 563                         // Each message carries the number of blocks (from the `first_blocknum`) its contents
 564                         // fit in. Though there is no requirement that we use exactly the number of blocks its
 565                         // contents are from, except for the bogus requirements c-lightning enforces, above.
 566                         //
 567                         // Per spec, the last end block (ie `first_blocknum + number_of_blocks`) needs to be
 568                         // >= the query's end block. Thus, for the last reply, we calculate the difference
 569                         // between the query's end block and the start of the reply.
 570                         //
 571                         // Overflow safe since end_blocknum=msg.first_block_num+msg.number_of_blocks and
 572                         // first_blocknum will be either msg.first_blocknum or a higher block height.
 573                         let (sync_complete, number_of_blocks) = if batch_index == batch_count-1 {
 574                                 (true, msg.end_blocknum() - first_blocknum)
 575                         }
 576                         // Prior replies should use the number of blocks that fit into the reply. Overflow
 577                         // safe since first_blocknum is always <= last SCID's block.
 578                         else {
 579                                 (false, block_from_scid(batch.last().unwrap()) - first_blocknum)
 580                         };
 581
 582                         prev_batch_endblock = first_blocknum + number_of_blocks;
 583
 584                         pending_events.push(MessageSendEvent::SendReplyChannelRange {
 585                                 node_id: their_node_id.clone(),
 586                                 msg: ReplyChannelRange {
 587                                         chain_hash: msg.chain_hash.clone(),
 588                                         first_blocknum,
 589                                         number_of_blocks,
 590                                         sync_complete,
 591                                         short_channel_ids: batch,
 592                                 }
 593                         });
 594                 }
 595
 596                 Ok(())
 597         }
 598
 599         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: QueryShortChannelIds) -> Result<(), LightningError> {
 600                 // TODO
 601                 Err(LightningError {
 602                         err: String::from("Not implemented"),
 603                         action: ErrorAction::IgnoreError,
 604                 })
 605         }
 606 }
 607
 608 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> MessageSendEventsProvider for P2PGossipSync<G, C, L>
 609 where
 610         C::Target: chain::Access,
 611         L::Target: Logger,
 612 {
 613         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
 614                 let mut ret = Vec::new();
 615                 let mut pending_events = self.pending_events.lock().unwrap();
 616                 core::mem::swap(&mut ret, &mut pending_events);
 617                 ret
 618         }
 619 }
 620
 621 #[derive(Clone, Debug, PartialEq)]
 622 /// Details about one direction of a channel as received within a [`ChannelUpdate`].
 623 pub struct ChannelUpdateInfo {
 624         /// When the last update to the channel direction was issued.
 625         /// Value is opaque, as set in the announcement.
 626         pub last_update: u32,
 627         /// Whether the channel can be currently used for payments (in this one direction).
 628         pub enabled: bool,
 629         /// The difference in CLTV values that you must have when routing through this channel.
 630         pub cltv_expiry_delta: u16,
 631         /// The minimum value, which must be relayed to the next hop via the channel
 632         pub htlc_minimum_msat: u64,
 633         /// The maximum value which may be relayed to the next hop via the channel.
 634         pub htlc_maximum_msat: Option<u64>,
 635         /// Fees charged when the channel is used for routing
 636         pub fees: RoutingFees,
 637         /// Most recent update for the channel received from the network
 638         /// Mostly redundant with the data we store in fields explicitly.
 639         /// Everything else is useful only for sending out for initial routing sync.
 640         /// Not stored if contains excess data to prevent DoS.
 641         pub last_update_message: Option<ChannelUpdate>,
 642 }
 643
 644 impl fmt::Display for ChannelUpdateInfo {
 645         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 646                 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)?;
 647                 Ok(())
 648         }
 649 }
 650
 651 impl_writeable_tlv_based!(ChannelUpdateInfo, {
 652         (0, last_update, required),
 653         (2, enabled, required),
 654         (4, cltv_expiry_delta, required),
 655         (6, htlc_minimum_msat, required),
 656         (8, htlc_maximum_msat, required),
 657         (10, fees, required),
 658         (12, last_update_message, required),
 659 });
 660
 661 #[derive(Clone, Debug, PartialEq)]
 662 /// Details about a channel (both directions).
 663 /// Received within a channel announcement.
 664 pub struct ChannelInfo {
 665         /// Protocol features of a channel communicated during its announcement
 666         pub features: ChannelFeatures,
 667         /// Source node of the first direction of a channel
 668         pub node_one: NodeId,
 669         /// Details about the first direction of a channel
 670         pub one_to_two: Option<ChannelUpdateInfo>,
 671         /// Source node of the second direction of a channel
 672         pub node_two: NodeId,
 673         /// Details about the second direction of a channel
 674         pub two_to_one: Option<ChannelUpdateInfo>,
 675         /// The channel capacity as seen on-chain, if chain lookup is available.
 676         pub capacity_sats: Option<u64>,
 677         /// An initial announcement of the channel
 678         /// Mostly redundant with the data we store in fields explicitly.
 679         /// Everything else is useful only for sending out for initial routing sync.
 680         /// Not stored if contains excess data to prevent DoS.
 681         pub announcement_message: Option<ChannelAnnouncement>,
 682         /// The timestamp when we received the announcement, if we are running with feature = "std"
 683         /// (which we can probably assume we are - no-std environments probably won't have a full
 684         /// network graph in memory!).
 685         announcement_received_time: u64,
 686 }
 687
 688 impl ChannelInfo {
 689         /// Returns a [`DirectedChannelInfo`] for the channel directed to the given `target` from a
 690         /// returned `source`, or `None` if `target` is not one of the channel's counterparties.
 691         pub fn as_directed_to(&self, target: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
 692                 let (direction, source) = {
 693                         if target == &self.node_one {
 694                                 (self.two_to_one.as_ref(), &self.node_two)
 695                         } else if target == &self.node_two {
 696                                 (self.one_to_two.as_ref(), &self.node_one)
 697                         } else {
 698                                 return None;
 699                         }
 700                 };
 701                 Some((DirectedChannelInfo::new(self, direction), source))
 702         }
 703
 704         /// Returns a [`DirectedChannelInfo`] for the channel directed from the given `source` to a
 705         /// returned `target`, or `None` if `source` is not one of the channel's counterparties.
 706         pub fn as_directed_from(&self, source: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
 707                 let (direction, target) = {
 708                         if source == &self.node_one {
 709                                 (self.one_to_two.as_ref(), &self.node_two)
 710                         } else if source == &self.node_two {
 711                                 (self.two_to_one.as_ref(), &self.node_one)
 712                         } else {
 713                                 return None;
 714                         }
 715                 };
 716                 Some((DirectedChannelInfo::new(self, direction), target))
 717         }
 718
 719         /// Returns a [`ChannelUpdateInfo`] based on the direction implied by the channel_flag.
 720         pub fn get_directional_info(&self, channel_flags: u8) -> Option<&ChannelUpdateInfo> {
 721                 let direction = channel_flags & 1u8;
 722                 if direction == 0 {
 723                         self.one_to_two.as_ref()
 724                 } else {
 725                         self.two_to_one.as_ref()
 726                 }
 727         }
 728 }
 729
 730 impl fmt::Display for ChannelInfo {
 731         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 732                 write!(f, "features: {}, node_one: {}, one_to_two: {:?}, node_two: {}, two_to_one: {:?}",
 733                    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)?;
 734                 Ok(())
 735         }
 736 }
 737
 738 impl_writeable_tlv_based!(ChannelInfo, {
 739         (0, features, required),
 740         (1, announcement_received_time, (default_value, 0)),
 741         (2, node_one, required),
 742         (4, one_to_two, required),
 743         (6, node_two, required),
 744         (8, two_to_one, required),
 745         (10, capacity_sats, required),
 746         (12, announcement_message, required),
 747 });
 748
 749 /// A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
 750 /// source node to a target node.
 751 #[derive(Clone)]
 752 pub struct DirectedChannelInfo<'a> {
 753         channel: &'a ChannelInfo,
 754         direction: Option<&'a ChannelUpdateInfo>,
 755         htlc_maximum_msat: u64,
 756         effective_capacity: EffectiveCapacity,
 757 }
 758
 759 impl<'a> DirectedChannelInfo<'a> {
 760         #[inline]
 761         fn new(channel: &'a ChannelInfo, direction: Option<&'a ChannelUpdateInfo>) -> Self {
 762                 let htlc_maximum_msat = direction.and_then(|direction| direction.htlc_maximum_msat);
 763                 let capacity_msat = channel.capacity_sats.map(|capacity_sats| capacity_sats * 1000);
 764
 765                 let (htlc_maximum_msat, effective_capacity) = match (htlc_maximum_msat, capacity_msat) {
 766                         (Some(amount_msat), Some(capacity_msat)) => {
 767                                 let htlc_maximum_msat = cmp::min(amount_msat, capacity_msat);
 768                                 (htlc_maximum_msat, EffectiveCapacity::Total { capacity_msat })
 769                         },
 770                         (Some(amount_msat), None) => {
 771                                 (amount_msat, EffectiveCapacity::MaximumHTLC { amount_msat })
 772                         },
 773                         (None, Some(capacity_msat)) => {
 774                                 (capacity_msat, EffectiveCapacity::Total { capacity_msat })
 775                         },
 776                         (None, None) => (EffectiveCapacity::Unknown.as_msat(), EffectiveCapacity::Unknown),
 777                 };
 778
 779                 Self {
 780                         channel, direction, htlc_maximum_msat, effective_capacity
 781                 }
 782         }
 783
 784         /// Returns information for the channel.
 785         pub fn channel(&self) -> &'a ChannelInfo { self.channel }
 786
 787         /// Returns information for the direction.
 788         pub fn direction(&self) -> Option<&'a ChannelUpdateInfo> { self.direction }
 789
 790         /// Returns the maximum HTLC amount allowed over the channel in the direction.
 791         pub fn htlc_maximum_msat(&self) -> u64 {
 792                 self.htlc_maximum_msat
 793         }
 794
 795         /// Returns the [`EffectiveCapacity`] of the channel in the direction.
 796         ///
 797         /// This is either the total capacity from the funding transaction, if known, or the
 798         /// `htlc_maximum_msat` for the direction as advertised by the gossip network, if known,
 799         /// otherwise.
 800         pub fn effective_capacity(&self) -> EffectiveCapacity {
 801                 self.effective_capacity
 802         }
 803
 804         /// Returns `Some` if [`ChannelUpdateInfo`] is available in the direction.
 805         pub(super) fn with_update(self) -> Option<DirectedChannelInfoWithUpdate<'a>> {
 806                 match self.direction {
 807                         Some(_) => Some(DirectedChannelInfoWithUpdate { inner: self }),
 808                         None => None,
 809                 }
 810         }
 811 }
 812
 813 impl<'a> fmt::Debug for DirectedChannelInfo<'a> {
 814         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 815                 f.debug_struct("DirectedChannelInfo")
 816                         .field("channel", &self.channel)
 817                         .finish()
 818         }
 819 }
 820
 821 /// A [`DirectedChannelInfo`] with [`ChannelUpdateInfo`] available in its direction.
 822 #[derive(Clone)]
 823 pub(super) struct DirectedChannelInfoWithUpdate<'a> {
 824         inner: DirectedChannelInfo<'a>,
 825 }
 826
 827 impl<'a> DirectedChannelInfoWithUpdate<'a> {
 828         /// Returns information for the channel.
 829         #[inline]
 830         pub(super) fn channel(&self) -> &'a ChannelInfo { &self.inner.channel }
 831
 832         /// Returns information for the direction.
 833         #[inline]
 834         pub(super) fn direction(&self) -> &'a ChannelUpdateInfo { self.inner.direction.unwrap() }
 835
 836         /// Returns the [`EffectiveCapacity`] of the channel in the direction.
 837         #[inline]
 838         pub(super) fn effective_capacity(&self) -> EffectiveCapacity { self.inner.effective_capacity() }
 839
 840         /// Returns the maximum HTLC amount allowed over the channel in the direction.
 841         #[inline]
 842         pub(super) fn htlc_maximum_msat(&self) -> u64 { self.inner.htlc_maximum_msat() }
 843 }
 844
 845 impl<'a> fmt::Debug for DirectedChannelInfoWithUpdate<'a> {
 846         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 847                 self.inner.fmt(f)
 848         }
 849 }
 850
 851 /// The effective capacity of a channel for routing purposes.
 852 ///
 853 /// While this may be smaller than the actual channel capacity, amounts greater than
 854 /// [`Self::as_msat`] should not be routed through the channel.
 855 #[derive(Clone, Copy)]
 856 pub enum EffectiveCapacity {
 857         /// The available liquidity in the channel known from being a channel counterparty, and thus a
 858         /// direct hop.
 859         ExactLiquidity {
 860                 /// Either the inbound or outbound liquidity depending on the direction, denominated in
 861                 /// millisatoshi.
 862                 liquidity_msat: u64,
 863         },
 864         /// The maximum HTLC amount in one direction as advertised on the gossip network.
 865         MaximumHTLC {
 866                 /// The maximum HTLC amount denominated in millisatoshi.
 867                 amount_msat: u64,
 868         },
 869         /// The total capacity of the channel as determined by the funding transaction.
 870         Total {
 871                 /// The funding amount denominated in millisatoshi.
 872                 capacity_msat: u64,
 873         },
 874         /// A capacity sufficient to route any payment, typically used for private channels provided by
 875         /// an invoice.
 876         Infinite,
 877         /// A capacity that is unknown possibly because either the chain state is unavailable to know
 878         /// the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
 879         Unknown,
 880 }
 881
 882 /// The presumed channel capacity denominated in millisatoshi for [`EffectiveCapacity::Unknown`] to
 883 /// use when making routing decisions.
 884 pub const UNKNOWN_CHANNEL_CAPACITY_MSAT: u64 = 250_000 * 1000;
 885
 886 impl EffectiveCapacity {
 887         /// Returns the effective capacity denominated in millisatoshi.
 888         pub fn as_msat(&self) -> u64 {
 889                 match self {
 890                         EffectiveCapacity::ExactLiquidity { liquidity_msat } => *liquidity_msat,
 891                         EffectiveCapacity::MaximumHTLC { amount_msat } => *amount_msat,
 892                         EffectiveCapacity::Total { capacity_msat } => *capacity_msat,
 893                         EffectiveCapacity::Infinite => u64::max_value(),
 894                         EffectiveCapacity::Unknown => UNKNOWN_CHANNEL_CAPACITY_MSAT,
 895                 }
 896         }
 897 }
 898
 899 /// Fees for routing via a given channel or a node
 900 #[derive(Eq, PartialEq, Copy, Clone, Debug, Hash)]
 901 pub struct RoutingFees {
 902         /// Flat routing fee in satoshis
 903         pub base_msat: u32,
 904         /// Liquidity-based routing fee in millionths of a routed amount.
 905         /// In other words, 10000 is 1%.
 906         pub proportional_millionths: u32,
 907 }
 908
 909 impl_writeable_tlv_based!(RoutingFees, {
 910         (0, base_msat, required),
 911         (2, proportional_millionths, required)
 912 });
 913
 914 #[derive(Clone, Debug, PartialEq)]
 915 /// Information received in the latest node_announcement from this node.
 916 pub struct NodeAnnouncementInfo {
 917         /// Protocol features the node announced support for
 918         pub features: NodeFeatures,
 919         /// When the last known update to the node state was issued.
 920         /// Value is opaque, as set in the announcement.
 921         pub last_update: u32,
 922         /// Color assigned to the node
 923         pub rgb: [u8; 3],
 924         /// Moniker assigned to the node.
 925         /// May be invalid or malicious (eg control chars),
 926         /// should not be exposed to the user.
 927         pub alias: [u8; 32],
 928         /// Internet-level addresses via which one can connect to the node
 929         pub addresses: Vec<NetAddress>,
 930         /// An initial announcement of the node
 931         /// Mostly redundant with the data we store in fields explicitly.
 932         /// Everything else is useful only for sending out for initial routing sync.
 933         /// Not stored if contains excess data to prevent DoS.
 934         pub announcement_message: Option<NodeAnnouncement>
 935 }
 936
 937 impl_writeable_tlv_based!(NodeAnnouncementInfo, {
 938         (0, features, required),
 939         (2, last_update, required),
 940         (4, rgb, required),
 941         (6, alias, required),
 942         (8, announcement_message, option),
 943         (10, addresses, vec_type),
 944 });
 945
 946 #[derive(Clone, Debug, PartialEq)]
 947 /// Details about a node in the network, known from the network announcement.
 948 pub struct NodeInfo {
 949         /// All valid channels a node has announced
 950         pub channels: Vec<u64>,
 951         /// Lowest fees enabling routing via any of the enabled, known channels to a node.
 952         /// The two fields (flat and proportional fee) are independent,
 953         /// meaning they don't have to refer to the same channel.
 954         pub lowest_inbound_channel_fees: Option<RoutingFees>,
 955         /// More information about a node from node_announcement.
 956         /// Optional because we store a Node entry after learning about it from
 957         /// a channel announcement, but before receiving a node announcement.
 958         pub announcement_info: Option<NodeAnnouncementInfo>
 959 }
 960
 961 impl fmt::Display for NodeInfo {
 962         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 963                 write!(f, "lowest_inbound_channel_fees: {:?}, channels: {:?}, announcement_info: {:?}",
 964                    self.lowest_inbound_channel_fees, &self.channels[..], self.announcement_info)?;
 965                 Ok(())
 966         }
 967 }
 968
 969 impl_writeable_tlv_based!(NodeInfo, {
 970         (0, lowest_inbound_channel_fees, option),
 971         (2, announcement_info, option),
 972         (4, channels, vec_type),
 973 });
 974
 975 const SERIALIZATION_VERSION: u8 = 1;
 976 const MIN_SERIALIZATION_VERSION: u8 = 1;
 977
 978 impl Writeable for NetworkGraph {
 979         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 980                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
 981
 982                 self.genesis_hash.write(writer)?;
 983                 let channels = self.channels.read().unwrap();
 984                 (channels.len() as u64).write(writer)?;
 985                 for (ref chan_id, ref chan_info) in channels.iter() {
 986                         (*chan_id).write(writer)?;
 987                         chan_info.write(writer)?;
 988                 }
 989                 let nodes = self.nodes.read().unwrap();
 990                 (nodes.len() as u64).write(writer)?;
 991                 for (ref node_id, ref node_info) in nodes.iter() {
 992                         node_id.write(writer)?;
 993                         node_info.write(writer)?;
 994                 }
 995
 996                 let last_rapid_gossip_sync_timestamp = self.get_last_rapid_gossip_sync_timestamp();
 997                 write_tlv_fields!(writer, {
 998                         (1, last_rapid_gossip_sync_timestamp, option),
 999                 });
1000                 Ok(())
1001         }
1002 }
1003
1004 impl Readable for NetworkGraph {
1005         fn read<R: io::Read>(reader: &mut R) -> Result<NetworkGraph, DecodeError> {
1006                 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
1007
1008                 let genesis_hash: BlockHash = Readable::read(reader)?;
1009                 let channels_count: u64 = Readable::read(reader)?;
1010                 let mut channels = BTreeMap::new();
1011                 for _ in 0..channels_count {
1012                         let chan_id: u64 = Readable::read(reader)?;
1013                         let chan_info = Readable::read(reader)?;
1014                         channels.insert(chan_id, chan_info);
1015                 }
1016                 let nodes_count: u64 = Readable::read(reader)?;
1017                 let mut nodes = BTreeMap::new();
1018                 for _ in 0..nodes_count {
1019                         let node_id = Readable::read(reader)?;
1020                         let node_info = Readable::read(reader)?;
1021                         nodes.insert(node_id, node_info);
1022                 }
1023
1024                 let mut last_rapid_gossip_sync_timestamp: Option<u32> = None;
1025                 read_tlv_fields!(reader, {
1026                         (1, last_rapid_gossip_sync_timestamp, option),
1027                 });
1028
1029                 Ok(NetworkGraph {
1030                         genesis_hash,
1031                         channels: RwLock::new(channels),
1032                         nodes: RwLock::new(nodes),
1033                         last_rapid_gossip_sync_timestamp: Mutex::new(last_rapid_gossip_sync_timestamp),
1034                 })
1035         }
1036 }
1037
1038 impl fmt::Display for NetworkGraph {
1039         fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1040                 writeln!(f, "Network map\n[Channels]")?;
1041                 for (key, val) in self.channels.read().unwrap().iter() {
1042                         writeln!(f, " {}: {}", key, val)?;
1043                 }
1044                 writeln!(f, "[Nodes]")?;
1045                 for (&node_id, val) in self.nodes.read().unwrap().iter() {
1046                         writeln!(f, " {}: {}", log_bytes!(node_id.as_slice()), val)?;
1047                 }
1048                 Ok(())
1049         }
1050 }
1051
1052 impl PartialEq for NetworkGraph {
1053         fn eq(&self, other: &Self) -> bool {
1054                 self.genesis_hash == other.genesis_hash &&
1055                         *self.channels.read().unwrap() == *other.channels.read().unwrap() &&
1056                         *self.nodes.read().unwrap() == *other.nodes.read().unwrap()
1057         }
1058 }
1059
1060 impl NetworkGraph {
1061         /// Creates a new, empty, network graph.
1062         pub fn new(genesis_hash: BlockHash) -> NetworkGraph {
1063                 Self {
1064                         genesis_hash,
1065                         channels: RwLock::new(BTreeMap::new()),
1066                         nodes: RwLock::new(BTreeMap::new()),
1067                         last_rapid_gossip_sync_timestamp: Mutex::new(None),
1068                 }
1069         }
1070
1071         /// Returns a read-only view of the network graph.
1072         pub fn read_only(&'_ self) -> ReadOnlyNetworkGraph<'_> {
1073                 let channels = self.channels.read().unwrap();
1074                 let nodes = self.nodes.read().unwrap();
1075                 ReadOnlyNetworkGraph {
1076                         channels,
1077                         nodes,
1078                 }
1079         }
1080
1081         /// The unix timestamp provided by the most recent rapid gossip sync.
1082         /// It will be set by the rapid sync process after every sync completion.
1083         pub fn get_last_rapid_gossip_sync_timestamp(&self) -> Option<u32> {
1084                 self.last_rapid_gossip_sync_timestamp.lock().unwrap().clone()
1085         }
1086
1087         /// Update the unix timestamp provided by the most recent rapid gossip sync.
1088         /// This should be done automatically by the rapid sync process after every sync completion.
1089         pub fn set_last_rapid_gossip_sync_timestamp(&self, last_rapid_gossip_sync_timestamp: u32) {
1090                 self.last_rapid_gossip_sync_timestamp.lock().unwrap().replace(last_rapid_gossip_sync_timestamp);
1091         }
1092
1093         /// Clears the `NodeAnnouncementInfo` field for all nodes in the `NetworkGraph` for testing
1094         /// purposes.
1095         #[cfg(test)]
1096         pub fn clear_nodes_announcement_info(&self) {
1097                 for node in self.nodes.write().unwrap().iter_mut() {
1098                         node.1.announcement_info = None;
1099                 }
1100         }
1101
1102         /// For an already known node (from channel announcements), update its stored properties from a
1103         /// given node announcement.
1104         ///
1105         /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1106         /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1107         /// routing messages from a source using a protocol other than the lightning P2P protocol.
1108         pub fn update_node_from_announcement<T: secp256k1::Verification>(&self, msg: &msgs::NodeAnnouncement, secp_ctx: &Secp256k1<T>) -> Result<(), LightningError> {
1109                 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1110                 secp_verify_sig!(secp_ctx, &msg_hash, &msg.signature, &msg.contents.node_id, "node_announcement");
1111                 self.update_node_from_announcement_intern(&msg.contents, Some(&msg))
1112         }
1113
1114         /// For an already known node (from channel announcements), update its stored properties from a
1115         /// given node announcement without verifying the associated signatures. Because we aren't
1116         /// given the associated signatures here we cannot relay the node announcement to any of our
1117         /// peers.
1118         pub fn update_node_from_unsigned_announcement(&self, msg: &msgs::UnsignedNodeAnnouncement) -> Result<(), LightningError> {
1119                 self.update_node_from_announcement_intern(msg, None)
1120         }
1121
1122         fn update_node_from_announcement_intern(&self, msg: &msgs::UnsignedNodeAnnouncement, full_msg: Option<&msgs::NodeAnnouncement>) -> Result<(), LightningError> {
1123                 match self.nodes.write().unwrap().get_mut(&NodeId::from_pubkey(&msg.node_id)) {
1124                         None => Err(LightningError{err: "No existing channels for node_announcement".to_owned(), action: ErrorAction::IgnoreError}),
1125                         Some(node) => {
1126                                 if let Some(node_info) = node.announcement_info.as_ref() {
1127                                         // The timestamp field is somewhat of a misnomer - the BOLTs use it to order
1128                                         // updates to ensure you always have the latest one, only vaguely suggesting
1129                                         // that it be at least the current time.
1130                                         if node_info.last_update  > msg.timestamp {
1131                                                 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1132                                         } else if node_info.last_update  == msg.timestamp {
1133                                                 return Err(LightningError{err: "Update had the same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1134                                         }
1135                                 }
1136
1137                                 let should_relay =
1138                                         msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1139                                         msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
1140                                         msg.excess_data.len() + msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY;
1141                                 node.announcement_info = Some(NodeAnnouncementInfo {
1142                                         features: msg.features.clone(),
1143                                         last_update: msg.timestamp,
1144                                         rgb: msg.rgb,
1145                                         alias: msg.alias,
1146                                         addresses: msg.addresses.clone(),
1147                                         announcement_message: if should_relay { full_msg.cloned() } else { None },
1148                                 });
1149
1150                                 Ok(())
1151                         }
1152                 }
1153         }
1154
1155         /// Store or update channel info from a channel announcement.
1156         ///
1157         /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1158         /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1159         /// routing messages from a source using a protocol other than the lightning P2P protocol.
1160         ///
1161         /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1162         /// the corresponding UTXO exists on chain and is correctly-formatted.
1163         pub fn update_channel_from_announcement<T: secp256k1::Verification, C: Deref>(
1164                 &self, msg: &msgs::ChannelAnnouncement, chain_access: &Option<C>, secp_ctx: &Secp256k1<T>
1165         ) -> Result<(), LightningError>
1166         where
1167                 C::Target: chain::Access,
1168         {
1169                 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
1170                 secp_verify_sig!(secp_ctx, &msg_hash, &msg.node_signature_1, &msg.contents.node_id_1, "channel_announcement");
1171                 secp_verify_sig!(secp_ctx, &msg_hash, &msg.node_signature_2, &msg.contents.node_id_2, "channel_announcement");
1172                 secp_verify_sig!(secp_ctx, &msg_hash, &msg.bitcoin_signature_1, &msg.contents.bitcoin_key_1, "channel_announcement");
1173                 secp_verify_sig!(secp_ctx, &msg_hash, &msg.bitcoin_signature_2, &msg.contents.bitcoin_key_2, "channel_announcement");
1174                 self.update_channel_from_unsigned_announcement_intern(&msg.contents, Some(msg), chain_access)
1175         }
1176
1177         /// Store or update channel info from a channel announcement without verifying the associated
1178         /// signatures. Because we aren't given the associated signatures here we cannot relay the
1179         /// channel announcement to any of our peers.
1180         ///
1181         /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1182         /// the corresponding UTXO exists on chain and is correctly-formatted.
1183         pub fn update_channel_from_unsigned_announcement<C: Deref>(
1184                 &self, msg: &msgs::UnsignedChannelAnnouncement, chain_access: &Option<C>
1185         ) -> Result<(), LightningError>
1186         where
1187                 C::Target: chain::Access,
1188         {
1189                 self.update_channel_from_unsigned_announcement_intern(msg, None, chain_access)
1190         }
1191
1192         /// Update channel from partial announcement data received via rapid gossip sync
1193         ///
1194         /// `timestamp: u64`: Timestamp emulating the backdated original announcement receipt (by the
1195         /// rapid gossip sync server)
1196         ///
1197         /// All other parameters as used in [`msgs::UnsignedChannelAnnouncement`] fields.
1198         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> {
1199                 if node_id_1 == node_id_2 {
1200                         return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1201                 };
1202
1203                 let node_1 = NodeId::from_pubkey(&node_id_1);
1204                 let node_2 = NodeId::from_pubkey(&node_id_2);
1205                 let channel_info = ChannelInfo {
1206                         features,
1207                         node_one: node_1.clone(),
1208                         one_to_two: None,
1209                         node_two: node_2.clone(),
1210                         two_to_one: None,
1211                         capacity_sats: None,
1212                         announcement_message: None,
1213                         announcement_received_time: timestamp,
1214                 };
1215
1216                 self.add_channel_between_nodes(short_channel_id, channel_info, None)
1217         }
1218
1219         fn add_channel_between_nodes(&self, short_channel_id: u64, channel_info: ChannelInfo, utxo_value: Option<u64>) -> Result<(), LightningError> {
1220                 let mut channels = self.channels.write().unwrap();
1221                 let mut nodes = self.nodes.write().unwrap();
1222
1223                 let node_id_a = channel_info.node_one.clone();
1224                 let node_id_b = channel_info.node_two.clone();
1225
1226                 match channels.entry(short_channel_id) {
1227                         BtreeEntry::Occupied(mut entry) => {
1228                                 //TODO: because asking the blockchain if short_channel_id is valid is only optional
1229                                 //in the blockchain API, we need to handle it smartly here, though it's unclear
1230                                 //exactly how...
1231                                 if utxo_value.is_some() {
1232                                         // Either our UTXO provider is busted, there was a reorg, or the UTXO provider
1233                                         // only sometimes returns results. In any case remove the previous entry. Note
1234                                         // that the spec expects us to "blacklist" the node_ids involved, but we can't
1235                                         // do that because
1236                                         // a) we don't *require* a UTXO provider that always returns results.
1237                                         // b) we don't track UTXOs of channels we know about and remove them if they
1238                                         //    get reorg'd out.
1239                                         // c) it's unclear how to do so without exposing ourselves to massive DoS risk.
1240                                         Self::remove_channel_in_nodes(&mut nodes, &entry.get(), short_channel_id);
1241                                         *entry.get_mut() = channel_info;
1242                                 } else {
1243                                         return Err(LightningError{err: "Already have knowledge of channel".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1244                                 }
1245                         },
1246                         BtreeEntry::Vacant(entry) => {
1247                                 entry.insert(channel_info);
1248                         }
1249                 };
1250
1251                 for current_node_id in [node_id_a, node_id_b].iter() {
1252                         match nodes.entry(current_node_id.clone()) {
1253                                 BtreeEntry::Occupied(node_entry) => {
1254                                         node_entry.into_mut().channels.push(short_channel_id);
1255                                 },
1256                                 BtreeEntry::Vacant(node_entry) => {
1257                                         node_entry.insert(NodeInfo {
1258                                                 channels: vec!(short_channel_id),
1259                                                 lowest_inbound_channel_fees: None,
1260                                                 announcement_info: None,
1261                                         });
1262                                 }
1263                         };
1264                 };
1265
1266                 Ok(())
1267         }
1268
1269         fn update_channel_from_unsigned_announcement_intern<C: Deref>(
1270                 &self, msg: &msgs::UnsignedChannelAnnouncement, full_msg: Option<&msgs::ChannelAnnouncement>, chain_access: &Option<C>
1271         ) -> Result<(), LightningError>
1272         where
1273                 C::Target: chain::Access,
1274         {
1275                 if msg.node_id_1 == msg.node_id_2 || msg.bitcoin_key_1 == msg.bitcoin_key_2 {
1276                         return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
1277                 }
1278
1279                 let utxo_value = match &chain_access {
1280                         &None => {
1281                                 // Tentatively accept, potentially exposing us to DoS attacks
1282                                 None
1283                         },
1284                         &Some(ref chain_access) => {
1285                                 match chain_access.get_utxo(&msg.chain_hash, msg.short_channel_id) {
1286                                         Ok(TxOut { value, script_pubkey }) => {
1287                                                 let expected_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1288                                                                                     .push_slice(&msg.bitcoin_key_1.serialize())
1289                                                                                     .push_slice(&msg.bitcoin_key_2.serialize())
1290                                                                                     .push_opcode(opcodes::all::OP_PUSHNUM_2)
1291                                                                                     .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
1292                                                 if script_pubkey != expected_script {
1293                                                         return Err(LightningError{err: format!("Channel announcement key ({}) didn't match on-chain script ({})", script_pubkey.to_hex(), expected_script.to_hex()), action: ErrorAction::IgnoreError});
1294                                                 }
1295                                                 //TODO: Check if value is worth storing, use it to inform routing, and compare it
1296                                                 //to the new HTLC max field in channel_update
1297                                                 Some(value)
1298                                         },
1299                                         Err(chain::AccessError::UnknownChain) => {
1300                                                 return Err(LightningError{err: format!("Channel announced on an unknown chain ({})", msg.chain_hash.encode().to_hex()), action: ErrorAction::IgnoreError});
1301                                         },
1302                                         Err(chain::AccessError::UnknownTx) => {
1303                                                 return Err(LightningError{err: "Channel announced without corresponding UTXO entry".to_owned(), action: ErrorAction::IgnoreError});
1304                                         },
1305                                 }
1306                         },
1307                 };
1308
1309                 #[allow(unused_mut, unused_assignments)]
1310                 let mut announcement_received_time = 0;
1311                 #[cfg(feature = "std")]
1312                 {
1313                         announcement_received_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1314                 }
1315
1316                 let chan_info = ChannelInfo {
1317                         features: msg.features.clone(),
1318                         node_one: NodeId::from_pubkey(&msg.node_id_1),
1319                         one_to_two: None,
1320                         node_two: NodeId::from_pubkey(&msg.node_id_2),
1321                         two_to_one: None,
1322                         capacity_sats: utxo_value,
1323                         announcement_message: if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1324                                 { full_msg.cloned() } else { None },
1325                         announcement_received_time,
1326                 };
1327
1328                 self.add_channel_between_nodes(msg.short_channel_id, chan_info, utxo_value)
1329         }
1330
1331         /// Marks a channel in the graph as failed if a corresponding HTLC fail was sent.
1332         /// If permanent, removes a channel from the local storage.
1333         /// May cause the removal of nodes too, if this was their last channel.
1334         /// If not permanent, makes channels unavailable for routing.
1335         pub fn channel_failed(&self, short_channel_id: u64, is_permanent: bool) {
1336                 let mut channels = self.channels.write().unwrap();
1337                 if is_permanent {
1338                         if let Some(chan) = channels.remove(&short_channel_id) {
1339                                 let mut nodes = self.nodes.write().unwrap();
1340                                 Self::remove_channel_in_nodes(&mut nodes, &chan, short_channel_id);
1341                         }
1342                 } else {
1343                         if let Some(chan) = channels.get_mut(&short_channel_id) {
1344                                 if let Some(one_to_two) = chan.one_to_two.as_mut() {
1345                                         one_to_two.enabled = false;
1346                                 }
1347                                 if let Some(two_to_one) = chan.two_to_one.as_mut() {
1348                                         two_to_one.enabled = false;
1349                                 }
1350                         }
1351                 }
1352         }
1353
1354         /// Marks a node in the graph as failed.
1355         pub fn node_failed(&self, _node_id: &PublicKey, is_permanent: bool) {
1356                 if is_permanent {
1357                         // TODO: Wholly remove the node
1358                 } else {
1359                         // TODO: downgrade the node
1360                 }
1361         }
1362
1363         #[cfg(feature = "std")]
1364         /// Removes information about channels that we haven't heard any updates about in some time.
1365         /// This can be used regularly to prune the network graph of channels that likely no longer
1366         /// exist.
1367         ///
1368         /// While there is no formal requirement that nodes regularly re-broadcast their channel
1369         /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1370         /// pruning occur for updates which are at least two weeks old, which we implement here.
1371         ///
1372         /// Note that for users of the `lightning-background-processor` crate this method may be
1373         /// automatically called regularly for you.
1374         ///
1375         /// This method is only available with the `std` feature. See
1376         /// [`NetworkGraph::remove_stale_channels_with_time`] for `no-std` use.
1377         pub fn remove_stale_channels(&self) {
1378                 let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1379                 self.remove_stale_channels_with_time(time);
1380         }
1381
1382         /// Removes information about channels that we haven't heard any updates about in some time.
1383         /// This can be used regularly to prune the network graph of channels that likely no longer
1384         /// exist.
1385         ///
1386         /// While there is no formal requirement that nodes regularly re-broadcast their channel
1387         /// updates every two weeks, the non-normative section of BOLT 7 currently suggests that
1388         /// pruning occur for updates which are at least two weeks old, which we implement here.
1389         ///
1390         /// This function takes the current unix time as an argument. For users with the `std` feature
1391         /// enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
1392         pub fn remove_stale_channels_with_time(&self, current_time_unix: u64) {
1393                 let mut channels = self.channels.write().unwrap();
1394                 // Time out if we haven't received an update in at least 14 days.
1395                 if current_time_unix > u32::max_value() as u64 { return; } // Remove by 2106
1396                 if current_time_unix < STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS { return; }
1397                 let min_time_unix: u32 = (current_time_unix - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS) as u32;
1398                 // Sadly BTreeMap::retain was only stabilized in 1.53 so we can't switch to it for some
1399                 // time.
1400                 let mut scids_to_remove = Vec::new();
1401                 for (scid, info) in channels.iter_mut() {
1402                         if info.one_to_two.is_some() && info.one_to_two.as_ref().unwrap().last_update < min_time_unix {
1403                                 info.one_to_two = None;
1404                         }
1405                         if info.two_to_one.is_some() && info.two_to_one.as_ref().unwrap().last_update < min_time_unix {
1406                                 info.two_to_one = None;
1407                         }
1408                         if info.one_to_two.is_none() && info.two_to_one.is_none() {
1409                                 // We check the announcement_received_time here to ensure we don't drop
1410                                 // announcements that we just received and are just waiting for our peer to send a
1411                                 // channel_update for.
1412                                 if info.announcement_received_time < min_time_unix as u64 {
1413                                         scids_to_remove.push(*scid);
1414                                 }
1415                         }
1416                 }
1417                 if !scids_to_remove.is_empty() {
1418                         let mut nodes = self.nodes.write().unwrap();
1419                         for scid in scids_to_remove {
1420                                 let info = channels.remove(&scid).expect("We just accessed this scid, it should be present");
1421                                 Self::remove_channel_in_nodes(&mut nodes, &info, scid);
1422                         }
1423                 }
1424         }
1425
1426         /// For an already known (from announcement) channel, update info about one of the directions
1427         /// of the channel.
1428         ///
1429         /// You probably don't want to call this directly, instead relying on a P2PGossipSync's
1430         /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1431         /// routing messages from a source using a protocol other than the lightning P2P protocol.
1432         ///
1433         /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1434         /// materially in the future will be rejected.
1435         pub fn update_channel<T: secp256k1::Verification>(&self, msg: &msgs::ChannelUpdate, secp_ctx: &Secp256k1<T>) -> Result<(), LightningError> {
1436                 self.update_channel_intern(&msg.contents, Some(&msg), Some((&msg.signature, secp_ctx)))
1437         }
1438
1439         /// For an already known (from announcement) channel, update info about one of the directions
1440         /// of the channel without verifying the associated signatures. Because we aren't given the
1441         /// associated signatures here we cannot relay the channel update to any of our peers.
1442         ///
1443         /// If built with `no-std`, any updates with a timestamp more than two weeks in the past or
1444         /// materially in the future will be rejected.
1445         pub fn update_channel_unsigned(&self, msg: &msgs::UnsignedChannelUpdate) -> Result<(), LightningError> {
1446                 self.update_channel_intern(msg, None, None::<(&secp256k1::ecdsa::Signature, &Secp256k1<secp256k1::VerifyOnly>)>)
1447         }
1448
1449         fn update_channel_intern<T: secp256k1::Verification>(&self, msg: &msgs::UnsignedChannelUpdate, full_msg: Option<&msgs::ChannelUpdate>, sig_info: Option<(&secp256k1::ecdsa::Signature, &Secp256k1<T>)>) -> Result<(), LightningError> {
1450                 let dest_node_id;
1451                 let chan_enabled = msg.flags & (1 << 1) != (1 << 1);
1452                 let chan_was_enabled;
1453
1454                 #[cfg(all(feature = "std", not(test), not(feature = "_test_utils")))]
1455                 {
1456                         // Note that many tests rely on being able to set arbitrarily old timestamps, thus we
1457                         // disable this check during tests!
1458                         let time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1459                         if (msg.timestamp as u64) < time - STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS {
1460                                 return Err(LightningError{err: "channel_update is older than two weeks old".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1461                         }
1462                         if msg.timestamp as u64 > time + 60 * 60 * 24 {
1463                                 return Err(LightningError{err: "channel_update has a timestamp more than a day in the future".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1464                         }
1465                 }
1466
1467                 let mut channels = self.channels.write().unwrap();
1468                 match channels.get_mut(&msg.short_channel_id) {
1469                         None => return Err(LightningError{err: "Couldn't find channel for update".to_owned(), action: ErrorAction::IgnoreError}),
1470                         Some(channel) => {
1471                                 if let OptionalField::Present(htlc_maximum_msat) = msg.htlc_maximum_msat {
1472                                         if htlc_maximum_msat > MAX_VALUE_MSAT {
1473                                                 return Err(LightningError{err: "htlc_maximum_msat is larger than maximum possible msats".to_owned(), action: ErrorAction::IgnoreError});
1474                                         }
1475
1476                                         if let Some(capacity_sats) = channel.capacity_sats {
1477                                                 // It's possible channel capacity is available now, although it wasn't available at announcement (so the field is None).
1478                                                 // Don't query UTXO set here to reduce DoS risks.
1479                                                 if capacity_sats > MAX_VALUE_MSAT / 1000 || htlc_maximum_msat > capacity_sats * 1000 {
1480                                                         return Err(LightningError{err: "htlc_maximum_msat is larger than channel capacity or capacity is bogus".to_owned(), action: ErrorAction::IgnoreError});
1481                                                 }
1482                                         }
1483                                 }
1484                                 macro_rules! check_update_latest {
1485                                         ($target: expr) => {
1486                                                 if let Some(existing_chan_info) = $target.as_ref() {
1487                                                         // The timestamp field is somewhat of a misnomer - the BOLTs use it to
1488                                                         // order updates to ensure you always have the latest one, only
1489                                                         // suggesting  that it be at least the current time. For
1490                                                         // channel_updates specifically, the BOLTs discuss the possibility of
1491                                                         // pruning based on the timestamp field being more than two weeks old,
1492                                                         // but only in the non-normative section.
1493                                                         if existing_chan_info.last_update > msg.timestamp {
1494                                                                 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1495                                                         } else if existing_chan_info.last_update == msg.timestamp {
1496                                                                 return Err(LightningError{err: "Update had same timestamp as last processed update".to_owned(), action: ErrorAction::IgnoreDuplicateGossip});
1497                                                         }
1498                                                         chan_was_enabled = existing_chan_info.enabled;
1499                                                 } else {
1500                                                         chan_was_enabled = false;
1501                                                 }
1502                                         }
1503                                 }
1504
1505                                 macro_rules! get_new_channel_info {
1506                                         () => { {
1507                                                 let last_update_message = if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1508                                                         { full_msg.cloned() } else { None };
1509
1510                                                 let updated_channel_update_info = ChannelUpdateInfo {
1511                                                         enabled: chan_enabled,
1512                                                         last_update: msg.timestamp,
1513                                                         cltv_expiry_delta: msg.cltv_expiry_delta,
1514                                                         htlc_minimum_msat: msg.htlc_minimum_msat,
1515                                                         htlc_maximum_msat: if let OptionalField::Present(max_value) = msg.htlc_maximum_msat { Some(max_value) } else { None },
1516                                                         fees: RoutingFees {
1517                                                                 base_msat: msg.fee_base_msat,
1518                                                                 proportional_millionths: msg.fee_proportional_millionths,
1519                                                         },
1520                                                         last_update_message
1521                                                 };
1522                                                 Some(updated_channel_update_info)
1523                                         } }
1524                                 }
1525
1526                                 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1527                                 if msg.flags & 1 == 1 {
1528                                         dest_node_id = channel.node_one.clone();
1529                                         check_update_latest!(channel.two_to_one);
1530                                         if let Some((sig, ctx)) = sig_info {
1531                                                 secp_verify_sig!(ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_two.as_slice()).map_err(|_| LightningError{
1532                                                         err: "Couldn't parse source node pubkey".to_owned(),
1533                                                         action: ErrorAction::IgnoreAndLog(Level::Debug)
1534                                                 })?, "channel_update");
1535                                         }
1536                                         channel.two_to_one = get_new_channel_info!();
1537                                 } else {
1538                                         dest_node_id = channel.node_two.clone();
1539                                         check_update_latest!(channel.one_to_two);
1540                                         if let Some((sig, ctx)) = sig_info {
1541                                                 secp_verify_sig!(ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_one.as_slice()).map_err(|_| LightningError{
1542                                                         err: "Couldn't parse destination node pubkey".to_owned(),
1543                                                         action: ErrorAction::IgnoreAndLog(Level::Debug)
1544                                                 })?, "channel_update");
1545                                         }
1546                                         channel.one_to_two = get_new_channel_info!();
1547                                 }
1548                         }
1549                 }
1550
1551                 let mut nodes = self.nodes.write().unwrap();
1552                 if chan_enabled {
1553                         let node = nodes.get_mut(&dest_node_id).unwrap();
1554                         let mut base_msat = msg.fee_base_msat;
1555                         let mut proportional_millionths = msg.fee_proportional_millionths;
1556                         if let Some(fees) = node.lowest_inbound_channel_fees {
1557                                 base_msat = cmp::min(base_msat, fees.base_msat);
1558                                 proportional_millionths = cmp::min(proportional_millionths, fees.proportional_millionths);
1559                         }
1560                         node.lowest_inbound_channel_fees = Some(RoutingFees {
1561                                 base_msat,
1562                                 proportional_millionths
1563                         });
1564                 } else if chan_was_enabled {
1565                         let node = nodes.get_mut(&dest_node_id).unwrap();
1566                         let mut lowest_inbound_channel_fees = None;
1567
1568                         for chan_id in node.channels.iter() {
1569                                 let chan = channels.get(chan_id).unwrap();
1570                                 let chan_info_opt;
1571                                 if chan.node_one == dest_node_id {
1572                                         chan_info_opt = chan.two_to_one.as_ref();
1573                                 } else {
1574                                         chan_info_opt = chan.one_to_two.as_ref();
1575                                 }
1576                                 if let Some(chan_info) = chan_info_opt {
1577                                         if chan_info.enabled {
1578                                                 let fees = lowest_inbound_channel_fees.get_or_insert(RoutingFees {
1579                                                         base_msat: u32::max_value(), proportional_millionths: u32::max_value() });
1580                                                 fees.base_msat = cmp::min(fees.base_msat, chan_info.fees.base_msat);
1581                                                 fees.proportional_millionths = cmp::min(fees.proportional_millionths, chan_info.fees.proportional_millionths);
1582                                         }
1583                                 }
1584                         }
1585
1586                         node.lowest_inbound_channel_fees = lowest_inbound_channel_fees;
1587                 }
1588
1589                 Ok(())
1590         }
1591
1592         fn remove_channel_in_nodes(nodes: &mut BTreeMap<NodeId, NodeInfo>, chan: &ChannelInfo, short_channel_id: u64) {
1593                 macro_rules! remove_from_node {
1594                         ($node_id: expr) => {
1595                                 if let BtreeEntry::Occupied(mut entry) = nodes.entry($node_id) {
1596                                         entry.get_mut().channels.retain(|chan_id| {
1597                                                 short_channel_id != *chan_id
1598                                         });
1599                                         if entry.get().channels.is_empty() {
1600                                                 entry.remove_entry();
1601                                         }
1602                                 } else {
1603                                         panic!("Had channel that pointed to unknown node (ie inconsistent network map)!");
1604                                 }
1605                         }
1606                 }
1607
1608                 remove_from_node!(chan.node_one);
1609                 remove_from_node!(chan.node_two);
1610         }
1611 }
1612
1613 impl ReadOnlyNetworkGraph<'_> {
1614         /// Returns all known valid channels' short ids along with announced channel info.
1615         ///
1616         /// (C-not exported) because we have no mapping for `BTreeMap`s
1617         pub fn channels(&self) -> &BTreeMap<u64, ChannelInfo> {
1618                 &*self.channels
1619         }
1620
1621         /// Returns all known nodes' public keys along with announced node info.
1622         ///
1623         /// (C-not exported) because we have no mapping for `BTreeMap`s
1624         pub fn nodes(&self) -> &BTreeMap<NodeId, NodeInfo> {
1625                 &*self.nodes
1626         }
1627
1628         /// Get network addresses by node id.
1629         /// Returns None if the requested node is completely unknown,
1630         /// or if node announcement for the node was never received.
1631         pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
1632                 if let Some(node) = self.nodes.get(&NodeId::from_pubkey(&pubkey)) {
1633                         if let Some(node_info) = node.announcement_info.as_ref() {
1634                                 return Some(node_info.addresses.clone())
1635                         }
1636                 }
1637                 None
1638         }
1639 }
1640
1641 #[cfg(test)]
1642 mod tests {
1643         use chain;
1644         use ln::PaymentHash;
1645         use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
1646         use routing::network_graph::{P2PGossipSync, NetworkGraph, NetworkUpdate, MAX_EXCESS_BYTES_FOR_RELAY};
1647         use ln::msgs::{Init, OptionalField, RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
1648                 UnsignedChannelAnnouncement, ChannelAnnouncement, UnsignedChannelUpdate, ChannelUpdate,
1649                 ReplyChannelRange, QueryChannelRange, QueryShortChannelIds, MAX_VALUE_MSAT};
1650         use util::test_utils;
1651         use util::logger::Logger;
1652         use util::ser::{Readable, Writeable};
1653         use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
1654         use util::scid_utils::scid_from_parts;
1655
1656         use super::STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS;
1657
1658         use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1659         use bitcoin::hashes::Hash;
1660         use bitcoin::network::constants::Network;
1661         use bitcoin::blockdata::constants::genesis_block;
1662         use bitcoin::blockdata::script::{Builder, Script};
1663         use bitcoin::blockdata::transaction::TxOut;
1664         use bitcoin::blockdata::opcodes;
1665
1666         use hex;
1667
1668         use bitcoin::secp256k1::{PublicKey, SecretKey};
1669         use bitcoin::secp256k1::{All, Secp256k1};
1670
1671         use io;
1672         use bitcoin::secp256k1;
1673         use prelude::*;
1674         use sync::Arc;
1675
1676         fn create_network_graph() -> NetworkGraph {
1677                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1678                 NetworkGraph::new(genesis_hash)
1679         }
1680
1681         fn create_gossip_sync(network_graph: &NetworkGraph) -> (
1682                 Secp256k1<All>, P2PGossipSync<&NetworkGraph, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>
1683         ) {
1684                 let secp_ctx = Secp256k1::new();
1685                 let logger = Arc::new(test_utils::TestLogger::new());
1686                 let gossip_sync = P2PGossipSync::new(network_graph, None, Arc::clone(&logger));
1687                 (secp_ctx, gossip_sync)
1688         }
1689
1690         #[test]
1691         fn request_full_sync_finite_times() {
1692                 let network_graph = create_network_graph();
1693                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
1694                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1695
1696                 assert!(gossip_sync.should_request_full_sync(&node_id));
1697                 assert!(gossip_sync.should_request_full_sync(&node_id));
1698                 assert!(gossip_sync.should_request_full_sync(&node_id));
1699                 assert!(gossip_sync.should_request_full_sync(&node_id));
1700                 assert!(gossip_sync.should_request_full_sync(&node_id));
1701                 assert!(!gossip_sync.should_request_full_sync(&node_id));
1702         }
1703
1704         fn get_signed_node_announcement<F: Fn(&mut UnsignedNodeAnnouncement)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> NodeAnnouncement {
1705                 let node_id = PublicKey::from_secret_key(&secp_ctx, node_key);
1706                 let mut unsigned_announcement = UnsignedNodeAnnouncement {
1707                         features: NodeFeatures::known(),
1708                         timestamp: 100,
1709                         node_id: node_id,
1710                         rgb: [0; 3],
1711                         alias: [0; 32],
1712                         addresses: Vec::new(),
1713                         excess_address_data: Vec::new(),
1714                         excess_data: Vec::new(),
1715                 };
1716                 f(&mut unsigned_announcement);
1717                 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1718                 NodeAnnouncement {
1719                         signature: secp_ctx.sign_ecdsa(&msghash, node_key),
1720                         contents: unsigned_announcement
1721                 }
1722         }
1723
1724         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 {
1725                 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_key);
1726                 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_key);
1727                 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1728                 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1729
1730                 let mut unsigned_announcement = UnsignedChannelAnnouncement {
1731                         features: ChannelFeatures::known(),
1732                         chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1733                         short_channel_id: 0,
1734                         node_id_1,
1735                         node_id_2,
1736                         bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1737                         bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1738                         excess_data: Vec::new(),
1739                 };
1740                 f(&mut unsigned_announcement);
1741                 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1742                 ChannelAnnouncement {
1743                         node_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_key),
1744                         node_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_key),
1745                         bitcoin_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_btckey),
1746                         bitcoin_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_btckey),
1747                         contents: unsigned_announcement,
1748                 }
1749         }
1750
1751         fn get_channel_script(secp_ctx: &Secp256k1<secp256k1::All>) -> Script {
1752                 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1753                 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1754                 Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1755                               .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_1_btckey).serialize())
1756                               .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_2_btckey).serialize())
1757                               .push_opcode(opcodes::all::OP_PUSHNUM_2)
1758                               .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
1759                               .to_v0_p2wsh()
1760         }
1761
1762         fn get_signed_channel_update<F: Fn(&mut UnsignedChannelUpdate)>(f: F, node_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> ChannelUpdate {
1763                 let mut unsigned_channel_update = UnsignedChannelUpdate {
1764                         chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1765                         short_channel_id: 0,
1766                         timestamp: 100,
1767                         flags: 0,
1768                         cltv_expiry_delta: 144,
1769                         htlc_minimum_msat: 1_000_000,
1770                         htlc_maximum_msat: OptionalField::Absent,
1771                         fee_base_msat: 10_000,
1772                         fee_proportional_millionths: 20,
1773                         excess_data: Vec::new()
1774                 };
1775                 f(&mut unsigned_channel_update);
1776                 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1777                 ChannelUpdate {
1778                         signature: secp_ctx.sign_ecdsa(&msghash, node_key),
1779                         contents: unsigned_channel_update
1780                 }
1781         }
1782
1783         #[test]
1784         fn handling_node_announcements() {
1785                 let network_graph = create_network_graph();
1786                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
1787
1788                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1789                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1790                 let zero_hash = Sha256dHash::hash(&[0; 32]);
1791
1792                 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
1793                 match gossip_sync.handle_node_announcement(&valid_announcement) {
1794                         Ok(_) => panic!(),
1795                         Err(e) => assert_eq!("No existing channels for node_announcement", e.err)
1796                 };
1797
1798                 {
1799                         // Announce a channel to add a corresponding node.
1800                         let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
1801                         match gossip_sync.handle_channel_announcement(&valid_announcement) {
1802                                 Ok(res) => assert!(res),
1803                                 _ => panic!()
1804                         };
1805                 }
1806
1807                 match gossip_sync.handle_node_announcement(&valid_announcement) {
1808                         Ok(res) => assert!(res),
1809                         Err(_) => panic!()
1810                 };
1811
1812                 let fake_msghash = hash_to_message!(&zero_hash);
1813                 match gossip_sync.handle_node_announcement(
1814                         &NodeAnnouncement {
1815                                 signature: secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey),
1816                                 contents: valid_announcement.contents.clone()
1817                 }) {
1818                         Ok(_) => panic!(),
1819                         Err(e) => assert_eq!(e.err, "Invalid signature on node_announcement message")
1820                 };
1821
1822                 let announcement_with_data = get_signed_node_announcement(|unsigned_announcement| {
1823                         unsigned_announcement.timestamp += 1000;
1824                         unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
1825                 }, node_1_privkey, &secp_ctx);
1826                 // Return false because contains excess data.
1827                 match gossip_sync.handle_node_announcement(&announcement_with_data) {
1828                         Ok(res) => assert!(!res),
1829                         Err(_) => panic!()
1830                 };
1831
1832                 // Even though previous announcement was not relayed further, we still accepted it,
1833                 // so we now won't accept announcements before the previous one.
1834                 let outdated_announcement = get_signed_node_announcement(|unsigned_announcement| {
1835                         unsigned_announcement.timestamp += 1000 - 10;
1836                 }, node_1_privkey, &secp_ctx);
1837                 match gossip_sync.handle_node_announcement(&outdated_announcement) {
1838                         Ok(_) => panic!(),
1839                         Err(e) => assert_eq!(e.err, "Update older than last processed update")
1840                 };
1841         }
1842
1843         #[test]
1844         fn handling_channel_announcements() {
1845                 let secp_ctx = Secp256k1::new();
1846                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1847
1848                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1849                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1850
1851                 let good_script = get_channel_script(&secp_ctx);
1852                 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
1853
1854                 // Test if the UTXO lookups were not supported
1855                 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1856                 let mut gossip_sync = P2PGossipSync::new(&network_graph, None, Arc::clone(&logger));
1857                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1858                         Ok(res) => assert!(res),
1859                         _ => panic!()
1860                 };
1861
1862                 {
1863                         match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
1864                                 None => panic!(),
1865                                 Some(_) => ()
1866                         };
1867                 }
1868
1869                 // If we receive announcement for the same channel (with UTXO lookups disabled),
1870                 // drop new one on the floor, since we can't see any changes.
1871                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1872                         Ok(_) => panic!(),
1873                         Err(e) => assert_eq!(e.err, "Already have knowledge of channel")
1874                 };
1875
1876                 // Test if an associated transaction were not on-chain (or not confirmed).
1877                 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1878                 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
1879                 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1880                 gossip_sync = P2PGossipSync::new(&network_graph, Some(chain_source.clone()), Arc::clone(&logger));
1881
1882                 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
1883                         unsigned_announcement.short_channel_id += 1;
1884                 }, node_1_privkey, node_2_privkey, &secp_ctx);
1885                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1886                         Ok(_) => panic!(),
1887                         Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
1888                 };
1889
1890                 // Now test if the transaction is found in the UTXO set and the script is correct.
1891                 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script.clone() });
1892                 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
1893                         unsigned_announcement.short_channel_id += 2;
1894                 }, node_1_privkey, node_2_privkey, &secp_ctx);
1895                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1896                         Ok(res) => assert!(res),
1897                         _ => panic!()
1898                 };
1899
1900                 {
1901                         match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
1902                                 None => panic!(),
1903                                 Some(_) => ()
1904                         };
1905                 }
1906
1907                 // If we receive announcement for the same channel (but TX is not confirmed),
1908                 // drop new one on the floor, since we can't see any changes.
1909                 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
1910                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1911                         Ok(_) => panic!(),
1912                         Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
1913                 };
1914
1915                 // But if it is confirmed, replace the channel
1916                 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script });
1917                 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
1918                         unsigned_announcement.features = ChannelFeatures::empty();
1919                         unsigned_announcement.short_channel_id += 2;
1920                 }, node_1_privkey, node_2_privkey, &secp_ctx);
1921                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1922                         Ok(res) => assert!(res),
1923                         _ => panic!()
1924                 };
1925                 {
1926                         match network_graph.read_only().channels().get(&valid_announcement.contents.short_channel_id) {
1927                                 Some(channel_entry) => {
1928                                         assert_eq!(channel_entry.features, ChannelFeatures::empty());
1929                                 },
1930                                 _ => panic!()
1931                         };
1932                 }
1933
1934                 // Don't relay valid channels with excess data
1935                 let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
1936                         unsigned_announcement.short_channel_id += 3;
1937                         unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
1938                 }, node_1_privkey, node_2_privkey, &secp_ctx);
1939                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
1940                         Ok(res) => assert!(!res),
1941                         _ => panic!()
1942                 };
1943
1944                 let mut invalid_sig_announcement = valid_announcement.clone();
1945                 invalid_sig_announcement.contents.excess_data = Vec::new();
1946                 match gossip_sync.handle_channel_announcement(&invalid_sig_announcement) {
1947                         Ok(_) => panic!(),
1948                         Err(e) => assert_eq!(e.err, "Invalid signature on channel_announcement message")
1949                 };
1950
1951                 let channel_to_itself_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_1_privkey, &secp_ctx);
1952                 match gossip_sync.handle_channel_announcement(&channel_to_itself_announcement) {
1953                         Ok(_) => panic!(),
1954                         Err(e) => assert_eq!(e.err, "Channel announcement node had a channel with itself")
1955                 };
1956         }
1957
1958         #[test]
1959         fn handling_channel_update() {
1960                 let secp_ctx = Secp256k1::new();
1961                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1962                 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1963                 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1964                 let gossip_sync = P2PGossipSync::new(&network_graph, Some(chain_source.clone()), Arc::clone(&logger));
1965
1966                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1967                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1968
1969                 let amount_sats = 1000_000;
1970                 let short_channel_id;
1971
1972                 {
1973                         // Announce a channel we will update
1974                         let good_script = get_channel_script(&secp_ctx);
1975                         *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: amount_sats, script_pubkey: good_script.clone() });
1976
1977                         let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
1978                         short_channel_id = valid_channel_announcement.contents.short_channel_id;
1979                         match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
1980                                 Ok(_) => (),
1981                                 Err(_) => panic!()
1982                         };
1983
1984                 }
1985
1986                 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
1987                 match gossip_sync.handle_channel_update(&valid_channel_update) {
1988                         Ok(res) => assert!(res),
1989                         _ => panic!()
1990                 };
1991
1992                 {
1993                         match network_graph.read_only().channels().get(&short_channel_id) {
1994                                 None => panic!(),
1995                                 Some(channel_info) => {
1996                                         assert_eq!(channel_info.one_to_two.as_ref().unwrap().cltv_expiry_delta, 144);
1997                                         assert!(channel_info.two_to_one.is_none());
1998                                 }
1999                         };
2000                 }
2001
2002                 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2003                         unsigned_channel_update.timestamp += 100;
2004                         unsigned_channel_update.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
2005                 }, node_1_privkey, &secp_ctx);
2006                 // Return false because contains excess data
2007                 match gossip_sync.handle_channel_update(&valid_channel_update) {
2008                         Ok(res) => assert!(!res),
2009                         _ => panic!()
2010                 };
2011
2012                 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2013                         unsigned_channel_update.timestamp += 110;
2014                         unsigned_channel_update.short_channel_id += 1;
2015                 }, node_1_privkey, &secp_ctx);
2016                 match gossip_sync.handle_channel_update(&valid_channel_update) {
2017                         Ok(_) => panic!(),
2018                         Err(e) => assert_eq!(e.err, "Couldn't find channel for update")
2019                 };
2020
2021                 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2022                         unsigned_channel_update.htlc_maximum_msat = OptionalField::Present(MAX_VALUE_MSAT + 1);
2023                         unsigned_channel_update.timestamp += 110;
2024                 }, node_1_privkey, &secp_ctx);
2025                 match gossip_sync.handle_channel_update(&valid_channel_update) {
2026                         Ok(_) => panic!(),
2027                         Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than maximum possible msats")
2028                 };
2029
2030                 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2031                         unsigned_channel_update.htlc_maximum_msat = OptionalField::Present(amount_sats * 1000 + 1);
2032                         unsigned_channel_update.timestamp += 110;
2033                 }, node_1_privkey, &secp_ctx);
2034                 match gossip_sync.handle_channel_update(&valid_channel_update) {
2035                         Ok(_) => panic!(),
2036                         Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than channel capacity or capacity is bogus")
2037                 };
2038
2039                 // Even though previous update was not relayed further, we still accepted it,
2040                 // so we now won't accept update before the previous one.
2041                 let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2042                         unsigned_channel_update.timestamp += 100;
2043                 }, node_1_privkey, &secp_ctx);
2044                 match gossip_sync.handle_channel_update(&valid_channel_update) {
2045                         Ok(_) => panic!(),
2046                         Err(e) => assert_eq!(e.err, "Update had same timestamp as last processed update")
2047                 };
2048
2049                 let mut invalid_sig_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2050                         unsigned_channel_update.timestamp += 500;
2051                 }, node_1_privkey, &secp_ctx);
2052                 let zero_hash = Sha256dHash::hash(&[0; 32]);
2053                 let fake_msghash = hash_to_message!(&zero_hash);
2054                 invalid_sig_channel_update.signature = secp_ctx.sign_ecdsa(&fake_msghash, node_1_privkey);
2055                 match gossip_sync.handle_channel_update(&invalid_sig_channel_update) {
2056                         Ok(_) => panic!(),
2057                         Err(e) => assert_eq!(e.err, "Invalid signature on channel_update message")
2058                 };
2059         }
2060
2061         #[test]
2062         fn handling_network_update() {
2063                 let logger = test_utils::TestLogger::new();
2064                 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
2065                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2066                 let network_graph = NetworkGraph::new(genesis_hash);
2067                 let gossip_sync = P2PGossipSync::new(&network_graph, Some(chain_source.clone()), &logger);
2068                 let secp_ctx = Secp256k1::new();
2069
2070                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2071                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2072
2073                 {
2074                         // There is no nodes in the table at the beginning.
2075                         assert_eq!(network_graph.read_only().nodes().len(), 0);
2076                 }
2077
2078                 let short_channel_id;
2079                 {
2080                         // Announce a channel we will update
2081                         let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2082                         short_channel_id = valid_channel_announcement.contents.short_channel_id;
2083                         let chain_source: Option<&test_utils::TestChainSource> = None;
2084                         assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source, &secp_ctx).is_ok());
2085                         assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2086
2087                         let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2088                         assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2089
2090                         gossip_sync.handle_event(&Event::PaymentPathFailed {
2091                                 payment_id: None,
2092                                 payment_hash: PaymentHash([0; 32]),
2093                                 rejected_by_dest: false,
2094                                 all_paths_failed: true,
2095                                 path: vec![],
2096                                 network_update: Some(NetworkUpdate::ChannelUpdateMessage {
2097                                         msg: valid_channel_update,
2098                                 }),
2099                                 short_channel_id: None,
2100                                 retry: None,
2101                                 error_code: None,
2102                                 error_data: None,
2103                         });
2104
2105                         assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2106                 }
2107
2108                 // Non-permanent closing just disables a channel
2109                 {
2110                         match network_graph.read_only().channels().get(&short_channel_id) {
2111                                 None => panic!(),
2112                                 Some(channel_info) => {
2113                                         assert!(channel_info.one_to_two.as_ref().unwrap().enabled);
2114                                 }
2115                         };
2116
2117                         gossip_sync.handle_event(&Event::PaymentPathFailed {
2118                                 payment_id: None,
2119                                 payment_hash: PaymentHash([0; 32]),
2120                                 rejected_by_dest: false,
2121                                 all_paths_failed: true,
2122                                 path: vec![],
2123                                 network_update: Some(NetworkUpdate::ChannelFailure {
2124                                         short_channel_id,
2125                                         is_permanent: false,
2126                                 }),
2127                                 short_channel_id: None,
2128                                 retry: None,
2129                                 error_code: None,
2130                                 error_data: None,
2131                         });
2132
2133                         match network_graph.read_only().channels().get(&short_channel_id) {
2134                                 None => panic!(),
2135                                 Some(channel_info) => {
2136                                         assert!(!channel_info.one_to_two.as_ref().unwrap().enabled);
2137                                 }
2138                         };
2139                 }
2140
2141                 // Permanent closing deletes a channel
2142                 gossip_sync.handle_event(&Event::PaymentPathFailed {
2143                         payment_id: None,
2144                         payment_hash: PaymentHash([0; 32]),
2145                         rejected_by_dest: false,
2146                         all_paths_failed: true,
2147                         path: vec![],
2148                         network_update: Some(NetworkUpdate::ChannelFailure {
2149                                 short_channel_id,
2150                                 is_permanent: true,
2151                         }),
2152                         short_channel_id: None,
2153                         retry: None,
2154                         error_code: None,
2155                         error_data: None,
2156                 });
2157
2158                 assert_eq!(network_graph.read_only().channels().len(), 0);
2159                 // Nodes are also deleted because there are no associated channels anymore
2160                 assert_eq!(network_graph.read_only().nodes().len(), 0);
2161                 // TODO: Test NetworkUpdate::NodeFailure, which is not implemented yet.
2162         }
2163
2164         #[test]
2165         fn test_channel_timeouts() {
2166                 // Test the removal of channels with `remove_stale_channels`.
2167                 let logger = test_utils::TestLogger::new();
2168                 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
2169                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2170                 let network_graph = NetworkGraph::new(genesis_hash);
2171                 let gossip_sync = P2PGossipSync::new(&network_graph, Some(chain_source.clone()), &logger);
2172                 let secp_ctx = Secp256k1::new();
2173
2174                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2175                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2176
2177                 let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2178                 let short_channel_id = valid_channel_announcement.contents.short_channel_id;
2179                 let chain_source: Option<&test_utils::TestChainSource> = None;
2180                 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source, &secp_ctx).is_ok());
2181                 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
2182
2183                 let valid_channel_update = get_signed_channel_update(|_| {}, node_1_privkey, &secp_ctx);
2184                 assert!(gossip_sync.handle_channel_update(&valid_channel_update).is_ok());
2185                 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
2186
2187                 network_graph.remove_stale_channels_with_time(100 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2188                 assert_eq!(network_graph.read_only().channels().len(), 1);
2189                 assert_eq!(network_graph.read_only().nodes().len(), 2);
2190
2191                 network_graph.remove_stale_channels_with_time(101 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2192                 #[cfg(feature = "std")]
2193                 {
2194                         // In std mode, a further check is performed before fully removing the channel -
2195                         // the channel_announcement must have been received at least two weeks ago. We
2196                         // fudge that here by indicating the time has jumped two weeks. Note that the
2197                         // directional channel information will have been removed already..
2198                         assert_eq!(network_graph.read_only().channels().len(), 1);
2199                         assert_eq!(network_graph.read_only().nodes().len(), 2);
2200                         assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
2201
2202                         use std::time::{SystemTime, UNIX_EPOCH};
2203                         let announcement_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2204                         network_graph.remove_stale_channels_with_time(announcement_time + 1 + STALE_CHANNEL_UPDATE_AGE_LIMIT_SECS);
2205                 }
2206
2207                 assert_eq!(network_graph.read_only().channels().len(), 0);
2208                 assert_eq!(network_graph.read_only().nodes().len(), 0);
2209         }
2210
2211         #[test]
2212         fn getting_next_channel_announcements() {
2213                 let network_graph = create_network_graph();
2214                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2215                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2216                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2217
2218                 // Channels were not announced yet.
2219                 let channels_with_announcements = gossip_sync.get_next_channel_announcements(0, 1);
2220                 assert_eq!(channels_with_announcements.len(), 0);
2221
2222                 let short_channel_id;
2223                 {
2224                         // Announce a channel we will update
2225                         let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2226                         short_channel_id = valid_channel_announcement.contents.short_channel_id;
2227                         match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2228                                 Ok(_) => (),
2229                                 Err(_) => panic!()
2230                         };
2231                 }
2232
2233                 // Contains initial channel announcement now.
2234                 let channels_with_announcements = gossip_sync.get_next_channel_announcements(short_channel_id, 1);
2235                 assert_eq!(channels_with_announcements.len(), 1);
2236                 if let Some(channel_announcements) = channels_with_announcements.first() {
2237                         let &(_, ref update_1, ref update_2) = channel_announcements;
2238                         assert_eq!(update_1, &None);
2239                         assert_eq!(update_2, &None);
2240                 } else {
2241                         panic!();
2242                 }
2243
2244
2245                 {
2246                         // Valid channel update
2247                         let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2248                                 unsigned_channel_update.timestamp = 101;
2249                         }, node_1_privkey, &secp_ctx);
2250                         match gossip_sync.handle_channel_update(&valid_channel_update) {
2251                                 Ok(_) => (),
2252                                 Err(_) => panic!()
2253                         };
2254                 }
2255
2256                 // Now contains an initial announcement and an update.
2257                 let channels_with_announcements = gossip_sync.get_next_channel_announcements(short_channel_id, 1);
2258                 assert_eq!(channels_with_announcements.len(), 1);
2259                 if let Some(channel_announcements) = channels_with_announcements.first() {
2260                         let &(_, ref update_1, ref update_2) = channel_announcements;
2261                         assert_ne!(update_1, &None);
2262                         assert_eq!(update_2, &None);
2263                 } else {
2264                         panic!();
2265                 }
2266
2267                 {
2268                         // Channel update with excess data.
2269                         let valid_channel_update = get_signed_channel_update(|unsigned_channel_update| {
2270                                 unsigned_channel_update.timestamp = 102;
2271                                 unsigned_channel_update.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2272                         }, node_1_privkey, &secp_ctx);
2273                         match gossip_sync.handle_channel_update(&valid_channel_update) {
2274                                 Ok(_) => (),
2275                                 Err(_) => panic!()
2276                         };
2277                 }
2278
2279                 // Test that announcements with excess data won't be returned
2280                 let channels_with_announcements = gossip_sync.get_next_channel_announcements(short_channel_id, 1);
2281                 assert_eq!(channels_with_announcements.len(), 1);
2282                 if let Some(channel_announcements) = channels_with_announcements.first() {
2283                         let &(_, ref update_1, ref update_2) = channel_announcements;
2284                         assert_eq!(update_1, &None);
2285                         assert_eq!(update_2, &None);
2286                 } else {
2287                         panic!();
2288                 }
2289
2290                 // Further starting point have no channels after it
2291                 let channels_with_announcements = gossip_sync.get_next_channel_announcements(short_channel_id + 1000, 1);
2292                 assert_eq!(channels_with_announcements.len(), 0);
2293         }
2294
2295         #[test]
2296         fn getting_next_node_announcements() {
2297                 let network_graph = create_network_graph();
2298                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2299                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2300                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2301                 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2302
2303                 // No nodes yet.
2304                 let next_announcements = gossip_sync.get_next_node_announcements(None, 10);
2305                 assert_eq!(next_announcements.len(), 0);
2306
2307                 {
2308                         // Announce a channel to add 2 nodes
2309                         let valid_channel_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2310                         match gossip_sync.handle_channel_announcement(&valid_channel_announcement) {
2311                                 Ok(_) => (),
2312                                 Err(_) => panic!()
2313                         };
2314                 }
2315
2316
2317                 // Nodes were never announced
2318                 let next_announcements = gossip_sync.get_next_node_announcements(None, 3);
2319                 assert_eq!(next_announcements.len(), 0);
2320
2321                 {
2322                         let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2323                         match gossip_sync.handle_node_announcement(&valid_announcement) {
2324                                 Ok(_) => (),
2325                                 Err(_) => panic!()
2326                         };
2327
2328                         let valid_announcement = get_signed_node_announcement(|_| {}, node_2_privkey, &secp_ctx);
2329                         match gossip_sync.handle_node_announcement(&valid_announcement) {
2330                                 Ok(_) => (),
2331                                 Err(_) => panic!()
2332                         };
2333                 }
2334
2335                 let next_announcements = gossip_sync.get_next_node_announcements(None, 3);
2336                 assert_eq!(next_announcements.len(), 2);
2337
2338                 // Skip the first node.
2339                 let next_announcements = gossip_sync.get_next_node_announcements(Some(&node_id_1), 2);
2340                 assert_eq!(next_announcements.len(), 1);
2341
2342                 {
2343                         // Later announcement which should not be relayed (excess data) prevent us from sharing a node
2344                         let valid_announcement = get_signed_node_announcement(|unsigned_announcement| {
2345                                 unsigned_announcement.timestamp += 10;
2346                                 unsigned_announcement.excess_data = [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec();
2347                         }, node_2_privkey, &secp_ctx);
2348                         match gossip_sync.handle_node_announcement(&valid_announcement) {
2349                                 Ok(res) => assert!(!res),
2350                                 Err(_) => panic!()
2351                         };
2352                 }
2353
2354                 let next_announcements = gossip_sync.get_next_node_announcements(Some(&node_id_1), 2);
2355                 assert_eq!(next_announcements.len(), 0);
2356         }
2357
2358         #[test]
2359         fn network_graph_serialization() {
2360                 let network_graph = create_network_graph();
2361                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2362
2363                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2364                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2365
2366                 // Announce a channel to add a corresponding node.
2367                 let valid_announcement = get_signed_channel_announcement(|_| {}, node_1_privkey, node_2_privkey, &secp_ctx);
2368                 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2369                         Ok(res) => assert!(res),
2370                         _ => panic!()
2371                 };
2372
2373                 let valid_announcement = get_signed_node_announcement(|_| {}, node_1_privkey, &secp_ctx);
2374                 match gossip_sync.handle_node_announcement(&valid_announcement) {
2375                         Ok(_) => (),
2376                         Err(_) => panic!()
2377                 };
2378
2379                 let mut w = test_utils::TestVecWriter(Vec::new());
2380                 assert!(!network_graph.read_only().nodes().is_empty());
2381                 assert!(!network_graph.read_only().channels().is_empty());
2382                 network_graph.write(&mut w).unwrap();
2383                 assert!(<NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap() == network_graph);
2384         }
2385
2386         #[test]
2387         fn network_graph_tlv_serialization() {
2388                 let network_graph = create_network_graph();
2389                 network_graph.set_last_rapid_gossip_sync_timestamp(42);
2390
2391                 let mut w = test_utils::TestVecWriter(Vec::new());
2392                 network_graph.write(&mut w).unwrap();
2393                 let reassembled_network_graph: NetworkGraph = Readable::read(&mut io::Cursor::new(&w.0)).unwrap();
2394                 assert!(reassembled_network_graph == network_graph);
2395                 assert_eq!(reassembled_network_graph.get_last_rapid_gossip_sync_timestamp().unwrap(), 42);
2396         }
2397
2398         #[test]
2399         #[cfg(feature = "std")]
2400         fn calling_sync_routing_table() {
2401                 use std::time::{SystemTime, UNIX_EPOCH};
2402
2403                 let network_graph = create_network_graph();
2404                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2405                 let node_privkey_1 = &SecretKey::from_slice(&[42; 32]).unwrap();
2406                 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_privkey_1);
2407
2408                 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2409
2410                 // It should ignore if gossip_queries feature is not enabled
2411                 {
2412                         let init_msg = Init { features: InitFeatures::known().clear_gossip_queries(), remote_network_address: None };
2413                         gossip_sync.peer_connected(&node_id_1, &init_msg);
2414                         let events = gossip_sync.get_and_clear_pending_msg_events();
2415                         assert_eq!(events.len(), 0);
2416                 }
2417
2418                 // It should send a gossip_timestamp_filter with the correct information
2419                 {
2420                         let init_msg = Init { features: InitFeatures::known(), remote_network_address: None };
2421                         gossip_sync.peer_connected(&node_id_1, &init_msg);
2422                         let events = gossip_sync.get_and_clear_pending_msg_events();
2423                         assert_eq!(events.len(), 1);
2424                         match &events[0] {
2425                                 MessageSendEvent::SendGossipTimestampFilter{ node_id, msg } => {
2426                                         assert_eq!(node_id, &node_id_1);
2427                                         assert_eq!(msg.chain_hash, chain_hash);
2428                                         let expected_timestamp = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
2429                                         assert!((msg.first_timestamp as u64) >= expected_timestamp - 60*60*24*7*2);
2430                                         assert!((msg.first_timestamp as u64) < expected_timestamp - 60*60*24*7*2 + 10);
2431                                         assert_eq!(msg.timestamp_range, u32::max_value());
2432                                 },
2433                                 _ => panic!("Expected MessageSendEvent::SendChannelRangeQuery")
2434                         };
2435                 }
2436         }
2437
2438         #[test]
2439         fn handling_query_channel_range() {
2440                 let network_graph = create_network_graph();
2441                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2442
2443                 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2444                 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2445                 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2446                 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2447
2448                 let mut scids: Vec<u64> = vec![
2449                         scid_from_parts(0xfffffe, 0xffffff, 0xffff).unwrap(), // max
2450                         scid_from_parts(0xffffff, 0xffffff, 0xffff).unwrap(), // never
2451                 ];
2452
2453                 // used for testing multipart reply across blocks
2454                 for block in 100000..=108001 {
2455                         scids.push(scid_from_parts(block, 0, 0).unwrap());
2456                 }
2457
2458                 // used for testing resumption on same block
2459                 scids.push(scid_from_parts(108001, 1, 0).unwrap());
2460
2461                 for scid in scids {
2462                         let valid_announcement = get_signed_channel_announcement(|unsigned_announcement| {
2463                                 unsigned_announcement.short_channel_id = scid;
2464                         }, node_1_privkey, node_2_privkey, &secp_ctx);
2465                         match gossip_sync.handle_channel_announcement(&valid_announcement) {
2466                                 Ok(_) => (),
2467                                 _ => panic!()
2468                         };
2469                 }
2470
2471                 // Error when number_of_blocks=0
2472                 do_handling_query_channel_range(
2473                         &gossip_sync,
2474                         &node_id_2,
2475                         QueryChannelRange {
2476                                 chain_hash: chain_hash.clone(),
2477                                 first_blocknum: 0,
2478                                 number_of_blocks: 0,
2479                         },
2480                         false,
2481                         vec![ReplyChannelRange {
2482                                 chain_hash: chain_hash.clone(),
2483                                 first_blocknum: 0,
2484                                 number_of_blocks: 0,
2485                                 sync_complete: true,
2486                                 short_channel_ids: vec![]
2487                         }]
2488                 );
2489
2490                 // Error when wrong chain
2491                 do_handling_query_channel_range(
2492                         &gossip_sync,
2493                         &node_id_2,
2494                         QueryChannelRange {
2495                                 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2496                                 first_blocknum: 0,
2497                                 number_of_blocks: 0xffff_ffff,
2498                         },
2499                         false,
2500                         vec![ReplyChannelRange {
2501                                 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2502                                 first_blocknum: 0,
2503                                 number_of_blocks: 0xffff_ffff,
2504                                 sync_complete: true,
2505                                 short_channel_ids: vec![],
2506                         }]
2507                 );
2508
2509                 // Error when first_blocknum > 0xffffff
2510                 do_handling_query_channel_range(
2511                         &gossip_sync,
2512                         &node_id_2,
2513                         QueryChannelRange {
2514                                 chain_hash: chain_hash.clone(),
2515                                 first_blocknum: 0x01000000,
2516                                 number_of_blocks: 0xffff_ffff,
2517                         },
2518                         false,
2519                         vec![ReplyChannelRange {
2520                                 chain_hash: chain_hash.clone(),
2521                                 first_blocknum: 0x01000000,
2522                                 number_of_blocks: 0xffff_ffff,
2523                                 sync_complete: true,
2524                                 short_channel_ids: vec![]
2525                         }]
2526                 );
2527
2528                 // Empty reply when max valid SCID block num
2529                 do_handling_query_channel_range(
2530                         &gossip_sync,
2531                         &node_id_2,
2532                         QueryChannelRange {
2533                                 chain_hash: chain_hash.clone(),
2534                                 first_blocknum: 0xffffff,
2535                                 number_of_blocks: 1,
2536                         },
2537                         true,
2538                         vec![
2539                                 ReplyChannelRange {
2540                                         chain_hash: chain_hash.clone(),
2541                                         first_blocknum: 0xffffff,
2542                                         number_of_blocks: 1,
2543                                         sync_complete: true,
2544                                         short_channel_ids: vec![]
2545                                 },
2546                         ]
2547                 );
2548
2549                 // No results in valid query range
2550                 do_handling_query_channel_range(
2551                         &gossip_sync,
2552                         &node_id_2,
2553                         QueryChannelRange {
2554                                 chain_hash: chain_hash.clone(),
2555                                 first_blocknum: 1000,
2556                                 number_of_blocks: 1000,
2557                         },
2558                         true,
2559                         vec![
2560                                 ReplyChannelRange {
2561                                         chain_hash: chain_hash.clone(),
2562                                         first_blocknum: 1000,
2563                                         number_of_blocks: 1000,
2564                                         sync_complete: true,
2565                                         short_channel_ids: vec![],
2566                                 }
2567                         ]
2568                 );
2569
2570                 // Overflow first_blocknum + number_of_blocks
2571                 do_handling_query_channel_range(
2572                         &gossip_sync,
2573                         &node_id_2,
2574                         QueryChannelRange {
2575                                 chain_hash: chain_hash.clone(),
2576                                 first_blocknum: 0xfe0000,
2577                                 number_of_blocks: 0xffffffff,
2578                         },
2579                         true,
2580                         vec![
2581                                 ReplyChannelRange {
2582                                         chain_hash: chain_hash.clone(),
2583                                         first_blocknum: 0xfe0000,
2584                                         number_of_blocks: 0xffffffff - 0xfe0000,
2585                                         sync_complete: true,
2586                                         short_channel_ids: vec![
2587                                                 0xfffffe_ffffff_ffff, // max
2588                                         ]
2589                                 }
2590                         ]
2591                 );
2592
2593                 // Single block exactly full
2594                 do_handling_query_channel_range(
2595                         &gossip_sync,
2596                         &node_id_2,
2597                         QueryChannelRange {
2598                                 chain_hash: chain_hash.clone(),
2599                                 first_blocknum: 100000,
2600                                 number_of_blocks: 8000,
2601                         },
2602                         true,
2603                         vec![
2604                                 ReplyChannelRange {
2605                                         chain_hash: chain_hash.clone(),
2606                                         first_blocknum: 100000,
2607                                         number_of_blocks: 8000,
2608                                         sync_complete: true,
2609                                         short_channel_ids: (100000..=107999)
2610                                                 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2611                                                 .collect(),
2612                                 },
2613                         ]
2614                 );
2615
2616                 // Multiple split on new block
2617                 do_handling_query_channel_range(
2618                         &gossip_sync,
2619                         &node_id_2,
2620                         QueryChannelRange {
2621                                 chain_hash: chain_hash.clone(),
2622                                 first_blocknum: 100000,
2623                                 number_of_blocks: 8001,
2624                         },
2625                         true,
2626                         vec![
2627                                 ReplyChannelRange {
2628                                         chain_hash: chain_hash.clone(),
2629                                         first_blocknum: 100000,
2630                                         number_of_blocks: 7999,
2631                                         sync_complete: false,
2632                                         short_channel_ids: (100000..=107999)
2633                                                 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2634                                                 .collect(),
2635                                 },
2636                                 ReplyChannelRange {
2637                                         chain_hash: chain_hash.clone(),
2638                                         first_blocknum: 107999,
2639                                         number_of_blocks: 2,
2640                                         sync_complete: true,
2641                                         short_channel_ids: vec![
2642                                                 scid_from_parts(108000, 0, 0).unwrap(),
2643                                         ],
2644                                 }
2645                         ]
2646                 );
2647
2648                 // Multiple split on same block
2649                 do_handling_query_channel_range(
2650                         &gossip_sync,
2651                         &node_id_2,
2652                         QueryChannelRange {
2653                                 chain_hash: chain_hash.clone(),
2654                                 first_blocknum: 100002,
2655                                 number_of_blocks: 8000,
2656                         },
2657                         true,
2658                         vec![
2659                                 ReplyChannelRange {
2660                                         chain_hash: chain_hash.clone(),
2661                                         first_blocknum: 100002,
2662                                         number_of_blocks: 7999,
2663                                         sync_complete: false,
2664                                         short_channel_ids: (100002..=108001)
2665                                                 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2666                                                 .collect(),
2667                                 },
2668                                 ReplyChannelRange {
2669                                         chain_hash: chain_hash.clone(),
2670                                         first_blocknum: 108001,
2671                                         number_of_blocks: 1,
2672                                         sync_complete: true,
2673                                         short_channel_ids: vec![
2674                                                 scid_from_parts(108001, 1, 0).unwrap(),
2675                                         ],
2676                                 }
2677                         ]
2678                 );
2679         }
2680
2681         fn do_handling_query_channel_range(
2682                 gossip_sync: &P2PGossipSync<&NetworkGraph, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2683                 test_node_id: &PublicKey,
2684                 msg: QueryChannelRange,
2685                 expected_ok: bool,
2686                 expected_replies: Vec<ReplyChannelRange>
2687         ) {
2688                 let mut max_firstblocknum = msg.first_blocknum.saturating_sub(1);
2689                 let mut c_lightning_0_9_prev_end_blocknum = max_firstblocknum;
2690                 let query_end_blocknum = msg.end_blocknum();
2691                 let result = gossip_sync.handle_query_channel_range(test_node_id, msg);
2692
2693                 if expected_ok {
2694                         assert!(result.is_ok());
2695                 } else {
2696                         assert!(result.is_err());
2697                 }
2698
2699                 let events = gossip_sync.get_and_clear_pending_msg_events();
2700                 assert_eq!(events.len(), expected_replies.len());
2701
2702                 for i in 0..events.len() {
2703                         let expected_reply = &expected_replies[i];
2704                         match &events[i] {
2705                                 MessageSendEvent::SendReplyChannelRange { node_id, msg } => {
2706                                         assert_eq!(node_id, test_node_id);
2707                                         assert_eq!(msg.chain_hash, expected_reply.chain_hash);
2708                                         assert_eq!(msg.first_blocknum, expected_reply.first_blocknum);
2709                                         assert_eq!(msg.number_of_blocks, expected_reply.number_of_blocks);
2710                                         assert_eq!(msg.sync_complete, expected_reply.sync_complete);
2711                                         assert_eq!(msg.short_channel_ids, expected_reply.short_channel_ids);
2712
2713                                         // Enforce exactly the sequencing requirements present on c-lightning v0.9.3
2714                                         assert!(msg.first_blocknum == c_lightning_0_9_prev_end_blocknum || msg.first_blocknum == c_lightning_0_9_prev_end_blocknum.saturating_add(1));
2715                                         assert!(msg.first_blocknum >= max_firstblocknum);
2716                                         max_firstblocknum = msg.first_blocknum;
2717                                         c_lightning_0_9_prev_end_blocknum = msg.first_blocknum.saturating_add(msg.number_of_blocks);
2718
2719                                         // Check that the last block count is >= the query's end_blocknum
2720                                         if i == events.len() - 1 {
2721                                                 assert!(msg.first_blocknum.saturating_add(msg.number_of_blocks) >= query_end_blocknum);
2722                                         }
2723                                 },
2724                                 _ => panic!("expected MessageSendEvent::SendReplyChannelRange"),
2725                         }
2726                 }
2727         }
2728
2729         #[test]
2730         fn handling_query_short_channel_ids() {
2731                 let network_graph = create_network_graph();
2732                 let (secp_ctx, gossip_sync) = create_gossip_sync(&network_graph);
2733                 let node_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2734                 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2735
2736                 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2737
2738                 let result = gossip_sync.handle_query_short_channel_ids(&node_id, QueryShortChannelIds {
2739                         chain_hash,
2740                         short_channel_ids: vec![0x0003e8_000000_0000],
2741                 });
2742                 assert!(result.is_err());
2743         }
2744 }
2745
2746 #[cfg(all(test, feature = "_bench_unstable"))]
2747 mod benches {
2748         use super::*;
2749
2750         use test::Bencher;
2751         use std::io::Read;
2752
2753         #[bench]
2754         fn read_network_graph(bench: &mut Bencher) {
2755                 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
2756                 let mut v = Vec::new();
2757                 d.read_to_end(&mut v).unwrap();
2758                 bench.iter(|| {
2759                         let _ = NetworkGraph::read(&mut std::io::Cursor::new(&v)).unwrap();
2760                 });
2761         }
2762
2763         #[bench]
2764         fn write_network_graph(bench: &mut Bencher) {
2765                 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
2766                 let net_graph = NetworkGraph::read(&mut d).unwrap();
2767                 bench.iter(|| {
2768                         let _ = net_graph.encode();
2769                 });
2770         }
2771 }