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