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 ln::msgs::ChannelMessageHandler;
14 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
15 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
19 use util::events::{MessageSendEvent, MessageSendEventsProvider};
20 use util::logger::Logger;
21 use util::ser::Writer;
23 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
24 use std::sync::{Arc, Mutex};
25 use std::sync::atomic::{AtomicUsize, Ordering};
26 use std::{cmp,error,hash,fmt};
29 use bitcoin_hashes::sha256::Hash as Sha256;
30 use bitcoin_hashes::sha256::HashEngine as Sha256Engine;
31 use bitcoin_hashes::{HashEngine, Hash};
33 /// Provides references to trait impls which handle different types of messages.
34 pub struct MessageHandler<CM: Deref> where CM::Target: msgs::ChannelMessageHandler {
35 /// A message handler which handles messages specific to channels. Usually this is just a
36 /// ChannelManager object.
38 /// A message handler which handles messages updating our knowledge of the network channel
39 /// graph. Usually this is just a Router object.
40 pub route_handler: Arc<msgs::RoutingMessageHandler>,
43 /// Provides an object which can be used to send data to and which uniquely identifies a connection
44 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
45 /// implement Hash to meet the PeerManager API.
47 /// For efficiency, Clone should be relatively cheap for this type.
49 /// You probably want to just extend an int and put a file descriptor in a struct and implement
50 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
51 /// careful to ensure you don't have races whereby you might register a new connection with an fd
52 /// the same as a yet-to-be-disconnect_event()-ed.
53 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
54 /// Attempts to send some data from the given slice to the peer.
56 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
57 /// Note that in the disconnected case, a disconnect_event must still fire and further write
58 /// attempts may occur until that time.
60 /// If the returned size is smaller than data.len(), a write_available event must
61 /// trigger the next time more data can be written. Additionally, until the a send_data event
62 /// completes fully, no further read_events should trigger on the same peer!
64 /// If a read_event on this descriptor had previously returned true (indicating that read
65 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
66 /// indicating that read events on this descriptor should resume. A resume_read of false does
67 /// *not* imply that further read events should be paused.
68 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
69 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
70 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
71 /// No disconnect_event should be generated as a result of this call, though obviously races
72 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
73 /// that event completing.
74 fn disconnect_socket(&mut self);
77 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
78 /// generate no further read/write_events for the descriptor, only triggering a single
79 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
80 /// no such disconnect_event must be generated and the socket be silently disconencted).
81 pub struct PeerHandleError {
82 /// Used to indicate that we probably can't make any future connections to this peer, implying
83 /// we should go ahead and force-close any channels we have with it.
84 no_connection_possible: bool,
86 impl fmt::Debug for PeerHandleError {
87 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
88 formatter.write_str("Peer Sent Invalid Data")
91 impl fmt::Display for PeerHandleError {
92 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
93 formatter.write_str("Peer Sent Invalid Data")
96 impl error::Error for PeerHandleError {
97 fn description(&self) -> &str {
98 "Peer Sent Invalid Data"
102 enum InitSyncTracker{
104 ChannelsSyncing(u64),
105 NodesSyncing(PublicKey),
109 channel_encryptor: PeerChannelEncryptor,
111 their_node_id: Option<PublicKey>,
112 their_features: Option<InitFeatures>,
114 pending_outbound_buffer: LinkedList<Vec<u8>>,
115 pending_outbound_buffer_first_msg_offset: usize,
116 awaiting_write_event: bool,
118 pending_read_buffer: Vec<u8>,
119 pending_read_buffer_pos: usize,
120 pending_read_is_header: bool,
122 sync_status: InitSyncTracker,
128 /// Returns true if the channel announcements/updates for the given channel should be
129 /// forwarded to this peer.
130 /// If we are sending our routing table to this peer and we have not yet sent channel
131 /// announcements/updates for the given channel_id then we will send it when we get to that
132 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
133 /// sent the old versions, we should send the update, and so return true here.
134 fn should_forward_channel(&self, channel_id: u64)->bool{
135 match self.sync_status {
136 InitSyncTracker::NoSyncRequested => true,
137 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
138 InitSyncTracker::NodesSyncing(_) => true,
143 struct PeerHolder<Descriptor: SocketDescriptor> {
144 peers: HashMap<Descriptor, Peer>,
145 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
146 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
147 peers_needing_send: HashSet<Descriptor>,
148 /// Only add to this set when noise completes:
149 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
152 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
153 fn _check_usize_is_32_or_64() {
154 // See below, less than 32 bit pointers may be unsafe here!
155 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
158 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
159 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
160 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
161 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
162 /// issues such as overly long function definitions.
163 pub type SimpleArcPeerManager<SD, M> = Arc<PeerManager<SD, SimpleArcChannelManager<M>>>;
165 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
166 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
167 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
168 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
169 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
170 /// helps with issues such as long function definitions.
171 pub type SimpleRefPeerManager<'a, SD, M> = PeerManager<SD, SimpleRefChannelManager<'a, M>>;
173 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
174 /// events into messages which it passes on to its MessageHandlers.
176 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
177 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
178 /// essentially you should default to using a SimpleRefPeerManager, and use a
179 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
180 /// you're using lightning-net-tokio.
181 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref> where CM::Target: msgs::ChannelMessageHandler {
182 message_handler: MessageHandler<CM>,
183 peers: Mutex<PeerHolder<Descriptor>>,
184 our_node_secret: SecretKey,
185 ephemeral_key_midstate: Sha256Engine,
187 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
188 // bits we will never realistically count into high:
189 peer_counter_low: AtomicUsize,
190 peer_counter_high: AtomicUsize,
192 initial_syncs_sent: AtomicUsize,
196 struct VecWriter(Vec<u8>);
197 impl Writer for VecWriter {
198 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
199 self.0.extend_from_slice(buf);
202 fn size_hint(&mut self, size: usize) {
203 self.0.reserve_exact(size);
207 macro_rules! encode_msg {
209 let mut buffer = VecWriter(Vec::new());
210 wire::write($msg, &mut buffer).unwrap();
215 //TODO: Really should do something smarter for this
216 const INITIAL_SYNCS_TO_SEND: usize = 5;
218 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
219 /// PeerIds may repeat, but only after disconnect_event() has been called.
220 impl<Descriptor: SocketDescriptor, CM: Deref> PeerManager<Descriptor, CM> where CM::Target: msgs::ChannelMessageHandler {
221 /// Constructs a new PeerManager with the given message handlers and node_id secret key
222 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
223 /// cryptographically secure random bytes.
224 pub fn new(message_handler: MessageHandler<CM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: Arc<Logger>) -> PeerManager<Descriptor, CM> {
225 let mut ephemeral_key_midstate = Sha256::engine();
226 ephemeral_key_midstate.input(ephemeral_random_data);
229 message_handler: message_handler,
230 peers: Mutex::new(PeerHolder {
231 peers: HashMap::new(),
232 peers_needing_send: HashSet::new(),
233 node_id_to_descriptor: HashMap::new()
235 our_node_secret: our_node_secret,
236 ephemeral_key_midstate,
237 peer_counter_low: AtomicUsize::new(0),
238 peer_counter_high: AtomicUsize::new(0),
239 initial_syncs_sent: AtomicUsize::new(0),
244 /// Get the list of node ids for peers which have completed the initial handshake.
246 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
247 /// new_outbound_connection, however entries will only appear once the initial handshake has
248 /// completed and we are sure the remote peer has the private key for the given node_id.
249 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
250 let peers = self.peers.lock().unwrap();
251 peers.peers.values().filter_map(|p| {
252 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
259 fn get_ephemeral_key(&self) -> SecretKey {
260 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
261 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
262 let high = if low == 0 {
263 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
265 self.peer_counter_high.load(Ordering::Acquire)
267 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
268 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
269 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
272 /// Indicates a new outbound connection has been established to a node with the given node_id.
273 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
274 /// descriptor but must disconnect the connection immediately.
276 /// Returns a small number of bytes to send to the remote node (currently always 50).
278 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
279 /// disconnect_event.
280 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
281 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
282 let res = peer_encryptor.get_act_one().to_vec();
283 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
285 let mut peers = self.peers.lock().unwrap();
286 if peers.peers.insert(descriptor, Peer {
287 channel_encryptor: peer_encryptor,
290 their_features: None,
292 pending_outbound_buffer: LinkedList::new(),
293 pending_outbound_buffer_first_msg_offset: 0,
294 awaiting_write_event: false,
296 pending_read_buffer: pending_read_buffer,
297 pending_read_buffer_pos: 0,
298 pending_read_is_header: false,
300 sync_status: InitSyncTracker::NoSyncRequested,
302 awaiting_pong: false,
304 panic!("PeerManager driver duplicated descriptors!");
309 /// Indicates a new inbound connection has been established.
311 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
312 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
313 /// call disconnect_event for the new descriptor but must disconnect the connection
316 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
317 /// disconnect_event.
318 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
319 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
320 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
322 let mut peers = self.peers.lock().unwrap();
323 if peers.peers.insert(descriptor, Peer {
324 channel_encryptor: peer_encryptor,
327 their_features: None,
329 pending_outbound_buffer: LinkedList::new(),
330 pending_outbound_buffer_first_msg_offset: 0,
331 awaiting_write_event: false,
333 pending_read_buffer: pending_read_buffer,
334 pending_read_buffer_pos: 0,
335 pending_read_is_header: false,
337 sync_status: InitSyncTracker::NoSyncRequested,
339 awaiting_pong: false,
341 panic!("PeerManager driver duplicated descriptors!");
346 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
347 macro_rules! encode_and_send_msg {
350 log_trace!(self, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
351 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
355 const MSG_BUFF_SIZE: usize = 10;
356 while !peer.awaiting_write_event {
357 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
358 match peer.sync_status {
359 InitSyncTracker::NoSyncRequested => {},
360 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
361 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
362 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(0, steps);
363 for &(ref announce, ref update_a, ref update_b) in all_messages.iter() {
364 encode_and_send_msg!(announce);
365 encode_and_send_msg!(update_a);
366 encode_and_send_msg!(update_b);
367 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
369 if all_messages.is_empty() || all_messages.len() != steps as usize {
370 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
373 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
374 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
375 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
376 for msg in all_messages.iter() {
377 encode_and_send_msg!(msg);
378 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
380 if all_messages.is_empty() || all_messages.len() != steps as usize {
381 peer.sync_status = InitSyncTracker::NoSyncRequested;
384 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
385 InitSyncTracker::NodesSyncing(key) => {
386 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
387 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
388 for msg in all_messages.iter() {
389 encode_and_send_msg!(msg);
390 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
392 if all_messages.is_empty() || all_messages.len() != steps as usize {
393 peer.sync_status = InitSyncTracker::NoSyncRequested;
400 let next_buff = match peer.pending_outbound_buffer.front() {
405 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
406 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
407 let data_sent = descriptor.send_data(pending, should_be_reading);
408 peer.pending_outbound_buffer_first_msg_offset += data_sent;
409 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
411 peer.pending_outbound_buffer_first_msg_offset = 0;
412 peer.pending_outbound_buffer.pop_front();
414 peer.awaiting_write_event = true;
419 /// Indicates that there is room to write data to the given socket descriptor.
421 /// May return an Err to indicate that the connection should be closed.
423 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
424 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
425 /// invariants around calling write_event in case a write did not fully complete must still
426 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
427 /// Panics if the descriptor was not previously registered in a new_\*_connection event.
428 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
429 let mut peers = self.peers.lock().unwrap();
430 match peers.peers.get_mut(descriptor) {
431 None => panic!("Descriptor for write_event is not already known to PeerManager"),
433 peer.awaiting_write_event = false;
434 self.do_attempt_write_data(descriptor, peer);
440 /// Indicates that data was read from the given socket descriptor.
442 /// May return an Err to indicate that the connection should be closed.
444 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
445 /// Thus, however, you almost certainly want to call process_events() after any read_event to
446 /// generate send_data calls to handle responses.
448 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
449 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer).
451 /// Panics if the descriptor was not previously registered in a new_*_connection event.
452 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
453 match self.do_read_event(peer_descriptor, data) {
456 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
462 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
464 let mut peers_lock = self.peers.lock().unwrap();
465 let peers = &mut *peers_lock;
466 let pause_read = match peers.peers.get_mut(peer_descriptor) {
467 None => panic!("Descriptor for read_event is not already known to PeerManager"),
469 assert!(peer.pending_read_buffer.len() > 0);
470 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
472 let mut read_pos = 0;
473 while read_pos < data.len() {
475 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
476 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]);
477 read_pos += data_to_copy;
478 peer.pending_read_buffer_pos += data_to_copy;
481 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
482 peer.pending_read_buffer_pos = 0;
484 macro_rules! encode_and_send_msg {
487 log_trace!(self, "Encoding and sending message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
488 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&$msg)[..]));
489 peers.peers_needing_send.insert(peer_descriptor.clone());
494 macro_rules! try_potential_handleerror {
500 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
501 //TODO: Try to push msg
502 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
503 return Err(PeerHandleError{ no_connection_possible: false });
505 msgs::ErrorAction::IgnoreError => {
506 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
509 msgs::ErrorAction::SendErrorMessage { msg } => {
510 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
511 encode_and_send_msg!(msg);
520 macro_rules! try_potential_decodeerror {
526 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
527 msgs::DecodeError::UnknownRequiredFeature => {
528 log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to update!");
531 msgs::DecodeError::InvalidValue => {
532 log_debug!(self, "Got an invalid value while deserializing message");
533 return Err(PeerHandleError{ no_connection_possible: false });
535 msgs::DecodeError::ShortRead => {
536 log_debug!(self, "Deserialization failed due to shortness of message");
537 return Err(PeerHandleError{ no_connection_possible: false });
539 msgs::DecodeError::ExtraAddressesPerType => {
540 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
543 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
544 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
551 macro_rules! insert_node_id {
553 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
554 hash_map::Entry::Occupied(_) => {
555 log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
556 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
557 return Err(PeerHandleError{ no_connection_possible: false })
559 hash_map::Entry::Vacant(entry) => {
560 log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
561 entry.insert(peer_descriptor.clone())
567 let next_step = peer.channel_encryptor.get_noise_step();
569 NextNoiseStep::ActOne => {
570 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();
571 peer.pending_outbound_buffer.push_back(act_two);
572 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
574 NextNoiseStep::ActTwo => {
575 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
576 peer.pending_outbound_buffer.push_back(act_three.to_vec());
577 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
578 peer.pending_read_is_header = true;
580 peer.their_node_id = Some(their_node_id);
582 let mut features = InitFeatures::supported();
583 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
584 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
585 features.set_initial_routing_sync();
588 let resp = msgs::Init { features };
589 encode_and_send_msg!(resp);
591 NextNoiseStep::ActThree => {
592 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
593 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
594 peer.pending_read_is_header = true;
595 peer.their_node_id = Some(their_node_id);
598 NextNoiseStep::NoiseComplete => {
599 if peer.pending_read_is_header {
600 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
601 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
602 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
603 if msg_len < 2 { // Need at least the message type tag
604 return Err(PeerHandleError{ no_connection_possible: false });
606 peer.pending_read_is_header = false;
608 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
609 assert!(msg_data.len() >= 2);
612 peer.pending_read_buffer = [0; 18].to_vec();
613 peer.pending_read_is_header = true;
615 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
616 let message = try_potential_decodeerror!(wire::read(&mut reader));
617 log_trace!(self, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
619 // Need an Init as first message
620 if let wire::Message::Init(_) = message {
621 } else if peer.their_features.is_none() {
622 log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
623 return Err(PeerHandleError{ no_connection_possible: false });
627 // Setup and Control messages:
628 wire::Message::Init(msg) => {
629 if msg.features.requires_unknown_bits() {
630 log_info!(self, "Peer global features required unknown version bits");
631 return Err(PeerHandleError{ no_connection_possible: true });
633 if msg.features.requires_unknown_bits() {
634 log_info!(self, "Peer local features required unknown version bits");
635 return Err(PeerHandleError{ no_connection_possible: true });
637 if peer.their_features.is_some() {
638 return Err(PeerHandleError{ no_connection_possible: false });
641 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
642 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
643 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
644 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
645 if msg.features.supports_unknown_bits() { "present" } else { "none" },
646 if msg.features.supports_unknown_bits() { "present" } else { "none" });
648 if msg.features.initial_routing_sync() {
649 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
650 peers.peers_needing_send.insert(peer_descriptor.clone());
654 let mut features = InitFeatures::supported();
655 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
656 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
657 features.set_initial_routing_sync();
660 let resp = msgs::Init { features };
661 encode_and_send_msg!(resp);
664 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
665 peer.their_features = Some(msg.features);
667 wire::Message::Error(msg) => {
668 let mut data_is_printable = true;
669 for b in msg.data.bytes() {
670 if b < 32 || b > 126 {
671 data_is_printable = false;
676 if data_is_printable {
677 log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
679 log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
681 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
682 if msg.channel_id == [0; 32] {
683 return Err(PeerHandleError{ no_connection_possible: true });
687 wire::Message::Ping(msg) => {
688 if msg.ponglen < 65532 {
689 let resp = msgs::Pong { byteslen: msg.ponglen };
690 encode_and_send_msg!(resp);
693 wire::Message::Pong(_msg) => {
694 peer.awaiting_pong = false;
698 wire::Message::OpenChannel(msg) => {
699 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
701 wire::Message::AcceptChannel(msg) => {
702 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
705 wire::Message::FundingCreated(msg) => {
706 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
708 wire::Message::FundingSigned(msg) => {
709 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
711 wire::Message::FundingLocked(msg) => {
712 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
715 wire::Message::Shutdown(msg) => {
716 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
718 wire::Message::ClosingSigned(msg) => {
719 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
722 // Commitment messages:
723 wire::Message::UpdateAddHTLC(msg) => {
724 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
726 wire::Message::UpdateFulfillHTLC(msg) => {
727 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
729 wire::Message::UpdateFailHTLC(msg) => {
730 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
732 wire::Message::UpdateFailMalformedHTLC(msg) => {
733 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
736 wire::Message::CommitmentSigned(msg) => {
737 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
739 wire::Message::RevokeAndACK(msg) => {
740 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
742 wire::Message::UpdateFee(msg) => {
743 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
745 wire::Message::ChannelReestablish(msg) => {
746 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
750 wire::Message::AnnouncementSignatures(msg) => {
751 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
753 wire::Message::ChannelAnnouncement(msg) => {
754 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
757 // TODO: forward msg along to all our other peers!
760 wire::Message::NodeAnnouncement(msg) => {
761 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
764 // TODO: forward msg along to all our other peers!
767 wire::Message::ChannelUpdate(msg) => {
768 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
771 // TODO: forward msg along to all our other peers!
776 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
777 // Fail the channel if message is an even, unknown type as per BOLT #1.
778 return Err(PeerHandleError{ no_connection_possible: true });
780 wire::Message::Unknown(_) => {},
788 self.do_attempt_write_data(peer_descriptor, peer);
790 peer.pending_outbound_buffer.len() > 10 // pause_read
800 /// Checks for any events generated by our handlers and processes them. Includes sending most
801 /// response messages as well as messages generated by calls to handler functions directly (eg
802 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
803 pub fn process_events(&self) {
805 // TODO: There are some DoS attacks here where you can flood someone's outbound send
806 // buffer by doing things like announcing channels on another node. We should be willing to
807 // drop optional-ish messages when send buffers get full!
809 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
810 let mut peers_lock = self.peers.lock().unwrap();
811 let peers = &mut *peers_lock;
812 for event in events_generated.drain(..) {
813 macro_rules! get_peer_for_forwarding {
814 ($node_id: expr, $handle_no_such_peer: block) => {
816 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
817 Some(descriptor) => descriptor.clone(),
819 $handle_no_such_peer;
823 match peers.peers.get_mut(&descriptor) {
825 if peer.their_features.is_none() {
826 $handle_no_such_peer;
831 None => panic!("Inconsistent peers set state!"),
837 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
838 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
839 log_pubkey!(node_id),
840 log_bytes!(msg.temporary_channel_id));
841 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
842 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
844 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
845 self.do_attempt_write_data(&mut descriptor, peer);
847 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
848 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
849 log_pubkey!(node_id),
850 log_bytes!(msg.temporary_channel_id));
851 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
852 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
854 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
855 self.do_attempt_write_data(&mut descriptor, peer);
857 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
858 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
859 log_pubkey!(node_id),
860 log_bytes!(msg.temporary_channel_id),
861 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
862 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
863 //TODO: generate a DiscardFunding event indicating to the wallet that
864 //they should just throw away this funding transaction
866 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
867 self.do_attempt_write_data(&mut descriptor, peer);
869 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
870 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
871 log_pubkey!(node_id),
872 log_bytes!(msg.channel_id));
873 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
874 //TODO: generate a DiscardFunding event indicating to the wallet that
875 //they should just throw away this funding transaction
877 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
878 self.do_attempt_write_data(&mut descriptor, peer);
880 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
881 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
882 log_pubkey!(node_id),
883 log_bytes!(msg.channel_id));
884 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
885 //TODO: Do whatever we're gonna do for handling dropped messages
887 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
888 self.do_attempt_write_data(&mut descriptor, peer);
890 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
891 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
892 log_pubkey!(node_id),
893 log_bytes!(msg.channel_id));
894 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
895 //TODO: generate a DiscardFunding event indicating to the wallet that
896 //they should just throw away this funding transaction
898 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
899 self.do_attempt_write_data(&mut descriptor, peer);
901 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 } } => {
902 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
903 log_pubkey!(node_id),
904 update_add_htlcs.len(),
905 update_fulfill_htlcs.len(),
906 update_fail_htlcs.len(),
907 log_bytes!(commitment_signed.channel_id));
908 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
909 //TODO: Do whatever we're gonna do for handling dropped messages
911 for msg in update_add_htlcs {
912 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
914 for msg in update_fulfill_htlcs {
915 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
917 for msg in update_fail_htlcs {
918 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
920 for msg in update_fail_malformed_htlcs {
921 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
923 if let &Some(ref msg) = update_fee {
924 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
926 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
927 self.do_attempt_write_data(&mut descriptor, peer);
929 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
930 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
931 log_pubkey!(node_id),
932 log_bytes!(msg.channel_id));
933 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
934 //TODO: Do whatever we're gonna do for handling dropped messages
936 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
937 self.do_attempt_write_data(&mut descriptor, peer);
939 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
940 log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
941 log_pubkey!(node_id),
942 log_bytes!(msg.channel_id));
943 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
944 //TODO: Do whatever we're gonna do for handling dropped messages
946 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
947 self.do_attempt_write_data(&mut descriptor, peer);
949 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
950 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
951 log_pubkey!(node_id),
952 log_bytes!(msg.channel_id));
953 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
954 //TODO: Do whatever we're gonna do for handling dropped messages
956 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
957 self.do_attempt_write_data(&mut descriptor, peer);
959 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
960 log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
961 log_pubkey!(node_id),
962 log_bytes!(msg.channel_id));
963 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
964 //TODO: Do whatever we're gonna do for handling dropped messages
966 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
967 self.do_attempt_write_data(&mut descriptor, peer);
969 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
970 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
971 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
972 let encoded_msg = encode_msg!(msg);
973 let encoded_update_msg = encode_msg!(update_msg);
975 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
976 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
977 !peer.should_forward_channel(msg.contents.short_channel_id) {
980 match peer.their_node_id {
982 Some(their_node_id) => {
983 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
988 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
989 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
990 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
994 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
995 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
996 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
997 let encoded_msg = encode_msg!(msg);
999 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1000 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1001 !peer.should_forward_channel(msg.contents.short_channel_id) {
1004 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1005 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1009 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1010 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1012 MessageSendEvent::HandleError { ref node_id, ref action } => {
1014 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1015 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1016 peers.peers_needing_send.remove(&descriptor);
1017 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1018 if let Some(ref msg) = *msg {
1019 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1020 log_pubkey!(node_id),
1022 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1023 // This isn't guaranteed to work, but if there is enough free
1024 // room in the send buffer, put the error message there...
1025 self.do_attempt_write_data(&mut descriptor, &mut peer);
1027 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1030 descriptor.disconnect_socket();
1031 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1034 msgs::ErrorAction::IgnoreError => {},
1035 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1036 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1037 log_pubkey!(node_id),
1039 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1040 //TODO: Do whatever we're gonna do for handling dropped messages
1042 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1043 self.do_attempt_write_data(&mut descriptor, peer);
1050 for mut descriptor in peers.peers_needing_send.drain() {
1051 match peers.peers.get_mut(&descriptor) {
1052 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1053 None => panic!("Inconsistent peers set state!"),
1059 /// Indicates that the given socket descriptor's connection is now closed.
1061 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
1062 /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
1064 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1065 pub fn disconnect_event(&self, descriptor: &Descriptor) {
1066 self.disconnect_event_internal(descriptor, false);
1069 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1070 let mut peers = self.peers.lock().unwrap();
1071 peers.peers_needing_send.remove(descriptor);
1072 let peer_option = peers.peers.remove(descriptor);
1074 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1076 match peer.their_node_id {
1078 peers.node_id_to_descriptor.remove(&node_id);
1079 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1087 /// This function should be called roughly once every 30 seconds.
1088 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1090 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1091 pub fn timer_tick_occured(&self) {
1092 let mut peers_lock = self.peers.lock().unwrap();
1094 let peers = &mut *peers_lock;
1095 let peers_needing_send = &mut peers.peers_needing_send;
1096 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1097 let peers = &mut peers.peers;
1099 peers.retain(|descriptor, peer| {
1100 if peer.awaiting_pong == true {
1101 peers_needing_send.remove(descriptor);
1102 match peer.their_node_id {
1104 node_id_to_descriptor.remove(&node_id);
1105 self.message_handler.chan_handler.peer_disconnected(&node_id, true);
1111 let ping = msgs::Ping {
1115 peer.pending_outbound_buffer.push_back(encode_msg!(&ping));
1116 let mut descriptor_clone = descriptor.clone();
1117 self.do_attempt_write_data(&mut descriptor_clone, peer);
1119 if peer.awaiting_pong {
1120 false // Drop the peer
1122 peer.awaiting_pong = true;
1132 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1135 use util::test_utils;
1136 use util::logger::Logger;
1138 use secp256k1::Secp256k1;
1139 use secp256k1::key::{SecretKey, PublicKey};
1141 use rand::{thread_rng, Rng};
1143 use std::sync::{Arc};
1145 #[derive(PartialEq, Eq, Clone, Hash)]
1146 struct FileDescriptor {
1150 impl SocketDescriptor for FileDescriptor {
1151 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1155 fn disconnect_socket(&mut self) {}
1158 fn create_chan_handlers(peer_count: usize) -> Vec<test_utils::TestChannelMessageHandler> {
1159 let mut chan_handlers = Vec::new();
1160 for _ in 0..peer_count {
1161 let chan_handler = test_utils::TestChannelMessageHandler::new();
1162 chan_handlers.push(chan_handler);
1168 fn create_network<'a>(peer_count: usize, chan_handlers: &'a Vec<test_utils::TestChannelMessageHandler>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>> {
1169 let mut peers = Vec::new();
1170 let mut rng = thread_rng();
1171 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1172 let mut ephemeral_bytes = [0; 32];
1173 rng.fill_bytes(&mut ephemeral_bytes);
1175 for i in 0..peer_count {
1176 let router = test_utils::TestRoutingMessageHandler::new();
1178 let mut key_slice = [0;32];
1179 rng.fill_bytes(&mut key_slice);
1180 SecretKey::from_slice(&key_slice).unwrap()
1182 let msg_handler = MessageHandler { chan_handler: &chan_handlers[i], route_handler: Arc::new(router) };
1183 let peer = PeerManager::new(msg_handler, node_id, &ephemeral_bytes, Arc::clone(&logger));
1190 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>) {
1191 let secp_ctx = Secp256k1::new();
1192 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1193 let fd = FileDescriptor { fd: 1};
1194 peer_a.new_inbound_connection(fd.clone()).unwrap();
1195 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1199 fn test_disconnect_peer() {
1200 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1201 // push a DisconnectPeer event to remove the node flagged by id
1202 let chan_handlers = create_chan_handlers(2);
1203 let chan_handler = test_utils::TestChannelMessageHandler::new();
1204 let mut peers = create_network(2, &chan_handlers);
1205 establish_connection(&peers[0], &peers[1]);
1206 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1208 let secp_ctx = Secp256k1::new();
1209 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1211 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1213 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1215 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1216 peers[0].message_handler.chan_handler = &chan_handler;
1218 peers[0].process_events();
1219 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1222 fn test_timer_tick_occured(){
1223 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1224 let chan_handlers = create_chan_handlers(2);
1225 let peers = create_network(2, &chan_handlers);
1226 establish_connection(&peers[0], &peers[1]);
1227 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1229 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1230 peers[0].timer_tick_occured();
1231 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1233 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1234 peers[0].timer_tick_occured();
1235 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);