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 NetGraphmsgHandler) with messages
7 //! they should handle, and encoding/sending response messages.
9 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
11 use ln::features::InitFeatures;
13 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
14 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
15 use util::ser::VecWriter;
16 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
20 use util::events::{MessageSendEvent, MessageSendEventsProvider};
21 use util::logger::Logger;
22 use routing::network_graph::NetGraphMsgHandler;
24 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
25 use std::sync::{Arc, Mutex};
26 use std::sync::atomic::{AtomicUsize, Ordering};
27 use std::{cmp,error,hash,fmt};
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
32 use bitcoin::hashes::{HashEngine, Hash};
34 /// Provides references to trait impls which handle different types of messages.
35 pub struct MessageHandler<CM: Deref, RM: Deref> where
36 CM::Target: ChannelMessageHandler,
37 RM::Target: RoutingMessageHandler {
38 /// A message handler which handles messages specific to channels. Usually this is just a
39 /// ChannelManager object.
41 /// A message handler which handles messages updating our knowledge of the network channel
42 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object.
43 pub route_handler: RM,
46 /// Provides an object which can be used to send data to and which uniquely identifies a connection
47 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
48 /// implement Hash to meet the PeerManager API.
50 /// For efficiency, Clone should be relatively cheap for this type.
52 /// You probably want to just extend an int and put a file descriptor in a struct and implement
53 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
54 /// be careful to ensure you don't have races whereby you might register a new connection with an
55 /// fd which is the same as a previous one which has yet to be removed via
56 /// PeerManager::socket_disconnected().
57 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
58 /// Attempts to send some data from the given slice to the peer.
60 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
61 /// Note that in the disconnected case, socket_disconnected must still fire and further write
62 /// attempts may occur until that time.
64 /// If the returned size is smaller than data.len(), a write_available event must
65 /// trigger the next time more data can be written. Additionally, until the a send_data event
66 /// completes fully, no further read_events should trigger on the same peer!
68 /// If a read_event on this descriptor had previously returned true (indicating that read
69 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
70 /// indicating that read events on this descriptor should resume. A resume_read of false does
71 /// *not* imply that further read events should be paused.
72 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
73 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
74 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
75 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
76 /// though races may occur whereby disconnect_socket is called after a call to
77 /// socket_disconnected but prior to socket_disconnected returning.
78 fn disconnect_socket(&mut self);
81 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
82 /// generate no further read_event/write_buffer_space_avail calls for the descriptor, only
83 /// triggering a single socket_disconnected call (unless it was provided in response to a
84 /// new_*_connection event, in which case no such socket_disconnected() must be called and the
85 /// socket silently disconencted).
86 pub struct PeerHandleError {
87 /// Used to indicate that we probably can't make any future connections to this peer, implying
88 /// we should go ahead and force-close any channels we have with it.
89 no_connection_possible: bool,
91 impl fmt::Debug for PeerHandleError {
92 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
93 formatter.write_str("Peer Sent Invalid Data")
96 impl fmt::Display for PeerHandleError {
97 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
98 formatter.write_str("Peer Sent Invalid Data")
101 impl error::Error for PeerHandleError {
102 fn description(&self) -> &str {
103 "Peer Sent Invalid Data"
107 enum InitSyncTracker{
109 ChannelsSyncing(u64),
110 NodesSyncing(PublicKey),
114 channel_encryptor: PeerChannelEncryptor,
116 their_node_id: Option<PublicKey>,
117 their_features: Option<InitFeatures>,
119 pending_outbound_buffer: LinkedList<Vec<u8>>,
120 pending_outbound_buffer_first_msg_offset: usize,
121 awaiting_write_event: bool,
123 pending_read_buffer: Vec<u8>,
124 pending_read_buffer_pos: usize,
125 pending_read_is_header: bool,
127 sync_status: InitSyncTracker,
133 /// Returns true if the channel announcements/updates for the given channel should be
134 /// forwarded to this peer.
135 /// If we are sending our routing table to this peer and we have not yet sent channel
136 /// announcements/updates for the given channel_id then we will send it when we get to that
137 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
138 /// sent the old versions, we should send the update, and so return true here.
139 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
140 match self.sync_status {
141 InitSyncTracker::NoSyncRequested => true,
142 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
143 InitSyncTracker::NodesSyncing(_) => true,
147 /// Similar to the above, but for node announcements indexed by node_id.
148 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
149 match self.sync_status {
150 InitSyncTracker::NoSyncRequested => true,
151 InitSyncTracker::ChannelsSyncing(_) => false,
152 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
157 struct PeerHolder<Descriptor: SocketDescriptor> {
158 peers: HashMap<Descriptor, Peer>,
159 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
160 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
161 peers_needing_send: HashSet<Descriptor>,
162 /// Only add to this set when noise completes:
163 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
166 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
167 fn _check_usize_is_32_or_64() {
168 // See below, less than 32 bit pointers may be unsafe here!
169 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
172 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
173 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
174 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
175 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
176 /// issues such as overly long function definitions.
177 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = Arc<PeerManager<SD, SimpleArcChannelManager<M, T, F, L>, Arc<NetGraphMsgHandler<Arc<C>, Arc<L>>>, Arc<L>>>;
179 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
180 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
181 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
182 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
183 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
184 /// helps with issues such as long function definitions.
185 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e NetGraphMsgHandler<&'g C, &'f L>, &'f L>;
187 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
188 /// events into messages which it passes on to its MessageHandlers.
190 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
191 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
192 /// essentially you should default to using a SimpleRefPeerManager, and use a
193 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
194 /// you're using lightning-net-tokio.
195 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
196 CM::Target: ChannelMessageHandler,
197 RM::Target: RoutingMessageHandler,
199 message_handler: MessageHandler<CM, RM>,
200 peers: Mutex<PeerHolder<Descriptor>>,
201 our_node_secret: SecretKey,
202 ephemeral_key_midstate: Sha256Engine,
204 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
205 // bits we will never realistically count into high:
206 peer_counter_low: AtomicUsize,
207 peer_counter_high: AtomicUsize,
212 macro_rules! encode_msg {
214 let mut buffer = VecWriter(Vec::new());
215 wire::write($msg, &mut buffer).unwrap();
220 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
221 /// PeerIds may repeat, but only after socket_disconnected() has been called.
222 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
223 CM::Target: ChannelMessageHandler,
224 RM::Target: RoutingMessageHandler,
226 /// Constructs a new PeerManager with the given message handlers and node_id secret key
227 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
228 /// cryptographically secure random bytes.
229 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
230 let mut ephemeral_key_midstate = Sha256::engine();
231 ephemeral_key_midstate.input(ephemeral_random_data);
235 peers: Mutex::new(PeerHolder {
236 peers: HashMap::new(),
237 peers_needing_send: HashSet::new(),
238 node_id_to_descriptor: HashMap::new()
241 ephemeral_key_midstate,
242 peer_counter_low: AtomicUsize::new(0),
243 peer_counter_high: AtomicUsize::new(0),
248 /// Get the list of node ids for peers which have completed the initial handshake.
250 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
251 /// new_outbound_connection, however entries will only appear once the initial handshake has
252 /// completed and we are sure the remote peer has the private key for the given node_id.
253 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
254 let peers = self.peers.lock().unwrap();
255 peers.peers.values().filter_map(|p| {
256 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
263 fn get_ephemeral_key(&self) -> SecretKey {
264 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
265 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
266 let high = if low == 0 {
267 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
269 self.peer_counter_high.load(Ordering::Acquire)
271 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
272 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
273 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
276 /// Indicates a new outbound connection has been established to a node with the given node_id.
277 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
278 /// descriptor but must disconnect the connection immediately.
280 /// Returns a small number of bytes to send to the remote node (currently always 50).
282 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
283 /// socket_disconnected().
284 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
285 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
286 let res = peer_encryptor.get_act_one().to_vec();
287 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
289 let mut peers = self.peers.lock().unwrap();
290 if peers.peers.insert(descriptor, Peer {
291 channel_encryptor: peer_encryptor,
294 their_features: None,
296 pending_outbound_buffer: LinkedList::new(),
297 pending_outbound_buffer_first_msg_offset: 0,
298 awaiting_write_event: false,
300 pending_read_buffer: pending_read_buffer,
301 pending_read_buffer_pos: 0,
302 pending_read_is_header: false,
304 sync_status: InitSyncTracker::NoSyncRequested,
306 awaiting_pong: false,
308 panic!("PeerManager driver duplicated descriptors!");
313 /// Indicates a new inbound connection has been established.
315 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
316 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
317 /// call socket_disconnected for the new descriptor but must disconnect the connection
320 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
321 /// socket_disconnected called.
322 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
323 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
324 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
326 let mut peers = self.peers.lock().unwrap();
327 if peers.peers.insert(descriptor, Peer {
328 channel_encryptor: peer_encryptor,
331 their_features: None,
333 pending_outbound_buffer: LinkedList::new(),
334 pending_outbound_buffer_first_msg_offset: 0,
335 awaiting_write_event: false,
337 pending_read_buffer: pending_read_buffer,
338 pending_read_buffer_pos: 0,
339 pending_read_is_header: false,
341 sync_status: InitSyncTracker::NoSyncRequested,
343 awaiting_pong: false,
345 panic!("PeerManager driver duplicated descriptors!");
350 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
351 macro_rules! encode_and_send_msg {
354 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
355 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
359 const MSG_BUFF_SIZE: usize = 10;
360 while !peer.awaiting_write_event {
361 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
362 match peer.sync_status {
363 InitSyncTracker::NoSyncRequested => {},
364 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
365 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
366 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
367 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
368 encode_and_send_msg!(announce);
369 if let &Some(ref update_a) = update_a_option {
370 encode_and_send_msg!(update_a);
372 if let &Some(ref update_b) = update_b_option {
373 encode_and_send_msg!(update_b);
375 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
377 if all_messages.is_empty() || all_messages.len() != steps as usize {
378 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
381 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
382 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
383 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
384 for msg in all_messages.iter() {
385 encode_and_send_msg!(msg);
386 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
388 if all_messages.is_empty() || all_messages.len() != steps as usize {
389 peer.sync_status = InitSyncTracker::NoSyncRequested;
392 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
393 InitSyncTracker::NodesSyncing(key) => {
394 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
395 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
396 for msg in all_messages.iter() {
397 encode_and_send_msg!(msg);
398 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
400 if all_messages.is_empty() || all_messages.len() != steps as usize {
401 peer.sync_status = InitSyncTracker::NoSyncRequested;
408 let next_buff = match peer.pending_outbound_buffer.front() {
413 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
414 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
415 let data_sent = descriptor.send_data(pending, should_be_reading);
416 peer.pending_outbound_buffer_first_msg_offset += data_sent;
417 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
419 peer.pending_outbound_buffer_first_msg_offset = 0;
420 peer.pending_outbound_buffer.pop_front();
422 peer.awaiting_write_event = true;
427 /// Indicates that there is room to write data to the given socket descriptor.
429 /// May return an Err to indicate that the connection should be closed.
431 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
432 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
433 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
434 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
435 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
436 /// new_\*_connection event.
437 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
438 let mut peers = self.peers.lock().unwrap();
439 match peers.peers.get_mut(descriptor) {
440 None => panic!("Descriptor for write_event is not already known to PeerManager"),
442 peer.awaiting_write_event = false;
443 self.do_attempt_write_data(descriptor, peer);
449 /// Indicates that data was read from the given socket descriptor.
451 /// May return an Err to indicate that the connection should be closed.
453 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
454 /// Thus, however, you almost certainly want to call process_events() after any read_event to
455 /// generate send_data calls to handle responses.
457 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
458 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
460 /// Panics if the descriptor was not previously registered in a new_*_connection event.
461 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
462 match self.do_read_event(peer_descriptor, data) {
465 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
471 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
473 let mut peers_lock = self.peers.lock().unwrap();
474 let peers = &mut *peers_lock;
475 let pause_read = match peers.peers.get_mut(peer_descriptor) {
476 None => panic!("Descriptor for read_event is not already known to PeerManager"),
478 assert!(peer.pending_read_buffer.len() > 0);
479 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
481 let mut read_pos = 0;
482 while read_pos < data.len() {
484 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
485 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]);
486 read_pos += data_to_copy;
487 peer.pending_read_buffer_pos += data_to_copy;
490 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
491 peer.pending_read_buffer_pos = 0;
493 macro_rules! encode_and_send_msg {
496 log_trace!(self.logger, "Encoding and sending message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
497 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&$msg)[..]));
498 peers.peers_needing_send.insert(peer_descriptor.clone());
503 macro_rules! try_potential_handleerror {
509 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
510 //TODO: Try to push msg
511 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
512 return Err(PeerHandleError{ no_connection_possible: false });
514 msgs::ErrorAction::IgnoreError => {
515 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
518 msgs::ErrorAction::SendErrorMessage { msg } => {
519 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
520 encode_and_send_msg!(msg);
529 macro_rules! insert_node_id {
531 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
532 hash_map::Entry::Occupied(_) => {
533 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
534 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
535 return Err(PeerHandleError{ no_connection_possible: false })
537 hash_map::Entry::Vacant(entry) => {
538 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
539 entry.insert(peer_descriptor.clone())
545 let next_step = peer.channel_encryptor.get_noise_step();
547 NextNoiseStep::ActOne => {
548 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();
549 peer.pending_outbound_buffer.push_back(act_two);
550 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
552 NextNoiseStep::ActTwo => {
553 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
554 peer.pending_outbound_buffer.push_back(act_three.to_vec());
555 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
556 peer.pending_read_is_header = true;
558 peer.their_node_id = Some(their_node_id);
560 let mut features = InitFeatures::known();
561 if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
562 features.clear_initial_routing_sync();
565 let resp = msgs::Init { features };
566 encode_and_send_msg!(resp);
568 NextNoiseStep::ActThree => {
569 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
570 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
571 peer.pending_read_is_header = true;
572 peer.their_node_id = Some(their_node_id);
575 NextNoiseStep::NoiseComplete => {
576 if peer.pending_read_is_header {
577 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
578 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
579 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
580 if msg_len < 2 { // Need at least the message type tag
581 return Err(PeerHandleError{ no_connection_possible: false });
583 peer.pending_read_is_header = false;
585 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
586 assert!(msg_data.len() >= 2);
589 peer.pending_read_buffer = [0; 18].to_vec();
590 peer.pending_read_is_header = true;
592 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
593 let message_result = wire::read(&mut reader);
594 let message = match message_result {
598 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
599 msgs::DecodeError::UnknownRequiredFeature => {
600 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
603 msgs::DecodeError::InvalidValue => {
604 log_debug!(self.logger, "Got an invalid value while deserializing message");
605 return Err(PeerHandleError { no_connection_possible: false });
607 msgs::DecodeError::ShortRead => {
608 log_debug!(self.logger, "Deserialization failed due to shortness of message");
609 return Err(PeerHandleError { no_connection_possible: false });
611 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
612 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
617 log_trace!(self.logger, "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.logger, "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.logger, "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.logger, "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.logger, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, static_remote_key: {}, 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_static_remote_key() { "supported" } else { "not supported"},
646 if msg.features.supports_unknown_bits() { "present" } else { "none" },
647 if msg.features.supports_unknown_bits() { "present" } else { "none" });
649 if msg.features.initial_routing_sync() {
650 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
651 peers.peers_needing_send.insert(peer_descriptor.clone());
653 if !msg.features.supports_static_remote_key() {
654 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
655 return Err(PeerHandleError{ no_connection_possible: true });
659 let mut features = InitFeatures::known();
660 if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
661 features.clear_initial_routing_sync();
664 let resp = msgs::Init { features };
665 encode_and_send_msg!(resp);
668 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
669 peer.their_features = Some(msg.features);
671 wire::Message::Error(msg) => {
672 let mut data_is_printable = true;
673 for b in msg.data.bytes() {
674 if b < 32 || b > 126 {
675 data_is_printable = false;
680 if data_is_printable {
681 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
683 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
685 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
686 if msg.channel_id == [0; 32] {
687 return Err(PeerHandleError{ no_connection_possible: true });
691 wire::Message::Ping(msg) => {
692 if msg.ponglen < 65532 {
693 let resp = msgs::Pong { byteslen: msg.ponglen };
694 encode_and_send_msg!(resp);
697 wire::Message::Pong(_msg) => {
698 peer.awaiting_pong = false;
702 wire::Message::OpenChannel(msg) => {
703 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
705 wire::Message::AcceptChannel(msg) => {
706 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
709 wire::Message::FundingCreated(msg) => {
710 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
712 wire::Message::FundingSigned(msg) => {
713 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
715 wire::Message::FundingLocked(msg) => {
716 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
719 wire::Message::Shutdown(msg) => {
720 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
722 wire::Message::ClosingSigned(msg) => {
723 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
726 // Commitment messages:
727 wire::Message::UpdateAddHTLC(msg) => {
728 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
730 wire::Message::UpdateFulfillHTLC(msg) => {
731 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
733 wire::Message::UpdateFailHTLC(msg) => {
734 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
736 wire::Message::UpdateFailMalformedHTLC(msg) => {
737 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
740 wire::Message::CommitmentSigned(msg) => {
741 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
743 wire::Message::RevokeAndACK(msg) => {
744 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
746 wire::Message::UpdateFee(msg) => {
747 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
749 wire::Message::ChannelReestablish(msg) => {
750 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
754 wire::Message::AnnouncementSignatures(msg) => {
755 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
757 wire::Message::ChannelAnnouncement(msg) => {
758 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
761 // TODO: forward msg along to all our other peers!
764 wire::Message::NodeAnnouncement(msg) => {
765 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
768 // TODO: forward msg along to all our other peers!
771 wire::Message::ChannelUpdate(msg) => {
772 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
775 // TODO: forward msg along to all our other peers!
780 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
781 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
782 // Fail the channel if message is an even, unknown type as per BOLT #1.
783 return Err(PeerHandleError{ no_connection_possible: true });
785 wire::Message::Unknown(msg_type) => {
786 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
795 self.do_attempt_write_data(peer_descriptor, peer);
797 peer.pending_outbound_buffer.len() > 10 // pause_read
807 /// Checks for any events generated by our handlers and processes them. Includes sending most
808 /// response messages as well as messages generated by calls to handler functions directly (eg
809 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
810 pub fn process_events(&self) {
812 // TODO: There are some DoS attacks here where you can flood someone's outbound send
813 // buffer by doing things like announcing channels on another node. We should be willing to
814 // drop optional-ish messages when send buffers get full!
816 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
817 let mut peers_lock = self.peers.lock().unwrap();
818 let peers = &mut *peers_lock;
819 for event in events_generated.drain(..) {
820 macro_rules! get_peer_for_forwarding {
821 ($node_id: expr, $handle_no_such_peer: block) => {
823 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
824 Some(descriptor) => descriptor.clone(),
826 $handle_no_such_peer;
830 match peers.peers.get_mut(&descriptor) {
832 if peer.their_features.is_none() {
833 $handle_no_such_peer;
838 None => panic!("Inconsistent peers set state!"),
844 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
845 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
846 log_pubkey!(node_id),
847 log_bytes!(msg.temporary_channel_id));
848 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
849 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
851 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
852 self.do_attempt_write_data(&mut descriptor, peer);
854 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
855 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
856 log_pubkey!(node_id),
857 log_bytes!(msg.temporary_channel_id));
858 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
859 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
861 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
862 self.do_attempt_write_data(&mut descriptor, peer);
864 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
865 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
866 log_pubkey!(node_id),
867 log_bytes!(msg.temporary_channel_id),
868 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
869 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
870 //TODO: generate a DiscardFunding event indicating to the wallet that
871 //they should just throw away this funding transaction
873 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
874 self.do_attempt_write_data(&mut descriptor, peer);
876 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
877 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
878 log_pubkey!(node_id),
879 log_bytes!(msg.channel_id));
880 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
881 //TODO: generate a DiscardFunding event indicating to the wallet that
882 //they should just throw away this funding transaction
884 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
885 self.do_attempt_write_data(&mut descriptor, peer);
887 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
888 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
889 log_pubkey!(node_id),
890 log_bytes!(msg.channel_id));
891 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
892 //TODO: Do whatever we're gonna do for handling dropped messages
894 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
895 self.do_attempt_write_data(&mut descriptor, peer);
897 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
898 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
899 log_pubkey!(node_id),
900 log_bytes!(msg.channel_id));
901 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
902 //TODO: generate a DiscardFunding event indicating to the wallet that
903 //they should just throw away this funding transaction
905 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
906 self.do_attempt_write_data(&mut descriptor, peer);
908 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 } } => {
909 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
910 log_pubkey!(node_id),
911 update_add_htlcs.len(),
912 update_fulfill_htlcs.len(),
913 update_fail_htlcs.len(),
914 log_bytes!(commitment_signed.channel_id));
915 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
916 //TODO: Do whatever we're gonna do for handling dropped messages
918 for msg in update_add_htlcs {
919 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
921 for msg in update_fulfill_htlcs {
922 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
924 for msg in update_fail_htlcs {
925 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
927 for msg in update_fail_malformed_htlcs {
928 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
930 if let &Some(ref msg) = update_fee {
931 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
933 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
934 self.do_attempt_write_data(&mut descriptor, peer);
936 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
937 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
938 log_pubkey!(node_id),
939 log_bytes!(msg.channel_id));
940 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
941 //TODO: Do whatever we're gonna do for handling dropped messages
943 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
944 self.do_attempt_write_data(&mut descriptor, peer);
946 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
947 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
948 log_pubkey!(node_id),
949 log_bytes!(msg.channel_id));
950 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
951 //TODO: Do whatever we're gonna do for handling dropped messages
953 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
954 self.do_attempt_write_data(&mut descriptor, peer);
956 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
957 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
958 log_pubkey!(node_id),
959 log_bytes!(msg.channel_id));
960 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
961 //TODO: Do whatever we're gonna do for handling dropped messages
963 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
964 self.do_attempt_write_data(&mut descriptor, peer);
966 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
967 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
968 log_pubkey!(node_id),
969 log_bytes!(msg.channel_id));
970 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
971 //TODO: Do whatever we're gonna do for handling dropped messages
973 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
974 self.do_attempt_write_data(&mut descriptor, peer);
976 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
977 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
978 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
979 let encoded_msg = encode_msg!(msg);
980 let encoded_update_msg = encode_msg!(update_msg);
982 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
983 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
984 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
987 match peer.their_node_id {
989 Some(their_node_id) => {
990 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
995 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
996 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
997 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1001 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1002 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1003 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1004 let encoded_msg = encode_msg!(msg);
1006 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1007 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1008 !peer.should_forward_node_announcement(msg.contents.node_id) {
1011 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1012 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1016 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1017 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1018 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1019 let encoded_msg = encode_msg!(msg);
1021 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1022 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1023 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1026 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1027 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1031 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1032 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1034 MessageSendEvent::HandleError { ref node_id, ref action } => {
1036 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1037 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1038 peers.peers_needing_send.remove(&descriptor);
1039 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1040 if let Some(ref msg) = *msg {
1041 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1042 log_pubkey!(node_id),
1044 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1045 // This isn't guaranteed to work, but if there is enough free
1046 // room in the send buffer, put the error message there...
1047 self.do_attempt_write_data(&mut descriptor, &mut peer);
1049 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1052 descriptor.disconnect_socket();
1053 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1056 msgs::ErrorAction::IgnoreError => {},
1057 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1058 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1059 log_pubkey!(node_id),
1061 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1062 //TODO: Do whatever we're gonna do for handling dropped messages
1064 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1065 self.do_attempt_write_data(&mut descriptor, peer);
1072 for mut descriptor in peers.peers_needing_send.drain() {
1073 match peers.peers.get_mut(&descriptor) {
1074 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1075 None => panic!("Inconsistent peers set state!"),
1081 /// Indicates that the given socket descriptor's connection is now closed.
1083 /// This must only be called if the socket has been disconnected by the peer or your own
1084 /// decision to disconnect it and must NOT be called in any case where other parts of this
1085 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1088 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1089 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1090 self.disconnect_event_internal(descriptor, false);
1093 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1094 let mut peers = self.peers.lock().unwrap();
1095 peers.peers_needing_send.remove(descriptor);
1096 let peer_option = peers.peers.remove(descriptor);
1098 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1100 match peer.their_node_id {
1102 peers.node_id_to_descriptor.remove(&node_id);
1103 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1111 /// This function should be called roughly once every 30 seconds.
1112 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1114 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1115 pub fn timer_tick_occured(&self) {
1116 let mut peers_lock = self.peers.lock().unwrap();
1118 let peers = &mut *peers_lock;
1119 let peers_needing_send = &mut peers.peers_needing_send;
1120 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1121 let peers = &mut peers.peers;
1122 let mut descriptors_needing_disconnect = Vec::new();
1124 peers.retain(|descriptor, peer| {
1125 if peer.awaiting_pong {
1126 peers_needing_send.remove(descriptor);
1127 descriptors_needing_disconnect.push(descriptor.clone());
1128 match peer.their_node_id {
1130 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1131 node_id_to_descriptor.remove(&node_id);
1132 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1135 // This can't actually happen as we should have hit
1136 // is_ready_for_encryption() previously on this same peer.
1143 if !peer.channel_encryptor.is_ready_for_encryption() {
1144 // The peer needs to complete its handshake before we can exchange messages
1148 let ping = msgs::Ping {
1152 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1154 let mut descriptor_clone = descriptor.clone();
1155 self.do_attempt_write_data(&mut descriptor_clone, peer);
1157 peer.awaiting_pong = true;
1161 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1162 descriptor.disconnect_socket();
1170 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1173 use util::test_utils;
1175 use bitcoin::secp256k1::Secp256k1;
1176 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1178 use rand::{thread_rng, Rng};
1181 use std::sync::{Arc, Mutex};
1182 use std::sync::atomic::Ordering;
1185 struct FileDescriptor {
1187 outbound_data: Arc<Mutex<Vec<u8>>>,
1189 impl PartialEq for FileDescriptor {
1190 fn eq(&self, other: &Self) -> bool {
1194 impl Eq for FileDescriptor { }
1195 impl std::hash::Hash for FileDescriptor {
1196 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1197 self.fd.hash(hasher)
1201 impl SocketDescriptor for FileDescriptor {
1202 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1203 self.outbound_data.lock().unwrap().extend_from_slice(data);
1207 fn disconnect_socket(&mut self) {}
1210 struct PeerManagerCfg {
1211 chan_handler: test_utils::TestChannelMessageHandler,
1212 routing_handler: test_utils::TestRoutingMessageHandler,
1213 logger: test_utils::TestLogger,
1216 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1217 let mut cfgs = Vec::new();
1218 for _ in 0..peer_count {
1221 chan_handler: test_utils::TestChannelMessageHandler::new(),
1222 logger: test_utils::TestLogger::new(),
1223 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1231 fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>> {
1232 let mut peers = Vec::new();
1233 let mut rng = thread_rng();
1234 let mut ephemeral_bytes = [0; 32];
1235 rng.fill_bytes(&mut ephemeral_bytes);
1237 for i in 0..peer_count {
1239 let mut key_slice = [0;32];
1240 rng.fill_bytes(&mut key_slice);
1241 SecretKey::from_slice(&key_slice).unwrap()
1243 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1244 let peer = PeerManager::new(msg_handler, node_id, &ephemeral_bytes, &cfgs[i].logger);
1251 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>) -> (FileDescriptor, FileDescriptor) {
1252 let secp_ctx = Secp256k1::new();
1253 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1254 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1255 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1256 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1257 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1258 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1259 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1260 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1261 (fd_a.clone(), fd_b.clone())
1264 fn establish_connection_and_read_events<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger>) -> (FileDescriptor, FileDescriptor) {
1265 let (mut fd_a, mut fd_b) = establish_connection(peer_a, peer_b);
1266 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1267 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1268 (fd_a.clone(), fd_b.clone())
1272 fn test_disconnect_peer() {
1273 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1274 // push a DisconnectPeer event to remove the node flagged by id
1275 let cfgs = create_peermgr_cfgs(2);
1276 let chan_handler = test_utils::TestChannelMessageHandler::new();
1277 let mut peers = create_network(2, &cfgs);
1278 establish_connection(&peers[0], &peers[1]);
1279 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1281 let secp_ctx = Secp256k1::new();
1282 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1284 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1286 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1288 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1289 peers[0].message_handler.chan_handler = &chan_handler;
1291 peers[0].process_events();
1292 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1296 fn test_timer_tick_occurred() {
1297 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1298 let cfgs = create_peermgr_cfgs(2);
1299 let peers = create_network(2, &cfgs);
1300 establish_connection(&peers[0], &peers[1]);
1301 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1303 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1304 peers[0].timer_tick_occured();
1305 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1307 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1308 peers[0].timer_tick_occured();
1309 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1313 fn test_do_attempt_write_data() {
1314 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1315 let cfgs = create_peermgr_cfgs(2);
1316 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1317 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1318 let peers = create_network(2, &cfgs);
1320 // By calling establish_connect, we trigger do_attempt_write_data between
1321 // the peers. Previously this function would mistakenly enter an infinite loop
1322 // when there were more channel messages available than could fit into a peer's
1323 // buffer. This issue would now be detected by this test (because we use custom
1324 // RoutingMessageHandlers that intentionally return more channel messages
1325 // than can fit into a peer's buffer).
1326 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1328 // Make each peer to read the messages that the other peer just wrote to them.
1329 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1330 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1332 // Check that each peer has received the expected number of channel updates and channel
1334 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1335 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1336 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1337 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1341 fn limit_initial_routing_sync_requests() {
1342 // Inbound peer 0 requests initial_routing_sync, but outbound peer 1 does not.
1344 let cfgs = create_peermgr_cfgs(2);
1345 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1346 let peers = create_network(2, &cfgs);
1347 let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1349 let peer_0 = peers[0].peers.lock().unwrap();
1350 let peer_1 = peers[1].peers.lock().unwrap();
1352 let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1353 let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1355 assert!(peer_0_features.unwrap().initial_routing_sync());
1356 assert!(!peer_1_features.unwrap().initial_routing_sync());
1359 // Outbound peer 1 requests initial_routing_sync, but inbound peer 0 does not.
1361 let cfgs = create_peermgr_cfgs(2);
1362 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1363 let peers = create_network(2, &cfgs);
1364 let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1366 let peer_0 = peers[0].peers.lock().unwrap();
1367 let peer_1 = peers[1].peers.lock().unwrap();
1369 let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1370 let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1372 assert!(!peer_0_features.unwrap().initial_routing_sync());
1373 assert!(peer_1_features.unwrap().initial_routing_sync());