Add logging for (dis)connect in peer_handler/channelmanager
[rust-lightning] / src / ln / peer_handler.rs
1 //! Top level peer message handling and socket handling logic lives here.
2 //!
3 //! Instead of actually servicing sockets ourselves we require that you implement the
4 //! SocketDescriptor interface and use that to receive actions which you should perform on the
5 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
6 //! call into the provided message handlers (probably a ChannelManager and Router) with messages
7 //! they should handle, and encoding/sending response messages.
8
9 use secp256k1::key::{SecretKey,PublicKey};
10
11 use ln::msgs;
12 use util::ser::{Writeable, Writer, Readable};
13 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
14 use util::byte_utils;
15 use util::events::{MessageSendEvent};
16 use util::logger::Logger;
17
18 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
19 use std::sync::{Arc, Mutex};
20 use std::sync::atomic::{AtomicUsize, Ordering};
21 use std::{cmp,error,hash,fmt};
22
23 /// Provides references to trait impls which handle different types of messages.
24 pub struct MessageHandler {
25         /// A message handler which handles messages specific to channels. Usually this is just a
26         /// ChannelManager object.
27         pub chan_handler: Arc<msgs::ChannelMessageHandler>,
28         /// A message handler which handles messages updating our knowledge of the network channel
29         /// graph. Usually this is just a Router object.
30         pub route_handler: Arc<msgs::RoutingMessageHandler>,
31 }
32
33 /// Provides an object which can be used to send data to and which uniquely identifies a connection
34 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
35 /// implement Hash to meet the PeerManager API.
36 ///
37 /// For efficiency, Clone should be relatively cheap for this type.
38 ///
39 /// You probably want to just extend an int and put a file descriptor in a struct and implement
40 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
41 /// careful to ensure you don't have races whereby you might register a new connection with an fd
42 /// the same as a yet-to-be-disconnect_event()-ed.
43 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
44         /// Attempts to send some data from the given Vec starting at the given offset to the peer.
45         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
46         /// Note that in the disconnected case, a disconnect_event must still fire and further write
47         /// attempts may occur until that time.
48         ///
49         /// If the returned size is smaller than data.len() - write_offset, a write_available event must
50         /// trigger the next time more data can be written. Additionally, until the a send_data event
51         /// completes fully, no further read_events should trigger on the same peer!
52         ///
53         /// If a read_event on this descriptor had previously returned true (indicating that read
54         /// events should be paused to prevent DoS in the send buffer), resume_read may be set
55         /// indicating that read events on this descriptor should resume. A resume_read of false does
56         /// *not* imply that further read events should be paused.
57         fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
58         /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
59         /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
60         /// No disconnect_event should be generated as a result of this call, though obviously races
61         /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
62         /// that event completing.
63         fn disconnect_socket(&mut self);
64 }
65
66 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
67 /// generate no further read/write_events for the descriptor, only triggering a single
68 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
69 /// no such disconnect_event must be generated and the socket be silently disconencted).
70 pub struct PeerHandleError {
71         /// Used to indicate that we probably can't make any future connections to this peer, implying
72         /// we should go ahead and force-close any channels we have with it.
73         no_connection_possible: bool,
74 }
75 impl fmt::Debug for PeerHandleError {
76         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
77                 formatter.write_str("Peer Sent Invalid Data")
78         }
79 }
80 impl fmt::Display for PeerHandleError {
81         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
82                 formatter.write_str("Peer Sent Invalid Data")
83         }
84 }
85 impl error::Error for PeerHandleError {
86         fn description(&self) -> &str {
87                 "Peer Sent Invalid Data"
88         }
89 }
90
91 struct Peer {
92         channel_encryptor: PeerChannelEncryptor,
93         outbound: bool,
94         their_node_id: Option<PublicKey>,
95         their_global_features: Option<msgs::GlobalFeatures>,
96         their_local_features: Option<msgs::LocalFeatures>,
97
98         pending_outbound_buffer: LinkedList<Vec<u8>>,
99         pending_outbound_buffer_first_msg_offset: usize,
100         awaiting_write_event: bool,
101
102         pending_read_buffer: Vec<u8>,
103         pending_read_buffer_pos: usize,
104         pending_read_is_header: bool,
105 }
106
107 struct PeerHolder<Descriptor: SocketDescriptor> {
108         peers: HashMap<Descriptor, Peer>,
109         /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
110         /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
111         peers_needing_send: HashSet<Descriptor>,
112         /// Only add to this set when noise completes:
113         node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
114 }
115 struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
116         peers: &'a mut HashMap<Descriptor, Peer>,
117         peers_needing_send: &'a mut HashSet<Descriptor>,
118         node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
119 }
120 impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
121         fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
122                 MutPeerHolder {
123                         peers: &mut self.peers,
124                         peers_needing_send: &mut self.peers_needing_send,
125                         node_id_to_descriptor: &mut self.node_id_to_descriptor,
126                 }
127         }
128 }
129
130 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
131 /// events into messages which it passes on to its MessageHandlers.
132 pub struct PeerManager<Descriptor: SocketDescriptor> {
133         message_handler: MessageHandler,
134         peers: Mutex<PeerHolder<Descriptor>>,
135         our_node_secret: SecretKey,
136         initial_syncs_sent: AtomicUsize,
137         logger: Arc<Logger>,
138 }
139
140 struct VecWriter(Vec<u8>);
141 impl Writer for VecWriter {
142         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
143                 self.0.extend_from_slice(buf);
144                 Ok(())
145         }
146         fn size_hint(&mut self, size: usize) {
147                 self.0.reserve_exact(size);
148         }
149 }
150
151 macro_rules! encode_msg {
152         ($msg: expr, $msg_code: expr) => {{
153                 let mut msg = VecWriter(Vec::new());
154                 ($msg_code as u16).write(&mut msg).unwrap();
155                 $msg.write(&mut msg).unwrap();
156                 msg.0
157         }}
158 }
159
160 //TODO: Really should do something smarter for this
161 const INITIAL_SYNCS_TO_SEND: usize = 5;
162
163 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
164 /// PeerIds may repeat, but only after disconnect_event() has been called.
165 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
166         /// Constructs a new PeerManager with the given message handlers and node_id secret key
167         pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, logger: Arc<Logger>) -> PeerManager<Descriptor> {
168                 PeerManager {
169                         message_handler: message_handler,
170                         peers: Mutex::new(PeerHolder {
171                                 peers: HashMap::new(),
172                                 peers_needing_send: HashSet::new(),
173                                 node_id_to_descriptor: HashMap::new()
174                         }),
175                         our_node_secret: our_node_secret,
176                         initial_syncs_sent: AtomicUsize::new(0),
177                         logger,
178                 }
179         }
180
181         /// Get the list of node ids for peers which have completed the initial handshake.
182         ///
183         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
184         /// new_outbound_connection, however entries will only appear once the initial handshake has
185         /// completed and we are sure the remote peer has the private key for the given node_id.
186         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
187                 let peers = self.peers.lock().unwrap();
188                 peers.peers.values().filter_map(|p| {
189                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_global_features.is_none() {
190                                 return None;
191                         }
192                         p.their_node_id
193                 }).collect()
194         }
195
196         /// Indicates a new outbound connection has been established to a node with the given node_id.
197         /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
198         /// descriptor but must disconnect the connection immediately.
199         ///
200         /// Returns a small number of bytes to send to the remote node (currently always 50).
201         ///
202         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
203         /// disconnect_event.
204         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
205                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
206                 let res = peer_encryptor.get_act_one().to_vec();
207                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
208
209                 let mut peers = self.peers.lock().unwrap();
210                 if peers.peers.insert(descriptor, Peer {
211                         channel_encryptor: peer_encryptor,
212                         outbound: true,
213                         their_node_id: Some(their_node_id),
214                         their_global_features: None,
215                         their_local_features: None,
216
217                         pending_outbound_buffer: LinkedList::new(),
218                         pending_outbound_buffer_first_msg_offset: 0,
219                         awaiting_write_event: false,
220
221                         pending_read_buffer: pending_read_buffer,
222                         pending_read_buffer_pos: 0,
223                         pending_read_is_header: false,
224                 }).is_some() {
225                         panic!("PeerManager driver duplicated descriptors!");
226                 };
227                 Ok(res)
228         }
229
230         /// Indicates a new inbound connection has been established.
231         ///
232         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
233         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
234         /// call disconnect_event for the new descriptor but must disconnect the connection
235         /// immediately.
236         ///
237         /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
238         /// disconnect_event.
239         pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
240                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
241                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
242
243                 let mut peers = self.peers.lock().unwrap();
244                 if peers.peers.insert(descriptor, Peer {
245                         channel_encryptor: peer_encryptor,
246                         outbound: false,
247                         their_node_id: None,
248                         their_global_features: None,
249                         their_local_features: None,
250
251                         pending_outbound_buffer: LinkedList::new(),
252                         pending_outbound_buffer_first_msg_offset: 0,
253                         awaiting_write_event: false,
254
255                         pending_read_buffer: pending_read_buffer,
256                         pending_read_buffer_pos: 0,
257                         pending_read_is_header: false,
258                 }).is_some() {
259                         panic!("PeerManager driver duplicated descriptors!");
260                 };
261                 Ok(())
262         }
263
264         fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
265                 while !peer.awaiting_write_event {
266                         if {
267                                 let next_buff = match peer.pending_outbound_buffer.front() {
268                                         None => return,
269                                         Some(buff) => buff,
270                                 };
271                                 let should_be_reading = peer.pending_outbound_buffer.len() < 10;
272
273                                 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
274                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
275                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
276                         } {
277                                 peer.pending_outbound_buffer_first_msg_offset = 0;
278                                 peer.pending_outbound_buffer.pop_front();
279                         } else {
280                                 peer.awaiting_write_event = true;
281                         }
282                 }
283         }
284
285         /// Indicates that there is room to write data to the given socket descriptor.
286         ///
287         /// May return an Err to indicate that the connection should be closed.
288         ///
289         /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
290         /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
291         /// invariants around calling write_event in case a write did not fully complete must still
292         /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
293         /// Panics if the descriptor was not previously registered in a new_\*_connection event.
294         pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
295                 let mut peers = self.peers.lock().unwrap();
296                 match peers.peers.get_mut(descriptor) {
297                         None => panic!("Descriptor for write_event is not already known to PeerManager"),
298                         Some(peer) => {
299                                 peer.awaiting_write_event = false;
300                                 Self::do_attempt_write_data(descriptor, peer);
301                         }
302                 };
303                 Ok(())
304         }
305
306         /// Indicates that data was read from the given socket descriptor.
307         ///
308         /// May return an Err to indicate that the connection should be closed.
309         ///
310         /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
311         /// Thus, however, you almost certainly want to call process_events() after any read_event to
312         /// generate send_data calls to handle responses.
313         ///
314         /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
315         /// this file descriptor has resume_read set (preventing DoS issues in the send buffer).
316         ///
317         /// Panics if the descriptor was not previously registered in a new_*_connection event.
318         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
319                 match self.do_read_event(peer_descriptor, data) {
320                         Ok(res) => Ok(res),
321                         Err(e) => {
322                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
323                                 Err(e)
324                         }
325                 }
326         }
327
328         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
329                 let pause_read = {
330                         let mut peers_lock = self.peers.lock().unwrap();
331                         let peers = peers_lock.borrow_parts();
332                         let pause_read = match peers.peers.get_mut(peer_descriptor) {
333                                 None => panic!("Descriptor for read_event is not already known to PeerManager"),
334                                 Some(peer) => {
335                                         assert!(peer.pending_read_buffer.len() > 0);
336                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
337
338                                         let mut read_pos = 0;
339                                         while read_pos < data.len() {
340                                                 {
341                                                         let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
342                                                         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]);
343                                                         read_pos += data_to_copy;
344                                                         peer.pending_read_buffer_pos += data_to_copy;
345                                                 }
346
347                                                 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
348                                                         peer.pending_read_buffer_pos = 0;
349
350                                                         macro_rules! encode_and_send_msg {
351                                                                 ($msg: expr, $msg_code: expr) => {
352                                                                         {
353                                                                                 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
354                                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
355                                                                                 peers.peers_needing_send.insert(peer_descriptor.clone());
356                                                                         }
357                                                                 }
358                                                         }
359
360                                                         macro_rules! try_potential_handleerror {
361                                                                 ($thing: expr) => {
362                                                                         match $thing {
363                                                                                 Ok(x) => x,
364                                                                                 Err(e) => {
365                                                                                         if let Some(action) = e.action {
366                                                                                                 match action {
367                                                                                                         msgs::ErrorAction::DisconnectPeer { msg: _ } => {
368                                                                                                                 //TODO: Try to push msg
369                                                                                                                 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
370                                                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
371                                                                                                         },
372                                                                                                         msgs::ErrorAction::IgnoreError => {
373                                                                                                                 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
374                                                                                                                 continue;
375                                                                                                         },
376                                                                                                         msgs::ErrorAction::SendErrorMessage { msg } => {
377                                                                                                                 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
378                                                                                                                 encode_and_send_msg!(msg, 17);
379                                                                                                                 continue;
380                                                                                                         },
381                                                                                                 }
382                                                                                         } else {
383                                                                                                 log_debug!(self, "Got Err handling message, action not yet filled in: {}", e.err);
384                                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
385                                                                                         }
386                                                                                 }
387                                                                         };
388                                                                 }
389                                                         }
390
391                                                         macro_rules! try_potential_decodeerror {
392                                                                 ($thing: expr) => {
393                                                                         match $thing {
394                                                                                 Ok(x) => x,
395                                                                                 Err(e) => {
396                                                                                         match e {
397                                                                                                 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
398                                                                                                 msgs::DecodeError::UnknownRequiredFeature => {
399                                                                                                         log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to udpate!");
400                                                                                                         continue;
401                                                                                                 },
402                                                                                                 msgs::DecodeError::InvalidValue => return Err(PeerHandleError{ no_connection_possible: false }),
403                                                                                                 msgs::DecodeError::ShortRead => return Err(PeerHandleError{ no_connection_possible: false }),
404                                                                                                 msgs::DecodeError::ExtraAddressesPerType => {
405                                                                                                         log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
406                                                                                                         continue;
407                                                                                                 },
408                                                                                                 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
409                                                                                                 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
410                                                                                         }
411                                                                                 }
412                                                                         };
413                                                                 }
414                                                         }
415
416                                                         macro_rules! insert_node_id {
417                                                                 () => {
418                                                                         match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
419                                                                                 hash_map::Entry::Occupied(_) => {
420                                                                                         log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
421                                                                                         peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
422                                                                                         return Err(PeerHandleError{ no_connection_possible: false })
423                                                                                 },
424                                                                                 hash_map::Entry::Vacant(entry) => {
425                                                                                         log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
426                                                                                         entry.insert(peer_descriptor.clone())
427                                                                                 },
428                                                                         };
429                                                                 }
430                                                         }
431
432                                                         let next_step = peer.channel_encryptor.get_noise_step();
433                                                         match next_step {
434                                                                 NextNoiseStep::ActOne => {
435                                                                         let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
436                                                                         peer.pending_outbound_buffer.push_back(act_two);
437                                                                         peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
438                                                                 },
439                                                                 NextNoiseStep::ActTwo => {
440                                                                         let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
441                                                                         peer.pending_outbound_buffer.push_back(act_three);
442                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
443                                                                         peer.pending_read_is_header = true;
444
445                                                                         insert_node_id!();
446                                                                         let mut local_features = msgs::LocalFeatures::new();
447                                                                         if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
448                                                                                 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
449                                                                                 local_features.set_initial_routing_sync();
450                                                                         }
451                                                                         encode_and_send_msg!(msgs::Init {
452                                                                                 global_features: msgs::GlobalFeatures::new(),
453                                                                                 local_features,
454                                                                         }, 16);
455                                                                 },
456                                                                 NextNoiseStep::ActThree => {
457                                                                         let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
458                                                                         peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
459                                                                         peer.pending_read_is_header = true;
460                                                                         peer.their_node_id = Some(their_node_id);
461                                                                         insert_node_id!();
462                                                                 },
463                                                                 NextNoiseStep::NoiseComplete => {
464                                                                         if peer.pending_read_is_header {
465                                                                                 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
466                                                                                 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
467                                                                                 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
468                                                                                 if msg_len < 2 { // Need at least the message type tag
469                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
470                                                                                 }
471                                                                                 peer.pending_read_is_header = false;
472                                                                         } else {
473                                                                                 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
474                                                                                 assert!(msg_data.len() >= 2);
475
476                                                                                 // Reset read buffer
477                                                                                 peer.pending_read_buffer = [0; 18].to_vec();
478                                                                                 peer.pending_read_is_header = true;
479
480                                                                                 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
481                                                                                 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
482                                                                                 if msg_type != 16 && peer.their_global_features.is_none() {
483                                                                                         // Need an init message as first message
484                                                                                         log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
485                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
486                                                                                 }
487                                                                                 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
488                                                                                 match msg_type {
489                                                                                         // Connection control:
490                                                                                         16 => {
491                                                                                                 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
492                                                                                                 if msg.global_features.requires_unknown_bits() {
493                                                                                                         log_info!(self, "Peer global features required unknown version bits");
494                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
495                                                                                                 }
496                                                                                                 if msg.local_features.requires_unknown_bits() {
497                                                                                                         log_info!(self, "Peer local features required unknown version bits");
498                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
499                                                                                                 }
500                                                                                                 if msg.local_features.requires_data_loss_protect() {
501                                                                                                         log_info!(self, "Peer local features required data_loss_protect");
502                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
503                                                                                                 }
504                                                                                                 if msg.local_features.requires_upfront_shutdown_script() {
505                                                                                                         log_info!(self, "Peer local features required upfront_shutdown_script");
506                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
507                                                                                                 }
508                                                                                                 if peer.their_global_features.is_some() {
509                                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
510                                                                                                 }
511
512                                                                                                 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
513                                                                                                         if msg.local_features.supports_data_loss_protect() { "supported" } else { "not supported"},
514                                                                                                         if msg.local_features.initial_routing_sync() { "requested" } else { "not requested" },
515                                                                                                         if msg.local_features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
516                                                                                                         if msg.local_features.supports_unknown_bits() { "present" } else { "none" },
517                                                                                                         if msg.global_features.supports_unknown_bits() { "present" } else { "none" });
518
519                                                                                                 peer.their_global_features = Some(msg.global_features);
520                                                                                                 peer.their_local_features = Some(msg.local_features);
521
522                                                                                                 if !peer.outbound {
523                                                                                                         let mut local_features = msgs::LocalFeatures::new();
524                                                                                                         if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
525                                                                                                                 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
526                                                                                                                 local_features.set_initial_routing_sync();
527                                                                                                         }
528                                                                                                         encode_and_send_msg!(msgs::Init {
529                                                                                                                 global_features: msgs::GlobalFeatures::new(),
530                                                                                                                 local_features,
531                                                                                                         }, 16);
532                                                                                                 }
533
534                                                                                                 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap());
535                                                                                         },
536                                                                                         17 => {
537                                                                                                 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
538                                                                                                 let mut data_is_printable = true;
539                                                                                                 for b in msg.data.bytes() {
540                                                                                                         if b < 32 || b > 126 {
541                                                                                                                 data_is_printable = false;
542                                                                                                                 break;
543                                                                                                         }
544                                                                                                 }
545
546                                                                                                 if data_is_printable {
547                                                                                                         log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
548                                                                                                 } else {
549                                                                                                         log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
550                                                                                                 }
551                                                                                                 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
552                                                                                                 if msg.channel_id == [0; 32] {
553                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
554                                                                                                 }
555                                                                                         },
556
557                                                                                         18 => {
558                                                                                                 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
559                                                                                                 if msg.ponglen < 65532 {
560                                                                                                         let resp = msgs::Pong { byteslen: msg.ponglen };
561                                                                                                         encode_and_send_msg!(resp, 19);
562                                                                                                 }
563                                                                                         },
564                                                                                         19 => {
565                                                                                                 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
566                                                                                         },
567
568                                                                                         // Channel control:
569                                                                                         32 => {
570                                                                                                 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
571                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
572                                                                                         },
573                                                                                         33 => {
574                                                                                                 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
575                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
576                                                                                         },
577
578                                                                                         34 => {
579                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
580                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
581                                                                                         },
582                                                                                         35 => {
583                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
584                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
585                                                                                         },
586                                                                                         36 => {
587                                                                                                 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
588                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
589                                                                                         },
590
591                                                                                         38 => {
592                                                                                                 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
593                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
594                                                                                         },
595                                                                                         39 => {
596                                                                                                 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
597                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
598                                                                                         },
599
600                                                                                         128 => {
601                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
602                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
603                                                                                         },
604                                                                                         130 => {
605                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
606                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
607                                                                                         },
608                                                                                         131 => {
609                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
610                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
611                                                                                         },
612                                                                                         135 => {
613                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
614                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
615                                                                                         },
616
617                                                                                         132 => {
618                                                                                                 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
619                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
620                                                                                         },
621                                                                                         133 => {
622                                                                                                 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
623                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
624                                                                                         },
625                                                                                         134 => {
626                                                                                                 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
627                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
628                                                                                         },
629                                                                                         136 => {
630                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
631                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg));
632                                                                                         },
633
634                                                                                         // Routing control:
635                                                                                         259 => {
636                                                                                                 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
637                                                                                                 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
638                                                                                         },
639                                                                                         256 => {
640                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
641                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
642
643                                                                                                 if should_forward {
644                                                                                                         // TODO: forward msg along to all our other peers!
645                                                                                                 }
646                                                                                         },
647                                                                                         257 => {
648                                                                                                 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
649                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
650
651                                                                                                 if should_forward {
652                                                                                                         // TODO: forward msg along to all our other peers!
653                                                                                                 }
654                                                                                         },
655                                                                                         258 => {
656                                                                                                 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
657                                                                                                 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
658
659                                                                                                 if should_forward {
660                                                                                                         // TODO: forward msg along to all our other peers!
661                                                                                                 }
662                                                                                         },
663                                                                                         _ => {
664                                                                                                 if (msg_type & 1) == 0 {
665                                                                                                         return Err(PeerHandleError{ no_connection_possible: true });
666                                                                                                 }
667                                                                                         },
668                                                                                 }
669                                                                         }
670                                                                 }
671                                                         }
672                                                 }
673                                         }
674
675                                         Self::do_attempt_write_data(peer_descriptor, peer);
676
677                                         peer.pending_outbound_buffer.len() > 10 // pause_read
678                                 }
679                         };
680
681                         pause_read
682                 };
683
684                 Ok(pause_read)
685         }
686
687         /// Checks for any events generated by our handlers and processes them. Includes sending most
688         /// response messages as well as messages generated by calls to handler functions directly (eg
689         /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
690         pub fn process_events(&self) {
691                 {
692                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
693                         // buffer by doing things like announcing channels on another node. We should be willing to
694                         // drop optional-ish messages when send buffers get full!
695
696                         let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
697                         let mut peers_lock = self.peers.lock().unwrap();
698                         let peers = peers_lock.borrow_parts();
699                         for event in events_generated.drain(..) {
700                                 macro_rules! get_peer_for_forwarding {
701                                         ($node_id: expr, $handle_no_such_peer: block) => {
702                                                 {
703                                                         let descriptor = match peers.node_id_to_descriptor.get($node_id) {
704                                                                 Some(descriptor) => descriptor.clone(),
705                                                                 None => {
706                                                                         $handle_no_such_peer;
707                                                                         continue;
708                                                                 },
709                                                         };
710                                                         match peers.peers.get_mut(&descriptor) {
711                                                                 Some(peer) => {
712                                                                         if peer.their_global_features.is_none() {
713                                                                                 $handle_no_such_peer;
714                                                                                 continue;
715                                                                         }
716                                                                         (descriptor, peer)
717                                                                 },
718                                                                 None => panic!("Inconsistent peers set state!"),
719                                                         }
720                                                 }
721                                         }
722                                 }
723                                 match event {
724                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
725                                                 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
726                                                                 log_pubkey!(node_id),
727                                                                 log_bytes!(msg.temporary_channel_id));
728                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
729                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
730                                                         });
731                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
732                                                 Self::do_attempt_write_data(&mut descriptor, peer);
733                                         },
734                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
735                                                 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
736                                                                 log_pubkey!(node_id),
737                                                                 log_bytes!(msg.temporary_channel_id));
738                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
739                                                                 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
740                                                         });
741                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
742                                                 Self::do_attempt_write_data(&mut descriptor, peer);
743                                         },
744                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
745                                                 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
746                                                                 log_pubkey!(node_id),
747                                                                 log_bytes!(msg.temporary_channel_id),
748                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
749                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
750                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
751                                                                 //they should just throw away this funding transaction
752                                                         });
753                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
754                                                 Self::do_attempt_write_data(&mut descriptor, peer);
755                                         },
756                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
757                                                 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
758                                                                 log_pubkey!(node_id),
759                                                                 log_bytes!(msg.channel_id));
760                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
761                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
762                                                                 //they should just throw away this funding transaction
763                                                         });
764                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
765                                                 Self::do_attempt_write_data(&mut descriptor, peer);
766                                         },
767                                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
768                                                 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
769                                                                 log_pubkey!(node_id),
770                                                                 log_bytes!(msg.channel_id));
771                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
772                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
773                                                         });
774                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
775                                                 Self::do_attempt_write_data(&mut descriptor, peer);
776                                         },
777                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
778                                                 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
779                                                                 log_pubkey!(node_id),
780                                                                 log_bytes!(msg.channel_id));
781                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
782                                                                 //TODO: generate a DiscardFunding event indicating to the wallet that
783                                                                 //they should just throw away this funding transaction
784                                                         });
785                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
786                                                 Self::do_attempt_write_data(&mut descriptor, peer);
787                                         },
788                                         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 } } => {
789                                                 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
790                                                                 log_pubkey!(node_id),
791                                                                 update_add_htlcs.len(),
792                                                                 update_fulfill_htlcs.len(),
793                                                                 update_fail_htlcs.len(),
794                                                                 log_bytes!(commitment_signed.channel_id));
795                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
796                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
797                                                         });
798                                                 for msg in update_add_htlcs {
799                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
800                                                 }
801                                                 for msg in update_fulfill_htlcs {
802                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
803                                                 }
804                                                 for msg in update_fail_htlcs {
805                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
806                                                 }
807                                                 for msg in update_fail_malformed_htlcs {
808                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
809                                                 }
810                                                 if let &Some(ref msg) = update_fee {
811                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
812                                                 }
813                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
814                                                 Self::do_attempt_write_data(&mut descriptor, peer);
815                                         },
816                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
817                                                 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
818                                                                 log_pubkey!(node_id),
819                                                                 log_bytes!(msg.channel_id));
820                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
821                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
822                                                         });
823                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
824                                                 Self::do_attempt_write_data(&mut descriptor, peer);
825                                         },
826                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
827                                                 log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
828                                                                 log_pubkey!(node_id),
829                                                                 log_bytes!(msg.channel_id));
830                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
831                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
832                                                         });
833                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 39)));
834                                                 Self::do_attempt_write_data(&mut descriptor, peer);
835                                         },
836                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
837                                                 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
838                                                                 log_pubkey!(node_id),
839                                                                 log_bytes!(msg.channel_id));
840                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
841                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
842                                                         });
843                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
844                                                 Self::do_attempt_write_data(&mut descriptor, peer);
845                                         },
846                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
847                                                 log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
848                                                                 log_pubkey!(node_id),
849                                                                 log_bytes!(msg.channel_id));
850                                                 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
851                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
852                                                         });
853                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 136)));
854                                                 Self::do_attempt_write_data(&mut descriptor, peer);
855                                         },
856                                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
857                                                 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
858                                                 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
859                                                         let encoded_msg = encode_msg!(msg, 256);
860                                                         let encoded_update_msg = encode_msg!(update_msg, 258);
861
862                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
863                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
864                                                                         continue
865                                                                 }
866                                                                 match peer.their_node_id {
867                                                                         None => continue,
868                                                                         Some(their_node_id) => {
869                                                                                 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
870                                                                                         continue
871                                                                                 }
872                                                                         }
873                                                                 }
874                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
875                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
876                                                                 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
877                                                         }
878                                                 }
879                                         },
880                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
881                                                 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
882                                                 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
883                                                         let encoded_msg = encode_msg!(msg, 258);
884
885                                                         for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
886                                                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
887                                                                         continue
888                                                                 }
889                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
890                                                                 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
891                                                         }
892                                                 }
893                                         },
894                                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
895                                                 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
896                                         },
897                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
898                                                 if let Some(ref action) = *action {
899                                                         match *action {
900                                                                 msgs::ErrorAction::DisconnectPeer { ref msg } => {
901                                                                         if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
902                                                                                 peers.peers_needing_send.remove(&descriptor);
903                                                                                 if let Some(mut peer) = peers.peers.remove(&descriptor) {
904                                                                                         if let Some(ref msg) = *msg {
905                                                                                                 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
906                                                                                                                 log_pubkey!(node_id),
907                                                                                                                 msg.data);
908                                                                                                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
909                                                                                                 // This isn't guaranteed to work, but if there is enough free
910                                                                                                 // room in the send buffer, put the error message there...
911                                                                                                 Self::do_attempt_write_data(&mut descriptor, &mut peer);
912                                                                                         } else {
913                                                                                                 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
914                                                                                         }
915                                                                                 }
916                                                                                 descriptor.disconnect_socket();
917                                                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
918                                                                         }
919                                                                 },
920                                                                 msgs::ErrorAction::IgnoreError => {},
921                                                                 msgs::ErrorAction::SendErrorMessage { ref msg } => {
922                                                                         log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
923                                                                                         log_pubkey!(node_id),
924                                                                                         msg.data);
925                                                                         let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
926                                                                                 //TODO: Do whatever we're gonna do for handling dropped messages
927                                                                         });
928                                                                         peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
929                                                                         Self::do_attempt_write_data(&mut descriptor, peer);
930                                                                 },
931                                                         }
932                                                 } else {
933                                                         log_error!(self, "Got no-action HandleError Event in peer_handler for node {}, no such events should ever be generated!", log_pubkey!(node_id));
934                                                 }
935                                         }
936                                 }
937                         }
938
939                         for mut descriptor in peers.peers_needing_send.drain() {
940                                 match peers.peers.get_mut(&descriptor) {
941                                         Some(peer) => Self::do_attempt_write_data(&mut descriptor, peer),
942                                         None => panic!("Inconsistent peers set state!"),
943                                 }
944                         }
945                 }
946         }
947
948         /// Indicates that the given socket descriptor's connection is now closed.
949         ///
950         /// This must be called even if a PeerHandleError was given for a read_event or write_event,
951         /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
952         ///
953         /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
954         pub fn disconnect_event(&self, descriptor: &Descriptor) {
955                 self.disconnect_event_internal(descriptor, false);
956         }
957
958         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
959                 let mut peers = self.peers.lock().unwrap();
960                 peers.peers_needing_send.remove(descriptor);
961                 let peer_option = peers.peers.remove(descriptor);
962                 match peer_option {
963                         None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
964                         Some(peer) => {
965                                 match peer.their_node_id {
966                                         Some(node_id) => {
967                                                 peers.node_id_to_descriptor.remove(&node_id);
968                                                 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
969                                         },
970                                         None => {}
971                                 }
972                         }
973                 };
974         }
975 }
976
977 #[cfg(test)]
978 mod tests {
979         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
980         use ln::msgs;
981         use util::events;
982         use util::test_utils;
983         use util::logger::Logger;
984
985         use secp256k1::Secp256k1;
986         use secp256k1::key::{SecretKey, PublicKey};
987
988         use rand::{thread_rng, Rng};
989
990         use std::sync::{Arc};
991
992         #[derive(PartialEq, Eq, Clone, Hash)]
993         struct FileDescriptor {
994                 fd: u16,
995         }
996
997         impl SocketDescriptor for FileDescriptor {
998                 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, _resume_read: bool) -> usize {
999                         assert!(write_offset < data.len());
1000                         data.len() - write_offset
1001                 }
1002
1003                 fn disconnect_socket(&mut self) {}
1004         }
1005
1006         fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
1007                 let secp_ctx = Secp256k1::new();
1008                 let mut peers = Vec::new();
1009                 let mut rng = thread_rng();
1010                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1011
1012                 for _ in 0..peer_count {
1013                         let chan_handler = test_utils::TestChannelMessageHandler::new();
1014                         let router = test_utils::TestRoutingMessageHandler::new();
1015                         let node_id = {
1016                                 let mut key_slice = [0;32];
1017                                 rng.fill_bytes(&mut key_slice);
1018                                 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
1019                         };
1020                         let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
1021                         let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));
1022                         peers.push(peer);
1023                 }
1024
1025                 peers
1026         }
1027
1028         fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
1029                 let secp_ctx = Secp256k1::new();
1030                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1031                 let fd = FileDescriptor { fd: 1};
1032                 peer_a.new_inbound_connection(fd.clone()).unwrap();
1033                 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1034         }
1035
1036         #[test]
1037         fn test_disconnect_peer() {
1038                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1039                 // push an DisconnectPeer event to remove the node flagged by id
1040                 let mut peers = create_network(2);
1041                 establish_connection(&peers[0], &peers[1]);
1042                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1043
1044                 let secp_ctx = Secp256k1::new();
1045                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1046
1047                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1048                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1049                         node_id: their_id,
1050                         action: Some(msgs::ErrorAction::DisconnectPeer { msg: None }),
1051                 });
1052                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1053                 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
1054
1055                 peers[0].process_events();
1056                 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1057         }
1058 }