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 util::ser::{Writeable, Writer, Readable};
16 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
18 use util::events::{MessageSendEvent, MessageSendEventsProvider};
19 use util::logger::Logger;
21 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
22 use std::sync::{Arc, Mutex};
23 use std::sync::atomic::{AtomicUsize, Ordering};
24 use std::{cmp,error,hash,fmt};
27 use bitcoin_hashes::sha256::Hash as Sha256;
28 use bitcoin_hashes::sha256::HashEngine as Sha256Engine;
29 use bitcoin_hashes::{HashEngine, Hash};
31 /// Provides references to trait impls which handle different types of messages.
32 pub struct MessageHandler<CM: Deref> where CM::Target: msgs::ChannelMessageHandler {
33 /// A message handler which handles messages specific to channels. Usually this is just a
34 /// ChannelManager object.
36 /// A message handler which handles messages updating our knowledge of the network channel
37 /// graph. Usually this is just a Router object.
38 pub route_handler: Arc<msgs::RoutingMessageHandler>,
41 /// Provides an object which can be used to send data to and which uniquely identifies a connection
42 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
43 /// implement Hash to meet the PeerManager API.
45 /// For efficiency, Clone should be relatively cheap for this type.
47 /// You probably want to just extend an int and put a file descriptor in a struct and implement
48 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
49 /// careful to ensure you don't have races whereby you might register a new connection with an fd
50 /// the same as a yet-to-be-disconnect_event()-ed.
51 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
52 /// Attempts to send some data from the given slice to the peer.
54 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
55 /// Note that in the disconnected case, a disconnect_event must still fire and further write
56 /// attempts may occur until that time.
58 /// If the returned size is smaller than data.len(), a write_available event must
59 /// trigger the next time more data can be written. Additionally, until the a send_data event
60 /// completes fully, no further read_events should trigger on the same peer!
62 /// If a read_event on this descriptor had previously returned true (indicating that read
63 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
64 /// indicating that read events on this descriptor should resume. A resume_read of false does
65 /// *not* imply that further read events should be paused.
66 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
67 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
68 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
69 /// No disconnect_event should be generated as a result of this call, though obviously races
70 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
71 /// that event completing.
72 fn disconnect_socket(&mut self);
75 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
76 /// generate no further read/write_events for the descriptor, only triggering a single
77 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
78 /// no such disconnect_event must be generated and the socket be silently disconencted).
79 pub struct PeerHandleError {
80 /// Used to indicate that we probably can't make any future connections to this peer, implying
81 /// we should go ahead and force-close any channels we have with it.
82 no_connection_possible: bool,
84 impl fmt::Debug for PeerHandleError {
85 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
86 formatter.write_str("Peer Sent Invalid Data")
89 impl fmt::Display for PeerHandleError {
90 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
91 formatter.write_str("Peer Sent Invalid Data")
94 impl error::Error for PeerHandleError {
95 fn description(&self) -> &str {
96 "Peer Sent Invalid Data"
100 enum InitSyncTracker{
102 ChannelsSyncing(u64),
103 NodesSyncing(PublicKey),
107 channel_encryptor: PeerChannelEncryptor,
109 their_node_id: Option<PublicKey>,
110 their_features: Option<InitFeatures>,
112 pending_outbound_buffer: LinkedList<Vec<u8>>,
113 pending_outbound_buffer_first_msg_offset: usize,
114 awaiting_write_event: bool,
116 pending_read_buffer: Vec<u8>,
117 pending_read_buffer_pos: usize,
118 pending_read_is_header: bool,
120 sync_status: InitSyncTracker,
126 /// Returns true if the channel announcements/updates for the given channel should be
127 /// forwarded to this peer.
128 /// If we are sending our routing table to this peer and we have not yet sent channel
129 /// announcements/updates for the given channel_id then we will send it when we get to that
130 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
131 /// sent the old versions, we should send the update, and so return true here.
132 fn should_forward_channel(&self, channel_id: u64)->bool{
133 match self.sync_status {
134 InitSyncTracker::NoSyncRequested => true,
135 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
136 InitSyncTracker::NodesSyncing(_) => true,
140 fn should_forward_node(&self, node_id: PublicKey) -> bool {
141 match self.sync_status {
142 InitSyncTracker::NoSyncRequested => true,
143 InitSyncTracker::ChannelsSyncing(_) => false,
144 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
149 struct PeerHolder<Descriptor: SocketDescriptor> {
150 peers: HashMap<Descriptor, Peer>,
151 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
152 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
153 peers_needing_send: HashSet<Descriptor>,
154 /// Only add to this set when noise completes:
155 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
158 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
159 fn _check_usize_is_32_or_64() {
160 // See below, less than 32 bit pointers may be unsafe here!
161 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
164 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
165 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
166 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
167 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
168 /// issues such as overly long function definitions.
169 pub type SimpleArcPeerManager<SD, M> = Arc<PeerManager<SD, SimpleArcChannelManager<M>>>;
171 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
172 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
173 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
174 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
175 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
176 /// helps with issues such as long function definitions.
177 pub type SimpleRefPeerManager<'a, SD, M> = PeerManager<SD, SimpleRefChannelManager<'a, M>>;
179 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
180 /// events into messages which it passes on to its MessageHandlers.
182 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
183 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
184 /// essentially you should default to using a SimpleRefPeerManager, and use a
185 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
186 /// you're using lightning-net-tokio.
187 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref> where CM::Target: msgs::ChannelMessageHandler {
188 message_handler: MessageHandler<CM>,
189 peers: Mutex<PeerHolder<Descriptor>>,
190 our_node_secret: SecretKey,
191 ephemeral_key_midstate: Sha256Engine,
193 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
194 // bits we will never realistically count into high:
195 peer_counter_low: AtomicUsize,
196 peer_counter_high: AtomicUsize,
198 initial_syncs_sent: AtomicUsize,
202 struct VecWriter(Vec<u8>);
203 impl Writer for VecWriter {
204 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
205 self.0.extend_from_slice(buf);
208 fn size_hint(&mut self, size: usize) {
209 self.0.reserve_exact(size);
213 macro_rules! encode_msg {
214 ($msg: expr, $msg_code: expr) => {{
215 let mut msg = VecWriter(Vec::new());
216 ($msg_code as u16).write(&mut msg).unwrap();
217 $msg.write(&mut msg).unwrap();
222 //TODO: Really should do something smarter for this
223 const INITIAL_SYNCS_TO_SEND: usize = 5;
225 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
226 /// PeerIds may repeat, but only after disconnect_event() has been called.
227 impl<Descriptor: SocketDescriptor, CM: Deref> PeerManager<Descriptor, CM> where CM::Target: msgs::ChannelMessageHandler {
228 /// Constructs a new PeerManager with the given message handlers and node_id secret key
229 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
230 /// cryptographically secure random bytes.
231 pub fn new(message_handler: MessageHandler<CM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: Arc<Logger>) -> PeerManager<Descriptor, CM> {
232 let mut ephemeral_key_midstate = Sha256::engine();
233 ephemeral_key_midstate.input(ephemeral_random_data);
236 message_handler: message_handler,
237 peers: Mutex::new(PeerHolder {
238 peers: HashMap::new(),
239 peers_needing_send: HashSet::new(),
240 node_id_to_descriptor: HashMap::new()
242 our_node_secret: our_node_secret,
243 ephemeral_key_midstate,
244 peer_counter_low: AtomicUsize::new(0),
245 peer_counter_high: AtomicUsize::new(0),
246 initial_syncs_sent: AtomicUsize::new(0),
251 /// Get the list of node ids for peers which have completed the initial handshake.
253 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
254 /// new_outbound_connection, however entries will only appear once the initial handshake has
255 /// completed and we are sure the remote peer has the private key for the given node_id.
256 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
257 let peers = self.peers.lock().unwrap();
258 peers.peers.values().filter_map(|p| {
259 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
266 fn get_ephemeral_key(&self) -> SecretKey {
267 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
268 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
269 let high = if low == 0 {
270 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
272 self.peer_counter_high.load(Ordering::Acquire)
274 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
275 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
276 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
279 /// Indicates a new outbound connection has been established to a node with the given node_id.
280 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
281 /// descriptor but must disconnect the connection immediately.
283 /// Returns a small number of bytes to send to the remote node (currently always 50).
285 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
286 /// disconnect_event.
287 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
288 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
289 let res = peer_encryptor.get_act_one().to_vec();
290 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
292 let mut peers = self.peers.lock().unwrap();
293 if peers.peers.insert(descriptor, Peer {
294 channel_encryptor: peer_encryptor,
297 their_features: None,
299 pending_outbound_buffer: LinkedList::new(),
300 pending_outbound_buffer_first_msg_offset: 0,
301 awaiting_write_event: false,
303 pending_read_buffer: pending_read_buffer,
304 pending_read_buffer_pos: 0,
305 pending_read_is_header: false,
307 sync_status: InitSyncTracker::NoSyncRequested,
309 awaiting_pong: false,
311 panic!("PeerManager driver duplicated descriptors!");
316 /// Indicates a new inbound connection has been established.
318 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
319 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
320 /// call disconnect_event for the new descriptor but must disconnect the connection
323 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
324 /// disconnect_event.
325 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
326 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
327 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
329 let mut peers = self.peers.lock().unwrap();
330 if peers.peers.insert(descriptor, Peer {
331 channel_encryptor: peer_encryptor,
334 their_features: None,
336 pending_outbound_buffer: LinkedList::new(),
337 pending_outbound_buffer_first_msg_offset: 0,
338 awaiting_write_event: false,
340 pending_read_buffer: pending_read_buffer,
341 pending_read_buffer_pos: 0,
342 pending_read_is_header: false,
344 sync_status: InitSyncTracker::NoSyncRequested,
346 awaiting_pong: false,
348 panic!("PeerManager driver duplicated descriptors!");
353 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
354 macro_rules! encode_and_send_msg {
355 ($msg: expr, $msg_code: expr) => {
357 log_trace!(self, "Encoding and sending sync update message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
358 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
362 const MSG_BUFF_SIZE: usize = 10;
363 while !peer.awaiting_write_event {
364 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
365 match peer.sync_status {
366 InitSyncTracker::NoSyncRequested => {},
367 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
368 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
369 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(0, steps);
370 for &(ref announce, ref update_a, ref update_b) in all_messages.iter() {
371 encode_and_send_msg!(announce, 256);
372 encode_and_send_msg!(update_a, 258);
373 encode_and_send_msg!(update_b, 258);
374 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
376 if all_messages.is_empty() || all_messages.len() != steps as usize {
377 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
380 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
381 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
382 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
383 for msg in all_messages.iter() {
384 encode_and_send_msg!(msg, 256);
385 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
387 if all_messages.is_empty() || all_messages.len() != steps as usize {
388 peer.sync_status = InitSyncTracker::NoSyncRequested;
391 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
392 InitSyncTracker::NodesSyncing(key) => {
393 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
394 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
395 for msg in all_messages.iter() {
396 encode_and_send_msg!(msg, 256);
397 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
399 if all_messages.is_empty() || all_messages.len() != steps as usize {
400 peer.sync_status = InitSyncTracker::NoSyncRequested;
407 let next_buff = match peer.pending_outbound_buffer.front() {
412 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
413 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
414 let data_sent = descriptor.send_data(pending, should_be_reading);
415 peer.pending_outbound_buffer_first_msg_offset += data_sent;
416 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
418 peer.pending_outbound_buffer_first_msg_offset = 0;
419 peer.pending_outbound_buffer.pop_front();
421 peer.awaiting_write_event = true;
426 /// Indicates that there is room to write data to the given socket descriptor.
428 /// May return an Err to indicate that the connection should be closed.
430 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
431 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
432 /// invariants around calling write_event in case a write did not fully complete must still
433 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
434 /// Panics if the descriptor was not previously registered in a new_\*_connection event.
435 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
436 let mut peers = self.peers.lock().unwrap();
437 match peers.peers.get_mut(descriptor) {
438 None => panic!("Descriptor for write_event is not already known to PeerManager"),
440 peer.awaiting_write_event = false;
441 self.do_attempt_write_data(descriptor, peer);
447 /// Indicates that data was read from the given socket descriptor.
449 /// May return an Err to indicate that the connection should be closed.
451 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
452 /// Thus, however, you almost certainly want to call process_events() after any read_event to
453 /// generate send_data calls to handle responses.
455 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
456 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer).
458 /// Panics if the descriptor was not previously registered in a new_*_connection event.
459 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
460 match self.do_read_event(peer_descriptor, data) {
463 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
469 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
471 let mut peers_lock = self.peers.lock().unwrap();
472 let peers = &mut *peers_lock;
473 let pause_read = match peers.peers.get_mut(peer_descriptor) {
474 None => panic!("Descriptor for read_event is not already known to PeerManager"),
476 assert!(peer.pending_read_buffer.len() > 0);
477 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
479 let mut read_pos = 0;
480 while read_pos < data.len() {
482 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
483 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]);
484 read_pos += data_to_copy;
485 peer.pending_read_buffer_pos += data_to_copy;
488 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
489 peer.pending_read_buffer_pos = 0;
491 macro_rules! encode_and_send_msg {
492 ($msg: expr, $msg_code: expr) => {
494 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
495 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
496 peers.peers_needing_send.insert(peer_descriptor.clone());
501 macro_rules! try_potential_handleerror {
507 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
508 //TODO: Try to push msg
509 log_trace!(self, "Got Err handling message, disconnecting peer because {}", e.err);
510 return Err(PeerHandleError{ no_connection_possible: false });
512 msgs::ErrorAction::IgnoreError => {
513 log_trace!(self, "Got Err handling message, ignoring because {}", e.err);
516 msgs::ErrorAction::SendErrorMessage { msg } => {
517 log_trace!(self, "Got Err handling message, sending Error message because {}", e.err);
518 encode_and_send_msg!(msg, 17);
527 macro_rules! try_potential_decodeerror {
533 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError{ no_connection_possible: false }),
534 msgs::DecodeError::UnknownRequiredFeature => {
535 log_debug!(self, "Got a channel/node announcement with an known required feature flag, you may want to update!");
538 msgs::DecodeError::InvalidValue => {
539 log_debug!(self, "Got an invalid value while deserializing message");
540 return Err(PeerHandleError{ no_connection_possible: false });
542 msgs::DecodeError::ShortRead => {
543 log_debug!(self, "Deserialization failed due to shortness of message");
544 return Err(PeerHandleError{ no_connection_possible: false });
546 msgs::DecodeError::ExtraAddressesPerType => {
547 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
550 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
551 msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
558 macro_rules! insert_node_id {
560 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
561 hash_map::Entry::Occupied(_) => {
562 log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
563 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
564 return Err(PeerHandleError{ no_connection_possible: false })
566 hash_map::Entry::Vacant(entry) => {
567 log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
568 entry.insert(peer_descriptor.clone())
574 let next_step = peer.channel_encryptor.get_noise_step();
576 NextNoiseStep::ActOne => {
577 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();
578 peer.pending_outbound_buffer.push_back(act_two);
579 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
581 NextNoiseStep::ActTwo => {
582 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
583 peer.pending_outbound_buffer.push_back(act_three.to_vec());
584 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
585 peer.pending_read_is_header = true;
587 peer.their_node_id = Some(their_node_id);
589 let mut features = InitFeatures::supported();
590 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
591 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
592 features.set_initial_routing_sync();
594 encode_and_send_msg!(msgs::Init {
598 NextNoiseStep::ActThree => {
599 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
600 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
601 peer.pending_read_is_header = true;
602 peer.their_node_id = Some(their_node_id);
605 NextNoiseStep::NoiseComplete => {
606 if peer.pending_read_is_header {
607 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
608 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
609 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
610 if msg_len < 2 { // Need at least the message type tag
611 return Err(PeerHandleError{ no_connection_possible: false });
613 peer.pending_read_is_header = false;
615 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
616 assert!(msg_data.len() >= 2);
619 peer.pending_read_buffer = [0; 18].to_vec();
620 peer.pending_read_is_header = true;
622 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
623 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
624 if msg_type != 16 && peer.their_features.is_none() {
625 // Need an init message as first message
626 log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
627 return Err(PeerHandleError{ no_connection_possible: false });
629 let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
631 // Connection control:
633 let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
634 if msg.features.requires_unknown_bits() {
635 log_info!(self, "Peer global features required unknown version bits");
636 return Err(PeerHandleError{ no_connection_possible: true });
638 if msg.features.requires_unknown_bits() {
639 log_info!(self, "Peer local features required unknown version bits");
640 return Err(PeerHandleError{ no_connection_possible: true });
642 if peer.their_features.is_some() {
643 return Err(PeerHandleError{ no_connection_possible: false });
646 log_info!(self, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, unkown local flags: {}, unknown global flags: {}",
647 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
648 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
649 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
650 if msg.features.supports_unknown_bits() { "present" } else { "none" },
651 if msg.features.supports_unknown_bits() { "present" } else { "none" });
653 if msg.features.initial_routing_sync() {
654 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
655 peers.peers_needing_send.insert(peer_descriptor.clone());
659 let mut features = InitFeatures::supported();
660 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
661 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
662 features.set_initial_routing_sync();
665 encode_and_send_msg!(msgs::Init {
670 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
671 peer.their_features = Some(msg.features);
674 let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
675 let mut data_is_printable = true;
676 for b in msg.data.bytes() {
677 if b < 32 || b > 126 {
678 data_is_printable = false;
683 if data_is_printable {
684 log_debug!(self, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
686 log_debug!(self, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
688 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
689 if msg.channel_id == [0; 32] {
690 return Err(PeerHandleError{ no_connection_possible: true });
695 let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
696 if msg.ponglen < 65532 {
697 let resp = msgs::Pong { byteslen: msg.ponglen };
698 encode_and_send_msg!(resp, 19);
702 peer.awaiting_pong = false;
703 try_potential_decodeerror!(msgs::Pong::read(&mut reader));
707 let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
708 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
711 let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
712 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
716 let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
717 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
720 let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
721 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
724 let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
725 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
729 let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
730 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
733 let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
734 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
738 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
739 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
742 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
743 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
746 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
747 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
750 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
751 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
755 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
756 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
759 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
760 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
763 let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
764 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
767 let msg = try_potential_decodeerror!(msgs::ChannelReestablish::read(&mut reader));
768 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
773 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
774 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
777 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
778 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
781 // TODO: forward msg along to all our other peers!
785 let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
786 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
789 // TODO: forward msg along to all our other peers!
793 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
794 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
797 // TODO: forward msg along to all our other peers!
801 if (msg_type & 1) == 0 {
802 return Err(PeerHandleError{ no_connection_possible: true });
812 self.do_attempt_write_data(peer_descriptor, peer);
814 peer.pending_outbound_buffer.len() > 10 // pause_read
824 /// Checks for any events generated by our handlers and processes them. Includes sending most
825 /// response messages as well as messages generated by calls to handler functions directly (eg
826 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
827 pub fn process_events(&self) {
829 // TODO: There are some DoS attacks here where you can flood someone's outbound send
830 // buffer by doing things like announcing channels on another node. We should be willing to
831 // drop optional-ish messages when send buffers get full!
833 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
834 let mut peers_lock = self.peers.lock().unwrap();
835 let peers = &mut *peers_lock;
836 for event in events_generated.drain(..) {
837 macro_rules! get_peer_for_forwarding {
838 ($node_id: expr, $handle_no_such_peer: block) => {
840 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
841 Some(descriptor) => descriptor.clone(),
843 $handle_no_such_peer;
847 match peers.peers.get_mut(&descriptor) {
849 if peer.their_features.is_none() {
850 $handle_no_such_peer;
855 None => panic!("Inconsistent peers set state!"),
861 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
862 log_trace!(self, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
863 log_pubkey!(node_id),
864 log_bytes!(msg.temporary_channel_id));
865 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
866 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
868 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
869 self.do_attempt_write_data(&mut descriptor, peer);
871 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
872 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
873 log_pubkey!(node_id),
874 log_bytes!(msg.temporary_channel_id));
875 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
876 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
878 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
879 self.do_attempt_write_data(&mut descriptor, peer);
881 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
882 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
883 log_pubkey!(node_id),
884 log_bytes!(msg.temporary_channel_id),
885 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
886 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
887 //TODO: generate a DiscardFunding event indicating to the wallet that
888 //they should just throw away this funding transaction
890 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
891 self.do_attempt_write_data(&mut descriptor, peer);
893 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
894 log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
895 log_pubkey!(node_id),
896 log_bytes!(msg.channel_id));
897 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
898 //TODO: generate a DiscardFunding event indicating to the wallet that
899 //they should just throw away this funding transaction
901 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
902 self.do_attempt_write_data(&mut descriptor, peer);
904 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
905 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
906 log_pubkey!(node_id),
907 log_bytes!(msg.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 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
912 self.do_attempt_write_data(&mut descriptor, peer);
914 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
915 log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
916 log_pubkey!(node_id),
917 log_bytes!(msg.channel_id));
918 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
919 //TODO: generate a DiscardFunding event indicating to the wallet that
920 //they should just throw away this funding transaction
922 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
923 self.do_attempt_write_data(&mut descriptor, peer);
925 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 } } => {
926 log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
927 log_pubkey!(node_id),
928 update_add_htlcs.len(),
929 update_fulfill_htlcs.len(),
930 update_fail_htlcs.len(),
931 log_bytes!(commitment_signed.channel_id));
932 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
933 //TODO: Do whatever we're gonna do for handling dropped messages
935 for msg in update_add_htlcs {
936 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
938 for msg in update_fulfill_htlcs {
939 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
941 for msg in update_fail_htlcs {
942 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
944 for msg in update_fail_malformed_htlcs {
945 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 135)));
947 if let &Some(ref msg) = update_fee {
948 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
950 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
951 self.do_attempt_write_data(&mut descriptor, peer);
953 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
954 log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
955 log_pubkey!(node_id),
956 log_bytes!(msg.channel_id));
957 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
958 //TODO: Do whatever we're gonna do for handling dropped messages
960 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
961 self.do_attempt_write_data(&mut descriptor, peer);
963 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
964 log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
965 log_pubkey!(node_id),
966 log_bytes!(msg.channel_id));
967 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
968 //TODO: Do whatever we're gonna do for handling dropped messages
970 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 39)));
971 self.do_attempt_write_data(&mut descriptor, peer);
973 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
974 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
975 log_pubkey!(node_id),
976 log_bytes!(msg.channel_id));
977 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
978 //TODO: Do whatever we're gonna do for handling dropped messages
980 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
981 self.do_attempt_write_data(&mut descriptor, peer);
983 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
984 log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
985 log_pubkey!(node_id),
986 log_bytes!(msg.channel_id));
987 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
988 //TODO: Do whatever we're gonna do for handling dropped messages
990 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 136)));
991 self.do_attempt_write_data(&mut descriptor, peer);
993 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
994 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
995 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
996 let encoded_msg = encode_msg!(msg, 256);
997 let encoded_update_msg = encode_msg!(update_msg, 258);
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 match peer.their_node_id {
1006 Some(their_node_id) => {
1007 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1012 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1013 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1014 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1018 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1019 log_trace!(self, "Handling BroadcastNodeAnnouncement event in peer_handler");
1020 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1021 let encoded_msg = encode_msg!(msg, 257);
1023 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1024 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1025 !peer.should_forward_node(msg.contents.node_id) {
1028 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1029 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1033 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1034 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1035 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1036 let encoded_msg = encode_msg!(msg, 258);
1038 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1039 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1040 !peer.should_forward_channel(msg.contents.short_channel_id) {
1043 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1044 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1048 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1049 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1051 MessageSendEvent::HandleError { ref node_id, ref action } => {
1053 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1054 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1055 peers.peers_needing_send.remove(&descriptor);
1056 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1057 if let Some(ref msg) = *msg {
1058 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1059 log_pubkey!(node_id),
1061 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
1062 // This isn't guaranteed to work, but if there is enough free
1063 // room in the send buffer, put the error message there...
1064 self.do_attempt_write_data(&mut descriptor, &mut peer);
1066 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1069 descriptor.disconnect_socket();
1070 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1073 msgs::ErrorAction::IgnoreError => {},
1074 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1075 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1076 log_pubkey!(node_id),
1078 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1079 //TODO: Do whatever we're gonna do for handling dropped messages
1081 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
1082 self.do_attempt_write_data(&mut descriptor, peer);
1089 for mut descriptor in peers.peers_needing_send.drain() {
1090 match peers.peers.get_mut(&descriptor) {
1091 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1092 None => panic!("Inconsistent peers set state!"),
1098 /// Indicates that the given socket descriptor's connection is now closed.
1100 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
1101 /// but must NOT be called if a PeerHandleError was provided out of a new_\*\_connection event!
1103 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1104 pub fn disconnect_event(&self, descriptor: &Descriptor) {
1105 self.disconnect_event_internal(descriptor, false);
1108 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1109 let mut peers = self.peers.lock().unwrap();
1110 peers.peers_needing_send.remove(descriptor);
1111 let peer_option = peers.peers.remove(descriptor);
1113 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1115 match peer.their_node_id {
1117 peers.node_id_to_descriptor.remove(&node_id);
1118 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1126 /// This function should be called roughly once every 30 seconds.
1127 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1129 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1130 pub fn timer_tick_occured(&self) {
1131 let mut peers_lock = self.peers.lock().unwrap();
1133 let peers = &mut *peers_lock;
1134 let peers_needing_send = &mut peers.peers_needing_send;
1135 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1136 let peers = &mut peers.peers;
1138 peers.retain(|descriptor, peer| {
1139 if peer.awaiting_pong == true {
1140 peers_needing_send.remove(descriptor);
1141 match peer.their_node_id {
1143 node_id_to_descriptor.remove(&node_id);
1144 self.message_handler.chan_handler.peer_disconnected(&node_id, true);
1150 let ping = msgs::Ping {
1154 peer.pending_outbound_buffer.push_back(encode_msg!(ping, 18));
1155 let mut descriptor_clone = descriptor.clone();
1156 self.do_attempt_write_data(&mut descriptor_clone, peer);
1158 if peer.awaiting_pong {
1159 false // Drop the peer
1161 peer.awaiting_pong = true;
1171 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1174 use util::test_utils;
1175 use util::logger::Logger;
1177 use secp256k1::Secp256k1;
1178 use secp256k1::key::{SecretKey, PublicKey};
1180 use rand::{thread_rng, Rng};
1182 use std::sync::{Arc};
1184 #[derive(PartialEq, Eq, Clone, Hash)]
1185 struct FileDescriptor {
1189 impl SocketDescriptor for FileDescriptor {
1190 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1194 fn disconnect_socket(&mut self) {}
1197 fn create_chan_handlers(peer_count: usize) -> Vec<test_utils::TestChannelMessageHandler> {
1198 let mut chan_handlers = Vec::new();
1199 for _ in 0..peer_count {
1200 let chan_handler = test_utils::TestChannelMessageHandler::new();
1201 chan_handlers.push(chan_handler);
1207 fn create_network<'a>(peer_count: usize, chan_handlers: &'a Vec<test_utils::TestChannelMessageHandler>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>> {
1208 let mut peers = Vec::new();
1209 let mut rng = thread_rng();
1210 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1211 let mut ephemeral_bytes = [0; 32];
1212 rng.fill_bytes(&mut ephemeral_bytes);
1214 for i in 0..peer_count {
1215 let router = test_utils::TestRoutingMessageHandler::new();
1217 let mut key_slice = [0;32];
1218 rng.fill_bytes(&mut key_slice);
1219 SecretKey::from_slice(&key_slice).unwrap()
1221 let msg_handler = MessageHandler { chan_handler: &chan_handlers[i], route_handler: Arc::new(router) };
1222 let peer = PeerManager::new(msg_handler, node_id, &ephemeral_bytes, Arc::clone(&logger));
1229 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler>) {
1230 let secp_ctx = Secp256k1::new();
1231 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret);
1232 let fd = FileDescriptor { fd: 1};
1233 peer_a.new_inbound_connection(fd.clone()).unwrap();
1234 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
1238 fn test_disconnect_peer() {
1239 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1240 // push a DisconnectPeer event to remove the node flagged by id
1241 let chan_handlers = create_chan_handlers(2);
1242 let chan_handler = test_utils::TestChannelMessageHandler::new();
1243 let mut peers = create_network(2, &chan_handlers);
1244 establish_connection(&peers[0], &peers[1]);
1245 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1247 let secp_ctx = Secp256k1::new();
1248 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1250 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1252 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1254 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1255 peers[0].message_handler.chan_handler = &chan_handler;
1257 peers[0].process_events();
1258 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1261 fn test_timer_tick_occured(){
1262 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1263 let chan_handlers = create_chan_handlers(2);
1264 let peers = create_network(2, &chan_handlers);
1265 establish_connection(&peers[0], &peers[1]);
1266 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1268 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1269 peers[0].timer_tick_occured();
1270 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1272 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1273 peers[0].timer_tick_occured();
1274 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);