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, Writer};
25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
28 use util::events::{MessageSendEvent, MessageSendEventsProvider};
29 use util::logger::Logger;
30 use routing::network_graph::NetGraphMsgHandler;
34 use alloc::collections::LinkedList;
35 use sync::{Arc, Mutex};
36 use core::sync::atomic::{AtomicUsize, Ordering};
37 use core::{cmp, hash, fmt, mem};
39 use core::convert::Infallible;
40 #[cfg(feature = "std")] use std::error;
42 use bitcoin::hashes::sha256::Hash as Sha256;
43 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
44 use bitcoin::hashes::{HashEngine, Hash};
46 /// Handler for BOLT1-compliant messages.
47 pub trait CustomMessageHandler: wire::CustomMessageReader {
48 /// Called with the message type that was received and the buffer to be read.
49 /// Can return a `MessageHandlingError` if the message could not be handled.
50 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
52 /// Gets the list of pending messages which were generated by the custom message
53 /// handler, clearing the list in the process. The first tuple element must
54 /// correspond to the intended recipients node ids. If no connection to one of the
55 /// specified node does not exist, the message is simply not sent to it.
56 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
59 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
60 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
61 pub struct IgnoringMessageHandler{}
62 impl MessageSendEventsProvider for IgnoringMessageHandler {
63 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
65 impl RoutingMessageHandler for IgnoringMessageHandler {
66 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
67 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
68 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
69 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
70 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
71 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
72 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
73 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
74 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
75 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
76 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
78 impl Deref for IgnoringMessageHandler {
79 type Target = IgnoringMessageHandler;
80 fn deref(&self) -> &Self { self }
83 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
84 // method that takes self for it.
85 impl wire::Type for Infallible {
86 fn type_id(&self) -> u16 {
90 impl Writeable for Infallible {
91 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
96 impl wire::CustomMessageReader for IgnoringMessageHandler {
97 type CustomMessage = Infallible;
98 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
103 impl CustomMessageHandler for IgnoringMessageHandler {
104 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
105 // Since we always return `None` in the read the handle method should never be called.
109 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
112 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
113 /// You can provide one of these as the route_handler in a MessageHandler.
114 pub struct ErroringMessageHandler {
115 message_queue: Mutex<Vec<MessageSendEvent>>
117 impl ErroringMessageHandler {
118 /// Constructs a new ErroringMessageHandler
119 pub fn new() -> Self {
120 Self { message_queue: Mutex::new(Vec::new()) }
122 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
123 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
124 action: msgs::ErrorAction::SendErrorMessage {
125 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
127 node_id: node_id.clone(),
131 impl MessageSendEventsProvider for ErroringMessageHandler {
132 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
133 let mut res = Vec::new();
134 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
138 impl ChannelMessageHandler for ErroringMessageHandler {
139 // Any messages which are related to a specific channel generate an error message to let the
140 // peer know we don't care about channels.
141 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
142 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
144 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
145 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
147 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
148 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
150 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
151 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
153 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
154 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
156 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
157 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
159 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
160 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
162 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
163 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
165 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
166 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
168 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
169 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
171 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
172 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
174 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
175 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
177 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
178 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
180 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
181 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
183 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
184 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
186 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
187 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
189 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
190 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
191 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
192 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
193 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
195 impl Deref for ErroringMessageHandler {
196 type Target = ErroringMessageHandler;
197 fn deref(&self) -> &Self { self }
200 /// Provides references to trait impls which handle different types of messages.
201 pub struct MessageHandler<CM: Deref, RM: Deref> where
202 CM::Target: ChannelMessageHandler,
203 RM::Target: RoutingMessageHandler {
204 /// A message handler which handles messages specific to channels. Usually this is just a
205 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
207 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
208 pub chan_handler: CM,
209 /// A message handler which handles messages updating our knowledge of the network channel
210 /// graph. Usually this is just a [`NetGraphMsgHandler`] object or an
211 /// [`IgnoringMessageHandler`].
213 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
214 pub route_handler: RM,
217 /// Provides an object which can be used to send data to and which uniquely identifies a connection
218 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
219 /// implement Hash to meet the PeerManager API.
221 /// For efficiency, Clone should be relatively cheap for this type.
223 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
224 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
225 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
226 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
227 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
228 /// to simply use another value which is guaranteed to be globally unique instead.
229 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
230 /// Attempts to send some data from the given slice to the peer.
232 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
233 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
234 /// called and further write attempts may occur until that time.
236 /// If the returned size is smaller than `data.len()`, a
237 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
238 /// written. Additionally, until a `send_data` event completes fully, no further
239 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
240 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
243 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
244 /// (indicating that read events should be paused to prevent DoS in the send buffer),
245 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
246 /// `resume_read` of false carries no meaning, and should not cause any action.
247 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
248 /// Disconnect the socket pointed to by this SocketDescriptor.
250 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
251 /// call (doing so is a noop).
252 fn disconnect_socket(&mut self);
255 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
256 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
259 pub struct PeerHandleError {
260 /// Used to indicate that we probably can't make any future connections to this peer, implying
261 /// we should go ahead and force-close any channels we have with it.
262 pub no_connection_possible: bool,
264 impl fmt::Debug for PeerHandleError {
265 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
266 formatter.write_str("Peer Sent Invalid Data")
269 impl fmt::Display for PeerHandleError {
270 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
271 formatter.write_str("Peer Sent Invalid Data")
275 #[cfg(feature = "std")]
276 impl error::Error for PeerHandleError {
277 fn description(&self) -> &str {
278 "Peer Sent Invalid Data"
282 enum InitSyncTracker{
284 ChannelsSyncing(u64),
285 NodesSyncing(PublicKey),
288 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
289 /// forwarding gossip messages to peers altogether.
290 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
292 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
293 /// we have fewer than this many messages in the outbound buffer again.
294 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
295 /// refilled as we send bytes.
296 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
297 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
299 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
301 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
302 /// the socket receive buffer before receiving the ping.
304 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
305 /// including any network delays, outbound traffic, or the same for messages from other peers.
307 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
308 /// per connected peer to respond to a ping, as long as they send us at least one message during
309 /// each tick, ensuring we aren't actually just disconnected.
310 /// With a timer tick interval of five seconds, this translates to about 30 seconds per connected
313 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
314 /// two connected peers, assuming most LDK-running systems have at least two cores.
315 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 6;
317 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
318 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
319 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
320 /// process before the next ping.
321 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
324 channel_encryptor: PeerChannelEncryptor,
325 their_node_id: Option<PublicKey>,
326 their_features: Option<InitFeatures>,
328 pending_outbound_buffer: LinkedList<Vec<u8>>,
329 pending_outbound_buffer_first_msg_offset: usize,
330 awaiting_write_event: bool,
332 pending_read_buffer: Vec<u8>,
333 pending_read_buffer_pos: usize,
334 pending_read_is_header: bool,
336 sync_status: InitSyncTracker,
338 msgs_sent_since_pong: usize,
339 awaiting_pong_timer_tick_intervals: i8,
340 received_message_since_timer_tick: bool,
344 /// Returns true if the channel announcements/updates for the given channel should be
345 /// forwarded to this peer.
346 /// If we are sending our routing table to this peer and we have not yet sent channel
347 /// announcements/updates for the given channel_id then we will send it when we get to that
348 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
349 /// sent the old versions, we should send the update, and so return true here.
350 fn should_forward_channel_announcement(&self, channel_id: u64)->bool{
351 match self.sync_status {
352 InitSyncTracker::NoSyncRequested => true,
353 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
354 InitSyncTracker::NodesSyncing(_) => true,
358 /// Similar to the above, but for node announcements indexed by node_id.
359 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
360 match self.sync_status {
361 InitSyncTracker::NoSyncRequested => true,
362 InitSyncTracker::ChannelsSyncing(_) => false,
363 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
368 struct PeerHolder<Descriptor: SocketDescriptor> {
369 peers: HashMap<Descriptor, Peer>,
370 /// Only add to this set when noise completes:
371 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
374 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
375 fn _check_usize_is_32_or_64() {
376 // See below, less than 32 bit pointers may be unsafe here!
377 unsafe { mem::transmute::<*const usize, [u8; 4]>(panic!()); }
380 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
381 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
382 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
383 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
384 /// issues such as overly long function definitions.
385 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>, Arc<IgnoringMessageHandler>>;
387 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
388 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
389 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
390 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
391 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
392 /// helps with issues such as long function definitions.
393 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, IgnoringMessageHandler>;
395 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
396 /// socket events into messages which it passes on to its [`MessageHandler`].
398 /// Locks are taken internally, so you must never assume that reentrancy from a
399 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
401 /// Calls to [`read_event`] will decode relevant messages and pass them to the
402 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
403 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
404 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
405 /// calls only after previous ones have returned.
407 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
408 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
409 /// essentially you should default to using a SimpleRefPeerManager, and use a
410 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
411 /// you're using lightning-net-tokio.
413 /// [`read_event`]: PeerManager::read_event
414 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> where
415 CM::Target: ChannelMessageHandler,
416 RM::Target: RoutingMessageHandler,
418 CMH::Target: CustomMessageHandler {
419 message_handler: MessageHandler<CM, RM>,
420 peers: Mutex<PeerHolder<Descriptor>>,
421 our_node_secret: SecretKey,
422 ephemeral_key_midstate: Sha256Engine,
423 custom_message_handler: CMH,
425 // Usize needs to be at least 32 bits to avoid overflowing both low and high. If usize is 64
426 // bits we will never realistically count into high:
427 peer_counter_low: AtomicUsize,
428 peer_counter_high: AtomicUsize,
433 enum MessageHandlingError {
434 PeerHandleError(PeerHandleError),
435 LightningError(LightningError),
438 impl From<PeerHandleError> for MessageHandlingError {
439 fn from(error: PeerHandleError) -> Self {
440 MessageHandlingError::PeerHandleError(error)
444 impl From<LightningError> for MessageHandlingError {
445 fn from(error: LightningError) -> Self {
446 MessageHandlingError::LightningError(error)
450 macro_rules! encode_msg {
452 let mut buffer = VecWriter(Vec::new());
453 wire::write($msg, &mut buffer).unwrap();
458 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L, IgnoringMessageHandler> where
459 CM::Target: ChannelMessageHandler,
461 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
462 /// handler is used and network graph messages are ignored.
464 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
465 /// cryptographically secure random bytes.
467 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
468 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
469 Self::new(MessageHandler {
470 chan_handler: channel_message_handler,
471 route_handler: IgnoringMessageHandler{},
472 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
476 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L, IgnoringMessageHandler> where
477 RM::Target: RoutingMessageHandler,
479 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
480 /// handler is used and messages related to channels will be ignored (or generate error
481 /// messages). Note that some other lightning implementations time-out connections after some
482 /// time if no channel is built with the peer.
484 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
485 /// cryptographically secure random bytes.
487 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
488 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
489 Self::new(MessageHandler {
490 chan_handler: ErroringMessageHandler::new(),
491 route_handler: routing_message_handler,
492 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
496 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> PeerManager<Descriptor, CM, RM, L, CMH> where
497 CM::Target: ChannelMessageHandler,
498 RM::Target: RoutingMessageHandler,
500 CMH::Target: CustomMessageHandler {
501 /// Constructs a new PeerManager with the given message handlers and node_id secret key
502 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
503 /// cryptographically secure random bytes.
504 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH) -> Self {
505 let mut ephemeral_key_midstate = Sha256::engine();
506 ephemeral_key_midstate.input(ephemeral_random_data);
510 peers: Mutex::new(PeerHolder {
511 peers: HashMap::new(),
512 node_id_to_descriptor: HashMap::new()
515 ephemeral_key_midstate,
516 peer_counter_low: AtomicUsize::new(0),
517 peer_counter_high: AtomicUsize::new(0),
519 custom_message_handler,
523 /// Get the list of node ids for peers which have completed the initial handshake.
525 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
526 /// new_outbound_connection, however entries will only appear once the initial handshake has
527 /// completed and we are sure the remote peer has the private key for the given node_id.
528 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
529 let peers = self.peers.lock().unwrap();
530 peers.peers.values().filter_map(|p| {
531 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
538 fn get_ephemeral_key(&self) -> SecretKey {
539 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
540 let low = self.peer_counter_low.fetch_add(1, Ordering::AcqRel);
541 let high = if low == 0 {
542 self.peer_counter_high.fetch_add(1, Ordering::AcqRel)
544 self.peer_counter_high.load(Ordering::Acquire)
546 ephemeral_hash.input(&byte_utils::le64_to_array(low as u64));
547 ephemeral_hash.input(&byte_utils::le64_to_array(high as u64));
548 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
551 /// Indicates a new outbound connection has been established to a node with the given node_id.
552 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
553 /// descriptor but must disconnect the connection immediately.
555 /// Returns a small number of bytes to send to the remote node (currently always 50).
557 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
558 /// [`socket_disconnected()`].
560 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
561 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
562 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
563 let res = peer_encryptor.get_act_one().to_vec();
564 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
566 let mut peers = self.peers.lock().unwrap();
567 if peers.peers.insert(descriptor, Peer {
568 channel_encryptor: peer_encryptor,
570 their_features: None,
572 pending_outbound_buffer: LinkedList::new(),
573 pending_outbound_buffer_first_msg_offset: 0,
574 awaiting_write_event: false,
577 pending_read_buffer_pos: 0,
578 pending_read_is_header: false,
580 sync_status: InitSyncTracker::NoSyncRequested,
582 msgs_sent_since_pong: 0,
583 awaiting_pong_timer_tick_intervals: 0,
584 received_message_since_timer_tick: false,
586 panic!("PeerManager driver duplicated descriptors!");
591 /// Indicates a new inbound connection has been established.
593 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
594 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
595 /// call socket_disconnected for the new descriptor but must disconnect the connection
598 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
599 /// [`socket_disconnected()`].
601 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
602 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
603 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
604 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
606 let mut peers = self.peers.lock().unwrap();
607 if peers.peers.insert(descriptor, Peer {
608 channel_encryptor: peer_encryptor,
610 their_features: None,
612 pending_outbound_buffer: LinkedList::new(),
613 pending_outbound_buffer_first_msg_offset: 0,
614 awaiting_write_event: false,
617 pending_read_buffer_pos: 0,
618 pending_read_is_header: false,
620 sync_status: InitSyncTracker::NoSyncRequested,
622 msgs_sent_since_pong: 0,
623 awaiting_pong_timer_tick_intervals: 0,
624 received_message_since_timer_tick: false,
626 panic!("PeerManager driver duplicated descriptors!");
631 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
632 while !peer.awaiting_write_event {
633 if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE && peer.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK {
634 match peer.sync_status {
635 InitSyncTracker::NoSyncRequested => {},
636 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
637 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
638 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
639 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
640 self.enqueue_message(peer, announce);
641 if let &Some(ref update_a) = update_a_option {
642 self.enqueue_message(peer, update_a);
644 if let &Some(ref update_b) = update_b_option {
645 self.enqueue_message(peer, update_b);
647 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
649 if all_messages.is_empty() || all_messages.len() != steps as usize {
650 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
653 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
654 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
655 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
656 for msg in all_messages.iter() {
657 self.enqueue_message(peer, msg);
658 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
660 if all_messages.is_empty() || all_messages.len() != steps as usize {
661 peer.sync_status = InitSyncTracker::NoSyncRequested;
664 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
665 InitSyncTracker::NodesSyncing(key) => {
666 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
667 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
668 for msg in all_messages.iter() {
669 self.enqueue_message(peer, msg);
670 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
672 if all_messages.is_empty() || all_messages.len() != steps as usize {
673 peer.sync_status = InitSyncTracker::NoSyncRequested;
678 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
679 self.maybe_send_extra_ping(peer);
683 let next_buff = match peer.pending_outbound_buffer.front() {
688 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
689 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
690 let data_sent = descriptor.send_data(pending, should_be_reading);
691 peer.pending_outbound_buffer_first_msg_offset += data_sent;
692 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
694 peer.pending_outbound_buffer_first_msg_offset = 0;
695 peer.pending_outbound_buffer.pop_front();
697 peer.awaiting_write_event = true;
702 /// Indicates that there is room to write data to the given socket descriptor.
704 /// May return an Err to indicate that the connection should be closed.
706 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
707 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
708 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
709 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
712 /// [`send_data`]: SocketDescriptor::send_data
713 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
714 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
715 let mut peers = self.peers.lock().unwrap();
716 match peers.peers.get_mut(descriptor) {
718 // This is most likely a simple race condition where the user found that the socket
719 // was writeable, then we told the user to `disconnect_socket()`, then they called
720 // this method. Return an error to make sure we get disconnected.
721 return Err(PeerHandleError { no_connection_possible: false });
724 peer.awaiting_write_event = false;
725 self.do_attempt_write_data(descriptor, peer);
731 /// Indicates that data was read from the given socket descriptor.
733 /// May return an Err to indicate that the connection should be closed.
735 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
736 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
737 /// [`send_data`] calls to handle responses.
739 /// If `Ok(true)` is returned, further read_events should not be triggered until a
740 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
743 /// [`send_data`]: SocketDescriptor::send_data
744 /// [`process_events`]: PeerManager::process_events
745 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
746 match self.do_read_event(peer_descriptor, data) {
749 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
750 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
756 /// Append a message to a peer's pending outbound/write buffer
757 fn enqueue_encoded_message(&self, peer: &mut Peer, encoded_message: &Vec<u8>) {
758 peer.msgs_sent_since_pong += 1;
759 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
762 /// Append a message to a peer's pending outbound/write buffer
763 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
764 let mut buffer = VecWriter(Vec::with_capacity(2048));
765 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
766 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
767 self.enqueue_encoded_message(peer, &buffer.0);
770 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
772 let mut peers_lock = self.peers.lock().unwrap();
773 let peers = &mut *peers_lock;
774 let mut msgs_to_forward = Vec::new();
775 let mut peer_node_id = None;
776 let pause_read = match peers.peers.get_mut(peer_descriptor) {
778 // This is most likely a simple race condition where the user read some bytes
779 // from the socket, then we told the user to `disconnect_socket()`, then they
780 // called this method. Return an error to make sure we get disconnected.
781 return Err(PeerHandleError { no_connection_possible: false });
784 assert!(peer.pending_read_buffer.len() > 0);
785 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
787 let mut read_pos = 0;
788 while read_pos < data.len() {
790 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
791 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]);
792 read_pos += data_to_copy;
793 peer.pending_read_buffer_pos += data_to_copy;
796 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
797 peer.pending_read_buffer_pos = 0;
799 macro_rules! try_potential_handleerror {
805 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
806 //TODO: Try to push msg
807 log_debug!(self.logger, "Error handling message; disconnecting peer with: {}", e.err);
808 return Err(PeerHandleError{ no_connection_possible: false });
810 msgs::ErrorAction::IgnoreAndLog(level) => {
811 log_given_level!(self.logger, level, "Error handling message; ignoring: {}", e.err);
814 msgs::ErrorAction::IgnoreError => {
815 log_debug!(self.logger, "Error handling message; ignoring: {}", e.err);
818 msgs::ErrorAction::SendErrorMessage { msg } => {
819 log_debug!(self.logger, "Error handling message; sending error message with: {}", e.err);
820 self.enqueue_message(peer, &msg);
829 macro_rules! insert_node_id {
831 match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
832 hash_map::Entry::Occupied(_) => {
833 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
834 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
835 return Err(PeerHandleError{ no_connection_possible: false })
837 hash_map::Entry::Vacant(entry) => {
838 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
839 entry.insert(peer_descriptor.clone())
845 let next_step = peer.channel_encryptor.get_noise_step();
847 NextNoiseStep::ActOne => {
848 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();
849 peer.pending_outbound_buffer.push_back(act_two);
850 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
852 NextNoiseStep::ActTwo => {
853 let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
854 peer.pending_outbound_buffer.push_back(act_three.to_vec());
855 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
856 peer.pending_read_is_header = true;
858 peer.their_node_id = Some(their_node_id);
860 let features = InitFeatures::known();
861 let resp = msgs::Init { features };
862 self.enqueue_message(peer, &resp);
863 peer.awaiting_pong_timer_tick_intervals = 0;
865 NextNoiseStep::ActThree => {
866 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
867 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
868 peer.pending_read_is_header = true;
869 peer.their_node_id = Some(their_node_id);
871 let features = InitFeatures::known();
872 let resp = msgs::Init { features };
873 self.enqueue_message(peer, &resp);
874 peer.awaiting_pong_timer_tick_intervals = 0;
876 NextNoiseStep::NoiseComplete => {
877 if peer.pending_read_is_header {
878 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
879 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
880 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
881 if msg_len < 2 { // Need at least the message type tag
882 return Err(PeerHandleError{ no_connection_possible: false });
884 peer.pending_read_is_header = false;
886 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
887 assert!(msg_data.len() >= 2);
890 peer.pending_read_buffer = [0; 18].to_vec();
891 peer.pending_read_is_header = true;
893 let mut reader = io::Cursor::new(&msg_data[..]);
894 let message_result = wire::read(&mut reader, &*self.custom_message_handler);
895 let message = match message_result {
899 msgs::DecodeError::UnknownVersion => return Err(PeerHandleError { no_connection_possible: false }),
900 msgs::DecodeError::UnknownRequiredFeature => {
901 log_trace!(self.logger, "Got a channel/node announcement with an known required feature flag, you may want to update!");
904 msgs::DecodeError::InvalidValue => {
905 log_debug!(self.logger, "Got an invalid value while deserializing message");
906 return Err(PeerHandleError { no_connection_possible: false });
908 msgs::DecodeError::ShortRead => {
909 log_debug!(self.logger, "Deserialization failed due to shortness of message");
910 return Err(PeerHandleError { no_connection_possible: false });
912 msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError { no_connection_possible: false }),
913 msgs::DecodeError::Io(_) => return Err(PeerHandleError { no_connection_possible: false }),
914 msgs::DecodeError::UnsupportedCompression => {
915 log_trace!(self.logger, "We don't support zlib-compressed message fields, ignoring message");
922 match self.handle_message(peer, message) {
923 Err(handling_error) => match handling_error {
924 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
925 MessageHandlingError::LightningError(e) => {
926 try_potential_handleerror!(Err(e));
930 peer_node_id = Some(peer.their_node_id.expect("After noise is complete, their_node_id is always set"));
931 msgs_to_forward.push(msg);
941 peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE // pause_read
945 for msg in msgs_to_forward.drain(..) {
946 self.forward_broadcast_msg(peers, &msg, peer_node_id.as_ref());
955 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
956 /// Returns the message back if it needs to be broadcasted to all other peers.
960 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
961 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
962 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(peer.their_node_id.unwrap()));
963 peer.received_message_since_timer_tick = true;
965 // Need an Init as first message
966 if let wire::Message::Init(_) = message {
967 } else if peer.their_features.is_none() {
968 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
969 return Err(PeerHandleError{ no_connection_possible: false }.into());
972 let mut should_forward = None;
975 // Setup and Control messages:
976 wire::Message::Init(msg) => {
977 if msg.features.requires_unknown_bits() {
978 log_debug!(self.logger, "Peer features required unknown version bits");
979 return Err(PeerHandleError{ no_connection_possible: true }.into());
981 if peer.their_features.is_some() {
982 return Err(PeerHandleError{ no_connection_possible: false }.into());
985 log_info!(self.logger, "Received peer Init message: {}", msg.features);
987 if msg.features.initial_routing_sync() {
988 peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
990 if !msg.features.supports_static_remote_key() {
991 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(peer.their_node_id.unwrap()));
992 return Err(PeerHandleError{ no_connection_possible: true }.into());
995 self.message_handler.route_handler.sync_routing_table(&peer.their_node_id.unwrap(), &msg);
997 self.message_handler.chan_handler.peer_connected(&peer.their_node_id.unwrap(), &msg);
998 peer.their_features = Some(msg.features);
1000 wire::Message::Error(msg) => {
1001 let mut data_is_printable = true;
1002 for b in msg.data.bytes() {
1003 if b < 32 || b > 126 {
1004 data_is_printable = false;
1009 if data_is_printable {
1010 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(peer.their_node_id.unwrap()), msg.data);
1012 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(peer.their_node_id.unwrap()));
1014 self.message_handler.chan_handler.handle_error(&peer.their_node_id.unwrap(), &msg);
1015 if msg.channel_id == [0; 32] {
1016 return Err(PeerHandleError{ no_connection_possible: true }.into());
1020 wire::Message::Ping(msg) => {
1021 if msg.ponglen < 65532 {
1022 let resp = msgs::Pong { byteslen: msg.ponglen };
1023 self.enqueue_message(peer, &resp);
1026 wire::Message::Pong(_msg) => {
1027 peer.awaiting_pong_timer_tick_intervals = 0;
1028 peer.msgs_sent_since_pong = 0;
1031 // Channel messages:
1032 wire::Message::OpenChannel(msg) => {
1033 self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
1035 wire::Message::AcceptChannel(msg) => {
1036 self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), peer.their_features.clone().unwrap(), &msg);
1039 wire::Message::FundingCreated(msg) => {
1040 self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg);
1042 wire::Message::FundingSigned(msg) => {
1043 self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg);
1045 wire::Message::FundingLocked(msg) => {
1046 self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg);
1049 wire::Message::Shutdown(msg) => {
1050 self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), peer.their_features.as_ref().unwrap(), &msg);
1052 wire::Message::ClosingSigned(msg) => {
1053 self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg);
1056 // Commitment messages:
1057 wire::Message::UpdateAddHTLC(msg) => {
1058 self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg);
1060 wire::Message::UpdateFulfillHTLC(msg) => {
1061 self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg);
1063 wire::Message::UpdateFailHTLC(msg) => {
1064 self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg);
1066 wire::Message::UpdateFailMalformedHTLC(msg) => {
1067 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg);
1070 wire::Message::CommitmentSigned(msg) => {
1071 self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg);
1073 wire::Message::RevokeAndACK(msg) => {
1074 self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg);
1076 wire::Message::UpdateFee(msg) => {
1077 self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg);
1079 wire::Message::ChannelReestablish(msg) => {
1080 self.message_handler.chan_handler.handle_channel_reestablish(&peer.their_node_id.unwrap(), &msg);
1083 // Routing messages:
1084 wire::Message::AnnouncementSignatures(msg) => {
1085 self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg);
1087 wire::Message::ChannelAnnouncement(msg) => {
1088 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1089 .map_err(|e| -> MessageHandlingError { e.into() })? {
1090 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1093 wire::Message::NodeAnnouncement(msg) => {
1094 if self.message_handler.route_handler.handle_node_announcement(&msg)
1095 .map_err(|e| -> MessageHandlingError { e.into() })? {
1096 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1099 wire::Message::ChannelUpdate(msg) => {
1100 self.message_handler.chan_handler.handle_channel_update(&peer.their_node_id.unwrap(), &msg);
1101 if self.message_handler.route_handler.handle_channel_update(&msg)
1102 .map_err(|e| -> MessageHandlingError { e.into() })? {
1103 should_forward = Some(wire::Message::ChannelUpdate(msg));
1106 wire::Message::QueryShortChannelIds(msg) => {
1107 self.message_handler.route_handler.handle_query_short_channel_ids(&peer.their_node_id.unwrap(), msg)?;
1109 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1110 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&peer.their_node_id.unwrap(), msg)?;
1112 wire::Message::QueryChannelRange(msg) => {
1113 self.message_handler.route_handler.handle_query_channel_range(&peer.their_node_id.unwrap(), msg)?;
1115 wire::Message::ReplyChannelRange(msg) => {
1116 self.message_handler.route_handler.handle_reply_channel_range(&peer.their_node_id.unwrap(), msg)?;
1118 wire::Message::GossipTimestampFilter(_msg) => {
1119 // TODO: handle message
1122 // Unknown messages:
1123 wire::Message::Unknown(type_id) if message.is_even() => {
1124 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1125 // Fail the channel if message is an even, unknown type as per BOLT #1.
1126 return Err(PeerHandleError{ no_connection_possible: true }.into());
1128 wire::Message::Unknown(type_id) => {
1129 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1131 wire::Message::Custom(custom) => {
1132 self.custom_message_handler.handle_custom_message(custom, &peer.their_node_id.unwrap())?;
1138 fn forward_broadcast_msg(&self, peers: &mut PeerHolder<Descriptor>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1140 wire::Message::ChannelAnnouncement(ref msg) => {
1141 log_trace!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1142 let encoded_msg = encode_msg!(msg);
1144 for (_, peer) in peers.peers.iter_mut() {
1145 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1146 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1149 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1150 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1152 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1155 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1156 peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1159 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1162 self.enqueue_encoded_message(peer, &encoded_msg);
1165 wire::Message::NodeAnnouncement(ref msg) => {
1166 log_trace!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1167 let encoded_msg = encode_msg!(msg);
1169 for (_, peer) in peers.peers.iter_mut() {
1170 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1171 !peer.should_forward_node_announcement(msg.contents.node_id) {
1174 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1175 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1177 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1180 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1183 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1186 self.enqueue_encoded_message(peer, &encoded_msg);
1189 wire::Message::ChannelUpdate(ref msg) => {
1190 log_trace!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1191 let encoded_msg = encode_msg!(msg);
1193 for (_, peer) in peers.peers.iter_mut() {
1194 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1195 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1198 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1199 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1201 log_trace!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1204 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1207 self.enqueue_encoded_message(peer, &encoded_msg);
1210 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1214 /// Checks for any events generated by our handlers and processes them. Includes sending most
1215 /// response messages as well as messages generated by calls to handler functions directly (eg
1216 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1218 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1221 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1222 /// or one of the other clients provided in our language bindings.
1224 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1225 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1226 /// [`send_data`]: SocketDescriptor::send_data
1227 pub fn process_events(&self) {
1229 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1230 // buffer by doing things like announcing channels on another node. We should be willing to
1231 // drop optional-ish messages when send buffers get full!
1233 let mut peers_lock = self.peers.lock().unwrap();
1234 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1235 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1236 let peers = &mut *peers_lock;
1237 macro_rules! get_peer_for_forwarding {
1238 ($node_id: expr) => {
1240 match peers.node_id_to_descriptor.get($node_id) {
1241 Some(descriptor) => match peers.peers.get_mut(&descriptor) {
1243 if peer.their_features.is_none() {
1248 None => panic!("Inconsistent peers set state!"),
1257 for event in events_generated.drain(..) {
1259 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1260 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1261 log_pubkey!(node_id),
1262 log_bytes!(msg.temporary_channel_id));
1263 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1265 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1266 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1267 log_pubkey!(node_id),
1268 log_bytes!(msg.temporary_channel_id));
1269 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1271 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1272 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1273 log_pubkey!(node_id),
1274 log_bytes!(msg.temporary_channel_id),
1275 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1276 // TODO: If the peer is gone we should generate a DiscardFunding event
1277 // indicating to the wallet that they should just throw away this funding transaction
1278 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1280 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1281 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1282 log_pubkey!(node_id),
1283 log_bytes!(msg.channel_id));
1284 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1286 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1287 log_debug!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1288 log_pubkey!(node_id),
1289 log_bytes!(msg.channel_id));
1290 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1292 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1293 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1294 log_pubkey!(node_id),
1295 log_bytes!(msg.channel_id));
1296 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1298 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 } } => {
1299 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1300 log_pubkey!(node_id),
1301 update_add_htlcs.len(),
1302 update_fulfill_htlcs.len(),
1303 update_fail_htlcs.len(),
1304 log_bytes!(commitment_signed.channel_id));
1305 let peer = get_peer_for_forwarding!(node_id);
1306 for msg in update_add_htlcs {
1307 self.enqueue_message(peer, msg);
1309 for msg in update_fulfill_htlcs {
1310 self.enqueue_message(peer, msg);
1312 for msg in update_fail_htlcs {
1313 self.enqueue_message(peer, msg);
1315 for msg in update_fail_malformed_htlcs {
1316 self.enqueue_message(peer, msg);
1318 if let &Some(ref msg) = update_fee {
1319 self.enqueue_message(peer, msg);
1321 self.enqueue_message(peer, commitment_signed);
1323 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1324 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1325 log_pubkey!(node_id),
1326 log_bytes!(msg.channel_id));
1327 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1329 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1330 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1331 log_pubkey!(node_id),
1332 log_bytes!(msg.channel_id));
1333 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1335 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1336 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1337 log_pubkey!(node_id),
1338 log_bytes!(msg.channel_id));
1339 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1341 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1342 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1343 log_pubkey!(node_id),
1344 log_bytes!(msg.channel_id));
1345 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1347 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1348 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1349 if self.message_handler.route_handler.handle_channel_announcement(&msg).is_ok() && self.message_handler.route_handler.handle_channel_update(&update_msg).is_ok() {
1350 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None);
1351 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None);
1354 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1355 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1356 if self.message_handler.route_handler.handle_node_announcement(&msg).is_ok() {
1357 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None);
1360 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1361 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1362 if self.message_handler.route_handler.handle_channel_update(&msg).is_ok() {
1363 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None);
1366 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1367 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1368 log_pubkey!(node_id), msg.contents.short_channel_id);
1369 let peer = get_peer_for_forwarding!(node_id);
1370 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg)));
1372 MessageSendEvent::HandleError { ref node_id, ref action } => {
1374 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1375 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
1376 if let Some(mut peer) = peers.peers.remove(&descriptor) {
1377 if let Some(ref msg) = *msg {
1378 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1379 log_pubkey!(node_id),
1381 self.enqueue_message(&mut peer, msg);
1382 // This isn't guaranteed to work, but if there is enough free
1383 // room in the send buffer, put the error message there...
1384 self.do_attempt_write_data(&mut descriptor, &mut peer);
1386 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1389 descriptor.disconnect_socket();
1390 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1393 msgs::ErrorAction::IgnoreAndLog(level) => {
1394 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1396 msgs::ErrorAction::IgnoreError => {
1397 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1399 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1400 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1401 log_pubkey!(node_id),
1403 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1407 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1408 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1410 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1411 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1413 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1414 log_trace!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1415 log_pubkey!(node_id),
1416 msg.short_channel_ids.len(),
1418 msg.number_of_blocks,
1420 self.enqueue_message(get_peer_for_forwarding!(node_id), msg);
1425 for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1426 self.enqueue_message(get_peer_for_forwarding!(&node_id), &msg);
1429 for (descriptor, peer) in peers.peers.iter_mut() {
1430 self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
1435 /// Indicates that the given socket descriptor's connection is now closed.
1436 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1437 self.disconnect_event_internal(descriptor, false);
1440 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1441 let mut peers = self.peers.lock().unwrap();
1442 let peer_option = peers.peers.remove(descriptor);
1445 // This is most likely a simple race condition where the user found that the socket
1446 // was disconnected, then we told the user to `disconnect_socket()`, then they
1447 // called this method. Either way we're disconnected, return.
1450 match peer.their_node_id {
1452 log_trace!(self.logger,
1453 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1454 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1455 peers.node_id_to_descriptor.remove(&node_id);
1456 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1464 /// Disconnect a peer given its node id.
1466 /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1467 /// force-closing any channels we have with it.
1469 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1470 /// peer. Thus, be very careful about reentrancy issues.
1472 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1473 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1474 let mut peers_lock = self.peers.lock().unwrap();
1475 if let Some(mut descriptor) = peers_lock.node_id_to_descriptor.remove(&node_id) {
1476 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1477 peers_lock.peers.remove(&descriptor);
1478 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1479 descriptor.disconnect_socket();
1483 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1484 /// an indication that TCP sockets have stalled even if we weren't around to time them out
1485 /// using regular ping/pongs.
1486 pub fn disconnect_all_peers(&self) {
1487 let mut peers_lock = self.peers.lock().unwrap();
1488 let peers = &mut *peers_lock;
1489 for (mut descriptor, peer) in peers.peers.drain() {
1490 if let Some(node_id) = peer.their_node_id {
1491 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1492 peers.node_id_to_descriptor.remove(&node_id);
1493 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1495 descriptor.disconnect_socket();
1497 debug_assert!(peers.node_id_to_descriptor.is_empty());
1500 /// This is called when we're blocked on sending additional gossip messages until we receive a
1501 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1502 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1503 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1504 if peer.awaiting_pong_timer_tick_intervals == 0 {
1505 peer.awaiting_pong_timer_tick_intervals = -1;
1506 let ping = msgs::Ping {
1510 self.enqueue_message(peer, &ping);
1514 /// Send pings to each peer and disconnect those which did not respond to the last round of
1517 /// This may be called on any timescale you want, however, roughly once every five to ten
1518 /// seconds is preferred. The call rate determines both how often we send a ping to our peers
1519 /// and how much time they have to respond before we disconnect them.
1521 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1524 /// [`send_data`]: SocketDescriptor::send_data
1525 pub fn timer_tick_occurred(&self) {
1526 let mut peers_lock = self.peers.lock().unwrap();
1528 let peers = &mut *peers_lock;
1529 let node_id_to_descriptor = &mut peers.node_id_to_descriptor;
1530 let peers = &mut peers.peers;
1531 let mut descriptors_needing_disconnect = Vec::new();
1532 let peer_count = peers.len();
1534 peers.retain(|descriptor, peer| {
1535 let mut do_disconnect_peer = false;
1536 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1537 // The peer needs to complete its handshake before we can exchange messages. We
1538 // give peers one timer tick to complete handshake, reusing
1539 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1540 // for handshake completion.
1541 if peer.awaiting_pong_timer_tick_intervals != 0 {
1542 do_disconnect_peer = true;
1544 peer.awaiting_pong_timer_tick_intervals = 1;
1549 if peer.awaiting_pong_timer_tick_intervals == -1 {
1550 // Magic value set in `maybe_send_extra_ping`.
1551 peer.awaiting_pong_timer_tick_intervals = 1;
1552 peer.received_message_since_timer_tick = false;
1556 if do_disconnect_peer
1557 || (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
1558 || peer.awaiting_pong_timer_tick_intervals as u64 >
1559 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peer_count as u64
1561 descriptors_needing_disconnect.push(descriptor.clone());
1562 match peer.their_node_id {
1564 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1565 node_id_to_descriptor.remove(&node_id);
1566 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1572 peer.received_message_since_timer_tick = false;
1574 if peer.awaiting_pong_timer_tick_intervals > 0 {
1575 peer.awaiting_pong_timer_tick_intervals += 1;
1579 peer.awaiting_pong_timer_tick_intervals = 1;
1580 let ping = msgs::Ping {
1584 self.enqueue_message(peer, &ping);
1585 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer);
1590 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1591 descriptor.disconnect_socket();
1599 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
1602 use util::test_utils;
1604 use bitcoin::secp256k1::Secp256k1;
1605 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1608 use sync::{Arc, Mutex};
1609 use core::sync::atomic::Ordering;
1612 struct FileDescriptor {
1614 outbound_data: Arc<Mutex<Vec<u8>>>,
1616 impl PartialEq for FileDescriptor {
1617 fn eq(&self, other: &Self) -> bool {
1621 impl Eq for FileDescriptor { }
1622 impl core::hash::Hash for FileDescriptor {
1623 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1624 self.fd.hash(hasher)
1628 impl SocketDescriptor for FileDescriptor {
1629 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1630 self.outbound_data.lock().unwrap().extend_from_slice(data);
1634 fn disconnect_socket(&mut self) {}
1637 struct PeerManagerCfg {
1638 chan_handler: test_utils::TestChannelMessageHandler,
1639 routing_handler: test_utils::TestRoutingMessageHandler,
1640 logger: test_utils::TestLogger,
1643 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1644 let mut cfgs = Vec::new();
1645 for _ in 0..peer_count {
1648 chan_handler: test_utils::TestChannelMessageHandler::new(),
1649 logger: test_utils::TestLogger::new(),
1650 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1658 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, IgnoringMessageHandler>> {
1659 let mut peers = Vec::new();
1660 for i in 0..peer_count {
1661 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1662 let ephemeral_bytes = [i as u8; 32];
1663 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1664 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {});
1671 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>) -> (FileDescriptor, FileDescriptor) {
1672 let secp_ctx = Secp256k1::new();
1673 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1674 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1675 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1676 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone()).unwrap();
1677 peer_a.new_inbound_connection(fd_a.clone()).unwrap();
1678 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1679 peer_a.process_events();
1680 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1681 peer_b.process_events();
1682 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1683 (fd_a.clone(), fd_b.clone())
1687 fn test_disconnect_peer() {
1688 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1689 // push a DisconnectPeer event to remove the node flagged by id
1690 let cfgs = create_peermgr_cfgs(2);
1691 let chan_handler = test_utils::TestChannelMessageHandler::new();
1692 let mut peers = create_network(2, &cfgs);
1693 establish_connection(&peers[0], &peers[1]);
1694 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1696 let secp_ctx = Secp256k1::new();
1697 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1699 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1701 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1703 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1704 peers[0].message_handler.chan_handler = &chan_handler;
1706 peers[0].process_events();
1707 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1711 fn test_timer_tick_occurred() {
1712 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1713 let cfgs = create_peermgr_cfgs(2);
1714 let peers = create_network(2, &cfgs);
1715 establish_connection(&peers[0], &peers[1]);
1716 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1718 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1719 peers[0].timer_tick_occurred();
1720 peers[0].process_events();
1721 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1723 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1724 peers[0].timer_tick_occurred();
1725 peers[0].process_events();
1726 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1730 fn test_do_attempt_write_data() {
1731 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1732 let cfgs = create_peermgr_cfgs(2);
1733 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1734 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1735 let peers = create_network(2, &cfgs);
1737 // By calling establish_connect, we trigger do_attempt_write_data between
1738 // the peers. Previously this function would mistakenly enter an infinite loop
1739 // when there were more channel messages available than could fit into a peer's
1740 // buffer. This issue would now be detected by this test (because we use custom
1741 // RoutingMessageHandlers that intentionally return more channel messages
1742 // than can fit into a peer's buffer).
1743 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1745 // Make each peer to read the messages that the other peer just wrote to them. Note that
1746 // due to the max-messagse-before-ping limits this may take a few iterations to complete.
1747 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
1748 peers[0].process_events();
1749 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
1750 assert!(!b_read_data.is_empty());
1752 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
1753 peers[1].process_events();
1755 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
1756 assert!(!a_read_data.is_empty());
1757 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
1759 peers[1].process_events();
1760 assert_eq!(fd_b.outbound_data.lock().unwrap().len(), 0, "Until B receives data, it shouldn't send more messages");
1763 // Check that each peer has received the expected number of channel updates and channel
1765 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1766 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1767 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
1768 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
1772 fn test_handshake_timeout() {
1773 // Tests that we time out a peer still waiting on handshake completion after a full timer
1775 let cfgs = create_peermgr_cfgs(2);
1776 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1777 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1778 let peers = create_network(2, &cfgs);
1780 let secp_ctx = Secp256k1::new();
1781 let a_id = PublicKey::from_secret_key(&secp_ctx, &peers[0].our_node_secret);
1782 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1783 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1784 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone()).unwrap();
1785 peers[0].new_inbound_connection(fd_a.clone()).unwrap();
1787 // If we get a single timer tick before completion, that's fine
1788 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1789 peers[0].timer_tick_occurred();
1790 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
1792 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
1793 peers[0].process_events();
1794 assert_eq!(peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1795 peers[1].process_events();
1797 // ...but if we get a second timer tick, we should disconnect the peer
1798 peers[0].timer_tick_occurred();
1799 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);
1801 assert!(peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).is_err());