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;
34 use alloc::collections::LinkedList;
35 use std::collections::{HashMap,hash_map,HashSet};
36 use std::sync::{Arc, Mutex};
37 use core::sync::atomic::{AtomicUsize, Ordering};
38 use core::{cmp, hash, fmt, mem};
42 use bitcoin::hashes::sha256::Hash as Sha256;
43 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
44 use bitcoin::hashes::{HashEngine, Hash};
46 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
47 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
48 pub struct IgnoringMessageHandler{}
49 impl MessageSendEventsProvider for IgnoringMessageHandler {
50 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
52 impl RoutingMessageHandler for IgnoringMessageHandler {
53 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
54 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
55 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
56 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
57 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
58 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
59 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
60 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
61 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
62 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
63 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
64 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
66 impl Deref for IgnoringMessageHandler {
67 type Target = IgnoringMessageHandler;
68 fn deref(&self) -> &Self { self }
71 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
72 /// You can provide one of these as the route_handler in a MessageHandler.
73 pub struct ErroringMessageHandler {
74 message_queue: Mutex<Vec<MessageSendEvent>>
76 impl ErroringMessageHandler {
77 /// Constructs a new ErroringMessageHandler
78 pub fn new() -> Self {
79 Self { message_queue: Mutex::new(Vec::new()) }
81 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
82 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
83 action: msgs::ErrorAction::SendErrorMessage {
84 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
86 node_id: node_id.clone(),
90 impl MessageSendEventsProvider for ErroringMessageHandler {
91 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
92 let mut res = Vec::new();
93 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
97 impl ChannelMessageHandler for ErroringMessageHandler {
98 // Any messages which are related to a specific channel generate an error message to let the
99 // peer know we don't care about channels.
100 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
101 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
103 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
104 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
106 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
107 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
109 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
110 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
112 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
113 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
115 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
116 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
118 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
119 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
121 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
122 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
124 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
125 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
127 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
128 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
130 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
131 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
133 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
134 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
136 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
137 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
139 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
140 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
142 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
143 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
145 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
146 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
148 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
149 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
150 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
151 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
152 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
154 impl Deref for ErroringMessageHandler {
155 type Target = ErroringMessageHandler;
156 fn deref(&self) -> &Self { self }
159 /// Provides references to trait impls which handle different types of messages.
160 pub struct MessageHandler<CM: Deref, RM: Deref> where
161 CM::Target: ChannelMessageHandler,
162 RM::Target: RoutingMessageHandler {
163 /// A message handler which handles messages specific to channels. Usually this is just a
164 /// ChannelManager object or a ErroringMessageHandler.
165 pub chan_handler: CM,
166 /// A message handler which handles messages updating our knowledge of the network channel
167 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
168 pub route_handler: RM,
171 /// Provides an object which can be used to send data to and which uniquely identifies a connection
172 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
173 /// implement Hash to meet the PeerManager API.
175 /// For efficiency, Clone should be relatively cheap for this type.
177 /// You probably want to just extend an int and put a file descriptor in a struct and implement
178 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
179 /// be careful to ensure you don't have races whereby you might register a new connection with an
180 /// fd which is the same as a previous one which has yet to be removed via
181 /// PeerManager::socket_disconnected().
182 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
183 /// Attempts to send some data from the given slice to the peer.
185 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
186 /// Note that in the disconnected case, socket_disconnected must still fire and further write
187 /// attempts may occur until that time.
189 /// If the returned size is smaller than data.len(), a write_available event must
190 /// trigger the next time more data can be written. Additionally, until the a send_data event
191 /// completes fully, no further read_events should trigger on the same peer!
193 /// If a read_event on this descriptor had previously returned true (indicating that read
194 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
195 /// indicating that read events on this descriptor should resume. A resume_read of false does
196 /// *not* imply that further read events should be paused.
197 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
198 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
199 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
200 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
201 /// though races may occur whereby disconnect_socket is called after a call to
202 /// socket_disconnected but prior to socket_disconnected returning.
203 fn disconnect_socket(&mut self);
206 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
207 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
210 pub struct PeerHandleError {
211 /// Used to indicate that we probably can't make any future connections to this peer, implying
212 /// we should go ahead and force-close any channels we have with it.
213 pub no_connection_possible: bool,
215 impl fmt::Debug for PeerHandleError {
216 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
217 formatter.write_str("Peer Sent Invalid Data")
220 impl fmt::Display for PeerHandleError {
221 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
222 formatter.write_str("Peer Sent Invalid Data")
225 impl error::Error for PeerHandleError {
226 fn description(&self) -> &str {
227 "Peer Sent Invalid Data"
231 enum InitSyncTracker{
233 ChannelsSyncing(u64),
234 NodesSyncing(PublicKey),
238 channel_encryptor: PeerChannelEncryptor,
239 their_node_id: Option<PublicKey>,
240 their_features: Option<InitFeatures>,
242 pending_outbound_buffer: LinkedList<Vec<u8>>,
243 pending_outbound_buffer_first_msg_offset: usize,
244 awaiting_write_event: bool,
246 pending_read_buffer: Vec<u8>,
247 pending_read_buffer_pos: usize,
248 pending_read_is_header: bool,
250 sync_status: InitSyncTracker,
256 /// Returns true if the channel announcements/updates for the given channel should be
257 /// forwarded to this peer.
258 /// If we are sending our routing table to this peer and we have not yet sent channel
259 /// announcements/updates for the given channel_id then we will send it when we get to that
260 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
261 /// sent the old versions, we should send the update, and so return true here.
262 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
263 match self.sync_status {
264 InitSyncTracker::NoSyncRequested => true,
265 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
266 InitSyncTracker::NodesSyncing(_) => true,
270 /// Similar to the above, but for node announcements indexed by node_id.
271 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
272 match self.sync_status {
273 InitSyncTracker::NoSyncRequested => true,
274 InitSyncTracker::ChannelsSyncing(_) => false,
275 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
280 struct PeerHolder<Descriptor: SocketDescriptor> {
281 peers: HashMap<Descriptor, Peer>,
282 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
283 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
284 peers_needing_send: HashSet<Descriptor>,
285 /// Only add to this set when noise completes:
286 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
289 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
290 fn _check_usize_is_32_or_64() {
291 // See below, less than 32 bit pointers may be unsafe here!
292 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
295 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
296 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
297 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
298 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
299 /// issues such as overly long function definitions.
300 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<NetGraphMsgHandler<Arc<C>, Arc<L>>>, Arc<L>>;
302 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
303 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
304 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
305 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
306 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
307 /// helps with issues such as long function definitions.
308 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>;
310 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
311 /// events into messages which it passes on to its MessageHandlers.
313 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
314 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
315 /// essentially you should default to using a SimpleRefPeerManager, and use a
316 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
317 /// you're using lightning-net-tokio.
318 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
319 CM::Target: ChannelMessageHandler,
320 RM::Target: RoutingMessageHandler,
322 message_handler: MessageHandler<CM, RM>,
323 peers: Mutex<PeerHolder<Descriptor>>,
324 our_node_secret: SecretKey,
325 ephemeral_key_midstate: Sha256Engine,
327 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
328 // bits we will never realistically count into high:
329 peer_counter_low: AtomicUsize,
330 peer_counter_high: AtomicUsize,
335 enum MessageHandlingError {
336 PeerHandleError(PeerHandleError),
337 LightningError(LightningError),
340 impl From<PeerHandleError> for MessageHandlingError {
341 fn from(error: PeerHandleError) -> Self {
342 MessageHandlingError::PeerHandleError(error)
346 impl From<LightningError> for MessageHandlingError {
347 fn from(error: LightningError) -> Self {
348 MessageHandlingError::LightningError(error)
352 macro_rules! encode_msg {
354 let mut buffer = VecWriter(Vec::new());
355 wire::write($msg, &mut buffer).unwrap();
360 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
361 CM::Target: ChannelMessageHandler,
363 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
364 /// handler is used and network graph messages are ignored.
366 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
367 /// cryptographically secure random bytes.
369 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
370 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
371 Self::new(MessageHandler {
372 chan_handler: channel_message_handler,
373 route_handler: IgnoringMessageHandler{},
374 }, our_node_secret, ephemeral_random_data, logger)
378 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
379 RM::Target: RoutingMessageHandler,
381 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
382 /// handler is used and messages related to channels will be ignored (or generate error
383 /// messages). Note that some other lightning implementations time-out connections after some
384 /// time if no channel is built with the peer.
386 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
387 /// cryptographically secure random bytes.
389 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
390 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
391 Self::new(MessageHandler {
392 chan_handler: ErroringMessageHandler::new(),
393 route_handler: routing_message_handler,
394 }, our_node_secret, ephemeral_random_data, logger)
398 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
399 /// PeerIds may repeat, but only after socket_disconnected() has been called.
400 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
401 CM::Target: ChannelMessageHandler,
402 RM::Target: RoutingMessageHandler,
404 /// Constructs a new PeerManager with the given message handlers and node_id secret key
405 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
406 /// cryptographically secure random bytes.
407 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
408 let mut ephemeral_key_midstate = Sha256::engine();
409 ephemeral_key_midstate.input(ephemeral_random_data);
413 peers: Mutex::new(PeerHolder {
414 peers: HashMap::new(),
415 peers_needing_send: HashSet::new(),
416 node_id_to_descriptor: HashMap::new()
419 ephemeral_key_midstate,
420 peer_counter_low: AtomicUsize::new(0),
421 peer_counter_high: AtomicUsize::new(0),
426 /// Get the list of node ids for peers which have completed the initial handshake.
428 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
429 /// new_outbound_connection, however entries will only appear once the initial handshake has
430 /// completed and we are sure the remote peer has the private key for the given node_id.
431 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
432 let peers = self.peers.lock().unwrap();
433 peers.peers.values().filter_map(|p| {
434 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
441 fn get_ephemeral_key(&self) -> SecretKey {
442 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
443 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
444 let high = if low == 0 {
445 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
447 self.peer_counter_high.load(Ordering::Acquire)
449 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
450 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
451 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
454 /// Indicates a new outbound connection has been established to a node with the given node_id.
455 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
456 /// descriptor but must disconnect the connection immediately.
458 /// Returns a small number of bytes to send to the remote node (currently always 50).
460 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
461 /// socket_disconnected().
462 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
463 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
464 let res = peer_encryptor.get_act_one().to_vec();
465 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
467 let mut peers = self.peers.lock().unwrap();
468 if peers.peers.insert(descriptor, Peer {
469 channel_encryptor: peer_encryptor,
471 their_features: None,
473 pending_outbound_buffer: LinkedList::new(),
474 pending_outbound_buffer_first_msg_offset: 0,
475 awaiting_write_event: false,
478 pending_read_buffer_pos: 0,
479 pending_read_is_header: false,
481 sync_status: InitSyncTracker::NoSyncRequested,
483 awaiting_pong: false,
485 panic!("PeerManager driver duplicated descriptors!");
490 /// Indicates a new inbound connection has been established.
492 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
493 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
494 /// call socket_disconnected for the new descriptor but must disconnect the connection
497 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
498 /// socket_disconnected called.
499 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
500 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
501 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
503 let mut peers = self.peers.lock().unwrap();
504 if peers.peers.insert(descriptor, Peer {
505 channel_encryptor: peer_encryptor,
507 their_features: None,
509 pending_outbound_buffer: LinkedList::new(),
510 pending_outbound_buffer_first_msg_offset: 0,
511 awaiting_write_event: false,
514 pending_read_buffer_pos: 0,
515 pending_read_is_header: false,
517 sync_status: InitSyncTracker::NoSyncRequested,
519 awaiting_pong: false,
521 panic!("PeerManager driver duplicated descriptors!");
526 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
527 macro_rules! encode_and_send_msg {
530 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
531 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
535 const MSG_BUFF_SIZE: usize = 10;
536 while !peer.awaiting_write_event {
537 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
538 match peer.sync_status {
539 InitSyncTracker::NoSyncRequested => {},
540 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
541 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
542 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
543 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
544 encode_and_send_msg!(announce);
545 if let &Some(ref update_a) = update_a_option {
546 encode_and_send_msg!(update_a);
548 if let &Some(ref update_b) = update_b_option {
549 encode_and_send_msg!(update_b);
551 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
553 if all_messages.is_empty() || all_messages.len() != steps as usize {
554 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
557 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
558 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
559 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
560 for msg in all_messages.iter() {
561 encode_and_send_msg!(msg);
562 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
564 if all_messages.is_empty() || all_messages.len() != steps as usize {
565 peer.sync_status = InitSyncTracker::NoSyncRequested;
568 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
569 InitSyncTracker::NodesSyncing(key) => {
570 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
571 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
572 for msg in all_messages.iter() {
573 encode_and_send_msg!(msg);
574 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
576 if all_messages.is_empty() || all_messages.len() != steps as usize {
577 peer.sync_status = InitSyncTracker::NoSyncRequested;
584 let next_buff = match peer.pending_outbound_buffer.front() {
589 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
590 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
591 let data_sent = descriptor.send_data(pending, should_be_reading);
592 peer.pending_outbound_buffer_first_msg_offset += data_sent;
593 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
595 peer.pending_outbound_buffer_first_msg_offset = 0;
596 peer.pending_outbound_buffer.pop_front();
598 peer.awaiting_write_event = true;
603 /// Indicates that there is room to write data to the given socket descriptor.
605 /// May return an Err to indicate that the connection should be closed.
607 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
608 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
609 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
610 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
611 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
612 /// new_\*_connection event.
613 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
614 let mut peers = self.peers.lock().unwrap();
615 match peers.peers.get_mut(descriptor) {
616 None => panic!("Descriptor for write_event is not already known to PeerManager"),
618 peer.awaiting_write_event = false;
619 self.do_attempt_write_data(descriptor, peer);
625 /// Indicates that data was read from the given socket descriptor.
627 /// May return an Err to indicate that the connection should be closed.
629 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
630 /// Thus, however, you almost certainly want to call process_events() after any read_event to
631 /// generate send_data calls to handle responses.
633 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
634 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
636 /// Panics if the descriptor was not previously registered in a new_*_connection event.
637 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
638 match self.do_read_event(peer_descriptor, data) {
641 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
647 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
648 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
649 let mut buffer = VecWriter(Vec::new());
650 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
651 let encoded_message = buffer.0;
653 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
654 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
655 peers_needing_send.insert(descriptor);
658 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
660 let mut peers_lock = self.peers.lock().unwrap();
661 let peers = &mut *peers_lock;
662 let pause_read = match peers.peers.get_mut(peer_descriptor) {
663 None => panic!("Descriptor for read_event is not already known to PeerManager"),
665 assert!(peer.pending_read_buffer.len() > 0);
666 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
668 let mut read_pos = 0;
669 while read_pos < data.len() {
671 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
672 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]);
673 read_pos += data_to_copy;
674 peer.pending_read_buffer_pos += data_to_copy;
677 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
678 peer.pending_read_buffer_pos = 0;
680 macro_rules! try_potential_handleerror {
686 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
687 //TODO: Try to push msg
688 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
689 return Err(PeerHandleError{ no_connection_possible: false });
691 msgs::ErrorAction::IgnoreError => {
692 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
695 msgs::ErrorAction::SendErrorMessage { msg } => {
696 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
697 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
706 macro_rules! insert_node_id {
708 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
709 hash_map::Entry::Occupied(_) => {
710 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
711 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
712 return Err(PeerHandleError{ no_connection_possible: false })
714 hash_map::Entry::Vacant(entry) => {
715 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
716 entry.insert(peer_descriptor.clone())
722 let next_step = peer.channel_encryptor.get_noise_step();
724 NextNoiseStep::ActOne => {
725 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();
726 peer.pending_outbound_buffer.push_back(act_two);
727 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
729 NextNoiseStep::ActTwo => {
730 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
731 peer.pending_outbound_buffer.push_back(act_three.to_vec());
732 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
733 peer.pending_read_is_header = true;
735 peer.their_node_id = Some(their_node_id);
737 let features = InitFeatures::known();
738 let resp = msgs::Init { features };
739 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
741 NextNoiseStep::ActThree => {
742 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
743 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
744 peer.pending_read_is_header = true;
745 peer.their_node_id = Some(their_node_id);
747 let features = InitFeatures::known();
748 let resp = msgs::Init { features };
749 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
751 NextNoiseStep::NoiseComplete => {
752 if peer.pending_read_is_header {
753 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
754 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
755 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
756 if msg_len < 2 { // Need at least the message type tag
757 return Err(PeerHandleError{ no_connection_possible: false });
759 peer.pending_read_is_header = false;
761 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
762 assert!(msg_data.len() >= 2);
765 peer.pending_read_buffer = [0; 18].to_vec();
766 peer.pending_read_is_header = true;
768 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
769 let message_result = wire::read(&mut reader);
770 let message = match message_result {
774 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
775 msgs::DecodeError::UnknownRequiredFeature => {
776 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
779 msgs::DecodeError::InvalidValue => {
780 log_debug!(self.logger, "Got an invalid value while deserializing message");
781 return Err(PeerHandleError { no_connection_possible: false });
783 msgs::DecodeError::ShortRead => {
784 log_debug!(self.logger, "Deserialization failed due to shortness of message");
785 return Err(PeerHandleError { no_connection_possible: false });
787 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
788 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
789 msgs::DecodeError::UnsupportedCompression => {
790 log_debug!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
797 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message) {
798 match handling_error {
799 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
800 MessageHandlingError::LightningError(e) => {
801 try_potential_handleerror!(Err(e));
811 peer.pending_outbound_buffer.len() > 10 // pause_read
821 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
822 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
823 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
825 // Need an Init as first message
826 if let wire::Message::Init(_) = message {
827 } else if peer.their_features.is_none() {
828 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
829 return Err(PeerHandleError{ no_connection_possible: false }.into());
833 // Setup and Control messages:
834 wire::Message::Init(msg) => {
835 if msg.features.requires_unknown_bits() {
836 log_info!(self.logger, "Peer features required unknown version bits");
837 return Err(PeerHandleError{ no_connection_possible: true }.into());
839 if peer.their_features.is_some() {
840 return Err(PeerHandleError{ no_connection_possible: false }.into());
844 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): {}",
845 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
846 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
847 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
848 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
849 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
850 if msg.features.supports_unknown_bits() { "present" } else { "none" }
853 if msg.features.initial_routing_sync() {
854 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
855 peers_needing_send.insert(peer_descriptor.clone());
857 if !msg.features.supports_static_remote_key() {
858 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
859 return Err(PeerHandleError{ no_connection_possible: true }.into());
862 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
864 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
865 peer.their_features = Some(msg.features);
867 wire::Message::Error(msg) => {
868 let mut data_is_printable = true;
869 for b in msg.data.bytes() {
870 if b < 32 || b > 126 {
871 data_is_printable = false;
876 if data_is_printable {
877 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
879 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
881 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
882 if msg.channel_id == [0; 32] {
883 return Err(PeerHandleError{ no_connection_possible: true }.into());
887 wire::Message::Ping(msg) => {
888 if msg.ponglen < 65532 {
889 let resp = msgs::Pong { byteslen: msg.ponglen };
890 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
893 wire::Message::Pong(_msg) => {
894 peer.awaiting_pong = false;
898 wire::Message::OpenChannel(msg) => {
899 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
901 wire::Message::AcceptChannel(msg) => {
902 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
905 wire::Message::FundingCreated(msg) => {
906 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
908 wire::Message::FundingSigned(msg) => {
909 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
911 wire::Message::FundingLocked(msg) => {
912 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
915 wire::Message::Shutdown(msg) => {
916 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
918 wire::Message::ClosingSigned(msg) => {
919 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
922 // Commitment messages:
923 wire::Message::UpdateAddHTLC(msg) => {
924 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
926 wire::Message::UpdateFulfillHTLC(msg) => {
927 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
929 wire::Message::UpdateFailHTLC(msg) => {
930 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
932 wire::Message::UpdateFailMalformedHTLC(msg) => {
933 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
936 wire::Message::CommitmentSigned(msg) => {
937 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
939 wire::Message::RevokeAndACK(msg) => {
940 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
942 wire::Message::UpdateFee(msg) => {
943 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
945 wire::Message::ChannelReestablish(msg) => {
946 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
950 wire::Message::AnnouncementSignatures(msg) => {
951 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
953 wire::Message::ChannelAnnouncement(msg) => {
954 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
956 Err(e) => { return Err(e.into()); },
960 // TODO: forward msg along to all our other peers!
963 wire::Message::NodeAnnouncement(msg) => {
964 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
966 Err(e) => { return Err(e.into()); },
970 // TODO: forward msg along to all our other peers!
973 wire::Message::ChannelUpdate(msg) => {
974 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
975 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
977 Err(e) => { return Err(e.into()); },
981 // TODO: forward msg along to all our other peers!
984 wire::Message::QueryShortChannelIds(msg) => {
985 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
987 wire::Message::ReplyShortChannelIdsEnd(msg) => {
988 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
990 wire::Message::QueryChannelRange(msg) => {
991 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
993 wire::Message::ReplyChannelRange(msg) => {
994 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
996 wire::Message::GossipTimestampFilter(_msg) => {
997 // TODO: handle message
1000 // Unknown messages:
1001 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1002 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1003 // Fail the channel if message is an even, unknown type as per BOLT #1.
1004 return Err(PeerHandleError{ no_connection_possible: true }.into());
1006 wire::Message::Unknown(msg_type) => {
1007 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1013 /// Checks for any events generated by our handlers and processes them. Includes sending most
1014 /// response messages as well as messages generated by calls to handler functions directly (eg
1015 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1016 pub fn process_events(&self) {
1018 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1019 // buffer by doing things like announcing channels on another node. We should be willing to
1020 // drop optional-ish messages when send buffers get full!
1022 let mut peers_lock = self.peers.lock().unwrap();
1023 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1024 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1025 let peers = &mut *peers_lock;
1026 for event in events_generated.drain(..) {
1027 macro_rules! get_peer_for_forwarding {
1028 ($node_id: expr) => {
1030 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1031 Some(descriptor) => descriptor.clone(),
1036 match peers.peers.get_mut(&descriptor) {
1038 if peer.their_features.is_none() {
1043 None => panic!("Inconsistent peers set state!"),
1049 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1050 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1051 log_pubkey!(node_id),
1052 log_bytes!(msg.temporary_channel_id));
1053 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1054 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1055 self.do_attempt_write_data(&mut descriptor, peer);
1057 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1058 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1059 log_pubkey!(node_id),
1060 log_bytes!(msg.temporary_channel_id));
1061 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1062 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1063 self.do_attempt_write_data(&mut descriptor, peer);
1065 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1066 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1067 log_pubkey!(node_id),
1068 log_bytes!(msg.temporary_channel_id),
1069 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1070 // TODO: If the peer is gone we should generate a DiscardFunding event
1071 // indicating to the wallet that they should just throw away this funding transaction
1072 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1073 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1074 self.do_attempt_write_data(&mut descriptor, peer);
1076 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1077 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1078 log_pubkey!(node_id),
1079 log_bytes!(msg.channel_id));
1080 // TODO: If the peer is gone we should generate a DiscardFunding event
1081 // indicating to the wallet that they should just throw away this funding transaction
1082 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1083 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1084 self.do_attempt_write_data(&mut descriptor, peer);
1086 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1087 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1088 log_pubkey!(node_id),
1089 log_bytes!(msg.channel_id));
1090 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1091 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1092 self.do_attempt_write_data(&mut descriptor, peer);
1094 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1095 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1096 log_pubkey!(node_id),
1097 log_bytes!(msg.channel_id));
1098 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1099 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1100 self.do_attempt_write_data(&mut descriptor, peer);
1102 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 } } => {
1103 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1104 log_pubkey!(node_id),
1105 update_add_htlcs.len(),
1106 update_fulfill_htlcs.len(),
1107 update_fail_htlcs.len(),
1108 log_bytes!(commitment_signed.channel_id));
1109 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1110 for msg in update_add_htlcs {
1111 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1113 for msg in update_fulfill_htlcs {
1114 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1116 for msg in update_fail_htlcs {
1117 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1119 for msg in update_fail_malformed_htlcs {
1120 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1122 if let &Some(ref msg) = update_fee {
1123 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1125 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1126 self.do_attempt_write_data(&mut descriptor, peer);
1128 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1129 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1130 log_pubkey!(node_id),
1131 log_bytes!(msg.channel_id));
1132 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1133 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1134 self.do_attempt_write_data(&mut descriptor, peer);
1136 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1137 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1138 log_pubkey!(node_id),
1139 log_bytes!(msg.channel_id));
1140 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1141 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1142 self.do_attempt_write_data(&mut descriptor, peer);
1144 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1145 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1146 log_pubkey!(node_id),
1147 log_bytes!(msg.channel_id));
1148 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1149 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1150 self.do_attempt_write_data(&mut descriptor, peer);
1152 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1153 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1154 log_pubkey!(node_id),
1155 log_bytes!(msg.channel_id));
1156 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1157 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1158 self.do_attempt_write_data(&mut descriptor, peer);
1160 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1161 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1162 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1163 let encoded_msg = encode_msg!(msg);
1164 let encoded_update_msg = encode_msg!(update_msg);
1166 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1167 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1168 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1171 match peer.their_node_id {
1173 Some(their_node_id) => {
1174 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1179 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1180 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1181 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1185 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1186 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1187 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1188 let encoded_msg = encode_msg!(msg);
1190 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1191 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1192 !peer.should_forward_node_announcement(msg.contents.node_id) {
1195 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1196 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1200 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1201 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1202 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1203 let encoded_msg = encode_msg!(msg);
1205 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1206 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1207 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1210 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1211 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1215 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1216 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1218 MessageSendEvent::HandleError { ref node_id, ref action } => {
1220 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1221 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1222 peers.peers_needing_send.remove(&descriptor);
1223 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1224 if let Some(ref msg) = *msg {
1225 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1226 log_pubkey!(node_id),
1228 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1229 // This isn't guaranteed to work, but if there is enough free
1230 // room in the send buffer, put the error message there...
1231 self.do_attempt_write_data(&mut descriptor, &mut peer);
1233 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1236 descriptor.disconnect_socket();
1237 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1240 msgs::ErrorAction::IgnoreError => {},
1241 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1242 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1243 log_pubkey!(node_id),
1245 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1246 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1247 self.do_attempt_write_data(&mut descriptor, peer);
1251 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1252 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1253 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1254 self.do_attempt_write_data(&mut descriptor, peer);
1256 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1257 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1258 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1259 self.do_attempt_write_data(&mut descriptor, peer);
1261 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1262 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1263 log_pubkey!(node_id),
1264 msg.short_channel_ids.len(),
1266 msg.number_of_blocks,
1268 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id);
1269 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1270 self.do_attempt_write_data(&mut descriptor, peer);
1275 for mut descriptor in peers.peers_needing_send.drain() {
1276 match peers.peers.get_mut(&descriptor) {
1277 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1278 None => panic!("Inconsistent peers set state!"),
1284 /// Indicates that the given socket descriptor's connection is now closed.
1286 /// This must only be called if the socket has been disconnected by the peer or your own
1287 /// decision to disconnect it and must NOT be called in any case where other parts of this
1288 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1291 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1292 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1293 self.disconnect_event_internal(descriptor, false);
1296 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1297 let mut peers = self.peers.lock().unwrap();
1298 peers.peers_needing_send.remove(descriptor);
1299 let peer_option = peers.peers.remove(descriptor);
1301 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1303 match peer.their_node_id {
1305 peers.node_id_to_descriptor.remove(&node_id);
1306 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1314 /// Disconnect a peer given its node id.
1316 /// Set no_connection_possible to true to prevent any further connection with this peer,
1317 /// force-closing any channels we have with it.
1319 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1320 /// so be careful about reentrancy issues.
1321 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1322 let mut peers_lock = self.peers.lock().unwrap();
1323 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1324 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1325 peers_lock.peers.remove(&descriptor);
1326 peers_lock.peers_needing_send.remove(&descriptor);
1327 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1328 descriptor.disconnect_socket();
1332 /// This function should be called roughly once every 30 seconds.
1333 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1335 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1336 pub fn timer_tick_occurred(&self) {
1337 let mut peers_lock = self.peers.lock().unwrap();
1339 let peers = &mut *peers_lock;
1340 let peers_needing_send = &mut peers.peers_needing_send;
1341 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1342 let peers = &mut peers.peers;
1343 let mut descriptors_needing_disconnect = Vec::new();
1345 peers.retain(|descriptor, peer| {
1346 if peer.awaiting_pong {
1347 peers_needing_send.remove(descriptor);
1348 descriptors_needing_disconnect.push(descriptor.clone());
1349 match peer.their_node_id {
1351 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1352 node_id_to_descriptor.remove(&node_id);
1353 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1356 // This can't actually happen as we should have hit
1357 // is_ready_for_encryption() previously on this same peer.
1364 if !peer.channel_encryptor.is_ready_for_encryption() {
1365 // The peer needs to complete its handshake before we can exchange messages
1369 let ping = msgs::Ping {
1373 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1375 let mut descriptor_clone = descriptor.clone();
1376 self.do_attempt_write_data(&mut descriptor_clone, peer);
1378 peer.awaiting_pong = true;
1382 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1383 descriptor.disconnect_socket();
1391 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1394 use util::test_utils;
1396 use bitcoin::secp256k1::Secp256k1;
1397 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1400 use std::sync::{Arc, Mutex};
1401 use core::sync::atomic::Ordering;
1404 struct FileDescriptor {
1406 outbound_data: Arc<Mutex<Vec<u8>>>,
1408 impl PartialEq for FileDescriptor {
1409 fn eq(&self, other: &Self) -> bool {
1413 impl Eq for FileDescriptor { }
1414 impl core::hash::Hash for FileDescriptor {
1415 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1416 self.fd.hash(hasher)
1420 impl SocketDescriptor for FileDescriptor {
1421 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1422 self.outbound_data.lock().unwrap().extend_from_slice(data);
1426 fn disconnect_socket(&mut self) {}
1429 struct PeerManagerCfg {
1430 chan_handler: test_utils::TestChannelMessageHandler,
1431 routing_handler: test_utils::TestRoutingMessageHandler,
1432 logger: test_utils::TestLogger,
1435 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1436 let mut cfgs = Vec::new();
1437 for _ in 0..peer_count {
1440 chan_handler: test_utils::TestChannelMessageHandler::new(),
1441 logger: test_utils::TestLogger::new(),
1442 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1450 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>> {
1451 let mut peers = Vec::new();
1452 for i in 0..peer_count {
1453 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1454 let ephemeral_bytes = [i as u8; 32];
1455 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1456 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1463 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) {
1464 let secp_ctx = Secp256k1::new();
1465 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1466 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1467 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1468 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1469 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1470 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1471 peer_a.process_events();
1472 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1473 peer_b.process_events();
1474 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1475 (fd_a.clone(), fd_b.clone())
1479 fn test_disconnect_peer() {
1480 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1481 // push a DisconnectPeer event to remove the node flagged by id
1482 let cfgs = create_peermgr_cfgs(2);
1483 let chan_handler = test_utils::TestChannelMessageHandler::new();
1484 let mut peers = create_network(2, &cfgs);
1485 establish_connection(&peers[0], &peers[1]);
1486 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1488 let secp_ctx = Secp256k1::new();
1489 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1491 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1493 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1495 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1496 peers[0].message_handler.chan_handler = &chan_handler;
1498 peers[0].process_events();
1499 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1503 fn test_timer_tick_occurred() {
1504 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1505 let cfgs = create_peermgr_cfgs(2);
1506 let peers = create_network(2, &cfgs);
1507 establish_connection(&peers[0], &peers[1]);
1508 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1510 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1511 peers[0].timer_tick_occurred();
1512 peers[0].process_events();
1513 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1515 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1516 peers[0].timer_tick_occurred();
1517 peers[0].process_events();
1518 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1522 fn test_do_attempt_write_data() {
1523 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1524 let cfgs = create_peermgr_cfgs(2);
1525 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1526 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1527 let peers = create_network(2, &cfgs);
1529 // By calling establish_connect, we trigger do_attempt_write_data between
1530 // the peers. Previously this function would mistakenly enter an infinite loop
1531 // when there were more channel messages available than could fit into a peer's
1532 // buffer. This issue would now be detected by this test (because we use custom
1533 // RoutingMessageHandlers that intentionally return more channel messages
1534 // than can fit into a peer's buffer).
1535 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1537 // Make each peer to read the messages that the other peer just wrote to them.
1538 peers[0].process_events();
1539 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1540 peers[1].process_events();
1541 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1543 // Check that each peer has received the expected number of channel updates and channel
1545 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1546 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1547 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1548 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);