_ Git - rust-lightning/blob - lightning/src/ln/peer_handler.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 //! Top level peer message handling and socket handling logic lives here.
  11 //!
  12 //! Instead of actually servicing sockets ourselves we require that you implement the
  13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
  14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
  15 //! call into the provided message handlers (probably a ChannelManager and P2PGossipSync) with
  16 //! messages they should handle, and encoding/sending response messages.
  17
  18 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
  19
  20 use ln::features::InitFeatures;
  21 use ln::msgs;
  22 use ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, RoutingMessageHandler};
  23 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
  24 use util::ser::{VecWriter, Writeable, Writer};
  25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
  26 use ln::wire;
  27 use ln::wire::Encode;
  28 use routing::gossip::{NetworkGraph, P2PGossipSync};
  29 use util::atomic_counter::AtomicCounter;
  30 use util::events::{MessageSendEvent, MessageSendEventsProvider};
  31 use util::logger::Logger;
  32
  33 use prelude::*;
  34 use io;
  35 use alloc::collections::LinkedList;
  36 use sync::{Arc, Mutex, MutexGuard, FairRwLock};
  37 use core::sync::atomic::{AtomicBool, Ordering};
  38 use core::{cmp, hash, fmt, mem};
  39 use core::ops::Deref;
  40 use core::convert::Infallible;
  41 #[cfg(feature = "std")] use std::error;
  42
  43 use bitcoin::hashes::sha256::Hash as Sha256;
  44 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
  45 use bitcoin::hashes::{HashEngine, Hash};
  46
  47 /// Handler for BOLT1-compliant messages.
  48 pub trait CustomMessageHandler: wire::CustomMessageReader {
  49         /// Called with the message type that was received and the buffer to be read.
  50         /// Can return a `MessageHandlingError` if the message could not be handled.
  51         fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
  52
  53         /// Gets the list of pending messages which were generated by the custom message
  54         /// handler, clearing the list in the process. The first tuple element must
  55         /// correspond to the intended recipients node ids. If no connection to one of the
  56         /// specified node does not exist, the message is simply not sent to it.
  57         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
  58 }
  59
  60 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
  61 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
  62 pub struct IgnoringMessageHandler{}
  63 impl MessageSendEventsProvider for IgnoringMessageHandler {
  64         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
  65 }
  66 impl RoutingMessageHandler for IgnoringMessageHandler {
  67         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  68         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  69         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
  70         fn get_next_channel_announcement(&self, _starting_point: u64) ->
  71                 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
  72         fn get_next_node_announcement(&self, _starting_point: Option<&PublicKey>) -> Option<msgs::NodeAnnouncement> { None }
  73         fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
  74         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
  75         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
  76         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
  77         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
  78 }
  79 impl Deref for IgnoringMessageHandler {
  80         type Target = IgnoringMessageHandler;
  81         fn deref(&self) -> &Self { self }
  82 }
  83
  84 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
  85 // method that takes self for it.
  86 impl wire::Type for Infallible {
  87         fn type_id(&self) -> u16 {
  88                 unreachable!();
  89         }
  90 }
  91 impl Writeable for Infallible {
  92         fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
  93                 unreachable!();
  94         }
  95 }
  96
  97 impl wire::CustomMessageReader for IgnoringMessageHandler {
  98         type CustomMessage = Infallible;
  99         fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
 100                 Ok(None)
 101         }
 102 }
 103
 104 impl CustomMessageHandler for IgnoringMessageHandler {
 105         fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
 106                 // Since we always return `None` in the read the handle method should never be called.
 107                 unreachable!();
 108         }
 109
 110         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
 111 }
 112
 113 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
 114 /// You can provide one of these as the route_handler in a MessageHandler.
 115 pub struct ErroringMessageHandler {
 116         message_queue: Mutex<Vec<MessageSendEvent>>
 117 }
 118 impl ErroringMessageHandler {
 119         /// Constructs a new ErroringMessageHandler
 120         pub fn new() -> Self {
 121                 Self { message_queue: Mutex::new(Vec::new()) }
 122         }
 123         fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
 124                 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
 125                         action: msgs::ErrorAction::SendErrorMessage {
 126                                 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
 127                         },
 128                         node_id: node_id.clone(),
 129                 });
 130         }
 131 }
 132 impl MessageSendEventsProvider for ErroringMessageHandler {
 133         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
 134                 let mut res = Vec::new();
 135                 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
 136                 res
 137         }
 138 }
 139 impl ChannelMessageHandler for ErroringMessageHandler {
 140         // Any messages which are related to a specific channel generate an error message to let the
 141         // peer know we don't care about channels.
 142         fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
 143                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 144         }
 145         fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
 146                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 147         }
 148         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 149                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 150         }
 151         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 152                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 153         }
 154         fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
 155                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 156         }
 157         fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
 158                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 159         }
 160         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 161                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 162         }
 163         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 164                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 165         }
 166         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 167                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 168         }
 169         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 170                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 171         }
 172         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 173                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 174         }
 175         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 176                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 177         }
 178         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 179                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 180         }
 181         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 182                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 183         }
 184         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 185                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 186         }
 187         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 188                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 189         }
 190         // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
 191         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 192         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 193         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
 194         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 195 }
 196 impl Deref for ErroringMessageHandler {
 197         type Target = ErroringMessageHandler;
 198         fn deref(&self) -> &Self { self }
 199 }
 200
 201 /// Provides references to trait impls which handle different types of messages.
 202 pub struct MessageHandler<CM: Deref, RM: Deref> where
 203                 CM::Target: ChannelMessageHandler,
 204                 RM::Target: RoutingMessageHandler {
 205         /// A message handler which handles messages specific to channels. Usually this is just a
 206         /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
 207         ///
 208         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 209         pub chan_handler: CM,
 210         /// A message handler which handles messages updating our knowledge of the network channel
 211         /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
 212         ///
 213         /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
 214         pub route_handler: RM,
 215 }
 216
 217 /// Provides an object which can be used to send data to and which uniquely identifies a connection
 218 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
 219 /// implement Hash to meet the PeerManager API.
 220 ///
 221 /// For efficiency, Clone should be relatively cheap for this type.
 222 ///
 223 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
 224 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
 225 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
 226 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
 227 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
 228 /// to simply use another value which is guaranteed to be globally unique instead.
 229 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
 230         /// Attempts to send some data from the given slice to the peer.
 231         ///
 232         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
 233         /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
 234         /// called and further write attempts may occur until that time.
 235         ///
 236         /// If the returned size is smaller than `data.len()`, a
 237         /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
 238         /// written. Additionally, until a `send_data` event completes fully, no further
 239         /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
 240         /// prevent denial-of-service issues, you should not read or buffer any data from the socket
 241         /// until then.
 242         ///
 243         /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
 244         /// (indicating that read events should be paused to prevent DoS in the send buffer),
 245         /// `resume_read` may be set indicating that read events on this descriptor should resume. A
 246         /// `resume_read` of false carries no meaning, and should not cause any action.
 247         fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
 248         /// Disconnect the socket pointed to by this SocketDescriptor.
 249         ///
 250         /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
 251         /// call (doing so is a noop).
 252         fn disconnect_socket(&mut self);
 253 }
 254
 255 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
 256 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
 257 /// descriptor.
 258 #[derive(Clone)]
 259 pub struct PeerHandleError {
 260         /// Used to indicate that we probably can't make any future connections to this peer (e.g.
 261         /// because we required features that our peer was missing, or vice versa).
 262         ///
 263         /// While LDK's [`ChannelManager`] will not do it automatically, you likely wish to force-close
 264         /// any channels with this peer or check for new versions of LDK.
 265         ///
 266         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 267         pub no_connection_possible: bool,
 268 }
 269 impl fmt::Debug for PeerHandleError {
 270         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 271                 formatter.write_str("Peer Sent Invalid Data")
 272         }
 273 }
 274 impl fmt::Display for PeerHandleError {
 275         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 276                 formatter.write_str("Peer Sent Invalid Data")
 277         }
 278 }
 279
 280 #[cfg(feature = "std")]
 281 impl error::Error for PeerHandleError {
 282         fn description(&self) -> &str {
 283                 "Peer Sent Invalid Data"
 284         }
 285 }
 286
 287 enum InitSyncTracker{
 288         NoSyncRequested,
 289         ChannelsSyncing(u64),
 290         NodesSyncing(PublicKey),
 291 }
 292
 293 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
 294 /// forwarding gossip messages to peers altogether.
 295 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
 296
 297 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
 298 /// we have fewer than this many messages in the outbound buffer again.
 299 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
 300 /// refilled as we send bytes.
 301 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
 302 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
 303 /// the peer.
 304 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
 305
 306 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
 307 /// the socket receive buffer before receiving the ping.
 308 ///
 309 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
 310 /// including any network delays, outbound traffic, or the same for messages from other peers.
 311 ///
 312 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
 313 /// per connected peer to respond to a ping, as long as they send us at least one message during
 314 /// each tick, ensuring we aren't actually just disconnected.
 315 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
 316 /// peer.
 317 ///
 318 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
 319 /// two connected peers, assuming most LDK-running systems have at least two cores.
 320 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
 321
 322 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
 323 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
 324 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
 325 /// process before the next ping.
 326 ///
 327 /// Note that we continue responding to other messages even after we've sent this many messages, so
 328 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
 329 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
 330 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
 331
 332 struct Peer {
 333         channel_encryptor: PeerChannelEncryptor,
 334         their_node_id: Option<PublicKey>,
 335         their_features: Option<InitFeatures>,
 336         their_net_address: Option<NetAddress>,
 337
 338         pending_outbound_buffer: LinkedList<Vec<u8>>,
 339         pending_outbound_buffer_first_msg_offset: usize,
 340         awaiting_write_event: bool,
 341
 342         pending_read_buffer: Vec<u8>,
 343         pending_read_buffer_pos: usize,
 344         pending_read_is_header: bool,
 345
 346         sync_status: InitSyncTracker,
 347
 348         msgs_sent_since_pong: usize,
 349         awaiting_pong_timer_tick_intervals: i8,
 350         received_message_since_timer_tick: bool,
 351         sent_gossip_timestamp_filter: bool,
 352 }
 353
 354 impl Peer {
 355         /// Returns true if the channel announcements/updates for the given channel should be
 356         /// forwarded to this peer.
 357         /// If we are sending our routing table to this peer and we have not yet sent channel
 358         /// announcements/updates for the given channel_id then we will send it when we get to that
 359         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 360         /// sent the old versions, we should send the update, and so return true here.
 361         fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
 362                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 363                         !self.sent_gossip_timestamp_filter {
 364                                 return false;
 365                         }
 366                 match self.sync_status {
 367                         InitSyncTracker::NoSyncRequested => true,
 368                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 369                         InitSyncTracker::NodesSyncing(_) => true,
 370                 }
 371         }
 372
 373         /// Similar to the above, but for node announcements indexed by node_id.
 374         fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
 375                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 376                         !self.sent_gossip_timestamp_filter {
 377                                 return false;
 378                         }
 379                 match self.sync_status {
 380                         InitSyncTracker::NoSyncRequested => true,
 381                         InitSyncTracker::ChannelsSyncing(_) => false,
 382                         InitSyncTracker::NodesSyncing(pk) => pk < node_id,
 383                 }
 384         }
 385
 386         /// Returns whether we should be reading bytes from this peer, based on whether its outbound
 387         /// buffer still has space and we don't need to pause reads to get some writes out.
 388         fn should_read(&self) -> bool {
 389                 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE
 390         }
 391
 392         /// Determines if we should push additional gossip messages onto a peer's outbound buffer for
 393         /// backfilling gossip data to the peer. This is checked every time the peer's buffer may have
 394         /// been drained.
 395         fn should_buffer_gossip_backfill(&self) -> bool {
 396                 self.pending_outbound_buffer.is_empty() &&
 397                         self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
 398         }
 399
 400         /// Returns whether this peer's buffer is full and we should drop gossip messages.
 401         fn buffer_full_drop_gossip_broadcast(&self) -> bool {
 402                 self.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
 403                         self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
 404         }
 405 }
 406
 407 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
 408 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
 409 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
 410 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
 411 /// issues such as overly long function definitions.
 412 ///
 413 /// (C-not exported) as Arcs don't make sense in bindings
 414 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, Arc<C>, Arc<L>>>, Arc<L>, Arc<IgnoringMessageHandler>>;
 415
 416 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
 417 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
 418 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
 419 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
 420 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
 421 /// helps with issues such as long function definitions.
 422 ///
 423 /// (C-not exported) as Arcs don't make sense in bindings
 424 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e P2PGossipSync<&'g NetworkGraph<&'f L>, &'h C, &'f L>, &'f L, IgnoringMessageHandler>;
 425
 426 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
 427 /// socket events into messages which it passes on to its [`MessageHandler`].
 428 ///
 429 /// Locks are taken internally, so you must never assume that reentrancy from a
 430 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
 431 ///
 432 /// Calls to [`read_event`] will decode relevant messages and pass them to the
 433 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
 434 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
 435 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
 436 /// calls only after previous ones have returned.
 437 ///
 438 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
 439 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
 440 /// essentially you should default to using a SimpleRefPeerManager, and use a
 441 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
 442 /// you're using lightning-net-tokio.
 443 ///
 444 /// [`read_event`]: PeerManager::read_event
 445 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> where
 446                 CM::Target: ChannelMessageHandler,
 447                 RM::Target: RoutingMessageHandler,
 448                 L::Target: Logger,
 449                 CMH::Target: CustomMessageHandler {
 450         message_handler: MessageHandler<CM, RM>,
 451         /// Connection state for each connected peer - we have an outer read-write lock which is taken
 452         /// as read while we're doing processing for a peer and taken write when a peer is being added
 453         /// or removed.
 454         ///
 455         /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
 456         /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
 457         /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
 458         /// the `MessageHandler`s for a given peer is already guaranteed.
 459         peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
 460         /// Only add to this set when noise completes.
 461         /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
 462         /// lock held. Entries may be added with only the `peers` read lock held (though the
 463         /// `Descriptor` value must already exist in `peers`).
 464         node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
 465         /// We can only have one thread processing events at once, but we don't usually need the full
 466         /// `peers` write lock to do so, so instead we block on this empty mutex when entering
 467         /// `process_events`.
 468         event_processing_lock: Mutex<()>,
 469         /// Because event processing is global and always does all available work before returning,
 470         /// there is no reason for us to have many event processors waiting on the lock at once.
 471         /// Instead, we limit the total blocked event processors to always exactly one by setting this
 472         /// when an event process call is waiting.
 473         blocked_event_processors: AtomicBool,
 474         our_node_secret: SecretKey,
 475         ephemeral_key_midstate: Sha256Engine,
 476         custom_message_handler: CMH,
 477
 478         peer_counter: AtomicCounter,
 479
 480         logger: L,
 481         secp_ctx: Secp256k1<secp256k1::SignOnly>
 482 }
 483
 484 enum MessageHandlingError {
 485         PeerHandleError(PeerHandleError),
 486         LightningError(LightningError),
 487 }
 488
 489 impl From<PeerHandleError> for MessageHandlingError {
 490         fn from(error: PeerHandleError) -> Self {
 491                 MessageHandlingError::PeerHandleError(error)
 492         }
 493 }
 494
 495 impl From<LightningError> for MessageHandlingError {
 496         fn from(error: LightningError) -> Self {
 497                 MessageHandlingError::LightningError(error)
 498         }
 499 }
 500
 501 macro_rules! encode_msg {
 502         ($msg: expr) => {{
 503                 let mut buffer = VecWriter(Vec::new());
 504                 wire::write($msg, &mut buffer).unwrap();
 505                 buffer.0
 506         }}
 507 }
 508
 509 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L, IgnoringMessageHandler> where
 510                 CM::Target: ChannelMessageHandler,
 511                 L::Target: Logger {
 512         /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
 513         /// handler is used and network graph messages are ignored.
 514         ///
 515         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 516         /// cryptographically secure random bytes.
 517         ///
 518         /// (C-not exported) as we can't export a PeerManager with a dummy route handler
 519         pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 520                 Self::new(MessageHandler {
 521                         chan_handler: channel_message_handler,
 522                         route_handler: IgnoringMessageHandler{},
 523                 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
 524         }
 525 }
 526
 527 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L, IgnoringMessageHandler> where
 528                 RM::Target: RoutingMessageHandler,
 529                 L::Target: Logger {
 530         /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
 531         /// handler is used and messages related to channels will be ignored (or generate error
 532         /// messages). Note that some other lightning implementations time-out connections after some
 533         /// time if no channel is built with the peer.
 534         ///
 535         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 536         /// cryptographically secure random bytes.
 537         ///
 538         /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
 539         pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 540                 Self::new(MessageHandler {
 541                         chan_handler: ErroringMessageHandler::new(),
 542                         route_handler: routing_message_handler,
 543                 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
 544         }
 545 }
 546
 547 /// A simple wrapper that optionally prints " from <pubkey>" for an optional pubkey.
 548 /// This works around `format!()` taking a reference to each argument, preventing
 549 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
 550 /// due to lifetime errors.
 551 struct OptionalFromDebugger<'a>(&'a Option<PublicKey>);
 552 impl core::fmt::Display for OptionalFromDebugger<'_> {
 553         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
 554                 if let Some(node_id) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
 555         }
 556 }
 557
 558 /// A function used to filter out local or private addresses
 559 /// https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml
 560 /// https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
 561 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
 562         match ip_address{
 563                 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
 564                 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
 565                 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
 566                 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
 567                 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
 568                 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
 569                 // For IPv4 range       127.0.0.0 - 127.255.255.255 (127/8)
 570                 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
 571                 // For IPv4 range       169.254.0.0 - 169.254.255.255 (169.254/16)
 572                 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
 573                 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
 574                 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
 575                 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
 576                 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
 577                 // For IPv4 range 192.88.99.0 - 192.88.99.255  (192.88.99/24)
 578                 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
 579                 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
 580                 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
 581                 // For remaining addresses
 582                 Some(NetAddress::IPv6{addr: _, port: _}) => None,
 583                 Some(..) => ip_address,
 584                 None => None,
 585         }
 586 }
 587
 588 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> PeerManager<Descriptor, CM, RM, L, CMH> where
 589                 CM::Target: ChannelMessageHandler,
 590                 RM::Target: RoutingMessageHandler,
 591                 L::Target: Logger,
 592                 CMH::Target: CustomMessageHandler {
 593         /// Constructs a new PeerManager with the given message handlers and node_id secret key
 594         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 595         /// cryptographically secure random bytes.
 596         pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH) -> Self {
 597                 let mut ephemeral_key_midstate = Sha256::engine();
 598                 ephemeral_key_midstate.input(ephemeral_random_data);
 599
 600                 let mut secp_ctx = Secp256k1::signing_only();
 601                 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
 602                 secp_ctx.seeded_randomize(&ephemeral_hash);
 603
 604                 PeerManager {
 605                         message_handler,
 606                         peers: FairRwLock::new(HashMap::new()),
 607                         node_id_to_descriptor: Mutex::new(HashMap::new()),
 608                         event_processing_lock: Mutex::new(()),
 609                         blocked_event_processors: AtomicBool::new(false),
 610                         our_node_secret,
 611                         ephemeral_key_midstate,
 612                         peer_counter: AtomicCounter::new(),
 613                         logger,
 614                         custom_message_handler,
 615                         secp_ctx,
 616                 }
 617         }
 618
 619         /// Get the list of node ids for peers which have completed the initial handshake.
 620         ///
 621         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
 622         /// new_outbound_connection, however entries will only appear once the initial handshake has
 623         /// completed and we are sure the remote peer has the private key for the given node_id.
 624         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
 625                 let peers = self.peers.read().unwrap();
 626                 peers.values().filter_map(|peer_mutex| {
 627                         let p = peer_mutex.lock().unwrap();
 628                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
 629                                 return None;
 630                         }
 631                         p.their_node_id
 632                 }).collect()
 633         }
 634
 635         fn get_ephemeral_key(&self) -> SecretKey {
 636                 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 637                 let counter = self.peer_counter.get_increment();
 638                 ephemeral_hash.input(&counter.to_le_bytes());
 639                 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
 640         }
 641
 642         /// Indicates a new outbound connection has been established to a node with the given node_id
 643         /// and an optional remote network address.
 644         ///
 645         /// The remote network address adds the option to report a remote IP address back to a connecting
 646         /// peer using the init message.
 647         /// The user should pass the remote network address of the host they are connected to.
 648         ///
 649         /// If an `Err` is returned here you must disconnect the connection immediately.
 650         ///
 651         /// Returns a small number of bytes to send to the remote node (currently always 50).
 652         ///
 653         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
 654         /// [`socket_disconnected()`].
 655         ///
 656         /// [`socket_disconnected()`]: PeerManager::socket_disconnected
 657         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
 658                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
 659                 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
 660                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 661
 662                 let mut peers = self.peers.write().unwrap();
 663                 if peers.insert(descriptor, Mutex::new(Peer {
 664                         channel_encryptor: peer_encryptor,
 665                         their_node_id: None,
 666                         their_features: None,
 667                         their_net_address: remote_network_address,
 668
 669                         pending_outbound_buffer: LinkedList::new(),
 670                         pending_outbound_buffer_first_msg_offset: 0,
 671                         awaiting_write_event: false,
 672
 673                         pending_read_buffer,
 674                         pending_read_buffer_pos: 0,
 675                         pending_read_is_header: false,
 676
 677                         sync_status: InitSyncTracker::NoSyncRequested,
 678
 679                         msgs_sent_since_pong: 0,
 680                         awaiting_pong_timer_tick_intervals: 0,
 681                         received_message_since_timer_tick: false,
 682                         sent_gossip_timestamp_filter: false,
 683                 })).is_some() {
 684                         panic!("PeerManager driver duplicated descriptors!");
 685                 };
 686                 Ok(res)
 687         }
 688
 689         /// Indicates a new inbound connection has been established to a node with an optional remote
 690         /// network address.
 691         ///
 692         /// The remote network address adds the option to report a remote IP address back to a connecting
 693         /// peer using the init message.
 694         /// The user should pass the remote network address of the host they are connected to.
 695         ///
 696         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 697         /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
 698         /// the connection immediately.
 699         ///
 700         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
 701         /// [`socket_disconnected()`].
 702         ///
 703         /// [`socket_disconnected()`]: PeerManager::socket_disconnected
 704         pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
 705                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret, &self.secp_ctx);
 706                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 707
 708                 let mut peers = self.peers.write().unwrap();
 709                 if peers.insert(descriptor, Mutex::new(Peer {
 710                         channel_encryptor: peer_encryptor,
 711                         their_node_id: None,
 712                         their_features: None,
 713                         their_net_address: remote_network_address,
 714
 715                         pending_outbound_buffer: LinkedList::new(),
 716                         pending_outbound_buffer_first_msg_offset: 0,
 717                         awaiting_write_event: false,
 718
 719                         pending_read_buffer,
 720                         pending_read_buffer_pos: 0,
 721                         pending_read_is_header: false,
 722
 723                         sync_status: InitSyncTracker::NoSyncRequested,
 724
 725                         msgs_sent_since_pong: 0,
 726                         awaiting_pong_timer_tick_intervals: 0,
 727                         received_message_since_timer_tick: false,
 728                         sent_gossip_timestamp_filter: false,
 729                 })).is_some() {
 730                         panic!("PeerManager driver duplicated descriptors!");
 731                 };
 732                 Ok(())
 733         }
 734
 735         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
 736                 while !peer.awaiting_write_event {
 737                         if peer.should_buffer_gossip_backfill() {
 738                                 match peer.sync_status {
 739                                         InitSyncTracker::NoSyncRequested => {},
 740                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
 741                                                 if let Some((announce, update_a_option, update_b_option)) =
 742                                                         self.message_handler.route_handler.get_next_channel_announcement(c)
 743                                                 {
 744                                                         self.enqueue_message(peer, &announce);
 745                                                         if let Some(update_a) = update_a_option {
 746                                                                 self.enqueue_message(peer, &update_a);
 747                                                         }
 748                                                         if let Some(update_b) = update_b_option {
 749                                                                 self.enqueue_message(peer, &update_b);
 750                                                         }
 751                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
 752                                                 } else {
 753                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
 754                                                 }
 755                                         },
 756                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
 757                                                 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
 758                                                         self.enqueue_message(peer, &msg);
 759                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 760                                                 } else {
 761                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 762                                                 }
 763                                         },
 764                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
 765                                         InitSyncTracker::NodesSyncing(key) => {
 766                                                 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&key)) {
 767                                                         self.enqueue_message(peer, &msg);
 768                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 769                                                 } else {
 770                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 771                                                 }
 772                                         },
 773                                 }
 774                         }
 775                         if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
 776                                 self.maybe_send_extra_ping(peer);
 777                         }
 778
 779                         let next_buff = match peer.pending_outbound_buffer.front() {
 780                                 None => return,
 781                                 Some(buff) => buff,
 782                         };
 783
 784                         let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
 785                         let data_sent = descriptor.send_data(pending, peer.should_read());
 786                         peer.pending_outbound_buffer_first_msg_offset += data_sent;
 787                         if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
 788                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 789                                 peer.pending_outbound_buffer.pop_front();
 790                         } else {
 791                                 peer.awaiting_write_event = true;
 792                         }
 793                 }
 794         }
 795
 796         /// Indicates that there is room to write data to the given socket descriptor.
 797         ///
 798         /// May return an Err to indicate that the connection should be closed.
 799         ///
 800         /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
 801         /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
 802         /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
 803         /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
 804         /// sufficient!
 805         ///
 806         /// [`send_data`]: SocketDescriptor::send_data
 807         /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
 808         pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 809                 let peers = self.peers.read().unwrap();
 810                 match peers.get(descriptor) {
 811                         None => {
 812                                 // This is most likely a simple race condition where the user found that the socket
 813                                 // was writeable, then we told the user to `disconnect_socket()`, then they called
 814                                 // this method. Return an error to make sure we get disconnected.
 815                                 return Err(PeerHandleError { no_connection_possible: false });
 816                         },
 817                         Some(peer_mutex) => {
 818                                 let mut peer = peer_mutex.lock().unwrap();
 819                                 peer.awaiting_write_event = false;
 820                                 self.do_attempt_write_data(descriptor, &mut peer);
 821                         }
 822                 };
 823                 Ok(())
 824         }
 825
 826         /// Indicates that data was read from the given socket descriptor.
 827         ///
 828         /// May return an Err to indicate that the connection should be closed.
 829         ///
 830         /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
 831         /// Thus, however, you should call [`process_events`] after any `read_event` to generate
 832         /// [`send_data`] calls to handle responses.
 833         ///
 834         /// If `Ok(true)` is returned, further read_events should not be triggered until a
 835         /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
 836         /// send buffer).
 837         ///
 838         /// [`send_data`]: SocketDescriptor::send_data
 839         /// [`process_events`]: PeerManager::process_events
 840         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 841                 match self.do_read_event(peer_descriptor, data) {
 842                         Ok(res) => Ok(res),
 843                         Err(e) => {
 844                                 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
 845                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
 846                                 Err(e)
 847                         }
 848                 }
 849         }
 850
 851         /// Append a message to a peer's pending outbound/write buffer
 852         fn enqueue_encoded_message(&self, peer: &mut Peer, encoded_message: &Vec<u8>) {
 853                 peer.msgs_sent_since_pong += 1;
 854                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
 855         }
 856
 857         /// Append a message to a peer's pending outbound/write buffer
 858         fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
 859                 let mut buffer = VecWriter(Vec::with_capacity(2048));
 860                 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
 861
 862                 if is_gossip_msg(message.type_id()) {
 863                         log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
 864                 } else {
 865                         log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()))
 866                 }
 867                 self.enqueue_encoded_message(peer, &buffer.0);
 868         }
 869
 870         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 871                 let mut pause_read = false;
 872                 let peers = self.peers.read().unwrap();
 873                 let mut msgs_to_forward = Vec::new();
 874                 let mut peer_node_id = None;
 875                 match peers.get(peer_descriptor) {
 876                         None => {
 877                                 // This is most likely a simple race condition where the user read some bytes
 878                                 // from the socket, then we told the user to `disconnect_socket()`, then they
 879                                 // called this method. Return an error to make sure we get disconnected.
 880                                 return Err(PeerHandleError { no_connection_possible: false });
 881                         },
 882                         Some(peer_mutex) => {
 883                                 let mut read_pos = 0;
 884                                 while read_pos < data.len() {
 885                                         macro_rules! try_potential_handleerror {
 886                                                 ($peer: expr, $thing: expr) => {
 887                                                         match $thing {
 888                                                                 Ok(x) => x,
 889                                                                 Err(e) => {
 890                                                                         match e.action {
 891                                                                                 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
 892                                                                                         //TODO: Try to push msg
 893                                                                                         log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 894                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 895                                                                                 },
 896                                                                                 msgs::ErrorAction::IgnoreAndLog(level) => {
 897                                                                                         log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
 898                                                                                         continue
 899                                                                                 },
 900                                                                                 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
 901                                                                                 msgs::ErrorAction::IgnoreError => {
 902                                                                                         log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
 903                                                                                         continue;
 904                                                                                 },
 905                                                                                 msgs::ErrorAction::SendErrorMessage { msg } => {
 906                                                                                         log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 907                                                                                         self.enqueue_message($peer, &msg);
 908                                                                                         continue;
 909                                                                                 },
 910                                                                                 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
 911                                                                                         log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 912                                                                                         self.enqueue_message($peer, &msg);
 913                                                                                         continue;
 914                                                                                 },
 915                                                                         }
 916                                                                 }
 917                                                         }
 918                                                 }
 919                                         }
 920
 921                                         let mut peer_lock = peer_mutex.lock().unwrap();
 922                                         let peer = &mut *peer_lock;
 923                                         let mut msg_to_handle = None;
 924                                         if peer_node_id.is_none() {
 925                                                 peer_node_id = peer.their_node_id.clone();
 926                                         }
 927
 928                                         assert!(peer.pending_read_buffer.len() > 0);
 929                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 930
 931                                         {
 932                                                 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 933                                                 peer.pending_read_buffer[peer.pending_read_buffer_pos..peer.pending_read_buffer_pos + data_to_copy].copy_from_slice(&data[read_pos..read_pos + data_to_copy]);
 934                                                 read_pos += data_to_copy;
 935                                                 peer.pending_read_buffer_pos += data_to_copy;
 936                                         }
 937
 938                                         if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 939                                                 peer.pending_read_buffer_pos = 0;
 940
 941                                                 macro_rules! insert_node_id {
 942                                                         () => {
 943                                                                 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap()) {
 944                                                                         hash_map::Entry::Occupied(_) => {
 945                                                                                 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
 946                                                                                 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
 947                                                                                 return Err(PeerHandleError{ no_connection_possible: false })
 948                                                                         },
 949                                                                         hash_map::Entry::Vacant(entry) => {
 950                                                                                 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
 951                                                                                 entry.insert(peer_descriptor.clone())
 952                                                                         },
 953                                                                 };
 954                                                         }
 955                                                 }
 956
 957                                                 let next_step = peer.channel_encryptor.get_noise_step();
 958                                                 match next_step {
 959                                                         NextNoiseStep::ActOne => {
 960                                                                 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
 961                                                                         .process_act_one_with_keys(&peer.pending_read_buffer[..],
 962                                                                                 &self.our_node_secret, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
 963                                                                 peer.pending_outbound_buffer.push_back(act_two);
 964                                                                 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 965                                                         },
 966                                                         NextNoiseStep::ActTwo => {
 967                                                                 let (act_three, their_node_id) = try_potential_handleerror!(peer,
 968                                                                         peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
 969                                                                                 &self.our_node_secret, &self.secp_ctx));
 970                                                                 peer.pending_outbound_buffer.push_back(act_three.to_vec());
 971                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 972                                                                 peer.pending_read_is_header = true;
 973
 974                                                                 peer.their_node_id = Some(their_node_id);
 975                                                                 insert_node_id!();
 976                                                                 let features = InitFeatures::known();
 977                                                                 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
 978                                                                 self.enqueue_message(peer, &resp);
 979                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
 980                                                         },
 981                                                         NextNoiseStep::ActThree => {
 982                                                                 let their_node_id = try_potential_handleerror!(peer,
 983                                                                         peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 984                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 985                                                                 peer.pending_read_is_header = true;
 986                                                                 peer.their_node_id = Some(their_node_id);
 987                                                                 insert_node_id!();
 988                                                                 let features = InitFeatures::known();
 989                                                                 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
 990                                                                 self.enqueue_message(peer, &resp);
 991                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
 992                                                         },
 993                                                         NextNoiseStep::NoiseComplete => {
 994                                                                 if peer.pending_read_is_header {
 995                                                                         let msg_len = try_potential_handleerror!(peer,
 996                                                                                 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 997                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
 998                                                                         peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 999                                                                         if msg_len < 2 { // Need at least the message type tag
1000                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
1001                                                                         }
1002                                                                         peer.pending_read_is_header = false;
1003                                                                 } else {
1004                                                                         let msg_data = try_potential_handleerror!(peer,
1005                                                                                 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1006                                                                         assert!(msg_data.len() >= 2);
1007
1008                                                                         // Reset read buffer
1009                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1010                                                                         peer.pending_read_buffer.resize(18, 0);
1011                                                                         peer.pending_read_is_header = true;
1012
1013                                                                         let mut reader = io::Cursor::new(&msg_data[..]);
1014                                                                         let message_result = wire::read(&mut reader, &*self.custom_message_handler);
1015                                                                         let message = match message_result {
1016                                                                                 Ok(x) => x,
1017                                                                                 Err(e) => {
1018                                                                                         match e {
1019                                                                                                 // Note that to avoid recursion we never call
1020                                                                                                 // `do_attempt_write_data` from here, causing
1021                                                                                                 // the messages enqueued here to not actually
1022                                                                                                 // be sent before the peer is disconnected.
1023                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1024                                                                                                         log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1025                                                                                                         continue;
1026                                                                                                 }
1027                                                                                                 (msgs::DecodeError::UnsupportedCompression, _) => {
1028                                                                                                         log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1029                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1030                                                                                                         continue;
1031                                                                                                 }
1032                                                                                                 (_, Some(ty)) if is_gossip_msg(ty) => {
1033                                                                                                         log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1034                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unreadable/bogus gossip message".to_owned() });
1035                                                                                                         continue;
1036                                                                                                 }
1037                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1038                                                                                                         log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1039                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1040                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1041                                                                                                 }
1042                                                                                                 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { no_connection_possible: false }),
1043                                                                                                 (msgs::DecodeError::InvalidValue, _) => {
1044                                                                                                         log_debug!(self.logger, "Got an invalid value while deserializing message");
1045                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1046                                                                                                 }
1047                                                                                                 (msgs::DecodeError::ShortRead, _) => {
1048                                                                                                         log_debug!(self.logger, "Deserialization failed due to shortness of message");
1049                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1050                                                                                                 }
1051                                                                                                 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { no_connection_possible: false }),
1052                                                                                                 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { no_connection_possible: false }),
1053                                                                                         }
1054                                                                                 }
1055                                                                         };
1056
1057                                                                         msg_to_handle = Some(message);
1058                                                                 }
1059                                                         }
1060                                                 }
1061                                         }
1062                                         pause_read = !peer.should_read();
1063
1064                                         if let Some(message) = msg_to_handle {
1065                                                 match self.handle_message(&peer_mutex, peer_lock, message) {
1066                                                         Err(handling_error) => match handling_error {
1067                                                                 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1068                                                                 MessageHandlingError::LightningError(e) => {
1069                                                                         try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1070                                                                 },
1071                                                         },
1072                                                         Ok(Some(msg)) => {
1073                                                                 msgs_to_forward.push(msg);
1074                                                         },
1075                                                         Ok(None) => {},
1076                                                 }
1077                                         }
1078                                 }
1079                         }
1080                 }
1081
1082                 for msg in msgs_to_forward.drain(..) {
1083                         self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref());
1084                 }
1085
1086                 Ok(pause_read)
1087         }
1088
1089         /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1090         /// Returns the message back if it needs to be broadcasted to all other peers.
1091         fn handle_message(
1092                 &self,
1093                 peer_mutex: &Mutex<Peer>,
1094                 mut peer_lock: MutexGuard<Peer>,
1095                 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1096         ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1097                 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages");
1098                 peer_lock.received_message_since_timer_tick = true;
1099
1100                 // Need an Init as first message
1101                 if let wire::Message::Init(msg) = message {
1102                         if msg.features.requires_unknown_bits() {
1103                                 log_debug!(self.logger, "Peer features required unknown version bits");
1104                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1105                         }
1106                         if peer_lock.their_features.is_some() {
1107                                 return Err(PeerHandleError{ no_connection_possible: false }.into());
1108                         }
1109
1110                         log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1111
1112                         // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1113                         if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1114                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1115                         }
1116
1117                         if !msg.features.supports_static_remote_key() {
1118                                 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(their_node_id));
1119                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1120                         }
1121
1122                         self.message_handler.route_handler.peer_connected(&their_node_id, &msg);
1123
1124                         self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
1125                         peer_lock.their_features = Some(msg.features);
1126                         return Ok(None);
1127                 } else if peer_lock.their_features.is_none() {
1128                         log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1129                         return Err(PeerHandleError{ no_connection_possible: false }.into());
1130                 }
1131
1132                 if let wire::Message::GossipTimestampFilter(_msg) = message {
1133                         // When supporting gossip messages, start inital gossip sync only after we receive
1134                         // a GossipTimestampFilter
1135                         if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1136                                 !peer_lock.sent_gossip_timestamp_filter {
1137                                 peer_lock.sent_gossip_timestamp_filter = true;
1138                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1139                         }
1140                         return Ok(None);
1141                 }
1142
1143                 let their_features = peer_lock.their_features.clone();
1144                 mem::drop(peer_lock);
1145
1146                 if is_gossip_msg(message.type_id()) {
1147                         log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1148                 } else {
1149                         log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1150                 }
1151
1152                 let mut should_forward = None;
1153
1154                 match message {
1155                         // Setup and Control messages:
1156                         wire::Message::Init(_) => {
1157                                 // Handled above
1158                         },
1159                         wire::Message::GossipTimestampFilter(_) => {
1160                                 // Handled above
1161                         },
1162                         wire::Message::Error(msg) => {
1163                                 let mut data_is_printable = true;
1164                                 for b in msg.data.bytes() {
1165                                         if b < 32 || b > 126 {
1166                                                 data_is_printable = false;
1167                                                 break;
1168                                         }
1169                                 }
1170
1171                                 if data_is_printable {
1172                                         log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1173                                 } else {
1174                                         log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1175                                 }
1176                                 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1177                                 if msg.channel_id == [0; 32] {
1178                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
1179                                 }
1180                         },
1181                         wire::Message::Warning(msg) => {
1182                                 let mut data_is_printable = true;
1183                                 for b in msg.data.bytes() {
1184                                         if b < 32 || b > 126 {
1185                                                 data_is_printable = false;
1186                                                 break;
1187                                         }
1188                                 }
1189
1190                                 if data_is_printable {
1191                                         log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1192                                 } else {
1193                                         log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1194                                 }
1195                         },
1196
1197                         wire::Message::Ping(msg) => {
1198                                 if msg.ponglen < 65532 {
1199                                         let resp = msgs::Pong { byteslen: msg.ponglen };
1200                                         self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1201                                 }
1202                         },
1203                         wire::Message::Pong(_msg) => {
1204                                 let mut peer_lock = peer_mutex.lock().unwrap();
1205                                 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1206                                 peer_lock.msgs_sent_since_pong = 0;
1207                         },
1208
1209                         // Channel messages:
1210                         wire::Message::OpenChannel(msg) => {
1211                                 self.message_handler.chan_handler.handle_open_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1212                         },
1213                         wire::Message::AcceptChannel(msg) => {
1214                                 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1215                         },
1216
1217                         wire::Message::FundingCreated(msg) => {
1218                                 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1219                         },
1220                         wire::Message::FundingSigned(msg) => {
1221                                 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1222                         },
1223                         wire::Message::ChannelReady(msg) => {
1224                                 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1225                         },
1226
1227                         wire::Message::Shutdown(msg) => {
1228                                 self.message_handler.chan_handler.handle_shutdown(&their_node_id, their_features.as_ref().unwrap(), &msg);
1229                         },
1230                         wire::Message::ClosingSigned(msg) => {
1231                                 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1232                         },
1233
1234                         // Commitment messages:
1235                         wire::Message::UpdateAddHTLC(msg) => {
1236                                 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1237                         },
1238                         wire::Message::UpdateFulfillHTLC(msg) => {
1239                                 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1240                         },
1241                         wire::Message::UpdateFailHTLC(msg) => {
1242                                 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1243                         },
1244                         wire::Message::UpdateFailMalformedHTLC(msg) => {
1245                                 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1246                         },
1247
1248                         wire::Message::CommitmentSigned(msg) => {
1249                                 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1250                         },
1251                         wire::Message::RevokeAndACK(msg) => {
1252                                 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1253                         },
1254                         wire::Message::UpdateFee(msg) => {
1255                                 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1256                         },
1257                         wire::Message::ChannelReestablish(msg) => {
1258                                 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1259                         },
1260
1261                         // Routing messages:
1262                         wire::Message::AnnouncementSignatures(msg) => {
1263                                 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1264                         },
1265                         wire::Message::ChannelAnnouncement(msg) => {
1266                                 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1267                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1268                                         should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1269                                 }
1270                         },
1271                         wire::Message::NodeAnnouncement(msg) => {
1272                                 if self.message_handler.route_handler.handle_node_announcement(&msg)
1273                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1274                                         should_forward = Some(wire::Message::NodeAnnouncement(msg));
1275                                 }
1276                         },
1277                         wire::Message::ChannelUpdate(msg) => {
1278                                 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1279                                 if self.message_handler.route_handler.handle_channel_update(&msg)
1280                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1281                                         should_forward = Some(wire::Message::ChannelUpdate(msg));
1282                                 }
1283                         },
1284                         wire::Message::QueryShortChannelIds(msg) => {
1285                                 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1286                         },
1287                         wire::Message::ReplyShortChannelIdsEnd(msg) => {
1288                                 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1289                         },
1290                         wire::Message::QueryChannelRange(msg) => {
1291                                 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1292                         },
1293                         wire::Message::ReplyChannelRange(msg) => {
1294                                 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1295                         },
1296
1297                         // Unknown messages:
1298                         wire::Message::Unknown(type_id) if message.is_even() => {
1299                                 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1300                                 // Fail the channel if message is an even, unknown type as per BOLT #1.
1301                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1302                         },
1303                         wire::Message::Unknown(type_id) => {
1304                                 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1305                         },
1306                         wire::Message::Custom(custom) => {
1307                                 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1308                         },
1309                 };
1310                 Ok(should_forward)
1311         }
1312
1313         fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1314                 match msg {
1315                         wire::Message::ChannelAnnouncement(ref msg) => {
1316                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1317                                 let encoded_msg = encode_msg!(msg);
1318
1319                                 for (_, peer_mutex) in peers.iter() {
1320                                         let mut peer = peer_mutex.lock().unwrap();
1321                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1322                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1323                                                 continue
1324                                         }
1325                                         if peer.buffer_full_drop_gossip_broadcast() {
1326                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1327                                                 continue;
1328                                         }
1329                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1330                                            peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1331                                                 continue;
1332                                         }
1333                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1334                                                 continue;
1335                                         }
1336                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1337                                 }
1338                         },
1339                         wire::Message::NodeAnnouncement(ref msg) => {
1340                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1341                                 let encoded_msg = encode_msg!(msg);
1342
1343                                 for (_, peer_mutex) in peers.iter() {
1344                                         let mut peer = peer_mutex.lock().unwrap();
1345                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1346                                                         !peer.should_forward_node_announcement(msg.contents.node_id) {
1347                                                 continue
1348                                         }
1349                                         if peer.buffer_full_drop_gossip_broadcast() {
1350                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1351                                                 continue;
1352                                         }
1353                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1354                                                 continue;
1355                                         }
1356                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1357                                                 continue;
1358                                         }
1359                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1360                                 }
1361                         },
1362                         wire::Message::ChannelUpdate(ref msg) => {
1363                                 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1364                                 let encoded_msg = encode_msg!(msg);
1365
1366                                 for (_, peer_mutex) in peers.iter() {
1367                                         let mut peer = peer_mutex.lock().unwrap();
1368                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1369                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id)  {
1370                                                 continue
1371                                         }
1372                                         if peer.buffer_full_drop_gossip_broadcast() {
1373                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1374                                                 continue;
1375                                         }
1376                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1377                                                 continue;
1378                                         }
1379                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1380                                 }
1381                         },
1382                         _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1383                 }
1384         }
1385
1386         /// Checks for any events generated by our handlers and processes them. Includes sending most
1387         /// response messages as well as messages generated by calls to handler functions directly (eg
1388         /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1389         ///
1390         /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1391         /// issues!
1392         ///
1393         /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1394         /// or one of the other clients provided in our language bindings.
1395         ///
1396         /// Note that if there are any other calls to this function waiting on lock(s) this may return
1397         /// without doing any work. All available events that need handling will be handled before the
1398         /// other calls return.
1399         ///
1400         /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1401         /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1402         /// [`send_data`]: SocketDescriptor::send_data
1403         pub fn process_events(&self) {
1404                 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1405                 if _single_processor_lock.is_err() {
1406                         // While we could wake the older sleeper here with a CV and make more even waiting
1407                         // times, that would be a lot of overengineering for a simple "reduce total waiter
1408                         // count" goal.
1409                         match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1410                                 Err(val) => {
1411                                         debug_assert!(val, "compare_exchange failed spuriously?");
1412                                         return;
1413                                 },
1414                                 Ok(val) => {
1415                                         debug_assert!(!val, "compare_exchange succeeded spuriously?");
1416                                         // We're the only waiter, as the running process_events may have emptied the
1417                                         // pending events "long" ago and there are new events for us to process, wait until
1418                                         // its done and process any leftover events before returning.
1419                                         _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1420                                         self.blocked_event_processors.store(false, Ordering::Release);
1421                                 }
1422                         }
1423                 }
1424
1425                 let mut peers_to_disconnect = HashMap::new();
1426                 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1427                 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1428
1429                 {
1430                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
1431                         // buffer by doing things like announcing channels on another node. We should be willing to
1432                         // drop optional-ish messages when send buffers get full!
1433
1434                         let peers_lock = self.peers.read().unwrap();
1435                         let peers = &*peers_lock;
1436                         macro_rules! get_peer_for_forwarding {
1437                                 ($node_id: expr) => {
1438                                         {
1439                                                 if peers_to_disconnect.get($node_id).is_some() {
1440                                                         // If we've "disconnected" this peer, do not send to it.
1441                                                         continue;
1442                                                 }
1443                                                 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1444                                                 match descriptor_opt {
1445                                                         Some(descriptor) => match peers.get(&descriptor) {
1446                                                                 Some(peer_mutex) => {
1447                                                                         let peer_lock = peer_mutex.lock().unwrap();
1448                                                                         if peer_lock.their_features.is_none() {
1449                                                                                 continue;
1450                                                                         }
1451                                                                         peer_lock
1452                                                                 },
1453                                                                 None => {
1454                                                                         debug_assert!(false, "Inconsistent peers set state!");
1455                                                                         continue;
1456                                                                 }
1457                                                         },
1458                                                         None => {
1459                                                                 continue;
1460                                                         },
1461                                                 }
1462                                         }
1463                                 }
1464                         }
1465                         for event in events_generated.drain(..) {
1466                                 match event {
1467                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1468                                                 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1469                                                                 log_pubkey!(node_id),
1470                                                                 log_bytes!(msg.temporary_channel_id));
1471                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1472                                         },
1473                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1474                                                 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1475                                                                 log_pubkey!(node_id),
1476                                                                 log_bytes!(msg.temporary_channel_id));
1477                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1478                                         },
1479                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1480                                                 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1481                                                                 log_pubkey!(node_id),
1482                                                                 log_bytes!(msg.temporary_channel_id),
1483                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1484                                                 // TODO: If the peer is gone we should generate a DiscardFunding event
1485                                                 // indicating to the wallet that they should just throw away this funding transaction
1486                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1487                                         },
1488                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1489                                                 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1490                                                                 log_pubkey!(node_id),
1491                                                                 log_bytes!(msg.channel_id));
1492                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1493                                         },
1494                                         MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1495                                                 log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1496                                                                 log_pubkey!(node_id),
1497                                                                 log_bytes!(msg.channel_id));
1498                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1499                                         },
1500                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1501                                                 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1502                                                                 log_pubkey!(node_id),
1503                                                                 log_bytes!(msg.channel_id));
1504                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1505                                         },
1506                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1507                                                 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1508                                                                 log_pubkey!(node_id),
1509                                                                 update_add_htlcs.len(),
1510                                                                 update_fulfill_htlcs.len(),
1511                                                                 update_fail_htlcs.len(),
1512                                                                 log_bytes!(commitment_signed.channel_id));
1513                                                 let mut peer = get_peer_for_forwarding!(node_id);
1514                                                 for msg in update_add_htlcs {
1515                                                         self.enqueue_message(&mut *peer, msg);
1516                                                 }
1517                                                 for msg in update_fulfill_htlcs {
1518                                                         self.enqueue_message(&mut *peer, msg);
1519                                                 }
1520                                                 for msg in update_fail_htlcs {
1521                                                         self.enqueue_message(&mut *peer, msg);
1522                                                 }
1523                                                 for msg in update_fail_malformed_htlcs {
1524                                                         self.enqueue_message(&mut *peer, msg);
1525                                                 }
1526                                                 if let &Some(ref msg) = update_fee {
1527                                                         self.enqueue_message(&mut *peer, msg);
1528                                                 }
1529                                                 self.enqueue_message(&mut *peer, commitment_signed);
1530                                         },
1531                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1532                                                 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1533                                                                 log_pubkey!(node_id),
1534                                                                 log_bytes!(msg.channel_id));
1535                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1536                                         },
1537                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1538                                                 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1539                                                                 log_pubkey!(node_id),
1540                                                                 log_bytes!(msg.channel_id));
1541                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1542                                         },
1543                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1544                                                 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1545                                                                 log_pubkey!(node_id),
1546                                                                 log_bytes!(msg.channel_id));
1547                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1548                                         },
1549                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1550                                                 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1551                                                                 log_pubkey!(node_id),
1552                                                                 log_bytes!(msg.channel_id));
1553                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1554                                         },
1555                                         MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1556                                                 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1557                                                 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1558                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1559                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1560                                                         _ => {},
1561                                                 }
1562                                                 match self.message_handler.route_handler.handle_channel_update(&update_msg) {
1563                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1564                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None),
1565                                                         _ => {},
1566                                                 }
1567                                         },
1568                                         MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1569                                                 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1570                                                 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1571                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1572                                                                 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1573                                                         _ => {},
1574                                                 }
1575                                         },
1576                                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
1577                                                 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1578                                                 match self.message_handler.route_handler.handle_channel_update(&msg) {
1579                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1580                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1581                                                         _ => {},
1582                                                 }
1583                                         },
1584                                         MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1585                                                 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1586                                                                 log_pubkey!(node_id), msg.contents.short_channel_id);
1587                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1588                                         },
1589                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
1590                                                 match *action {
1591                                                         msgs::ErrorAction::DisconnectPeer { ref msg } => {
1592                                                                 // We do not have the peers write lock, so we just store that we're
1593                                                                 // about to disconenct the peer and do it after we finish
1594                                                                 // processing most messages.
1595                                                                 peers_to_disconnect.insert(*node_id, msg.clone());
1596                                                         },
1597                                                         msgs::ErrorAction::IgnoreAndLog(level) => {
1598                                                                 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1599                                                         },
1600                                                         msgs::ErrorAction::IgnoreDuplicateGossip => {},
1601                                                         msgs::ErrorAction::IgnoreError => {
1602                                                                 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1603                                                         },
1604                                                         msgs::ErrorAction::SendErrorMessage { ref msg } => {
1605                                                                 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1606                                                                                 log_pubkey!(node_id),
1607                                                                                 msg.data);
1608                                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1609                                                         },
1610                                                         msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1611                                                                 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1612                                                                                 log_pubkey!(node_id),
1613                                                                                 msg.data);
1614                                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1615                                                         },
1616                                                 }
1617                                         },
1618                                         MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1619                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1620                                         },
1621                                         MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1622                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1623                                         }
1624                                         MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1625                                                 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1626                                                         log_pubkey!(node_id),
1627                                                         msg.short_channel_ids.len(),
1628                                                         msg.first_blocknum,
1629                                                         msg.number_of_blocks,
1630                                                         msg.sync_complete);
1631                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1632                                         }
1633                                         MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1634                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1635                                         }
1636                                 }
1637                         }
1638
1639                         for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1640                                 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1641                                 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1642                         }
1643
1644                         for (descriptor, peer_mutex) in peers.iter() {
1645                                 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer_mutex.lock().unwrap());
1646                         }
1647                 }
1648                 if !peers_to_disconnect.is_empty() {
1649                         let mut peers_lock = self.peers.write().unwrap();
1650                         let peers = &mut *peers_lock;
1651                         for (node_id, msg) in peers_to_disconnect.drain() {
1652                                 // Note that since we are holding the peers *write* lock we can
1653                                 // remove from node_id_to_descriptor immediately (as no other
1654                                 // thread can be holding the peer lock if we have the global write
1655                                 // lock).
1656
1657                                 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1658                                         if let Some(peer_mutex) = peers.remove(&descriptor) {
1659                                                 if let Some(msg) = msg {
1660                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1661                                                                         log_pubkey!(node_id),
1662                                                                         msg.data);
1663                                                         let mut peer = peer_mutex.lock().unwrap();
1664                                                         self.enqueue_message(&mut *peer, &msg);
1665                                                         // This isn't guaranteed to work, but if there is enough free
1666                                                         // room in the send buffer, put the error message there...
1667                                                         self.do_attempt_write_data(&mut descriptor, &mut *peer);
1668                                                 } else {
1669                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1670                                                 }
1671                                         }
1672                                         descriptor.disconnect_socket();
1673                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1674                                 }
1675                         }
1676                 }
1677         }
1678
1679         /// Indicates that the given socket descriptor's connection is now closed.
1680         pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1681                 self.disconnect_event_internal(descriptor, false);
1682         }
1683
1684         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1685                 let mut peers = self.peers.write().unwrap();
1686                 let peer_option = peers.remove(descriptor);
1687                 match peer_option {
1688                         None => {
1689                                 // This is most likely a simple race condition where the user found that the socket
1690                                 // was disconnected, then we told the user to `disconnect_socket()`, then they
1691                                 // called this method. Either way we're disconnected, return.
1692                         },
1693                         Some(peer_lock) => {
1694                                 let peer = peer_lock.lock().unwrap();
1695                                 if let Some(node_id) = peer.their_node_id {
1696                                         log_trace!(self.logger,
1697                                                 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1698                                                 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1699                                         self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1700                                         self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1701                                 }
1702                         }
1703                 };
1704         }
1705
1706         /// Disconnect a peer given its node id.
1707         ///
1708         /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1709         /// force-closing any channels we have with it.
1710         ///
1711         /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1712         /// peer. Thus, be very careful about reentrancy issues.
1713         ///
1714         /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1715         pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1716                 let mut peers_lock = self.peers.write().unwrap();
1717                 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1718                         log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1719                         peers_lock.remove(&descriptor);
1720                         self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1721                         descriptor.disconnect_socket();
1722                 }
1723         }
1724
1725         /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1726         /// an indication that TCP sockets have stalled even if we weren't around to time them out
1727         /// using regular ping/pongs.
1728         pub fn disconnect_all_peers(&self) {
1729                 let mut peers_lock = self.peers.write().unwrap();
1730                 self.node_id_to_descriptor.lock().unwrap().clear();
1731                 let peers = &mut *peers_lock;
1732                 for (mut descriptor, peer) in peers.drain() {
1733                         if let Some(node_id) = peer.lock().unwrap().their_node_id {
1734                                 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1735                                 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1736                         }
1737                         descriptor.disconnect_socket();
1738                 }
1739         }
1740
1741         /// This is called when we're blocked on sending additional gossip messages until we receive a
1742         /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1743         /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1744         fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1745                 if peer.awaiting_pong_timer_tick_intervals == 0 {
1746                         peer.awaiting_pong_timer_tick_intervals = -1;
1747                         let ping = msgs::Ping {
1748                                 ponglen: 0,
1749                                 byteslen: 64,
1750                         };
1751                         self.enqueue_message(peer, &ping);
1752                 }
1753         }
1754
1755         /// Send pings to each peer and disconnect those which did not respond to the last round of
1756         /// pings.
1757         ///
1758         /// This may be called on any timescale you want, however, roughly once every ten seconds is
1759         /// preferred. The call rate determines both how often we send a ping to our peers and how much
1760         /// time they have to respond before we disconnect them.
1761         ///
1762         /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1763         /// issues!
1764         ///
1765         /// [`send_data`]: SocketDescriptor::send_data
1766         pub fn timer_tick_occurred(&self) {
1767                 let mut descriptors_needing_disconnect = Vec::new();
1768                 {
1769                         let peers_lock = self.peers.read().unwrap();
1770
1771                         for (descriptor, peer_mutex) in peers_lock.iter() {
1772                                 let mut peer = peer_mutex.lock().unwrap();
1773                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1774                                         // The peer needs to complete its handshake before we can exchange messages. We
1775                                         // give peers one timer tick to complete handshake, reusing
1776                                         // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1777                                         // for handshake completion.
1778                                         if peer.awaiting_pong_timer_tick_intervals != 0 {
1779                                                 descriptors_needing_disconnect.push(descriptor.clone());
1780                                         } else {
1781                                                 peer.awaiting_pong_timer_tick_intervals = 1;
1782                                         }
1783                                         continue;
1784                                 }
1785
1786                                 if peer.awaiting_pong_timer_tick_intervals == -1 {
1787                                         // Magic value set in `maybe_send_extra_ping`.
1788                                         peer.awaiting_pong_timer_tick_intervals = 1;
1789                                         peer.received_message_since_timer_tick = false;
1790                                         continue;
1791                                 }
1792
1793                                 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
1794                                         || peer.awaiting_pong_timer_tick_intervals as u64 >
1795                                                 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
1796                                 {
1797                                         descriptors_needing_disconnect.push(descriptor.clone());
1798                                         continue;
1799                                 }
1800                                 peer.received_message_since_timer_tick = false;
1801
1802                                 if peer.awaiting_pong_timer_tick_intervals > 0 {
1803                                         peer.awaiting_pong_timer_tick_intervals += 1;
1804                                         continue;
1805                                 }
1806
1807                                 peer.awaiting_pong_timer_tick_intervals = 1;
1808                                 let ping = msgs::Ping {
1809                                         ponglen: 0,
1810                                         byteslen: 64,
1811                                 };
1812                                 self.enqueue_message(&mut *peer, &ping);
1813                                 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer);
1814                         }
1815                 }
1816
1817                 if !descriptors_needing_disconnect.is_empty() {
1818                         {
1819                                 let mut peers_lock = self.peers.write().unwrap();
1820                                 for descriptor in descriptors_needing_disconnect.iter() {
1821                                         if let Some(peer) = peers_lock.remove(descriptor) {
1822                                                 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1823                                                         log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1824                                                         self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1825                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1826                                                 }
1827                                         }
1828                                 }
1829                         }
1830
1831                         for mut descriptor in descriptors_needing_disconnect.drain(..) {
1832                                 descriptor.disconnect_socket();
1833                         }
1834                 }
1835         }
1836 }
1837
1838 fn is_gossip_msg(type_id: u16) -> bool {
1839         match type_id {
1840                 msgs::ChannelAnnouncement::TYPE |
1841                 msgs::ChannelUpdate::TYPE |
1842                 msgs::NodeAnnouncement::TYPE |
1843                 msgs::QueryChannelRange::TYPE |
1844                 msgs::ReplyChannelRange::TYPE |
1845                 msgs::QueryShortChannelIds::TYPE |
1846                 msgs::ReplyShortChannelIdsEnd::TYPE => true,
1847                 _ => false
1848         }
1849 }
1850
1851 #[cfg(test)]
1852 mod tests {
1853         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
1854         use ln::{msgs, wire};
1855         use ln::msgs::NetAddress;
1856         use util::events;
1857         use util::test_utils;
1858
1859         use bitcoin::secp256k1::Secp256k1;
1860         use bitcoin::secp256k1::{SecretKey, PublicKey};
1861
1862         use prelude::*;
1863         use sync::{Arc, Mutex};
1864         use core::sync::atomic::Ordering;
1865
1866         #[derive(Clone)]
1867         struct FileDescriptor {
1868                 fd: u16,
1869                 outbound_data: Arc<Mutex<Vec<u8>>>,
1870         }
1871         impl PartialEq for FileDescriptor {
1872                 fn eq(&self, other: &Self) -> bool {
1873                         self.fd == other.fd
1874                 }
1875         }
1876         impl Eq for FileDescriptor { }
1877         impl core::hash::Hash for FileDescriptor {
1878                 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1879                         self.fd.hash(hasher)
1880                 }
1881         }
1882
1883         impl SocketDescriptor for FileDescriptor {
1884                 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1885                         self.outbound_data.lock().unwrap().extend_from_slice(data);
1886                         data.len()
1887                 }
1888
1889                 fn disconnect_socket(&mut self) {}
1890         }
1891
1892         struct PeerManagerCfg {
1893                 chan_handler: test_utils::TestChannelMessageHandler,
1894                 routing_handler: test_utils::TestRoutingMessageHandler,
1895                 logger: test_utils::TestLogger,
1896         }
1897
1898         fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1899                 let mut cfgs = Vec::new();
1900                 for _ in 0..peer_count {
1901                         cfgs.push(
1902                                 PeerManagerCfg{
1903                                         chan_handler: test_utils::TestChannelMessageHandler::new(),
1904                                         logger: test_utils::TestLogger::new(),
1905                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
1906                                 }
1907                         );
1908                 }
1909
1910                 cfgs
1911         }
1912
1913         fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>> {
1914                 let mut peers = Vec::new();
1915                 for i in 0..peer_count {
1916                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1917                         let ephemeral_bytes = [i as u8; 32];
1918                         let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1919                         let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {});
1920                         peers.push(peer);
1921                 }
1922
1923                 peers
1924         }
1925
1926         fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>) -> (FileDescriptor, FileDescriptor) {
1927                 let secp_ctx = Secp256k1::new();
1928                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1929                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1930                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1931                 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
1932                 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();
1933                 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1934                 peer_a.process_events();
1935
1936                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
1937                 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
1938
1939                 peer_b.process_events();
1940                 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
1941                 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
1942
1943                 peer_a.process_events();
1944                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
1945                 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
1946
1947                 (fd_a.clone(), fd_b.clone())
1948         }
1949
1950         #[test]
1951         fn test_disconnect_peer() {
1952                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1953                 // push a DisconnectPeer event to remove the node flagged by id
1954                 let cfgs = create_peermgr_cfgs(2);
1955                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1956                 let mut peers = create_network(2, &cfgs);
1957                 establish_connection(&peers[0], &peers[1]);
1958                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
1959
1960                 let secp_ctx = Secp256k1::new();
1961                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1962
1963                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1964                         node_id: their_id,
1965                         action: msgs::ErrorAction::DisconnectPeer { msg: None },
1966                 });
1967                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1968                 peers[0].message_handler.chan_handler = &chan_handler;
1969
1970                 peers[0].process_events();
1971                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
1972         }
1973
1974         #[test]
1975         fn test_send_simple_msg() {
1976                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1977                 // push a message from one peer to another.
1978                 let cfgs = create_peermgr_cfgs(2);
1979                 let a_chan_handler = test_utils::TestChannelMessageHandler::new();
1980                 let b_chan_handler = test_utils::TestChannelMessageHandler::new();
1981                 let mut peers = create_network(2, &cfgs);
1982                 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1983                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
1984
1985                 let secp_ctx = Secp256k1::new();
1986                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1987
1988                 let msg = msgs::Shutdown { channel_id: [42; 32], scriptpubkey: bitcoin::Script::new() };
1989                 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
1990                         node_id: their_id, msg: msg.clone()
1991                 });
1992                 peers[0].message_handler.chan_handler = &a_chan_handler;
1993
1994                 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
1995                 peers[1].message_handler.chan_handler = &b_chan_handler;
1996
1997                 peers[0].process_events();
1998
1999                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2000                 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2001         }
2002
2003         #[test]
2004         fn test_disconnect_all_peer() {
2005                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2006                 // then calls disconnect_all_peers
2007                 let cfgs = create_peermgr_cfgs(2);
2008                 let peers = create_network(2, &cfgs);
2009                 establish_connection(&peers[0], &peers[1]);
2010                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2011
2012                 peers[0].disconnect_all_peers();
2013                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2014         }
2015
2016         #[test]
2017         fn test_timer_tick_occurred() {
2018                 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2019                 let cfgs = create_peermgr_cfgs(2);
2020                 let peers = create_network(2, &cfgs);
2021                 establish_connection(&peers[0], &peers[1]);
2022                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2023
2024                 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2025                 peers[0].timer_tick_occurred();
2026                 peers[0].process_events();
2027                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2028
2029                 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2030                 peers[0].timer_tick_occurred();
2031                 peers[0].process_events();
2032                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2033         }
2034
2035         #[test]
2036         fn test_do_attempt_write_data() {
2037                 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2038                 let cfgs = create_peermgr_cfgs(2);
2039                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2040                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2041                 let peers = create_network(2, &cfgs);
2042
2043                 // By calling establish_connect, we trigger do_attempt_write_data between
2044                 // the peers. Previously this function would mistakenly enter an infinite loop
2045                 // when there were more channel messages available than could fit into a peer's
2046                 // buffer. This issue would now be detected by this test (because we use custom
2047                 // RoutingMessageHandlers that intentionally return more channel messages
2048                 // than can fit into a peer's buffer).
2049                 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2050
2051                 // Make each peer to read the messages that the other peer just wrote to them. Note that
2052                 // due to the max-message-before-ping limits this may take a few iterations to complete.
2053                 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2054                         peers[1].process_events();
2055                         let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2056                         assert!(!a_read_data.is_empty());
2057
2058                         peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2059                         peers[0].process_events();
2060
2061                         let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2062                         assert!(!b_read_data.is_empty());
2063                         peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2064
2065                         peers[0].process_events();
2066                         assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2067                 }
2068
2069                 // Check that each peer has received the expected number of channel updates and channel
2070                 // announcements.
2071                 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2072                 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2073                 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2074                 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2075         }
2076
2077         #[test]
2078         fn test_handshake_timeout() {
2079                 // Tests that we time out a peer still waiting on handshake completion after a full timer
2080                 // tick.
2081                 let cfgs = create_peermgr_cfgs(2);
2082                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2083                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2084                 let peers = create_network(2, &cfgs);
2085
2086                 let secp_ctx = Secp256k1::new();
2087                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peers[0].our_node_secret);
2088                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2089                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2090                 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2091                 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2092
2093                 // If we get a single timer tick before completion, that's fine
2094                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2095                 peers[0].timer_tick_occurred();
2096                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2097
2098                 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2099                 peers[0].process_events();
2100                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2101                 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2102                 peers[1].process_events();
2103
2104                 // ...but if we get a second timer tick, we should disconnect the peer
2105                 peers[0].timer_tick_occurred();
2106                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2107
2108                 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2109                 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
2110         }
2111
2112         #[test]
2113         fn test_filter_addresses(){
2114                 // Tests the filter_addresses function.
2115
2116                 // For (10/8)
2117                 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2118                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2119                 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2120                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2121                 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2122                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2123
2124                 // For (0/8)
2125                 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2126                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2127                 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2128                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2129                 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2130                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2131
2132                 // For (100.64/10)
2133                 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2134                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2135                 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2136                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2137                 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2138                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2139
2140                 // For (127/8)
2141                 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2142                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2143                 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2144                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2145                 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2146                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2147
2148                 // For (169.254/16)
2149                 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2150                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2151                 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2152                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2153                 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2154                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2155
2156                 // For (172.16/12)
2157                 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2158                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2159                 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2160                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2161                 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2162                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2163
2164                 // For (192.168/16)
2165                 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2166                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2167                 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2168                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2169                 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2170                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2171
2172                 // For (192.88.99/24)
2173                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2174                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2175                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2176                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2177                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2178                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2179
2180                 // For other IPv4 addresses
2181                 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2182                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2183                 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2184                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2185                 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2186                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2187
2188                 // For (2000::/3)
2189                 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2190                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2191                 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2192                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2193                 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2194                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2195
2196                 // For other IPv6 addresses
2197                 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2198                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2199                 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2200                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2201                 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2202                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2203
2204                 // For (None)
2205                 assert_eq!(filter_addresses(None), None);
2206         }
2207 }