_ 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};
  25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
  26 use ln::wire;
  27 use ln::wire::Encode;
  28 use util::byte_utils;
  29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
  30 use util::logger::Logger;
  31 use routing::network_graph::NetGraphMsgHandler;
  32
  33 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
  34 use std::sync::{Arc, Mutex};
  35 use std::sync::atomic::{AtomicUsize, Ordering};
  36 use std::{cmp,error,hash,fmt};
  37 use std::ops::Deref;
  38
  39 use bitcoin::hashes::sha256::Hash as Sha256;
  40 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
  41 use bitcoin::hashes::{HashEngine, Hash};
  42
  43 /// Provides references to trait impls which handle different types of messages.
  44 pub struct MessageHandler<CM: Deref, RM: Deref> where
  45                 CM::Target: ChannelMessageHandler,
  46                 RM::Target: RoutingMessageHandler {
  47         /// A message handler which handles messages specific to channels. Usually this is just a
  48         /// ChannelManager object.
  49         pub chan_handler: CM,
  50         /// A message handler which handles messages updating our knowledge of the network channel
  51         /// graph. Usually this is just a NetGraphMsgHandlerMonitor object.
  52         pub route_handler: RM,
  53 }
  54
  55 /// Provides an object which can be used to send data to and which uniquely identifies a connection
  56 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
  57 /// implement Hash to meet the PeerManager API.
  58 ///
  59 /// For efficiency, Clone should be relatively cheap for this type.
  60 ///
  61 /// You probably want to just extend an int and put a file descriptor in a struct and implement
  62 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
  63 /// be careful to ensure you don't have races whereby you might register a new connection with an
  64 /// fd which is the same as a previous one which has yet to be removed via
  65 /// PeerManager::socket_disconnected().
  66 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
  67         /// Attempts to send some data from the given slice to the peer.
  68         ///
  69         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
  70         /// Note that in the disconnected case, socket_disconnected must still fire and further write
  71         /// attempts may occur until that time.
  72         ///
  73         /// If the returned size is smaller than data.len(), a write_available event must
  74         /// trigger the next time more data can be written. Additionally, until the a send_data event
  75         /// completes fully, no further read_events should trigger on the same peer!
  76         ///
  77         /// If a read_event on this descriptor had previously returned true (indicating that read
  78         /// events should be paused to prevent DoS in the send buffer), resume_read may be set
  79         /// indicating that read events on this descriptor should resume. A resume_read of false does
  80         /// *not* imply that further read events should be paused.
  81         fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
  82         /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
  83         /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
  84         /// this descriptor. No socket_disconnected call should be generated as a result of this call,
  85         /// though races may occur whereby disconnect_socket is called after a call to
  86         /// socket_disconnected but prior to socket_disconnected returning.
  87         fn disconnect_socket(&mut self);
  88 }
  89
  90 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
  91 /// generate no further read_event/write_buffer_space_avail calls for the descriptor, only
  92 /// triggering a single socket_disconnected call (unless it was provided in response to a
  93 /// new_*_connection event, in which case no such socket_disconnected() must be called and the
  94 /// socket silently disconencted).
  95 pub struct PeerHandleError {
  96         /// Used to indicate that we probably can't make any future connections to this peer, implying
  97         /// we should go ahead and force-close any channels we have with it.
  98         pub no_connection_possible: bool,
  99 }
 100 impl fmt::Debug for PeerHandleError {
 101         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 102                 formatter.write_str("Peer Sent Invalid Data")
 103         }
 104 }
 105 impl fmt::Display for PeerHandleError {
 106         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 107                 formatter.write_str("Peer Sent Invalid Data")
 108         }
 109 }
 110 impl error::Error for PeerHandleError {
 111         fn description(&self) -> &str {
 112                 "Peer Sent Invalid Data"
 113         }
 114 }
 115
 116 enum InitSyncTracker{
 117         NoSyncRequested,
 118         ChannelsSyncing(u64),
 119         NodesSyncing(PublicKey),
 120 }
 121
 122 struct Peer {
 123         channel_encryptor: PeerChannelEncryptor,
 124         outbound: bool,
 125         their_node_id: Option<PublicKey>,
 126         their_features: Option<InitFeatures>,
 127
 128         pending_outbound_buffer: LinkedList<Vec<u8>>,
 129         pending_outbound_buffer_first_msg_offset: usize,
 130         awaiting_write_event: bool,
 131
 132         pending_read_buffer: Vec<u8>,
 133         pending_read_buffer_pos: usize,
 134         pending_read_is_header: bool,
 135
 136         sync_status: InitSyncTracker,
 137
 138         awaiting_pong: bool,
 139 }
 140
 141 impl Peer {
 142         /// Returns true if the channel announcements/updates for the given channel should be
 143         /// forwarded to this peer.
 144         /// If we are sending our routing table to this peer and we have not yet sent channel
 145         /// announcements/updates for the given channel_id then we will send it when we get to that
 146         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 147         /// sent the old versions, we should send the update, and so return true here.
 148         fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
 149                 match self.sync_status {
 150                         InitSyncTracker::NoSyncRequested => true,
 151                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 152                         InitSyncTracker::NodesSyncing(_) => true,
 153                 }
 154         }
 155
 156         /// Similar to the above, but for node announcements indexed by node_id.
 157         fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
 158                 match self.sync_status {
 159                         InitSyncTracker::NoSyncRequested => true,
 160                         InitSyncTracker::ChannelsSyncing(_) => false,
 161                         InitSyncTracker::NodesSyncing(pk) => pk < node_id,
 162                 }
 163         }
 164 }
 165
 166 struct PeerHolder<Descriptor: SocketDescriptor> {
 167         peers: HashMap<Descriptor, Peer>,
 168         /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
 169         /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
 170         peers_needing_send: HashSet<Descriptor>,
 171         /// Only add to this set when noise completes:
 172         node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
 173 }
 174
 175 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
 176 fn _check_usize_is_32_or_64() {
 177         // See below, less than 32 bit pointers may be unsafe here!
 178         unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
 179 }
 180
 181 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
 182 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
 183 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
 184 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
 185 /// issues such as overly long function definitions.
 186 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = Arc<PeerManager<SD, SimpleArcChannelManager<M, T, F, L>, Arc<NetGraphMsgHandler<Arc<C>, Arc<L>>>, Arc<L>>>;
 187
 188 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
 189 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
 190 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
 191 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
 192 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
 193 /// helps with issues such as long function definitions.
 194 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e NetGraphMsgHandler<&'g C, &'f L>, &'f L>;
 195
 196 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
 197 /// events into messages which it passes on to its MessageHandlers.
 198 ///
 199 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
 200 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
 201 /// essentially you should default to using a SimpleRefPeerManager, and use a
 202 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
 203 /// you're using lightning-net-tokio.
 204 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
 205                 CM::Target: ChannelMessageHandler,
 206                 RM::Target: RoutingMessageHandler,
 207                 L::Target: Logger {
 208         message_handler: MessageHandler<CM, RM>,
 209         peers: Mutex<PeerHolder<Descriptor>>,
 210         our_node_secret: SecretKey,
 211         ephemeral_key_midstate: Sha256Engine,
 212
 213         // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
 214         // bits we will never realistically count into high:
 215         peer_counter_low: AtomicUsize,
 216         peer_counter_high: AtomicUsize,
 217
 218         logger: L,
 219 }
 220
 221 enum MessageHandlingError {
 222         PeerHandleError(PeerHandleError),
 223         LightningError(LightningError),
 224 }
 225
 226 impl From<PeerHandleError> for MessageHandlingError {
 227         fn from(error: PeerHandleError) -> Self {
 228                 MessageHandlingError::PeerHandleError(error)
 229         }
 230 }
 231
 232 impl From<LightningError> for MessageHandlingError {
 233         fn from(error: LightningError) -> Self {
 234                 MessageHandlingError::LightningError(error)
 235         }
 236 }
 237
 238 macro_rules! encode_msg {
 239         ($msg: expr) => {{
 240                 let mut buffer = VecWriter(Vec::new());
 241                 wire::write($msg, &mut buffer).unwrap();
 242                 buffer.0
 243         }}
 244 }
 245
 246 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
 247 /// PeerIds may repeat, but only after socket_disconnected() has been called.
 248 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
 249                 CM::Target: ChannelMessageHandler,
 250                 RM::Target: RoutingMessageHandler,
 251                 L::Target: Logger {
 252         /// Constructs a new PeerManager with the given message handlers and node_id secret key
 253         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 254         /// cryptographically secure random bytes.
 255         pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 256                 let mut ephemeral_key_midstate = Sha256::engine();
 257                 ephemeral_key_midstate.input(ephemeral_random_data);
 258
 259                 PeerManager {
 260                         message_handler,
 261                         peers: Mutex::new(PeerHolder {
 262                                 peers: HashMap::new(),
 263                                 peers_needing_send: HashSet::new(),
 264                                 node_id_to_descriptor: HashMap::new()
 265                         }),
 266                         our_node_secret,
 267                         ephemeral_key_midstate,
 268                         peer_counter_low: AtomicUsize::new(0),
 269                         peer_counter_high: AtomicUsize::new(0),
 270                         logger,
 271                 }
 272         }
 273
 274         /// Get the list of node ids for peers which have completed the initial handshake.
 275         ///
 276         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
 277         /// new_outbound_connection, however entries will only appear once the initial handshake has
 278         /// completed and we are sure the remote peer has the private key for the given node_id.
 279         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
 280                 let peers = self.peers.lock().unwrap();
 281                 peers.peers.values().filter_map(|p| {
 282                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
 283                                 return None;
 284                         }
 285                         p.their_node_id
 286                 }).collect()
 287         }
 288
 289         fn get_ephemeral_key(&self) -> SecretKey {
 290                 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 291                 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
 292                 let high = if low == 0 {
 293                         self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
 294                 } else {
 295                         self.peer_counter_high.load(Ordering::Acquire)
 296                 };
 297                 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
 298                 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
 299                 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
 300         }
 301
 302         /// Indicates a new outbound connection has been established to a node with the given node_id.
 303         /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
 304         /// descriptor but must disconnect the connection immediately.
 305         ///
 306         /// Returns a small number of bytes to send to the remote node (currently always 50).
 307         ///
 308         /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
 309         /// socket_disconnected().
 310         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
 311                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
 312                 let res = peer_encryptor.get_act_one().to_vec();
 313                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 314
 315                 let mut peers = self.peers.lock().unwrap();
 316                 if peers.peers.insert(descriptor, Peer {
 317                         channel_encryptor: peer_encryptor,
 318                         outbound: true,
 319                         their_node_id: None,
 320                         their_features: None,
 321
 322                         pending_outbound_buffer: LinkedList::new(),
 323                         pending_outbound_buffer_first_msg_offset: 0,
 324                         awaiting_write_event: false,
 325
 326                         pending_read_buffer,
 327                         pending_read_buffer_pos: 0,
 328                         pending_read_is_header: false,
 329
 330                         sync_status: InitSyncTracker::NoSyncRequested,
 331
 332                         awaiting_pong: false,
 333                 }).is_some() {
 334                         panic!("PeerManager driver duplicated descriptors!");
 335                 };
 336                 Ok(res)
 337         }
 338
 339         /// Indicates a new inbound connection has been established.
 340         ///
 341         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 342         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 343         /// call socket_disconnected for the new descriptor but must disconnect the connection
 344         /// immediately.
 345         ///
 346         /// Panics if descriptor is duplicative with some other descriptor which has not yet had
 347         /// socket_disconnected called.
 348         pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
 349                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
 350                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 351
 352                 let mut peers = self.peers.lock().unwrap();
 353                 if peers.peers.insert(descriptor, Peer {
 354                         channel_encryptor: peer_encryptor,
 355                         outbound: false,
 356                         their_node_id: None,
 357                         their_features: None,
 358
 359                         pending_outbound_buffer: LinkedList::new(),
 360                         pending_outbound_buffer_first_msg_offset: 0,
 361                         awaiting_write_event: false,
 362
 363                         pending_read_buffer,
 364                         pending_read_buffer_pos: 0,
 365                         pending_read_is_header: false,
 366
 367                         sync_status: InitSyncTracker::NoSyncRequested,
 368
 369                         awaiting_pong: false,
 370                 }).is_some() {
 371                         panic!("PeerManager driver duplicated descriptors!");
 372                 };
 373                 Ok(())
 374         }
 375
 376         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
 377                 macro_rules! encode_and_send_msg {
 378                         ($msg: expr) => {
 379                                 {
 380                                         log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 381                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
 382                                 }
 383                         }
 384                 }
 385                 const MSG_BUFF_SIZE: usize = 10;
 386                 while !peer.awaiting_write_event {
 387                         if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
 388                                 match peer.sync_status {
 389                                         InitSyncTracker::NoSyncRequested => {},
 390                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
 391                                                 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
 392                                                 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
 393                                                 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
 394                                                         encode_and_send_msg!(announce);
 395                                                         if let &Some(ref update_a) = update_a_option {
 396                                                                 encode_and_send_msg!(update_a);
 397                                                         }
 398                                                         if let &Some(ref update_b) = update_b_option {
 399                                                                 encode_and_send_msg!(update_b);
 400                                                         }
 401                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
 402                                                 }
 403                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 404                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
 405                                                 }
 406                                         },
 407                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
 408                                                 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
 409                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
 410                                                 for msg in all_messages.iter() {
 411                                                         encode_and_send_msg!(msg);
 412                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 413                                                 }
 414                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 415                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 416                                                 }
 417                                         },
 418                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
 419                                         InitSyncTracker::NodesSyncing(key) => {
 420                                                 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
 421                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
 422                                                 for msg in all_messages.iter() {
 423                                                         encode_and_send_msg!(msg);
 424                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 425                                                 }
 426                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 427                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 428                                                 }
 429                                         },
 430                                 }
 431                         }
 432
 433                         if {
 434                                 let next_buff = match peer.pending_outbound_buffer.front() {
 435                                         None => return,
 436                                         Some(buff) => buff,
 437                                 };
 438
 439                                 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
 440                                 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
 441                                 let data_sent = descriptor.send_data(pending, should_be_reading);
 442                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
 443                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
 444                         } {
 445                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 446                                 peer.pending_outbound_buffer.pop_front();
 447                         } else {
 448                                 peer.awaiting_write_event = true;
 449                         }
 450                 }
 451         }
 452
 453         /// Indicates that there is room to write data to the given socket descriptor.
 454         ///
 455         /// May return an Err to indicate that the connection should be closed.
 456         ///
 457         /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
 458         /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
 459         /// invariants around calling write_buffer_space_avail in case a write did not fully complete
 460         /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
 461         /// here isn't sufficient! Panics if the descriptor was not previously registered in a
 462         /// new_\*_connection event.
 463         pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 464                 let mut peers = self.peers.lock().unwrap();
 465                 match peers.peers.get_mut(descriptor) {
 466                         None => panic!("Descriptor for write_event is not already known to PeerManager"),
 467                         Some(peer) => {
 468                                 peer.awaiting_write_event = false;
 469                                 self.do_attempt_write_data(descriptor, peer);
 470                         }
 471                 };
 472                 Ok(())
 473         }
 474
 475         /// Indicates that data was read from the given socket descriptor.
 476         ///
 477         /// May return an Err to indicate that the connection should be closed.
 478         ///
 479         /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
 480         /// Thus, however, you almost certainly want to call process_events() after any read_event to
 481         /// generate send_data calls to handle responses.
 482         ///
 483         /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
 484         /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
 485         ///
 486         /// Panics if the descriptor was not previously registered in a new_*_connection event.
 487         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 488                 match self.do_read_event(peer_descriptor, data) {
 489                         Ok(res) => Ok(res),
 490                         Err(e) => {
 491                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
 492                                 Err(e)
 493                         }
 494                 }
 495         }
 496
 497         /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
 498         fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
 499                 let mut buffer = VecWriter(Vec::new());
 500                 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
 501                 let encoded_message = buffer.0;
 502
 503                 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 504                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
 505                 peers_needing_send.insert(descriptor);
 506         }
 507
 508         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 509                 let pause_read = {
 510                         let mut peers_lock = self.peers.lock().unwrap();
 511                         let peers = &mut *peers_lock;
 512                         let pause_read = match peers.peers.get_mut(peer_descriptor) {
 513                                 None => panic!("Descriptor for read_event is not already known to PeerManager"),
 514                                 Some(peer) => {
 515                                         assert!(peer.pending_read_buffer.len() > 0);
 516                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 517
 518                                         let mut read_pos = 0;
 519                                         while read_pos < data.len() {
 520                                                 {
 521                                                         let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 522                                                         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]);
 523                                                         read_pos += data_to_copy;
 524                                                         peer.pending_read_buffer_pos += data_to_copy;
 525                                                 }
 526
 527                                                 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 528                                                         peer.pending_read_buffer_pos = 0;
 529
 530                                                         macro_rules! try_potential_handleerror {
 531                                                                 ($thing: expr) => {
 532                                                                         match $thing {
 533                                                                                 Ok(x) => x,
 534                                                                                 Err(e) => {
 535                                                                                         match e.action {
 536                                                                                                 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
 537                                                                                                         //TODO: Try to push msg
 538                                                                                                         log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
 539                                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 540                                                                                                 },
 541                                                                                                 msgs::ErrorAction::IgnoreError => {
 542                                                                                                         log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
 543                                                                                                         continue;
 544                                                                                                 },
 545                                                                                                 msgs::ErrorAction::SendErrorMessage { msg } => {
 546                                                                                                         log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
 547                                                                                                         self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
 548                                                                                                         continue;
 549                                                                                                 },
 550                                                                                         }
 551                                                                                 }
 552                                                                         };
 553                                                                 }
 554                                                         }
 555
 556                                                         macro_rules! insert_node_id {
 557                                                                 () => {
 558                                                                         match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
 559                                                                                 hash_map::Entry::Occupied(_) => {
 560                                                                                         log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
 561                                                                                         peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
 562                                                                                         return Err(PeerHandleError{ no_connection_possible: false })
 563                                                                                 },
 564                                                                                 hash_map::Entry::Vacant(entry) => {
 565                                                                                         log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
 566                                                                                         entry.insert(peer_descriptor.clone())
 567                                                                                 },
 568                                                                         };
 569                                                                 }
 570                                                         }
 571
 572                                                         let next_step = peer.channel_encryptor.get_noise_step();
 573                                                         match next_step {
 574                                                                 NextNoiseStep::ActOne => {
 575                                                                         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();
 576                                                                         peer.pending_outbound_buffer.push_back(act_two);
 577                                                                         peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 578                                                                 },
 579                                                                 NextNoiseStep::ActTwo => {
 580                                                                         let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
 581                                                                         peer.pending_outbound_buffer.push_back(act_three.to_vec());
 582                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 583                                                                         peer.pending_read_is_header = true;
 584
 585                                                                         peer.their_node_id = Some(their_node_id);
 586                                                                         insert_node_id!();
 587                                                                         let mut features = InitFeatures::known();
 588                                                                         if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
 589                                                                                 features.clear_initial_routing_sync();
 590                                                                         }
 591
 592                                                                         let resp = msgs::Init { features };
 593                                                                         self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
 594                                                                 },
 595                                                                 NextNoiseStep::ActThree => {
 596                                                                         let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 597                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 598                                                                         peer.pending_read_is_header = true;
 599                                                                         peer.their_node_id = Some(their_node_id);
 600                                                                         insert_node_id!();
 601                                                                 },
 602                                                                 NextNoiseStep::NoiseComplete => {
 603                                                                         if peer.pending_read_is_header {
 604                                                                                 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 605                                                                                 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
 606                                                                                 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 607                                                                                 if msg_len < 2 { // Need at least the message type tag
 608                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 609                                                                                 }
 610                                                                                 peer.pending_read_is_header = false;
 611                                                                         } else {
 612                                                                                 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
 613                                                                                 assert!(msg_data.len() >= 2);
 614
 615                                                                                 // Reset read buffer
 616                                                                                 peer.pending_read_buffer = [0; 18].to_vec();
 617                                                                                 peer.pending_read_is_header = true;
 618
 619                                                                                 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
 620                                                                                 let message_result = wire::read(&mut reader);
 621                                                                                 let message = match message_result {
 622                                                                                         Ok(x) => x,
 623                                                                                         Err(e) => {
 624                                                                                                 match e {
 625                                                                                                         msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
 626                                                                                                         msgs::DecodeError::UnknownRequiredFeature => {
 627                                                                                                                 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
 628                                                                                                                 continue;
 629                                                                                                         }
 630                                                                                                         msgs::DecodeError::InvalidValue => {
 631                                                                                                                 log_debug!(self.logger, "Got an invalid value while deserializing message");
 632                                                                                                                 return Err(PeerHandleError { no_connection_possible: false });
 633                                                                                                         }
 634                                                                                                         msgs::DecodeError::ShortRead => {
 635                                                                                                                 log_debug!(self.logger, "Deserialization failed due to shortness of message");
 636                                                                                                                 return Err(PeerHandleError { no_connection_possible: false });
 637                                                                                                         }
 638                                                                                                         msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
 639                                                                                                         msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
 640                                                                                                 }
 641                                                                                         }
 642                                                                                 };
 643
 644                                                                                 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
 645                                                                                         match handling_error {
 646                                                                                                 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
 647                                                                                                 MessageHandlingError::LightningError(e) => {
 648                                                                                                         try_potential_handleerror!(Err(e));
 649                                                                                                 },
 650                                                                                         }
 651                                                                                 }
 652                                                                         }
 653                                                                 }
 654                                                         }
 655                                                 }
 656                                         }
 657
 658                                         self.do_attempt_write_data(peer_descriptor, peer);
 659
 660                                         peer.pending_outbound_buffer.len() > 10 // pause_read
 661                                 }
 662                         };
 663
 664                         pause_read
 665                 };
 666
 667                 Ok(pause_read)
 668         }
 669
 670         /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
 671         fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
 672                 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
 673
 674                 // Need an Init as first message
 675                 if let wire::Message::Init(_) = message {
 676                 } else if peer.their_features.is_none() {
 677                         log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
 678                         return Err(PeerHandleError{ no_connection_possible: false }.into());
 679                 }
 680
 681                 match message {
 682                         // Setup and Control messages:
 683                         wire::Message::Init(msg) => {
 684                                 if msg.features.requires_unknown_bits() {
 685                                         log_info!(self.logger, "Peer global features required unknown version bits");
 686                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 687                                 }
 688                                 if msg.features.requires_unknown_bits() {
 689                                         log_info!(self.logger, "Peer local features required unknown version bits");
 690                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 691                                 }
 692                                 if peer.their_features.is_some() {
 693                                         return Err(PeerHandleError{ no_connection_possible: false }.into());
 694                                 }
 695
 696                                 log_info!(
 697                                         self.logger, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, static_remote_key: {}, unknown flags (local and global): {}",
 698                                         if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
 699                                         if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
 700                                         if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
 701                                         if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
 702                                         if msg.features.supports_unknown_bits() { "present" } else { "none" }
 703                                 );
 704
 705                                 if msg.features.initial_routing_sync() {
 706                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
 707                                         peers_needing_send.insert(peer_descriptor.clone());
 708                                 }
 709                                 if !msg.features.supports_static_remote_key() {
 710                                         log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
 711                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 712                                 }
 713
 714                                 if !peer.outbound {
 715                                         let mut features = InitFeatures::known();
 716                                         if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
 717                                                 features.clear_initial_routing_sync();
 718                                         }
 719
 720                                         let resp = msgs::Init { features };
 721                                         self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
 722                                 }
 723
 724                                 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
 725                                 peer.their_features = Some(msg.features);
 726                         },
 727                         wire::Message::Error(msg) => {
 728                                 let mut data_is_printable = true;
 729                                 for b in msg.data.bytes() {
 730                                         if b < 32 || b > 126 {
 731                                                 data_is_printable = false;
 732                                                 break;
 733                                         }
 734                                 }
 735
 736                                 if data_is_printable {
 737                                         log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
 738                                 } else {
 739                                         log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
 740                                 }
 741                                 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
 742                                 if msg.channel_id == [0; 32] {
 743                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
 744                                 }
 745                         },
 746
 747                         wire::Message::Ping(msg) => {
 748                                 if msg.ponglen < 65532 {
 749                                         let resp = msgs::Pong { byteslen: msg.ponglen };
 750                                         self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
 751                                 }
 752                         },
 753                         wire::Message::Pong(_msg) => {
 754                                 peer.awaiting_pong = false;
 755                         },
 756
 757                         // Channel messages:
 758                         wire::Message::OpenChannel(msg) => {
 759                                 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
 760                         },
 761                         wire::Message::AcceptChannel(msg) => {
 762                                 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
 763                         },
 764
 765                         wire::Message::FundingCreated(msg) => {
 766                                 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
 767                         },
 768                         wire::Message::FundingSigned(msg) => {
 769                                 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
 770                         },
 771                         wire::Message::FundingLocked(msg) => {
 772                                 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
 773                         },
 774
 775                         wire::Message::Shutdown(msg) => {
 776                                 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
 777                         },
 778                         wire::Message::ClosingSigned(msg) => {
 779                                 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
 780                         },
 781
 782                         // Commitment messages:
 783                         wire::Message::UpdateAddHTLC(msg) => {
 784                                 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
 785                         },
 786                         wire::Message::UpdateFulfillHTLC(msg) => {
 787                                 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
 788                         },
 789                         wire::Message::UpdateFailHTLC(msg) => {
 790                                 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
 791                         },
 792                         wire::Message::UpdateFailMalformedHTLC(msg) => {
 793                                 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
 794                         },
 795
 796                         wire::Message::CommitmentSigned(msg) => {
 797                                 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
 798                         },
 799                         wire::Message::RevokeAndACK(msg) => {
 800                                 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
 801                         },
 802                         wire::Message::UpdateFee(msg) => {
 803                                 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
 804                         },
 805                         wire::Message::ChannelReestablish(msg) => {
 806                                 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
 807                         },
 808
 809                         // Routing messages:
 810                         wire::Message::AnnouncementSignatures(msg) => {
 811                                 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
 812                         },
 813                         wire::Message::ChannelAnnouncement(msg) => {
 814                                 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
 815                                         Ok(v) => v,
 816                                         Err(e) => { return Err(e.into()); },
 817                                 };
 818
 819                                 if should_forward {
 820                                         // TODO: forward msg along to all our other peers!
 821                                 }
 822                         },
 823                         wire::Message::NodeAnnouncement(msg) => {
 824                                 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
 825                                         Ok(v) => v,
 826                                         Err(e) => { return Err(e.into()); },
 827                                 };
 828
 829                                 if should_forward {
 830                                         // TODO: forward msg along to all our other peers!
 831                                 }
 832                         },
 833                         wire::Message::ChannelUpdate(msg) => {
 834                                 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
 835                                         Ok(v) => v,
 836                                         Err(e) => { return Err(e.into()); },
 837                                 };
 838
 839                                 if should_forward {
 840                                         // TODO: forward msg along to all our other peers!
 841                                 }
 842                         },
 843
 844                         // Unknown messages:
 845                         wire::Message::Unknown(msg_type) if msg_type.is_even() => {
 846                                 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
 847                                 // Fail the channel if message is an even, unknown type as per BOLT #1.
 848                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
 849                         },
 850                         wire::Message::Unknown(msg_type) => {
 851                                 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
 852                         }
 853                 };
 854                 Ok(())
 855         }
 856
 857         /// Checks for any events generated by our handlers and processes them. Includes sending most
 858         /// response messages as well as messages generated by calls to handler functions directly (eg
 859         /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
 860         pub fn process_events(&self) {
 861                 {
 862                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
 863                         // buffer by doing things like announcing channels on another node. We should be willing to
 864                         // drop optional-ish messages when send buffers get full!
 865
 866                         let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
 867                         let mut peers_lock = self.peers.lock().unwrap();
 868                         let peers = &mut *peers_lock;
 869                         for event in events_generated.drain(..) {
 870                                 macro_rules! get_peer_for_forwarding {
 871                                         ($node_id: expr, $handle_no_such_peer: block) => {
 872                                                 {
 873                                                         let descriptor = match peers.node_id_to_descriptor.get($node_id) {
 874                                                                 Some(descriptor) => descriptor.clone(),
 875                                                                 None => {
 876                                                                         $handle_no_such_peer;
 877                                                                         continue;
 878                                                                 },
 879                                                         };
 880                                                         match peers.peers.get_mut(&descriptor) {
 881                                                                 Some(peer) => {
 882                                                                         if peer.their_features.is_none() {
 883                                                                                 $handle_no_such_peer;
 884                                                                                 continue;
 885                                                                         }
 886                                                                         (descriptor, peer)
 887                                                                 },
 888                                                                 None => panic!("Inconsistent peers set state!"),
 889                                                         }
 890                                                 }
 891                                         }
 892                                 }
 893                                 match event {
 894                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
 895                                                 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
 896                                                                 log_pubkey!(node_id),
 897                                                                 log_bytes!(msg.temporary_channel_id));
 898                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 899                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
 900                                                         });
 901                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 902                                                 self.do_attempt_write_data(&mut descriptor, peer);
 903                                         },
 904                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
 905                                                 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
 906                                                                 log_pubkey!(node_id),
 907                                                                 log_bytes!(msg.temporary_channel_id));
 908                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 909                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
 910                                                         });
 911                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 912                                                 self.do_attempt_write_data(&mut descriptor, peer);
 913                                         },
 914                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
 915                                                 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
 916                                                                 log_pubkey!(node_id),
 917                                                                 log_bytes!(msg.temporary_channel_id),
 918                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
 919                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 920                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 921                                                                 //they should just throw away this funding transaction
 922                                                         });
 923                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 924                                                 self.do_attempt_write_data(&mut descriptor, peer);
 925                                         },
 926                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
 927                                                 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
 928                                                                 log_pubkey!(node_id),
 929                                                                 log_bytes!(msg.channel_id));
 930                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 931                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 932                                                                 //they should just throw away this funding transaction
 933                                                         });
 934                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 935                                                 self.do_attempt_write_data(&mut descriptor, peer);
 936                                         },
 937                                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 938                                                 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
 939                                                                 log_pubkey!(node_id),
 940                                                                 log_bytes!(msg.channel_id));
 941                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 942                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 943                                                         });
 944                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 945                                                 self.do_attempt_write_data(&mut descriptor, peer);
 946                                         },
 947                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 948                                                 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
 949                                                                 log_pubkey!(node_id),
 950                                                                 log_bytes!(msg.channel_id));
 951                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 952                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
 953                                                                 //they should just throw away this funding transaction
 954                                                         });
 955                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 956                                                 self.do_attempt_write_data(&mut descriptor, peer);
 957                                         },
 958                                         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 } } => {
 959                                                 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
 960                                                                 log_pubkey!(node_id),
 961                                                                 update_add_htlcs.len(),
 962                                                                 update_fulfill_htlcs.len(),
 963                                                                 update_fail_htlcs.len(),
 964                                                                 log_bytes!(commitment_signed.channel_id));
 965                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 966                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 967                                                         });
 968                                                 for msg in update_add_htlcs {
 969                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 970                                                 }
 971                                                 for msg in update_fulfill_htlcs {
 972                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 973                                                 }
 974                                                 for msg in update_fail_htlcs {
 975                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 976                                                 }
 977                                                 for msg in update_fail_malformed_htlcs {
 978                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 979                                                 }
 980                                                 if let &Some(ref msg) = update_fee {
 981                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 982                                                 }
 983                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
 984                                                 self.do_attempt_write_data(&mut descriptor, peer);
 985                                         },
 986                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 987                                                 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
 988                                                                 log_pubkey!(node_id),
 989                                                                 log_bytes!(msg.channel_id));
 990                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
 991                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
 992                                                         });
 993                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
 994                                                 self.do_attempt_write_data(&mut descriptor, peer);
 995                                         },
 996                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 997                                                 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
 998                                                                 log_pubkey!(node_id),
 999                                                                 log_bytes!(msg.channel_id));
1000                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1001                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
1002                                                         });
1003                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1004                                                 self.do_attempt_write_data(&mut descriptor, peer);
1005                                         },
1006                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1007                                                 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1008                                                                 log_pubkey!(node_id),
1009                                                                 log_bytes!(msg.channel_id));
1010                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1011                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
1012                                                         });
1013                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1014                                                 self.do_attempt_write_data(&mut descriptor, peer);
1015                                         },
1016                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1017                                                 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1018                                                                 log_pubkey!(node_id),
1019                                                                 log_bytes!(msg.channel_id));
1020                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1021                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
1022                                                         });
1023                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1024                                                 self.do_attempt_write_data(&mut descriptor, peer);
1025                                         },
1026                                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1027                                                 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1028                                                 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1029                                                         let encoded_msg = encode_msg!(msg);
1030                                                         let encoded_update_msg = encode_msg!(update_msg);
1031
1032                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1033                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1034                                                                                 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1035                                                                         continue
1036                                                                 }
1037                                                                 match peer.their_node_id {
1038                                                                         None => continue,
1039                                                                         Some(their_node_id) => {
1040                                                                                 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1041                                                                                         continue
1042                                                                                 }
1043                                                                         }
1044                                                                 }
1045                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1046                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1047                                                                 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1048                                                         }
1049                                                 }
1050                                         },
1051                                         MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1052                                                 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1053                                                 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1054                                                         let encoded_msg = encode_msg!(msg);
1055
1056                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1057                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1058                                                                                 !peer.should_forward_node_announcement(msg.contents.node_id) {
1059                                                                         continue
1060                                                                 }
1061                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1062                                                                 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1063                                                         }
1064                                                 }
1065                                         },
1066                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1067                                                 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1068                                                 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1069                                                         let encoded_msg = encode_msg!(msg);
1070
1071                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1072                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1073                                                                                 !peer.should_forward_channel_announcement(msg.contents.short_channel_id)  {
1074                                                                         continue
1075                                                                 }
1076                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1077                                                                 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1078                                                         }
1079                                                 }
1080                                         },
1081                                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1082                                                 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1083                                         },
1084                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
1085                                                 match *action {
1086                                                         msgs::ErrorAction::DisconnectPeer { ref msg } => {
1087                                                                 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1088                                                                         peers.peers_needing_send.remove(&descriptor);
1089                                                                         if let Some(mut peer) = peers.peers.remove(&descriptor) {
1090                                                                                 if let Some(ref msg) = *msg {
1091                                                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1092                                                                                                         log_pubkey!(node_id),
1093                                                                                                         msg.data);
1094                                                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1095                                                                                         // This isn't guaranteed to work, but if there is enough free
1096                                                                                         // room in the send buffer, put the error message there...
1097                                                                                         self.do_attempt_write_data(&mut descriptor, &mut peer);
1098                                                                                 } else {
1099                                                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1100                                                                                 }
1101                                                                         }
1102                                                                         descriptor.disconnect_socket();
1103                                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1104                                                                 }
1105                                                         },
1106                                                         msgs::ErrorAction::IgnoreError => {},
1107                                                         msgs::ErrorAction::SendErrorMessage { ref msg } => {
1108                                                                 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1109                                                                                 log_pubkey!(node_id),
1110                                                                                 msg.data);
1111                                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1112                                                                         //TODO: Do whatever we're gonna do for handling dropped messages
1113                                                                 });
1114                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1115                                                                 self.do_attempt_write_data(&mut descriptor, peer);
1116                                                         },
1117                                                 }
1118                                         }
1119                                 }
1120                         }
1121
1122                         for mut descriptor in peers.peers_needing_send.drain() {
1123                                 match peers.peers.get_mut(&descriptor) {
1124                                         Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1125                                         None => panic!("Inconsistent peers set state!"),
1126                                 }
1127                         }
1128                 }
1129         }
1130
1131         /// Indicates that the given socket descriptor's connection is now closed.
1132         ///
1133         /// This must only be called if the socket has been disconnected by the peer or your own
1134         /// decision to disconnect it and must NOT be called in any case where other parts of this
1135         /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1136         /// the peer.
1137         ///
1138         /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1139         pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1140                 self.disconnect_event_internal(descriptor, false);
1141         }
1142
1143         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1144                 let mut peers = self.peers.lock().unwrap();
1145                 peers.peers_needing_send.remove(descriptor);
1146                 let peer_option = peers.peers.remove(descriptor);
1147                 match peer_option {
1148                         None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1149                         Some(peer) => {
1150                                 match peer.their_node_id {
1151                                         Some(node_id) => {
1152                                                 peers.node_id_to_descriptor.remove(&node_id);
1153                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1154                                         },
1155                                         None => {}
1156                                 }
1157                         }
1158                 };
1159         }
1160
1161         /// This function should be called roughly once every 30 seconds.
1162         /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1163
1164         /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1165         pub fn timer_tick_occured(&self) {
1166                 let mut peers_lock = self.peers.lock().unwrap();
1167                 {
1168                         let peers = &mut *peers_lock;
1169                         let peers_needing_send = &mut peers.peers_needing_send;
1170                         let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1171                         let peers = &mut peers.peers;
1172                         let mut descriptors_needing_disconnect = Vec::new();
1173
1174                         peers.retain(|descriptor, peer| {
1175                                 if peer.awaiting_pong {
1176                                         peers_needing_send.remove(descriptor);
1177                                         descriptors_needing_disconnect.push(descriptor.clone());
1178                                         match peer.their_node_id {
1179                                                 Some(node_id) => {
1180                                                         log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1181                                                         node_id_to_descriptor.remove(&node_id);
1182                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1183                                                 }
1184                                                 None => {
1185                                                         // This can't actually happen as we should have hit
1186                                                         // is_ready_for_encryption() previously on this same peer.
1187                                                         unreachable!();
1188                                                 },
1189                                         }
1190                                         return false;
1191                                 }
1192
1193                                 if !peer.channel_encryptor.is_ready_for_encryption() {
1194                                         // The peer needs to complete its handshake before we can exchange messages
1195                                         return true;
1196                                 }
1197
1198                                 let ping = msgs::Ping {
1199                                         ponglen: 0,
1200                                         byteslen: 64,
1201                                 };
1202                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1203
1204                                 let mut descriptor_clone = descriptor.clone();
1205                                 self.do_attempt_write_data(&mut descriptor_clone, peer);
1206
1207                                 peer.awaiting_pong = true;
1208                                 true
1209                         });
1210
1211                         for mut descriptor in descriptors_needing_disconnect.drain(..) {
1212                                 descriptor.disconnect_socket();
1213                         }
1214                 }
1215         }
1216 }
1217
1218 #[cfg(test)]
1219 mod tests {
1220         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1221         use ln::msgs;
1222         use util::events;
1223         use util::test_utils;
1224
1225         use bitcoin::secp256k1::Secp256k1;
1226         use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1227
1228         use std;
1229         use std::sync::{Arc, Mutex};
1230         use std::sync::atomic::Ordering;
1231
1232         #[derive(Clone)]
1233         struct FileDescriptor {
1234                 fd: u16,
1235                 outbound_data: Arc<Mutex<Vec<u8>>>,
1236         }
1237         impl PartialEq for FileDescriptor {
1238                 fn eq(&self, other: &Self) -> bool {
1239                         self.fd == other.fd
1240                 }
1241         }
1242         impl Eq for FileDescriptor { }
1243         impl std::hash::Hash for FileDescriptor {
1244                 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1245                         self.fd.hash(hasher)
1246                 }
1247         }
1248
1249         impl SocketDescriptor for FileDescriptor {
1250                 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1251                         self.outbound_data.lock().unwrap().extend_from_slice(data);
1252                         data.len()
1253                 }
1254
1255                 fn disconnect_socket(&mut self) {}
1256         }
1257
1258         struct PeerManagerCfg {
1259                 chan_handler: test_utils::TestChannelMessageHandler,
1260                 routing_handler: test_utils::TestRoutingMessageHandler,
1261                 logger: test_utils::TestLogger,
1262         }
1263
1264         fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1265                 let mut cfgs = Vec::new();
1266                 for _ in 0..peer_count {
1267                         cfgs.push(
1268                                 PeerManagerCfg{
1269                                         chan_handler: test_utils::TestChannelMessageHandler::new(),
1270                                         logger: test_utils::TestLogger::new(),
1271                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
1272                                 }
1273                         );
1274                 }
1275
1276                 cfgs
1277         }
1278
1279         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>> {
1280                 let mut peers = Vec::new();
1281                 for i in 0..peer_count {
1282                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1283                         let ephemeral_bytes = [i as u8; 32];
1284                         let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1285                         let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1286                         peers.push(peer);
1287                 }
1288
1289                 peers
1290         }
1291
1292         fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>) -> (FileDescriptor, FileDescriptor) {
1293                 let secp_ctx = Secp256k1::new();
1294                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1295                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1296                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1297                 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1298                 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1299                 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1300                 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1301                 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1302                 (fd_a.clone(), fd_b.clone())
1303         }
1304
1305         fn establish_connection_and_read_events<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>) -> (FileDescriptor, FileDescriptor) {
1306                 let (mut fd_a, mut fd_b) = establish_connection(peer_a, peer_b);
1307                 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1308                 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1309                 (fd_a.clone(), fd_b.clone())
1310         }
1311
1312         #[test]
1313         fn test_disconnect_peer() {
1314                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1315                 // push a DisconnectPeer event to remove the node flagged by id
1316                 let cfgs = create_peermgr_cfgs(2);
1317                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1318                 let mut peers = create_network(2, &cfgs);
1319                 establish_connection(&peers[0], &peers[1]);
1320                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1321
1322                 let secp_ctx = Secp256k1::new();
1323                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1324
1325                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1326                         node_id: their_id,
1327                         action: msgs::ErrorAction::DisconnectPeer { msg: None },
1328                 });
1329                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1330                 peers[0].message_handler.chan_handler = &chan_handler;
1331
1332                 peers[0].process_events();
1333                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1334         }
1335
1336         #[test]
1337         fn test_timer_tick_occurred() {
1338                 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1339                 let cfgs = create_peermgr_cfgs(2);
1340                 let peers = create_network(2, &cfgs);
1341                 establish_connection(&peers[0], &peers[1]);
1342                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1343
1344                 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1345                 peers[0].timer_tick_occured();
1346                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1347
1348                 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1349                 peers[0].timer_tick_occured();
1350                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1351         }
1352
1353         #[test]
1354         fn test_do_attempt_write_data() {
1355                 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1356                 let cfgs = create_peermgr_cfgs(2);
1357                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1358                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1359                 let peers = create_network(2, &cfgs);
1360
1361                 // By calling establish_connect, we trigger do_attempt_write_data between
1362                 // the peers. Previously this function would mistakenly enter an infinite loop
1363                 // when there were more channel messages available than could fit into a peer's
1364                 // buffer. This issue would now be detected by this test (because we use custom
1365                 // RoutingMessageHandlers that intentionally return more channel messages
1366                 // than can fit into a peer's buffer).
1367                 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1368
1369                 // Make each peer to read the messages that the other peer just wrote to them.
1370                 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1371                 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1372
1373                 // Check that each peer has received the expected number of channel updates and channel
1374                 // announcements.
1375                 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1376                 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1377                 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1378                 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1379         }
1380
1381         #[test]
1382         fn limit_initial_routing_sync_requests() {
1383                 // Inbound peer 0 requests initial_routing_sync, but outbound peer 1 does not.
1384                 {
1385                         let cfgs = create_peermgr_cfgs(2);
1386                         cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1387                         let peers = create_network(2, &cfgs);
1388                         let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1389
1390                         let peer_0 = peers[0].peers.lock().unwrap();
1391                         let peer_1 = peers[1].peers.lock().unwrap();
1392
1393                         let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1394                         let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1395
1396                         assert!(peer_0_features.unwrap().initial_routing_sync());
1397                         assert!(!peer_1_features.unwrap().initial_routing_sync());
1398                 }
1399
1400                 // Outbound peer 1 requests initial_routing_sync, but inbound peer 0 does not.
1401                 {
1402                         let cfgs = create_peermgr_cfgs(2);
1403                         cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1404                         let peers = create_network(2, &cfgs);
1405                         let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1406
1407                         let peer_0 = peers[0].peers.lock().unwrap();
1408                         let peer_1 = peers[1].peers.lock().unwrap();
1409
1410                         let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1411                         let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1412
1413                         assert!(!peer_0_features.unwrap().initial_routing_sync());
1414                         assert!(peer_1_features.unwrap().initial_routing_sync());
1415                 }
1416         }
1417 }