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