1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and NetGraphmsgHandler) with messages
16 //! they should handle, and encoding/sending response messages.
18 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
20 use ln::features::InitFeatures;
22 use ln::msgs::{ChannelMessageHandler, LightningError, RoutingMessageHandler};
23 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
24 use util::ser::{VecWriter, Writeable};
25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
30 use util::logger::Logger;
31 use routing::network_graph::NetGraphMsgHandler;
33 use std::collections::{HashMap,hash_map,HashSet,LinkedList};
34 use std::sync::{Arc, Mutex};
35 use std::sync::atomic::{AtomicUsize, Ordering};
36 use std::{cmp, error, hash, fmt, mem};
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
41 use bitcoin::hashes::{HashEngine, Hash};
43 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
44 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
45 struct IgnoringMessageHandler{}
46 impl MessageSendEventsProvider for IgnoringMessageHandler {
47 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
49 impl RoutingMessageHandler for IgnoringMessageHandler {
50 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
51 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
52 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
53 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
54 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
55 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
56 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
57 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
58 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
59 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
60 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
61 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
63 impl Deref for IgnoringMessageHandler {
64 type Target = IgnoringMessageHandler;
65 fn deref(&self) -> &Self { self }
68 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
69 /// You can provide one of these as the route_handler in a MessageHandler.
70 struct ErroringMessageHandler {
71 message_queue: Mutex<Vec<MessageSendEvent>>
73 impl ErroringMessageHandler {
74 /// Constructs a new ErroringMessageHandler
75 pub fn new() -> Self {
76 Self { message_queue: Mutex::new(Vec::new()) }
78 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
79 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
80 action: msgs::ErrorAction::SendErrorMessage {
81 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
83 node_id: node_id.clone(),
87 impl MessageSendEventsProvider for ErroringMessageHandler {
88 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
89 let mut res = Vec::new();
90 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
94 impl ChannelMessageHandler for ErroringMessageHandler {
95 // Any messages which are related to a specific channel generate an error message to let the
96 // peer know we don't care about channels.
97 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
98 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
100 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
101 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
103 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
104 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
106 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
107 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
109 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
110 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
112 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
113 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
115 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
116 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
118 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
119 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
121 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
122 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
124 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
125 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
127 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
128 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
130 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
131 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
133 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
134 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
136 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
137 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
139 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
140 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
142 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
143 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
145 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
146 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
147 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
149 impl Deref for ErroringMessageHandler {
150 type Target = ErroringMessageHandler;
151 fn deref(&self) -> &Self { self }
154 /// Provides references to trait impls which handle different types of messages.
155 pub struct MessageHandler<CM: Deref, RM: Deref> where
156 CM::Target: ChannelMessageHandler,
157 RM::Target: RoutingMessageHandler {
158 /// A message handler which handles messages specific to channels. Usually this is just a
159 /// ChannelManager object or a ErroringMessageHandler.
160 pub chan_handler: CM,
161 /// A message handler which handles messages updating our knowledge of the network channel
162 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
163 pub route_handler: RM,
166 /// Provides an object which can be used to send data to and which uniquely identifies a connection
167 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
168 /// implement Hash to meet the PeerManager API.
170 /// For efficiency, Clone should be relatively cheap for this type.
172 /// You probably want to just extend an int and put a file descriptor in a struct and implement
173 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
174 /// be careful to ensure you don't have races whereby you might register a new connection with an
175 /// fd which is the same as a previous one which has yet to be removed via
176 /// PeerManager::socket_disconnected().
177 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
178 /// Attempts to send some data from the given slice to the peer.
180 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
181 /// Note that in the disconnected case, socket_disconnected must still fire and further write
182 /// attempts may occur until that time.
184 /// If the returned size is smaller than data.len(), a write_available event must
185 /// trigger the next time more data can be written. Additionally, until the a send_data event
186 /// completes fully, no further read_events should trigger on the same peer!
188 /// If a read_event on this descriptor had previously returned true (indicating that read
189 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
190 /// indicating that read events on this descriptor should resume. A resume_read of false does
191 /// *not* imply that further read events should be paused.
192 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
193 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
194 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
195 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
196 /// though races may occur whereby disconnect_socket is called after a call to
197 /// socket_disconnected but prior to socket_disconnected returning.
198 fn disconnect_socket(&mut self);
201 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
202 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
205 pub struct PeerHandleError {
206 /// Used to indicate that we probably can't make any future connections to this peer, implying
207 /// we should go ahead and force-close any channels we have with it.
208 pub no_connection_possible: bool,
210 impl fmt::Debug for PeerHandleError {
211 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
212 formatter.write_str("Peer Sent Invalid Data")
215 impl fmt::Display for PeerHandleError {
216 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
217 formatter.write_str("Peer Sent Invalid Data")
220 impl error::Error for PeerHandleError {
221 fn description(&self) -> &str {
222 "Peer Sent Invalid Data"
226 enum InitSyncTracker{
228 ChannelsSyncing(u64),
229 NodesSyncing(PublicKey),
233 channel_encryptor: PeerChannelEncryptor,
235 their_node_id: Option<PublicKey>,
236 their_features: Option<InitFeatures>,
238 pending_outbound_buffer: LinkedList<Vec<u8>>,
239 pending_outbound_buffer_first_msg_offset: usize,
240 awaiting_write_event: bool,
242 pending_read_buffer: Vec<u8>,
243 pending_read_buffer_pos: usize,
244 pending_read_is_header: bool,
246 sync_status: InitSyncTracker,
252 /// Returns true if the channel announcements/updates for the given channel should be
253 /// forwarded to this peer.
254 /// If we are sending our routing table to this peer and we have not yet sent channel
255 /// announcements/updates for the given channel_id then we will send it when we get to that
256 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
257 /// sent the old versions, we should send the update, and so return true here.
258 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
259 match self.sync_status {
260 InitSyncTracker::NoSyncRequested => true,
261 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
262 InitSyncTracker::NodesSyncing(_) => true,
266 /// Similar to the above, but for node announcements indexed by node_id.
267 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
268 match self.sync_status {
269 InitSyncTracker::NoSyncRequested => true,
270 InitSyncTracker::ChannelsSyncing(_) => false,
271 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
276 struct PeerHolder<Descriptor: SocketDescriptor> {
277 peers: HashMap<Descriptor, Peer>,
278 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
279 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
280 peers_needing_send: HashSet<Descriptor>,
281 /// Only add to this set when noise completes:
282 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
285 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
286 fn _check_usize_is_32_or_64() {
287 // See below, less than 32 bit pointers may be unsafe here!
288 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
291 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
292 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
293 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
294 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
295 /// issues such as overly long function definitions.
296 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>>>;
298 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
299 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
300 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
301 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
302 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
303 /// helps with issues such as long function definitions.
304 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>;
306 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
307 /// events into messages which it passes on to its MessageHandlers.
309 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
310 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
311 /// essentially you should default to using a SimpleRefPeerManager, and use a
312 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
313 /// you're using lightning-net-tokio.
314 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
315 CM::Target: ChannelMessageHandler,
316 RM::Target: RoutingMessageHandler,
318 message_handler: MessageHandler<CM, RM>,
319 peers: Mutex<PeerHolder<Descriptor>>,
320 our_node_secret: SecretKey,
321 ephemeral_key_midstate: Sha256Engine,
323 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
324 // bits we will never realistically count into high:
325 peer_counter_low: AtomicUsize,
326 peer_counter_high: AtomicUsize,
331 enum MessageHandlingError {
332 PeerHandleError(PeerHandleError),
333 LightningError(LightningError),
336 impl From<PeerHandleError> for MessageHandlingError {
337 fn from(error: PeerHandleError) -> Self {
338 MessageHandlingError::PeerHandleError(error)
342 impl From<LightningError> for MessageHandlingError {
343 fn from(error: LightningError) -> Self {
344 MessageHandlingError::LightningError(error)
348 macro_rules! encode_msg {
350 let mut buffer = VecWriter(Vec::new());
351 wire::write($msg, &mut buffer).unwrap();
356 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
357 /// PeerIds may repeat, but only after socket_disconnected() has been called.
358 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
359 CM::Target: ChannelMessageHandler,
360 RM::Target: RoutingMessageHandler,
362 /// Constructs a new PeerManager with the given message handlers and node_id secret key
363 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
364 /// cryptographically secure random bytes.
365 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
366 let mut ephemeral_key_midstate = Sha256::engine();
367 ephemeral_key_midstate.input(ephemeral_random_data);
371 peers: Mutex::new(PeerHolder {
372 peers: HashMap::new(),
373 peers_needing_send: HashSet::new(),
374 node_id_to_descriptor: HashMap::new()
377 ephemeral_key_midstate,
378 peer_counter_low: AtomicUsize::new(0),
379 peer_counter_high: AtomicUsize::new(0),
384 /// Get the list of node ids for peers which have completed the initial handshake.
386 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
387 /// new_outbound_connection, however entries will only appear once the initial handshake has
388 /// completed and we are sure the remote peer has the private key for the given node_id.
389 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
390 let peers = self.peers.lock().unwrap();
391 peers.peers.values().filter_map(|p| {
392 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
399 fn get_ephemeral_key(&self) -> SecretKey {
400 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
401 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
402 let high = if low == 0 {
403 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
405 self.peer_counter_high.load(Ordering::Acquire)
407 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
408 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
409 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
412 /// Indicates a new outbound connection has been established to a node with the given node_id.
413 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
414 /// descriptor but must disconnect the connection immediately.
416 /// Returns a small number of bytes to send to the remote node (currently always 50).
418 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
419 /// socket_disconnected().
420 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
421 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
422 let res = peer_encryptor.get_act_one().to_vec();
423 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
425 let mut peers = self.peers.lock().unwrap();
426 if peers.peers.insert(descriptor, Peer {
427 channel_encryptor: peer_encryptor,
430 their_features: None,
432 pending_outbound_buffer: LinkedList::new(),
433 pending_outbound_buffer_first_msg_offset: 0,
434 awaiting_write_event: false,
437 pending_read_buffer_pos: 0,
438 pending_read_is_header: false,
440 sync_status: InitSyncTracker::NoSyncRequested,
442 awaiting_pong: false,
444 panic!("PeerManager driver duplicated descriptors!");
449 /// Indicates a new inbound connection has been established.
451 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
452 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
453 /// call socket_disconnected for the new descriptor but must disconnect the connection
456 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
457 /// socket_disconnected called.
458 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
459 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
460 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
462 let mut peers = self.peers.lock().unwrap();
463 if peers.peers.insert(descriptor, Peer {
464 channel_encryptor: peer_encryptor,
467 their_features: None,
469 pending_outbound_buffer: LinkedList::new(),
470 pending_outbound_buffer_first_msg_offset: 0,
471 awaiting_write_event: false,
474 pending_read_buffer_pos: 0,
475 pending_read_is_header: false,
477 sync_status: InitSyncTracker::NoSyncRequested,
479 awaiting_pong: false,
481 panic!("PeerManager driver duplicated descriptors!");
486 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
487 macro_rules! encode_and_send_msg {
490 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
491 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
495 const MSG_BUFF_SIZE: usize = 10;
496 while !peer.awaiting_write_event {
497 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
498 match peer.sync_status {
499 InitSyncTracker::NoSyncRequested => {},
500 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
501 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
502 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
503 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
504 encode_and_send_msg!(announce);
505 if let &Some(ref update_a) = update_a_option {
506 encode_and_send_msg!(update_a);
508 if let &Some(ref update_b) = update_b_option {
509 encode_and_send_msg!(update_b);
511 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
513 if all_messages.is_empty() || all_messages.len() != steps as usize {
514 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
517 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
518 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
519 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
520 for msg in all_messages.iter() {
521 encode_and_send_msg!(msg);
522 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
524 if all_messages.is_empty() || all_messages.len() != steps as usize {
525 peer.sync_status = InitSyncTracker::NoSyncRequested;
528 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
529 InitSyncTracker::NodesSyncing(key) => {
530 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
531 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
532 for msg in all_messages.iter() {
533 encode_and_send_msg!(msg);
534 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
536 if all_messages.is_empty() || all_messages.len() != steps as usize {
537 peer.sync_status = InitSyncTracker::NoSyncRequested;
544 let next_buff = match peer.pending_outbound_buffer.front() {
549 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
550 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
551 let data_sent = descriptor.send_data(pending, should_be_reading);
552 peer.pending_outbound_buffer_first_msg_offset += data_sent;
553 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
555 peer.pending_outbound_buffer_first_msg_offset = 0;
556 peer.pending_outbound_buffer.pop_front();
558 peer.awaiting_write_event = true;
563 /// Indicates that there is room to write data to the given socket descriptor.
565 /// May return an Err to indicate that the connection should be closed.
567 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
568 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
569 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
570 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
571 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
572 /// new_\*_connection event.
573 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
574 let mut peers = self.peers.lock().unwrap();
575 match peers.peers.get_mut(descriptor) {
576 None => panic!("Descriptor for write_event is not already known to PeerManager"),
578 peer.awaiting_write_event = false;
579 self.do_attempt_write_data(descriptor, peer);
585 /// Indicates that data was read from the given socket descriptor.
587 /// May return an Err to indicate that the connection should be closed.
589 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
590 /// Thus, however, you almost certainly want to call process_events() after any read_event to
591 /// generate send_data calls to handle responses.
593 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
594 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
596 /// Panics if the descriptor was not previously registered in a new_*_connection event.
597 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
598 match self.do_read_event(peer_descriptor, data) {
601 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
607 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
608 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
609 let mut buffer = VecWriter(Vec::new());
610 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
611 let encoded_message = buffer.0;
613 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
614 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
615 peers_needing_send.insert(descriptor);
618 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
620 let mut peers_lock = self.peers.lock().unwrap();
621 let peers = &mut *peers_lock;
622 let pause_read = match peers.peers.get_mut(peer_descriptor) {
623 None => panic!("Descriptor for read_event is not already known to PeerManager"),
625 assert!(peer.pending_read_buffer.len() > 0);
626 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
628 let mut read_pos = 0;
629 while read_pos < data.len() {
631 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
632 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]);
633 read_pos += data_to_copy;
634 peer.pending_read_buffer_pos += data_to_copy;
637 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
638 peer.pending_read_buffer_pos = 0;
640 macro_rules! try_potential_handleerror {
646 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
647 //TODO: Try to push msg
648 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
649 return Err(PeerHandleError{ no_connection_possible: false });
651 msgs::ErrorAction::IgnoreError => {
652 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
655 msgs::ErrorAction::SendErrorMessage { msg } => {
656 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
657 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
666 macro_rules! insert_node_id {
668 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
669 hash_map::Entry::Occupied(_) => {
670 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
671 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
672 return Err(PeerHandleError{ no_connection_possible: false })
674 hash_map::Entry::Vacant(entry) => {
675 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
676 entry.insert(peer_descriptor.clone())
682 let next_step = peer.channel_encryptor.get_noise_step();
684 NextNoiseStep::ActOne => {
685 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();
686 peer.pending_outbound_buffer.push_back(act_two);
687 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
689 NextNoiseStep::ActTwo => {
690 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
691 peer.pending_outbound_buffer.push_back(act_three.to_vec());
692 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
693 peer.pending_read_is_header = true;
695 peer.their_node_id = Some(their_node_id);
697 let features = InitFeatures::known();
698 let resp = msgs::Init { features };
699 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
701 NextNoiseStep::ActThree => {
702 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
703 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
704 peer.pending_read_is_header = true;
705 peer.their_node_id = Some(their_node_id);
708 NextNoiseStep::NoiseComplete => {
709 if peer.pending_read_is_header {
710 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
711 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
712 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
713 if msg_len < 2 { // Need at least the message type tag
714 return Err(PeerHandleError{ no_connection_possible: false });
716 peer.pending_read_is_header = false;
718 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
719 assert!(msg_data.len() >= 2);
722 peer.pending_read_buffer = [0; 18].to_vec();
723 peer.pending_read_is_header = true;
725 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
726 let message_result = wire::read(&mut reader);
727 let message = match message_result {
731 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
732 msgs::DecodeError::UnknownRequiredFeature => {
733 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
736 msgs::DecodeError::InvalidValue => {
737 log_debug!(self.logger, "Got an invalid value while deserializing message");
738 return Err(PeerHandleError { no_connection_possible: false });
740 msgs::DecodeError::ShortRead => {
741 log_debug!(self.logger, "Deserialization failed due to shortness of message");
742 return Err(PeerHandleError { no_connection_possible: false });
744 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
745 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
750 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
751 match handling_error {
752 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
753 MessageHandlingError::LightningError(e) => {
754 try_potential_handleerror!(Err(e));
764 self.do_attempt_write_data(peer_descriptor, peer);
766 peer.pending_outbound_buffer.len() > 10 // pause_read
776 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
777 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
778 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
780 // Need an Init as first message
781 if let wire::Message::Init(_) = message {
782 } else if peer.their_features.is_none() {
783 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
784 return Err(PeerHandleError{ no_connection_possible: false }.into());
788 // Setup and Control messages:
789 wire::Message::Init(msg) => {
790 if msg.features.requires_unknown_bits() {
791 log_info!(self.logger, "Peer features required unknown version bits");
792 return Err(PeerHandleError{ no_connection_possible: true }.into());
794 if peer.their_features.is_some() {
795 return Err(PeerHandleError{ no_connection_possible: false }.into());
799 self.logger, "Received peer Init message: data_loss_protect: {}, initial_routing_sync: {}, upfront_shutdown_script: {}, gossip_queries: {}, static_remote_key: {}, unknown flags (local and global): {}",
800 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
801 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
802 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
803 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
804 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
805 if msg.features.supports_unknown_bits() { "present" } else { "none" }
808 if msg.features.initial_routing_sync() {
809 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
810 peers_needing_send.insert(peer_descriptor.clone());
812 if !msg.features.supports_static_remote_key() {
813 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
814 return Err(PeerHandleError{ no_connection_possible: true }.into());
818 let features = InitFeatures::known();
819 let resp = msgs::Init { features };
820 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
823 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
825 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
826 peer.their_features = Some(msg.features);
828 wire::Message::Error(msg) => {
829 let mut data_is_printable = true;
830 for b in msg.data.bytes() {
831 if b < 32 || b > 126 {
832 data_is_printable = false;
837 if data_is_printable {
838 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
840 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
842 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
843 if msg.channel_id == [0; 32] {
844 return Err(PeerHandleError{ no_connection_possible: true }.into());
848 wire::Message::Ping(msg) => {
849 if msg.ponglen < 65532 {
850 let resp = msgs::Pong { byteslen: msg.ponglen };
851 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
854 wire::Message::Pong(_msg) => {
855 peer.awaiting_pong = false;
859 wire::Message::OpenChannel(msg) => {
860 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
862 wire::Message::AcceptChannel(msg) => {
863 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
866 wire::Message::FundingCreated(msg) => {
867 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
869 wire::Message::FundingSigned(msg) => {
870 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
872 wire::Message::FundingLocked(msg) => {
873 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
876 wire::Message::Shutdown(msg) => {
877 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
879 wire::Message::ClosingSigned(msg) => {
880 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
883 // Commitment messages:
884 wire::Message::UpdateAddHTLC(msg) => {
885 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
887 wire::Message::UpdateFulfillHTLC(msg) => {
888 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
890 wire::Message::UpdateFailHTLC(msg) => {
891 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
893 wire::Message::UpdateFailMalformedHTLC(msg) => {
894 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
897 wire::Message::CommitmentSigned(msg) => {
898 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
900 wire::Message::RevokeAndACK(msg) => {
901 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
903 wire::Message::UpdateFee(msg) => {
904 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
906 wire::Message::ChannelReestablish(msg) => {
907 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
911 wire::Message::AnnouncementSignatures(msg) => {
912 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
914 wire::Message::ChannelAnnouncement(msg) => {
915 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
917 Err(e) => { return Err(e.into()); },
921 // TODO: forward msg along to all our other peers!
924 wire::Message::NodeAnnouncement(msg) => {
925 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
927 Err(e) => { return Err(e.into()); },
931 // TODO: forward msg along to all our other peers!
934 wire::Message::ChannelUpdate(msg) => {
935 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
937 Err(e) => { return Err(e.into()); },
941 // TODO: forward msg along to all our other peers!
944 wire::Message::QueryShortChannelIds(msg) => {
945 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
947 wire::Message::ReplyShortChannelIdsEnd(msg) => {
948 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
950 wire::Message::QueryChannelRange(msg) => {
951 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
953 wire::Message::ReplyChannelRange(msg) => {
954 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
956 wire::Message::GossipTimestampFilter(_msg) => {
957 // TODO: handle message
961 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
962 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
963 // Fail the channel if message is an even, unknown type as per BOLT #1.
964 return Err(PeerHandleError{ no_connection_possible: true }.into());
966 wire::Message::Unknown(msg_type) => {
967 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
973 /// Checks for any events generated by our handlers and processes them. Includes sending most
974 /// response messages as well as messages generated by calls to handler functions directly (eg
975 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
976 pub fn process_events(&self) {
978 // TODO: There are some DoS attacks here where you can flood someone's outbound send
979 // buffer by doing things like announcing channels on another node. We should be willing to
980 // drop optional-ish messages when send buffers get full!
982 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
983 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
984 let mut peers_lock = self.peers.lock().unwrap();
985 let peers = &mut *peers_lock;
986 for event in events_generated.drain(..) {
987 macro_rules! get_peer_for_forwarding {
988 ($node_id: expr, $handle_no_such_peer: block) => {
990 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
991 Some(descriptor) => descriptor.clone(),
993 $handle_no_such_peer;
997 match peers.peers.get_mut(&descriptor) {
999 if peer.their_features.is_none() {
1000 $handle_no_such_peer;
1005 None => panic!("Inconsistent peers set state!"),
1011 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1012 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1013 log_pubkey!(node_id),
1014 log_bytes!(msg.temporary_channel_id));
1015 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1016 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1018 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1019 self.do_attempt_write_data(&mut descriptor, peer);
1021 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1022 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1023 log_pubkey!(node_id),
1024 log_bytes!(msg.temporary_channel_id));
1025 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1026 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1028 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1029 self.do_attempt_write_data(&mut descriptor, peer);
1031 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1032 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1033 log_pubkey!(node_id),
1034 log_bytes!(msg.temporary_channel_id),
1035 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1036 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1037 //TODO: generate a DiscardFunding event indicating to the wallet that
1038 //they should just throw away this funding transaction
1040 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1041 self.do_attempt_write_data(&mut descriptor, peer);
1043 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1044 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1045 log_pubkey!(node_id),
1046 log_bytes!(msg.channel_id));
1047 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1048 //TODO: generate a DiscardFunding event indicating to the wallet that
1049 //they should just throw away this funding transaction
1051 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1052 self.do_attempt_write_data(&mut descriptor, peer);
1054 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1055 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1056 log_pubkey!(node_id),
1057 log_bytes!(msg.channel_id));
1058 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1059 //TODO: Do whatever we're gonna do for handling dropped messages
1061 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1062 self.do_attempt_write_data(&mut descriptor, peer);
1064 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1065 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1066 log_pubkey!(node_id),
1067 log_bytes!(msg.channel_id));
1068 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1069 //TODO: generate a DiscardFunding event indicating to the wallet that
1070 //they should just throw away this funding transaction
1072 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1073 self.do_attempt_write_data(&mut descriptor, peer);
1075 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 } } => {
1076 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1077 log_pubkey!(node_id),
1078 update_add_htlcs.len(),
1079 update_fulfill_htlcs.len(),
1080 update_fail_htlcs.len(),
1081 log_bytes!(commitment_signed.channel_id));
1082 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1083 //TODO: Do whatever we're gonna do for handling dropped messages
1085 for msg in update_add_htlcs {
1086 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1088 for msg in update_fulfill_htlcs {
1089 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1091 for msg in update_fail_htlcs {
1092 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1094 for msg in update_fail_malformed_htlcs {
1095 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1097 if let &Some(ref msg) = update_fee {
1098 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1100 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1101 self.do_attempt_write_data(&mut descriptor, peer);
1103 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1104 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1105 log_pubkey!(node_id),
1106 log_bytes!(msg.channel_id));
1107 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1108 //TODO: Do whatever we're gonna do for handling dropped messages
1110 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1111 self.do_attempt_write_data(&mut descriptor, peer);
1113 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1114 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1115 log_pubkey!(node_id),
1116 log_bytes!(msg.channel_id));
1117 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1118 //TODO: Do whatever we're gonna do for handling dropped messages
1120 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1121 self.do_attempt_write_data(&mut descriptor, peer);
1123 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1124 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1125 log_pubkey!(node_id),
1126 log_bytes!(msg.channel_id));
1127 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1128 //TODO: Do whatever we're gonna do for handling dropped messages
1130 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1131 self.do_attempt_write_data(&mut descriptor, peer);
1133 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1134 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1135 log_pubkey!(node_id),
1136 log_bytes!(msg.channel_id));
1137 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1138 //TODO: Do whatever we're gonna do for handling dropped messages
1140 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1141 self.do_attempt_write_data(&mut descriptor, peer);
1143 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1144 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1145 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1146 let encoded_msg = encode_msg!(msg);
1147 let encoded_update_msg = encode_msg!(update_msg);
1149 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1150 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1151 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1154 match peer.their_node_id {
1156 Some(their_node_id) => {
1157 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1162 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1163 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1164 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1168 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1169 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1170 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1171 let encoded_msg = encode_msg!(msg);
1173 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1174 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1175 !peer.should_forward_node_announcement(msg.contents.node_id) {
1178 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1179 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1183 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1184 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1185 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1186 let encoded_msg = encode_msg!(msg);
1188 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1189 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1190 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1193 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1194 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1198 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1199 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1201 MessageSendEvent::HandleError { ref node_id, ref action } => {
1203 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1204 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1205 peers.peers_needing_send.remove(&descriptor);
1206 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1207 if let Some(ref msg) = *msg {
1208 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1209 log_pubkey!(node_id),
1211 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1212 // This isn't guaranteed to work, but if there is enough free
1213 // room in the send buffer, put the error message there...
1214 self.do_attempt_write_data(&mut descriptor, &mut peer);
1216 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1219 descriptor.disconnect_socket();
1220 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1223 msgs::ErrorAction::IgnoreError => {},
1224 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1225 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1226 log_pubkey!(node_id),
1228 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1229 //TODO: Do whatever we're gonna do for handling dropped messages
1231 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1232 self.do_attempt_write_data(&mut descriptor, peer);
1236 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1237 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1238 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1239 self.do_attempt_write_data(&mut descriptor, peer);
1241 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1242 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1243 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1244 self.do_attempt_write_data(&mut descriptor, peer);
1249 for mut descriptor in peers.peers_needing_send.drain() {
1250 match peers.peers.get_mut(&descriptor) {
1251 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1252 None => panic!("Inconsistent peers set state!"),
1258 /// Indicates that the given socket descriptor's connection is now closed.
1260 /// This must only be called if the socket has been disconnected by the peer or your own
1261 /// decision to disconnect it and must NOT be called in any case where other parts of this
1262 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1265 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1266 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1267 self.disconnect_event_internal(descriptor, false);
1270 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1271 let mut peers = self.peers.lock().unwrap();
1272 peers.peers_needing_send.remove(descriptor);
1273 let peer_option = peers.peers.remove(descriptor);
1275 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1277 match peer.their_node_id {
1279 peers.node_id_to_descriptor.remove(&node_id);
1280 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1288 /// Disconnect a peer given its node id.
1290 /// Set no_connection_possible to true to prevent any further connection with this peer,
1291 /// force-closing any channels we have with it.
1293 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1294 /// so be careful about reentrancy issues.
1295 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1296 let mut peers_lock = self.peers.lock().unwrap();
1297 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1298 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1299 peers_lock.peers.remove(&descriptor);
1300 peers_lock.peers_needing_send.remove(&descriptor);
1301 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1302 descriptor.disconnect_socket();
1306 /// This function should be called roughly once every 30 seconds.
1307 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1309 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1310 pub fn timer_tick_occured(&self) {
1311 let mut peers_lock = self.peers.lock().unwrap();
1313 let peers = &mut *peers_lock;
1314 let peers_needing_send = &mut peers.peers_needing_send;
1315 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1316 let peers = &mut peers.peers;
1317 let mut descriptors_needing_disconnect = Vec::new();
1319 peers.retain(|descriptor, peer| {
1320 if peer.awaiting_pong {
1321 peers_needing_send.remove(descriptor);
1322 descriptors_needing_disconnect.push(descriptor.clone());
1323 match peer.their_node_id {
1325 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1326 node_id_to_descriptor.remove(&node_id);
1327 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1330 // This can't actually happen as we should have hit
1331 // is_ready_for_encryption() previously on this same peer.
1338 if !peer.channel_encryptor.is_ready_for_encryption() {
1339 // The peer needs to complete its handshake before we can exchange messages
1343 let ping = msgs::Ping {
1347 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1349 let mut descriptor_clone = descriptor.clone();
1350 self.do_attempt_write_data(&mut descriptor_clone, peer);
1352 peer.awaiting_pong = true;
1356 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1357 descriptor.disconnect_socket();
1365 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1368 use util::test_utils;
1370 use bitcoin::secp256k1::Secp256k1;
1371 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1374 use std::sync::{Arc, Mutex};
1375 use std::sync::atomic::Ordering;
1378 struct FileDescriptor {
1380 outbound_data: Arc<Mutex<Vec<u8>>>,
1382 impl PartialEq for FileDescriptor {
1383 fn eq(&self, other: &Self) -> bool {
1387 impl Eq for FileDescriptor { }
1388 impl std::hash::Hash for FileDescriptor {
1389 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1390 self.fd.hash(hasher)
1394 impl SocketDescriptor for FileDescriptor {
1395 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1396 self.outbound_data.lock().unwrap().extend_from_slice(data);
1400 fn disconnect_socket(&mut self) {}
1403 struct PeerManagerCfg {
1404 chan_handler: test_utils::TestChannelMessageHandler,
1405 routing_handler: test_utils::TestRoutingMessageHandler,
1406 logger: test_utils::TestLogger,
1409 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1410 let mut cfgs = Vec::new();
1411 for _ in 0..peer_count {
1414 chan_handler: test_utils::TestChannelMessageHandler::new(),
1415 logger: test_utils::TestLogger::new(),
1416 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1424 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>> {
1425 let mut peers = Vec::new();
1426 for i in 0..peer_count {
1427 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1428 let ephemeral_bytes = [i as u8; 32];
1429 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1430 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1437 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) {
1438 let secp_ctx = Secp256k1::new();
1439 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1440 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1441 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1442 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1443 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1444 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1445 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1446 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1447 (fd_a.clone(), fd_b.clone())
1451 fn test_disconnect_peer() {
1452 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1453 // push a DisconnectPeer event to remove the node flagged by id
1454 let cfgs = create_peermgr_cfgs(2);
1455 let chan_handler = test_utils::TestChannelMessageHandler::new();
1456 let mut peers = create_network(2, &cfgs);
1457 establish_connection(&peers[0], &peers[1]);
1458 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1460 let secp_ctx = Secp256k1::new();
1461 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1463 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1465 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1467 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1468 peers[0].message_handler.chan_handler = &chan_handler;
1470 peers[0].process_events();
1471 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1475 fn test_timer_tick_occurred() {
1476 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1477 let cfgs = create_peermgr_cfgs(2);
1478 let peers = create_network(2, &cfgs);
1479 establish_connection(&peers[0], &peers[1]);
1480 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1482 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1483 peers[0].timer_tick_occured();
1484 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1486 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1487 peers[0].timer_tick_occured();
1488 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1492 fn test_do_attempt_write_data() {
1493 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1494 let cfgs = create_peermgr_cfgs(2);
1495 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1496 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1497 let peers = create_network(2, &cfgs);
1499 // By calling establish_connect, we trigger do_attempt_write_data between
1500 // the peers. Previously this function would mistakenly enter an infinite loop
1501 // when there were more channel messages available than could fit into a peer's
1502 // buffer. This issue would now be detected by this test (because we use custom
1503 // RoutingMessageHandlers that intentionally return more channel messages
1504 // than can fit into a peer's buffer).
1505 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1507 // Make each peer to read the messages that the other peer just wrote to them.
1508 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1509 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1511 // Check that each peer has received the expected number of channel updates and channel
1513 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1514 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1515 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1516 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);