_ Git - rust-lightning/blob - lightning/src/ln/peer_handler.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Top level peer message handling and socket handling logic lives here.
  11 //!
  12 //! Instead of actually servicing sockets ourselves we require that you implement the
  13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
  14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
  15 //! call into the provided message handlers (probably a ChannelManager and P2PGossipSync) with
  16 //! messages they should handle, and encoding/sending response messages.
  17
  18 use bitcoin::blockdata::constants::ChainHash;
  19 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
  20
  21 use crate::sign::{KeysManager, NodeSigner, Recipient};
  22 use crate::events::{MessageSendEvent, MessageSendEventsProvider};
  23 use crate::ln::ChannelId;
  24 use crate::ln::features::{InitFeatures, NodeFeatures};
  25 use crate::ln::msgs;
  26 use crate::ln::msgs::{ChannelMessageHandler, LightningError, SocketAddress, OnionMessageHandler, RoutingMessageHandler};
  27 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
  28 use crate::util::ser::{VecWriter, Writeable, Writer};
  29 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
  30 use crate::ln::wire;
  31 use crate::ln::wire::{Encode, Type};
  32 use crate::onion_message::{CustomOnionMessageHandler, OffersMessage, OffersMessageHandler, OnionMessageContents, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
  33 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, NodeAlias};
  34 use crate::util::atomic_counter::AtomicCounter;
  35 use crate::util::logger::Logger;
  36 use crate::util::string::PrintableString;
  37
  38 use crate::prelude::*;
  39 use crate::io;
  40 use alloc::collections::LinkedList;
  41 use crate::sync::{Arc, Mutex, MutexGuard, FairRwLock};
  42 use core::sync::atomic::{AtomicBool, AtomicU32, AtomicI32, Ordering};
  43 use core::{cmp, hash, fmt, mem};
  44 use core::ops::Deref;
  45 use core::convert::Infallible;
  46 #[cfg(feature = "std")] use std::error;
  47
  48 use bitcoin::hashes::sha256::Hash as Sha256;
  49 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
  50 use bitcoin::hashes::{HashEngine, Hash};
  51
  52 /// A handler provided to [`PeerManager`] for reading and handling custom messages.
  53 ///
  54 /// [BOLT 1] specifies a custom message type range for use with experimental or application-specific
  55 /// messages. `CustomMessageHandler` allows for user-defined handling of such types. See the
  56 /// [`lightning_custom_message`] crate for tools useful in composing more than one custom handler.
  57 ///
  58 /// [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
  59 /// [`lightning_custom_message`]: https://docs.rs/lightning_custom_message/latest/lightning_custom_message
  60 pub trait CustomMessageHandler: wire::CustomMessageReader {
  61         /// Handles the given message sent from `sender_node_id`, possibly producing messages for
  62         /// [`CustomMessageHandler::get_and_clear_pending_msg`] to return and thus for [`PeerManager`]
  63         /// to send.
  64         fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
  65
  66         /// Returns the list of pending messages that were generated by the handler, clearing the list
  67         /// in the process. Each message is paired with the node id of the intended recipient. If no
  68         /// connection to the node exists, then the message is simply not sent.
  69         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
  70
  71         /// Gets the node feature flags which this handler itself supports. All available handlers are
  72         /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
  73         /// which are broadcasted in our [`NodeAnnouncement`] message.
  74         ///
  75         /// [`NodeAnnouncement`]: crate::ln::msgs::NodeAnnouncement
  76         fn provided_node_features(&self) -> NodeFeatures;
  77
  78         /// Gets the init feature flags which should be sent to the given peer. All available handlers
  79         /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
  80         /// which are sent in our [`Init`] message.
  81         ///
  82         /// [`Init`]: crate::ln::msgs::Init
  83         fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
  84 }
  85
  86 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
  87 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
  88 pub struct IgnoringMessageHandler{}
  89 impl MessageSendEventsProvider for IgnoringMessageHandler {
  90         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
  91 }
  92 impl RoutingMessageHandler for IgnoringMessageHandler {
  93         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  94         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  95         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
  96         fn get_next_channel_announcement(&self, _starting_point: u64) ->
  97                 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
  98         fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
  99         fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
 100         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
 101         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
 102         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
 103         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
 104         fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
 105         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 106                 InitFeatures::empty()
 107         }
 108         fn processing_queue_high(&self) -> bool { false }
 109 }
 110 impl OnionMessageHandler for IgnoringMessageHandler {
 111         fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
 112         fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
 113         fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
 114         fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
 115         fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
 116         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 117                 InitFeatures::empty()
 118         }
 119 }
 120 impl OffersMessageHandler for IgnoringMessageHandler {
 121         fn handle_message(&self, _msg: OffersMessage) -> Option<OffersMessage> { None }
 122 }
 123 impl CustomOnionMessageHandler for IgnoringMessageHandler {
 124         type CustomMessage = Infallible;
 125         fn handle_custom_message(&self, _msg: Infallible) -> Option<Infallible> {
 126                 // Since we always return `None` in the read the handle method should never be called.
 127                 unreachable!();
 128         }
 129         fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
 130                 Ok(None)
 131         }
 132 }
 133
 134 impl OnionMessageContents for Infallible {
 135         fn tlv_type(&self) -> u64 { unreachable!(); }
 136 }
 137
 138 impl Deref for IgnoringMessageHandler {
 139         type Target = IgnoringMessageHandler;
 140         fn deref(&self) -> &Self { self }
 141 }
 142
 143 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
 144 // method that takes self for it.
 145 impl wire::Type for Infallible {
 146         fn type_id(&self) -> u16 {
 147                 unreachable!();
 148         }
 149 }
 150 impl Writeable for Infallible {
 151         fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
 152                 unreachable!();
 153         }
 154 }
 155
 156 impl wire::CustomMessageReader for IgnoringMessageHandler {
 157         type CustomMessage = Infallible;
 158         fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
 159                 Ok(None)
 160         }
 161 }
 162
 163 impl CustomMessageHandler for IgnoringMessageHandler {
 164         fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
 165                 // Since we always return `None` in the read the handle method should never be called.
 166                 unreachable!();
 167         }
 168
 169         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
 170
 171         fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
 172
 173         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 174                 InitFeatures::empty()
 175         }
 176 }
 177
 178 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
 179 /// You can provide one of these as the route_handler in a MessageHandler.
 180 pub struct ErroringMessageHandler {
 181         message_queue: Mutex<Vec<MessageSendEvent>>
 182 }
 183 impl ErroringMessageHandler {
 184         /// Constructs a new ErroringMessageHandler
 185         pub fn new() -> Self {
 186                 Self { message_queue: Mutex::new(Vec::new()) }
 187         }
 188         fn push_error(&self, node_id: &PublicKey, channel_id: ChannelId) {
 189                 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
 190                         action: msgs::ErrorAction::SendErrorMessage {
 191                                 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
 192                         },
 193                         node_id: node_id.clone(),
 194                 });
 195         }
 196 }
 197 impl MessageSendEventsProvider for ErroringMessageHandler {
 198         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
 199                 let mut res = Vec::new();
 200                 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
 201                 res
 202         }
 203 }
 204 impl ChannelMessageHandler for ErroringMessageHandler {
 205         // Any messages which are related to a specific channel generate an error message to let the
 206         // peer know we don't care about channels.
 207         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
 208                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 209         }
 210         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
 211                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 212         }
 213         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 214                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 215         }
 216         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 217                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 218         }
 219         fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
 220                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 221         }
 222         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
 223                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 224         }
 225         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 226                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 227         }
 228         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 229                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 230         }
 231         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 232                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 233         }
 234         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 235                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 236         }
 237         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 238                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 239         }
 240         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 241                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 242         }
 243         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 244                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 245         }
 246         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 247                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 248         }
 249         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 250                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 251         }
 252         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 253                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 254         }
 255         // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
 256         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 257         fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
 258         fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
 259         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 260         fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
 261         fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
 262                 // Set a number of features which various nodes may require to talk to us. It's totally
 263                 // reasonable to indicate we "support" all kinds of channel features...we just reject all
 264                 // channels.
 265                 let mut features = InitFeatures::empty();
 266                 features.set_data_loss_protect_optional();
 267                 features.set_upfront_shutdown_script_optional();
 268                 features.set_variable_length_onion_optional();
 269                 features.set_static_remote_key_optional();
 270                 features.set_payment_secret_optional();
 271                 features.set_basic_mpp_optional();
 272                 features.set_wumbo_optional();
 273                 features.set_shutdown_any_segwit_optional();
 274                 features.set_channel_type_optional();
 275                 features.set_scid_privacy_optional();
 276                 features.set_zero_conf_optional();
 277                 features
 278         }
 279
 280         fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
 281                 // We don't enforce any chains upon peer connection for `ErroringMessageHandler` and leave it up
 282                 // to users of `ErroringMessageHandler` to make decisions on network compatiblility.
 283                 // There's not really any way to pull in specific networks here, and hardcoding can cause breakages.
 284                 None
 285         }
 286
 287         fn handle_open_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
 288                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 289         }
 290
 291         fn handle_accept_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
 292                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 293         }
 294
 295         fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
 296                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 297         }
 298
 299         fn handle_tx_add_output(&self, their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
 300                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 301         }
 302
 303         fn handle_tx_remove_input(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
 304                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 305         }
 306
 307         fn handle_tx_remove_output(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
 308                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 309         }
 310
 311         fn handle_tx_complete(&self, their_node_id: &PublicKey, msg: &msgs::TxComplete) {
 312                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 313         }
 314
 315         fn handle_tx_signatures(&self, their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
 316                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 317         }
 318
 319         fn handle_tx_init_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
 320                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 321         }
 322
 323         fn handle_tx_ack_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
 324                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 325         }
 326
 327         fn handle_tx_abort(&self, their_node_id: &PublicKey, msg: &msgs::TxAbort) {
 328                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 329         }
 330 }
 331
 332 impl Deref for ErroringMessageHandler {
 333         type Target = ErroringMessageHandler;
 334         fn deref(&self) -> &Self { self }
 335 }
 336
 337 /// Provides references to trait impls which handle different types of messages.
 338 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref, CustomM: Deref> where
 339         CM::Target: ChannelMessageHandler,
 340         RM::Target: RoutingMessageHandler,
 341         OM::Target: OnionMessageHandler,
 342         CustomM::Target: CustomMessageHandler,
 343 {
 344         /// A message handler which handles messages specific to channels. Usually this is just a
 345         /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
 346         ///
 347         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 348         pub chan_handler: CM,
 349         /// A message handler which handles messages updating our knowledge of the network channel
 350         /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
 351         ///
 352         /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
 353         pub route_handler: RM,
 354
 355         /// A message handler which handles onion messages. This should generally be an
 356         /// [`OnionMessenger`], but can also be an [`IgnoringMessageHandler`].
 357         ///
 358         /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
 359         pub onion_message_handler: OM,
 360
 361         /// A message handler which handles custom messages. The only LDK-provided implementation is
 362         /// [`IgnoringMessageHandler`].
 363         pub custom_message_handler: CustomM,
 364 }
 365
 366 /// Provides an object which can be used to send data to and which uniquely identifies a connection
 367 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
 368 /// implement Hash to meet the PeerManager API.
 369 ///
 370 /// For efficiency, [`Clone`] should be relatively cheap for this type.
 371 ///
 372 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
 373 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
 374 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
 375 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
 376 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
 377 /// to simply use another value which is guaranteed to be globally unique instead.
 378 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
 379         /// Attempts to send some data from the given slice to the peer.
 380         ///
 381         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
 382         /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
 383         /// called and further write attempts may occur until that time.
 384         ///
 385         /// If the returned size is smaller than `data.len()`, a
 386         /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
 387         /// written. Additionally, until a `send_data` event completes fully, no further
 388         /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
 389         /// prevent denial-of-service issues, you should not read or buffer any data from the socket
 390         /// until then.
 391         ///
 392         /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
 393         /// (indicating that read events should be paused to prevent DoS in the send buffer),
 394         /// `resume_read` may be set indicating that read events on this descriptor should resume. A
 395         /// `resume_read` of false carries no meaning, and should not cause any action.
 396         fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
 397         /// Disconnect the socket pointed to by this SocketDescriptor.
 398         ///
 399         /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
 400         /// call (doing so is a noop).
 401         fn disconnect_socket(&mut self);
 402 }
 403
 404 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
 405 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
 406 /// descriptor.
 407 #[derive(Clone)]
 408 pub struct PeerHandleError { }
 409 impl fmt::Debug for PeerHandleError {
 410         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 411                 formatter.write_str("Peer Sent Invalid Data")
 412         }
 413 }
 414 impl fmt::Display for PeerHandleError {
 415         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 416                 formatter.write_str("Peer Sent Invalid Data")
 417         }
 418 }
 419
 420 #[cfg(feature = "std")]
 421 impl error::Error for PeerHandleError {
 422         fn description(&self) -> &str {
 423                 "Peer Sent Invalid Data"
 424         }
 425 }
 426
 427 enum InitSyncTracker{
 428         NoSyncRequested,
 429         ChannelsSyncing(u64),
 430         NodesSyncing(NodeId),
 431 }
 432
 433 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
 434 /// forwarding gossip messages to peers altogether.
 435 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
 436
 437 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
 438 /// we have fewer than this many messages in the outbound buffer again.
 439 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
 440 /// refilled as we send bytes.
 441 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
 442 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
 443 /// the peer.
 444 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
 445
 446 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
 447 /// the socket receive buffer before receiving the ping.
 448 ///
 449 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
 450 /// including any network delays, outbound traffic, or the same for messages from other peers.
 451 ///
 452 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
 453 /// per connected peer to respond to a ping, as long as they send us at least one message during
 454 /// each tick, ensuring we aren't actually just disconnected.
 455 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
 456 /// peer.
 457 ///
 458 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
 459 /// two connected peers, assuming most LDK-running systems have at least two cores.
 460 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
 461
 462 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
 463 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
 464 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
 465 /// process before the next ping.
 466 ///
 467 /// Note that we continue responding to other messages even after we've sent this many messages, so
 468 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
 469 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
 470 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
 471
 472 struct Peer {
 473         channel_encryptor: PeerChannelEncryptor,
 474         /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
 475         /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
 476         their_node_id: Option<(PublicKey, NodeId)>,
 477         /// The features provided in the peer's [`msgs::Init`] message.
 478         ///
 479         /// This is set only after we've processed the [`msgs::Init`] message and called relevant
 480         /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
 481         /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
 482         /// check this.
 483         their_features: Option<InitFeatures>,
 484         their_socket_address: Option<SocketAddress>,
 485
 486         pending_outbound_buffer: LinkedList<Vec<u8>>,
 487         pending_outbound_buffer_first_msg_offset: usize,
 488         /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
 489         /// prioritize channel messages over them.
 490         ///
 491         /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
 492         gossip_broadcast_buffer: LinkedList<Vec<u8>>,
 493         awaiting_write_event: bool,
 494
 495         pending_read_buffer: Vec<u8>,
 496         pending_read_buffer_pos: usize,
 497         pending_read_is_header: bool,
 498
 499         sync_status: InitSyncTracker,
 500
 501         msgs_sent_since_pong: usize,
 502         awaiting_pong_timer_tick_intervals: i64,
 503         received_message_since_timer_tick: bool,
 504         sent_gossip_timestamp_filter: bool,
 505
 506         /// Indicates we've received a `channel_announcement` since the last time we had
 507         /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
 508         /// `channel_announcement` at all - we set this unconditionally but unset it every time we
 509         /// check if we're gossip-processing-backlogged).
 510         received_channel_announce_since_backlogged: bool,
 511
 512         inbound_connection: bool,
 513 }
 514
 515 impl Peer {
 516         /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
 517         /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
 518         /// normally.
 519         fn handshake_complete(&self) -> bool {
 520                 self.their_features.is_some()
 521         }
 522
 523         /// Returns true if the channel announcements/updates for the given channel should be
 524         /// forwarded to this peer.
 525         /// If we are sending our routing table to this peer and we have not yet sent channel
 526         /// announcements/updates for the given channel_id then we will send it when we get to that
 527         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 528         /// sent the old versions, we should send the update, and so return true here.
 529         fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
 530                 if !self.handshake_complete() { return false; }
 531                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 532                         !self.sent_gossip_timestamp_filter {
 533                                 return false;
 534                         }
 535                 match self.sync_status {
 536                         InitSyncTracker::NoSyncRequested => true,
 537                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 538                         InitSyncTracker::NodesSyncing(_) => true,
 539                 }
 540         }
 541
 542         /// Similar to the above, but for node announcements indexed by node_id.
 543         fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
 544                 if !self.handshake_complete() { return false; }
 545                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 546                         !self.sent_gossip_timestamp_filter {
 547                                 return false;
 548                         }
 549                 match self.sync_status {
 550                         InitSyncTracker::NoSyncRequested => true,
 551                         InitSyncTracker::ChannelsSyncing(_) => false,
 552                         InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
 553                 }
 554         }
 555
 556         /// Returns whether we should be reading bytes from this peer, based on whether its outbound
 557         /// buffer still has space and we don't need to pause reads to get some writes out.
 558         fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
 559                 if !gossip_processing_backlogged {
 560                         self.received_channel_announce_since_backlogged = false;
 561                 }
 562                 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
 563                         (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
 564         }
 565
 566         /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
 567         /// outbound buffer. This is checked every time the peer's buffer may have been drained.
 568         fn should_buffer_gossip_backfill(&self) -> bool {
 569                 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
 570                         && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
 571                         && self.handshake_complete()
 572         }
 573
 574         /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
 575         /// every time the peer's buffer may have been drained.
 576         fn should_buffer_onion_message(&self) -> bool {
 577                 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
 578                         && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
 579         }
 580
 581         /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
 582         /// buffer. This is checked every time the peer's buffer may have been drained.
 583         fn should_buffer_gossip_broadcast(&self) -> bool {
 584                 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
 585                         && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
 586         }
 587
 588         /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
 589         fn buffer_full_drop_gossip_broadcast(&self) -> bool {
 590                 let total_outbound_buffered =
 591                         self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
 592
 593                 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
 594                         self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
 595         }
 596
 597         fn set_their_node_id(&mut self, node_id: PublicKey) {
 598                 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
 599         }
 600 }
 601
 602 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
 603 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
 604 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
 605 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
 606 /// issues such as overly long function definitions.
 607 ///
 608 /// This is not exported to bindings users as `Arc`s don't make sense in bindings.
 609 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<
 610         SD,
 611         Arc<SimpleArcChannelManager<M, T, F, L>>,
 612         Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, C, Arc<L>>>,
 613         Arc<SimpleArcOnionMessenger<L>>,
 614         Arc<L>,
 615         IgnoringMessageHandler,
 616         Arc<KeysManager>
 617 >;
 618
 619 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
 620 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
 621 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
 622 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
 623 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
 624 /// helps with issues such as long function definitions.
 625 ///
 626 /// This is not exported to bindings users as general type aliases don't make sense in bindings.
 627 pub type SimpleRefPeerManager<
 628         'a, 'b, 'c, 'd, 'e, 'f, 'logger, 'h, 'i, 'j, 'graph, SD, M, T, F, C, L
 629 > = PeerManager<
 630         SD,
 631         &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, M, T, F, L>,
 632         &'f P2PGossipSync<&'graph NetworkGraph<&'logger L>, C, &'logger L>,
 633         &'h SimpleRefOnionMessenger<'logger, 'i, 'j, L>,
 634         &'logger L,
 635         IgnoringMessageHandler,
 636         &'c KeysManager
 637 >;
 638
 639
 640 /// A generic trait which is implemented for all [`PeerManager`]s. This makes bounding functions or
 641 /// structs on any [`PeerManager`] much simpler as only this trait is needed as a bound, rather
 642 /// than the full set of bounds on [`PeerManager`] itself.
 643 ///
 644 /// This is not exported to bindings users as general cover traits aren't useful in other
 645 /// languages.
 646 #[allow(missing_docs)]
 647 pub trait APeerManager {
 648         type Descriptor: SocketDescriptor;
 649         type CMT: ChannelMessageHandler + ?Sized;
 650         type CM: Deref<Target=Self::CMT>;
 651         type RMT: RoutingMessageHandler + ?Sized;
 652         type RM: Deref<Target=Self::RMT>;
 653         type OMT: OnionMessageHandler + ?Sized;
 654         type OM: Deref<Target=Self::OMT>;
 655         type LT: Logger + ?Sized;
 656         type L: Deref<Target=Self::LT>;
 657         type CMHT: CustomMessageHandler + ?Sized;
 658         type CMH: Deref<Target=Self::CMHT>;
 659         type NST: NodeSigner + ?Sized;
 660         type NS: Deref<Target=Self::NST>;
 661         /// Gets a reference to the underlying [`PeerManager`].
 662         fn as_ref(&self) -> &PeerManager<Self::Descriptor, Self::CM, Self::RM, Self::OM, Self::L, Self::CMH, Self::NS>;
 663 }
 664
 665 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref>
 666 APeerManager for PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
 667         CM::Target: ChannelMessageHandler,
 668         RM::Target: RoutingMessageHandler,
 669         OM::Target: OnionMessageHandler,
 670         L::Target: Logger,
 671         CMH::Target: CustomMessageHandler,
 672         NS::Target: NodeSigner,
 673 {
 674         type Descriptor = Descriptor;
 675         type CMT = <CM as Deref>::Target;
 676         type CM = CM;
 677         type RMT = <RM as Deref>::Target;
 678         type RM = RM;
 679         type OMT = <OM as Deref>::Target;
 680         type OM = OM;
 681         type LT = <L as Deref>::Target;
 682         type L = L;
 683         type CMHT = <CMH as Deref>::Target;
 684         type CMH = CMH;
 685         type NST = <NS as Deref>::Target;
 686         type NS = NS;
 687         fn as_ref(&self) -> &PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> { self }
 688 }
 689
 690 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
 691 /// socket events into messages which it passes on to its [`MessageHandler`].
 692 ///
 693 /// Locks are taken internally, so you must never assume that reentrancy from a
 694 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
 695 ///
 696 /// Calls to [`read_event`] will decode relevant messages and pass them to the
 697 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
 698 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
 699 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
 700 /// calls only after previous ones have returned.
 701 ///
 702 /// Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
 703 /// a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
 704 /// essentially you should default to using a [`SimpleRefPeerManager`], and use a
 705 /// [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
 706 /// you're using lightning-net-tokio.
 707 ///
 708 /// [`read_event`]: PeerManager::read_event
 709 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
 710                 CM::Target: ChannelMessageHandler,
 711                 RM::Target: RoutingMessageHandler,
 712                 OM::Target: OnionMessageHandler,
 713                 L::Target: Logger,
 714                 CMH::Target: CustomMessageHandler,
 715                 NS::Target: NodeSigner {
 716         message_handler: MessageHandler<CM, RM, OM, CMH>,
 717         /// Connection state for each connected peer - we have an outer read-write lock which is taken
 718         /// as read while we're doing processing for a peer and taken write when a peer is being added
 719         /// or removed.
 720         ///
 721         /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
 722         /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
 723         /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
 724         /// the `MessageHandler`s for a given peer is already guaranteed.
 725         peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
 726         /// Only add to this set when noise completes.
 727         /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
 728         /// lock held. Entries may be added with only the `peers` read lock held (though the
 729         /// `Descriptor` value must already exist in `peers`).
 730         node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
 731         /// We can only have one thread processing events at once, but if a second call to
 732         /// `process_events` happens while a first call is in progress, one of the two calls needs to
 733         /// start from the top to ensure any new messages are also handled.
 734         ///
 735         /// Because the event handler calls into user code which may block, we don't want to block a
 736         /// second thread waiting for another thread to handle events which is then blocked on user
 737         /// code, so we store an atomic counter here:
 738         ///  * 0 indicates no event processor is running
 739         ///  * 1 indicates an event processor is running
 740         ///  * > 1 indicates an event processor is running but needs to start again from the top once
 741         ///        it finishes as another thread tried to start processing events but returned early.
 742         event_processing_state: AtomicI32,
 743
 744         /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
 745         /// value increases strictly since we don't assume access to a time source.
 746         last_node_announcement_serial: AtomicU32,
 747
 748         ephemeral_key_midstate: Sha256Engine,
 749
 750         peer_counter: AtomicCounter,
 751
 752         gossip_processing_backlogged: AtomicBool,
 753         gossip_processing_backlog_lifted: AtomicBool,
 754
 755         node_signer: NS,
 756
 757         logger: L,
 758         secp_ctx: Secp256k1<secp256k1::SignOnly>
 759 }
 760
 761 enum MessageHandlingError {
 762         PeerHandleError(PeerHandleError),
 763         LightningError(LightningError),
 764 }
 765
 766 impl From<PeerHandleError> for MessageHandlingError {
 767         fn from(error: PeerHandleError) -> Self {
 768                 MessageHandlingError::PeerHandleError(error)
 769         }
 770 }
 771
 772 impl From<LightningError> for MessageHandlingError {
 773         fn from(error: LightningError) -> Self {
 774                 MessageHandlingError::LightningError(error)
 775         }
 776 }
 777
 778 macro_rules! encode_msg {
 779         ($msg: expr) => {{
 780                 let mut buffer = VecWriter(Vec::new());
 781                 wire::write($msg, &mut buffer).unwrap();
 782                 buffer.0
 783         }}
 784 }
 785
 786 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
 787                 CM::Target: ChannelMessageHandler,
 788                 OM::Target: OnionMessageHandler,
 789                 L::Target: Logger,
 790                 NS::Target: NodeSigner {
 791         /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
 792         /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
 793         /// ignored.
 794         ///
 795         /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
 796         /// cryptographically secure random bytes.
 797         ///
 798         /// `current_time` is used as an always-increasing counter that survives across restarts and is
 799         /// incremented irregularly internally. In general it is best to simply use the current UNIX
 800         /// timestamp, however if it is not available a persistent counter that increases once per
 801         /// minute should suffice.
 802         ///
 803         /// This is not exported to bindings users as we can't export a PeerManager with a dummy route handler
 804         pub fn new_channel_only(channel_message_handler: CM, onion_message_handler: OM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
 805                 Self::new(MessageHandler {
 806                         chan_handler: channel_message_handler,
 807                         route_handler: IgnoringMessageHandler{},
 808                         onion_message_handler,
 809                         custom_message_handler: IgnoringMessageHandler{},
 810                 }, current_time, ephemeral_random_data, logger, node_signer)
 811         }
 812 }
 813
 814 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
 815                 RM::Target: RoutingMessageHandler,
 816                 L::Target: Logger,
 817                 NS::Target: NodeSigner {
 818         /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
 819         /// handler or onion message handler is used and onion and channel messages will be ignored (or
 820         /// generate error messages). Note that some other lightning implementations time-out connections
 821         /// after some time if no channel is built with the peer.
 822         ///
 823         /// `current_time` is used as an always-increasing counter that survives across restarts and is
 824         /// incremented irregularly internally. In general it is best to simply use the current UNIX
 825         /// timestamp, however if it is not available a persistent counter that increases once per
 826         /// minute should suffice.
 827         ///
 828         /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
 829         /// cryptographically secure random bytes.
 830         ///
 831         /// This is not exported to bindings users as we can't export a PeerManager with a dummy channel handler
 832         pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
 833                 Self::new(MessageHandler {
 834                         chan_handler: ErroringMessageHandler::new(),
 835                         route_handler: routing_message_handler,
 836                         onion_message_handler: IgnoringMessageHandler{},
 837                         custom_message_handler: IgnoringMessageHandler{},
 838                 }, current_time, ephemeral_random_data, logger, node_signer)
 839         }
 840 }
 841
 842 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
 843 /// This works around `format!()` taking a reference to each argument, preventing
 844 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
 845 /// due to lifetime errors.
 846 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
 847 impl core::fmt::Display for OptionalFromDebugger<'_> {
 848         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
 849                 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
 850         }
 851 }
 852
 853 /// A function used to filter out local or private addresses
 854 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
 855 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
 856 fn filter_addresses(ip_address: Option<SocketAddress>) -> Option<SocketAddress> {
 857         match ip_address{
 858                 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
 859                 Some(SocketAddress::TcpIpV4{addr: [10, _, _, _], port: _}) => None,
 860                 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
 861                 Some(SocketAddress::TcpIpV4{addr: [0, _, _, _], port: _}) => None,
 862                 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
 863                 Some(SocketAddress::TcpIpV4{addr: [100, 64..=127, _, _], port: _}) => None,
 864                 // For IPv4 range       127.0.0.0 - 127.255.255.255 (127/8)
 865                 Some(SocketAddress::TcpIpV4{addr: [127, _, _, _], port: _}) => None,
 866                 // For IPv4 range       169.254.0.0 - 169.254.255.255 (169.254/16)
 867                 Some(SocketAddress::TcpIpV4{addr: [169, 254, _, _], port: _}) => None,
 868                 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
 869                 Some(SocketAddress::TcpIpV4{addr: [172, 16..=31, _, _], port: _}) => None,
 870                 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
 871                 Some(SocketAddress::TcpIpV4{addr: [192, 168, _, _], port: _}) => None,
 872                 // For IPv4 range 192.88.99.0 - 192.88.99.255  (192.88.99/24)
 873                 Some(SocketAddress::TcpIpV4{addr: [192, 88, 99, _], port: _}) => None,
 874                 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
 875                 Some(SocketAddress::TcpIpV6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
 876                 // For remaining addresses
 877                 Some(SocketAddress::TcpIpV6{addr: _, port: _}) => None,
 878                 Some(..) => ip_address,
 879                 None => None,
 880         }
 881 }
 882
 883 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
 884                 CM::Target: ChannelMessageHandler,
 885                 RM::Target: RoutingMessageHandler,
 886                 OM::Target: OnionMessageHandler,
 887                 L::Target: Logger,
 888                 CMH::Target: CustomMessageHandler,
 889                 NS::Target: NodeSigner
 890 {
 891         /// Constructs a new `PeerManager` with the given message handlers.
 892         ///
 893         /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
 894         /// cryptographically secure random bytes.
 895         ///
 896         /// `current_time` is used as an always-increasing counter that survives across restarts and is
 897         /// incremented irregularly internally. In general it is best to simply use the current UNIX
 898         /// timestamp, however if it is not available a persistent counter that increases once per
 899         /// minute should suffice.
 900         pub fn new(message_handler: MessageHandler<CM, RM, OM, CMH>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
 901                 let mut ephemeral_key_midstate = Sha256::engine();
 902                 ephemeral_key_midstate.input(ephemeral_random_data);
 903
 904                 let mut secp_ctx = Secp256k1::signing_only();
 905                 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
 906                 secp_ctx.seeded_randomize(&ephemeral_hash);
 907
 908                 PeerManager {
 909                         message_handler,
 910                         peers: FairRwLock::new(HashMap::new()),
 911                         node_id_to_descriptor: Mutex::new(HashMap::new()),
 912                         event_processing_state: AtomicI32::new(0),
 913                         ephemeral_key_midstate,
 914                         peer_counter: AtomicCounter::new(),
 915                         gossip_processing_backlogged: AtomicBool::new(false),
 916                         gossip_processing_backlog_lifted: AtomicBool::new(false),
 917                         last_node_announcement_serial: AtomicU32::new(current_time),
 918                         logger,
 919                         node_signer,
 920                         secp_ctx,
 921                 }
 922         }
 923
 924         /// Get a list of tuples mapping from node id to network addresses for peers which have
 925         /// completed the initial handshake.
 926         ///
 927         /// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
 928         /// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
 929         /// handshake has completed and we are sure the remote peer has the private key for the given
 930         /// [`PublicKey`].
 931         ///
 932         /// The returned `Option`s will only be `Some` if an address had been previously given via
 933         /// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
 934         pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
 935                 let peers = self.peers.read().unwrap();
 936                 peers.values().filter_map(|peer_mutex| {
 937                         let p = peer_mutex.lock().unwrap();
 938                         if !p.handshake_complete() {
 939                                 return None;
 940                         }
 941                         Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 942                 }).collect()
 943         }
 944
 945         fn get_ephemeral_key(&self) -> SecretKey {
 946                 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 947                 let counter = self.peer_counter.get_increment();
 948                 ephemeral_hash.input(&counter.to_le_bytes());
 949                 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
 950         }
 951
 952         fn init_features(&self, their_node_id: &PublicKey) -> InitFeatures {
 953                 self.message_handler.chan_handler.provided_init_features(their_node_id)
 954                         | self.message_handler.route_handler.provided_init_features(their_node_id)
 955                         | self.message_handler.onion_message_handler.provided_init_features(their_node_id)
 956                         | self.message_handler.custom_message_handler.provided_init_features(their_node_id)
 957         }
 958
 959         /// Indicates a new outbound connection has been established to a node with the given `node_id`
 960         /// and an optional remote network address.
 961         ///
 962         /// The remote network address adds the option to report a remote IP address back to a connecting
 963         /// peer using the init message.
 964         /// The user should pass the remote network address of the host they are connected to.
 965         ///
 966         /// If an `Err` is returned here you must disconnect the connection immediately.
 967         ///
 968         /// Returns a small number of bytes to send to the remote node (currently always 50).
 969         ///
 970         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
 971         /// [`socket_disconnected`].
 972         ///
 973         /// [`socket_disconnected`]: PeerManager::socket_disconnected
 974         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<Vec<u8>, PeerHandleError> {
 975                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
 976                 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
 977                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 978
 979                 let mut peers = self.peers.write().unwrap();
 980                 match peers.entry(descriptor) {
 981                         hash_map::Entry::Occupied(_) => {
 982                                 debug_assert!(false, "PeerManager driver duplicated descriptors!");
 983                                 Err(PeerHandleError {})
 984                         },
 985                         hash_map::Entry::Vacant(e) => {
 986                                 e.insert(Mutex::new(Peer {
 987                                         channel_encryptor: peer_encryptor,
 988                                         their_node_id: None,
 989                                         their_features: None,
 990                                         their_socket_address: remote_network_address,
 991
 992                                         pending_outbound_buffer: LinkedList::new(),
 993                                         pending_outbound_buffer_first_msg_offset: 0,
 994                                         gossip_broadcast_buffer: LinkedList::new(),
 995                                         awaiting_write_event: false,
 996
 997                                         pending_read_buffer,
 998                                         pending_read_buffer_pos: 0,
 999                                         pending_read_is_header: false,
1000
1001                                         sync_status: InitSyncTracker::NoSyncRequested,
1002
1003                                         msgs_sent_since_pong: 0,
1004                                         awaiting_pong_timer_tick_intervals: 0,
1005                                         received_message_since_timer_tick: false,
1006                                         sent_gossip_timestamp_filter: false,
1007
1008                                         received_channel_announce_since_backlogged: false,
1009                                         inbound_connection: false,
1010                                 }));
1011                                 Ok(res)
1012                         }
1013                 }
1014         }
1015
1016         /// Indicates a new inbound connection has been established to a node with an optional remote
1017         /// network address.
1018         ///
1019         /// The remote network address adds the option to report a remote IP address back to a connecting
1020         /// peer using the init message.
1021         /// The user should pass the remote network address of the host they are connected to.
1022         ///
1023         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
1024         /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
1025         /// the connection immediately.
1026         ///
1027         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1028         /// [`socket_disconnected`].
1029         ///
1030         /// [`socket_disconnected`]: PeerManager::socket_disconnected
1031         pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<(), PeerHandleError> {
1032                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
1033                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
1034
1035                 let mut peers = self.peers.write().unwrap();
1036                 match peers.entry(descriptor) {
1037                         hash_map::Entry::Occupied(_) => {
1038                                 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1039                                 Err(PeerHandleError {})
1040                         },
1041                         hash_map::Entry::Vacant(e) => {
1042                                 e.insert(Mutex::new(Peer {
1043                                         channel_encryptor: peer_encryptor,
1044                                         their_node_id: None,
1045                                         their_features: None,
1046                                         their_socket_address: remote_network_address,
1047
1048                                         pending_outbound_buffer: LinkedList::new(),
1049                                         pending_outbound_buffer_first_msg_offset: 0,
1050                                         gossip_broadcast_buffer: LinkedList::new(),
1051                                         awaiting_write_event: false,
1052
1053                                         pending_read_buffer,
1054                                         pending_read_buffer_pos: 0,
1055                                         pending_read_is_header: false,
1056
1057                                         sync_status: InitSyncTracker::NoSyncRequested,
1058
1059                                         msgs_sent_since_pong: 0,
1060                                         awaiting_pong_timer_tick_intervals: 0,
1061                                         received_message_since_timer_tick: false,
1062                                         sent_gossip_timestamp_filter: false,
1063
1064                                         received_channel_announce_since_backlogged: false,
1065                                         inbound_connection: true,
1066                                 }));
1067                                 Ok(())
1068                         }
1069                 }
1070         }
1071
1072         fn peer_should_read(&self, peer: &mut Peer) -> bool {
1073                 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
1074         }
1075
1076         fn update_gossip_backlogged(&self) {
1077                 let new_state = self.message_handler.route_handler.processing_queue_high();
1078                 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
1079                 if prev_state && !new_state {
1080                         self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
1081                 }
1082         }
1083
1084         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
1085                 let mut have_written = false;
1086                 while !peer.awaiting_write_event {
1087                         if peer.should_buffer_onion_message() {
1088                                 if let Some((peer_node_id, _)) = peer.their_node_id {
1089                                         if let Some(next_onion_message) =
1090                                                 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
1091                                                         self.enqueue_message(peer, &next_onion_message);
1092                                         }
1093                                 }
1094                         }
1095                         if peer.should_buffer_gossip_broadcast() {
1096                                 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
1097                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(&msg[..]));
1098                                 }
1099                         }
1100                         if peer.should_buffer_gossip_backfill() {
1101                                 match peer.sync_status {
1102                                         InitSyncTracker::NoSyncRequested => {},
1103                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
1104                                                 if let Some((announce, update_a_option, update_b_option)) =
1105                                                         self.message_handler.route_handler.get_next_channel_announcement(c)
1106                                                 {
1107                                                         self.enqueue_message(peer, &announce);
1108                                                         if let Some(update_a) = update_a_option {
1109                                                                 self.enqueue_message(peer, &update_a);
1110                                                         }
1111                                                         if let Some(update_b) = update_b_option {
1112                                                                 self.enqueue_message(peer, &update_b);
1113                                                         }
1114                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
1115                                                 } else {
1116                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
1117                                                 }
1118                                         },
1119                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
1120                                                 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
1121                                                         self.enqueue_message(peer, &msg);
1122                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1123                                                 } else {
1124                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
1125                                                 }
1126                                         },
1127                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
1128                                         InitSyncTracker::NodesSyncing(sync_node_id) => {
1129                                                 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
1130                                                         self.enqueue_message(peer, &msg);
1131                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1132                                                 } else {
1133                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
1134                                                 }
1135                                         },
1136                                 }
1137                         }
1138                         if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
1139                                 self.maybe_send_extra_ping(peer);
1140                         }
1141
1142                         let should_read = self.peer_should_read(peer);
1143                         let next_buff = match peer.pending_outbound_buffer.front() {
1144                                 None => {
1145                                         if force_one_write && !have_written {
1146                                                 if should_read {
1147                                                         let data_sent = descriptor.send_data(&[], should_read);
1148                                                         debug_assert_eq!(data_sent, 0, "Can't write more than no data");
1149                                                 }
1150                                         }
1151                                         return
1152                                 },
1153                                 Some(buff) => buff,
1154                         };
1155
1156                         let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
1157                         let data_sent = descriptor.send_data(pending, should_read);
1158                         have_written = true;
1159                         peer.pending_outbound_buffer_first_msg_offset += data_sent;
1160                         if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
1161                                 peer.pending_outbound_buffer_first_msg_offset = 0;
1162                                 peer.pending_outbound_buffer.pop_front();
1163                         } else {
1164                                 peer.awaiting_write_event = true;
1165                         }
1166                 }
1167         }
1168
1169         /// Indicates that there is room to write data to the given socket descriptor.
1170         ///
1171         /// May return an Err to indicate that the connection should be closed.
1172         ///
1173         /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1174         /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1175         /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1176         /// ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
1177         /// sufficient!
1178         ///
1179         /// [`send_data`]: SocketDescriptor::send_data
1180         /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1181         pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1182                 let peers = self.peers.read().unwrap();
1183                 match peers.get(descriptor) {
1184                         None => {
1185                                 // This is most likely a simple race condition where the user found that the socket
1186                                 // was writeable, then we told the user to `disconnect_socket()`, then they called
1187                                 // this method. Return an error to make sure we get disconnected.
1188                                 return Err(PeerHandleError { });
1189                         },
1190                         Some(peer_mutex) => {
1191                                 let mut peer = peer_mutex.lock().unwrap();
1192                                 peer.awaiting_write_event = false;
1193                                 self.do_attempt_write_data(descriptor, &mut peer, false);
1194                         }
1195                 };
1196                 Ok(())
1197         }
1198
1199         /// Indicates that data was read from the given socket descriptor.
1200         ///
1201         /// May return an Err to indicate that the connection should be closed.
1202         ///
1203         /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1204         /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1205         /// [`send_data`] calls to handle responses.
1206         ///
1207         /// If `Ok(true)` is returned, further read_events should not be triggered until a
1208         /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1209         /// send buffer).
1210         ///
1211         /// In order to avoid processing too many messages at once per peer, `data` should be on the
1212         /// order of 4KiB.
1213         ///
1214         /// [`send_data`]: SocketDescriptor::send_data
1215         /// [`process_events`]: PeerManager::process_events
1216         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1217                 match self.do_read_event(peer_descriptor, data) {
1218                         Ok(res) => Ok(res),
1219                         Err(e) => {
1220                                 log_trace!(self.logger, "Disconnecting peer due to a protocol error (usually a duplicate connection).");
1221                                 self.disconnect_event_internal(peer_descriptor);
1222                                 Err(e)
1223                         }
1224                 }
1225         }
1226
1227         /// Append a message to a peer's pending outbound/write buffer
1228         fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1229                 if is_gossip_msg(message.type_id()) {
1230                         log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1231                 } else {
1232                         log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1233                 }
1234                 peer.msgs_sent_since_pong += 1;
1235                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1236         }
1237
1238         /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1239         fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: Vec<u8>) {
1240                 peer.msgs_sent_since_pong += 1;
1241                 peer.gossip_broadcast_buffer.push_back(encoded_message);
1242         }
1243
1244         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1245                 let mut pause_read = false;
1246                 let peers = self.peers.read().unwrap();
1247                 let mut msgs_to_forward = Vec::new();
1248                 let mut peer_node_id = None;
1249                 match peers.get(peer_descriptor) {
1250                         None => {
1251                                 // This is most likely a simple race condition where the user read some bytes
1252                                 // from the socket, then we told the user to `disconnect_socket()`, then they
1253                                 // called this method. Return an error to make sure we get disconnected.
1254                                 return Err(PeerHandleError { });
1255                         },
1256                         Some(peer_mutex) => {
1257                                 let mut read_pos = 0;
1258                                 while read_pos < data.len() {
1259                                         macro_rules! try_potential_handleerror {
1260                                                 ($peer: expr, $thing: expr) => {
1261                                                         match $thing {
1262                                                                 Ok(x) => x,
1263                                                                 Err(e) => {
1264                                                                         match e.action {
1265                                                                                 msgs::ErrorAction::DisconnectPeer { .. } => {
1266                                                                                         // We may have an `ErrorMessage` to send to the peer,
1267                                                                                         // but writing to the socket while reading can lead to
1268                                                                                         // re-entrant code and possibly unexpected behavior. The
1269                                                                                         // message send is optimistic anyway, and in this case
1270                                                                                         // we immediately disconnect the peer.
1271                                                                                         log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1272                                                                                         return Err(PeerHandleError { });
1273                                                                                 },
1274                                                                                 msgs::ErrorAction::DisconnectPeerWithWarning { .. } => {
1275                                                                                         // We have a `WarningMessage` to send to the peer, but
1276                                                                                         // writing to the socket while reading can lead to
1277                                                                                         // re-entrant code and possibly unexpected behavior. The
1278                                                                                         // message send is optimistic anyway, and in this case
1279                                                                                         // we immediately disconnect the peer.
1280                                                                                         log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1281                                                                                         return Err(PeerHandleError { });
1282                                                                                 },
1283                                                                                 msgs::ErrorAction::IgnoreAndLog(level) => {
1284                                                                                         log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1285                                                                                         continue
1286                                                                                 },
1287                                                                                 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1288                                                                                 msgs::ErrorAction::IgnoreError => {
1289                                                                                         log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1290                                                                                         continue;
1291                                                                                 },
1292                                                                                 msgs::ErrorAction::SendErrorMessage { msg } => {
1293                                                                                         log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1294                                                                                         self.enqueue_message($peer, &msg);
1295                                                                                         continue;
1296                                                                                 },
1297                                                                                 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1298                                                                                         log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1299                                                                                         self.enqueue_message($peer, &msg);
1300                                                                                         continue;
1301                                                                                 },
1302                                                                         }
1303                                                                 }
1304                                                         }
1305                                                 }
1306                                         }
1307
1308                                         let mut peer_lock = peer_mutex.lock().unwrap();
1309                                         let peer = &mut *peer_lock;
1310                                         let mut msg_to_handle = None;
1311                                         if peer_node_id.is_none() {
1312                                                 peer_node_id = peer.their_node_id.clone();
1313                                         }
1314
1315                                         assert!(peer.pending_read_buffer.len() > 0);
1316                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1317
1318                                         {
1319                                                 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1320                                                 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]);
1321                                                 read_pos += data_to_copy;
1322                                                 peer.pending_read_buffer_pos += data_to_copy;
1323                                         }
1324
1325                                         if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1326                                                 peer.pending_read_buffer_pos = 0;
1327
1328                                                 macro_rules! insert_node_id {
1329                                                         () => {
1330                                                                 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1331                                                                         hash_map::Entry::Occupied(e) => {
1332                                                                                 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1333                                                                                 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1334                                                                                 // Check that the peers map is consistent with the
1335                                                                                 // node_id_to_descriptor map, as this has been broken
1336                                                                                 // before.
1337                                                                                 debug_assert!(peers.get(e.get()).is_some());
1338                                                                                 return Err(PeerHandleError { })
1339                                                                         },
1340                                                                         hash_map::Entry::Vacant(entry) => {
1341                                                                                 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1342                                                                                 entry.insert(peer_descriptor.clone())
1343                                                                         },
1344                                                                 };
1345                                                         }
1346                                                 }
1347
1348                                                 let next_step = peer.channel_encryptor.get_noise_step();
1349                                                 match next_step {
1350                                                         NextNoiseStep::ActOne => {
1351                                                                 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1352                                                                         .process_act_one_with_keys(&peer.pending_read_buffer[..],
1353                                                                                 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1354                                                                 peer.pending_outbound_buffer.push_back(act_two);
1355                                                                 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1356                                                         },
1357                                                         NextNoiseStep::ActTwo => {
1358                                                                 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1359                                                                         peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1360                                                                                 &self.node_signer));
1361                                                                 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1362                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1363                                                                 peer.pending_read_is_header = true;
1364
1365                                                                 peer.set_their_node_id(their_node_id);
1366                                                                 insert_node_id!();
1367                                                                 let features = self.init_features(&their_node_id);
1368                                                                 let networks = self.message_handler.chan_handler.get_chain_hashes();
1369                                                                 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1370                                                                 self.enqueue_message(peer, &resp);
1371                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
1372                                                         },
1373                                                         NextNoiseStep::ActThree => {
1374                                                                 let their_node_id = try_potential_handleerror!(peer,
1375                                                                         peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1376                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1377                                                                 peer.pending_read_is_header = true;
1378                                                                 peer.set_their_node_id(their_node_id);
1379                                                                 insert_node_id!();
1380                                                                 let features = self.init_features(&their_node_id);
1381                                                                 let networks = self.message_handler.chan_handler.get_chain_hashes();
1382                                                                 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1383                                                                 self.enqueue_message(peer, &resp);
1384                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
1385                                                         },
1386                                                         NextNoiseStep::NoiseComplete => {
1387                                                                 if peer.pending_read_is_header {
1388                                                                         let msg_len = try_potential_handleerror!(peer,
1389                                                                                 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1390                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1391                                                                         peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1392                                                                         if msg_len < 2 { // Need at least the message type tag
1393                                                                                 return Err(PeerHandleError { });
1394                                                                         }
1395                                                                         peer.pending_read_is_header = false;
1396                                                                 } else {
1397                                                                         let msg_data = try_potential_handleerror!(peer,
1398                                                                                 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1399                                                                         assert!(msg_data.len() >= 2);
1400
1401                                                                         // Reset read buffer
1402                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1403                                                                         peer.pending_read_buffer.resize(18, 0);
1404                                                                         peer.pending_read_is_header = true;
1405
1406                                                                         let mut reader = io::Cursor::new(&msg_data[..]);
1407                                                                         let message_result = wire::read(&mut reader, &*self.message_handler.custom_message_handler);
1408                                                                         let message = match message_result {
1409                                                                                 Ok(x) => x,
1410                                                                                 Err(e) => {
1411                                                                                         match e {
1412                                                                                                 // Note that to avoid re-entrancy we never call
1413                                                                                                 // `do_attempt_write_data` from here, causing
1414                                                                                                 // the messages enqueued here to not actually
1415                                                                                                 // be sent before the peer is disconnected.
1416                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1417                                                                                                         log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1418                                                                                                         continue;
1419                                                                                                 }
1420                                                                                                 (msgs::DecodeError::UnsupportedCompression, _) => {
1421                                                                                                         log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1422                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: ChannelId::new_zero(), data: "Unsupported message compression: zlib".to_owned() });
1423                                                                                                         continue;
1424                                                                                                 }
1425                                                                                                 (_, Some(ty)) if is_gossip_msg(ty) => {
1426                                                                                                         log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1427                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage {
1428                                                                                                                 channel_id: ChannelId::new_zero(),
1429                                                                                                                 data: format!("Unreadable/bogus gossip message of type {}", ty),
1430                                                                                                         });
1431                                                                                                         continue;
1432                                                                                                 }
1433                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, _) => {
1434                                                                                                         log_debug!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1435                                                                                                         return Err(PeerHandleError { });
1436                                                                                                 }
1437                                                                                                 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1438                                                                                                 (msgs::DecodeError::InvalidValue, _) => {
1439                                                                                                         log_debug!(self.logger, "Got an invalid value while deserializing message");
1440                                                                                                         return Err(PeerHandleError { });
1441                                                                                                 }
1442                                                                                                 (msgs::DecodeError::ShortRead, _) => {
1443                                                                                                         log_debug!(self.logger, "Deserialization failed due to shortness of message");
1444                                                                                                         return Err(PeerHandleError { });
1445                                                                                                 }
1446                                                                                                 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1447                                                                                                 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1448                                                                                         }
1449                                                                                 }
1450                                                                         };
1451
1452                                                                         msg_to_handle = Some(message);
1453                                                                 }
1454                                                         }
1455                                                 }
1456                                         }
1457                                         pause_read = !self.peer_should_read(peer);
1458
1459                                         if let Some(message) = msg_to_handle {
1460                                                 match self.handle_message(&peer_mutex, peer_lock, message) {
1461                                                         Err(handling_error) => match handling_error {
1462                                                                 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1463                                                                 MessageHandlingError::LightningError(e) => {
1464                                                                         try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1465                                                                 },
1466                                                         },
1467                                                         Ok(Some(msg)) => {
1468                                                                 msgs_to_forward.push(msg);
1469                                                         },
1470                                                         Ok(None) => {},
1471                                                 }
1472                                         }
1473                                 }
1474                         }
1475                 }
1476
1477                 for msg in msgs_to_forward.drain(..) {
1478                         self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1479                 }
1480
1481                 Ok(pause_read)
1482         }
1483
1484         /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1485         /// Returns the message back if it needs to be broadcasted to all other peers.
1486         fn handle_message(
1487                 &self,
1488                 peer_mutex: &Mutex<Peer>,
1489                 mut peer_lock: MutexGuard<Peer>,
1490                 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1491         ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1492                 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages").0;
1493                 peer_lock.received_message_since_timer_tick = true;
1494
1495                 // Need an Init as first message
1496                 if let wire::Message::Init(msg) = message {
1497                         // Check if we have any compatible chains if the `networks` field is specified.
1498                         if let Some(networks) = &msg.networks {
1499                                 if let Some(our_chains) = self.message_handler.chan_handler.get_chain_hashes() {
1500                                         let mut have_compatible_chains = false;
1501                                         'our_chains: for our_chain in our_chains.iter() {
1502                                                 for their_chain in networks {
1503                                                         if our_chain == their_chain {
1504                                                                 have_compatible_chains = true;
1505                                                                 break 'our_chains;
1506                                                         }
1507                                                 }
1508                                         }
1509                                         if !have_compatible_chains {
1510                                                 log_debug!(self.logger, "Peer does not support any of our supported chains");
1511                                                 return Err(PeerHandleError { }.into());
1512                                         }
1513                                 }
1514                         }
1515
1516                         let our_features = self.init_features(&their_node_id);
1517                         if msg.features.requires_unknown_bits_from(&our_features) {
1518                                 log_debug!(self.logger, "Peer requires features unknown to us");
1519                                 return Err(PeerHandleError { }.into());
1520                         }
1521
1522                         if our_features.requires_unknown_bits_from(&msg.features) {
1523                                 log_debug!(self.logger, "We require features unknown to our peer");
1524                                 return Err(PeerHandleError { }.into());
1525                         }
1526
1527                         if peer_lock.their_features.is_some() {
1528                                 return Err(PeerHandleError { }.into());
1529                         }
1530
1531                         log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1532
1533                         // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1534                         if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1535                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1536                         }
1537
1538                         if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1539                                 log_debug!(self.logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1540                                 return Err(PeerHandleError { }.into());
1541                         }
1542                         if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1543                                 log_debug!(self.logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1544                                 return Err(PeerHandleError { }.into());
1545                         }
1546                         if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1547                                 log_debug!(self.logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1548                                 return Err(PeerHandleError { }.into());
1549                         }
1550
1551                         peer_lock.their_features = Some(msg.features);
1552                         return Ok(None);
1553                 } else if peer_lock.their_features.is_none() {
1554                         log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1555                         return Err(PeerHandleError { }.into());
1556                 }
1557
1558                 if let wire::Message::GossipTimestampFilter(_msg) = message {
1559                         // When supporting gossip messages, start inital gossip sync only after we receive
1560                         // a GossipTimestampFilter
1561                         if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1562                                 !peer_lock.sent_gossip_timestamp_filter {
1563                                 peer_lock.sent_gossip_timestamp_filter = true;
1564                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1565                         }
1566                         return Ok(None);
1567                 }
1568
1569                 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1570                         peer_lock.received_channel_announce_since_backlogged = true;
1571                 }
1572
1573                 mem::drop(peer_lock);
1574
1575                 if is_gossip_msg(message.type_id()) {
1576                         log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1577                 } else {
1578                         log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1579                 }
1580
1581                 let mut should_forward = None;
1582
1583                 match message {
1584                         // Setup and Control messages:
1585                         wire::Message::Init(_) => {
1586                                 // Handled above
1587                         },
1588                         wire::Message::GossipTimestampFilter(_) => {
1589                                 // Handled above
1590                         },
1591                         wire::Message::Error(msg) => {
1592                                 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1593                                 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1594                                 if msg.channel_id.is_zero() {
1595                                         return Err(PeerHandleError { }.into());
1596                                 }
1597                         },
1598                         wire::Message::Warning(msg) => {
1599                                 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1600                         },
1601
1602                         wire::Message::Ping(msg) => {
1603                                 if msg.ponglen < 65532 {
1604                                         let resp = msgs::Pong { byteslen: msg.ponglen };
1605                                         self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1606                                 }
1607                         },
1608                         wire::Message::Pong(_msg) => {
1609                                 let mut peer_lock = peer_mutex.lock().unwrap();
1610                                 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1611                                 peer_lock.msgs_sent_since_pong = 0;
1612                         },
1613
1614                         // Channel messages:
1615                         wire::Message::OpenChannel(msg) => {
1616                                 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1617                         },
1618                         wire::Message::OpenChannelV2(msg) => {
1619                                 self.message_handler.chan_handler.handle_open_channel_v2(&their_node_id, &msg);
1620                         },
1621                         wire::Message::AcceptChannel(msg) => {
1622                                 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1623                         },
1624                         wire::Message::AcceptChannelV2(msg) => {
1625                                 self.message_handler.chan_handler.handle_accept_channel_v2(&their_node_id, &msg);
1626                         },
1627
1628                         wire::Message::FundingCreated(msg) => {
1629                                 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1630                         },
1631                         wire::Message::FundingSigned(msg) => {
1632                                 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1633                         },
1634                         wire::Message::ChannelReady(msg) => {
1635                                 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1636                         },
1637
1638                         // Interactive transaction construction messages:
1639                         wire::Message::TxAddInput(msg) => {
1640                                 self.message_handler.chan_handler.handle_tx_add_input(&their_node_id, &msg);
1641                         },
1642                         wire::Message::TxAddOutput(msg) => {
1643                                 self.message_handler.chan_handler.handle_tx_add_output(&their_node_id, &msg);
1644                         },
1645                         wire::Message::TxRemoveInput(msg) => {
1646                                 self.message_handler.chan_handler.handle_tx_remove_input(&their_node_id, &msg);
1647                         },
1648                         wire::Message::TxRemoveOutput(msg) => {
1649                                 self.message_handler.chan_handler.handle_tx_remove_output(&their_node_id, &msg);
1650                         },
1651                         wire::Message::TxComplete(msg) => {
1652                                 self.message_handler.chan_handler.handle_tx_complete(&their_node_id, &msg);
1653                         },
1654                         wire::Message::TxSignatures(msg) => {
1655                                 self.message_handler.chan_handler.handle_tx_signatures(&their_node_id, &msg);
1656                         },
1657                         wire::Message::TxInitRbf(msg) => {
1658                                 self.message_handler.chan_handler.handle_tx_init_rbf(&their_node_id, &msg);
1659                         },
1660                         wire::Message::TxAckRbf(msg) => {
1661                                 self.message_handler.chan_handler.handle_tx_ack_rbf(&their_node_id, &msg);
1662                         },
1663                         wire::Message::TxAbort(msg) => {
1664                                 self.message_handler.chan_handler.handle_tx_abort(&their_node_id, &msg);
1665                         }
1666
1667                         wire::Message::Shutdown(msg) => {
1668                                 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1669                         },
1670                         wire::Message::ClosingSigned(msg) => {
1671                                 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1672                         },
1673
1674                         // Commitment messages:
1675                         wire::Message::UpdateAddHTLC(msg) => {
1676                                 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1677                         },
1678                         wire::Message::UpdateFulfillHTLC(msg) => {
1679                                 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1680                         },
1681                         wire::Message::UpdateFailHTLC(msg) => {
1682                                 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1683                         },
1684                         wire::Message::UpdateFailMalformedHTLC(msg) => {
1685                                 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1686                         },
1687
1688                         wire::Message::CommitmentSigned(msg) => {
1689                                 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1690                         },
1691                         wire::Message::RevokeAndACK(msg) => {
1692                                 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1693                         },
1694                         wire::Message::UpdateFee(msg) => {
1695                                 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1696                         },
1697                         wire::Message::ChannelReestablish(msg) => {
1698                                 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1699                         },
1700
1701                         // Routing messages:
1702                         wire::Message::AnnouncementSignatures(msg) => {
1703                                 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1704                         },
1705                         wire::Message::ChannelAnnouncement(msg) => {
1706                                 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1707                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1708                                         should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1709                                 }
1710                                 self.update_gossip_backlogged();
1711                         },
1712                         wire::Message::NodeAnnouncement(msg) => {
1713                                 if self.message_handler.route_handler.handle_node_announcement(&msg)
1714                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1715                                         should_forward = Some(wire::Message::NodeAnnouncement(msg));
1716                                 }
1717                                 self.update_gossip_backlogged();
1718                         },
1719                         wire::Message::ChannelUpdate(msg) => {
1720                                 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1721                                 if self.message_handler.route_handler.handle_channel_update(&msg)
1722                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1723                                         should_forward = Some(wire::Message::ChannelUpdate(msg));
1724                                 }
1725                                 self.update_gossip_backlogged();
1726                         },
1727                         wire::Message::QueryShortChannelIds(msg) => {
1728                                 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1729                         },
1730                         wire::Message::ReplyShortChannelIdsEnd(msg) => {
1731                                 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1732                         },
1733                         wire::Message::QueryChannelRange(msg) => {
1734                                 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1735                         },
1736                         wire::Message::ReplyChannelRange(msg) => {
1737                                 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1738                         },
1739
1740                         // Onion message:
1741                         wire::Message::OnionMessage(msg) => {
1742                                 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1743                         },
1744
1745                         // Unknown messages:
1746                         wire::Message::Unknown(type_id) if message.is_even() => {
1747                                 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1748                                 return Err(PeerHandleError { }.into());
1749                         },
1750                         wire::Message::Unknown(type_id) => {
1751                                 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1752                         },
1753                         wire::Message::Custom(custom) => {
1754                                 self.message_handler.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1755                         },
1756                 };
1757                 Ok(should_forward)
1758         }
1759
1760         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>) {
1761                 match msg {
1762                         wire::Message::ChannelAnnouncement(ref msg) => {
1763                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1764                                 let encoded_msg = encode_msg!(msg);
1765
1766                                 for (_, peer_mutex) in peers.iter() {
1767                                         let mut peer = peer_mutex.lock().unwrap();
1768                                         if !peer.handshake_complete() ||
1769                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1770                                                 continue
1771                                         }
1772                                         debug_assert!(peer.their_node_id.is_some());
1773                                         debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1774                                         if peer.buffer_full_drop_gossip_broadcast() {
1775                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1776                                                 continue;
1777                                         }
1778                                         if let Some((_, their_node_id)) = peer.their_node_id {
1779                                                 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1780                                                         continue;
1781                                                 }
1782                                         }
1783                                         if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1784                                                 continue;
1785                                         }
1786                                         self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1787                                 }
1788                         },
1789                         wire::Message::NodeAnnouncement(ref msg) => {
1790                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1791                                 let encoded_msg = encode_msg!(msg);
1792
1793                                 for (_, peer_mutex) in peers.iter() {
1794                                         let mut peer = peer_mutex.lock().unwrap();
1795                                         if !peer.handshake_complete() ||
1796                                                         !peer.should_forward_node_announcement(msg.contents.node_id) {
1797                                                 continue
1798                                         }
1799                                         debug_assert!(peer.their_node_id.is_some());
1800                                         debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1801                                         if peer.buffer_full_drop_gossip_broadcast() {
1802                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1803                                                 continue;
1804                                         }
1805                                         if let Some((_, their_node_id)) = peer.their_node_id {
1806                                                 if their_node_id == msg.contents.node_id {
1807                                                         continue;
1808                                                 }
1809                                         }
1810                                         if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1811                                                 continue;
1812                                         }
1813                                         self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1814                                 }
1815                         },
1816                         wire::Message::ChannelUpdate(ref msg) => {
1817                                 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1818                                 let encoded_msg = encode_msg!(msg);
1819
1820                                 for (_, peer_mutex) in peers.iter() {
1821                                         let mut peer = peer_mutex.lock().unwrap();
1822                                         if !peer.handshake_complete() ||
1823                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id)  {
1824                                                 continue
1825                                         }
1826                                         debug_assert!(peer.their_node_id.is_some());
1827                                         debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1828                                         if peer.buffer_full_drop_gossip_broadcast() {
1829                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1830                                                 continue;
1831                                         }
1832                                         if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1833                                                 continue;
1834                                         }
1835                                         self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1836                                 }
1837                         },
1838                         _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1839                 }
1840         }
1841
1842         /// Checks for any events generated by our handlers and processes them. Includes sending most
1843         /// response messages as well as messages generated by calls to handler functions directly (eg
1844         /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1845         ///
1846         /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1847         /// issues!
1848         ///
1849         /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1850         /// or one of the other clients provided in our language bindings.
1851         ///
1852         /// Note that if there are any other calls to this function waiting on lock(s) this may return
1853         /// without doing any work. All available events that need handling will be handled before the
1854         /// other calls return.
1855         ///
1856         /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1857         /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1858         /// [`send_data`]: SocketDescriptor::send_data
1859         pub fn process_events(&self) {
1860                 if self.event_processing_state.fetch_add(1, Ordering::AcqRel) > 0 {
1861                         // If we're not the first event processor to get here, just return early, the increment
1862                         // we just did will be treated as "go around again" at the end.
1863                         return;
1864                 }
1865
1866                 loop {
1867                         self.update_gossip_backlogged();
1868                         let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1869
1870                         let mut peers_to_disconnect = HashMap::new();
1871
1872                         {
1873                                 let peers_lock = self.peers.read().unwrap();
1874
1875                                 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1876                                 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1877
1878                                 let peers = &*peers_lock;
1879                                 macro_rules! get_peer_for_forwarding {
1880                                         ($node_id: expr) => {
1881                                                 {
1882                                                         if peers_to_disconnect.get($node_id).is_some() {
1883                                                                 // If we've "disconnected" this peer, do not send to it.
1884                                                                 continue;
1885                                                         }
1886                                                         let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1887                                                         match descriptor_opt {
1888                                                                 Some(descriptor) => match peers.get(&descriptor) {
1889                                                                         Some(peer_mutex) => {
1890                                                                                 let peer_lock = peer_mutex.lock().unwrap();
1891                                                                                 if !peer_lock.handshake_complete() {
1892                                                                                         continue;
1893                                                                                 }
1894                                                                                 peer_lock
1895                                                                         },
1896                                                                         None => {
1897                                                                                 debug_assert!(false, "Inconsistent peers set state!");
1898                                                                                 continue;
1899                                                                         }
1900                                                                 },
1901                                                                 None => {
1902                                                                         continue;
1903                                                                 },
1904                                                         }
1905                                                 }
1906                                         }
1907                                 }
1908                                 for event in events_generated.drain(..) {
1909                                         match event {
1910                                                 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1911                                                         log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1912                                                                         log_pubkey!(node_id),
1913                                                                         &msg.temporary_channel_id);
1914                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1915                                                 },
1916                                                 MessageSendEvent::SendAcceptChannelV2 { ref node_id, ref msg } => {
1917                                                         log_debug!(self.logger, "Handling SendAcceptChannelV2 event in peer_handler for node {} for channel {}",
1918                                                                         log_pubkey!(node_id),
1919                                                                         &msg.temporary_channel_id);
1920                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1921                                                 },
1922                                                 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1923                                                         log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1924                                                                         log_pubkey!(node_id),
1925                                                                         &msg.temporary_channel_id);
1926                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1927                                                 },
1928                                                 MessageSendEvent::SendOpenChannelV2 { ref node_id, ref msg } => {
1929                                                         log_debug!(self.logger, "Handling SendOpenChannelV2 event in peer_handler for node {} for channel {}",
1930                                                                         log_pubkey!(node_id),
1931                                                                         &msg.temporary_channel_id);
1932                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1933                                                 },
1934                                                 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1935                                                         log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1936                                                                         log_pubkey!(node_id),
1937                                                                         &msg.temporary_channel_id,
1938                                                                         log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1939                                                         // TODO: If the peer is gone we should generate a DiscardFunding event
1940                                                         // indicating to the wallet that they should just throw away this funding transaction
1941                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1942                                                 },
1943                                                 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1944                                                         log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1945                                                                         log_pubkey!(node_id),
1946                                                                         &msg.channel_id);
1947                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1948                                                 },
1949                                                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1950                                                         log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1951                                                                         log_pubkey!(node_id),
1952                                                                         &msg.channel_id);
1953                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1954                                                 },
1955                                                 MessageSendEvent::SendTxAddInput { ref node_id, ref msg } => {
1956                                                         log_debug!(self.logger, "Handling SendTxAddInput event in peer_handler for node {} for channel {}",
1957                                                                         log_pubkey!(node_id),
1958                                                                         &msg.channel_id);
1959                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1960                                                 },
1961                                                 MessageSendEvent::SendTxAddOutput { ref node_id, ref msg } => {
1962                                                         log_debug!(self.logger, "Handling SendTxAddOutput event in peer_handler for node {} for channel {}",
1963                                                                         log_pubkey!(node_id),
1964                                                                         &msg.channel_id);
1965                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1966                                                 },
1967                                                 MessageSendEvent::SendTxRemoveInput { ref node_id, ref msg } => {
1968                                                         log_debug!(self.logger, "Handling SendTxRemoveInput event in peer_handler for node {} for channel {}",
1969                                                                         log_pubkey!(node_id),
1970                                                                         &msg.channel_id);
1971                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1972                                                 },
1973                                                 MessageSendEvent::SendTxRemoveOutput { ref node_id, ref msg } => {
1974                                                         log_debug!(self.logger, "Handling SendTxRemoveOutput event in peer_handler for node {} for channel {}",
1975                                                                         log_pubkey!(node_id),
1976                                                                         &msg.channel_id);
1977                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1978                                                 },
1979                                                 MessageSendEvent::SendTxComplete { ref node_id, ref msg } => {
1980                                                         log_debug!(self.logger, "Handling SendTxComplete event in peer_handler for node {} for channel {}",
1981                                                                         log_pubkey!(node_id),
1982                                                                         &msg.channel_id);
1983                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1984                                                 },
1985                                                 MessageSendEvent::SendTxSignatures { ref node_id, ref msg } => {
1986                                                         log_debug!(self.logger, "Handling SendTxSignatures event in peer_handler for node {} for channel {}",
1987                                                                         log_pubkey!(node_id),
1988                                                                         &msg.channel_id);
1989                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1990                                                 },
1991                                                 MessageSendEvent::SendTxInitRbf { ref node_id, ref msg } => {
1992                                                         log_debug!(self.logger, "Handling SendTxInitRbf event in peer_handler for node {} for channel {}",
1993                                                                         log_pubkey!(node_id),
1994                                                                         &msg.channel_id);
1995                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1996                                                 },
1997                                                 MessageSendEvent::SendTxAckRbf { ref node_id, ref msg } => {
1998                                                         log_debug!(self.logger, "Handling SendTxAckRbf event in peer_handler for node {} for channel {}",
1999                                                                         log_pubkey!(node_id),
2000                                                                         &msg.channel_id);
2001                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2002                                                 },
2003                                                 MessageSendEvent::SendTxAbort { ref node_id, ref msg } => {
2004                                                         log_debug!(self.logger, "Handling SendTxAbort event in peer_handler for node {} for channel {}",
2005                                                                         log_pubkey!(node_id),
2006                                                                         &msg.channel_id);
2007                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2008                                                 },
2009                                                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
2010                                                         log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
2011                                                                         log_pubkey!(node_id),
2012                                                                         &msg.channel_id);
2013                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2014                                                 },
2015                                                 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 } } => {
2016                                                         log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
2017                                                                         log_pubkey!(node_id),
2018                                                                         update_add_htlcs.len(),
2019                                                                         update_fulfill_htlcs.len(),
2020                                                                         update_fail_htlcs.len(),
2021                                                                         &commitment_signed.channel_id);
2022                                                         let mut peer = get_peer_for_forwarding!(node_id);
2023                                                         for msg in update_add_htlcs {
2024                                                                 self.enqueue_message(&mut *peer, msg);
2025                                                         }
2026                                                         for msg in update_fulfill_htlcs {
2027                                                                 self.enqueue_message(&mut *peer, msg);
2028                                                         }
2029                                                         for msg in update_fail_htlcs {
2030                                                                 self.enqueue_message(&mut *peer, msg);
2031                                                         }
2032                                                         for msg in update_fail_malformed_htlcs {
2033                                                                 self.enqueue_message(&mut *peer, msg);
2034                                                         }
2035                                                         if let &Some(ref msg) = update_fee {
2036                                                                 self.enqueue_message(&mut *peer, msg);
2037                                                         }
2038                                                         self.enqueue_message(&mut *peer, commitment_signed);
2039                                                 },
2040                                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2041                                                         log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
2042                                                                         log_pubkey!(node_id),
2043                                                                         &msg.channel_id);
2044                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2045                                                 },
2046                                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
2047                                                         log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
2048                                                                         log_pubkey!(node_id),
2049                                                                         &msg.channel_id);
2050                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2051                                                 },
2052                                                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
2053                                                         log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
2054                                                                         log_pubkey!(node_id),
2055                                                                         &msg.channel_id);
2056                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2057                                                 },
2058                                                 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
2059                                                         log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
2060                                                                         log_pubkey!(node_id),
2061                                                                         &msg.channel_id);
2062                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2063                                                 },
2064                                                 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
2065                                                         log_debug!(self.logger, "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
2066                                                                         log_pubkey!(node_id),
2067                                                                         msg.contents.short_channel_id);
2068                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2069                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
2070                                                 },
2071                                                 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
2072                                                         log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
2073                                                         match self.message_handler.route_handler.handle_channel_announcement(&msg) {
2074                                                                 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2075                                                                         self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
2076                                                                 _ => {},
2077                                                         }
2078                                                         if let Some(msg) = update_msg {
2079                                                                 match self.message_handler.route_handler.handle_channel_update(&msg) {
2080                                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2081                                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2082                                                                         _ => {},
2083                                                                 }
2084                                                         }
2085                                                 },
2086                                                 MessageSendEvent::BroadcastChannelUpdate { msg } => {
2087                                                         log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for contents {:?}", msg.contents);
2088                                                         match self.message_handler.route_handler.handle_channel_update(&msg) {
2089                                                                 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2090                                                                         self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2091                                                                 _ => {},
2092                                                         }
2093                                                 },
2094                                                 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
2095                                                         log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
2096                                                         match self.message_handler.route_handler.handle_node_announcement(&msg) {
2097                                                                 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2098                                                                         self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
2099                                                                 _ => {},
2100                                                         }
2101                                                 },
2102                                                 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
2103                                                         log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
2104                                                                         log_pubkey!(node_id), msg.contents.short_channel_id);
2105                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2106                                                 },
2107                                                 MessageSendEvent::HandleError { node_id, action } => {
2108                                                         match action {
2109                                                                 msgs::ErrorAction::DisconnectPeer { msg } => {
2110                                                                         if let Some(msg) = msg.as_ref() {
2111                                                                                 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2112                                                                                         log_pubkey!(node_id), msg.data);
2113                                                                         } else {
2114                                                                                 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {}",
2115                                                                                         log_pubkey!(node_id));
2116                                                                         }
2117                                                                         // We do not have the peers write lock, so we just store that we're
2118                                                                         // about to disconenct the peer and do it after we finish
2119                                                                         // processing most messages.
2120                                                                         let msg = msg.map(|msg| wire::Message::<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>::Error(msg));
2121                                                                         peers_to_disconnect.insert(node_id, msg);
2122                                                                 },
2123                                                                 msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
2124                                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2125                                                                                 log_pubkey!(node_id), msg.data);
2126                                                                         // We do not have the peers write lock, so we just store that we're
2127                                                                         // about to disconenct the peer and do it after we finish
2128                                                                         // processing most messages.
2129                                                                         peers_to_disconnect.insert(node_id, Some(wire::Message::Warning(msg)));
2130                                                                 },
2131                                                                 msgs::ErrorAction::IgnoreAndLog(level) => {
2132                                                                         log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2133                                                                 },
2134                                                                 msgs::ErrorAction::IgnoreDuplicateGossip => {},
2135                                                                 msgs::ErrorAction::IgnoreError => {
2136                                                                                 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2137                                                                         },
2138                                                                 msgs::ErrorAction::SendErrorMessage { ref msg } => {
2139                                                                         log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
2140                                                                                         log_pubkey!(node_id),
2141                                                                                         msg.data);
2142                                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2143                                                                 },
2144                                                                 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
2145                                                                         log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
2146                                                                                         log_pubkey!(node_id),
2147                                                                                         msg.data);
2148                                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2149                                                                 },
2150                                                         }
2151                                                 },
2152                                                 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
2153                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2154                                                 },
2155                                                 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
2156                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2157                                                 }
2158                                                 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
2159                                                         log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
2160                                                                 log_pubkey!(node_id),
2161                                                                 msg.short_channel_ids.len(),
2162                                                                 msg.first_blocknum,
2163                                                                 msg.number_of_blocks,
2164                                                                 msg.sync_complete);
2165                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2166                                                 }
2167                                                 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
2168                                                         self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2169                                                 }
2170                                         }
2171                                 }
2172
2173                                 for (node_id, msg) in self.message_handler.custom_message_handler.get_and_clear_pending_msg() {
2174                                         if peers_to_disconnect.get(&node_id).is_some() { continue; }
2175                                         self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
2176                                 }
2177
2178                                 for (descriptor, peer_mutex) in peers.iter() {
2179                                         let mut peer = peer_mutex.lock().unwrap();
2180                                         if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2181                                         self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
2182                                 }
2183                         }
2184                         if !peers_to_disconnect.is_empty() {
2185                                 let mut peers_lock = self.peers.write().unwrap();
2186                                 let peers = &mut *peers_lock;
2187                                 for (node_id, msg) in peers_to_disconnect.drain() {
2188                                         // Note that since we are holding the peers *write* lock we can
2189                                         // remove from node_id_to_descriptor immediately (as no other
2190                                         // thread can be holding the peer lock if we have the global write
2191                                         // lock).
2192
2193                                         let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2194                                         if let Some(mut descriptor) = descriptor_opt {
2195                                                 if let Some(peer_mutex) = peers.remove(&descriptor) {
2196                                                         let mut peer = peer_mutex.lock().unwrap();
2197                                                         if let Some(msg) = msg {
2198                                                                 self.enqueue_message(&mut *peer, &msg);
2199                                                                 // This isn't guaranteed to work, but if there is enough free
2200                                                                 // room in the send buffer, put the error message there...
2201                                                                 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
2202                                                         }
2203                                                         self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
2204                                                 } else { debug_assert!(false, "Missing connection for peer"); }
2205                                         }
2206                                 }
2207                         }
2208
2209                         if self.event_processing_state.fetch_sub(1, Ordering::AcqRel) != 1 {
2210                                 // If another thread incremented the state while we were running we should go
2211                                 // around again, but only once.
2212                                 self.event_processing_state.store(1, Ordering::Release);
2213                                 continue;
2214                         }
2215                         break;
2216                 }
2217         }
2218
2219         /// Indicates that the given socket descriptor's connection is now closed.
2220         pub fn socket_disconnected(&self, descriptor: &Descriptor) {
2221                 self.disconnect_event_internal(descriptor);
2222         }
2223
2224         fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
2225                 if !peer.handshake_complete() {
2226                         log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
2227                         descriptor.disconnect_socket();
2228                         return;
2229                 }
2230
2231                 debug_assert!(peer.their_node_id.is_some());
2232                 if let Some((node_id, _)) = peer.their_node_id {
2233                         log_trace!(self.logger, "Disconnecting peer with id {} due to {}", node_id, reason);
2234                         self.message_handler.chan_handler.peer_disconnected(&node_id);
2235                         self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2236                 }
2237                 descriptor.disconnect_socket();
2238         }
2239
2240         fn disconnect_event_internal(&self, descriptor: &Descriptor) {
2241                 let mut peers = self.peers.write().unwrap();
2242                 let peer_option = peers.remove(descriptor);
2243                 match peer_option {
2244                         None => {
2245                                 // This is most likely a simple race condition where the user found that the socket
2246                                 // was disconnected, then we told the user to `disconnect_socket()`, then they
2247                                 // called this method. Either way we're disconnected, return.
2248                         },
2249                         Some(peer_lock) => {
2250                                 let peer = peer_lock.lock().unwrap();
2251                                 if let Some((node_id, _)) = peer.their_node_id {
2252                                         log_trace!(self.logger, "Handling disconnection of peer {}", log_pubkey!(node_id));
2253                                         let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2254                                         debug_assert!(removed.is_some(), "descriptor maps should be consistent");
2255                                         if !peer.handshake_complete() { return; }
2256                                         self.message_handler.chan_handler.peer_disconnected(&node_id);
2257                                         self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2258                                 }
2259                         }
2260                 };
2261         }
2262
2263         /// Disconnect a peer given its node id.
2264         ///
2265         /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
2266         /// peer. Thus, be very careful about reentrancy issues.
2267         ///
2268         /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
2269         pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
2270                 let mut peers_lock = self.peers.write().unwrap();
2271                 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
2272                         let peer_opt = peers_lock.remove(&descriptor);
2273                         if let Some(peer_mutex) = peer_opt {
2274                                 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
2275                         } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
2276                 }
2277         }
2278
2279         /// Disconnects all currently-connected peers. This is useful on platforms where there may be
2280         /// an indication that TCP sockets have stalled even if we weren't around to time them out
2281         /// using regular ping/pongs.
2282         pub fn disconnect_all_peers(&self) {
2283                 let mut peers_lock = self.peers.write().unwrap();
2284                 self.node_id_to_descriptor.lock().unwrap().clear();
2285                 let peers = &mut *peers_lock;
2286                 for (descriptor, peer_mutex) in peers.drain() {
2287                         self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2288                 }
2289         }
2290
2291         /// This is called when we're blocked on sending additional gossip messages until we receive a
2292         /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2293         /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2294         fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2295                 if peer.awaiting_pong_timer_tick_intervals == 0 {
2296                         peer.awaiting_pong_timer_tick_intervals = -1;
2297                         let ping = msgs::Ping {
2298                                 ponglen: 0,
2299                                 byteslen: 64,
2300                         };
2301                         self.enqueue_message(peer, &ping);
2302                 }
2303         }
2304
2305         /// Send pings to each peer and disconnect those which did not respond to the last round of
2306         /// pings.
2307         ///
2308         /// This may be called on any timescale you want, however, roughly once every ten seconds is
2309         /// preferred. The call rate determines both how often we send a ping to our peers and how much
2310         /// time they have to respond before we disconnect them.
2311         ///
2312         /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2313         /// issues!
2314         ///
2315         /// [`send_data`]: SocketDescriptor::send_data
2316         pub fn timer_tick_occurred(&self) {
2317                 let mut descriptors_needing_disconnect = Vec::new();
2318                 {
2319                         let peers_lock = self.peers.read().unwrap();
2320
2321                         self.update_gossip_backlogged();
2322                         let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2323
2324                         for (descriptor, peer_mutex) in peers_lock.iter() {
2325                                 let mut peer = peer_mutex.lock().unwrap();
2326                                 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2327
2328                                 if !peer.handshake_complete() {
2329                                         // The peer needs to complete its handshake before we can exchange messages. We
2330                                         // give peers one timer tick to complete handshake, reusing
2331                                         // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2332                                         // for handshake completion.
2333                                         if peer.awaiting_pong_timer_tick_intervals != 0 {
2334                                                 descriptors_needing_disconnect.push(descriptor.clone());
2335                                         } else {
2336                                                 peer.awaiting_pong_timer_tick_intervals = 1;
2337                                         }
2338                                         continue;
2339                                 }
2340                                 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2341                                 debug_assert!(peer.their_node_id.is_some());
2342
2343                                 loop { // Used as a `goto` to skip writing a Ping message.
2344                                         if peer.awaiting_pong_timer_tick_intervals == -1 {
2345                                                 // Magic value set in `maybe_send_extra_ping`.
2346                                                 peer.awaiting_pong_timer_tick_intervals = 1;
2347                                                 peer.received_message_since_timer_tick = false;
2348                                                 break;
2349                                         }
2350
2351                                         if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2352                                                 || peer.awaiting_pong_timer_tick_intervals as u64 >
2353                                                         MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2354                                         {
2355                                                 descriptors_needing_disconnect.push(descriptor.clone());
2356                                                 break;
2357                                         }
2358                                         peer.received_message_since_timer_tick = false;
2359
2360                                         if peer.awaiting_pong_timer_tick_intervals > 0 {
2361                                                 peer.awaiting_pong_timer_tick_intervals += 1;
2362                                                 break;
2363                                         }
2364
2365                                         peer.awaiting_pong_timer_tick_intervals = 1;
2366                                         let ping = msgs::Ping {
2367                                                 ponglen: 0,
2368                                                 byteslen: 64,
2369                                         };
2370                                         self.enqueue_message(&mut *peer, &ping);
2371                                         break;
2372                                 }
2373                                 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2374                         }
2375                 }
2376
2377                 if !descriptors_needing_disconnect.is_empty() {
2378                         {
2379                                 let mut peers_lock = self.peers.write().unwrap();
2380                                 for descriptor in descriptors_needing_disconnect {
2381                                         if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2382                                                 let peer = peer_mutex.lock().unwrap();
2383                                                 if let Some((node_id, _)) = peer.their_node_id {
2384                                                         self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2385                                                 }
2386                                                 self.do_disconnect(descriptor, &*peer, "ping/handshake timeout");
2387                                         }
2388                                 }
2389                         }
2390                 }
2391         }
2392
2393         #[allow(dead_code)]
2394         // Messages of up to 64KB should never end up more than half full with addresses, as that would
2395         // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2396         // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2397         // message...
2398         const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (SocketAddress::MAX_LEN as u32 + 1) / 2;
2399         #[deny(const_err)]
2400         #[allow(dead_code)]
2401         // ...by failing to compile if the number of addresses that would be half of a message is
2402         // smaller than 100:
2403         const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2404
2405         /// Generates a signed node_announcement from the given arguments, sending it to all connected
2406         /// peers. Note that peers will likely ignore this message unless we have at least one public
2407         /// channel which has at least six confirmations on-chain.
2408         ///
2409         /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2410         /// node to humans. They carry no in-protocol meaning.
2411         ///
2412         /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2413         /// accepts incoming connections. These will be included in the node_announcement, publicly
2414         /// tying these addresses together and to this node. If you wish to preserve user privacy,
2415         /// addresses should likely contain only Tor Onion addresses.
2416         ///
2417         /// Panics if `addresses` is absurdly large (more than 100).
2418         ///
2419         /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2420         pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<SocketAddress>) {
2421                 if addresses.len() > 100 {
2422                         panic!("More than half the message size was taken up by public addresses!");
2423                 }
2424
2425                 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2426                 // addresses be sorted for future compatibility.
2427                 addresses.sort_by_key(|addr| addr.get_id());
2428
2429                 let features = self.message_handler.chan_handler.provided_node_features()
2430                         | self.message_handler.route_handler.provided_node_features()
2431                         | self.message_handler.onion_message_handler.provided_node_features()
2432                         | self.message_handler.custom_message_handler.provided_node_features();
2433                 let announcement = msgs::UnsignedNodeAnnouncement {
2434                         features,
2435                         timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2436                         node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2437                         rgb,
2438                         alias: NodeAlias(alias),
2439                         addresses,
2440                         excess_address_data: Vec::new(),
2441                         excess_data: Vec::new(),
2442                 };
2443                 let node_announce_sig = match self.node_signer.sign_gossip_message(
2444                         msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2445                 ) {
2446                         Ok(sig) => sig,
2447                         Err(_) => {
2448                                 log_error!(self.logger, "Failed to generate signature for node_announcement");
2449                                 return;
2450                         },
2451                 };
2452
2453                 let msg = msgs::NodeAnnouncement {
2454                         signature: node_announce_sig,
2455                         contents: announcement
2456                 };
2457
2458                 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2459                 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2460                 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2461         }
2462 }
2463
2464 fn is_gossip_msg(type_id: u16) -> bool {
2465         match type_id {
2466                 msgs::ChannelAnnouncement::TYPE |
2467                 msgs::ChannelUpdate::TYPE |
2468                 msgs::NodeAnnouncement::TYPE |
2469                 msgs::QueryChannelRange::TYPE |
2470                 msgs::ReplyChannelRange::TYPE |
2471                 msgs::QueryShortChannelIds::TYPE |
2472                 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2473                 _ => false
2474         }
2475 }
2476
2477 #[cfg(test)]
2478 mod tests {
2479         use crate::sign::{NodeSigner, Recipient};
2480         use crate::events;
2481         use crate::io;
2482         use crate::ln::ChannelId;
2483         use crate::ln::features::{InitFeatures, NodeFeatures};
2484         use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2485         use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2486         use crate::ln::{msgs, wire};
2487         use crate::ln::msgs::{LightningError, SocketAddress};
2488         use crate::util::test_utils;
2489
2490         use bitcoin::Network;
2491         use bitcoin::blockdata::constants::ChainHash;
2492         use bitcoin::secp256k1::{PublicKey, SecretKey};
2493
2494         use crate::prelude::*;
2495         use crate::sync::{Arc, Mutex};
2496         use core::convert::Infallible;
2497         use core::sync::atomic::{AtomicBool, Ordering};
2498
2499         #[derive(Clone)]
2500         struct FileDescriptor {
2501                 fd: u16,
2502                 outbound_data: Arc<Mutex<Vec<u8>>>,
2503                 disconnect: Arc<AtomicBool>,
2504         }
2505         impl PartialEq for FileDescriptor {
2506                 fn eq(&self, other: &Self) -> bool {
2507                         self.fd == other.fd
2508                 }
2509         }
2510         impl Eq for FileDescriptor { }
2511         impl core::hash::Hash for FileDescriptor {
2512                 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2513                         self.fd.hash(hasher)
2514                 }
2515         }
2516
2517         impl SocketDescriptor for FileDescriptor {
2518                 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2519                         self.outbound_data.lock().unwrap().extend_from_slice(data);
2520                         data.len()
2521                 }
2522
2523                 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2524         }
2525
2526         struct PeerManagerCfg {
2527                 chan_handler: test_utils::TestChannelMessageHandler,
2528                 routing_handler: test_utils::TestRoutingMessageHandler,
2529                 custom_handler: TestCustomMessageHandler,
2530                 logger: test_utils::TestLogger,
2531                 node_signer: test_utils::TestNodeSigner,
2532         }
2533
2534         struct TestCustomMessageHandler {
2535                 features: InitFeatures,
2536         }
2537
2538         impl wire::CustomMessageReader for TestCustomMessageHandler {
2539                 type CustomMessage = Infallible;
2540                 fn read<R: io::Read>(&self, _: u16, _: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
2541                         Ok(None)
2542                 }
2543         }
2544
2545         impl CustomMessageHandler for TestCustomMessageHandler {
2546                 fn handle_custom_message(&self, _: Infallible, _: &PublicKey) -> Result<(), LightningError> {
2547                         unreachable!();
2548                 }
2549
2550                 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
2551
2552                 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
2553
2554                 fn provided_init_features(&self, _: &PublicKey) -> InitFeatures {
2555                         self.features.clone()
2556                 }
2557         }
2558
2559         fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2560                 let mut cfgs = Vec::new();
2561                 for i in 0..peer_count {
2562                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2563                         let features = {
2564                                 let mut feature_bits = vec![0u8; 33];
2565                                 feature_bits[32] = 0b00000001;
2566                                 InitFeatures::from_le_bytes(feature_bits)
2567                         };
2568                         cfgs.push(
2569                                 PeerManagerCfg{
2570                                         chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2571                                         logger: test_utils::TestLogger::new(),
2572                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
2573                                         custom_handler: TestCustomMessageHandler { features },
2574                                         node_signer: test_utils::TestNodeSigner::new(node_secret),
2575                                 }
2576                         );
2577                 }
2578
2579                 cfgs
2580         }
2581
2582         fn create_feature_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2583                 let mut cfgs = Vec::new();
2584                 for i in 0..peer_count {
2585                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2586                         let features = {
2587                                 let mut feature_bits = vec![0u8; 33 + i + 1];
2588                                 feature_bits[33 + i] = 0b00000001;
2589                                 InitFeatures::from_le_bytes(feature_bits)
2590                         };
2591                         cfgs.push(
2592                                 PeerManagerCfg{
2593                                         chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2594                                         logger: test_utils::TestLogger::new(),
2595                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
2596                                         custom_handler: TestCustomMessageHandler { features },
2597                                         node_signer: test_utils::TestNodeSigner::new(node_secret),
2598                                 }
2599                         );
2600                 }
2601
2602                 cfgs
2603         }
2604
2605         fn create_chain_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2606                 let mut cfgs = Vec::new();
2607                 for i in 0..peer_count {
2608                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2609                         let features = InitFeatures::from_le_bytes(vec![0u8; 33]);
2610                         let network = ChainHash::from(&[i as u8; 32][..]);
2611                         cfgs.push(
2612                                 PeerManagerCfg{
2613                                         chan_handler: test_utils::TestChannelMessageHandler::new(network),
2614                                         logger: test_utils::TestLogger::new(),
2615                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
2616                                         custom_handler: TestCustomMessageHandler { features },
2617                                         node_signer: test_utils::TestNodeSigner::new(node_secret),
2618                                 }
2619                         );
2620                 }
2621
2622                 cfgs
2623         }
2624
2625         fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>> {
2626                 let mut peers = Vec::new();
2627                 for i in 0..peer_count {
2628                         let ephemeral_bytes = [i as u8; 32];
2629                         let msg_handler = MessageHandler {
2630                                 chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler,
2631                                 onion_message_handler: IgnoringMessageHandler {}, custom_message_handler: &cfgs[i].custom_handler
2632                         };
2633                         let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, &cfgs[i].node_signer);
2634                         peers.push(peer);
2635                 }
2636
2637                 peers
2638         }
2639
2640         fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>) -> (FileDescriptor, FileDescriptor) {
2641                 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2642                 let mut fd_a = FileDescriptor {
2643                         fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2644                         disconnect: Arc::new(AtomicBool::new(false)),
2645                 };
2646                 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2647                 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2648                 let mut fd_b = FileDescriptor {
2649                         fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2650                         disconnect: Arc::new(AtomicBool::new(false)),
2651                 };
2652                 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2653                 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2654                 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2655                 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2656                 peer_a.process_events();
2657
2658                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2659                 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2660
2661                 peer_b.process_events();
2662                 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2663                 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2664
2665                 peer_a.process_events();
2666                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2667                 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2668
2669                 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
2670                 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));
2671
2672                 (fd_a.clone(), fd_b.clone())
2673         }
2674
2675         #[test]
2676         #[cfg(feature = "std")]
2677         fn fuzz_threaded_connections() {
2678                 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2679                 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2680                 // with our internal map consistency, and is a generally good smoke test of disconnection.
2681                 let cfgs = Arc::new(create_peermgr_cfgs(2));
2682                 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2683                 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2684
2685                 let start_time = std::time::Instant::now();
2686                 macro_rules! spawn_thread { ($id: expr) => { {
2687                         let peers = Arc::clone(&peers);
2688                         let cfgs = Arc::clone(&cfgs);
2689                         std::thread::spawn(move || {
2690                                 let mut ctr = 0;
2691                                 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2692                                         let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2693                                         let mut fd_a = FileDescriptor {
2694                                                 fd: $id  + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2695                                                 disconnect: Arc::new(AtomicBool::new(false)),
2696                                         };
2697                                         let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2698                                         let mut fd_b = FileDescriptor {
2699                                                 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2700                                                 disconnect: Arc::new(AtomicBool::new(false)),
2701                                         };
2702                                         let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2703                                         let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2704                                         peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2705                                         if peers[0].read_event(&mut fd_a, &initial_data).is_err() { break; }
2706
2707                                         while start_time.elapsed() < std::time::Duration::from_secs(1) {
2708                                                 peers[0].process_events();
2709                                                 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2710                                                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2711                                                 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2712
2713                                                 peers[1].process_events();
2714                                                 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2715                                                 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2716                                                 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2717
2718                                                 cfgs[0].chan_handler.pending_events.lock().unwrap()
2719                                                         .push(crate::events::MessageSendEvent::SendShutdown {
2720                                                                 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2721                                                                 msg: msgs::Shutdown {
2722                                                                         channel_id: ChannelId::new_zero(),
2723                                                                         scriptpubkey: bitcoin::Script::new(),
2724                                                                 },
2725                                                         });
2726                                                 cfgs[1].chan_handler.pending_events.lock().unwrap()
2727                                                         .push(crate::events::MessageSendEvent::SendShutdown {
2728                                                                 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2729                                                                 msg: msgs::Shutdown {
2730                                                                         channel_id: ChannelId::new_zero(),
2731                                                                         scriptpubkey: bitcoin::Script::new(),
2732                                                                 },
2733                                                         });
2734
2735                                                 if ctr % 2 == 0 {
2736                                                         peers[0].timer_tick_occurred();
2737                                                         peers[1].timer_tick_occurred();
2738                                                 }
2739                                         }
2740
2741                                         peers[0].socket_disconnected(&fd_a);
2742                                         peers[1].socket_disconnected(&fd_b);
2743                                         ctr += 1;
2744                                         std::thread::sleep(std::time::Duration::from_micros(1));
2745                                 }
2746                         })
2747                 } } }
2748                 let thrd_a = spawn_thread!(1);
2749                 let thrd_b = spawn_thread!(2);
2750
2751                 thrd_a.join().unwrap();
2752                 thrd_b.join().unwrap();
2753         }
2754
2755         #[test]
2756         fn test_feature_incompatible_peers() {
2757                 let cfgs = create_peermgr_cfgs(2);
2758                 let incompatible_cfgs = create_feature_incompatible_peermgr_cfgs(2);
2759
2760                 let peers = create_network(2, &cfgs);
2761                 let incompatible_peers = create_network(2, &incompatible_cfgs);
2762                 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2763                 for (peer_a, peer_b) in peer_pairs.iter() {
2764                         let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2765                         let mut fd_a = FileDescriptor {
2766                                 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2767                                 disconnect: Arc::new(AtomicBool::new(false)),
2768                         };
2769                         let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2770                         let mut fd_b = FileDescriptor {
2771                                 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2772                                 disconnect: Arc::new(AtomicBool::new(false)),
2773                         };
2774                         let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2775                         let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2776                         peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2777                         assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2778                         peer_a.process_events();
2779
2780                         let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2781                         assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2782
2783                         peer_b.process_events();
2784                         let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2785
2786                         // Should fail because of unknown required features
2787                         assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2788                 }
2789         }
2790
2791         #[test]
2792         fn test_chain_incompatible_peers() {
2793                 let cfgs = create_peermgr_cfgs(2);
2794                 let incompatible_cfgs = create_chain_incompatible_peermgr_cfgs(2);
2795
2796                 let peers = create_network(2, &cfgs);
2797                 let incompatible_peers = create_network(2, &incompatible_cfgs);
2798                 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2799                 for (peer_a, peer_b) in peer_pairs.iter() {
2800                         let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2801                         let mut fd_a = FileDescriptor {
2802                                 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2803                                 disconnect: Arc::new(AtomicBool::new(false)),
2804                         };
2805                         let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2806                         let mut fd_b = FileDescriptor {
2807                                 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2808                                 disconnect: Arc::new(AtomicBool::new(false)),
2809                         };
2810                         let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2811                         let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2812                         peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2813                         assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2814                         peer_a.process_events();
2815
2816                         let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2817                         assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2818
2819                         peer_b.process_events();
2820                         let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2821
2822                         // Should fail because of incompatible chains
2823                         assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2824                 }
2825         }
2826
2827         #[test]
2828         fn test_disconnect_peer() {
2829                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2830                 // push a DisconnectPeer event to remove the node flagged by id
2831                 let cfgs = create_peermgr_cfgs(2);
2832                 let peers = create_network(2, &cfgs);
2833                 establish_connection(&peers[0], &peers[1]);
2834                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2835
2836                 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2837                 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2838                         node_id: their_id,
2839                         action: msgs::ErrorAction::DisconnectPeer { msg: None },
2840                 });
2841
2842                 peers[0].process_events();
2843                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2844         }
2845
2846         #[test]
2847         fn test_send_simple_msg() {
2848                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2849                 // push a message from one peer to another.
2850                 let cfgs = create_peermgr_cfgs(2);
2851                 let a_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2852                 let b_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2853                 let mut peers = create_network(2, &cfgs);
2854                 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2855                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2856
2857                 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2858
2859                 let msg = msgs::Shutdown { channel_id: ChannelId::from_bytes([42; 32]), scriptpubkey: bitcoin::Script::new() };
2860                 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2861                         node_id: their_id, msg: msg.clone()
2862                 });
2863                 peers[0].message_handler.chan_handler = &a_chan_handler;
2864
2865                 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2866                 peers[1].message_handler.chan_handler = &b_chan_handler;
2867
2868                 peers[0].process_events();
2869
2870                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2871                 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2872         }
2873
2874         #[test]
2875         fn test_non_init_first_msg() {
2876                 // Simple test of the first message received over a connection being something other than
2877                 // Init. This results in an immediate disconnection, which previously included a spurious
2878                 // peer_disconnected event handed to event handlers (which would panic in
2879                 // `TestChannelMessageHandler` here).
2880                 let cfgs = create_peermgr_cfgs(2);
2881                 let peers = create_network(2, &cfgs);
2882
2883                 let mut fd_dup = FileDescriptor {
2884                         fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2885                         disconnect: Arc::new(AtomicBool::new(false)),
2886                 };
2887                 let addr_dup = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1003};
2888                 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
2889                 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
2890
2891                 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
2892                 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
2893                 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
2894                 peers[0].process_events();
2895
2896                 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
2897                 let (act_three, _) =
2898                         dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
2899                 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
2900
2901                 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
2902                 let msg_bytes = dup_encryptor.encrypt_message(&not_init_msg);
2903                 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
2904         }
2905
2906         #[test]
2907         fn test_disconnect_all_peer() {
2908                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2909                 // then calls disconnect_all_peers
2910                 let cfgs = create_peermgr_cfgs(2);
2911                 let peers = create_network(2, &cfgs);
2912                 establish_connection(&peers[0], &peers[1]);
2913                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2914
2915                 peers[0].disconnect_all_peers();
2916                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2917         }
2918
2919         #[test]
2920         fn test_timer_tick_occurred() {
2921                 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2922                 let cfgs = create_peermgr_cfgs(2);
2923                 let peers = create_network(2, &cfgs);
2924                 establish_connection(&peers[0], &peers[1]);
2925                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2926
2927                 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2928                 peers[0].timer_tick_occurred();
2929                 peers[0].process_events();
2930                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2931
2932                 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2933                 peers[0].timer_tick_occurred();
2934                 peers[0].process_events();
2935                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2936         }
2937
2938         #[test]
2939         fn test_do_attempt_write_data() {
2940                 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2941                 let cfgs = create_peermgr_cfgs(2);
2942                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2943                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2944                 let peers = create_network(2, &cfgs);
2945
2946                 // By calling establish_connect, we trigger do_attempt_write_data between
2947                 // the peers. Previously this function would mistakenly enter an infinite loop
2948                 // when there were more channel messages available than could fit into a peer's
2949                 // buffer. This issue would now be detected by this test (because we use custom
2950                 // RoutingMessageHandlers that intentionally return more channel messages
2951                 // than can fit into a peer's buffer).
2952                 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2953
2954                 // Make each peer to read the messages that the other peer just wrote to them. Note that
2955                 // due to the max-message-before-ping limits this may take a few iterations to complete.
2956                 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2957                         peers[1].process_events();
2958                         let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2959                         assert!(!a_read_data.is_empty());
2960
2961                         peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2962                         peers[0].process_events();
2963
2964                         let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2965                         assert!(!b_read_data.is_empty());
2966                         peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2967
2968                         peers[0].process_events();
2969                         assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2970                 }
2971
2972                 // Check that each peer has received the expected number of channel updates and channel
2973                 // announcements.
2974                 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2975                 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2976                 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2977                 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2978         }
2979
2980         #[test]
2981         fn test_handshake_timeout() {
2982                 // Tests that we time out a peer still waiting on handshake completion after a full timer
2983                 // tick.
2984                 let cfgs = create_peermgr_cfgs(2);
2985                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2986                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2987                 let peers = create_network(2, &cfgs);
2988
2989                 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2990                 let mut fd_a = FileDescriptor {
2991                         fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2992                         disconnect: Arc::new(AtomicBool::new(false)),
2993                 };
2994                 let mut fd_b = FileDescriptor {
2995                         fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2996                         disconnect: Arc::new(AtomicBool::new(false)),
2997                 };
2998                 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2999                 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
3000
3001                 // If we get a single timer tick before completion, that's fine
3002                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3003                 peers[0].timer_tick_occurred();
3004                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3005
3006                 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
3007                 peers[0].process_events();
3008                 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3009                 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
3010                 peers[1].process_events();
3011
3012                 // ...but if we get a second timer tick, we should disconnect the peer
3013                 peers[0].timer_tick_occurred();
3014                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3015
3016                 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3017                 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
3018         }
3019
3020         #[test]
3021         fn test_filter_addresses(){
3022                 // Tests the filter_addresses function.
3023
3024                 // For (10/8)
3025                 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 0, 0], port: 1000};
3026                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3027                 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 255, 201], port: 1000};
3028                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3029                 let ip_address = SocketAddress::TcpIpV4{addr: [10, 255, 255, 255], port: 1000};
3030                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3031
3032                 // For (0/8)
3033                 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 0, 0], port: 1000};
3034                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3035                 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 255, 187], port: 1000};
3036                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3037                 let ip_address = SocketAddress::TcpIpV4{addr: [0, 255, 255, 255], port: 1000};
3038                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3039
3040                 // For (100.64/10)
3041                 let ip_address = SocketAddress::TcpIpV4{addr: [100, 64, 0, 0], port: 1000};
3042                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3043                 let ip_address = SocketAddress::TcpIpV4{addr: [100, 78, 255, 0], port: 1000};
3044                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3045                 let ip_address = SocketAddress::TcpIpV4{addr: [100, 127, 255, 255], port: 1000};
3046                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3047
3048                 // For (127/8)
3049                 let ip_address = SocketAddress::TcpIpV4{addr: [127, 0, 0, 0], port: 1000};
3050                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3051                 let ip_address = SocketAddress::TcpIpV4{addr: [127, 65, 73, 0], port: 1000};
3052                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3053                 let ip_address = SocketAddress::TcpIpV4{addr: [127, 255, 255, 255], port: 1000};
3054                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3055
3056                 // For (169.254/16)
3057                 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 0, 0], port: 1000};
3058                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3059                 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 221, 101], port: 1000};
3060                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3061                 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 255, 255], port: 1000};
3062                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3063
3064                 // For (172.16/12)
3065                 let ip_address = SocketAddress::TcpIpV4{addr: [172, 16, 0, 0], port: 1000};
3066                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3067                 let ip_address = SocketAddress::TcpIpV4{addr: [172, 27, 101, 23], port: 1000};
3068                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3069                 let ip_address = SocketAddress::TcpIpV4{addr: [172, 31, 255, 255], port: 1000};
3070                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3071
3072                 // For (192.168/16)
3073                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 0, 0], port: 1000};
3074                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3075                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 205, 159], port: 1000};
3076                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3077                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 255, 255], port: 1000};
3078                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3079
3080                 // For (192.88.99/24)
3081                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 0], port: 1000};
3082                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3083                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 140], port: 1000};
3084                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3085                 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 255], port: 1000};
3086                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3087
3088                 // For other IPv4 addresses
3089                 let ip_address = SocketAddress::TcpIpV4{addr: [188, 255, 99, 0], port: 1000};
3090                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3091                 let ip_address = SocketAddress::TcpIpV4{addr: [123, 8, 129, 14], port: 1000};
3092                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3093                 let ip_address = SocketAddress::TcpIpV4{addr: [2, 88, 9, 255], port: 1000};
3094                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3095
3096                 // For (2000::/3)
3097                 let ip_address = SocketAddress::TcpIpV6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
3098                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3099                 let ip_address = SocketAddress::TcpIpV6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
3100                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3101                 let ip_address = SocketAddress::TcpIpV6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
3102                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3103
3104                 // For other IPv6 addresses
3105                 let ip_address = SocketAddress::TcpIpV6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
3106                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3107                 let ip_address = SocketAddress::TcpIpV6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
3108                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3109                 let ip_address = SocketAddress::TcpIpV6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
3110                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3111
3112                 // For (None)
3113                 assert_eq!(filter_addresses(None), None);
3114         }
3115
3116         #[test]
3117         #[cfg(feature = "std")]
3118         fn test_process_events_multithreaded() {
3119                 use std::time::{Duration, Instant};
3120                 // Test that `process_events` getting called on multiple threads doesn't generate too many
3121                 // loop iterations.
3122                 // Each time `process_events` goes around the loop we call
3123                 // `get_and_clear_pending_msg_events`, which we count using the `TestMessageHandler`.
3124                 // Because the loop should go around once more after a call which fails to take the
3125                 // single-threaded lock, if we write zero to the counter before calling `process_events` we
3126                 // should never observe there having been more than 2 loop iterations.
3127                 // Further, because the last thread to exit will call `process_events` before returning, we
3128                 // should always have at least one count at the end.
3129                 let cfg = Arc::new(create_peermgr_cfgs(1));
3130                 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
3131                 let peer = Arc::new(create_network(1, unsafe { &*(&*cfg as *const _) as &'static _ }).pop().unwrap());
3132
3133                 let exit_flag = Arc::new(AtomicBool::new(false));
3134                 macro_rules! spawn_thread { () => { {
3135                         let thread_cfg = Arc::clone(&cfg);
3136                         let thread_peer = Arc::clone(&peer);
3137                         let thread_exit = Arc::clone(&exit_flag);
3138                         std::thread::spawn(move || {
3139                                 while !thread_exit.load(Ordering::Acquire) {
3140                                         thread_cfg[0].chan_handler.message_fetch_counter.store(0, Ordering::Release);
3141                                         thread_peer.process_events();
3142                                         std::thread::sleep(Duration::from_micros(1));
3143                                 }
3144                         })
3145                 } } }
3146
3147                 let thread_a = spawn_thread!();
3148                 let thread_b = spawn_thread!();
3149                 let thread_c = spawn_thread!();
3150
3151                 let start_time = Instant::now();
3152                 while start_time.elapsed() < Duration::from_millis(100) {
3153                         let val = cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire);
3154                         assert!(val <= 2);
3155                         std::thread::yield_now(); // Winblowz seemingly doesn't ever interrupt threads?!
3156                 }
3157
3158                 exit_flag.store(true, Ordering::Release);
3159                 thread_a.join().unwrap();
3160                 thread_b.join().unwrap();
3161                 thread_c.join().unwrap();
3162                 assert!(cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire) >= 1);
3163         }
3164 }