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, NodeId};
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<&NodeId>) -> 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 {
84 fn processing_queue_high(&self) -> bool { false }
86 impl OnionMessageProvider for IgnoringMessageHandler {
87 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
89 impl OnionMessageHandler for IgnoringMessageHandler {
90 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
91 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) -> Result<(), ()> { Ok(()) }
92 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
93 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
94 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
98 impl CustomOnionMessageHandler for IgnoringMessageHandler {
99 type CustomMessage = Infallible;
100 fn handle_custom_message(&self, _msg: Infallible) {
101 // Since we always return `None` in the read the handle method should never be called.
104 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
109 impl CustomOnionMessageContents for Infallible {
110 fn tlv_type(&self) -> u64 { unreachable!(); }
113 impl Deref for IgnoringMessageHandler {
114 type Target = IgnoringMessageHandler;
115 fn deref(&self) -> &Self { self }
118 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
119 // method that takes self for it.
120 impl wire::Type for Infallible {
121 fn type_id(&self) -> u16 {
125 impl Writeable for Infallible {
126 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
131 impl wire::CustomMessageReader for IgnoringMessageHandler {
132 type CustomMessage = Infallible;
133 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
138 impl CustomMessageHandler for IgnoringMessageHandler {
139 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
140 // Since we always return `None` in the read the handle method should never be called.
144 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
147 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
148 /// You can provide one of these as the route_handler in a MessageHandler.
149 pub struct ErroringMessageHandler {
150 message_queue: Mutex<Vec<MessageSendEvent>>
152 impl ErroringMessageHandler {
153 /// Constructs a new ErroringMessageHandler
154 pub fn new() -> Self {
155 Self { message_queue: Mutex::new(Vec::new()) }
157 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
158 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
159 action: msgs::ErrorAction::SendErrorMessage {
160 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
162 node_id: node_id.clone(),
166 impl MessageSendEventsProvider for ErroringMessageHandler {
167 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
168 let mut res = Vec::new();
169 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
173 impl ChannelMessageHandler for ErroringMessageHandler {
174 // Any messages which are related to a specific channel generate an error message to let the
175 // peer know we don't care about channels.
176 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
177 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
179 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
180 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
182 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
183 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
185 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
186 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
188 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
189 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
191 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
192 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
194 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
195 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
197 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
198 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
200 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
201 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
203 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
204 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
206 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
207 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
209 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
210 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
212 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
213 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
215 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
216 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
218 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
219 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
221 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
222 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
224 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
225 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
226 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
227 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) -> Result<(), ()> { Ok(()) }
228 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
229 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
230 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
231 // Set a number of features which various nodes may require to talk to us. It's totally
232 // reasonable to indicate we "support" all kinds of channel features...we just reject all
234 let mut features = InitFeatures::empty();
235 features.set_data_loss_protect_optional();
236 features.set_upfront_shutdown_script_optional();
237 features.set_variable_length_onion_optional();
238 features.set_static_remote_key_optional();
239 features.set_payment_secret_optional();
240 features.set_basic_mpp_optional();
241 features.set_wumbo_optional();
242 features.set_shutdown_any_segwit_optional();
243 features.set_channel_type_optional();
244 features.set_scid_privacy_optional();
245 features.set_zero_conf_optional();
249 impl Deref for ErroringMessageHandler {
250 type Target = ErroringMessageHandler;
251 fn deref(&self) -> &Self { self }
254 /// Provides references to trait impls which handle different types of messages.
255 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref> where
256 CM::Target: ChannelMessageHandler,
257 RM::Target: RoutingMessageHandler,
258 OM::Target: OnionMessageHandler,
260 /// A message handler which handles messages specific to channels. Usually this is just a
261 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
263 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
264 pub chan_handler: CM,
265 /// A message handler which handles messages updating our knowledge of the network channel
266 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
268 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
269 pub route_handler: RM,
271 /// A message handler which handles onion messages. For now, this can only be an
272 /// [`IgnoringMessageHandler`].
273 pub onion_message_handler: OM,
276 /// Provides an object which can be used to send data to and which uniquely identifies a connection
277 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
278 /// implement Hash to meet the PeerManager API.
280 /// For efficiency, Clone should be relatively cheap for this type.
282 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
283 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
284 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
285 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
286 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
287 /// to simply use another value which is guaranteed to be globally unique instead.
288 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
289 /// Attempts to send some data from the given slice to the peer.
291 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
292 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
293 /// called and further write attempts may occur until that time.
295 /// If the returned size is smaller than `data.len()`, a
296 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
297 /// written. Additionally, until a `send_data` event completes fully, no further
298 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
299 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
302 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
303 /// (indicating that read events should be paused to prevent DoS in the send buffer),
304 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
305 /// `resume_read` of false carries no meaning, and should not cause any action.
306 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
307 /// Disconnect the socket pointed to by this SocketDescriptor.
309 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
310 /// call (doing so is a noop).
311 fn disconnect_socket(&mut self);
314 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
315 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
318 pub struct PeerHandleError {
319 /// Used to indicate that we probably can't make any future connections to this peer (e.g.
320 /// because we required features that our peer was missing, or vice versa).
322 /// While LDK's [`ChannelManager`] will not do it automatically, you likely wish to force-close
323 /// any channels with this peer or check for new versions of LDK.
325 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
326 pub no_connection_possible: bool,
328 impl fmt::Debug for PeerHandleError {
329 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
330 formatter.write_str("Peer Sent Invalid Data")
333 impl fmt::Display for PeerHandleError {
334 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
335 formatter.write_str("Peer Sent Invalid Data")
339 #[cfg(feature = "std")]
340 impl error::Error for PeerHandleError {
341 fn description(&self) -> &str {
342 "Peer Sent Invalid Data"
346 enum InitSyncTracker{
348 ChannelsSyncing(u64),
349 NodesSyncing(NodeId),
352 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
353 /// forwarding gossip messages to peers altogether.
354 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
356 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
357 /// we have fewer than this many messages in the outbound buffer again.
358 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
359 /// refilled as we send bytes.
360 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
361 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
363 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
365 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
366 /// the socket receive buffer before receiving the ping.
368 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
369 /// including any network delays, outbound traffic, or the same for messages from other peers.
371 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
372 /// per connected peer to respond to a ping, as long as they send us at least one message during
373 /// each tick, ensuring we aren't actually just disconnected.
374 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
377 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
378 /// two connected peers, assuming most LDK-running systems have at least two cores.
379 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
381 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
382 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
383 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
384 /// process before the next ping.
386 /// Note that we continue responding to other messages even after we've sent this many messages, so
387 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
388 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
389 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
392 channel_encryptor: PeerChannelEncryptor,
393 their_node_id: Option<PublicKey>,
394 their_features: Option<InitFeatures>,
395 their_net_address: Option<NetAddress>,
397 pending_outbound_buffer: LinkedList<Vec<u8>>,
398 pending_outbound_buffer_first_msg_offset: usize,
399 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
400 /// prioritize channel messages over them.
402 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
403 gossip_broadcast_buffer: LinkedList<Vec<u8>>,
404 awaiting_write_event: bool,
406 pending_read_buffer: Vec<u8>,
407 pending_read_buffer_pos: usize,
408 pending_read_is_header: bool,
410 sync_status: InitSyncTracker,
412 msgs_sent_since_pong: usize,
413 awaiting_pong_timer_tick_intervals: i8,
414 received_message_since_timer_tick: bool,
415 sent_gossip_timestamp_filter: bool,
417 /// Indicates we've received a `channel_announcement` since the last time we had
418 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
419 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
420 /// check if we're gossip-processing-backlogged).
421 received_channel_announce_since_backlogged: bool,
425 /// Returns true if the channel announcements/updates for the given channel should be
426 /// forwarded to this peer.
427 /// If we are sending our routing table to this peer and we have not yet sent channel
428 /// announcements/updates for the given channel_id then we will send it when we get to that
429 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
430 /// sent the old versions, we should send the update, and so return true here.
431 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
432 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
433 !self.sent_gossip_timestamp_filter {
436 match self.sync_status {
437 InitSyncTracker::NoSyncRequested => true,
438 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
439 InitSyncTracker::NodesSyncing(_) => true,
443 /// Similar to the above, but for node announcements indexed by node_id.
444 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
445 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
446 !self.sent_gossip_timestamp_filter {
449 match self.sync_status {
450 InitSyncTracker::NoSyncRequested => true,
451 InitSyncTracker::ChannelsSyncing(_) => false,
452 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
456 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
457 /// buffer still has space and we don't need to pause reads to get some writes out.
458 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
459 if !gossip_processing_backlogged {
460 self.received_channel_announce_since_backlogged = false;
462 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
463 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
466 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
467 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
468 fn should_buffer_gossip_backfill(&self) -> bool {
469 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
470 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
473 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
474 /// every time the peer's buffer may have been drained.
475 fn should_buffer_onion_message(&self) -> bool {
476 self.pending_outbound_buffer.is_empty()
477 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
480 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
481 /// buffer. This is checked every time the peer's buffer may have been drained.
482 fn should_buffer_gossip_broadcast(&self) -> bool {
483 self.pending_outbound_buffer.is_empty()
484 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
487 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
488 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
489 let total_outbound_buffered =
490 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
492 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
493 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
497 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
498 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
499 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
500 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
501 /// issues such as overly long function definitions.
503 /// (C-not exported) as `Arc`s don't make sense in bindings.
504 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>>;
506 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
507 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
508 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
509 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
510 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
511 /// helps with issues such as long function definitions.
513 /// (C-not exported) as general type aliases don't make sense in bindings.
514 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>;
516 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
517 /// socket events into messages which it passes on to its [`MessageHandler`].
519 /// Locks are taken internally, so you must never assume that reentrancy from a
520 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
522 /// Calls to [`read_event`] will decode relevant messages and pass them to the
523 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
524 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
525 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
526 /// calls only after previous ones have returned.
528 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
529 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
530 /// essentially you should default to using a SimpleRefPeerManager, and use a
531 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
532 /// you're using lightning-net-tokio.
534 /// [`read_event`]: PeerManager::read_event
535 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
536 CM::Target: ChannelMessageHandler,
537 RM::Target: RoutingMessageHandler,
538 OM::Target: OnionMessageHandler,
540 CMH::Target: CustomMessageHandler,
541 NS::Target: NodeSigner {
542 message_handler: MessageHandler<CM, RM, OM>,
543 /// Connection state for each connected peer - we have an outer read-write lock which is taken
544 /// as read while we're doing processing for a peer and taken write when a peer is being added
547 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
548 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
549 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
550 /// the `MessageHandler`s for a given peer is already guaranteed.
551 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
552 /// Only add to this set when noise completes.
553 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
554 /// lock held. Entries may be added with only the `peers` read lock held (though the
555 /// `Descriptor` value must already exist in `peers`).
556 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
557 /// We can only have one thread processing events at once, but we don't usually need the full
558 /// `peers` write lock to do so, so instead we block on this empty mutex when entering
559 /// `process_events`.
560 event_processing_lock: Mutex<()>,
561 /// Because event processing is global and always does all available work before returning,
562 /// there is no reason for us to have many event processors waiting on the lock at once.
563 /// Instead, we limit the total blocked event processors to always exactly one by setting this
564 /// when an event process call is waiting.
565 blocked_event_processors: AtomicBool,
567 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
568 /// value increases strictly since we don't assume access to a time source.
569 last_node_announcement_serial: AtomicU32,
571 ephemeral_key_midstate: Sha256Engine,
572 custom_message_handler: CMH,
574 peer_counter: AtomicCounter,
576 gossip_processing_backlogged: AtomicBool,
577 gossip_processing_backlog_lifted: AtomicBool,
582 secp_ctx: Secp256k1<secp256k1::SignOnly>
585 enum MessageHandlingError {
586 PeerHandleError(PeerHandleError),
587 LightningError(LightningError),
590 impl From<PeerHandleError> for MessageHandlingError {
591 fn from(error: PeerHandleError) -> Self {
592 MessageHandlingError::PeerHandleError(error)
596 impl From<LightningError> for MessageHandlingError {
597 fn from(error: LightningError) -> Self {
598 MessageHandlingError::LightningError(error)
602 macro_rules! encode_msg {
604 let mut buffer = VecWriter(Vec::new());
605 wire::write($msg, &mut buffer).unwrap();
610 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
611 CM::Target: ChannelMessageHandler,
612 OM::Target: OnionMessageHandler,
614 NS::Target: NodeSigner {
615 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
616 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
619 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
620 /// cryptographically secure random bytes.
622 /// `current_time` is used as an always-increasing counter that survives across restarts and is
623 /// incremented irregularly internally. In general it is best to simply use the current UNIX
624 /// timestamp, however if it is not available a persistent counter that increases once per
625 /// minute should suffice.
627 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
628 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 {
629 Self::new(MessageHandler {
630 chan_handler: channel_message_handler,
631 route_handler: IgnoringMessageHandler{},
632 onion_message_handler,
633 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
637 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
638 RM::Target: RoutingMessageHandler,
640 NS::Target: NodeSigner {
641 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
642 /// handler or onion message handler is used and onion and channel messages will be ignored (or
643 /// generate error messages). Note that some other lightning implementations time-out connections
644 /// after some time if no channel is built with the peer.
646 /// `current_time` is used as an always-increasing counter that survives across restarts and is
647 /// incremented irregularly internally. In general it is best to simply use the current UNIX
648 /// timestamp, however if it is not available a persistent counter that increases once per
649 /// minute should suffice.
651 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
652 /// cryptographically secure random bytes.
654 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
655 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
656 Self::new(MessageHandler {
657 chan_handler: ErroringMessageHandler::new(),
658 route_handler: routing_message_handler,
659 onion_message_handler: IgnoringMessageHandler{},
660 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
664 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
665 /// This works around `format!()` taking a reference to each argument, preventing
666 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
667 /// due to lifetime errors.
668 struct OptionalFromDebugger<'a>(&'a Option<PublicKey>);
669 impl core::fmt::Display for OptionalFromDebugger<'_> {
670 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
671 if let Some(node_id) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
675 /// A function used to filter out local or private addresses
676 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
677 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
678 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
680 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
681 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
682 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
683 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
684 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
685 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
686 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
687 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
688 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
689 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
690 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
691 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
692 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
693 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
694 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
695 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
696 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
697 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
698 // For remaining addresses
699 Some(NetAddress::IPv6{addr: _, port: _}) => None,
700 Some(..) => ip_address,
705 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
706 CM::Target: ChannelMessageHandler,
707 RM::Target: RoutingMessageHandler,
708 OM::Target: OnionMessageHandler,
710 CMH::Target: CustomMessageHandler,
711 NS::Target: NodeSigner
713 /// Constructs a new PeerManager with the given message handlers and node_id secret key
714 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
715 /// cryptographically secure random bytes.
717 /// `current_time` is used as an always-increasing counter that survives across restarts and is
718 /// incremented irregularly internally. In general it is best to simply use the current UNIX
719 /// timestamp, however if it is not available a persistent counter that increases once per
720 /// minute should suffice.
721 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 {
722 let mut ephemeral_key_midstate = Sha256::engine();
723 ephemeral_key_midstate.input(ephemeral_random_data);
725 let mut secp_ctx = Secp256k1::signing_only();
726 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
727 secp_ctx.seeded_randomize(&ephemeral_hash);
731 peers: FairRwLock::new(HashMap::new()),
732 node_id_to_descriptor: Mutex::new(HashMap::new()),
733 event_processing_lock: Mutex::new(()),
734 blocked_event_processors: AtomicBool::new(false),
735 ephemeral_key_midstate,
736 peer_counter: AtomicCounter::new(),
737 gossip_processing_backlogged: AtomicBool::new(false),
738 gossip_processing_backlog_lifted: AtomicBool::new(false),
739 last_node_announcement_serial: AtomicU32::new(current_time),
741 custom_message_handler,
747 /// Get the list of node ids for peers which have completed the initial handshake.
749 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
750 /// new_outbound_connection, however entries will only appear once the initial handshake has
751 /// completed and we are sure the remote peer has the private key for the given node_id.
752 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
753 let peers = self.peers.read().unwrap();
754 peers.values().filter_map(|peer_mutex| {
755 let p = peer_mutex.lock().unwrap();
756 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
763 fn get_ephemeral_key(&self) -> SecretKey {
764 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
765 let counter = self.peer_counter.get_increment();
766 ephemeral_hash.input(&counter.to_le_bytes());
767 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
770 /// Indicates a new outbound connection has been established to a node with the given node_id
771 /// and an optional remote network address.
773 /// The remote network address adds the option to report a remote IP address back to a connecting
774 /// peer using the init message.
775 /// The user should pass the remote network address of the host they are connected to.
777 /// If an `Err` is returned here you must disconnect the connection immediately.
779 /// Returns a small number of bytes to send to the remote node (currently always 50).
781 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
782 /// [`socket_disconnected()`].
784 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
785 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
786 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
787 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
788 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
790 let mut peers = self.peers.write().unwrap();
791 if peers.insert(descriptor, Mutex::new(Peer {
792 channel_encryptor: peer_encryptor,
794 their_features: None,
795 their_net_address: remote_network_address,
797 pending_outbound_buffer: LinkedList::new(),
798 pending_outbound_buffer_first_msg_offset: 0,
799 gossip_broadcast_buffer: LinkedList::new(),
800 awaiting_write_event: false,
803 pending_read_buffer_pos: 0,
804 pending_read_is_header: false,
806 sync_status: InitSyncTracker::NoSyncRequested,
808 msgs_sent_since_pong: 0,
809 awaiting_pong_timer_tick_intervals: 0,
810 received_message_since_timer_tick: false,
811 sent_gossip_timestamp_filter: false,
813 received_channel_announce_since_backlogged: false,
815 panic!("PeerManager driver duplicated descriptors!");
820 /// Indicates a new inbound connection has been established to a node with an optional remote
823 /// The remote network address adds the option to report a remote IP address back to a connecting
824 /// peer using the init message.
825 /// The user should pass the remote network address of the host they are connected to.
827 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
828 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
829 /// the connection immediately.
831 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
832 /// [`socket_disconnected()`].
834 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
835 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
836 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
837 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
839 let mut peers = self.peers.write().unwrap();
840 if peers.insert(descriptor, Mutex::new(Peer {
841 channel_encryptor: peer_encryptor,
843 their_features: None,
844 their_net_address: remote_network_address,
846 pending_outbound_buffer: LinkedList::new(),
847 pending_outbound_buffer_first_msg_offset: 0,
848 gossip_broadcast_buffer: LinkedList::new(),
849 awaiting_write_event: false,
852 pending_read_buffer_pos: 0,
853 pending_read_is_header: false,
855 sync_status: InitSyncTracker::NoSyncRequested,
857 msgs_sent_since_pong: 0,
858 awaiting_pong_timer_tick_intervals: 0,
859 received_message_since_timer_tick: false,
860 sent_gossip_timestamp_filter: false,
862 received_channel_announce_since_backlogged: false,
864 panic!("PeerManager driver duplicated descriptors!");
869 fn peer_should_read(&self, peer: &mut Peer) -> bool {
870 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
873 fn update_gossip_backlogged(&self) {
874 let new_state = self.message_handler.route_handler.processing_queue_high();
875 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
876 if prev_state && !new_state {
877 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
881 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
882 let mut have_written = false;
883 while !peer.awaiting_write_event {
884 if peer.should_buffer_onion_message() {
885 if let Some(peer_node_id) = peer.their_node_id {
886 if let Some(next_onion_message) =
887 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
888 self.enqueue_message(peer, &next_onion_message);
892 if peer.should_buffer_gossip_broadcast() {
893 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
894 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(&msg[..]));
897 if peer.should_buffer_gossip_backfill() {
898 match peer.sync_status {
899 InitSyncTracker::NoSyncRequested => {},
900 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
901 if let Some((announce, update_a_option, update_b_option)) =
902 self.message_handler.route_handler.get_next_channel_announcement(c)
904 self.enqueue_message(peer, &announce);
905 if let Some(update_a) = update_a_option {
906 self.enqueue_message(peer, &update_a);
908 if let Some(update_b) = update_b_option {
909 self.enqueue_message(peer, &update_b);
911 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
913 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
916 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
917 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
918 self.enqueue_message(peer, &msg);
919 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
921 peer.sync_status = InitSyncTracker::NoSyncRequested;
924 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
925 InitSyncTracker::NodesSyncing(sync_node_id) => {
926 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
927 self.enqueue_message(peer, &msg);
928 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
930 peer.sync_status = InitSyncTracker::NoSyncRequested;
935 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
936 self.maybe_send_extra_ping(peer);
939 let should_read = self.peer_should_read(peer);
940 let next_buff = match peer.pending_outbound_buffer.front() {
942 if force_one_write && !have_written {
944 let data_sent = descriptor.send_data(&[], should_read);
945 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
953 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
954 let data_sent = descriptor.send_data(pending, should_read);
956 peer.pending_outbound_buffer_first_msg_offset += data_sent;
957 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
958 peer.pending_outbound_buffer_first_msg_offset = 0;
959 peer.pending_outbound_buffer.pop_front();
961 peer.awaiting_write_event = true;
966 /// Indicates that there is room to write data to the given socket descriptor.
968 /// May return an Err to indicate that the connection should be closed.
970 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
971 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
972 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
973 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
976 /// [`send_data`]: SocketDescriptor::send_data
977 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
978 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
979 let peers = self.peers.read().unwrap();
980 match peers.get(descriptor) {
982 // This is most likely a simple race condition where the user found that the socket
983 // was writeable, then we told the user to `disconnect_socket()`, then they called
984 // this method. Return an error to make sure we get disconnected.
985 return Err(PeerHandleError { no_connection_possible: false });
987 Some(peer_mutex) => {
988 let mut peer = peer_mutex.lock().unwrap();
989 peer.awaiting_write_event = false;
990 self.do_attempt_write_data(descriptor, &mut peer, false);
996 /// Indicates that data was read from the given socket descriptor.
998 /// May return an Err to indicate that the connection should be closed.
1000 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1001 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1002 /// [`send_data`] calls to handle responses.
1004 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1005 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1008 /// [`send_data`]: SocketDescriptor::send_data
1009 /// [`process_events`]: PeerManager::process_events
1010 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1011 match self.do_read_event(peer_descriptor, data) {
1014 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
1015 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
1021 /// Append a message to a peer's pending outbound/write buffer
1022 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1023 if is_gossip_msg(message.type_id()) {
1024 log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
1026 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()))
1028 peer.msgs_sent_since_pong += 1;
1029 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1032 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1033 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: Vec<u8>) {
1034 peer.msgs_sent_since_pong += 1;
1035 peer.gossip_broadcast_buffer.push_back(encoded_message);
1038 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1039 let mut pause_read = false;
1040 let peers = self.peers.read().unwrap();
1041 let mut msgs_to_forward = Vec::new();
1042 let mut peer_node_id = None;
1043 match peers.get(peer_descriptor) {
1045 // This is most likely a simple race condition where the user read some bytes
1046 // from the socket, then we told the user to `disconnect_socket()`, then they
1047 // called this method. Return an error to make sure we get disconnected.
1048 return Err(PeerHandleError { no_connection_possible: false });
1050 Some(peer_mutex) => {
1051 let mut read_pos = 0;
1052 while read_pos < data.len() {
1053 macro_rules! try_potential_handleerror {
1054 ($peer: expr, $thing: expr) => {
1059 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
1060 //TODO: Try to push msg
1061 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1062 return Err(PeerHandleError{ no_connection_possible: false });
1064 msgs::ErrorAction::IgnoreAndLog(level) => {
1065 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1068 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1069 msgs::ErrorAction::IgnoreError => {
1070 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1073 msgs::ErrorAction::SendErrorMessage { msg } => {
1074 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1075 self.enqueue_message($peer, &msg);
1078 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1079 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1080 self.enqueue_message($peer, &msg);
1089 let mut peer_lock = peer_mutex.lock().unwrap();
1090 let peer = &mut *peer_lock;
1091 let mut msg_to_handle = None;
1092 if peer_node_id.is_none() {
1093 peer_node_id = peer.their_node_id.clone();
1096 assert!(peer.pending_read_buffer.len() > 0);
1097 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1100 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1101 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]);
1102 read_pos += data_to_copy;
1103 peer.pending_read_buffer_pos += data_to_copy;
1106 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1107 peer.pending_read_buffer_pos = 0;
1109 macro_rules! insert_node_id {
1111 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap()) {
1112 hash_map::Entry::Occupied(_) => {
1113 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
1114 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1115 return Err(PeerHandleError{ no_connection_possible: false })
1117 hash_map::Entry::Vacant(entry) => {
1118 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
1119 entry.insert(peer_descriptor.clone())
1125 let next_step = peer.channel_encryptor.get_noise_step();
1127 NextNoiseStep::ActOne => {
1128 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1129 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1130 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1131 peer.pending_outbound_buffer.push_back(act_two);
1132 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1134 NextNoiseStep::ActTwo => {
1135 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1136 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1137 &self.node_signer));
1138 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1139 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1140 peer.pending_read_is_header = true;
1142 peer.their_node_id = Some(their_node_id);
1144 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1145 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1146 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1147 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1148 self.enqueue_message(peer, &resp);
1149 peer.awaiting_pong_timer_tick_intervals = 0;
1151 NextNoiseStep::ActThree => {
1152 let their_node_id = try_potential_handleerror!(peer,
1153 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1154 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1155 peer.pending_read_is_header = true;
1156 peer.their_node_id = Some(their_node_id);
1158 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1159 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1160 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1161 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1162 self.enqueue_message(peer, &resp);
1163 peer.awaiting_pong_timer_tick_intervals = 0;
1165 NextNoiseStep::NoiseComplete => {
1166 if peer.pending_read_is_header {
1167 let msg_len = try_potential_handleerror!(peer,
1168 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1169 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1170 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1171 if msg_len < 2 { // Need at least the message type tag
1172 return Err(PeerHandleError{ no_connection_possible: false });
1174 peer.pending_read_is_header = false;
1176 let msg_data = try_potential_handleerror!(peer,
1177 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1178 assert!(msg_data.len() >= 2);
1180 // Reset read buffer
1181 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1182 peer.pending_read_buffer.resize(18, 0);
1183 peer.pending_read_is_header = true;
1185 let mut reader = io::Cursor::new(&msg_data[..]);
1186 let message_result = wire::read(&mut reader, &*self.custom_message_handler);
1187 let message = match message_result {
1191 // Note that to avoid recursion we never call
1192 // `do_attempt_write_data` from here, causing
1193 // the messages enqueued here to not actually
1194 // be sent before the peer is disconnected.
1195 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1196 log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1199 (msgs::DecodeError::UnsupportedCompression, _) => {
1200 log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1201 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1204 (_, Some(ty)) if is_gossip_msg(ty) => {
1205 log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1206 self.enqueue_message(peer, &msgs::WarningMessage {
1207 channel_id: [0; 32],
1208 data: format!("Unreadable/bogus gossip message of type {}", ty),
1212 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1213 log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1214 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1215 return Err(PeerHandleError { no_connection_possible: false });
1217 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { no_connection_possible: false }),
1218 (msgs::DecodeError::InvalidValue, _) => {
1219 log_debug!(self.logger, "Got an invalid value while deserializing message");
1220 return Err(PeerHandleError { no_connection_possible: false });
1222 (msgs::DecodeError::ShortRead, _) => {
1223 log_debug!(self.logger, "Deserialization failed due to shortness of message");
1224 return Err(PeerHandleError { no_connection_possible: false });
1226 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { no_connection_possible: false }),
1227 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { no_connection_possible: false }),
1232 msg_to_handle = Some(message);
1237 pause_read = !self.peer_should_read(peer);
1239 if let Some(message) = msg_to_handle {
1240 match self.handle_message(&peer_mutex, peer_lock, message) {
1241 Err(handling_error) => match handling_error {
1242 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1243 MessageHandlingError::LightningError(e) => {
1244 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1248 msgs_to_forward.push(msg);
1257 for msg in msgs_to_forward.drain(..) {
1258 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref());
1264 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1265 /// Returns the message back if it needs to be broadcasted to all other peers.
1268 peer_mutex: &Mutex<Peer>,
1269 mut peer_lock: MutexGuard<Peer>,
1270 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1271 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1272 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages");
1273 peer_lock.received_message_since_timer_tick = true;
1275 // Need an Init as first message
1276 if let wire::Message::Init(msg) = message {
1277 if msg.features.requires_unknown_bits() {
1278 log_debug!(self.logger, "Peer features required unknown version bits");
1279 return Err(PeerHandleError{ no_connection_possible: true }.into());
1281 if peer_lock.their_features.is_some() {
1282 return Err(PeerHandleError{ no_connection_possible: false }.into());
1285 log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1287 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1288 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1289 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1292 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg) {
1293 log_debug!(self.logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1294 return Err(PeerHandleError{ no_connection_possible: true }.into());
1296 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg) {
1297 log_debug!(self.logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1298 return Err(PeerHandleError{ no_connection_possible: true }.into());
1300 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg) {
1301 log_debug!(self.logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1302 return Err(PeerHandleError{ no_connection_possible: true }.into());
1305 peer_lock.their_features = Some(msg.features);
1307 } else if peer_lock.their_features.is_none() {
1308 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1309 return Err(PeerHandleError{ no_connection_possible: false }.into());
1312 if let wire::Message::GossipTimestampFilter(_msg) = message {
1313 // When supporting gossip messages, start inital gossip sync only after we receive
1314 // a GossipTimestampFilter
1315 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1316 !peer_lock.sent_gossip_timestamp_filter {
1317 peer_lock.sent_gossip_timestamp_filter = true;
1318 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1323 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1324 peer_lock.received_channel_announce_since_backlogged = true;
1327 mem::drop(peer_lock);
1329 if is_gossip_msg(message.type_id()) {
1330 log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1332 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1335 let mut should_forward = None;
1338 // Setup and Control messages:
1339 wire::Message::Init(_) => {
1342 wire::Message::GossipTimestampFilter(_) => {
1345 wire::Message::Error(msg) => {
1346 let mut data_is_printable = true;
1347 for b in msg.data.bytes() {
1348 if b < 32 || b > 126 {
1349 data_is_printable = false;
1354 if data_is_printable {
1355 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1357 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1359 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1360 if msg.channel_id == [0; 32] {
1361 return Err(PeerHandleError{ no_connection_possible: true }.into());
1364 wire::Message::Warning(msg) => {
1365 let mut data_is_printable = true;
1366 for b in msg.data.bytes() {
1367 if b < 32 || b > 126 {
1368 data_is_printable = false;
1373 if data_is_printable {
1374 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1376 log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1380 wire::Message::Ping(msg) => {
1381 if msg.ponglen < 65532 {
1382 let resp = msgs::Pong { byteslen: msg.ponglen };
1383 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1386 wire::Message::Pong(_msg) => {
1387 let mut peer_lock = peer_mutex.lock().unwrap();
1388 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1389 peer_lock.msgs_sent_since_pong = 0;
1392 // Channel messages:
1393 wire::Message::OpenChannel(msg) => {
1394 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1396 wire::Message::AcceptChannel(msg) => {
1397 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1400 wire::Message::FundingCreated(msg) => {
1401 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1403 wire::Message::FundingSigned(msg) => {
1404 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1406 wire::Message::ChannelReady(msg) => {
1407 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1410 wire::Message::Shutdown(msg) => {
1411 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1413 wire::Message::ClosingSigned(msg) => {
1414 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1417 // Commitment messages:
1418 wire::Message::UpdateAddHTLC(msg) => {
1419 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1421 wire::Message::UpdateFulfillHTLC(msg) => {
1422 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1424 wire::Message::UpdateFailHTLC(msg) => {
1425 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1427 wire::Message::UpdateFailMalformedHTLC(msg) => {
1428 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1431 wire::Message::CommitmentSigned(msg) => {
1432 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1434 wire::Message::RevokeAndACK(msg) => {
1435 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1437 wire::Message::UpdateFee(msg) => {
1438 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1440 wire::Message::ChannelReestablish(msg) => {
1441 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1444 // Routing messages:
1445 wire::Message::AnnouncementSignatures(msg) => {
1446 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1448 wire::Message::ChannelAnnouncement(msg) => {
1449 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1450 .map_err(|e| -> MessageHandlingError { e.into() })? {
1451 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1453 self.update_gossip_backlogged();
1455 wire::Message::NodeAnnouncement(msg) => {
1456 if self.message_handler.route_handler.handle_node_announcement(&msg)
1457 .map_err(|e| -> MessageHandlingError { e.into() })? {
1458 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1460 self.update_gossip_backlogged();
1462 wire::Message::ChannelUpdate(msg) => {
1463 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1464 if self.message_handler.route_handler.handle_channel_update(&msg)
1465 .map_err(|e| -> MessageHandlingError { e.into() })? {
1466 should_forward = Some(wire::Message::ChannelUpdate(msg));
1468 self.update_gossip_backlogged();
1470 wire::Message::QueryShortChannelIds(msg) => {
1471 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1473 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1474 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1476 wire::Message::QueryChannelRange(msg) => {
1477 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1479 wire::Message::ReplyChannelRange(msg) => {
1480 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1484 wire::Message::OnionMessage(msg) => {
1485 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1488 // Unknown messages:
1489 wire::Message::Unknown(type_id) if message.is_even() => {
1490 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1491 // Fail the channel if message is an even, unknown type as per BOLT #1.
1492 return Err(PeerHandleError{ no_connection_possible: true }.into());
1494 wire::Message::Unknown(type_id) => {
1495 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1497 wire::Message::Custom(custom) => {
1498 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1504 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>) {
1506 wire::Message::ChannelAnnouncement(ref msg) => {
1507 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1508 let encoded_msg = encode_msg!(msg);
1510 for (_, peer_mutex) in peers.iter() {
1511 let mut peer = peer_mutex.lock().unwrap();
1512 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1513 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1516 if peer.buffer_full_drop_gossip_broadcast() {
1517 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1520 if let Some(their_node_id) = peer.their_node_id {
1521 let their_node_id = NodeId::from_pubkey(&their_node_id);
1522 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1526 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1529 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1532 wire::Message::NodeAnnouncement(ref msg) => {
1533 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1534 let encoded_msg = encode_msg!(msg);
1536 for (_, peer_mutex) in peers.iter() {
1537 let mut peer = peer_mutex.lock().unwrap();
1538 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1539 !peer.should_forward_node_announcement(msg.contents.node_id) {
1542 if peer.buffer_full_drop_gossip_broadcast() {
1543 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1546 if let Some(their_node_id) = peer.their_node_id {
1547 if NodeId::from_pubkey(&their_node_id) == msg.contents.node_id {
1551 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1554 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1557 wire::Message::ChannelUpdate(ref msg) => {
1558 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1559 let encoded_msg = encode_msg!(msg);
1561 for (_, peer_mutex) in peers.iter() {
1562 let mut peer = peer_mutex.lock().unwrap();
1563 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1564 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1567 if peer.buffer_full_drop_gossip_broadcast() {
1568 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1571 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1574 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1577 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1581 /// Checks for any events generated by our handlers and processes them. Includes sending most
1582 /// response messages as well as messages generated by calls to handler functions directly (eg
1583 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1585 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1588 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1589 /// or one of the other clients provided in our language bindings.
1591 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1592 /// without doing any work. All available events that need handling will be handled before the
1593 /// other calls return.
1595 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1596 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1597 /// [`send_data`]: SocketDescriptor::send_data
1598 pub fn process_events(&self) {
1599 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1600 if _single_processor_lock.is_err() {
1601 // While we could wake the older sleeper here with a CV and make more even waiting
1602 // times, that would be a lot of overengineering for a simple "reduce total waiter
1604 match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1606 debug_assert!(val, "compare_exchange failed spuriously?");
1610 debug_assert!(!val, "compare_exchange succeeded spuriously?");
1611 // We're the only waiter, as the running process_events may have emptied the
1612 // pending events "long" ago and there are new events for us to process, wait until
1613 // its done and process any leftover events before returning.
1614 _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1615 self.blocked_event_processors.store(false, Ordering::Release);
1620 self.update_gossip_backlogged();
1621 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1623 let mut peers_to_disconnect = HashMap::new();
1624 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1625 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1628 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1629 // buffer by doing things like announcing channels on another node. We should be willing to
1630 // drop optional-ish messages when send buffers get full!
1632 let peers_lock = self.peers.read().unwrap();
1633 let peers = &*peers_lock;
1634 macro_rules! get_peer_for_forwarding {
1635 ($node_id: expr) => {
1637 if peers_to_disconnect.get($node_id).is_some() {
1638 // If we've "disconnected" this peer, do not send to it.
1641 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1642 match descriptor_opt {
1643 Some(descriptor) => match peers.get(&descriptor) {
1644 Some(peer_mutex) => {
1645 let peer_lock = peer_mutex.lock().unwrap();
1646 if peer_lock.their_features.is_none() {
1652 debug_assert!(false, "Inconsistent peers set state!");
1663 for event in events_generated.drain(..) {
1665 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1666 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1667 log_pubkey!(node_id),
1668 log_bytes!(msg.temporary_channel_id));
1669 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1671 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1672 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1673 log_pubkey!(node_id),
1674 log_bytes!(msg.temporary_channel_id));
1675 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1677 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1678 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1679 log_pubkey!(node_id),
1680 log_bytes!(msg.temporary_channel_id),
1681 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1682 // TODO: If the peer is gone we should generate a DiscardFunding event
1683 // indicating to the wallet that they should just throw away this funding transaction
1684 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1686 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1687 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1688 log_pubkey!(node_id),
1689 log_bytes!(msg.channel_id));
1690 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1692 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1693 log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1694 log_pubkey!(node_id),
1695 log_bytes!(msg.channel_id));
1696 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1698 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1699 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1700 log_pubkey!(node_id),
1701 log_bytes!(msg.channel_id));
1702 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1704 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 } } => {
1705 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1706 log_pubkey!(node_id),
1707 update_add_htlcs.len(),
1708 update_fulfill_htlcs.len(),
1709 update_fail_htlcs.len(),
1710 log_bytes!(commitment_signed.channel_id));
1711 let mut peer = get_peer_for_forwarding!(node_id);
1712 for msg in update_add_htlcs {
1713 self.enqueue_message(&mut *peer, msg);
1715 for msg in update_fulfill_htlcs {
1716 self.enqueue_message(&mut *peer, msg);
1718 for msg in update_fail_htlcs {
1719 self.enqueue_message(&mut *peer, msg);
1721 for msg in update_fail_malformed_htlcs {
1722 self.enqueue_message(&mut *peer, msg);
1724 if let &Some(ref msg) = update_fee {
1725 self.enqueue_message(&mut *peer, msg);
1727 self.enqueue_message(&mut *peer, commitment_signed);
1729 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1730 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1731 log_pubkey!(node_id),
1732 log_bytes!(msg.channel_id));
1733 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1735 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1736 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1737 log_pubkey!(node_id),
1738 log_bytes!(msg.channel_id));
1739 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1741 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1742 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1743 log_pubkey!(node_id),
1744 log_bytes!(msg.channel_id));
1745 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1747 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1748 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1749 log_pubkey!(node_id),
1750 log_bytes!(msg.channel_id));
1751 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1753 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
1754 log_debug!(self.logger, "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
1755 log_pubkey!(node_id),
1756 msg.contents.short_channel_id);
1757 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1758 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
1760 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1761 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1762 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1763 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1764 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1767 if let Some(msg) = update_msg {
1768 match self.message_handler.route_handler.handle_channel_update(&msg) {
1769 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1770 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1775 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1776 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1777 match self.message_handler.route_handler.handle_channel_update(&msg) {
1778 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1779 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1783 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1784 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
1785 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1786 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1787 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1791 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1792 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1793 log_pubkey!(node_id), msg.contents.short_channel_id);
1794 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1796 MessageSendEvent::HandleError { ref node_id, ref action } => {
1798 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1799 // We do not have the peers write lock, so we just store that we're
1800 // about to disconenct the peer and do it after we finish
1801 // processing most messages.
1802 peers_to_disconnect.insert(*node_id, msg.clone());
1804 msgs::ErrorAction::IgnoreAndLog(level) => {
1805 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1807 msgs::ErrorAction::IgnoreDuplicateGossip => {},
1808 msgs::ErrorAction::IgnoreError => {
1809 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1811 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1812 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1813 log_pubkey!(node_id),
1815 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1817 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1818 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1819 log_pubkey!(node_id),
1821 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1825 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1826 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1828 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1829 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1831 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1832 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1833 log_pubkey!(node_id),
1834 msg.short_channel_ids.len(),
1836 msg.number_of_blocks,
1838 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1840 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1841 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1846 for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1847 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1848 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1851 for (descriptor, peer_mutex) in peers.iter() {
1852 let mut peer = peer_mutex.lock().unwrap();
1853 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
1854 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
1857 if !peers_to_disconnect.is_empty() {
1858 let mut peers_lock = self.peers.write().unwrap();
1859 let peers = &mut *peers_lock;
1860 for (node_id, msg) in peers_to_disconnect.drain() {
1861 // Note that since we are holding the peers *write* lock we can
1862 // remove from node_id_to_descriptor immediately (as no other
1863 // thread can be holding the peer lock if we have the global write
1866 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1867 if let Some(peer_mutex) = peers.remove(&descriptor) {
1868 if let Some(msg) = msg {
1869 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1870 log_pubkey!(node_id),
1872 let mut peer = peer_mutex.lock().unwrap();
1873 self.enqueue_message(&mut *peer, &msg);
1874 // This isn't guaranteed to work, but if there is enough free
1875 // room in the send buffer, put the error message there...
1876 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
1878 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1881 descriptor.disconnect_socket();
1882 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1883 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
1889 /// Indicates that the given socket descriptor's connection is now closed.
1890 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1891 self.disconnect_event_internal(descriptor, false);
1894 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1895 let mut peers = self.peers.write().unwrap();
1896 let peer_option = peers.remove(descriptor);
1899 // This is most likely a simple race condition where the user found that the socket
1900 // was disconnected, then we told the user to `disconnect_socket()`, then they
1901 // called this method. Either way we're disconnected, return.
1903 Some(peer_lock) => {
1904 let peer = peer_lock.lock().unwrap();
1905 if let Some(node_id) = peer.their_node_id {
1906 log_trace!(self.logger,
1907 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1908 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1909 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1910 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1911 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
1917 /// Disconnect a peer given its node id.
1919 /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1920 /// force-closing any channels we have with it.
1922 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1923 /// peer. Thus, be very careful about reentrancy issues.
1925 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1926 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1927 let mut peers_lock = self.peers.write().unwrap();
1928 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1929 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1930 peers_lock.remove(&descriptor);
1931 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1932 self.message_handler.onion_message_handler.peer_disconnected(&node_id, no_connection_possible);
1933 descriptor.disconnect_socket();
1937 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1938 /// an indication that TCP sockets have stalled even if we weren't around to time them out
1939 /// using regular ping/pongs.
1940 pub fn disconnect_all_peers(&self) {
1941 let mut peers_lock = self.peers.write().unwrap();
1942 self.node_id_to_descriptor.lock().unwrap().clear();
1943 let peers = &mut *peers_lock;
1944 for (mut descriptor, peer) in peers.drain() {
1945 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1946 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1947 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1948 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
1950 descriptor.disconnect_socket();
1954 /// This is called when we're blocked on sending additional gossip messages until we receive a
1955 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1956 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1957 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1958 if peer.awaiting_pong_timer_tick_intervals == 0 {
1959 peer.awaiting_pong_timer_tick_intervals = -1;
1960 let ping = msgs::Ping {
1964 self.enqueue_message(peer, &ping);
1968 /// Send pings to each peer and disconnect those which did not respond to the last round of
1971 /// This may be called on any timescale you want, however, roughly once every ten seconds is
1972 /// preferred. The call rate determines both how often we send a ping to our peers and how much
1973 /// time they have to respond before we disconnect them.
1975 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1978 /// [`send_data`]: SocketDescriptor::send_data
1979 pub fn timer_tick_occurred(&self) {
1980 let mut descriptors_needing_disconnect = Vec::new();
1982 let peers_lock = self.peers.read().unwrap();
1984 self.update_gossip_backlogged();
1985 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1987 for (descriptor, peer_mutex) in peers_lock.iter() {
1988 let mut peer = peer_mutex.lock().unwrap();
1989 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
1991 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1992 // The peer needs to complete its handshake before we can exchange messages. We
1993 // give peers one timer tick to complete handshake, reusing
1994 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1995 // for handshake completion.
1996 if peer.awaiting_pong_timer_tick_intervals != 0 {
1997 descriptors_needing_disconnect.push(descriptor.clone());
1999 peer.awaiting_pong_timer_tick_intervals = 1;
2004 loop { // Used as a `goto` to skip writing a Ping message.
2005 if peer.awaiting_pong_timer_tick_intervals == -1 {
2006 // Magic value set in `maybe_send_extra_ping`.
2007 peer.awaiting_pong_timer_tick_intervals = 1;
2008 peer.received_message_since_timer_tick = false;
2012 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2013 || peer.awaiting_pong_timer_tick_intervals as u64 >
2014 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2016 descriptors_needing_disconnect.push(descriptor.clone());
2019 peer.received_message_since_timer_tick = false;
2021 if peer.awaiting_pong_timer_tick_intervals > 0 {
2022 peer.awaiting_pong_timer_tick_intervals += 1;
2026 peer.awaiting_pong_timer_tick_intervals = 1;
2027 let ping = msgs::Ping {
2031 self.enqueue_message(&mut *peer, &ping);
2034 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2038 if !descriptors_needing_disconnect.is_empty() {
2040 let mut peers_lock = self.peers.write().unwrap();
2041 for descriptor in descriptors_needing_disconnect.iter() {
2042 if let Some(peer) = peers_lock.remove(descriptor) {
2043 if let Some(node_id) = peer.lock().unwrap().their_node_id {
2044 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
2045 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2046 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
2047 self.message_handler.onion_message_handler.peer_disconnected(&node_id, false);
2053 for mut descriptor in descriptors_needing_disconnect.drain(..) {
2054 descriptor.disconnect_socket();
2060 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2061 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2062 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2064 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2067 // ...by failing to compile if the number of addresses that would be half of a message is
2068 // smaller than 100:
2069 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2071 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2072 /// peers. Note that peers will likely ignore this message unless we have at least one public
2073 /// channel which has at least six confirmations on-chain.
2075 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2076 /// node to humans. They carry no in-protocol meaning.
2078 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2079 /// accepts incoming connections. These will be included in the node_announcement, publicly
2080 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2081 /// addresses should likely contain only Tor Onion addresses.
2083 /// Panics if `addresses` is absurdly large (more than 100).
2085 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2086 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2087 if addresses.len() > 100 {
2088 panic!("More than half the message size was taken up by public addresses!");
2091 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2092 // addresses be sorted for future compatibility.
2093 addresses.sort_by_key(|addr| addr.get_id());
2095 let features = self.message_handler.chan_handler.provided_node_features()
2096 .or(self.message_handler.route_handler.provided_node_features())
2097 .or(self.message_handler.onion_message_handler.provided_node_features());
2098 let announcement = msgs::UnsignedNodeAnnouncement {
2100 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2101 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2102 rgb, alias, addresses,
2103 excess_address_data: Vec::new(),
2104 excess_data: Vec::new(),
2106 let node_announce_sig = match self.node_signer.sign_gossip_message(
2107 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2111 log_error!(self.logger, "Failed to generate signature for node_announcement");
2116 let msg = msgs::NodeAnnouncement {
2117 signature: node_announce_sig,
2118 contents: announcement
2121 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2122 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2123 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2127 fn is_gossip_msg(type_id: u16) -> bool {
2129 msgs::ChannelAnnouncement::TYPE |
2130 msgs::ChannelUpdate::TYPE |
2131 msgs::NodeAnnouncement::TYPE |
2132 msgs::QueryChannelRange::TYPE |
2133 msgs::ReplyChannelRange::TYPE |
2134 msgs::QueryShortChannelIds::TYPE |
2135 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2142 use crate::chain::keysinterface::{NodeSigner, Recipient};
2143 use crate::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2144 use crate::ln::{msgs, wire};
2145 use crate::ln::msgs::NetAddress;
2146 use crate::util::events;
2147 use crate::util::test_utils;
2149 use bitcoin::secp256k1::SecretKey;
2151 use crate::prelude::*;
2152 use crate::sync::{Arc, Mutex};
2153 use core::sync::atomic::Ordering;
2156 struct FileDescriptor {
2158 outbound_data: Arc<Mutex<Vec<u8>>>,
2160 impl PartialEq for FileDescriptor {
2161 fn eq(&self, other: &Self) -> bool {
2165 impl Eq for FileDescriptor { }
2166 impl core::hash::Hash for FileDescriptor {
2167 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2168 self.fd.hash(hasher)
2172 impl SocketDescriptor for FileDescriptor {
2173 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2174 self.outbound_data.lock().unwrap().extend_from_slice(data);
2178 fn disconnect_socket(&mut self) {}
2181 struct PeerManagerCfg {
2182 chan_handler: test_utils::TestChannelMessageHandler,
2183 routing_handler: test_utils::TestRoutingMessageHandler,
2184 logger: test_utils::TestLogger,
2185 node_signer: test_utils::TestNodeSigner,
2188 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2189 let mut cfgs = Vec::new();
2190 for i in 0..peer_count {
2191 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2194 chan_handler: test_utils::TestChannelMessageHandler::new(),
2195 logger: test_utils::TestLogger::new(),
2196 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2197 node_signer: test_utils::TestNodeSigner::new(node_secret),
2205 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>> {
2206 let mut peers = Vec::new();
2207 for i in 0..peer_count {
2208 let ephemeral_bytes = [i as u8; 32];
2209 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler, onion_message_handler: IgnoringMessageHandler {} };
2210 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {}, &cfgs[i].node_signer);
2217 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) {
2218 let a_id = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2219 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2220 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2221 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2222 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();
2223 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2224 peer_a.process_events();
2226 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2227 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2229 peer_b.process_events();
2230 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2231 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2233 peer_a.process_events();
2234 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2235 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2237 (fd_a.clone(), fd_b.clone())
2241 fn test_disconnect_peer() {
2242 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2243 // push a DisconnectPeer event to remove the node flagged by id
2244 let cfgs = create_peermgr_cfgs(2);
2245 let chan_handler = test_utils::TestChannelMessageHandler::new();
2246 let mut peers = create_network(2, &cfgs);
2247 establish_connection(&peers[0], &peers[1]);
2248 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2250 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2252 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2254 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2256 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
2257 peers[0].message_handler.chan_handler = &chan_handler;
2259 peers[0].process_events();
2260 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2264 fn test_send_simple_msg() {
2265 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2266 // push a message from one peer to another.
2267 let cfgs = create_peermgr_cfgs(2);
2268 let a_chan_handler = test_utils::TestChannelMessageHandler::new();
2269 let b_chan_handler = test_utils::TestChannelMessageHandler::new();
2270 let mut peers = create_network(2, &cfgs);
2271 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2272 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2274 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2276 let msg = msgs::Shutdown { channel_id: [42; 32], scriptpubkey: bitcoin::Script::new() };
2277 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2278 node_id: their_id, msg: msg.clone()
2280 peers[0].message_handler.chan_handler = &a_chan_handler;
2282 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2283 peers[1].message_handler.chan_handler = &b_chan_handler;
2285 peers[0].process_events();
2287 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2288 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2292 fn test_disconnect_all_peer() {
2293 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2294 // then calls disconnect_all_peers
2295 let cfgs = create_peermgr_cfgs(2);
2296 let peers = create_network(2, &cfgs);
2297 establish_connection(&peers[0], &peers[1]);
2298 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2300 peers[0].disconnect_all_peers();
2301 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2305 fn test_timer_tick_occurred() {
2306 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2307 let cfgs = create_peermgr_cfgs(2);
2308 let peers = create_network(2, &cfgs);
2309 establish_connection(&peers[0], &peers[1]);
2310 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2312 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2313 peers[0].timer_tick_occurred();
2314 peers[0].process_events();
2315 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2317 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2318 peers[0].timer_tick_occurred();
2319 peers[0].process_events();
2320 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2324 fn test_do_attempt_write_data() {
2325 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2326 let cfgs = create_peermgr_cfgs(2);
2327 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2328 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2329 let peers = create_network(2, &cfgs);
2331 // By calling establish_connect, we trigger do_attempt_write_data between
2332 // the peers. Previously this function would mistakenly enter an infinite loop
2333 // when there were more channel messages available than could fit into a peer's
2334 // buffer. This issue would now be detected by this test (because we use custom
2335 // RoutingMessageHandlers that intentionally return more channel messages
2336 // than can fit into a peer's buffer).
2337 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2339 // Make each peer to read the messages that the other peer just wrote to them. Note that
2340 // due to the max-message-before-ping limits this may take a few iterations to complete.
2341 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2342 peers[1].process_events();
2343 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2344 assert!(!a_read_data.is_empty());
2346 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2347 peers[0].process_events();
2349 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2350 assert!(!b_read_data.is_empty());
2351 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2353 peers[0].process_events();
2354 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2357 // Check that each peer has received the expected number of channel updates and channel
2359 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2360 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2361 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2362 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2366 fn test_handshake_timeout() {
2367 // Tests that we time out a peer still waiting on handshake completion after a full timer
2369 let cfgs = create_peermgr_cfgs(2);
2370 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2371 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2372 let peers = create_network(2, &cfgs);
2374 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2375 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2376 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2377 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2378 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2380 // If we get a single timer tick before completion, that's fine
2381 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2382 peers[0].timer_tick_occurred();
2383 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2385 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2386 peers[0].process_events();
2387 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2388 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2389 peers[1].process_events();
2391 // ...but if we get a second timer tick, we should disconnect the peer
2392 peers[0].timer_tick_occurred();
2393 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2395 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2396 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
2400 fn test_filter_addresses(){
2401 // Tests the filter_addresses function.
2404 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2405 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2406 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2407 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2408 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2409 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2412 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2413 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2414 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2415 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2416 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2417 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2420 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2421 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2422 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2423 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2424 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2425 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2428 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2429 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2430 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2431 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2432 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2433 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2436 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2437 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2438 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2439 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2440 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2441 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2444 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2445 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2446 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2447 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2448 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2449 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2452 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2453 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2454 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2455 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2456 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2457 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2459 // For (192.88.99/24)
2460 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2461 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2462 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2463 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2464 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2465 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2467 // For other IPv4 addresses
2468 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2469 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2470 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2471 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2472 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2473 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2476 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2477 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2478 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2479 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2480 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2481 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2483 // For other IPv6 addresses
2484 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2485 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2486 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2487 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2488 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2489 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2492 assert_eq!(filter_addresses(None), None);