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 P2PGossipSync) with
16 //! messages they should handle, and encoding/sending response messages.
18 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
20 use crate::chain::keysinterface::{KeysManager, NodeSigner, Recipient};
21 use crate::ln::features::{InitFeatures, NodeFeatures};
23 use crate::ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, OnionMessageHandler, RoutingMessageHandler};
24 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
25 use crate::util::ser::{VecWriter, Writeable, Writer};
26 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
28 use crate::ln::wire::Encode;
29 use crate::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
30 use crate::routing::gossip::{NetworkGraph, P2PGossipSync};
31 use crate::util::atomic_counter::AtomicCounter;
32 use crate::util::events::{MessageSendEvent, MessageSendEventsProvider, OnionMessageProvider};
33 use crate::util::logger::Logger;
35 use crate::prelude::*;
37 use alloc::collections::LinkedList;
38 use crate::sync::{Arc, Mutex, MutexGuard, FairRwLock};
39 use core::sync::atomic::{AtomicBool, AtomicU32, Ordering};
40 use core::{cmp, hash, fmt, mem};
42 use core::convert::Infallible;
43 #[cfg(feature = "std")] use std::error;
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
47 use bitcoin::hashes::{HashEngine, Hash};
49 /// Handler for BOLT1-compliant messages.
50 pub trait CustomMessageHandler: wire::CustomMessageReader {
51 /// Called with the message type that was received and the buffer to be read.
52 /// Can return a `MessageHandlingError` if the message could not be handled.
53 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
55 /// Gets the list of pending messages which were generated by the custom message
56 /// handler, clearing the list in the process. The first tuple element must
57 /// correspond to the intended recipients node ids. If no connection to one of the
58 /// specified node does not exist, the message is simply not sent to it.
59 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
62 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
63 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
64 pub struct IgnoringMessageHandler{}
65 impl MessageSendEventsProvider for IgnoringMessageHandler {
66 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
68 impl RoutingMessageHandler for IgnoringMessageHandler {
69 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
70 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
71 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
72 fn get_next_channel_announcement(&self, _starting_point: u64) ->
73 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
74 fn get_next_node_announcement(&self, _starting_point: Option<&PublicKey>) -> Option<msgs::NodeAnnouncement> { None }
75 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) -> Result<(), ()> { Ok(()) }
76 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
77 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
78 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
79 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
80 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
81 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
85 impl OnionMessageProvider for IgnoringMessageHandler {
86 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
88 impl OnionMessageHandler for IgnoringMessageHandler {
89 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
90 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) -> Result<(), ()> { Ok(()) }
91 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
92 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
93 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
97 impl CustomOnionMessageHandler for IgnoringMessageHandler {
98 type CustomMessage = Infallible;
99 fn handle_custom_message(&self, _msg: Infallible) {
100 // Since we always return `None` in the read the handle method should never be called.
103 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
108 impl CustomOnionMessageContents for Infallible {
109 fn tlv_type(&self) -> u64 { unreachable!(); }
112 impl Deref for IgnoringMessageHandler {
113 type Target = IgnoringMessageHandler;
114 fn deref(&self) -> &Self { self }
117 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
118 // method that takes self for it.
119 impl wire::Type for Infallible {
120 fn type_id(&self) -> u16 {
124 impl Writeable for Infallible {
125 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
130 impl wire::CustomMessageReader for IgnoringMessageHandler {
131 type CustomMessage = Infallible;
132 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
137 impl CustomMessageHandler for IgnoringMessageHandler {
138 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
139 // Since we always return `None` in the read the handle method should never be called.
143 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
146 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
147 /// You can provide one of these as the route_handler in a MessageHandler.
148 pub struct ErroringMessageHandler {
149 message_queue: Mutex<Vec<MessageSendEvent>>
151 impl ErroringMessageHandler {
152 /// Constructs a new ErroringMessageHandler
153 pub fn new() -> Self {
154 Self { message_queue: Mutex::new(Vec::new()) }
156 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
157 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
158 action: msgs::ErrorAction::SendErrorMessage {
159 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
161 node_id: node_id.clone(),
165 impl MessageSendEventsProvider for ErroringMessageHandler {
166 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
167 let mut res = Vec::new();
168 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
172 impl ChannelMessageHandler for ErroringMessageHandler {
173 // Any messages which are related to a specific channel generate an error message to let the
174 // peer know we don't care about channels.
175 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
176 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
178 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
179 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
181 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
182 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
184 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
185 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
187 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
188 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
190 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
191 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
193 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
194 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
196 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
197 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
199 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
200 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
202 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
203 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
205 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
206 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
208 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
209 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
211 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
212 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
214 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
215 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
217 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
218 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
220 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
221 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
223 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
224 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
225 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
226 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) -> Result<(), ()> { Ok(()) }
227 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
228 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
229 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
230 // Set a number of features which various nodes may require to talk to us. It's totally
231 // reasonable to indicate we "support" all kinds of channel features...we just reject all
233 let mut features = InitFeatures::empty();
234 features.set_data_loss_protect_optional();
235 features.set_upfront_shutdown_script_optional();
236 features.set_variable_length_onion_optional();
237 features.set_static_remote_key_optional();
238 features.set_payment_secret_optional();
239 features.set_basic_mpp_optional();
240 features.set_wumbo_optional();
241 features.set_shutdown_any_segwit_optional();
242 features.set_channel_type_optional();
243 features.set_scid_privacy_optional();
244 features.set_zero_conf_optional();
248 impl Deref for ErroringMessageHandler {
249 type Target = ErroringMessageHandler;
250 fn deref(&self) -> &Self { self }
253 /// Provides references to trait impls which handle different types of messages.
254 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref> where
255 CM::Target: ChannelMessageHandler,
256 RM::Target: RoutingMessageHandler,
257 OM::Target: OnionMessageHandler,
259 /// A message handler which handles messages specific to channels. Usually this is just a
260 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
262 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
263 pub chan_handler: CM,
264 /// A message handler which handles messages updating our knowledge of the network channel
265 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
267 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
268 pub route_handler: RM,
270 /// A message handler which handles onion messages. For now, this can only be an
271 /// [`IgnoringMessageHandler`].
272 pub onion_message_handler: OM,
275 /// Provides an object which can be used to send data to and which uniquely identifies a connection
276 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
277 /// implement Hash to meet the PeerManager API.
279 /// For efficiency, Clone should be relatively cheap for this type.
281 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
282 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
283 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
284 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
285 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
286 /// to simply use another value which is guaranteed to be globally unique instead.
287 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
288 /// Attempts to send some data from the given slice to the peer.
290 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
291 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
292 /// called and further write attempts may occur until that time.
294 /// If the returned size is smaller than `data.len()`, a
295 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
296 /// written. Additionally, until a `send_data` event completes fully, no further
297 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
298 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
301 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
302 /// (indicating that read events should be paused to prevent DoS in the send buffer),
303 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
304 /// `resume_read` of false carries no meaning, and should not cause any action.
305 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
306 /// Disconnect the socket pointed to by this SocketDescriptor.
308 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
309 /// call (doing so is a noop).
310 fn disconnect_socket(&mut self);
313 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
314 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
317 pub struct PeerHandleError {
318 /// Used to indicate that we probably can't make any future connections to this peer (e.g.
319 /// because we required features that our peer was missing, or vice versa).
321 /// While LDK's [`ChannelManager`] will not do it automatically, you likely wish to force-close
322 /// any channels with this peer or check for new versions of LDK.
324 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
325 pub no_connection_possible: bool,
327 impl fmt::Debug for PeerHandleError {
328 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
329 formatter.write_str("Peer Sent Invalid Data")
332 impl fmt::Display for PeerHandleError {
333 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
334 formatter.write_str("Peer Sent Invalid Data")
338 #[cfg(feature = "std")]
339 impl error::Error for PeerHandleError {
340 fn description(&self) -> &str {
341 "Peer Sent Invalid Data"
345 enum InitSyncTracker{
347 ChannelsSyncing(u64),
348 NodesSyncing(PublicKey),
351 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
352 /// forwarding gossip messages to peers altogether.
353 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
355 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
356 /// we have fewer than this many messages in the outbound buffer again.
357 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
358 /// refilled as we send bytes.
359 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
360 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
362 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
364 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
365 /// the socket receive buffer before receiving the ping.
367 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
368 /// including any network delays, outbound traffic, or the same for messages from other peers.
370 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
371 /// per connected peer to respond to a ping, as long as they send us at least one message during
372 /// each tick, ensuring we aren't actually just disconnected.
373 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
376 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
377 /// two connected peers, assuming most LDK-running systems have at least two cores.
378 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
380 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
381 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
382 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
383 /// process before the next ping.
385 /// Note that we continue responding to other messages even after we've sent this many messages, so
386 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
387 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
388 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
391 channel_encryptor: PeerChannelEncryptor,
392 their_node_id: Option<PublicKey>,
393 their_features: Option<InitFeatures>,
394 their_net_address: Option<NetAddress>,
396 pending_outbound_buffer: LinkedList<Vec<u8>>,
397 pending_outbound_buffer_first_msg_offset: usize,
398 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
399 /// prioritize channel messages over them.
401 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
402 gossip_broadcast_buffer: LinkedList<Vec<u8>>,
403 awaiting_write_event: bool,
405 pending_read_buffer: Vec<u8>,
406 pending_read_buffer_pos: usize,
407 pending_read_is_header: bool,
409 sync_status: InitSyncTracker,
411 msgs_sent_since_pong: usize,
412 awaiting_pong_timer_tick_intervals: i8,
413 received_message_since_timer_tick: bool,
414 sent_gossip_timestamp_filter: bool,
418 /// Returns true if the channel announcements/updates for the given channel should be
419 /// forwarded to this peer.
420 /// If we are sending our routing table to this peer and we have not yet sent channel
421 /// announcements/updates for the given channel_id then we will send it when we get to that
422 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
423 /// sent the old versions, we should send the update, and so return true here.
424 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
425 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
426 !self.sent_gossip_timestamp_filter {
429 match self.sync_status {
430 InitSyncTracker::NoSyncRequested => true,
431 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
432 InitSyncTracker::NodesSyncing(_) => true,
436 /// Similar to the above, but for node announcements indexed by node_id.
437 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
438 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
439 !self.sent_gossip_timestamp_filter {
442 match self.sync_status {
443 InitSyncTracker::NoSyncRequested => true,
444 InitSyncTracker::ChannelsSyncing(_) => false,
445 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
449 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
450 /// buffer still has space and we don't need to pause reads to get some writes out.
451 fn should_read(&self) -> bool {
452 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE
455 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
456 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
457 fn should_buffer_gossip_backfill(&self) -> bool {
458 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
459 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
462 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
463 /// every time the peer's buffer may have been drained.
464 fn should_buffer_onion_message(&self) -> bool {
465 self.pending_outbound_buffer.is_empty()
466 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
469 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
470 /// buffer. This is checked every time the peer's buffer may have been drained.
471 fn should_buffer_gossip_broadcast(&self) -> bool {
472 self.pending_outbound_buffer.is_empty()
473 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
476 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
477 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
478 let total_outbound_buffered =
479 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
481 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
482 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
486 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
487 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
488 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
489 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
490 /// issues such as overly long function definitions.
492 /// (C-not exported) as `Arc`s don't make sense in bindings.
493 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, Arc<C>, Arc<L>>>, Arc<SimpleArcOnionMessenger<L>>, Arc<L>, IgnoringMessageHandler, Arc<KeysManager>>;
495 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
496 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
497 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
498 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
499 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
500 /// helps with issues such as long function definitions.
502 /// (C-not exported) as general type aliases don't make sense in bindings.
503 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, 'k, 'l, 'm, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'm, M, T, F, L>, &'f P2PGossipSync<&'g NetworkGraph<&'f L>, &'h C, &'f L>, &'i SimpleRefOnionMessenger<'j, 'k, L>, &'f L, IgnoringMessageHandler, &'c KeysManager>;
505 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
506 /// socket events into messages which it passes on to its [`MessageHandler`].
508 /// Locks are taken internally, so you must never assume that reentrancy from a
509 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
511 /// Calls to [`read_event`] will decode relevant messages and pass them to the
512 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
513 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
514 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
515 /// calls only after previous ones have returned.
517 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
518 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
519 /// essentially you should default to using a SimpleRefPeerManager, and use a
520 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
521 /// you're using lightning-net-tokio.
523 /// [`read_event`]: PeerManager::read_event
524 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
525 CM::Target: ChannelMessageHandler,
526 RM::Target: RoutingMessageHandler,
527 OM::Target: OnionMessageHandler,
529 CMH::Target: CustomMessageHandler,
530 NS::Target: NodeSigner {
531 message_handler: MessageHandler<CM, RM, OM>,
532 /// Connection state for each connected peer - we have an outer read-write lock which is taken
533 /// as read while we're doing processing for a peer and taken write when a peer is being added
536 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
537 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
538 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
539 /// the `MessageHandler`s for a given peer is already guaranteed.
540 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
541 /// Only add to this set when noise completes.
542 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
543 /// lock held. Entries may be added with only the `peers` read lock held (though the
544 /// `Descriptor` value must already exist in `peers`).
545 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
546 /// We can only have one thread processing events at once, but we don't usually need the full
547 /// `peers` write lock to do so, so instead we block on this empty mutex when entering
548 /// `process_events`.
549 event_processing_lock: Mutex<()>,
550 /// Because event processing is global and always does all available work before returning,
551 /// there is no reason for us to have many event processors waiting on the lock at once.
552 /// Instead, we limit the total blocked event processors to always exactly one by setting this
553 /// when an event process call is waiting.
554 blocked_event_processors: AtomicBool,
556 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
557 /// value increases strictly since we don't assume access to a time source.
558 last_node_announcement_serial: AtomicU32,
560 ephemeral_key_midstate: Sha256Engine,
561 custom_message_handler: CMH,
563 peer_counter: AtomicCounter,
568 secp_ctx: Secp256k1<secp256k1::SignOnly>
571 enum MessageHandlingError {
572 PeerHandleError(PeerHandleError),
573 LightningError(LightningError),
576 impl From<PeerHandleError> for MessageHandlingError {
577 fn from(error: PeerHandleError) -> Self {
578 MessageHandlingError::PeerHandleError(error)
582 impl From<LightningError> for MessageHandlingError {
583 fn from(error: LightningError) -> Self {
584 MessageHandlingError::LightningError(error)
588 macro_rules! encode_msg {
590 let mut buffer = VecWriter(Vec::new());
591 wire::write($msg, &mut buffer).unwrap();
596 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
597 CM::Target: ChannelMessageHandler,
598 OM::Target: OnionMessageHandler,
600 NS::Target: NodeSigner {
601 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
602 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
605 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
606 /// cryptographically secure random bytes.
608 /// `current_time` is used as an always-increasing counter that survives across restarts and is
609 /// incremented irregularly internally. In general it is best to simply use the current UNIX
610 /// timestamp, however if it is not available a persistent counter that increases once per
611 /// minute should suffice.
613 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
614 pub fn new_channel_only(channel_message_handler: CM, onion_message_handler: OM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
615 Self::new(MessageHandler {
616 chan_handler: channel_message_handler,
617 route_handler: IgnoringMessageHandler{},
618 onion_message_handler,
619 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
623 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
624 RM::Target: RoutingMessageHandler,
626 NS::Target: NodeSigner {
627 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
628 /// handler or onion message handler is used and onion and channel messages will be ignored (or
629 /// generate error messages). Note that some other lightning implementations time-out connections
630 /// after some time if no channel is built with the peer.
632 /// `current_time` is used as an always-increasing counter that survives across restarts and is
633 /// incremented irregularly internally. In general it is best to simply use the current UNIX
634 /// timestamp, however if it is not available a persistent counter that increases once per
635 /// minute should suffice.
637 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
638 /// cryptographically secure random bytes.
640 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
641 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
642 Self::new(MessageHandler {
643 chan_handler: ErroringMessageHandler::new(),
644 route_handler: routing_message_handler,
645 onion_message_handler: IgnoringMessageHandler{},
646 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
650 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
651 /// This works around `format!()` taking a reference to each argument, preventing
652 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
653 /// due to lifetime errors.
654 struct OptionalFromDebugger<'a>(&'a Option<PublicKey>);
655 impl core::fmt::Display for OptionalFromDebugger<'_> {
656 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
657 if let Some(node_id) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
661 /// A function used to filter out local or private addresses
662 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
663 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
664 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
666 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
667 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
668 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
669 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
670 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
671 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
672 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
673 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
674 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
675 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
676 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
677 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
678 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
679 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
680 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
681 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
682 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
683 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
684 // For remaining addresses
685 Some(NetAddress::IPv6{addr: _, port: _}) => None,
686 Some(..) => ip_address,
691 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
692 CM::Target: ChannelMessageHandler,
693 RM::Target: RoutingMessageHandler,
694 OM::Target: OnionMessageHandler,
696 CMH::Target: CustomMessageHandler,
697 NS::Target: NodeSigner
699 /// Constructs a new PeerManager with the given message handlers and node_id secret key
700 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
701 /// cryptographically secure random bytes.
703 /// `current_time` is used as an always-increasing counter that survives across restarts and is
704 /// incremented irregularly internally. In general it is best to simply use the current UNIX
705 /// timestamp, however if it is not available a persistent counter that increases once per
706 /// minute should suffice.
707 pub fn new(message_handler: MessageHandler<CM, RM, OM>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH, node_signer: NS) -> Self {
708 let mut ephemeral_key_midstate = Sha256::engine();
709 ephemeral_key_midstate.input(ephemeral_random_data);
711 let mut secp_ctx = Secp256k1::signing_only();
712 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
713 secp_ctx.seeded_randomize(&ephemeral_hash);
717 peers: FairRwLock::new(HashMap::new()),
718 node_id_to_descriptor: Mutex::new(HashMap::new()),
719 event_processing_lock: Mutex::new(()),
720 blocked_event_processors: AtomicBool::new(false),
721 ephemeral_key_midstate,
722 peer_counter: AtomicCounter::new(),
723 last_node_announcement_serial: AtomicU32::new(current_time),
725 custom_message_handler,
731 /// Get the list of node ids for peers which have completed the initial handshake.
733 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
734 /// new_outbound_connection, however entries will only appear once the initial handshake has
735 /// completed and we are sure the remote peer has the private key for the given node_id.
736 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
737 let peers = self.peers.read().unwrap();
738 peers.values().filter_map(|peer_mutex| {
739 let p = peer_mutex.lock().unwrap();
740 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
747 fn get_ephemeral_key(&self) -> SecretKey {
748 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
749 let counter = self.peer_counter.get_increment();
750 ephemeral_hash.input(&counter.to_le_bytes());
751 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
754 /// Indicates a new outbound connection has been established to a node with the given node_id
755 /// and an optional remote network address.
757 /// The remote network address adds the option to report a remote IP address back to a connecting
758 /// peer using the init message.
759 /// The user should pass the remote network address of the host they are connected to.
761 /// If an `Err` is returned here you must disconnect the connection immediately.
763 /// Returns a small number of bytes to send to the remote node (currently always 50).
765 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
766 /// [`socket_disconnected()`].
768 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
769 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
770 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
771 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
772 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
774 let mut peers = self.peers.write().unwrap();
775 if peers.insert(descriptor, Mutex::new(Peer {
776 channel_encryptor: peer_encryptor,
778 their_features: None,
779 their_net_address: remote_network_address,
781 pending_outbound_buffer: LinkedList::new(),
782 pending_outbound_buffer_first_msg_offset: 0,
783 gossip_broadcast_buffer: LinkedList::new(),
784 awaiting_write_event: false,
787 pending_read_buffer_pos: 0,
788 pending_read_is_header: false,
790 sync_status: InitSyncTracker::NoSyncRequested,
792 msgs_sent_since_pong: 0,
793 awaiting_pong_timer_tick_intervals: 0,
794 received_message_since_timer_tick: false,
795 sent_gossip_timestamp_filter: false,
797 panic!("PeerManager driver duplicated descriptors!");
802 /// Indicates a new inbound connection has been established to a node with an optional remote
805 /// The remote network address adds the option to report a remote IP address back to a connecting
806 /// peer using the init message.
807 /// The user should pass the remote network address of the host they are connected to.
809 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
810 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
811 /// the connection immediately.
813 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
814 /// [`socket_disconnected()`].
816 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
817 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
818 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
819 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
821 let mut peers = self.peers.write().unwrap();
822 if peers.insert(descriptor, Mutex::new(Peer {
823 channel_encryptor: peer_encryptor,
825 their_features: None,
826 their_net_address: remote_network_address,
828 pending_outbound_buffer: LinkedList::new(),
829 pending_outbound_buffer_first_msg_offset: 0,
830 gossip_broadcast_buffer: LinkedList::new(),
831 awaiting_write_event: false,
834 pending_read_buffer_pos: 0,
835 pending_read_is_header: false,
837 sync_status: InitSyncTracker::NoSyncRequested,
839 msgs_sent_since_pong: 0,
840 awaiting_pong_timer_tick_intervals: 0,
841 received_message_since_timer_tick: false,
842 sent_gossip_timestamp_filter: false,
844 panic!("PeerManager driver duplicated descriptors!");
849 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
850 while !peer.awaiting_write_event {
851 if peer.should_buffer_onion_message() {
852 if let Some(peer_node_id) = peer.their_node_id {
853 if let Some(next_onion_message) =
854 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
855 self.enqueue_message(peer, &next_onion_message);
859 if peer.should_buffer_gossip_broadcast() {
860 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
861 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(&msg[..]));
864 if peer.should_buffer_gossip_backfill() {
865 match peer.sync_status {
866 InitSyncTracker::NoSyncRequested => {},
867 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
868 if let Some((announce, update_a_option, update_b_option)) =
869 self.message_handler.route_handler.get_next_channel_announcement(c)
871 self.enqueue_message(peer, &announce);
872 if let Some(update_a) = update_a_option {
873 self.enqueue_message(peer, &update_a);
875 if let Some(update_b) = update_b_option {
876 self.enqueue_message(peer, &update_b);
878 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
880 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
883 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
884 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
885 self.enqueue_message(peer, &msg);
886 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
888 peer.sync_status = InitSyncTracker::NoSyncRequested;
891 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
892 InitSyncTracker::NodesSyncing(key) => {
893 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&key)) {
894 self.enqueue_message(peer, &msg);
895 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
897 peer.sync_status = InitSyncTracker::NoSyncRequested;
902 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
903 self.maybe_send_extra_ping(peer);
906 let next_buff = match peer.pending_outbound_buffer.front() {
911 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
912 let data_sent = descriptor.send_data(pending, peer.should_read());
913 peer.pending_outbound_buffer_first_msg_offset += data_sent;
914 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
915 peer.pending_outbound_buffer_first_msg_offset = 0;
916 peer.pending_outbound_buffer.pop_front();
918 peer.awaiting_write_event = true;
923 /// Indicates that there is room to write data to the given socket descriptor.
925 /// May return an Err to indicate that the connection should be closed.
927 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
928 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
929 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
930 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
933 /// [`send_data`]: SocketDescriptor::send_data
934 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
935 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
936 let peers = self.peers.read().unwrap();
937 match peers.get(descriptor) {
939 // This is most likely a simple race condition where the user found that the socket
940 // was writeable, then we told the user to `disconnect_socket()`, then they called
941 // this method. Return an error to make sure we get disconnected.
942 return Err(PeerHandleError { no_connection_possible: false });
944 Some(peer_mutex) => {
945 let mut peer = peer_mutex.lock().unwrap();
946 peer.awaiting_write_event = false;
947 self.do_attempt_write_data(descriptor, &mut peer);
953 /// Indicates that data was read from the given socket descriptor.
955 /// May return an Err to indicate that the connection should be closed.
957 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
958 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
959 /// [`send_data`] calls to handle responses.
961 /// If `Ok(true)` is returned, further read_events should not be triggered until a
962 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
965 /// [`send_data`]: SocketDescriptor::send_data
966 /// [`process_events`]: PeerManager::process_events
967 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
968 match self.do_read_event(peer_descriptor, data) {
971 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
972 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
978 /// Append a message to a peer's pending outbound/write buffer
979 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
980 if is_gossip_msg(message.type_id()) {
981 log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
983 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()))
985 peer.msgs_sent_since_pong += 1;
986 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
989 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
990 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: Vec<u8>) {
991 peer.msgs_sent_since_pong += 1;
992 peer.gossip_broadcast_buffer.push_back(encoded_message);
995 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
996 let mut pause_read = false;
997 let peers = self.peers.read().unwrap();
998 let mut msgs_to_forward = Vec::new();
999 let mut peer_node_id = None;
1000 match peers.get(peer_descriptor) {
1002 // This is most likely a simple race condition where the user read some bytes
1003 // from the socket, then we told the user to `disconnect_socket()`, then they
1004 // called this method. Return an error to make sure we get disconnected.
1005 return Err(PeerHandleError { no_connection_possible: false });
1007 Some(peer_mutex) => {
1008 let mut read_pos = 0;
1009 while read_pos < data.len() {
1010 macro_rules! try_potential_handleerror {
1011 ($peer: expr, $thing: expr) => {
1016 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
1017 //TODO: Try to push msg
1018 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1019 return Err(PeerHandleError{ no_connection_possible: false });
1021 msgs::ErrorAction::IgnoreAndLog(level) => {
1022 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1025 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1026 msgs::ErrorAction::IgnoreError => {
1027 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1030 msgs::ErrorAction::SendErrorMessage { msg } => {
1031 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1032 self.enqueue_message($peer, &msg);
1035 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1036 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1037 self.enqueue_message($peer, &msg);
1046 let mut peer_lock = peer_mutex.lock().unwrap();
1047 let peer = &mut *peer_lock;
1048 let mut msg_to_handle = None;
1049 if peer_node_id.is_none() {
1050 peer_node_id = peer.their_node_id.clone();
1053 assert!(peer.pending_read_buffer.len() > 0);
1054 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1057 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1058 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]);
1059 read_pos += data_to_copy;
1060 peer.pending_read_buffer_pos += data_to_copy;
1063 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1064 peer.pending_read_buffer_pos = 0;
1066 macro_rules! insert_node_id {
1068 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap()) {
1069 hash_map::Entry::Occupied(_) => {
1070 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
1071 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1072 return Err(PeerHandleError{ no_connection_possible: false })
1074 hash_map::Entry::Vacant(entry) => {
1075 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
1076 entry.insert(peer_descriptor.clone())
1082 let next_step = peer.channel_encryptor.get_noise_step();
1084 NextNoiseStep::ActOne => {
1085 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1086 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1087 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1088 peer.pending_outbound_buffer.push_back(act_two);
1089 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1091 NextNoiseStep::ActTwo => {
1092 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1093 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1094 &self.node_signer));
1095 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1096 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1097 peer.pending_read_is_header = true;
1099 peer.their_node_id = Some(their_node_id);
1101 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1102 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1103 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1104 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1105 self.enqueue_message(peer, &resp);
1106 peer.awaiting_pong_timer_tick_intervals = 0;
1108 NextNoiseStep::ActThree => {
1109 let their_node_id = try_potential_handleerror!(peer,
1110 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1111 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1112 peer.pending_read_is_header = true;
1113 peer.their_node_id = Some(their_node_id);
1115 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1116 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1117 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1118 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1119 self.enqueue_message(peer, &resp);
1120 peer.awaiting_pong_timer_tick_intervals = 0;
1122 NextNoiseStep::NoiseComplete => {
1123 if peer.pending_read_is_header {
1124 let msg_len = try_potential_handleerror!(peer,
1125 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1126 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1127 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1128 if msg_len < 2 { // Need at least the message type tag
1129 return Err(PeerHandleError{ no_connection_possible: false });
1131 peer.pending_read_is_header = false;
1133 let msg_data = try_potential_handleerror!(peer,
1134 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1135 assert!(msg_data.len() >= 2);
1137 // Reset read buffer
1138 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1139 peer.pending_read_buffer.resize(18, 0);
1140 peer.pending_read_is_header = true;
1142 let mut reader = io::Cursor::new(&msg_data[..]);
1143 let message_result = wire::read(&mut reader, &*self.custom_message_handler);
1144 let message = match message_result {
1148 // Note that to avoid recursion we never call
1149 // `do_attempt_write_data` from here, causing
1150 // the messages enqueued here to not actually
1151 // be sent before the peer is disconnected.
1152 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1153 log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1156 (msgs::DecodeError::UnsupportedCompression, _) => {
1157 log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1158 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1161 (_, Some(ty)) if is_gossip_msg(ty) => {
1162 log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1163 self.enqueue_message(peer, &msgs::WarningMessage {
1164 channel_id: [0; 32],
1165 data: format!("Unreadable/bogus gossip message of type {}", ty),
1169 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1170 log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1171 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1172 return Err(PeerHandleError { no_connection_possible: false });
1174 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { no_connection_possible: false }),
1175 (msgs::DecodeError::InvalidValue, _) => {
1176 log_debug!(self.logger, "Got an invalid value while deserializing message");
1177 return Err(PeerHandleError { no_connection_possible: false });
1179 (msgs::DecodeError::ShortRead, _) => {
1180 log_debug!(self.logger, "Deserialization failed due to shortness of message");
1181 return Err(PeerHandleError { no_connection_possible: false });
1183 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { no_connection_possible: false }),
1184 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { no_connection_possible: false }),
1189 msg_to_handle = Some(message);
1194 pause_read = !peer.should_read();
1196 if let Some(message) = msg_to_handle {
1197 match self.handle_message(&peer_mutex, peer_lock, message) {
1198 Err(handling_error) => match handling_error {
1199 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1200 MessageHandlingError::LightningError(e) => {
1201 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1205 msgs_to_forward.push(msg);
1214 for msg in msgs_to_forward.drain(..) {
1215 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref());
1221 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1222 /// Returns the message back if it needs to be broadcasted to all other peers.
1225 peer_mutex: &Mutex<Peer>,
1226 mut peer_lock: MutexGuard<Peer>,
1227 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1228 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1229 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages");
1230 peer_lock.received_message_since_timer_tick = true;
1232 // Need an Init as first message
1233 if let wire::Message::Init(msg) = message {
1234 if msg.features.requires_unknown_bits() {
1235 log_debug!(self.logger, "Peer features required unknown version bits");
1236 return Err(PeerHandleError{ no_connection_possible: true }.into());
1238 if peer_lock.their_features.is_some() {
1239 return Err(PeerHandleError{ no_connection_possible: false }.into());
1242 log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1244 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1245 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1246 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1249 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg) {
1250 log_debug!(self.logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1251 return Err(PeerHandleError{ no_connection_possible: true }.into());
1253 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg) {
1254 log_debug!(self.logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1255 return Err(PeerHandleError{ no_connection_possible: true }.into());
1257 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg) {
1258 log_debug!(self.logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1259 return Err(PeerHandleError{ no_connection_possible: true }.into());
1262 peer_lock.their_features = Some(msg.features);
1264 } else if peer_lock.their_features.is_none() {
1265 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1266 return Err(PeerHandleError{ no_connection_possible: false }.into());
1269 if let wire::Message::GossipTimestampFilter(_msg) = message {
1270 // When supporting gossip messages, start inital gossip sync only after we receive
1271 // a GossipTimestampFilter
1272 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1273 !peer_lock.sent_gossip_timestamp_filter {
1274 peer_lock.sent_gossip_timestamp_filter = true;
1275 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1280 mem::drop(peer_lock);
1282 if is_gossip_msg(message.type_id()) {
1283 log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1285 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1288 let mut should_forward = None;
1291 // Setup and Control messages:
1292 wire::Message::Init(_) => {
1295 wire::Message::GossipTimestampFilter(_) => {
1298 wire::Message::Error(msg) => {
1299 let mut data_is_printable = true;
1300 for b in msg.data.bytes() {
1301 if b < 32 || b > 126 {
1302 data_is_printable = false;
1307 if data_is_printable {
1308 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1310 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1312 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1313 if msg.channel_id == [0; 32] {
1314 return Err(PeerHandleError{ no_connection_possible: true }.into());
1317 wire::Message::Warning(msg) => {
1318 let mut data_is_printable = true;
1319 for b in msg.data.bytes() {
1320 if b < 32 || b > 126 {
1321 data_is_printable = false;
1326 if data_is_printable {
1327 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1329 log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1333 wire::Message::Ping(msg) => {
1334 if msg.ponglen < 65532 {
1335 let resp = msgs::Pong { byteslen: msg.ponglen };
1336 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1339 wire::Message::Pong(_msg) => {
1340 let mut peer_lock = peer_mutex.lock().unwrap();
1341 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1342 peer_lock.msgs_sent_since_pong = 0;
1345 // Channel messages:
1346 wire::Message::OpenChannel(msg) => {
1347 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1349 wire::Message::AcceptChannel(msg) => {
1350 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1353 wire::Message::FundingCreated(msg) => {
1354 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1356 wire::Message::FundingSigned(msg) => {
1357 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1359 wire::Message::ChannelReady(msg) => {
1360 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1363 wire::Message::Shutdown(msg) => {
1364 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1366 wire::Message::ClosingSigned(msg) => {
1367 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1370 // Commitment messages:
1371 wire::Message::UpdateAddHTLC(msg) => {
1372 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1374 wire::Message::UpdateFulfillHTLC(msg) => {
1375 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1377 wire::Message::UpdateFailHTLC(msg) => {
1378 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1380 wire::Message::UpdateFailMalformedHTLC(msg) => {
1381 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1384 wire::Message::CommitmentSigned(msg) => {
1385 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1387 wire::Message::RevokeAndACK(msg) => {
1388 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1390 wire::Message::UpdateFee(msg) => {
1391 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1393 wire::Message::ChannelReestablish(msg) => {
1394 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1397 // Routing messages:
1398 wire::Message::AnnouncementSignatures(msg) => {
1399 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1401 wire::Message::ChannelAnnouncement(msg) => {
1402 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1403 .map_err(|e| -> MessageHandlingError { e.into() })? {
1404 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1407 wire::Message::NodeAnnouncement(msg) => {
1408 if self.message_handler.route_handler.handle_node_announcement(&msg)
1409 .map_err(|e| -> MessageHandlingError { e.into() })? {
1410 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1413 wire::Message::ChannelUpdate(msg) => {
1414 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1415 if self.message_handler.route_handler.handle_channel_update(&msg)
1416 .map_err(|e| -> MessageHandlingError { e.into() })? {
1417 should_forward = Some(wire::Message::ChannelUpdate(msg));
1420 wire::Message::QueryShortChannelIds(msg) => {
1421 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1423 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1424 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1426 wire::Message::QueryChannelRange(msg) => {
1427 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1429 wire::Message::ReplyChannelRange(msg) => {
1430 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1434 wire::Message::OnionMessage(msg) => {
1435 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1438 // Unknown messages:
1439 wire::Message::Unknown(type_id) if message.is_even() => {
1440 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1441 // Fail the channel if message is an even, unknown type as per BOLT #1.
1442 return Err(PeerHandleError{ no_connection_possible: true }.into());
1444 wire::Message::Unknown(type_id) => {
1445 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1447 wire::Message::Custom(custom) => {
1448 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1454 fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1456 wire::Message::ChannelAnnouncement(ref msg) => {
1457 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1458 let encoded_msg = encode_msg!(msg);
1460 for (_, peer_mutex) in peers.iter() {
1461 let mut peer = peer_mutex.lock().unwrap();
1462 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1463 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1466 if peer.buffer_full_drop_gossip_broadcast() {
1467 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1470 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1471 peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1474 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1477 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1480 wire::Message::NodeAnnouncement(ref msg) => {
1481 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1482 let encoded_msg = encode_msg!(msg);
1484 for (_, peer_mutex) in peers.iter() {
1485 let mut peer = peer_mutex.lock().unwrap();
1486 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1487 !peer.should_forward_node_announcement(msg.contents.node_id) {
1490 if peer.buffer_full_drop_gossip_broadcast() {
1491 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1494 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1497 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1500 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1503 wire::Message::ChannelUpdate(ref msg) => {
1504 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1505 let encoded_msg = encode_msg!(msg);
1507 for (_, peer_mutex) in peers.iter() {
1508 let mut peer = peer_mutex.lock().unwrap();
1509 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1510 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1513 if peer.buffer_full_drop_gossip_broadcast() {
1514 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1517 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1520 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1523 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1527 /// Checks for any events generated by our handlers and processes them. Includes sending most
1528 /// response messages as well as messages generated by calls to handler functions directly (eg
1529 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1531 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1534 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1535 /// or one of the other clients provided in our language bindings.
1537 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1538 /// without doing any work. All available events that need handling will be handled before the
1539 /// other calls return.
1541 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1542 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1543 /// [`send_data`]: SocketDescriptor::send_data
1544 pub fn process_events(&self) {
1545 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1546 if _single_processor_lock.is_err() {
1547 // While we could wake the older sleeper here with a CV and make more even waiting
1548 // times, that would be a lot of overengineering for a simple "reduce total waiter
1550 match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1552 debug_assert!(val, "compare_exchange failed spuriously?");
1556 debug_assert!(!val, "compare_exchange succeeded spuriously?");
1557 // We're the only waiter, as the running process_events may have emptied the
1558 // pending events "long" ago and there are new events for us to process, wait until
1559 // its done and process any leftover events before returning.
1560 _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1561 self.blocked_event_processors.store(false, Ordering::Release);
1566 let mut peers_to_disconnect = HashMap::new();
1567 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1568 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1571 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1572 // buffer by doing things like announcing channels on another node. We should be willing to
1573 // drop optional-ish messages when send buffers get full!
1575 let peers_lock = self.peers.read().unwrap();
1576 let peers = &*peers_lock;
1577 macro_rules! get_peer_for_forwarding {
1578 ($node_id: expr) => {
1580 if peers_to_disconnect.get($node_id).is_some() {
1581 // If we've "disconnected" this peer, do not send to it.
1584 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1585 match descriptor_opt {
1586 Some(descriptor) => match peers.get(&descriptor) {
1587 Some(peer_mutex) => {
1588 let peer_lock = peer_mutex.lock().unwrap();
1589 if peer_lock.their_features.is_none() {
1595 debug_assert!(false, "Inconsistent peers set state!");
1606 for event in events_generated.drain(..) {
1608 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1609 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1610 log_pubkey!(node_id),
1611 log_bytes!(msg.temporary_channel_id));
1612 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1614 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1615 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1616 log_pubkey!(node_id),
1617 log_bytes!(msg.temporary_channel_id));
1618 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1620 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1621 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1622 log_pubkey!(node_id),
1623 log_bytes!(msg.temporary_channel_id),
1624 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1625 // TODO: If the peer is gone we should generate a DiscardFunding event
1626 // indicating to the wallet that they should just throw away this funding transaction
1627 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1629 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1630 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1631 log_pubkey!(node_id),
1632 log_bytes!(msg.channel_id));
1633 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1635 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1636 log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1637 log_pubkey!(node_id),
1638 log_bytes!(msg.channel_id));
1639 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1641 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1642 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1643 log_pubkey!(node_id),
1644 log_bytes!(msg.channel_id));
1645 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1647 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 } } => {
1648 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1649 log_pubkey!(node_id),
1650 update_add_htlcs.len(),
1651 update_fulfill_htlcs.len(),
1652 update_fail_htlcs.len(),
1653 log_bytes!(commitment_signed.channel_id));
1654 let mut peer = get_peer_for_forwarding!(node_id);
1655 for msg in update_add_htlcs {
1656 self.enqueue_message(&mut *peer, msg);
1658 for msg in update_fulfill_htlcs {
1659 self.enqueue_message(&mut *peer, msg);
1661 for msg in update_fail_htlcs {
1662 self.enqueue_message(&mut *peer, msg);
1664 for msg in update_fail_malformed_htlcs {
1665 self.enqueue_message(&mut *peer, msg);
1667 if let &Some(ref msg) = update_fee {
1668 self.enqueue_message(&mut *peer, msg);
1670 self.enqueue_message(&mut *peer, commitment_signed);
1672 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1673 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1674 log_pubkey!(node_id),
1675 log_bytes!(msg.channel_id));
1676 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1678 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1679 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1680 log_pubkey!(node_id),
1681 log_bytes!(msg.channel_id));
1682 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1684 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1685 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1686 log_pubkey!(node_id),
1687 log_bytes!(msg.channel_id));
1688 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1690 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1691 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1692 log_pubkey!(node_id),
1693 log_bytes!(msg.channel_id));
1694 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1696 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
1697 log_debug!(self.logger, "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
1698 log_pubkey!(node_id),
1699 msg.contents.short_channel_id);
1700 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1701 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
1703 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1704 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1705 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1706 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1707 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1710 match self.message_handler.route_handler.handle_channel_update(&update_msg) {
1711 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1712 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None),
1716 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1717 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1718 match self.message_handler.route_handler.handle_channel_update(&msg) {
1719 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1720 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1724 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1725 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1726 log_pubkey!(node_id), msg.contents.short_channel_id);
1727 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1729 MessageSendEvent::HandleError { ref node_id, ref action } => {
1731 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1732 // We do not have the peers write lock, so we just store that we're
1733 // about to disconenct the peer and do it after we finish
1734 // processing most messages.
1735 peers_to_disconnect.insert(*node_id, msg.clone());
1737 msgs::ErrorAction::IgnoreAndLog(level) => {
1738 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1740 msgs::ErrorAction::IgnoreDuplicateGossip => {},
1741 msgs::ErrorAction::IgnoreError => {
1742 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1744 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1745 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1746 log_pubkey!(node_id),
1748 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1750 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1751 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1752 log_pubkey!(node_id),
1754 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1758 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1759 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1761 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1762 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1764 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1765 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1766 log_pubkey!(node_id),
1767 msg.short_channel_ids.len(),
1769 msg.number_of_blocks,
1771 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1773 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1774 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1779 for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1780 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1781 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1784 for (descriptor, peer_mutex) in peers.iter() {
1785 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer_mutex.lock().unwrap());
1788 if !peers_to_disconnect.is_empty() {
1789 let mut peers_lock = self.peers.write().unwrap();
1790 let peers = &mut *peers_lock;
1791 for (node_id, msg) in peers_to_disconnect.drain() {
1792 // Note that since we are holding the peers *write* lock we can
1793 // remove from node_id_to_descriptor immediately (as no other
1794 // thread can be holding the peer lock if we have the global write
1797 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1798 if let Some(peer_mutex) = peers.remove(&descriptor) {
1799 if let Some(msg) = msg {
1800 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1801 log_pubkey!(node_id),
1803 let mut peer = peer_mutex.lock().unwrap();
1804 self.enqueue_message(&mut *peer, &msg);
1805 // This isn't guaranteed to work, but if there is enough free
1806 // room in the send buffer, put the error message there...
1807 self.do_attempt_write_data(&mut descriptor, &mut *peer);
1809 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1812 descriptor.disconnect_socket();
1813 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1814 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
1820 /// Indicates that the given socket descriptor's connection is now closed.
1821 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1822 self.disconnect_event_internal(descriptor, false);
1825 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1826 let mut peers = self.peers.write().unwrap();
1827 let peer_option = peers.remove(descriptor);
1830 // This is most likely a simple race condition where the user found that the socket
1831 // was disconnected, then we told the user to `disconnect_socket()`, then they
1832 // called this method. Either way we're disconnected, return.
1834 Some(peer_lock) => {
1835 let peer = peer_lock.lock().unwrap();
1836 if let Some(node_id) = peer.their_node_id {
1837 log_trace!(self.logger,
1838 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1839 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1840 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1841 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1842 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
1848 /// Disconnect a peer given its node id.
1850 /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1851 /// force-closing any channels we have with it.
1853 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1854 /// peer. Thus, be very careful about reentrancy issues.
1856 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1857 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1858 let mut peers_lock = self.peers.write().unwrap();
1859 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1860 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1861 peers_lock.remove(&descriptor);
1862 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1863 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
1864 descriptor.disconnect_socket();
1868 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1869 /// an indication that TCP sockets have stalled even if we weren't around to time them out
1870 /// using regular ping/pongs.
1871 pub fn disconnect_all_peers(&self) {
1872 let mut peers_lock = self.peers.write().unwrap();
1873 self.node_id_to_descriptor.lock().unwrap().clear();
1874 let peers = &mut *peers_lock;
1875 for (mut descriptor, peer) in peers.drain() {
1876 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1877 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1878 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1879 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
1881 descriptor.disconnect_socket();
1885 /// This is called when we're blocked on sending additional gossip messages until we receive a
1886 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1887 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1888 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1889 if peer.awaiting_pong_timer_tick_intervals == 0 {
1890 peer.awaiting_pong_timer_tick_intervals = -1;
1891 let ping = msgs::Ping {
1895 self.enqueue_message(peer, &ping);
1899 /// Send pings to each peer and disconnect those which did not respond to the last round of
1902 /// This may be called on any timescale you want, however, roughly once every ten seconds is
1903 /// preferred. The call rate determines both how often we send a ping to our peers and how much
1904 /// time they have to respond before we disconnect them.
1906 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1909 /// [`send_data`]: SocketDescriptor::send_data
1910 pub fn timer_tick_occurred(&self) {
1911 let mut descriptors_needing_disconnect = Vec::new();
1913 let peers_lock = self.peers.read().unwrap();
1915 for (descriptor, peer_mutex) in peers_lock.iter() {
1916 let mut peer = peer_mutex.lock().unwrap();
1917 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1918 // The peer needs to complete its handshake before we can exchange messages. We
1919 // give peers one timer tick to complete handshake, reusing
1920 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1921 // for handshake completion.
1922 if peer.awaiting_pong_timer_tick_intervals != 0 {
1923 descriptors_needing_disconnect.push(descriptor.clone());
1925 peer.awaiting_pong_timer_tick_intervals = 1;
1930 if peer.awaiting_pong_timer_tick_intervals == -1 {
1931 // Magic value set in `maybe_send_extra_ping`.
1932 peer.awaiting_pong_timer_tick_intervals = 1;
1933 peer.received_message_since_timer_tick = false;
1937 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
1938 || peer.awaiting_pong_timer_tick_intervals as u64 >
1939 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
1941 descriptors_needing_disconnect.push(descriptor.clone());
1944 peer.received_message_since_timer_tick = false;
1946 if peer.awaiting_pong_timer_tick_intervals > 0 {
1947 peer.awaiting_pong_timer_tick_intervals += 1;
1951 peer.awaiting_pong_timer_tick_intervals = 1;
1952 let ping = msgs::Ping {
1956 self.enqueue_message(&mut *peer, &ping);
1957 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer);
1961 if !descriptors_needing_disconnect.is_empty() {
1963 let mut peers_lock = self.peers.write().unwrap();
1964 for descriptor in descriptors_needing_disconnect.iter() {
1965 if let Some(peer) = peers_lock.remove(descriptor) {
1966 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1967 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1968 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1969 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1970 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
1976 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1977 descriptor.disconnect_socket();
1983 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1984 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
1985 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1987 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
1990 // ...by failing to compile if the number of addresses that would be half of a message is
1991 // smaller than 100:
1992 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
1994 /// Generates a signed node_announcement from the given arguments, sending it to all connected
1995 /// peers. Note that peers will likely ignore this message unless we have at least one public
1996 /// channel which has at least six confirmations on-chain.
1998 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
1999 /// node to humans. They carry no in-protocol meaning.
2001 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2002 /// accepts incoming connections. These will be included in the node_announcement, publicly
2003 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2004 /// addresses should likely contain only Tor Onion addresses.
2006 /// Panics if `addresses` is absurdly large (more than 100).
2008 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2009 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2010 if addresses.len() > 100 {
2011 panic!("More than half the message size was taken up by public addresses!");
2014 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2015 // addresses be sorted for future compatibility.
2016 addresses.sort_by_key(|addr| addr.get_id());
2018 let features = self.message_handler.chan_handler.provided_node_features()
2019 .or(self.message_handler.route_handler.provided_node_features())
2020 .or(self.message_handler.onion_message_handler.provided_node_features());
2021 let announcement = msgs::UnsignedNodeAnnouncement {
2023 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2024 node_id: self.node_signer.get_node_id(Recipient::Node).unwrap(),
2025 rgb, alias, addresses,
2026 excess_address_data: Vec::new(),
2027 excess_data: Vec::new(),
2029 let node_announce_sig = match self.node_signer.sign_gossip_message(
2030 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2034 log_error!(self.logger, "Failed to generate signature for node_announcement");
2039 let msg = msgs::NodeAnnouncement {
2040 signature: node_announce_sig,
2041 contents: announcement
2044 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2045 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2046 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2050 fn is_gossip_msg(type_id: u16) -> bool {
2052 msgs::ChannelAnnouncement::TYPE |
2053 msgs::ChannelUpdate::TYPE |
2054 msgs::NodeAnnouncement::TYPE |
2055 msgs::QueryChannelRange::TYPE |
2056 msgs::ReplyChannelRange::TYPE |
2057 msgs::QueryShortChannelIds::TYPE |
2058 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2065 use crate::chain::keysinterface::{NodeSigner, Recipient};
2066 use crate::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2067 use crate::ln::{msgs, wire};
2068 use crate::ln::msgs::NetAddress;
2069 use crate::util::events;
2070 use crate::util::test_utils;
2072 use bitcoin::secp256k1::SecretKey;
2074 use crate::prelude::*;
2075 use crate::sync::{Arc, Mutex};
2076 use core::sync::atomic::Ordering;
2079 struct FileDescriptor {
2081 outbound_data: Arc<Mutex<Vec<u8>>>,
2083 impl PartialEq for FileDescriptor {
2084 fn eq(&self, other: &Self) -> bool {
2088 impl Eq for FileDescriptor { }
2089 impl core::hash::Hash for FileDescriptor {
2090 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2091 self.fd.hash(hasher)
2095 impl SocketDescriptor for FileDescriptor {
2096 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2097 self.outbound_data.lock().unwrap().extend_from_slice(data);
2101 fn disconnect_socket(&mut self) {}
2104 struct PeerManagerCfg {
2105 chan_handler: test_utils::TestChannelMessageHandler,
2106 routing_handler: test_utils::TestRoutingMessageHandler,
2107 logger: test_utils::TestLogger,
2108 node_signer: test_utils::TestNodeSigner,
2111 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2112 let mut cfgs = Vec::new();
2113 for i in 0..peer_count {
2114 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2117 chan_handler: test_utils::TestChannelMessageHandler::new(),
2118 logger: test_utils::TestLogger::new(),
2119 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2120 node_signer: test_utils::TestNodeSigner::new(node_secret),
2128 fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler, &'a test_utils::TestNodeSigner>> {
2129 let mut peers = Vec::new();
2130 for i in 0..peer_count {
2131 let ephemeral_bytes = [i as u8; 32];
2132 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler, onion_message_handler: IgnoringMessageHandler {} };
2133 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {}, &cfgs[i].node_signer);
2140 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler, &'a test_utils::TestNodeSigner>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler, &'a test_utils::TestNodeSigner>) -> (FileDescriptor, FileDescriptor) {
2141 let a_id = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2142 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2143 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2144 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2145 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();
2146 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2147 peer_a.process_events();
2149 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2150 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2152 peer_b.process_events();
2153 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2154 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2156 peer_a.process_events();
2157 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2158 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2160 (fd_a.clone(), fd_b.clone())
2164 fn test_disconnect_peer() {
2165 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2166 // push a DisconnectPeer event to remove the node flagged by id
2167 let cfgs = create_peermgr_cfgs(2);
2168 let chan_handler = test_utils::TestChannelMessageHandler::new();
2169 let mut peers = create_network(2, &cfgs);
2170 establish_connection(&peers[0], &peers[1]);
2171 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2173 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2175 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2177 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2179 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
2180 peers[0].message_handler.chan_handler = &chan_handler;
2182 peers[0].process_events();
2183 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2187 fn test_send_simple_msg() {
2188 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2189 // push a message from one peer to another.
2190 let cfgs = create_peermgr_cfgs(2);
2191 let a_chan_handler = test_utils::TestChannelMessageHandler::new();
2192 let b_chan_handler = test_utils::TestChannelMessageHandler::new();
2193 let mut peers = create_network(2, &cfgs);
2194 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2195 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2197 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2199 let msg = msgs::Shutdown { channel_id: [42; 32], scriptpubkey: bitcoin::Script::new() };
2200 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2201 node_id: their_id, msg: msg.clone()
2203 peers[0].message_handler.chan_handler = &a_chan_handler;
2205 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2206 peers[1].message_handler.chan_handler = &b_chan_handler;
2208 peers[0].process_events();
2210 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2211 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2215 fn test_disconnect_all_peer() {
2216 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2217 // then calls disconnect_all_peers
2218 let cfgs = create_peermgr_cfgs(2);
2219 let peers = create_network(2, &cfgs);
2220 establish_connection(&peers[0], &peers[1]);
2221 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2223 peers[0].disconnect_all_peers();
2224 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2228 fn test_timer_tick_occurred() {
2229 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2230 let cfgs = create_peermgr_cfgs(2);
2231 let peers = create_network(2, &cfgs);
2232 establish_connection(&peers[0], &peers[1]);
2233 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2235 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2236 peers[0].timer_tick_occurred();
2237 peers[0].process_events();
2238 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2240 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2241 peers[0].timer_tick_occurred();
2242 peers[0].process_events();
2243 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2247 fn test_do_attempt_write_data() {
2248 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2249 let cfgs = create_peermgr_cfgs(2);
2250 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2251 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2252 let peers = create_network(2, &cfgs);
2254 // By calling establish_connect, we trigger do_attempt_write_data between
2255 // the peers. Previously this function would mistakenly enter an infinite loop
2256 // when there were more channel messages available than could fit into a peer's
2257 // buffer. This issue would now be detected by this test (because we use custom
2258 // RoutingMessageHandlers that intentionally return more channel messages
2259 // than can fit into a peer's buffer).
2260 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2262 // Make each peer to read the messages that the other peer just wrote to them. Note that
2263 // due to the max-message-before-ping limits this may take a few iterations to complete.
2264 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2265 peers[1].process_events();
2266 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2267 assert!(!a_read_data.is_empty());
2269 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2270 peers[0].process_events();
2272 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2273 assert!(!b_read_data.is_empty());
2274 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2276 peers[0].process_events();
2277 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2280 // Check that each peer has received the expected number of channel updates and channel
2282 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2283 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2284 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2285 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2289 fn test_handshake_timeout() {
2290 // Tests that we time out a peer still waiting on handshake completion after a full timer
2292 let cfgs = create_peermgr_cfgs(2);
2293 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2294 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2295 let peers = create_network(2, &cfgs);
2297 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2298 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2299 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2300 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2301 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2303 // If we get a single timer tick before completion, that's fine
2304 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2305 peers[0].timer_tick_occurred();
2306 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2308 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2309 peers[0].process_events();
2310 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2311 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2312 peers[1].process_events();
2314 // ...but if we get a second timer tick, we should disconnect the peer
2315 peers[0].timer_tick_occurred();
2316 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2318 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2319 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
2323 fn test_filter_addresses(){
2324 // Tests the filter_addresses function.
2327 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2328 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2329 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2330 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2331 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2332 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2335 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2336 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2337 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2338 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2339 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2340 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2343 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2344 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2345 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2346 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2347 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2348 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2351 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2352 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2353 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2354 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2355 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2356 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2359 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2360 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2361 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2362 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2363 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2364 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2367 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2368 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2369 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2370 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2371 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2372 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2375 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2376 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2377 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2378 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2379 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2380 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2382 // For (192.88.99/24)
2383 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2384 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2385 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2386 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2387 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2388 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2390 // For other IPv4 addresses
2391 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2392 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2393 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2394 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2395 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2396 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2399 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2400 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2401 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2402 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2403 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2404 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2406 // For other IPv6 addresses
2407 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2408 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2409 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2410 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2411 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2412 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2415 assert_eq!(filter_addresses(None), None);