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