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

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