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

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