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, LightningError, RoutingMessageHandler};
14 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
15 use util::ser::{VecWriter, Writeable};
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 pub 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 enum MessageHandlingError {
213 PeerHandleError(PeerHandleError),
214 LightningError(LightningError),
217 impl From<PeerHandleError> for MessageHandlingError {
218 fn from(error: PeerHandleError) -> Self {
219 MessageHandlingError::PeerHandleError(error)
223 impl From<LightningError> for MessageHandlingError {
224 fn from(error: LightningError) -> Self {
225 MessageHandlingError::LightningError(error)
229 macro_rules! encode_msg {
231 let mut buffer = VecWriter(Vec::new());
232 wire::write($msg, &mut buffer).unwrap();
237 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
238 /// PeerIds may repeat, but only after socket_disconnected() has been called.
239 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
240 CM::Target: ChannelMessageHandler,
241 RM::Target: RoutingMessageHandler,
243 /// Constructs a new PeerManager with the given message handlers and node_id secret key
244 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
245 /// cryptographically secure random bytes.
246 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
247 let mut ephemeral_key_midstate = Sha256::engine();
248 ephemeral_key_midstate.input(ephemeral_random_data);
252 peers: Mutex::new(PeerHolder {
253 peers: HashMap::new(),
254 peers_needing_send: HashSet::new(),
255 node_id_to_descriptor: HashMap::new()
258 ephemeral_key_midstate,
259 peer_counter_low: AtomicUsize::new(0),
260 peer_counter_high: AtomicUsize::new(0),
265 /// Get the list of node ids for peers which have completed the initial handshake.
267 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
268 /// new_outbound_connection, however entries will only appear once the initial handshake has
269 /// completed and we are sure the remote peer has the private key for the given node_id.
270 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
271 let peers = self.peers.lock().unwrap();
272 peers.peers.values().filter_map(|p| {
273 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
280 fn get_ephemeral_key(&self) -> SecretKey {
281 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
282 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
283 let high = if low == 0 {
284 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
286 self.peer_counter_high.load(Ordering::Acquire)
288 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
289 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
290 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
293 /// Indicates a new outbound connection has been established to a node with the given node_id.
294 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
295 /// descriptor but must disconnect the connection immediately.
297 /// Returns a small number of bytes to send to the remote node (currently always 50).
299 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
300 /// socket_disconnected().
301 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
302 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
303 let res = peer_encryptor.get_act_one().to_vec();
304 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
306 let mut peers = self.peers.lock().unwrap();
307 if peers.peers.insert(descriptor, Peer {
308 channel_encryptor: peer_encryptor,
311 their_features: None,
313 pending_outbound_buffer: LinkedList::new(),
314 pending_outbound_buffer_first_msg_offset: 0,
315 awaiting_write_event: false,
317 pending_read_buffer: pending_read_buffer,
318 pending_read_buffer_pos: 0,
319 pending_read_is_header: false,
321 sync_status: InitSyncTracker::NoSyncRequested,
323 awaiting_pong: false,
325 panic!("PeerManager driver duplicated descriptors!");
330 /// Indicates a new inbound connection has been established.
332 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
333 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
334 /// call socket_disconnected for the new descriptor but must disconnect the connection
337 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
338 /// socket_disconnected called.
339 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
340 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
341 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
343 let mut peers = self.peers.lock().unwrap();
344 if peers.peers.insert(descriptor, Peer {
345 channel_encryptor: peer_encryptor,
348 their_features: None,
350 pending_outbound_buffer: LinkedList::new(),
351 pending_outbound_buffer_first_msg_offset: 0,
352 awaiting_write_event: false,
354 pending_read_buffer: pending_read_buffer,
355 pending_read_buffer_pos: 0,
356 pending_read_is_header: false,
358 sync_status: InitSyncTracker::NoSyncRequested,
360 awaiting_pong: false,
362 panic!("PeerManager driver duplicated descriptors!");
367 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
368 macro_rules! encode_and_send_msg {
371 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
372 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
376 const MSG_BUFF_SIZE: usize = 10;
377 while !peer.awaiting_write_event {
378 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
379 match peer.sync_status {
380 InitSyncTracker::NoSyncRequested => {},
381 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
382 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
383 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
384 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
385 encode_and_send_msg!(announce);
386 if let &Some(ref update_a) = update_a_option {
387 encode_and_send_msg!(update_a);
389 if let &Some(ref update_b) = update_b_option {
390 encode_and_send_msg!(update_b);
392 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
394 if all_messages.is_empty() || all_messages.len() != steps as usize {
395 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
398 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
399 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
400 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
401 for msg in all_messages.iter() {
402 encode_and_send_msg!(msg);
403 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
405 if all_messages.is_empty() || all_messages.len() != steps as usize {
406 peer.sync_status = InitSyncTracker::NoSyncRequested;
409 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
410 InitSyncTracker::NodesSyncing(key) => {
411 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
412 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
413 for msg in all_messages.iter() {
414 encode_and_send_msg!(msg);
415 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
417 if all_messages.is_empty() || all_messages.len() != steps as usize {
418 peer.sync_status = InitSyncTracker::NoSyncRequested;
425 let next_buff = match peer.pending_outbound_buffer.front() {
430 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
431 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
432 let data_sent = descriptor.send_data(pending, should_be_reading);
433 peer.pending_outbound_buffer_first_msg_offset += data_sent;
434 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
436 peer.pending_outbound_buffer_first_msg_offset = 0;
437 peer.pending_outbound_buffer.pop_front();
439 peer.awaiting_write_event = true;
444 /// Indicates that there is room to write data to the given socket descriptor.
446 /// May return an Err to indicate that the connection should be closed.
448 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
449 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
450 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
451 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
452 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
453 /// new_\*_connection event.
454 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
455 let mut peers = self.peers.lock().unwrap();
456 match peers.peers.get_mut(descriptor) {
457 None => panic!("Descriptor for write_event is not already known to PeerManager"),
459 peer.awaiting_write_event = false;
460 self.do_attempt_write_data(descriptor, peer);
466 /// Indicates that data was read from the given socket descriptor.
468 /// May return an Err to indicate that the connection should be closed.
470 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
471 /// Thus, however, you almost certainly want to call process_events() after any read_event to
472 /// generate send_data calls to handle responses.
474 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
475 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
477 /// Panics if the descriptor was not previously registered in a new_*_connection event.
478 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
479 match self.do_read_event(peer_descriptor, data) {
482 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
488 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
489 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
490 let mut buffer = VecWriter(Vec::new());
491 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
492 let encoded_message = buffer.0;
494 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
495 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
496 peers_needing_send.insert(descriptor);
499 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
501 let mut peers_lock = self.peers.lock().unwrap();
502 let peers = &mut *peers_lock;
503 let pause_read = match peers.peers.get_mut(peer_descriptor) {
504 None => panic!("Descriptor for read_event is not already known to PeerManager"),
506 assert!(peer.pending_read_buffer.len() > 0);
507 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
509 let mut read_pos = 0;
510 while read_pos < data.len() {
512 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
513 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]);
514 read_pos += data_to_copy;
515 peer.pending_read_buffer_pos += data_to_copy;
518 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
519 peer.pending_read_buffer_pos = 0;
521 macro_rules! try_potential_handleerror {
527 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
528 //TODO: Try to push msg
529 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
530 return Err(PeerHandleError{ no_connection_possible: false });
532 msgs::ErrorAction::IgnoreError => {
533 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
536 msgs::ErrorAction::SendErrorMessage { msg } => {
537 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
538 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
547 macro_rules! insert_node_id {
549 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
550 hash_map::Entry::Occupied(_) => {
551 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
552 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
553 return Err(PeerHandleError{ no_connection_possible: false })
555 hash_map::Entry::Vacant(entry) => {
556 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
557 entry.insert(peer_descriptor.clone())
563 let next_step = peer.channel_encryptor.get_noise_step();
565 NextNoiseStep::ActOne => {
566 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();
567 peer.pending_outbound_buffer.push_back(act_two);
568 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
570 NextNoiseStep::ActTwo => {
571 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
572 peer.pending_outbound_buffer.push_back(act_three.to_vec());
573 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
574 peer.pending_read_is_header = true;
576 peer.their_node_id = Some(their_node_id);
578 let mut features = InitFeatures::known();
579 if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
580 features.clear_initial_routing_sync();
583 let resp = msgs::Init { features };
584 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
586 NextNoiseStep::ActThree => {
587 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
588 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
589 peer.pending_read_is_header = true;
590 peer.their_node_id = Some(their_node_id);
593 NextNoiseStep::NoiseComplete => {
594 if peer.pending_read_is_header {
595 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
596 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
597 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
598 if msg_len < 2 { // Need at least the message type tag
599 return Err(PeerHandleError{ no_connection_possible: false });
601 peer.pending_read_is_header = false;
603 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
604 assert!(msg_data.len() >= 2);
607 peer.pending_read_buffer = [0; 18].to_vec();
608 peer.pending_read_is_header = true;
610 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
611 let message_result = wire::read(&mut reader);
612 let message = match message_result {
616 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
617 msgs::DecodeError::UnknownRequiredFeature => {
618 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
621 msgs::DecodeError::InvalidValue => {
622 log_debug!(self.logger, "Got an invalid value while deserializing message");
623 return Err(PeerHandleError { no_connection_possible: false });
625 msgs::DecodeError::ShortRead => {
626 log_debug!(self.logger, "Deserialization failed due to shortness of message");
627 return Err(PeerHandleError { no_connection_possible: false });
629 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
630 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
635 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
636 match handling_error {
637 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
638 MessageHandlingError::LightningError(e) => {
639 try_potential_handleerror!(Err(e));
649 self.do_attempt_write_data(peer_descriptor, peer);
651 peer.pending_outbound_buffer.len() > 10 // pause_read
661 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
662 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
663 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
665 // Need an Init as first message
666 if let wire::Message::Init(_) = message {
667 } else if peer.their_features.is_none() {
668 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
669 return Err(PeerHandleError{ no_connection_possible: false }.into());
673 // Setup and Control messages:
674 wire::Message::Init(msg) => {
675 if msg.features.requires_unknown_bits() {
676 log_info!(self.logger, "Peer global features required unknown version bits");
677 return Err(PeerHandleError{ no_connection_possible: true }.into());
679 if msg.features.requires_unknown_bits() {
680 log_info!(self.logger, "Peer local features required unknown version bits");
681 return Err(PeerHandleError{ no_connection_possible: true }.into());
683 if peer.their_features.is_some() {
684 return Err(PeerHandleError{ no_connection_possible: false }.into());
688 self.logger, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, static_remote_key: {}, unknown flags (local and global): {}",
689 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
690 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
691 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
692 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
693 if msg.features.supports_unknown_bits() { "present" } else { "none" }
696 if msg.features.initial_routing_sync() {
697 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
698 peers_needing_send.insert(peer_descriptor.clone());
700 if !msg.features.supports_static_remote_key() {
701 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
702 return Err(PeerHandleError{ no_connection_possible: true }.into());
706 let mut features = InitFeatures::known();
707 if !self.message_handler.route_handler.should_request_full_sync(&peer.their_node_id.unwrap()) {
708 features.clear_initial_routing_sync();
711 let resp = msgs::Init { features };
712 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
715 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
716 peer.their_features = Some(msg.features);
718 wire::Message::Error(msg) => {
719 let mut data_is_printable = true;
720 for b in msg.data.bytes() {
721 if b < 32 || b > 126 {
722 data_is_printable = false;
727 if data_is_printable {
728 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
730 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
732 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
733 if msg.channel_id == [0; 32] {
734 return Err(PeerHandleError{ no_connection_possible: true }.into());
738 wire::Message::Ping(msg) => {
739 if msg.ponglen < 65532 {
740 let resp = msgs::Pong { byteslen: msg.ponglen };
741 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
744 wire::Message::Pong(_msg) => {
745 peer.awaiting_pong = false;
749 wire::Message::OpenChannel(msg) => {
750 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
752 wire::Message::AcceptChannel(msg) => {
753 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
756 wire::Message::FundingCreated(msg) => {
757 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
759 wire::Message::FundingSigned(msg) => {
760 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
762 wire::Message::FundingLocked(msg) => {
763 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
766 wire::Message::Shutdown(msg) => {
767 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg);
769 wire::Message::ClosingSigned(msg) => {
770 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
773 // Commitment messages:
774 wire::Message::UpdateAddHTLC(msg) => {
775 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
777 wire::Message::UpdateFulfillHTLC(msg) => {
778 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
780 wire::Message::UpdateFailHTLC(msg) => {
781 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
783 wire::Message::UpdateFailMalformedHTLC(msg) => {
784 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
787 wire::Message::CommitmentSigned(msg) => {
788 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
790 wire::Message::RevokeAndACK(msg) => {
791 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
793 wire::Message::UpdateFee(msg) => {
794 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
796 wire::Message::ChannelReestablish(msg) => {
797 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
801 wire::Message::AnnouncementSignatures(msg) => {
802 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
804 wire::Message::ChannelAnnouncement(msg) => {
805 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
807 Err(e) => { return Err(e.into()); },
811 // TODO: forward msg along to all our other peers!
814 wire::Message::NodeAnnouncement(msg) => {
815 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
817 Err(e) => { return Err(e.into()); },
821 // TODO: forward msg along to all our other peers!
824 wire::Message::ChannelUpdate(msg) => {
825 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
827 Err(e) => { return Err(e.into()); },
831 // TODO: forward msg along to all our other peers!
836 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
837 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
838 // Fail the channel if message is an even, unknown type as per BOLT #1.
839 return Err(PeerHandleError{ no_connection_possible: true }.into());
841 wire::Message::Unknown(msg_type) => {
842 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
848 /// Checks for any events generated by our handlers and processes them. Includes sending most
849 /// response messages as well as messages generated by calls to handler functions directly (eg
850 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
851 pub fn process_events(&self) {
853 // TODO: There are some DoS attacks here where you can flood someone's outbound send
854 // buffer by doing things like announcing channels on another node. We should be willing to
855 // drop optional-ish messages when send buffers get full!
857 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
858 let mut peers_lock = self.peers.lock().unwrap();
859 let peers = &mut *peers_lock;
860 for event in events_generated.drain(..) {
861 macro_rules! get_peer_for_forwarding {
862 ($node_id: expr, $handle_no_such_peer: block) => {
864 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
865 Some(descriptor) => descriptor.clone(),
867 $handle_no_such_peer;
871 match peers.peers.get_mut(&descriptor) {
873 if peer.their_features.is_none() {
874 $handle_no_such_peer;
879 None => panic!("Inconsistent peers set state!"),
885 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
886 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
887 log_pubkey!(node_id),
888 log_bytes!(msg.temporary_channel_id));
889 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
890 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
892 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
893 self.do_attempt_write_data(&mut descriptor, peer);
895 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
896 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
897 log_pubkey!(node_id),
898 log_bytes!(msg.temporary_channel_id));
899 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
900 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
902 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
903 self.do_attempt_write_data(&mut descriptor, peer);
905 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
906 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
907 log_pubkey!(node_id),
908 log_bytes!(msg.temporary_channel_id),
909 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
910 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
911 //TODO: generate a DiscardFunding event indicating to the wallet that
912 //they should just throw away this funding transaction
914 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
915 self.do_attempt_write_data(&mut descriptor, peer);
917 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
918 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
919 log_pubkey!(node_id),
920 log_bytes!(msg.channel_id));
921 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
922 //TODO: generate a DiscardFunding event indicating to the wallet that
923 //they should just throw away this funding transaction
925 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
926 self.do_attempt_write_data(&mut descriptor, peer);
928 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
929 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
930 log_pubkey!(node_id),
931 log_bytes!(msg.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 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
936 self.do_attempt_write_data(&mut descriptor, peer);
938 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
939 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
940 log_pubkey!(node_id),
941 log_bytes!(msg.channel_id));
942 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
943 //TODO: generate a DiscardFunding event indicating to the wallet that
944 //they should just throw away this funding transaction
946 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
947 self.do_attempt_write_data(&mut descriptor, peer);
949 MessageSendEvent::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 } } => {
950 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
951 log_pubkey!(node_id),
952 update_add_htlcs.len(),
953 update_fulfill_htlcs.len(),
954 update_fail_htlcs.len(),
955 log_bytes!(commitment_signed.channel_id));
956 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
957 //TODO: Do whatever we're gonna do for handling dropped messages
959 for msg in update_add_htlcs {
960 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
962 for msg in update_fulfill_htlcs {
963 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
965 for msg in update_fail_htlcs {
966 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
968 for msg in update_fail_malformed_htlcs {
969 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
971 if let &Some(ref msg) = update_fee {
972 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
974 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
975 self.do_attempt_write_data(&mut descriptor, peer);
977 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
978 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
979 log_pubkey!(node_id),
980 log_bytes!(msg.channel_id));
981 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
982 //TODO: Do whatever we're gonna do for handling dropped messages
984 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
985 self.do_attempt_write_data(&mut descriptor, peer);
987 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
988 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
989 log_pubkey!(node_id),
990 log_bytes!(msg.channel_id));
991 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
992 //TODO: Do whatever we're gonna do for handling dropped messages
994 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
995 self.do_attempt_write_data(&mut descriptor, peer);
997 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
998 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
999 log_pubkey!(node_id),
1000 log_bytes!(msg.channel_id));
1001 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1002 //TODO: Do whatever we're gonna do for handling dropped messages
1004 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1005 self.do_attempt_write_data(&mut descriptor, peer);
1007 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1008 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1009 log_pubkey!(node_id),
1010 log_bytes!(msg.channel_id));
1011 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1012 //TODO: Do whatever we're gonna do for handling dropped messages
1014 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1015 self.do_attempt_write_data(&mut descriptor, peer);
1017 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1018 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1019 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1020 let encoded_msg = encode_msg!(msg);
1021 let encoded_update_msg = encode_msg!(update_msg);
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_channel_announcement(msg.contents.short_channel_id) {
1028 match peer.their_node_id {
1030 Some(their_node_id) => {
1031 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1036 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1037 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1038 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1042 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1043 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1044 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1045 let encoded_msg = encode_msg!(msg);
1047 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1048 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1049 !peer.should_forward_node_announcement(msg.contents.node_id) {
1052 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1053 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1057 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1058 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1059 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1060 let encoded_msg = encode_msg!(msg);
1062 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1063 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1064 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1067 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1068 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1072 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1073 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1075 MessageSendEvent::HandleError { ref node_id, ref action } => {
1077 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1078 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1079 peers.peers_needing_send.remove(&descriptor);
1080 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1081 if let Some(ref msg) = *msg {
1082 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1083 log_pubkey!(node_id),
1085 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1086 // This isn't guaranteed to work, but if there is enough free
1087 // room in the send buffer, put the error message there...
1088 self.do_attempt_write_data(&mut descriptor, &mut peer);
1090 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1093 descriptor.disconnect_socket();
1094 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1097 msgs::ErrorAction::IgnoreError => {},
1098 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1099 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1100 log_pubkey!(node_id),
1102 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1103 //TODO: Do whatever we're gonna do for handling dropped messages
1105 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1106 self.do_attempt_write_data(&mut descriptor, peer);
1113 for mut descriptor in peers.peers_needing_send.drain() {
1114 match peers.peers.get_mut(&descriptor) {
1115 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1116 None => panic!("Inconsistent peers set state!"),
1122 /// Indicates that the given socket descriptor's connection is now closed.
1124 /// This must only be called if the socket has been disconnected by the peer or your own
1125 /// decision to disconnect it and must NOT be called in any case where other parts of this
1126 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1129 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1130 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1131 self.disconnect_event_internal(descriptor, false);
1134 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1135 let mut peers = self.peers.lock().unwrap();
1136 peers.peers_needing_send.remove(descriptor);
1137 let peer_option = peers.peers.remove(descriptor);
1139 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1141 match peer.their_node_id {
1143 peers.node_id_to_descriptor.remove(&node_id);
1144 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1152 /// This function should be called roughly once every 30 seconds.
1153 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1155 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1156 pub fn timer_tick_occured(&self) {
1157 let mut peers_lock = self.peers.lock().unwrap();
1159 let peers = &mut *peers_lock;
1160 let peers_needing_send = &mut peers.peers_needing_send;
1161 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1162 let peers = &mut peers.peers;
1163 let mut descriptors_needing_disconnect = Vec::new();
1165 peers.retain(|descriptor, peer| {
1166 if peer.awaiting_pong {
1167 peers_needing_send.remove(descriptor);
1168 descriptors_needing_disconnect.push(descriptor.clone());
1169 match peer.their_node_id {
1171 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1172 node_id_to_descriptor.remove(&node_id);
1173 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1176 // This can't actually happen as we should have hit
1177 // is_ready_for_encryption() previously on this same peer.
1184 if !peer.channel_encryptor.is_ready_for_encryption() {
1185 // The peer needs to complete its handshake before we can exchange messages
1189 let ping = msgs::Ping {
1193 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1195 let mut descriptor_clone = descriptor.clone();
1196 self.do_attempt_write_data(&mut descriptor_clone, peer);
1198 peer.awaiting_pong = true;
1202 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1203 descriptor.disconnect_socket();
1211 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1214 use util::test_utils;
1216 use bitcoin::secp256k1::Secp256k1;
1217 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1220 use std::sync::{Arc, Mutex};
1221 use std::sync::atomic::Ordering;
1224 struct FileDescriptor {
1226 outbound_data: Arc<Mutex<Vec<u8>>>,
1228 impl PartialEq for FileDescriptor {
1229 fn eq(&self, other: &Self) -> bool {
1233 impl Eq for FileDescriptor { }
1234 impl std::hash::Hash for FileDescriptor {
1235 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1236 self.fd.hash(hasher)
1240 impl SocketDescriptor for FileDescriptor {
1241 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1242 self.outbound_data.lock().unwrap().extend_from_slice(data);
1246 fn disconnect_socket(&mut self) {}
1249 struct PeerManagerCfg {
1250 chan_handler: test_utils::TestChannelMessageHandler,
1251 routing_handler: test_utils::TestRoutingMessageHandler,
1252 logger: test_utils::TestLogger,
1255 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1256 let mut cfgs = Vec::new();
1257 for _ in 0..peer_count {
1260 chan_handler: test_utils::TestChannelMessageHandler::new(),
1261 logger: test_utils::TestLogger::new(),
1262 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1270 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>> {
1271 let mut peers = Vec::new();
1272 for i in 0..peer_count {
1273 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1274 let ephemeral_bytes = [i as u8; 32];
1275 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1276 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1283 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) {
1284 let secp_ctx = Secp256k1::new();
1285 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1286 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1287 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1288 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1289 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1290 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1291 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1292 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1293 (fd_a.clone(), fd_b.clone())
1296 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) {
1297 let (mut fd_a, mut fd_b) = establish_connection(peer_a, peer_b);
1298 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1299 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1300 (fd_a.clone(), fd_b.clone())
1304 fn test_disconnect_peer() {
1305 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1306 // push a DisconnectPeer event to remove the node flagged by id
1307 let cfgs = create_peermgr_cfgs(2);
1308 let chan_handler = test_utils::TestChannelMessageHandler::new();
1309 let mut peers = create_network(2, &cfgs);
1310 establish_connection(&peers[0], &peers[1]);
1311 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1313 let secp_ctx = Secp256k1::new();
1314 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1316 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1318 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1320 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1321 peers[0].message_handler.chan_handler = &chan_handler;
1323 peers[0].process_events();
1324 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1328 fn test_timer_tick_occurred() {
1329 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1330 let cfgs = create_peermgr_cfgs(2);
1331 let peers = create_network(2, &cfgs);
1332 establish_connection(&peers[0], &peers[1]);
1333 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1335 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1336 peers[0].timer_tick_occured();
1337 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1339 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1340 peers[0].timer_tick_occured();
1341 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1345 fn test_do_attempt_write_data() {
1346 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1347 let cfgs = create_peermgr_cfgs(2);
1348 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1349 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1350 let peers = create_network(2, &cfgs);
1352 // By calling establish_connect, we trigger do_attempt_write_data between
1353 // the peers. Previously this function would mistakenly enter an infinite loop
1354 // when there were more channel messages available than could fit into a peer's
1355 // buffer. This issue would now be detected by this test (because we use custom
1356 // RoutingMessageHandlers that intentionally return more channel messages
1357 // than can fit into a peer's buffer).
1358 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1360 // Make each peer to read the messages that the other peer just wrote to them.
1361 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1362 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1364 // Check that each peer has received the expected number of channel updates and channel
1366 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1367 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1368 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1369 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1373 fn limit_initial_routing_sync_requests() {
1374 // Inbound peer 0 requests initial_routing_sync, but outbound peer 1 does not.
1376 let cfgs = create_peermgr_cfgs(2);
1377 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1378 let peers = create_network(2, &cfgs);
1379 let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1381 let peer_0 = peers[0].peers.lock().unwrap();
1382 let peer_1 = peers[1].peers.lock().unwrap();
1384 let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1385 let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1387 assert!(peer_0_features.unwrap().initial_routing_sync());
1388 assert!(!peer_1_features.unwrap().initial_routing_sync());
1391 // Outbound peer 1 requests initial_routing_sync, but inbound peer 0 does not.
1393 let cfgs = create_peermgr_cfgs(2);
1394 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1395 let peers = create_network(2, &cfgs);
1396 let (fd_0_to_1, fd_1_to_0) = establish_connection_and_read_events(&peers[0], &peers[1]);
1398 let peer_0 = peers[0].peers.lock().unwrap();
1399 let peer_1 = peers[1].peers.lock().unwrap();
1401 let peer_0_features = peer_1.peers.get(&fd_1_to_0).unwrap().their_features.as_ref();
1402 let peer_1_features = peer_0.peers.get(&fd_0_to_1).unwrap().their_features.as_ref();
1404 assert!(!peer_0_features.unwrap().initial_routing_sync());
1405 assert!(peer_1_features.unwrap().initial_routing_sync());