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 pub 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 pub 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 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
146 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
147 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
148 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
149 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
151 impl Deref for ErroringMessageHandler {
152 type Target = ErroringMessageHandler;
153 fn deref(&self) -> &Self { self }
156 /// Provides references to trait impls which handle different types of messages.
157 pub struct MessageHandler<CM: Deref, RM: Deref> where
158 CM::Target: ChannelMessageHandler,
159 RM::Target: RoutingMessageHandler {
160 /// A message handler which handles messages specific to channels. Usually this is just a
161 /// ChannelManager object or a ErroringMessageHandler.
162 pub chan_handler: CM,
163 /// A message handler which handles messages updating our knowledge of the network channel
164 /// graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
165 pub route_handler: RM,
168 /// Provides an object which can be used to send data to and which uniquely identifies a connection
169 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
170 /// implement Hash to meet the PeerManager API.
172 /// For efficiency, Clone should be relatively cheap for this type.
174 /// You probably want to just extend an int and put a file descriptor in a struct and implement
175 /// send_data. Note that if you are using a higher-level net library that may call close() itself,
176 /// be careful to ensure you don't have races whereby you might register a new connection with an
177 /// fd which is the same as a previous one which has yet to be removed via
178 /// PeerManager::socket_disconnected().
179 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
180 /// Attempts to send some data from the given slice to the peer.
182 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
183 /// Note that in the disconnected case, socket_disconnected must still fire and further write
184 /// attempts may occur until that time.
186 /// If the returned size is smaller than data.len(), a write_available event must
187 /// trigger the next time more data can be written. Additionally, until the a send_data event
188 /// completes fully, no further read_events should trigger on the same peer!
190 /// If a read_event on this descriptor had previously returned true (indicating that read
191 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
192 /// indicating that read events on this descriptor should resume. A resume_read of false does
193 /// *not* imply that further read events should be paused.
194 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
195 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
196 /// more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
197 /// this descriptor. No socket_disconnected call should be generated as a result of this call,
198 /// though races may occur whereby disconnect_socket is called after a call to
199 /// socket_disconnected but prior to socket_disconnected returning.
200 fn disconnect_socket(&mut self);
203 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
204 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
207 pub struct PeerHandleError {
208 /// Used to indicate that we probably can't make any future connections to this peer, implying
209 /// we should go ahead and force-close any channels we have with it.
210 pub no_connection_possible: bool,
212 impl fmt::Debug for PeerHandleError {
213 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
214 formatter.write_str("Peer Sent Invalid Data")
217 impl fmt::Display for PeerHandleError {
218 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
219 formatter.write_str("Peer Sent Invalid Data")
222 impl error::Error for PeerHandleError {
223 fn description(&self) -> &str {
224 "Peer Sent Invalid Data"
228 enum InitSyncTracker{
230 ChannelsSyncing(u64),
231 NodesSyncing(PublicKey),
235 channel_encryptor: PeerChannelEncryptor,
236 their_node_id: Option<PublicKey>,
237 their_features: Option<InitFeatures>,
239 pending_outbound_buffer: LinkedList<Vec<u8>>,
240 pending_outbound_buffer_first_msg_offset: usize,
241 awaiting_write_event: bool,
243 pending_read_buffer: Vec<u8>,
244 pending_read_buffer_pos: usize,
245 pending_read_is_header: bool,
247 sync_status: InitSyncTracker,
253 /// Returns true if the channel announcements/updates for the given channel should be
254 /// forwarded to this peer.
255 /// If we are sending our routing table to this peer and we have not yet sent channel
256 /// announcements/updates for the given channel_id then we will send it when we get to that
257 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
258 /// sent the old versions, we should send the update, and so return true here.
259 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
260 match self.sync_status {
261 InitSyncTracker::NoSyncRequested => true,
262 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
263 InitSyncTracker::NodesSyncing(_) => true,
267 /// Similar to the above, but for node announcements indexed by node_id.
268 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
269 match self.sync_status {
270 InitSyncTracker::NoSyncRequested => true,
271 InitSyncTracker::ChannelsSyncing(_) => false,
272 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
277 struct PeerHolder<Descriptor: SocketDescriptor> {
278 peers: HashMap<Descriptor, Peer>,
279 /// Added to by do_read_event for cases where we pushed a message onto the send buffer but
280 /// didn't call do_attempt_write_data to avoid reentrancy. Cleared in process_events()
281 peers_needing_send: HashSet<Descriptor>,
282 /// Only add to this set when noise completes:
283 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
286 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
287 fn _check_usize_is_32_or_64() {
288 // See below, less than 32 bit pointers may be unsafe here!
289 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
292 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
293 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
294 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
295 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
296 /// issues such as overly long function definitions.
297 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>>;
299 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
300 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
301 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
302 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
303 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
304 /// helps with issues such as long function definitions.
305 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>;
307 /// A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
308 /// events into messages which it passes on to its MessageHandlers.
310 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
311 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
312 /// essentially you should default to using a SimpleRefPeerManager, and use a
313 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
314 /// you're using lightning-net-tokio.
315 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> where
316 CM::Target: ChannelMessageHandler,
317 RM::Target: RoutingMessageHandler,
319 message_handler: MessageHandler<CM, RM>,
320 peers: Mutex<PeerHolder<Descriptor>>,
321 our_node_secret: SecretKey,
322 ephemeral_key_midstate: Sha256Engine,
324 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
325 // bits we will never realistically count into high:
326 peer_counter_low: AtomicUsize,
327 peer_counter_high: AtomicUsize,
332 enum MessageHandlingError {
333 PeerHandleError(PeerHandleError),
334 LightningError(LightningError),
337 impl From<PeerHandleError> for MessageHandlingError {
338 fn from(error: PeerHandleError) -> Self {
339 MessageHandlingError::PeerHandleError(error)
343 impl From<LightningError> for MessageHandlingError {
344 fn from(error: LightningError) -> Self {
345 MessageHandlingError::LightningError(error)
349 macro_rules! encode_msg {
351 let mut buffer = VecWriter(Vec::new());
352 wire::write($msg, &mut buffer).unwrap();
357 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L> where
358 CM::Target: ChannelMessageHandler,
360 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
361 /// handler is used and network graph messages are ignored.
363 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
364 /// cryptographically secure random bytes.
366 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
367 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
368 Self::new(MessageHandler {
369 chan_handler: channel_message_handler,
370 route_handler: IgnoringMessageHandler{},
371 }, our_node_secret, ephemeral_random_data, logger)
375 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L> where
376 RM::Target: RoutingMessageHandler,
378 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
379 /// handler is used and messages related to channels will be ignored (or generate error
380 /// messages). Note that some other lightning implementations time-out connections after some
381 /// time if no channel is built with the peer.
383 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
384 /// cryptographically secure random bytes.
386 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
387 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
388 Self::new(MessageHandler {
389 chan_handler: ErroringMessageHandler::new(),
390 route_handler: routing_message_handler,
391 }, our_node_secret, ephemeral_random_data, logger)
395 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
396 /// PeerIds may repeat, but only after socket_disconnected() has been called.
397 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<Descriptor, CM, RM, L> where
398 CM::Target: ChannelMessageHandler,
399 RM::Target: RoutingMessageHandler,
401 /// Constructs a new PeerManager with the given message handlers and node_id secret key
402 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
403 /// cryptographically secure random bytes.
404 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
405 let mut ephemeral_key_midstate = Sha256::engine();
406 ephemeral_key_midstate.input(ephemeral_random_data);
410 peers: Mutex::new(PeerHolder {
411 peers: HashMap::new(),
412 peers_needing_send: HashSet::new(),
413 node_id_to_descriptor: HashMap::new()
416 ephemeral_key_midstate,
417 peer_counter_low: AtomicUsize::new(0),
418 peer_counter_high: AtomicUsize::new(0),
423 /// Get the list of node ids for peers which have completed the initial handshake.
425 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
426 /// new_outbound_connection, however entries will only appear once the initial handshake has
427 /// completed and we are sure the remote peer has the private key for the given node_id.
428 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
429 let peers = self.peers.lock().unwrap();
430 peers.peers.values().filter_map(|p| {
431 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
438 fn get_ephemeral_key(&self) -> SecretKey {
439 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
440 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
441 let high = if low == 0 {
442 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
444 self.peer_counter_high.load(Ordering::Acquire)
446 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
447 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
448 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
451 /// Indicates a new outbound connection has been established to a node with the given node_id.
452 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
453 /// descriptor but must disconnect the connection immediately.
455 /// Returns a small number of bytes to send to the remote node (currently always 50).
457 /// Panics if descriptor is duplicative with some other descriptor which has not yet had a
458 /// socket_disconnected().
459 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
460 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
461 let res = peer_encryptor.get_act_one().to_vec();
462 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
464 let mut peers = self.peers.lock().unwrap();
465 if peers.peers.insert(descriptor, Peer {
466 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,
504 their_features: None,
506 pending_outbound_buffer: LinkedList::new(),
507 pending_outbound_buffer_first_msg_offset: 0,
508 awaiting_write_event: false,
511 pending_read_buffer_pos: 0,
512 pending_read_is_header: false,
514 sync_status: InitSyncTracker::NoSyncRequested,
516 awaiting_pong: false,
518 panic!("PeerManager driver duplicated descriptors!");
523 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
524 macro_rules! encode_and_send_msg {
527 log_trace!(self.logger, "Encoding and sending sync update message of type {} to {}", $msg.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
528 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg)[..]));
532 const MSG_BUFF_SIZE: usize = 10;
533 while !peer.awaiting_write_event {
534 if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
535 match peer.sync_status {
536 InitSyncTracker::NoSyncRequested => {},
537 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
538 let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
539 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
540 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
541 encode_and_send_msg!(announce);
542 if let &Some(ref update_a) = update_a_option {
543 encode_and_send_msg!(update_a);
545 if let &Some(ref update_b) = update_b_option {
546 encode_and_send_msg!(update_b);
548 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
550 if all_messages.is_empty() || all_messages.len() != steps as usize {
551 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
554 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
555 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
556 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
557 for msg in all_messages.iter() {
558 encode_and_send_msg!(msg);
559 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
561 if all_messages.is_empty() || all_messages.len() != steps as usize {
562 peer.sync_status = InitSyncTracker::NoSyncRequested;
565 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
566 InitSyncTracker::NodesSyncing(key) => {
567 let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
568 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
569 for msg in all_messages.iter() {
570 encode_and_send_msg!(msg);
571 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
573 if all_messages.is_empty() || all_messages.len() != steps as usize {
574 peer.sync_status = InitSyncTracker::NoSyncRequested;
581 let next_buff = match peer.pending_outbound_buffer.front() {
586 let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
587 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
588 let data_sent = descriptor.send_data(pending, should_be_reading);
589 peer.pending_outbound_buffer_first_msg_offset += data_sent;
590 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
592 peer.pending_outbound_buffer_first_msg_offset = 0;
593 peer.pending_outbound_buffer.pop_front();
595 peer.awaiting_write_event = true;
600 /// Indicates that there is room to write data to the given socket descriptor.
602 /// May return an Err to indicate that the connection should be closed.
604 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
605 /// new_*\_connection) before returning. Thus, be very careful with reentrancy issues! The
606 /// invariants around calling write_buffer_space_avail in case a write did not fully complete
607 /// must still hold - be ready to call write_buffer_space_avail again if a write call generated
608 /// here isn't sufficient! Panics if the descriptor was not previously registered in a
609 /// new_\*_connection event.
610 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
611 let mut peers = self.peers.lock().unwrap();
612 match peers.peers.get_mut(descriptor) {
613 None => panic!("Descriptor for write_event is not already known to PeerManager"),
615 peer.awaiting_write_event = false;
616 self.do_attempt_write_data(descriptor, peer);
622 /// Indicates that data was read from the given socket descriptor.
624 /// May return an Err to indicate that the connection should be closed.
626 /// Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
627 /// Thus, however, you almost certainly want to call process_events() after any read_event to
628 /// generate send_data calls to handle responses.
630 /// If Ok(true) is returned, further read_events should not be triggered until a send_data call
631 /// on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
633 /// Panics if the descriptor was not previously registered in a new_*_connection event.
634 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
635 match self.do_read_event(peer_descriptor, data) {
638 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
644 /// Append a message to a peer's pending outbound/write buffer, and update the map of peers needing sends accordingly.
645 fn enqueue_message<M: Encode + Writeable>(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, descriptor: Descriptor, message: &M) {
646 let mut buffer = VecWriter(Vec::new());
647 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
648 let encoded_message = buffer.0;
650 log_trace!(self.logger, "Enqueueing message of type {} to {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
651 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
652 peers_needing_send.insert(descriptor);
655 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
657 let mut peers_lock = self.peers.lock().unwrap();
658 let peers = &mut *peers_lock;
659 let pause_read = match peers.peers.get_mut(peer_descriptor) {
660 None => panic!("Descriptor for read_event is not already known to PeerManager"),
662 assert!(peer.pending_read_buffer.len() > 0);
663 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
665 let mut read_pos = 0;
666 while read_pos < data.len() {
668 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
669 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]);
670 read_pos += data_to_copy;
671 peer.pending_read_buffer_pos += data_to_copy;
674 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
675 peer.pending_read_buffer_pos = 0;
677 macro_rules! try_potential_handleerror {
683 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
684 //TODO: Try to push msg
685 log_trace!(self.logger, "Got Err handling message, disconnecting peer because {}", e.err);
686 return Err(PeerHandleError{ no_connection_possible: false });
688 msgs::ErrorAction::IgnoreError => {
689 log_trace!(self.logger, "Got Err handling message, ignoring because {}", e.err);
692 msgs::ErrorAction::SendErrorMessage { msg } => {
693 log_trace!(self.logger, "Got Err handling message, sending Error message because {}", e.err);
694 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &msg);
703 macro_rules! insert_node_id {
705 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
706 hash_map::Entry::Occupied(_) => {
707 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
708 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
709 return Err(PeerHandleError{ no_connection_possible: false })
711 hash_map::Entry::Vacant(entry) => {
712 log_trace!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
713 entry.insert(peer_descriptor.clone())
719 let next_step = peer.channel_encryptor.get_noise_step();
721 NextNoiseStep::ActOne => {
722 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();
723 peer.pending_outbound_buffer.push_back(act_two);
724 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
726 NextNoiseStep::ActTwo => {
727 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
728 peer.pending_outbound_buffer.push_back(act_three.to_vec());
729 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
730 peer.pending_read_is_header = true;
732 peer.their_node_id = Some(their_node_id);
734 let features = InitFeatures::known();
735 let resp = msgs::Init { features };
736 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
738 NextNoiseStep::ActThree => {
739 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
740 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
741 peer.pending_read_is_header = true;
742 peer.their_node_id = Some(their_node_id);
744 let features = InitFeatures::known();
745 let resp = msgs::Init { features };
746 self.enqueue_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), &resp);
748 NextNoiseStep::NoiseComplete => {
749 if peer.pending_read_is_header {
750 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
751 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
752 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
753 if msg_len < 2 { // Need at least the message type tag
754 return Err(PeerHandleError{ no_connection_possible: false });
756 peer.pending_read_is_header = false;
758 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
759 assert!(msg_data.len() >= 2);
762 peer.pending_read_buffer = [0; 18].to_vec();
763 peer.pending_read_is_header = true;
765 let mut reader = ::std::io::Cursor::new(&msg_data[..]);
766 let message_result = wire::read(&mut reader);
767 let message = match message_result {
771 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
772 msgs::DecodeError::UnknownRequiredFeature => {
773 log_debug!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
776 msgs::DecodeError::InvalidValue => {
777 log_debug!(self.logger, "Got an invalid value while deserializing message");
778 return Err(PeerHandleError { no_connection_possible: false });
780 msgs::DecodeError::ShortRead => {
781 log_debug!(self.logger, "Deserialization failed due to shortness of message");
782 return Err(PeerHandleError { no_connection_possible: false });
784 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
785 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
790 if let Err(handling_error) = self.handle_message(&mut peers.peers_needing_send, peer, peer_descriptor.clone(), message){
791 match handling_error {
792 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
793 MessageHandlingError::LightningError(e) => {
794 try_potential_handleerror!(Err(e));
804 self.do_attempt_write_data(peer_descriptor, peer);
806 peer.pending_outbound_buffer.len() > 10 // pause_read
816 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
817 fn handle_message(&self, peers_needing_send: &mut HashSet<Descriptor>, peer: &mut Peer, peer_descriptor: Descriptor, message: wire::Message) -> Result<(), MessageHandlingError> {
818 log_trace!(self.logger, "Received message of type {} from {}", message.type_id(), log_pubkey!(peer.their_node_id.unwrap()));
820 // Need an Init as first message
821 if let wire::Message::Init(_) = message {
822 } else if peer.their_features.is_none() {
823 log_trace!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
824 return Err(PeerHandleError{ no_connection_possible: false }.into());
828 // Setup and Control messages:
829 wire::Message::Init(msg) => {
830 if msg.features.requires_unknown_bits() {
831 log_info!(self.logger, "Peer features required unknown version bits");
832 return Err(PeerHandleError{ no_connection_possible: true }.into());
834 if peer.their_features.is_some() {
835 return Err(PeerHandleError{ no_connection_possible: false }.into());
839 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): {}",
840 if msg.features.supports_data_loss_protect() { "supported" } else { "not supported"},
841 if msg.features.initial_routing_sync() { "requested" } else { "not requested" },
842 if msg.features.supports_upfront_shutdown_script() { "supported" } else { "not supported"},
843 if msg.features.supports_gossip_queries() { "supported" } else { "not supported" },
844 if msg.features.supports_static_remote_key() { "supported" } else { "not supported"},
845 if msg.features.supports_unknown_bits() { "present" } else { "none" }
848 if msg.features.initial_routing_sync() {
849 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
850 peers_needing_send.insert(peer_descriptor.clone());
852 if !msg.features.supports_static_remote_key() {
853 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
854 return Err(PeerHandleError{ no_connection_possible: true }.into());
857 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
859 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
860 peer.their_features = Some(msg.features);
862 wire::Message::Error(msg) => {
863 let mut data_is_printable = true;
864 for b in msg.data.bytes() {
865 if b < 32 || b > 126 {
866 data_is_printable = false;
871 if data_is_printable {
872 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
874 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
876 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
877 if msg.channel_id == [0; 32] {
878 return Err(PeerHandleError{ no_connection_possible: true }.into());
882 wire::Message::Ping(msg) => {
883 if msg.ponglen < 65532 {
884 let resp = msgs::Pong { byteslen: msg.ponglen };
885 self.enqueue_message(peers_needing_send, peer, peer_descriptor.clone(), &resp);
888 wire::Message::Pong(_msg) => {
889 peer.awaiting_pong = false;
893 wire::Message::OpenChannel(msg) => {
894 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
896 wire::Message::AcceptChannel(msg) => {
897 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
900 wire::Message::FundingCreated(msg) => {
901 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
903 wire::Message::FundingSigned(msg) => {
904 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
906 wire::Message::FundingLocked(msg) => {
907 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
910 wire::Message::Shutdown(msg) => {
911 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
913 wire::Message::ClosingSigned(msg) => {
914 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
917 // Commitment messages:
918 wire::Message::UpdateAddHTLC(msg) => {
919 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
921 wire::Message::UpdateFulfillHTLC(msg) => {
922 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
924 wire::Message::UpdateFailHTLC(msg) => {
925 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
927 wire::Message::UpdateFailMalformedHTLC(msg) => {
928 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
931 wire::Message::CommitmentSigned(msg) => {
932 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
934 wire::Message::RevokeAndACK(msg) => {
935 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
937 wire::Message::UpdateFee(msg) => {
938 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
940 wire::Message::ChannelReestablish(msg) => {
941 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
945 wire::Message::AnnouncementSignatures(msg) => {
946 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
948 wire::Message::ChannelAnnouncement(msg) => {
949 let should_forward = match self.message_handler.route_handler.handle_channel_announcement(&msg) {
951 Err(e) => { return Err(e.into()); },
955 // TODO: forward msg along to all our other peers!
958 wire::Message::NodeAnnouncement(msg) => {
959 let should_forward = match self.message_handler.route_handler.handle_node_announcement(&msg) {
961 Err(e) => { return Err(e.into()); },
965 // TODO: forward msg along to all our other peers!
968 wire::Message::ChannelUpdate(msg) => {
969 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
970 let should_forward = match self.message_handler.route_handler.handle_channel_update(&msg) {
972 Err(e) => { return Err(e.into()); },
976 // TODO: forward msg along to all our other peers!
979 wire::Message::QueryShortChannelIds(msg) => {
980 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
982 wire::Message::ReplyShortChannelIdsEnd(msg) => {
983 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
985 wire::Message::QueryChannelRange(msg) => {
986 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
988 wire::Message::ReplyChannelRange(msg) => {
989 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
991 wire::Message::GossipTimestampFilter(_msg) => {
992 // TODO: handle message
996 wire::Message::Unknown(msg_type) if msg_type.is_even() => {
997 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", msg_type);
998 // Fail the channel if message is an even, unknown type as per BOLT #1.
999 return Err(PeerHandleError{ no_connection_possible: true }.into());
1001 wire::Message::Unknown(msg_type) => {
1002 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", msg_type);
1008 /// Checks for any events generated by our handlers and processes them. Includes sending most
1009 /// response messages as well as messages generated by calls to handler functions directly (eg
1010 /// functions like ChannelManager::process_pending_htlc_forward or send_payment).
1011 pub fn process_events(&self) {
1013 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1014 // buffer by doing things like announcing channels on another node. We should be willing to
1015 // drop optional-ish messages when send buffers get full!
1017 let mut peers_lock = self.peers.lock().unwrap();
1018 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1019 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1020 let peers = &mut *peers_lock;
1021 for event in events_generated.drain(..) {
1022 macro_rules! get_peer_for_forwarding {
1023 ($node_id: expr, $handle_no_such_peer: block) => {
1025 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
1026 Some(descriptor) => descriptor.clone(),
1028 $handle_no_such_peer;
1032 match peers.peers.get_mut(&descriptor) {
1034 if peer.their_features.is_none() {
1035 $handle_no_such_peer;
1040 None => panic!("Inconsistent peers set state!"),
1046 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1047 log_trace!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1048 log_pubkey!(node_id),
1049 log_bytes!(msg.temporary_channel_id));
1050 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1051 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1053 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1054 self.do_attempt_write_data(&mut descriptor, peer);
1056 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1057 log_trace!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1058 log_pubkey!(node_id),
1059 log_bytes!(msg.temporary_channel_id));
1060 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1061 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
1063 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1064 self.do_attempt_write_data(&mut descriptor, peer);
1066 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1067 log_trace!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1068 log_pubkey!(node_id),
1069 log_bytes!(msg.temporary_channel_id),
1070 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1071 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1072 //TODO: generate a DiscardFunding event indicating to the wallet that
1073 //they should just throw away this funding transaction
1075 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1076 self.do_attempt_write_data(&mut descriptor, peer);
1078 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1079 log_trace!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1080 log_pubkey!(node_id),
1081 log_bytes!(msg.channel_id));
1082 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1083 //TODO: generate a DiscardFunding event indicating to the wallet that
1084 //they should just throw away this funding transaction
1086 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1087 self.do_attempt_write_data(&mut descriptor, peer);
1089 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1090 log_trace!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1091 log_pubkey!(node_id),
1092 log_bytes!(msg.channel_id));
1093 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1094 //TODO: Do whatever we're gonna do for handling dropped messages
1096 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1097 self.do_attempt_write_data(&mut descriptor, peer);
1099 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1100 log_trace!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1101 log_pubkey!(node_id),
1102 log_bytes!(msg.channel_id));
1103 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1104 //TODO: generate a DiscardFunding event indicating to the wallet that
1105 //they should just throw away this funding transaction
1107 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1108 self.do_attempt_write_data(&mut descriptor, peer);
1110 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 } } => {
1111 log_trace!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1112 log_pubkey!(node_id),
1113 update_add_htlcs.len(),
1114 update_fulfill_htlcs.len(),
1115 update_fail_htlcs.len(),
1116 log_bytes!(commitment_signed.channel_id));
1117 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1118 //TODO: Do whatever we're gonna do for handling dropped messages
1120 for msg in update_add_htlcs {
1121 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1123 for msg in update_fulfill_htlcs {
1124 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1126 for msg in update_fail_htlcs {
1127 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1129 for msg in update_fail_malformed_htlcs {
1130 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1132 if let &Some(ref msg) = update_fee {
1133 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1135 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed)));
1136 self.do_attempt_write_data(&mut descriptor, peer);
1138 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1139 log_trace!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1140 log_pubkey!(node_id),
1141 log_bytes!(msg.channel_id));
1142 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1143 //TODO: Do whatever we're gonna do for handling dropped messages
1145 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1146 self.do_attempt_write_data(&mut descriptor, peer);
1148 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1149 log_trace!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1150 log_pubkey!(node_id),
1151 log_bytes!(msg.channel_id));
1152 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1153 //TODO: Do whatever we're gonna do for handling dropped messages
1155 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1156 self.do_attempt_write_data(&mut descriptor, peer);
1158 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1159 log_trace!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1160 log_pubkey!(node_id),
1161 log_bytes!(msg.channel_id));
1162 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1163 //TODO: Do whatever we're gonna do for handling dropped messages
1165 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1166 self.do_attempt_write_data(&mut descriptor, peer);
1168 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1169 log_trace!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1170 log_pubkey!(node_id),
1171 log_bytes!(msg.channel_id));
1172 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1173 //TODO: Do whatever we're gonna do for handling dropped messages
1175 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1176 self.do_attempt_write_data(&mut descriptor, peer);
1178 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1179 log_trace!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1180 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
1181 let encoded_msg = encode_msg!(msg);
1182 let encoded_update_msg = encode_msg!(update_msg);
1184 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1185 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1186 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1189 match peer.their_node_id {
1191 Some(their_node_id) => {
1192 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1197 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1198 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
1199 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1203 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
1204 log_trace!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1205 if self.message_handler.route_handler.handle_node_announcement(msg).is_ok() {
1206 let encoded_msg = encode_msg!(msg);
1208 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1209 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1210 !peer.should_forward_node_announcement(msg.contents.node_id) {
1213 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1214 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1218 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1219 log_trace!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1220 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
1221 let encoded_msg = encode_msg!(msg);
1223 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
1224 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1225 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1228 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
1229 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1233 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1234 self.message_handler.route_handler.handle_htlc_fail_channel_update(update);
1236 MessageSendEvent::HandleError { ref node_id, ref action } => {
1238 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1239 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1240 peers.peers_needing_send.remove(&descriptor);
1241 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1242 if let Some(ref msg) = *msg {
1243 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1244 log_pubkey!(node_id),
1246 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1247 // This isn't guaranteed to work, but if there is enough free
1248 // room in the send buffer, put the error message there...
1249 self.do_attempt_write_data(&mut descriptor, &mut peer);
1251 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1254 descriptor.disconnect_socket();
1255 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1258 msgs::ErrorAction::IgnoreError => {},
1259 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1260 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1261 log_pubkey!(node_id),
1263 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
1264 //TODO: Do whatever we're gonna do for handling dropped messages
1266 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1267 self.do_attempt_write_data(&mut descriptor, peer);
1271 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1272 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1273 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1274 self.do_attempt_write_data(&mut descriptor, peer);
1276 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1277 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1278 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1279 self.do_attempt_write_data(&mut descriptor, peer);
1281 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1282 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1283 log_pubkey!(node_id),
1284 msg.short_channel_ids.len(),
1286 msg.number_of_blocks,
1288 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {});
1289 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1290 self.do_attempt_write_data(&mut descriptor, peer);
1295 for mut descriptor in peers.peers_needing_send.drain() {
1296 match peers.peers.get_mut(&descriptor) {
1297 Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
1298 None => panic!("Inconsistent peers set state!"),
1304 /// Indicates that the given socket descriptor's connection is now closed.
1306 /// This must only be called if the socket has been disconnected by the peer or your own
1307 /// decision to disconnect it and must NOT be called in any case where other parts of this
1308 /// library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
1311 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
1312 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1313 self.disconnect_event_internal(descriptor, false);
1316 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1317 let mut peers = self.peers.lock().unwrap();
1318 peers.peers_needing_send.remove(descriptor);
1319 let peer_option = peers.peers.remove(descriptor);
1321 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
1323 match peer.their_node_id {
1325 peers.node_id_to_descriptor.remove(&node_id);
1326 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1334 /// Disconnect a peer given its node id.
1336 /// Set no_connection_possible to true to prevent any further connection with this peer,
1337 /// force-closing any channels we have with it.
1339 /// If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
1340 /// so be careful about reentrancy issues.
1341 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1342 let mut peers_lock = self.peers.lock().unwrap();
1343 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1344 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1345 peers_lock.peers.remove(&descriptor);
1346 peers_lock.peers_needing_send.remove(&descriptor);
1347 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1348 descriptor.disconnect_socket();
1352 /// This function should be called roughly once every 30 seconds.
1353 /// It will send pings to each peer and disconnect those which did not respond to the last round of pings.
1355 /// Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
1356 pub fn timer_tick_occurred(&self) {
1357 let mut peers_lock = self.peers.lock().unwrap();
1359 let peers = &mut *peers_lock;
1360 let peers_needing_send = &mut peers.peers_needing_send;
1361 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1362 let peers = &mut peers.peers;
1363 let mut descriptors_needing_disconnect = Vec::new();
1365 peers.retain(|descriptor, peer| {
1366 if peer.awaiting_pong {
1367 peers_needing_send.remove(descriptor);
1368 descriptors_needing_disconnect.push(descriptor.clone());
1369 match peer.their_node_id {
1371 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1372 node_id_to_descriptor.remove(&node_id);
1373 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1376 // This can't actually happen as we should have hit
1377 // is_ready_for_encryption() previously on this same peer.
1384 if !peer.channel_encryptor.is_ready_for_encryption() {
1385 // The peer needs to complete its handshake before we can exchange messages
1389 let ping = msgs::Ping {
1393 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(&ping)));
1395 let mut descriptor_clone = descriptor.clone();
1396 self.do_attempt_write_data(&mut descriptor_clone, peer);
1398 peer.awaiting_pong = true;
1402 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1403 descriptor.disconnect_socket();
1411 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
1414 use util::test_utils;
1416 use bitcoin::secp256k1::Secp256k1;
1417 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1420 use std::sync::{Arc, Mutex};
1421 use std::sync::atomic::Ordering;
1424 struct FileDescriptor {
1426 outbound_data: Arc<Mutex<Vec<u8>>>,
1428 impl PartialEq for FileDescriptor {
1429 fn eq(&self, other: &Self) -> bool {
1433 impl Eq for FileDescriptor { }
1434 impl std::hash::Hash for FileDescriptor {
1435 fn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {
1436 self.fd.hash(hasher)
1440 impl SocketDescriptor for FileDescriptor {
1441 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1442 self.outbound_data.lock().unwrap().extend_from_slice(data);
1446 fn disconnect_socket(&mut self) {}
1449 struct PeerManagerCfg {
1450 chan_handler: test_utils::TestChannelMessageHandler,
1451 routing_handler: test_utils::TestRoutingMessageHandler,
1452 logger: test_utils::TestLogger,
1455 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1456 let mut cfgs = Vec::new();
1457 for _ in 0..peer_count {
1460 chan_handler: test_utils::TestChannelMessageHandler::new(),
1461 logger: test_utils::TestLogger::new(),
1462 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1470 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>> {
1471 let mut peers = Vec::new();
1472 for i in 0..peer_count {
1473 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1474 let ephemeral_bytes = [i as u8; 32];
1475 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1476 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger);
1483 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) {
1484 let secp_ctx = Secp256k1::new();
1485 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1486 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1487 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1488 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1489 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1490 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1491 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1492 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1493 (fd_a.clone(), fd_b.clone())
1497 fn test_disconnect_peer() {
1498 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1499 // push a DisconnectPeer event to remove the node flagged by id
1500 let cfgs = create_peermgr_cfgs(2);
1501 let chan_handler = test_utils::TestChannelMessageHandler::new();
1502 let mut peers = create_network(2, &cfgs);
1503 establish_connection(&peers[0], &peers[1]);
1504 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1506 let secp_ctx = Secp256k1::new();
1507 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1509 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1511 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1513 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1514 peers[0].message_handler.chan_handler = &chan_handler;
1516 peers[0].process_events();
1517 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1521 fn test_timer_tick_occurred() {
1522 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1523 let cfgs = create_peermgr_cfgs(2);
1524 let peers = create_network(2, &cfgs);
1525 establish_connection(&peers[0], &peers[1]);
1526 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1528 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1529 peers[0].timer_tick_occurred();
1530 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1532 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1533 peers[0].timer_tick_occurred();
1534 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1538 fn test_do_attempt_write_data() {
1539 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1540 let cfgs = create_peermgr_cfgs(2);
1541 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1542 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1543 let peers = create_network(2, &cfgs);
1545 // By calling establish_connect, we trigger do_attempt_write_data between
1546 // the peers. Previously this function would mistakenly enter an infinite loop
1547 // when there were more channel messages available than could fit into a peer's
1548 // buffer. This issue would now be detected by this test (because we use custom
1549 // RoutingMessageHandlers that intentionally return more channel messages
1550 // than can fit into a peer's buffer).
1551 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1553 // Make each peer to read the messages that the other peer just wrote to them.
1554 peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap();
1555 peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap();
1557 // Check that each peer has received the expected number of channel updates and channel
1559 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1560 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1561 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1562 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);