1 //! Top level peer message handling and socket handling logic lives here.
3 //! Instead of actually servicing sockets ourselves we require that you implement the
4 //! SocketDescriptor interface and use that to receive actions which you should perform on the
5 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
6 //! call into the provided message handlers (probably a ChannelManager and Router) with messages
7 //! they should handle, and encoding/sending response messages.
9 use secp256k1::key::{SecretKey,PublicKey};
11 use ln::features::InitFeatures;
13 use util::ser::{Writeable, Writer, Readable};
14 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
16 use util::events::{MessageSendEvent};
17 use util::logger::Logger;
19 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
20 use std::sync::{Arc, Mutex};
21 use std::sync::atomic::{AtomicUsize, Ordering};
22 use std::{cmp,error,hash,fmt};
24 use bitcoin_hashes::sha256::Hash as Sha256;
25 use bitcoin_hashes::sha256::HashEngine as Sha256Engine;
26 use bitcoin_hashes::{HashEngine, Hash};
28 /// Provides references to trait impls which handle different types of messages.
29 pub struct MessageHandler {
30 /// A message handler which handles messages specific to channels. Usually this is just a
31 /// ChannelManager object.
32 pub chan_handler: Arc<msgs::ChannelMessageHandler>,
33 /// A message handler which handles messages updating our knowledge of the network channel
34 /// graph. Usually this is just a Router object.
35 pub route_handler: Arc<msgs::RoutingMessageHandler>,
38 /// Provides an object which can be used to send data to and which uniquely identifies a connection
39 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
40 /// implement Hash to meet the PeerManager API.
42 /// For efficiency, Clone should be relatively cheap for this type.
44 /// You probably want to just extend an int and put a file descriptor in a struct and implement
45 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
46 /// careful to ensure you don't have races whereby you might register a new connection with an fd
47 /// the same as a yet-to-be-disconnect_event()-ed.
48 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
49 /// Attempts to send some data from the given slice to the peer.
51 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
52 /// Note that in the disconnected case, a disconnect_event must still fire and further write
53 /// attempts may occur until that time.
55 /// If the returned size is smaller than data.len(), a write_available event must
56 /// trigger the next time more data can be written. Additionally, until the a send_data event
57 /// completes fully, no further read_events should trigger on the same peer!
59 /// If a read_event on this descriptor had previously returned true (indicating that read
60 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
61 /// indicating that read events on this descriptor should resume. A resume_read of false does
62 /// *not* imply that further read events should be paused.
63 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
64 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
65 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
66 /// No disconnect_event should be generated as a result of this call, though obviously races
67 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
68 /// that event completing.
69 fn disconnect_socket(&mut self);
72 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
73 /// generate no further read/write_events for the descriptor, only triggering a single
74 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
75 /// no such disconnect_event must be generated and the socket be silently disconencted).
76 pub struct PeerHandleError {
77 /// Used to indicate that we probably can't make any future connections to this peer, implying
78 /// we should go ahead and force-close any channels we have with it.
79 no_connection_possible: bool,
81 impl fmt::Debug for PeerHandleError {
82 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
83 formatter.write_str("Peer Sent Invalid Data")
86 impl fmt::Display for PeerHandleError {
87 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
88 formatter.write_str("Peer Sent Invalid Data")
91 impl error::Error for PeerHandleError {
92 fn description(&self) -> &str {
93 "Peer Sent Invalid Data"
100 NodesSyncing(PublicKey),
104 channel_encryptor: PeerChannelEncryptor,
106 their_node_id: Option<PublicKey>,
107 their_features: Option<InitFeatures>,
109 pending_outbound_buffer: LinkedList<Vec<u8>>,
110 pending_outbound_buffer_first_msg_offset: usize,
111 awaiting_write_event: bool,
113 pending_read_buffer: Vec<u8>,
114 pending_read_buffer_pos: usize,
115 pending_read_is_header: bool,
117 sync_status: InitSyncTracker,
123 /// Returns true if the channel announcements/updates for the given channel should be
124 /// forwarded to this peer.
125 /// If we are sending our routing table to this peer and we have not yet sent channel
126 /// announcements/updates for the given channel_id then we will send it when we get to that
127 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
128 /// sent the old versions, we should send the update, and so return true here.
129 fn should_forward_channel(&self, channel_id: u64)->bool{
130 match self.sync_status {
131 InitSyncTracker::NoSyncRequested => true,
132 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
133 InitSyncTracker::NodesSyncing(_) => true,
138 struct PeerHolder<Descriptor: SocketDescriptor> {
139 peers: HashMap<Descriptor, Peer>,
140 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
141 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
142 peers_needing_send: HashSet<Descriptor>,
143 /// Only add to this set when noise completes:
144 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
146 struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
147 peers: &'a mut HashMap<Descriptor, Peer>,
148 peers_needing_send: &'a mut HashSet<Descriptor>,
149 node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
151 impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
152 fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
154 peers: &mut self.peers,
155 peers_needing_send: &mut self.peers_needing_send,
156 node_id_to_descriptor: &mut self.node_id_to_descriptor,
161 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
162 fn _check_usize_is_32_or_64() {
163 // See below, less than 32 bit pointers may be unsafe here!
164 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
167 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
168 /// events into messages which it passes on to its MessageHandlers.
169 pub struct PeerManager<Descriptor: SocketDescriptor> {
170 message_handler: MessageHandler,
171 peers: Mutex<PeerHolder<Descriptor>>,
172 our_node_secret: SecretKey,
173 ephemeral_key_midstate: Sha256Engine,
175 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
176 // bits we will never realistically count into high:
177 peer_counter_low: AtomicUsize,
178 peer_counter_high: AtomicUsize,
180 initial_syncs_sent: AtomicUsize,
184 struct VecWriter(Vec<u8>);
185 impl Writer for VecWriter {
186 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
187 self.0.extend_from_slice(buf);
190 fn size_hint(&mut self, size: usize) {
191 self.0.reserve_exact(size);
195 macro_rules! encode_msg {
196 ($msg: expr, $msg_code: expr) => {{
197 let mut msg = VecWriter(Vec::new());
198 ($msg_code as u16).write(&mut msg).unwrap();
199 $msg.write(&mut msg).unwrap();
204 //TODO: Really should do something smarter for this
205 const INITIAL_SYNCS_TO_SEND: usize = 5;
207 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
208 /// PeerIds may repeat, but only after disconnect_event() has been called.
209 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
210 /// Constructs a new PeerManager with the given message handlers and node_id secret key
211 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
212 /// cryptographically secure random bytes.
213 pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: Arc<Logger>) -> PeerManager<Descriptor> {
214 let mut ephemeral_key_midstate = Sha256::engine();
215 ephemeral_key_midstate.input(ephemeral_random_data);
218 message_handler: message_handler,
219 peers: Mutex::new(PeerHolder {
220 peers: HashMap::new(),
221 peers_needing_send: HashSet::new(),
222 node_id_to_descriptor: HashMap::new()
224 our_node_secret: our_node_secret,
225 ephemeral_key_midstate,
226 peer_counter_low: AtomicUsize::new(0),
227 peer_counter_high: AtomicUsize::new(0),
228 initial_syncs_sent: AtomicUsize::new(0),
233 /// Get the list of node ids for peers which have completed the initial handshake.
235 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
236 /// new_outbound_connection, however entries will only appear once the initial handshake has
237 /// completed and we are sure the remote peer has the private key for the given node_id.
238 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
239 let peers = self.peers.lock().unwrap();
240 peers.peers.values().filter_map(|p| {
241 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
248 fn get_ephemeral_key(&self) -> SecretKey {
249 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
250 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
251 let high = if low == 0 {
252 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
254 self.peer_counter_high.load(Ordering::Acquire)
256 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
257 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
258 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
261 /// Indicates a new outbound connection has been established to a node with the given node_id.
262 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
263 /// descriptor but must disconnect the connection immediately.
265 /// Returns a small number of bytes to send to the remote node (currently always 50).
267 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
268 /// disconnect_event.
269 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
270 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
271 let res = peer_encryptor.get_act_one().to_vec();
272 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
274 let mut peers = self.peers.lock().unwrap();
275 if peers.peers.insert(descriptor, Peer {
276 channel_encryptor: peer_encryptor,
279 their_features: None,
281 pending_outbound_buffer: LinkedList::new(),
282 pending_outbound_buffer_first_msg_offset: 0,
283 awaiting_write_event: false,
285 pending_read_buffer: pending_read_buffer,
286 pending_read_buffer_pos: 0,
287 pending_read_is_header: false,
289 sync_status: InitSyncTracker::NoSyncRequested,
291 awaiting_pong: false,
293 panic!("PeerManager driver duplicated descriptors!");
298 /// Indicates a new inbound connection has been established.
300 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
301 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
302 /// call disconnect_event for the new descriptor but must disconnect the connection
305 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
306 /// disconnect_event.
307 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
308 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
309 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
311 let mut peers = self.peers.lock().unwrap();
312 if peers.peers.insert(descriptor, Peer {
313 channel_encryptor: peer_encryptor,
316 their_features: None,
318 pending_outbound_buffer: LinkedList::new(),
319 pending_outbound_buffer_first_msg_offset: 0,
320 awaiting_write_event: false,
322 pending_read_buffer: pending_read_buffer,
323 pending_read_buffer_pos: 0,
324 pending_read_is_header: false,
326 sync_status: InitSyncTracker::NoSyncRequested,
328 awaiting_pong: false,
330 panic!("PeerManager driver duplicated descriptors!");
335 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
336 macro_rules! encode_and_send_msg {
337 ($msg: expr, $msg_code: expr) => {
339 log_trace!(self, "Encoding and sending sync update message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
340 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
344 const MSG_BUFF_SIZE: usize = 10;
345 while !peer.awaiting_write_event {
346 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
347 match peer.sync_status {
348 InitSyncTracker::NoSyncRequested => {},
349 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
350 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
351 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(0, steps);
352 for &(ref announce, ref update_a, ref update_b) in all_messages.iter() {
353 encode_and_send_msg!(announce, 256);
354 encode_and_send_msg!(update_a, 258);
355 encode_and_send_msg!(update_b, 258);
356 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
358 if all_messages.is_empty() || all_messages.len() != steps as usize {
359 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
362 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
363 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
364 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
365 for msg in all_messages.iter() {
366 encode_and_send_msg!(msg, 256);
367 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
369 if all_messages.is_empty() || all_messages.len() != steps as usize {
370 peer.sync_status = InitSyncTracker::NoSyncRequested;
373 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
374 InitSyncTracker::NodesSyncing(key) => {
375 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
376 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
377 for msg in all_messages.iter() {
378 encode_and_send_msg!(msg, 256);
379 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
381 if all_messages.is_empty() || all_messages.len() != steps as usize {
382 peer.sync_status = InitSyncTracker::NoSyncRequested;
389 let next_buff = match peer.pending_outbound_buffer.front() {
394 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
395 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
396 let data_sent = descriptor.send_data(pending, should_be_reading);
397 peer.pending_outbound_buffer_first_msg_offset += data_sent;
398 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
400 peer.pending_outbound_buffer_first_msg_offset = 0;
401 peer.pending_outbound_buffer.pop_front();
403 peer.awaiting_write_event = true;
408 /// Indicates that there is room to write data to the given socket descriptor.
410 /// May return an Err to indicate that the connection should be closed.
412 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
413 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
414 /// invariants around calling write_event in case a write did not fully complete must still
415 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
416 /// Panics if the descriptor was not previously registered in a new_\*_connection event.
417 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
418 let mut peers = self.peers.lock().unwrap();
419 match peers.peers.get_mut(descriptor) {
420 None => panic!("Descriptor for write_event is not already known to PeerManager"),
422 peer.awaiting_write_event = false;
423 self.do_attempt_write_data(descriptor, peer);
429 /// Indicates that data was read from the given socket descriptor.
431 /// May return an Err to indicate that the connection should be closed.
433 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
434 /// Thus, however, you almost certainly want to call process_events() after any read_event to
435 /// generate send_data calls to handle responses.
437 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
438 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer).
440 /// Panics if the descriptor was not previously registered in a new_*_connection event.
441 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
442 match self.do_read_event(peer_descriptor, data) {
445 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
451 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
453 let mut peers_lock = self.peers.lock().unwrap();
454 let peers = peers_lock.borrow_parts();
455 let pause_read = match peers.peers.get_mut(peer_descriptor) {
456 None => panic!("Descriptor for read_event is not already known to PeerManager"),
458 assert!(peer.pending_read_buffer.len() > 0);
459 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
461 let mut read_pos = 0;
462 while read_pos < data.len() {
464 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
465 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]);
466 read_pos += data_to_copy;
467 peer.pending_read_buffer_pos += data_to_copy;
470 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
471 peer.pending_read_buffer_pos = 0;
473 macro_rules! encode_and_send_msg {
474 ($msg: expr, $msg_code: expr) => {
476 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
477 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
478 peers.peers_needing_send.insert(peer_descriptor.clone());
483 macro_rules! try_potential_handleerror {
489 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
490 //TODO: Try to push msg
491 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
492 return Err(PeerHandleError{ no_connection_possible: false });
494 msgs::ErrorAction::IgnoreError => {
495 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
498 msgs::ErrorAction::SendErrorMessage { msg } => {
499 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
500 encode_and_send_msg!(msg, 17);
509 macro_rules! try_potential_decodeerror {
515 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
516 msgs::DecodeError::UnknownRequiredFeature => {
517 log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to update!");
520 msgs::DecodeError::InvalidValue => {
521 log_debug!(self, "Got an invalid value while deserializing message");
522 return Err(PeerHandleError{ no_connection_possible: false });
524 msgs::DecodeError::ShortRead => {
525 log_debug!(self, "Deserialization failed due to shortness of message");
526 return Err(PeerHandleError{ no_connection_possible: false });
528 msgs::DecodeError::ExtraAddressesPerType => {
529 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
532 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
533 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
540 macro_rules! insert_node_id {
542 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
543 hash_map::Entry::Occupied(_) => {
544 log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
545 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
546 return Err(PeerHandleError{ no_connection_possible: false })
548 hash_map::Entry::Vacant(entry) => {
549 log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
550 entry.insert(peer_descriptor.clone())
556 let next_step = peer.channel_encryptor.get_noise_step();
558 NextNoiseStep::ActOne => {
559 let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_keys(&peer.pending_read_buffer[..], &self.our_node_secret, self.get_ephemeral_key())).to_vec();
560 peer.pending_outbound_buffer.push_back(act_two);
561 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
563 NextNoiseStep::ActTwo => {
564 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
565 peer.pending_outbound_buffer.push_back(act_three.to_vec());
566 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
567 peer.pending_read_is_header = true;
569 peer.their_node_id = Some(their_node_id);
571 let mut features = InitFeatures::supported();
572 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
573 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
574 features.set_initial_routing_sync();
576 encode_and_send_msg!(msgs::Init {
580 NextNoiseStep::ActThree => {
581 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
582 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
583 peer.pending_read_is_header = true;
584 peer.their_node_id = Some(their_node_id);
587 NextNoiseStep::NoiseComplete => {
588 if peer.pending_read_is_header {
589 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
590 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
591 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
592 if msg_len < 2 { // Need at least the message type tag
593 return Err(PeerHandleError{ no_connection_possible: false });
595 peer.pending_read_is_header = false;
597 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
598 assert!(msg_data.len() >= 2);
601 peer.pending_read_buffer = [0; 18].to_vec();
602 peer.pending_read_is_header = true;
604 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
605 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
606 if msg_type != 16 && peer.their_features.is_none() {
607 // Need an init message as first message
608 log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
609 return Err(PeerHandleError{ no_connection_possible: false });
611 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
613 // Connection control:
615 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
616 if msg.features.requires_unknown_bits() {
617 log_info!(self, "Peer global features required unknown version bits");
618 return Err(PeerHandleError{ no_connection_possible: true });
620 if msg.features.requires_unknown_bits() {
621 log_info!(self, "Peer local features required unknown version bits");
622 return Err(PeerHandleError{ no_connection_possible: true });
624 if peer.their_features.is_some() {
625 return Err(PeerHandleError{ no_connection_possible: false });
628 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
629 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
630 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
631 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
632 if msg.features.supports_unknown_bits() { "present" } else { "none" },
633 if msg.features.supports_unknown_bits() { "present" } else { "none" });
635 if msg.features.initial_routing_sync() {
636 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
637 peers.peers_needing_send.insert(peer_descriptor.clone());
639 peer.their_features = Some(msg.features);
642 let mut features = InitFeatures::supported();
643 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
644 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
645 features.set_initial_routing_sync();
648 encode_and_send_msg!(msgs::Init {
653 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap());
656 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
657 let mut data_is_printable = true;
658 for b in msg.data.bytes() {
659 if b < 32 || b > 126 {
660 data_is_printable = false;
665 if data_is_printable {
666 log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
668 log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
670 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
671 if msg.channel_id == [0; 32] {
672 return Err(PeerHandleError{ no_connection_possible: true });
677 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
678 if msg.ponglen < 65532 {
679 let resp = msgs::Pong { byteslen: msg.ponglen };
680 encode_and_send_msg!(resp, 19);
684 peer.awaiting_pong = false;
685 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
689 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
690 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
693 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
694 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
698 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
699 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
702 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
703 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
706 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
707 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
711 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
712 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
715 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
716 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
720 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
721 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
724 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
725 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
728 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
729 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
732 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
733 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
737 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
738 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
741 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
742 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
745 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
746 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
749 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
750 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
755 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
756 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
759 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
760 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
763 // TODO: forward msg along to all our other peers!
767 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
768 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
771 // TODO: forward msg along to all our other peers!
775 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
776 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
779 // TODO: forward msg along to all our other peers!
783 if (msg_type & 1) == 0 {
784 return Err(PeerHandleError{ no_connection_possible: true });
794 self.do_attempt_write_data(peer_descriptor, peer);
796 peer.pending_outbound_buffer.len() > 10 // pause_read
806 /// Checks for any events generated by our handlers and processes them. Includes sending most
807 /// response messages as well as messages generated by calls to handler functions directly (eg
808 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
809 pub fn process_events(&self) {
811 // TODO: There are some DoS attacks here where you can flood someone's outbound send
812 // buffer by doing things like announcing channels on another node. We should be willing to
813 // drop optional-ish messages when send buffers get full!
815 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
816 let mut peers_lock = self.peers.lock().unwrap();
817 let peers = peers_lock.borrow_parts();
818 for event in events_generated.drain(..) {
819 macro_rules! get_peer_for_forwarding {
820 ($node_id: expr, $handle_no_such_peer: block) => {
822 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
823 Some(descriptor) => descriptor.clone(),
825 $handle_no_such_peer;
829 match peers.peers.get_mut(&descriptor) {
831 if peer.their_features.is_none() {
832 $handle_no_such_peer;
837 None => panic!("Inconsistent peers set state!"),
843 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
844 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
845 log_pubkey!(node_id),
846 log_bytes!(msg.temporary_channel_id));
847 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
848 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
850 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
851 self.do_attempt_write_data(&mut descriptor, peer);
853 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
854 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
855 log_pubkey!(node_id),
856 log_bytes!(msg.temporary_channel_id));
857 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
858 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
860 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
861 self.do_attempt_write_data(&mut descriptor, peer);
863 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
864 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
865 log_pubkey!(node_id),
866 log_bytes!(msg.temporary_channel_id),
867 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
868 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
869 //TODO: generate a DiscardFunding event indicating to the wallet that
870 //they should just throw away this funding transaction
872 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
873 self.do_attempt_write_data(&mut descriptor, peer);
875 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
876 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
877 log_pubkey!(node_id),
878 log_bytes!(msg.channel_id));
879 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
880 //TODO: generate a DiscardFunding event indicating to the wallet that
881 //they should just throw away this funding transaction
883 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
884 self.do_attempt_write_data(&mut descriptor, peer);
886 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
887 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
888 log_pubkey!(node_id),
889 log_bytes!(msg.channel_id));
890 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
891 //TODO: Do whatever we're gonna do for handling dropped messages
893 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
894 self.do_attempt_write_data(&mut descriptor, peer);
896 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
897 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
898 log_pubkey!(node_id),
899 log_bytes!(msg.channel_id));
900 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
901 //TODO: generate a DiscardFunding event indicating to the wallet that
902 //they should just throw away this funding transaction
904 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
905 self.do_attempt_write_data(&mut descriptor, peer);
907 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
908 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
909 log_pubkey!(node_id),
910 update_add_htlcs.len(),
911 update_fulfill_htlcs.len(),
912 update_fail_htlcs.len(),
913 log_bytes!(commitment_signed.channel_id));
914 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
915 //TODO: Do whatever we're gonna do for handling dropped messages
917 for msg in update_add_htlcs {
918 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
920 for msg in update_fulfill_htlcs {
921 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
923 for msg in update_fail_htlcs {
924 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
926 for msg in update_fail_malformed_htlcs {
927 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
929 if let &Some(ref msg) = update_fee {
930 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
932 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
933 self.do_attempt_write_data(&mut descriptor, peer);
935 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
936 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
937 log_pubkey!(node_id),
938 log_bytes!(msg.channel_id));
939 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
940 //TODO: Do whatever we're gonna do for handling dropped messages
942 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
943 self.do_attempt_write_data(&mut descriptor, peer);
945 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
946 log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
947 log_pubkey!(node_id),
948 log_bytes!(msg.channel_id));
949 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
950 //TODO: Do whatever we're gonna do for handling dropped messages
952 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 39)));
953 self.do_attempt_write_data(&mut descriptor, peer);
955 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
956 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
957 log_pubkey!(node_id),
958 log_bytes!(msg.channel_id));
959 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
960 //TODO: Do whatever we're gonna do for handling dropped messages
962 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
963 self.do_attempt_write_data(&mut descriptor, peer);
965 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
966 log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
967 log_pubkey!(node_id),
968 log_bytes!(msg.channel_id));
969 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
970 //TODO: Do whatever we're gonna do for handling dropped messages
972 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 136)));
973 self.do_attempt_write_data(&mut descriptor, peer);
975 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
976 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
977 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
978 let encoded_msg = encode_msg!(msg, 256);
979 let encoded_update_msg = encode_msg!(update_msg, 258);
981 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
982 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
983 !peer.should_forward_channel(msg.contents.short_channel_id) {
986 match peer.their_node_id {
988 Some(their_node_id) => {
989 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
994 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
995 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
996 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1000 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1001 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1002 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1003 let encoded_msg = encode_msg!(msg, 258);
1005 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1006 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1007 !peer.should_forward_channel(msg.contents.short_channel_id) {
1010 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1011 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1015 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1016 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1018 MessageSendEvent::HandleError { ref node_id, ref action } => {
1020 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1021 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1022 peers.peers_needing_send.remove(&descriptor);
1023 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1024 if let Some(ref msg) = *msg {
1025 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1026 log_pubkey!(node_id),
1028 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
1029 // This isn't guaranteed to work, but if there is enough free
1030 // room in the send buffer, put the error message there...
1031 self.do_attempt_write_data(&mut descriptor, &mut peer);
1033 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1036 descriptor.disconnect_socket();
1037 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1040 msgs::ErrorAction::IgnoreError => {},
1041 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1042 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1043 log_pubkey!(node_id),
1045 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1046 //TODO: Do whatever we're gonna do for handling dropped messages
1048 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
1049 self.do_attempt_write_data(&mut descriptor, peer);
1056 for mut descriptor in peers.peers_needing_send.drain() {
1057 match peers.peers.get_mut(&descriptor) {
1058 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1059 None => panic!("Inconsistent peers set state!"),
1065 /// Indicates that the given socket descriptor's connection is now closed.
1067 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
1068 /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
1070 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1071 pub fn disconnect_event(&self, descriptor: &Descriptor) {
1072 self.disconnect_event_internal(descriptor, false);
1075 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1076 let mut peers = self.peers.lock().unwrap();
1077 peers.peers_needing_send.remove(descriptor);
1078 let peer_option = peers.peers.remove(descriptor);
1080 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1082 match peer.their_node_id {
1084 peers.node_id_to_descriptor.remove(&node_id);
1085 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1093 /// This function should be called roughly once every 30 seconds.
1094 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1096 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1097 pub fn timer_tick_occured(&self) {
1098 let mut peers_lock = self.peers.lock().unwrap();
1100 let peers = peers_lock.borrow_parts();
1101 let peers_needing_send = peers.peers_needing_send;
1102 let node_id_to_descriptor = peers.node_id_to_descriptor;
1103 let peers = peers.peers;
1105 peers.retain(|descriptor, peer| {
1106 if peer.awaiting_pong == true {
1107 peers_needing_send.remove(descriptor);
1108 match peer.their_node_id {
1110 node_id_to_descriptor.remove(&node_id);
1111 self.message_handler.chan_handler.peer_disconnected(&node_id, true);
1117 let ping = msgs::Ping {
1121 peer.pending_outbound_buffer.push_back(encode_msg!(ping, 18));
1122 let mut descriptor_clone = descriptor.clone();
1123 self.do_attempt_write_data(&mut descriptor_clone, peer);
1125 if peer.awaiting_pong {
1126 false // Drop the peer
1128 peer.awaiting_pong = true;
1138 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1141 use util::test_utils;
1142 use util::logger::Logger;
1144 use secp256k1::Secp256k1;
1145 use secp256k1::key::{SecretKey, PublicKey};
1147 use rand::{thread_rng, Rng};
1149 use std::sync::{Arc};
1151 #[derive(PartialEq, Eq, Clone, Hash)]
1152 struct FileDescriptor {
1156 impl SocketDescriptor for FileDescriptor {
1157 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1161 fn disconnect_socket(&mut self) {}
1164 fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
1165 let mut peers = Vec::new();
1166 let mut rng = thread_rng();
1167 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1168 let mut ephemeral_bytes = [0; 32];
1169 rng.fill_bytes(&mut ephemeral_bytes);
1171 for _ in 0..peer_count {
1172 let chan_handler = test_utils::TestChannelMessageHandler::new();
1173 let router = test_utils::TestRoutingMessageHandler::new();
1175 let mut key_slice = [0;32];
1176 rng.fill_bytes(&mut key_slice);
1177 SecretKey::from_slice(&key_slice).unwrap()
1179 let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
1180 let peer = PeerManager::new(msg_handler, node_id, &ephemeral_bytes, Arc::clone(&logger));
1187 fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
1188 let secp_ctx = Secp256k1::new();
1189 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1190 let fd = FileDescriptor { fd: 1};
1191 peer_a.new_inbound_connection(fd.clone()).unwrap();
1192 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1196 fn test_disconnect_peer() {
1197 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1198 // push a DisconnectPeer event to remove the node flagged by id
1199 let mut peers = create_network(2);
1200 establish_connection(&peers[0], &peers[1]);
1201 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1203 let secp_ctx = Secp256k1::new();
1204 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1206 let chan_handler = test_utils::TestChannelMessageHandler::new();
1207 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1209 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1211 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1212 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
1214 peers[0].process_events();
1215 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1218 fn test_timer_tick_occured(){
1219 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1220 let peers = create_network(2);
1221 establish_connection(&peers[0], &peers[1]);
1222 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1224 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1225 peers[0].timer_tick_occured();
1226 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1228 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1229 peers[0].timer_tick_occured();
1230 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);