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> = PeerManager<SD, Arc<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 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
357 CM::Target: ChannelMessageHandler,
359 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
360 /// handler is used and network graph messages are ignored.
362 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
363 /// cryptographically secure random bytes.
365 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
366 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
367 Self::new(MessageHandler {
368 chan_handler: channel_message_handler,
369 route_handler: IgnoringMessageHandler{},
370 }, our_node_secret, ephemeral_random_data, logger)
374 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
375 RM::Target: RoutingMessageHandler,
377 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
378 /// handler is used and messages related to channels will be ignored (or generate error
379 /// messages). Note that some other lightning implementations time-out connections after some
380 /// time if no channel is built with the peer.
382 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
383 /// cryptographically secure random bytes.
385 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
386 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
387 Self::new(MessageHandler {
388 chan_handler: ErroringMessageHandler::new(),
389 route_handler: routing_message_handler,
390 }, our_node_secret, ephemeral_random_data, logger)
394 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
395 /// PeerIds may repeat, but only after socket_disconnected() has been called.
396 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
397 CM::Target: ChannelMessageHandler,
398 RM::Target: RoutingMessageHandler,
400 /// Constructs a new PeerManager with the given message handlers and node_id secret key
401 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
402 /// cryptographically secure random bytes.
403 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
404 let mut ephemeral_key_midstate = Sha256::engine();
405 ephemeral_key_midstate.input(ephemeral_random_data);
409 peers: Mutex::new(PeerHolder {
410 peers: HashMap::new(),
411 peers_needing_send: HashSet::new(),
412 node_id_to_descriptor: HashMap::new()
415 ephemeral_key_midstate,
416 peer_counter_low: AtomicUsize::new(0),
417 peer_counter_high: AtomicUsize::new(0),
422 /// Get the list of node ids for peers which have completed the initial handshake.
424 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
425 /// new_outbound_connection, however entries will only appear once the initial handshake has
426 /// completed and we are sure the remote peer has the private key for the given node_id.
427 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
428 let peers = self.peers.lock().unwrap();
429 peers.peers.values().filter_map(|p| {
430 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
437 fn get_ephemeral_key(&self) -> SecretKey {
438 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
439 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
440 let high = if low == 0 {
441 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
443 self.peer_counter_high.load(Ordering::Acquire)
445 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
446 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
447 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
450 /// Indicates a new outbound connection has been established to a node with the given node_id.
451 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
452 /// descriptor but must disconnect the connection immediately.
454 /// Returns a small number of bytes to send to the remote node (currently always 50).
456 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
457 /// socket_disconnected().
458 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
459 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
460 let res = peer_encryptor.get_act_one().to_vec();
461 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
463 let mut peers = self.peers.lock().unwrap();
464 if peers.peers.insert(descriptor, Peer {
465 channel_encryptor: peer_encryptor,
468 their_features: None,
470 pending_outbound_buffer: LinkedList::new(),
471 pending_outbound_buffer_first_msg_offset: 0,
472 awaiting_write_event: false,
475 pending_read_buffer_pos: 0,
476 pending_read_is_header: false,
478 sync_status: InitSyncTracker::NoSyncRequested,
480 awaiting_pong: false,
482 panic!("PeerManager driver duplicated descriptors!");
487 /// Indicates a new inbound connection has been established.
489 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
490 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
491 /// call socket_disconnected for the new descriptor but must disconnect the connection
494 /// Panics if descriptor is duplicative with some other descriptor which has not yet had
495 /// socket_disconnected called.
496 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
497 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
498 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
500 let mut peers = self.peers.lock().unwrap();
501 if peers.peers.insert(descriptor, Peer {
502 channel_encryptor: peer_encryptor,
505 their_features: None,
507 pending_outbound_buffer: LinkedList::new(),
508 pending_outbound_buffer_first_msg_offset: 0,
509 awaiting_write_event: false,
512 pending_read_buffer_pos: 0,
513 pending_read_is_header: false,
515 sync_status: InitSyncTracker::NoSyncRequested,
517 awaiting_pong: false,
519 panic!("PeerManager driver duplicated descriptors!");
524 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
525 macro_rules! encode_and_send_msg {
528 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
529 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
533 const MSG_BUFF_SIZE: usize = 10;
534 while !peer.awaiting_write_event {
535 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
536 match peer.sync_status {
537 InitSyncTracker::NoSyncRequested => {},
538 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
539 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
540 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
541 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
542 encode_and_send_msg!(announce);
543 if let &Some(ref update_a) = update_a_option {
544 encode_and_send_msg!(update_a);
546 if let &Some(ref update_b) = update_b_option {
547 encode_and_send_msg!(update_b);
549 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
551 if all_messages.is_empty() || all_messages.len() != steps as usize {
552 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
555 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
556 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
557 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
558 for msg in all_messages.iter() {
559 encode_and_send_msg!(msg);
560 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
562 if all_messages.is_empty() || all_messages.len() != steps as usize {
563 peer.sync_status = InitSyncTracker::NoSyncRequested;
566 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
567 InitSyncTracker::NodesSyncing(key) => {
568 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
569 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
570 for msg in all_messages.iter() {
571 encode_and_send_msg!(msg);
572 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
574 if all_messages.is_empty() || all_messages.len() != steps as usize {
575 peer.sync_status = InitSyncTracker::NoSyncRequested;
582 let next_buff = match peer.pending_outbound_buffer.front() {
587 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
588 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
589 let data_sent = descriptor.send_data(pending, should_be_reading);
590 peer.pending_outbound_buffer_first_msg_offset += data_sent;
591 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
593 peer.pending_outbound_buffer_first_msg_offset = 0;
594 peer.pending_outbound_buffer.pop_front();
596 peer.awaiting_write_event = true;
601 /// Indicates that there is room to write data to the given socket descriptor.
603 /// May return an Err to indicate that the connection should be closed.
605 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
606 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
607 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
608 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
609 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
610 /// new_\*_connection event.
611 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
612 let mut peers = self.peers.lock().unwrap();
613 match peers.peers.get_mut(descriptor) {
614 None => panic!("Descriptor for write_event is not already known to PeerManager"),
616 peer.awaiting_write_event = false;
617 self.do_attempt_write_data(descriptor, peer);
623 /// Indicates that data was read from the given socket descriptor.
625 /// May return an Err to indicate that the connection should be closed.
627 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
628 /// Thus, however, you almost certainly want to call process_events() after any read_event to
629 /// generate send_data calls to handle responses.
631 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
632 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
634 /// Panics if the descriptor was not previously registered in a new_*_connection event.
635 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
636 match self.do_read_event(peer_descriptor, data) {
639 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
645 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
646 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
647 let mut buffer = VecWriter(Vec::new());
648 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
649 let encoded_message = buffer.0;
651 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
652 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
653 peers_needing_send.insert(descriptor);
656 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
658 let mut peers_lock = self.peers.lock().unwrap();
659 let peers = &mut *peers_lock;
660 let pause_read = match peers.peers.get_mut(peer_descriptor) {
661 None => panic!("Descriptor for read_event is not already known to PeerManager"),
663 assert!(peer.pending_read_buffer.len() > 0);
664 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
666 let mut read_pos = 0;
667 while read_pos < data.len() {
669 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
670 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]);
671 read_pos += data_to_copy;
672 peer.pending_read_buffer_pos += data_to_copy;
675 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
676 peer.pending_read_buffer_pos = 0;
678 macro_rules! try_potential_handleerror {
684 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
685 //TODO: Try to push msg
686 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
687 return Err(PeerHandleError{ no_connection_possible: false });
689 msgs::ErrorAction::IgnoreError => {
690 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
693 msgs::ErrorAction::SendErrorMessage { msg } => {
694 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
695 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
704 macro_rules! insert_node_id {
706 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
707 hash_map::Entry::Occupied(_) => {
708 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
709 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
710 return Err(PeerHandleError{ no_connection_possible: false })
712 hash_map::Entry::Vacant(entry) => {
713 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
714 entry.insert(peer_descriptor.clone())
720 let next_step = peer.channel_encryptor.get_noise_step();
722 NextNoiseStep::ActOne => {
723 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();
724 peer.pending_outbound_buffer.push_back(act_two);
725 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
727 NextNoiseStep::ActTwo => {
728 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
729 peer.pending_outbound_buffer.push_back(act_three.to_vec());
730 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
731 peer.pending_read_is_header = true;
733 peer.their_node_id = Some(their_node_id);
735 let features = InitFeatures::known();
736 let resp = msgs::Init { features };
737 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
739 NextNoiseStep::ActThree => {
740 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
741 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
742 peer.pending_read_is_header = true;
743 peer.their_node_id = Some(their_node_id);
746 NextNoiseStep::NoiseComplete => {
747 if peer.pending_read_is_header {
748 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
749 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
750 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
751 if msg_len < 2 { // Need at least the message type tag
752 return Err(PeerHandleError{ no_connection_possible: false });
754 peer.pending_read_is_header = false;
756 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
757 assert!(msg_data.len() >= 2);
760 peer.pending_read_buffer = [0; 18].to_vec();
761 peer.pending_read_is_header = true;
763 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
764 let message_result = wire::read(&mut reader);
765 let message = match message_result {
769 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
770 msgs::DecodeError::UnknownRequiredFeature => {
771 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
774 msgs::DecodeError::InvalidValue => {
775 log_debug!(self.logger, "Got an invalid value while deserializing message");
776 return Err(PeerHandleError { no_connection_possible: false });
778 msgs::DecodeError::ShortRead => {
779 log_debug!(self.logger, "Deserialization failed due to shortness of message");
780 return Err(PeerHandleError { no_connection_possible: false });
782 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
783 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
788 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
789 match handling_error {
790 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
791 MessageHandlingError::LightningError(e) => {
792 try_potential_handleerror!(Err(e));
802 self.do_attempt_write_data(peer_descriptor, peer);
804 peer.pending_outbound_buffer.len() > 10 // pause_read
814 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
815 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
816 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
818 // Need an Init as first message
819 if let wire::Message::Init(_) = message {
820 } else if peer.their_features.is_none() {
821 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
822 return Err(PeerHandleError{ no_connection_possible: false }.into());
826 // Setup and Control messages:
827 wire::Message::Init(msg) => {
828 if msg.features.requires_unknown_bits() {
829 log_info!(self.logger, "Peer features required unknown version bits");
830 return Err(PeerHandleError{ no_connection_possible: true }.into());
832 if peer.their_features.is_some() {
833 return Err(PeerHandleError{ no_connection_possible: false }.into());
837 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): {}",
838 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
839 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
840 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
841 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
842 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
843 if msg.features.supports_unknown_bits() { "present" } else { "none" }
846 if msg.features.initial_routing_sync() {
847 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
848 peers_needing_send.insert(peer_descriptor.clone());
850 if !msg.features.supports_static_remote_key() {
851 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
852 return Err(PeerHandleError{ no_connection_possible: true }.into());
856 let features = InitFeatures::known();
857 let resp = msgs::Init { features };
858 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
861 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
863 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
864 peer.their_features = Some(msg.features);
866 wire::Message::Error(msg) => {
867 let mut data_is_printable = true;
868 for b in msg.data.bytes() {
869 if b < 32 || b > 126 {
870 data_is_printable = false;
875 if data_is_printable {
876 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
878 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
880 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
881 if msg.channel_id == [0; 32] {
882 return Err(PeerHandleError{ no_connection_possible: true }.into());
886 wire::Message::Ping(msg) => {
887 if msg.ponglen < 65532 {
888 let resp = msgs::Pong { byteslen: msg.ponglen };
889 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
892 wire::Message::Pong(_msg) => {
893 peer.awaiting_pong = false;
897 wire::Message::OpenChannel(msg) => {
898 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
900 wire::Message::AcceptChannel(msg) => {
901 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
904 wire::Message::FundingCreated(msg) => {
905 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
907 wire::Message::FundingSigned(msg) => {
908 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
910 wire::Message::FundingLocked(msg) => {
911 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
914 wire::Message::Shutdown(msg) => {
915 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
917 wire::Message::ClosingSigned(msg) => {
918 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
921 // Commitment messages:
922 wire::Message::UpdateAddHTLC(msg) => {
923 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
925 wire::Message::UpdateFulfillHTLC(msg) => {
926 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
928 wire::Message::UpdateFailHTLC(msg) => {
929 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
931 wire::Message::UpdateFailMalformedHTLC(msg) => {
932 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
935 wire::Message::CommitmentSigned(msg) => {
936 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
938 wire::Message::RevokeAndACK(msg) => {
939 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
941 wire::Message::UpdateFee(msg) => {
942 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
944 wire::Message::ChannelReestablish(msg) => {
945 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
949 wire::Message::AnnouncementSignatures(msg) => {
950 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
952 wire::Message::ChannelAnnouncement(msg) => {
953 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
955 Err(e) => { return Err(e.into()); },
959 // TODO: forward msg along to all our other peers!
962 wire::Message::NodeAnnouncement(msg) => {
963 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
965 Err(e) => { return Err(e.into()); },
969 // TODO: forward msg along to all our other peers!
972 wire::Message::ChannelUpdate(msg) => {
973 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
975 Err(e) => { return Err(e.into()); },
979 // TODO: forward msg along to all our other peers!
982 wire::Message::QueryShortChannelIds(msg) => {
983 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
985 wire::Message::ReplyShortChannelIdsEnd(msg) => {
986 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
988 wire::Message::QueryChannelRange(msg) => {
989 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
991 wire::Message::ReplyChannelRange(msg) => {
992 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
994 wire::Message::GossipTimestampFilter(_msg) => {
995 // TODO: handle message
999 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
1000 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
1001 // Fail the channel if message is an even, unknown type as per BOLT #1.
1002 return Err(PeerHandleError{ no_connection_possible: true }.into());
1004 wire::Message::Unknown(msg_type) => {
1005 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1011 /// Checks for any events generated by our handlers and processes them. Includes sending most
1012 /// response messages as well as messages generated by calls to handler functions directly (eg
1013 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1014 pub fn process_events(&self) {
1016 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1017 // buffer by doing things like announcing channels on another node. We should be willing to
1018 // drop optional-ish messages when send buffers get full!
1020 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1021 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1022 let mut peers_lock = self.peers.lock().unwrap();
1023 let peers = &mut *peers_lock;
1024 for event in events_generated.drain(..) {
1025 macro_rules! get_peer_for_forwarding {
1026 ($node_id: expr, $handle_no_such_peer: block) => {
1028 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1029 Some(descriptor) => descriptor.clone(),
1031 $handle_no_such_peer;
1035 match peers.peers.get_mut(&descriptor) {
1037 if peer.their_features.is_none() {
1038 $handle_no_such_peer;
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 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1056 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1057 self.do_attempt_write_data(&mut descriptor, peer);
1059 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1060 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1061 log_pubkey!(node_id),
1062 log_bytes!(msg.temporary_channel_id));
1063 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1064 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1066 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1067 self.do_attempt_write_data(&mut descriptor, peer);
1069 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1070 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1071 log_pubkey!(node_id),
1072 log_bytes!(msg.temporary_channel_id),
1073 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1074 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1075 //TODO: generate a DiscardFunding event indicating to the wallet that
1076 //they should just throw away this funding transaction
1078 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1079 self.do_attempt_write_data(&mut descriptor, peer);
1081 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1082 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1083 log_pubkey!(node_id),
1084 log_bytes!(msg.channel_id));
1085 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1086 //TODO: generate a DiscardFunding event indicating to the wallet that
1087 //they should just throw away this funding transaction
1089 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1090 self.do_attempt_write_data(&mut descriptor, peer);
1092 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1093 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1094 log_pubkey!(node_id),
1095 log_bytes!(msg.channel_id));
1096 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1097 //TODO: Do whatever we're gonna do for handling dropped messages
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::SendAnnouncementSignatures { ref node_id, ref msg } => {
1103 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1104 log_pubkey!(node_id),
1105 log_bytes!(msg.channel_id));
1106 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1107 //TODO: generate a DiscardFunding event indicating to the wallet that
1108 //they should just throw away this funding transaction
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::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 } } => {
1114 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1115 log_pubkey!(node_id),
1116 update_add_htlcs.len(),
1117 update_fulfill_htlcs.len(),
1118 update_fail_htlcs.len(),
1119 log_bytes!(commitment_signed.channel_id));
1120 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1121 //TODO: Do whatever we're gonna do for handling dropped messages
1123 for msg in update_add_htlcs {
1124 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1126 for msg in update_fulfill_htlcs {
1127 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1129 for msg in update_fail_htlcs {
1130 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1132 for msg in update_fail_malformed_htlcs {
1133 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1135 if let &Some(ref msg) = update_fee {
1136 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1138 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1139 self.do_attempt_write_data(&mut descriptor, peer);
1141 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1142 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1143 log_pubkey!(node_id),
1144 log_bytes!(msg.channel_id));
1145 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1146 //TODO: Do whatever we're gonna do for handling dropped messages
1148 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1149 self.do_attempt_write_data(&mut descriptor, peer);
1151 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1152 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1153 log_pubkey!(node_id),
1154 log_bytes!(msg.channel_id));
1155 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1156 //TODO: Do whatever we're gonna do for handling dropped messages
1158 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1159 self.do_attempt_write_data(&mut descriptor, peer);
1161 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1162 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1163 log_pubkey!(node_id),
1164 log_bytes!(msg.channel_id));
1165 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1166 //TODO: Do whatever we're gonna do for handling dropped messages
1168 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1169 self.do_attempt_write_data(&mut descriptor, peer);
1171 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1172 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1173 log_pubkey!(node_id),
1174 log_bytes!(msg.channel_id));
1175 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1176 //TODO: Do whatever we're gonna do for handling dropped messages
1178 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1179 self.do_attempt_write_data(&mut descriptor, peer);
1181 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1182 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1183 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1184 let encoded_msg = encode_msg!(msg);
1185 let encoded_update_msg = encode_msg!(update_msg);
1187 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1188 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1189 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1192 match peer.their_node_id {
1194 Some(their_node_id) => {
1195 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1200 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1201 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1202 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1206 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1207 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1208 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1209 let encoded_msg = encode_msg!(msg);
1211 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1212 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1213 !peer.should_forward_node_announcement(msg.contents.node_id) {
1216 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1217 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1221 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1222 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1223 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1224 let encoded_msg = encode_msg!(msg);
1226 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1227 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1228 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1231 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1232 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1236 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1237 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1239 MessageSendEvent::HandleError { ref node_id, ref action } => {
1241 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1242 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1243 peers.peers_needing_send.remove(&descriptor);
1244 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1245 if let Some(ref msg) = *msg {
1246 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1247 log_pubkey!(node_id),
1249 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1250 // This isn't guaranteed to work, but if there is enough free
1251 // room in the send buffer, put the error message there...
1252 self.do_attempt_write_data(&mut descriptor, &mut peer);
1254 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1257 descriptor.disconnect_socket();
1258 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1261 msgs::ErrorAction::IgnoreError => {},
1262 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1263 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1264 log_pubkey!(node_id),
1266 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1267 //TODO: Do whatever we're gonna do for handling dropped messages
1269 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1270 self.do_attempt_write_data(&mut descriptor, peer);
1274 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1275 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1276 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1277 self.do_attempt_write_data(&mut descriptor, peer);
1279 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1280 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1281 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1282 self.do_attempt_write_data(&mut descriptor, peer);
1287 for mut descriptor in peers.peers_needing_send.drain() {
1288 match peers.peers.get_mut(&descriptor) {
1289 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1290 None => panic!("Inconsistent peers set state!"),
1296 /// Indicates that the given socket descriptor's connection is now closed.
1298 /// This must only be called if the socket has been disconnected by the peer or your own
1299 /// decision to disconnect it and must NOT be called in any case where other parts of this
1300 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1303 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1304 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1305 self.disconnect_event_internal(descriptor, false);
1308 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1309 let mut peers = self.peers.lock().unwrap();
1310 peers.peers_needing_send.remove(descriptor);
1311 let peer_option = peers.peers.remove(descriptor);
1313 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1315 match peer.their_node_id {
1317 peers.node_id_to_descriptor.remove(&node_id);
1318 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1326 /// Disconnect a peer given its node id.
1328 /// Set no_connection_possible to true to prevent any further connection with this peer,
1329 /// force-closing any channels we have with it.
1331 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1332 /// so be careful about reentrancy issues.
1333 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1334 let mut peers_lock = self.peers.lock().unwrap();
1335 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1336 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1337 peers_lock.peers.remove(&descriptor);
1338 peers_lock.peers_needing_send.remove(&descriptor);
1339 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1340 descriptor.disconnect_socket();
1344 /// This function should be called roughly once every 30 seconds.
1345 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1347 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1348 pub fn timer_tick_occured(&self) {
1349 let mut peers_lock = self.peers.lock().unwrap();
1351 let peers = &mut *peers_lock;
1352 let peers_needing_send = &mut peers.peers_needing_send;
1353 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1354 let peers = &mut peers.peers;
1355 let mut descriptors_needing_disconnect = Vec::new();
1357 peers.retain(|descriptor, peer| {
1358 if peer.awaiting_pong {
1359 peers_needing_send.remove(descriptor);
1360 descriptors_needing_disconnect.push(descriptor.clone());
1361 match peer.their_node_id {
1363 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1364 node_id_to_descriptor.remove(&node_id);
1365 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1368 // This can't actually happen as we should have hit
1369 // is_ready_for_encryption() previously on this same peer.
1376 if !peer.channel_encryptor.is_ready_for_encryption() {
1377 // The peer needs to complete its handshake before we can exchange messages
1381 let ping = msgs::Ping {
1385 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1387 let mut descriptor_clone = descriptor.clone();
1388 self.do_attempt_write_data(&mut descriptor_clone, peer);
1390 peer.awaiting_pong = true;
1394 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1395 descriptor.disconnect_socket();
1403 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1406 use util::test_utils;
1408 use bitcoin::secp256k1::Secp256k1;
1409 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1412 use std::sync::{Arc, Mutex};
1413 use std::sync::atomic::Ordering;
1416 struct FileDescriptor {
1418 outbound_data: Arc<Mutex<Vec<u8>>>,
1420 impl PartialEq for FileDescriptor {
1421 fn eq(&self, other: &Self) -> bool {
1425 impl Eq for FileDescriptor { }
1426 impl std::hash::Hash for FileDescriptor {
1427 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1428 self.fd.hash(hasher)
1432 impl SocketDescriptor for FileDescriptor {
1433 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1434 self.outbound_data.lock().unwrap().extend_from_slice(data);
1438 fn disconnect_socket(&mut self) {}
1441 struct PeerManagerCfg {
1442 chan_handler: test_utils::TestChannelMessageHandler,
1443 routing_handler: test_utils::TestRoutingMessageHandler,
1444 logger: test_utils::TestLogger,
1447 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1448 let mut cfgs = Vec::new();
1449 for _ in 0..peer_count {
1452 chan_handler: test_utils::TestChannelMessageHandler::new(),
1453 logger: test_utils::TestLogger::new(),
1454 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1462 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>> {
1463 let mut peers = Vec::new();
1464 for i in 0..peer_count {
1465 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1466 let ephemeral_bytes = [i as u8; 32];
1467 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1468 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1475 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) {
1476 let secp_ctx = Secp256k1::new();
1477 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1478 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1479 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1480 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1481 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1482 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1483 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1484 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1485 (fd_a.clone(), fd_b.clone())
1489 fn test_disconnect_peer() {
1490 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1491 // push a DisconnectPeer event to remove the node flagged by id
1492 let cfgs = create_peermgr_cfgs(2);
1493 let chan_handler = test_utils::TestChannelMessageHandler::new();
1494 let mut peers = create_network(2, &cfgs);
1495 establish_connection(&peers[0], &peers[1]);
1496 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1498 let secp_ctx = Secp256k1::new();
1499 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1501 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1503 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1505 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1506 peers[0].message_handler.chan_handler = &chan_handler;
1508 peers[0].process_events();
1509 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1513 fn test_timer_tick_occurred() {
1514 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1515 let cfgs = create_peermgr_cfgs(2);
1516 let peers = create_network(2, &cfgs);
1517 establish_connection(&peers[0], &peers[1]);
1518 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1520 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1521 peers[0].timer_tick_occured();
1522 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1524 // Since timer_tick_occured() is called again when awaiting_pong is true, all Peers are disconnected
1525 peers[0].timer_tick_occured();
1526 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1530 fn test_do_attempt_write_data() {
1531 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1532 let cfgs = create_peermgr_cfgs(2);
1533 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1534 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1535 let peers = create_network(2, &cfgs);
1537 // By calling establish_connect, we trigger do_attempt_write_data between
1538 // the peers. Previously this function would mistakenly enter an infinite loop
1539 // when there were more channel messages available than could fit into a peer's
1540 // buffer. This issue would now be detected by this test (because we use custom
1541 // RoutingMessageHandlers that intentionally return more channel messages
1542 // than can fit into a peer's buffer).
1543 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1545 // Make each peer to read the messages that the other peer just wrote to them.
1546 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1547 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1549 // Check that each peer has received the expected number of channel updates and channel
1551 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1552 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1553 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1554 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);