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::sign::{KeysManager, NodeSigner, Recipient};
21 use crate::events::{MessageSendEvent, MessageSendEventsProvider, OnionMessageProvider};
22 use crate::ln::features::{InitFeatures, NodeFeatures};
24 use crate::ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, OnionMessageHandler, RoutingMessageHandler};
25 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
26 use crate::util::ser::{VecWriter, Writeable, Writer};
27 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
29 use crate::ln::wire::Encode;
30 use crate::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
31 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, NodeAlias};
32 use crate::util::atomic_counter::AtomicCounter;
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 /// A handler provided to [`PeerManager`] for reading and handling custom messages.
51 /// [BOLT 1] specifies a custom message type range for use with experimental or application-specific
52 /// messages. `CustomMessageHandler` allows for user-defined handling of such types. See the
53 /// [`lightning_custom_message`] crate for tools useful in composing more than one custom handler.
55 /// [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
56 /// [`lightning_custom_message`]: https://docs.rs/lightning_custom_message/latest/lightning_custom_message
57 pub trait CustomMessageHandler: wire::CustomMessageReader {
58 /// Handles the given message sent from `sender_node_id`, possibly producing messages for
59 /// [`CustomMessageHandler::get_and_clear_pending_msg`] to return and thus for [`PeerManager`]
61 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
63 /// Returns the list of pending messages that were generated by the handler, clearing the list
64 /// in the process. Each message is paired with the node id of the intended recipient. If no
65 /// connection to the node exists, then the message is simply not sent.
66 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
68 /// Gets the node feature flags which this handler itself supports. All available handlers are
69 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
70 /// which are broadcasted in our [`NodeAnnouncement`] message.
72 /// [`NodeAnnouncement`]: crate::ln::msgs::NodeAnnouncement
73 fn provided_node_features(&self) -> NodeFeatures;
75 /// Gets the init feature flags which should be sent to the given peer. All available handlers
76 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
77 /// which are sent in our [`Init`] message.
79 /// [`Init`]: crate::ln::msgs::Init
80 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
83 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
84 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
85 pub struct IgnoringMessageHandler{}
86 impl MessageSendEventsProvider for IgnoringMessageHandler {
87 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
89 impl RoutingMessageHandler for IgnoringMessageHandler {
90 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
91 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
92 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
93 fn get_next_channel_announcement(&self, _starting_point: u64) ->
94 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
95 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
96 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
97 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
98 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
99 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
100 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
101 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
102 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
103 InitFeatures::empty()
105 fn processing_queue_high(&self) -> bool { false }
107 impl OnionMessageProvider for IgnoringMessageHandler {
108 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
110 impl OnionMessageHandler for IgnoringMessageHandler {
111 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
112 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
113 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
114 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
115 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
116 InitFeatures::empty()
119 impl CustomOnionMessageHandler for IgnoringMessageHandler {
120 type CustomMessage = Infallible;
121 fn handle_custom_message(&self, _msg: Infallible) {
122 // Since we always return `None` in the read the handle method should never be called.
125 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
130 impl CustomOnionMessageContents for Infallible {
131 fn tlv_type(&self) -> u64 { unreachable!(); }
134 impl Deref for IgnoringMessageHandler {
135 type Target = IgnoringMessageHandler;
136 fn deref(&self) -> &Self { self }
139 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
140 // method that takes self for it.
141 impl wire::Type for Infallible {
142 fn type_id(&self) -> u16 {
146 impl Writeable for Infallible {
147 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
152 impl wire::CustomMessageReader for IgnoringMessageHandler {
153 type CustomMessage = Infallible;
154 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
159 impl CustomMessageHandler for IgnoringMessageHandler {
160 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
161 // Since we always return `None` in the read the handle method should never be called.
165 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
167 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
169 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
170 InitFeatures::empty()
174 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
175 /// You can provide one of these as the route_handler in a MessageHandler.
176 pub struct ErroringMessageHandler {
177 message_queue: Mutex<Vec<MessageSendEvent>>
179 impl ErroringMessageHandler {
180 /// Constructs a new ErroringMessageHandler
181 pub fn new() -> Self {
182 Self { message_queue: Mutex::new(Vec::new()) }
184 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
185 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
186 action: msgs::ErrorAction::SendErrorMessage {
187 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
189 node_id: node_id.clone(),
193 impl MessageSendEventsProvider for ErroringMessageHandler {
194 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
195 let mut res = Vec::new();
196 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
200 impl ChannelMessageHandler for ErroringMessageHandler {
201 // Any messages which are related to a specific channel generate an error message to let the
202 // peer know we don't care about channels.
203 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
204 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
206 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
207 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
209 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
210 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
212 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
213 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
215 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
216 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
218 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
219 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
221 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
222 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
224 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
225 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
227 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
228 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
230 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
231 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
233 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
234 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
236 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
237 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
239 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
240 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
242 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
243 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
245 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
246 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
248 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
249 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
251 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
252 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
253 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
254 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
255 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
256 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
257 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
258 // Set a number of features which various nodes may require to talk to us. It's totally
259 // reasonable to indicate we "support" all kinds of channel features...we just reject all
261 let mut features = InitFeatures::empty();
262 features.set_data_loss_protect_optional();
263 features.set_upfront_shutdown_script_optional();
264 features.set_variable_length_onion_optional();
265 features.set_static_remote_key_optional();
266 features.set_payment_secret_optional();
267 features.set_basic_mpp_optional();
268 features.set_wumbo_optional();
269 features.set_shutdown_any_segwit_optional();
270 features.set_channel_type_optional();
271 features.set_scid_privacy_optional();
272 features.set_zero_conf_optional();
276 impl Deref for ErroringMessageHandler {
277 type Target = ErroringMessageHandler;
278 fn deref(&self) -> &Self { self }
281 /// Provides references to trait impls which handle different types of messages.
282 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref, CustomM: Deref> where
283 CM::Target: ChannelMessageHandler,
284 RM::Target: RoutingMessageHandler,
285 OM::Target: OnionMessageHandler,
286 CustomM::Target: CustomMessageHandler,
288 /// A message handler which handles messages specific to channels. Usually this is just a
289 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
291 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
292 pub chan_handler: CM,
293 /// A message handler which handles messages updating our knowledge of the network channel
294 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
296 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
297 pub route_handler: RM,
299 /// A message handler which handles onion messages. This should generally be an
300 /// [`OnionMessenger`], but can also be an [`IgnoringMessageHandler`].
302 /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
303 pub onion_message_handler: OM,
305 /// A message handler which handles custom messages. The only LDK-provided implementation is
306 /// [`IgnoringMessageHandler`].
307 pub custom_message_handler: CustomM,
310 /// Provides an object which can be used to send data to and which uniquely identifies a connection
311 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
312 /// implement Hash to meet the PeerManager API.
314 /// For efficiency, [`Clone`] should be relatively cheap for this type.
316 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
317 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
318 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
319 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
320 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
321 /// to simply use another value which is guaranteed to be globally unique instead.
322 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
323 /// Attempts to send some data from the given slice to the peer.
325 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
326 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
327 /// called and further write attempts may occur until that time.
329 /// If the returned size is smaller than `data.len()`, a
330 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
331 /// written. Additionally, until a `send_data` event completes fully, no further
332 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
333 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
336 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
337 /// (indicating that read events should be paused to prevent DoS in the send buffer),
338 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
339 /// `resume_read` of false carries no meaning, and should not cause any action.
340 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
341 /// Disconnect the socket pointed to by this SocketDescriptor.
343 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
344 /// call (doing so is a noop).
345 fn disconnect_socket(&mut self);
348 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
349 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
352 pub struct PeerHandleError { }
353 impl fmt::Debug for PeerHandleError {
354 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
355 formatter.write_str("Peer Sent Invalid Data")
358 impl fmt::Display for PeerHandleError {
359 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
360 formatter.write_str("Peer Sent Invalid Data")
364 #[cfg(feature = "std")]
365 impl error::Error for PeerHandleError {
366 fn description(&self) -> &str {
367 "Peer Sent Invalid Data"
371 enum InitSyncTracker{
373 ChannelsSyncing(u64),
374 NodesSyncing(NodeId),
377 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
378 /// forwarding gossip messages to peers altogether.
379 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
381 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
382 /// we have fewer than this many messages in the outbound buffer again.
383 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
384 /// refilled as we send bytes.
385 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
386 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
388 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
390 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
391 /// the socket receive buffer before receiving the ping.
393 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
394 /// including any network delays, outbound traffic, or the same for messages from other peers.
396 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
397 /// per connected peer to respond to a ping, as long as they send us at least one message during
398 /// each tick, ensuring we aren't actually just disconnected.
399 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
402 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
403 /// two connected peers, assuming most LDK-running systems have at least two cores.
404 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
406 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
407 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
408 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
409 /// process before the next ping.
411 /// Note that we continue responding to other messages even after we've sent this many messages, so
412 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
413 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
414 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
417 channel_encryptor: PeerChannelEncryptor,
418 /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
419 /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
420 their_node_id: Option<(PublicKey, NodeId)>,
421 /// The features provided in the peer's [`msgs::Init`] message.
423 /// This is set only after we've processed the [`msgs::Init`] message and called relevant
424 /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
425 /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
427 their_features: Option<InitFeatures>,
428 their_net_address: Option<NetAddress>,
430 pending_outbound_buffer: LinkedList<Vec<u8>>,
431 pending_outbound_buffer_first_msg_offset: usize,
432 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
433 /// prioritize channel messages over them.
435 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
436 gossip_broadcast_buffer: LinkedList<Vec<u8>>,
437 awaiting_write_event: bool,
439 pending_read_buffer: Vec<u8>,
440 pending_read_buffer_pos: usize,
441 pending_read_is_header: bool,
443 sync_status: InitSyncTracker,
445 msgs_sent_since_pong: usize,
446 awaiting_pong_timer_tick_intervals: i64,
447 received_message_since_timer_tick: bool,
448 sent_gossip_timestamp_filter: bool,
450 /// Indicates we've received a `channel_announcement` since the last time we had
451 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
452 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
453 /// check if we're gossip-processing-backlogged).
454 received_channel_announce_since_backlogged: bool,
456 inbound_connection: bool,
460 /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
461 /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
463 fn handshake_complete(&self) -> bool {
464 self.their_features.is_some()
467 /// Returns true if the channel announcements/updates for the given channel should be
468 /// forwarded to this peer.
469 /// If we are sending our routing table to this peer and we have not yet sent channel
470 /// announcements/updates for the given channel_id then we will send it when we get to that
471 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
472 /// sent the old versions, we should send the update, and so return true here.
473 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
474 if !self.handshake_complete() { return false; }
475 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
476 !self.sent_gossip_timestamp_filter {
479 match self.sync_status {
480 InitSyncTracker::NoSyncRequested => true,
481 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
482 InitSyncTracker::NodesSyncing(_) => true,
486 /// Similar to the above, but for node announcements indexed by node_id.
487 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
488 if !self.handshake_complete() { return false; }
489 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
490 !self.sent_gossip_timestamp_filter {
493 match self.sync_status {
494 InitSyncTracker::NoSyncRequested => true,
495 InitSyncTracker::ChannelsSyncing(_) => false,
496 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
500 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
501 /// buffer still has space and we don't need to pause reads to get some writes out.
502 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
503 if !gossip_processing_backlogged {
504 self.received_channel_announce_since_backlogged = false;
506 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
507 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
510 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
511 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
512 fn should_buffer_gossip_backfill(&self) -> bool {
513 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
514 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
515 && self.handshake_complete()
518 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
519 /// every time the peer's buffer may have been drained.
520 fn should_buffer_onion_message(&self) -> bool {
521 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
522 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
525 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
526 /// buffer. This is checked every time the peer's buffer may have been drained.
527 fn should_buffer_gossip_broadcast(&self) -> bool {
528 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
529 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
532 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
533 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
534 let total_outbound_buffered =
535 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
537 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
538 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
541 fn set_their_node_id(&mut self, node_id: PublicKey) {
542 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
546 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
547 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
548 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
549 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
550 /// issues such as overly long function definitions.
552 /// This is not exported to bindings users as `Arc`s don't make sense in bindings.
553 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>>;
555 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
556 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
557 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
558 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
559 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
560 /// helps with issues such as long function definitions.
562 /// This is not exported to bindings users as general type aliases don't make sense in bindings.
563 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>;
566 /// A generic trait which is implemented for all [`PeerManager`]s. This makes bounding functions or
567 /// structs on any [`PeerManager`] much simpler as only this trait is needed as a bound, rather
568 /// than the full set of bounds on [`PeerManager`] itself.
569 #[allow(missing_docs)]
570 pub trait APeerManager {
571 type Descriptor: SocketDescriptor;
572 type CMT: ChannelMessageHandler + ?Sized;
573 type CM: Deref<Target=Self::CMT>;
574 type RMT: RoutingMessageHandler + ?Sized;
575 type RM: Deref<Target=Self::RMT>;
576 type OMT: OnionMessageHandler + ?Sized;
577 type OM: Deref<Target=Self::OMT>;
578 type LT: Logger + ?Sized;
579 type L: Deref<Target=Self::LT>;
580 type CMHT: CustomMessageHandler + ?Sized;
581 type CMH: Deref<Target=Self::CMHT>;
582 type NST: NodeSigner + ?Sized;
583 type NS: Deref<Target=Self::NST>;
584 /// Gets a reference to the underlying [`PeerManager`].
585 fn as_ref(&self) -> &PeerManager<Self::Descriptor, Self::CM, Self::RM, Self::OM, Self::L, Self::CMH, Self::NS>;
588 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref>
589 APeerManager for PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
590 CM::Target: ChannelMessageHandler,
591 RM::Target: RoutingMessageHandler,
592 OM::Target: OnionMessageHandler,
594 CMH::Target: CustomMessageHandler,
595 NS::Target: NodeSigner,
597 type Descriptor = Descriptor;
598 type CMT = <CM as Deref>::Target;
600 type RMT = <RM as Deref>::Target;
602 type OMT = <OM as Deref>::Target;
604 type LT = <L as Deref>::Target;
606 type CMHT = <CMH as Deref>::Target;
608 type NST = <NS as Deref>::Target;
610 fn as_ref(&self) -> &PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> { self }
613 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
614 /// socket events into messages which it passes on to its [`MessageHandler`].
616 /// Locks are taken internally, so you must never assume that reentrancy from a
617 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
619 /// Calls to [`read_event`] will decode relevant messages and pass them to the
620 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
621 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
622 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
623 /// calls only after previous ones have returned.
625 /// Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
626 /// a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
627 /// essentially you should default to using a [`SimpleRefPeerManager`], and use a
628 /// [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
629 /// you're using lightning-net-tokio.
631 /// [`read_event`]: PeerManager::read_event
632 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
633 CM::Target: ChannelMessageHandler,
634 RM::Target: RoutingMessageHandler,
635 OM::Target: OnionMessageHandler,
637 CMH::Target: CustomMessageHandler,
638 NS::Target: NodeSigner {
639 message_handler: MessageHandler<CM, RM, OM, CMH>,
640 /// Connection state for each connected peer - we have an outer read-write lock which is taken
641 /// as read while we're doing processing for a peer and taken write when a peer is being added
644 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
645 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
646 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
647 /// the `MessageHandler`s for a given peer is already guaranteed.
648 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
649 /// Only add to this set when noise completes.
650 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
651 /// lock held. Entries may be added with only the `peers` read lock held (though the
652 /// `Descriptor` value must already exist in `peers`).
653 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
654 /// We can only have one thread processing events at once, but we don't usually need the full
655 /// `peers` write lock to do so, so instead we block on this empty mutex when entering
656 /// `process_events`.
657 event_processing_lock: Mutex<()>,
658 /// Because event processing is global and always does all available work before returning,
659 /// there is no reason for us to have many event processors waiting on the lock at once.
660 /// Instead, we limit the total blocked event processors to always exactly one by setting this
661 /// when an event process call is waiting.
662 blocked_event_processors: AtomicBool,
664 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
665 /// value increases strictly since we don't assume access to a time source.
666 last_node_announcement_serial: AtomicU32,
668 ephemeral_key_midstate: Sha256Engine,
670 peer_counter: AtomicCounter,
672 gossip_processing_backlogged: AtomicBool,
673 gossip_processing_backlog_lifted: AtomicBool,
678 secp_ctx: Secp256k1<secp256k1::SignOnly>
681 enum MessageHandlingError {
682 PeerHandleError(PeerHandleError),
683 LightningError(LightningError),
686 impl From<PeerHandleError> for MessageHandlingError {
687 fn from(error: PeerHandleError) -> Self {
688 MessageHandlingError::PeerHandleError(error)
692 impl From<LightningError> for MessageHandlingError {
693 fn from(error: LightningError) -> Self {
694 MessageHandlingError::LightningError(error)
698 macro_rules! encode_msg {
700 let mut buffer = VecWriter(Vec::new());
701 wire::write($msg, &mut buffer).unwrap();
706 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
707 CM::Target: ChannelMessageHandler,
708 OM::Target: OnionMessageHandler,
710 NS::Target: NodeSigner {
711 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
712 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
715 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
716 /// cryptographically secure random bytes.
718 /// `current_time` is used as an always-increasing counter that survives across restarts and is
719 /// incremented irregularly internally. In general it is best to simply use the current UNIX
720 /// timestamp, however if it is not available a persistent counter that increases once per
721 /// minute should suffice.
723 /// This is not exported to bindings users as we can't export a PeerManager with a dummy route handler
724 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 {
725 Self::new(MessageHandler {
726 chan_handler: channel_message_handler,
727 route_handler: IgnoringMessageHandler{},
728 onion_message_handler,
729 custom_message_handler: IgnoringMessageHandler{},
730 }, current_time, ephemeral_random_data, logger, node_signer)
734 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
735 RM::Target: RoutingMessageHandler,
737 NS::Target: NodeSigner {
738 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
739 /// handler or onion message handler is used and onion and channel messages will be ignored (or
740 /// generate error messages). Note that some other lightning implementations time-out connections
741 /// after some time if no channel is built with the peer.
743 /// `current_time` is used as an always-increasing counter that survives across restarts and is
744 /// incremented irregularly internally. In general it is best to simply use the current UNIX
745 /// timestamp, however if it is not available a persistent counter that increases once per
746 /// minute should suffice.
748 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
749 /// cryptographically secure random bytes.
751 /// This is not exported to bindings users as we can't export a PeerManager with a dummy channel handler
752 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
753 Self::new(MessageHandler {
754 chan_handler: ErroringMessageHandler::new(),
755 route_handler: routing_message_handler,
756 onion_message_handler: IgnoringMessageHandler{},
757 custom_message_handler: IgnoringMessageHandler{},
758 }, current_time, ephemeral_random_data, logger, node_signer)
762 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
763 /// This works around `format!()` taking a reference to each argument, preventing
764 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
765 /// due to lifetime errors.
766 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
767 impl core::fmt::Display for OptionalFromDebugger<'_> {
768 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
769 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
773 /// A function used to filter out local or private addresses
774 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
775 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
776 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
778 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
779 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
780 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
781 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
782 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
783 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
784 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
785 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
786 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
787 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
788 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
789 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
790 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
791 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
792 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
793 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
794 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
795 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
796 // For remaining addresses
797 Some(NetAddress::IPv6{addr: _, port: _}) => None,
798 Some(..) => ip_address,
803 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
804 CM::Target: ChannelMessageHandler,
805 RM::Target: RoutingMessageHandler,
806 OM::Target: OnionMessageHandler,
808 CMH::Target: CustomMessageHandler,
809 NS::Target: NodeSigner
811 /// Constructs a new `PeerManager` with the given message handlers.
813 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
814 /// cryptographically secure random bytes.
816 /// `current_time` is used as an always-increasing counter that survives across restarts and is
817 /// incremented irregularly internally. In general it is best to simply use the current UNIX
818 /// timestamp, however if it is not available a persistent counter that increases once per
819 /// minute should suffice.
820 pub fn new(message_handler: MessageHandler<CM, RM, OM, CMH>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
821 let mut ephemeral_key_midstate = Sha256::engine();
822 ephemeral_key_midstate.input(ephemeral_random_data);
824 let mut secp_ctx = Secp256k1::signing_only();
825 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
826 secp_ctx.seeded_randomize(&ephemeral_hash);
830 peers: FairRwLock::new(HashMap::new()),
831 node_id_to_descriptor: Mutex::new(HashMap::new()),
832 event_processing_lock: Mutex::new(()),
833 blocked_event_processors: AtomicBool::new(false),
834 ephemeral_key_midstate,
835 peer_counter: AtomicCounter::new(),
836 gossip_processing_backlogged: AtomicBool::new(false),
837 gossip_processing_backlog_lifted: AtomicBool::new(false),
838 last_node_announcement_serial: AtomicU32::new(current_time),
845 /// Get a list of tuples mapping from node id to network addresses for peers which have
846 /// completed the initial handshake.
848 /// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
849 /// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
850 /// handshake has completed and we are sure the remote peer has the private key for the given
853 /// The returned `Option`s will only be `Some` if an address had been previously given via
854 /// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
855 pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<NetAddress>)> {
856 let peers = self.peers.read().unwrap();
857 peers.values().filter_map(|peer_mutex| {
858 let p = peer_mutex.lock().unwrap();
859 if !p.handshake_complete() {
862 Some((p.their_node_id.unwrap().0, p.their_net_address.clone()))
866 fn get_ephemeral_key(&self) -> SecretKey {
867 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
868 let counter = self.peer_counter.get_increment();
869 ephemeral_hash.input(&counter.to_le_bytes());
870 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
873 fn init_features(&self, their_node_id: &PublicKey) -> InitFeatures {
874 self.message_handler.chan_handler.provided_init_features(their_node_id)
875 | self.message_handler.route_handler.provided_init_features(their_node_id)
876 | self.message_handler.onion_message_handler.provided_init_features(their_node_id)
877 | self.message_handler.custom_message_handler.provided_init_features(their_node_id)
880 /// Indicates a new outbound connection has been established to a node with the given `node_id`
881 /// and an optional remote network address.
883 /// The remote network address adds the option to report a remote IP address back to a connecting
884 /// peer using the init message.
885 /// The user should pass the remote network address of the host they are connected to.
887 /// If an `Err` is returned here you must disconnect the connection immediately.
889 /// Returns a small number of bytes to send to the remote node (currently always 50).
891 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
892 /// [`socket_disconnected`].
894 /// [`socket_disconnected`]: PeerManager::socket_disconnected
895 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
896 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
897 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
898 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
900 let mut peers = self.peers.write().unwrap();
901 match peers.entry(descriptor) {
902 hash_map::Entry::Occupied(_) => {
903 debug_assert!(false, "PeerManager driver duplicated descriptors!");
904 Err(PeerHandleError {})
906 hash_map::Entry::Vacant(e) => {
907 e.insert(Mutex::new(Peer {
908 channel_encryptor: peer_encryptor,
910 their_features: None,
911 their_net_address: remote_network_address,
913 pending_outbound_buffer: LinkedList::new(),
914 pending_outbound_buffer_first_msg_offset: 0,
915 gossip_broadcast_buffer: LinkedList::new(),
916 awaiting_write_event: false,
919 pending_read_buffer_pos: 0,
920 pending_read_is_header: false,
922 sync_status: InitSyncTracker::NoSyncRequested,
924 msgs_sent_since_pong: 0,
925 awaiting_pong_timer_tick_intervals: 0,
926 received_message_since_timer_tick: false,
927 sent_gossip_timestamp_filter: false,
929 received_channel_announce_since_backlogged: false,
930 inbound_connection: false,
937 /// Indicates a new inbound connection has been established to a node with an optional remote
940 /// The remote network address adds the option to report a remote IP address back to a connecting
941 /// peer using the init message.
942 /// The user should pass the remote network address of the host they are connected to.
944 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
945 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
946 /// the connection immediately.
948 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
949 /// [`socket_disconnected`].
951 /// [`socket_disconnected`]: PeerManager::socket_disconnected
952 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
953 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
954 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
956 let mut peers = self.peers.write().unwrap();
957 match peers.entry(descriptor) {
958 hash_map::Entry::Occupied(_) => {
959 debug_assert!(false, "PeerManager driver duplicated descriptors!");
960 Err(PeerHandleError {})
962 hash_map::Entry::Vacant(e) => {
963 e.insert(Mutex::new(Peer {
964 channel_encryptor: peer_encryptor,
966 their_features: None,
967 their_net_address: remote_network_address,
969 pending_outbound_buffer: LinkedList::new(),
970 pending_outbound_buffer_first_msg_offset: 0,
971 gossip_broadcast_buffer: LinkedList::new(),
972 awaiting_write_event: false,
975 pending_read_buffer_pos: 0,
976 pending_read_is_header: false,
978 sync_status: InitSyncTracker::NoSyncRequested,
980 msgs_sent_since_pong: 0,
981 awaiting_pong_timer_tick_intervals: 0,
982 received_message_since_timer_tick: false,
983 sent_gossip_timestamp_filter: false,
985 received_channel_announce_since_backlogged: false,
986 inbound_connection: true,
993 fn peer_should_read(&self, peer: &mut Peer) -> bool {
994 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
997 fn update_gossip_backlogged(&self) {
998 let new_state = self.message_handler.route_handler.processing_queue_high();
999 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
1000 if prev_state && !new_state {
1001 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
1005 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
1006 let mut have_written = false;
1007 while !peer.awaiting_write_event {
1008 if peer.should_buffer_onion_message() {
1009 if let Some((peer_node_id, _)) = peer.their_node_id {
1010 if let Some(next_onion_message) =
1011 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
1012 self.enqueue_message(peer, &next_onion_message);
1016 if peer.should_buffer_gossip_broadcast() {
1017 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
1018 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(&msg[..]));
1021 if peer.should_buffer_gossip_backfill() {
1022 match peer.sync_status {
1023 InitSyncTracker::NoSyncRequested => {},
1024 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
1025 if let Some((announce, update_a_option, update_b_option)) =
1026 self.message_handler.route_handler.get_next_channel_announcement(c)
1028 self.enqueue_message(peer, &announce);
1029 if let Some(update_a) = update_a_option {
1030 self.enqueue_message(peer, &update_a);
1032 if let Some(update_b) = update_b_option {
1033 self.enqueue_message(peer, &update_b);
1035 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
1037 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
1040 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
1041 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
1042 self.enqueue_message(peer, &msg);
1043 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1045 peer.sync_status = InitSyncTracker::NoSyncRequested;
1048 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
1049 InitSyncTracker::NodesSyncing(sync_node_id) => {
1050 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
1051 self.enqueue_message(peer, &msg);
1052 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1054 peer.sync_status = InitSyncTracker::NoSyncRequested;
1059 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
1060 self.maybe_send_extra_ping(peer);
1063 let should_read = self.peer_should_read(peer);
1064 let next_buff = match peer.pending_outbound_buffer.front() {
1066 if force_one_write && !have_written {
1068 let data_sent = descriptor.send_data(&[], should_read);
1069 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
1077 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
1078 let data_sent = descriptor.send_data(pending, should_read);
1079 have_written = true;
1080 peer.pending_outbound_buffer_first_msg_offset += data_sent;
1081 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
1082 peer.pending_outbound_buffer_first_msg_offset = 0;
1083 peer.pending_outbound_buffer.pop_front();
1085 peer.awaiting_write_event = true;
1090 /// Indicates that there is room to write data to the given socket descriptor.
1092 /// May return an Err to indicate that the connection should be closed.
1094 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1095 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1096 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1097 /// ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
1100 /// [`send_data`]: SocketDescriptor::send_data
1101 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1102 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1103 let peers = self.peers.read().unwrap();
1104 match peers.get(descriptor) {
1106 // This is most likely a simple race condition where the user found that the socket
1107 // was writeable, then we told the user to `disconnect_socket()`, then they called
1108 // this method. Return an error to make sure we get disconnected.
1109 return Err(PeerHandleError { });
1111 Some(peer_mutex) => {
1112 let mut peer = peer_mutex.lock().unwrap();
1113 peer.awaiting_write_event = false;
1114 self.do_attempt_write_data(descriptor, &mut peer, false);
1120 /// Indicates that data was read from the given socket descriptor.
1122 /// May return an Err to indicate that the connection should be closed.
1124 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1125 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1126 /// [`send_data`] calls to handle responses.
1128 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1129 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1132 /// In order to avoid processing too many messages at once per peer, `data` should be on the
1135 /// [`send_data`]: SocketDescriptor::send_data
1136 /// [`process_events`]: PeerManager::process_events
1137 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1138 match self.do_read_event(peer_descriptor, data) {
1141 log_trace!(self.logger, "Disconnecting peer due to a protocol error (usually a duplicate connection).");
1142 self.disconnect_event_internal(peer_descriptor);
1148 /// Append a message to a peer's pending outbound/write buffer
1149 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1150 if is_gossip_msg(message.type_id()) {
1151 log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1153 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1155 peer.msgs_sent_since_pong += 1;
1156 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1159 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1160 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: Vec<u8>) {
1161 peer.msgs_sent_since_pong += 1;
1162 peer.gossip_broadcast_buffer.push_back(encoded_message);
1165 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1166 let mut pause_read = false;
1167 let peers = self.peers.read().unwrap();
1168 let mut msgs_to_forward = Vec::new();
1169 let mut peer_node_id = None;
1170 match peers.get(peer_descriptor) {
1172 // This is most likely a simple race condition where the user read some bytes
1173 // from the socket, then we told the user to `disconnect_socket()`, then they
1174 // called this method. Return an error to make sure we get disconnected.
1175 return Err(PeerHandleError { });
1177 Some(peer_mutex) => {
1178 let mut read_pos = 0;
1179 while read_pos < data.len() {
1180 macro_rules! try_potential_handleerror {
1181 ($peer: expr, $thing: expr) => {
1186 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
1187 //TODO: Try to push msg
1188 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1189 return Err(PeerHandleError { });
1191 msgs::ErrorAction::IgnoreAndLog(level) => {
1192 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1195 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1196 msgs::ErrorAction::IgnoreError => {
1197 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1200 msgs::ErrorAction::SendErrorMessage { msg } => {
1201 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1202 self.enqueue_message($peer, &msg);
1205 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1206 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1207 self.enqueue_message($peer, &msg);
1216 let mut peer_lock = peer_mutex.lock().unwrap();
1217 let peer = &mut *peer_lock;
1218 let mut msg_to_handle = None;
1219 if peer_node_id.is_none() {
1220 peer_node_id = peer.their_node_id.clone();
1223 assert!(peer.pending_read_buffer.len() > 0);
1224 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1227 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1228 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]);
1229 read_pos += data_to_copy;
1230 peer.pending_read_buffer_pos += data_to_copy;
1233 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1234 peer.pending_read_buffer_pos = 0;
1236 macro_rules! insert_node_id {
1238 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1239 hash_map::Entry::Occupied(e) => {
1240 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1241 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1242 // Check that the peers map is consistent with the
1243 // node_id_to_descriptor map, as this has been broken
1245 debug_assert!(peers.get(e.get()).is_some());
1246 return Err(PeerHandleError { })
1248 hash_map::Entry::Vacant(entry) => {
1249 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1250 entry.insert(peer_descriptor.clone())
1256 let next_step = peer.channel_encryptor.get_noise_step();
1258 NextNoiseStep::ActOne => {
1259 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1260 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1261 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1262 peer.pending_outbound_buffer.push_back(act_two);
1263 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1265 NextNoiseStep::ActTwo => {
1266 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1267 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1268 &self.node_signer));
1269 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1270 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1271 peer.pending_read_is_header = true;
1273 peer.set_their_node_id(their_node_id);
1275 let features = self.init_features(&their_node_id);
1276 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1277 self.enqueue_message(peer, &resp);
1278 peer.awaiting_pong_timer_tick_intervals = 0;
1280 NextNoiseStep::ActThree => {
1281 let their_node_id = try_potential_handleerror!(peer,
1282 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1283 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1284 peer.pending_read_is_header = true;
1285 peer.set_their_node_id(their_node_id);
1287 let features = self.init_features(&their_node_id);
1288 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1289 self.enqueue_message(peer, &resp);
1290 peer.awaiting_pong_timer_tick_intervals = 0;
1292 NextNoiseStep::NoiseComplete => {
1293 if peer.pending_read_is_header {
1294 let msg_len = try_potential_handleerror!(peer,
1295 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1296 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1297 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1298 if msg_len < 2 { // Need at least the message type tag
1299 return Err(PeerHandleError { });
1301 peer.pending_read_is_header = false;
1303 let msg_data = try_potential_handleerror!(peer,
1304 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1305 assert!(msg_data.len() >= 2);
1307 // Reset read buffer
1308 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1309 peer.pending_read_buffer.resize(18, 0);
1310 peer.pending_read_is_header = true;
1312 let mut reader = io::Cursor::new(&msg_data[..]);
1313 let message_result = wire::read(&mut reader, &*self.message_handler.custom_message_handler);
1314 let message = match message_result {
1318 // Note that to avoid recursion we never call
1319 // `do_attempt_write_data` from here, causing
1320 // the messages enqueued here to not actually
1321 // be sent before the peer is disconnected.
1322 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1323 log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1326 (msgs::DecodeError::UnsupportedCompression, _) => {
1327 log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1328 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1331 (_, Some(ty)) if is_gossip_msg(ty) => {
1332 log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1333 self.enqueue_message(peer, &msgs::WarningMessage {
1334 channel_id: [0; 32],
1335 data: format!("Unreadable/bogus gossip message of type {}", ty),
1339 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1340 log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1341 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1342 return Err(PeerHandleError { });
1344 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1345 (msgs::DecodeError::InvalidValue, _) => {
1346 log_debug!(self.logger, "Got an invalid value while deserializing message");
1347 return Err(PeerHandleError { });
1349 (msgs::DecodeError::ShortRead, _) => {
1350 log_debug!(self.logger, "Deserialization failed due to shortness of message");
1351 return Err(PeerHandleError { });
1353 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1354 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1359 msg_to_handle = Some(message);
1364 pause_read = !self.peer_should_read(peer);
1366 if let Some(message) = msg_to_handle {
1367 match self.handle_message(&peer_mutex, peer_lock, message) {
1368 Err(handling_error) => match handling_error {
1369 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1370 MessageHandlingError::LightningError(e) => {
1371 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1375 msgs_to_forward.push(msg);
1384 for msg in msgs_to_forward.drain(..) {
1385 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1391 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1392 /// Returns the message back if it needs to be broadcasted to all other peers.
1395 peer_mutex: &Mutex<Peer>,
1396 mut peer_lock: MutexGuard<Peer>,
1397 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1398 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1399 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages").0;
1400 peer_lock.received_message_since_timer_tick = true;
1402 // Need an Init as first message
1403 if let wire::Message::Init(msg) = message {
1404 if msg.features.requires_unknown_bits() {
1405 log_debug!(self.logger, "Peer features required unknown version bits");
1406 return Err(PeerHandleError { }.into());
1408 if peer_lock.their_features.is_some() {
1409 return Err(PeerHandleError { }.into());
1412 log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1414 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1415 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1416 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1419 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1420 log_debug!(self.logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1421 return Err(PeerHandleError { }.into());
1423 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1424 log_debug!(self.logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1425 return Err(PeerHandleError { }.into());
1427 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1428 log_debug!(self.logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1429 return Err(PeerHandleError { }.into());
1432 peer_lock.their_features = Some(msg.features);
1434 } else if peer_lock.their_features.is_none() {
1435 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1436 return Err(PeerHandleError { }.into());
1439 if let wire::Message::GossipTimestampFilter(_msg) = message {
1440 // When supporting gossip messages, start inital gossip sync only after we receive
1441 // a GossipTimestampFilter
1442 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1443 !peer_lock.sent_gossip_timestamp_filter {
1444 peer_lock.sent_gossip_timestamp_filter = true;
1445 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1450 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1451 peer_lock.received_channel_announce_since_backlogged = true;
1454 mem::drop(peer_lock);
1456 if is_gossip_msg(message.type_id()) {
1457 log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1459 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1462 let mut should_forward = None;
1465 // Setup and Control messages:
1466 wire::Message::Init(_) => {
1469 wire::Message::GossipTimestampFilter(_) => {
1472 wire::Message::Error(msg) => {
1473 let mut data_is_printable = true;
1474 for b in msg.data.bytes() {
1475 if b < 32 || b > 126 {
1476 data_is_printable = false;
1481 if data_is_printable {
1482 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1484 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1486 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1487 if msg.channel_id == [0; 32] {
1488 return Err(PeerHandleError { }.into());
1491 wire::Message::Warning(msg) => {
1492 let mut data_is_printable = true;
1493 for b in msg.data.bytes() {
1494 if b < 32 || b > 126 {
1495 data_is_printable = false;
1500 if data_is_printable {
1501 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1503 log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1507 wire::Message::Ping(msg) => {
1508 if msg.ponglen < 65532 {
1509 let resp = msgs::Pong { byteslen: msg.ponglen };
1510 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1513 wire::Message::Pong(_msg) => {
1514 let mut peer_lock = peer_mutex.lock().unwrap();
1515 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1516 peer_lock.msgs_sent_since_pong = 0;
1519 // Channel messages:
1520 wire::Message::OpenChannel(msg) => {
1521 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1523 wire::Message::AcceptChannel(msg) => {
1524 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1527 wire::Message::FundingCreated(msg) => {
1528 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1530 wire::Message::FundingSigned(msg) => {
1531 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1533 wire::Message::ChannelReady(msg) => {
1534 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1537 wire::Message::Shutdown(msg) => {
1538 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1540 wire::Message::ClosingSigned(msg) => {
1541 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1544 // Commitment messages:
1545 wire::Message::UpdateAddHTLC(msg) => {
1546 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1548 wire::Message::UpdateFulfillHTLC(msg) => {
1549 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1551 wire::Message::UpdateFailHTLC(msg) => {
1552 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1554 wire::Message::UpdateFailMalformedHTLC(msg) => {
1555 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1558 wire::Message::CommitmentSigned(msg) => {
1559 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1561 wire::Message::RevokeAndACK(msg) => {
1562 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1564 wire::Message::UpdateFee(msg) => {
1565 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1567 wire::Message::ChannelReestablish(msg) => {
1568 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1571 // Routing messages:
1572 wire::Message::AnnouncementSignatures(msg) => {
1573 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1575 wire::Message::ChannelAnnouncement(msg) => {
1576 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1577 .map_err(|e| -> MessageHandlingError { e.into() })? {
1578 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1580 self.update_gossip_backlogged();
1582 wire::Message::NodeAnnouncement(msg) => {
1583 if self.message_handler.route_handler.handle_node_announcement(&msg)
1584 .map_err(|e| -> MessageHandlingError { e.into() })? {
1585 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1587 self.update_gossip_backlogged();
1589 wire::Message::ChannelUpdate(msg) => {
1590 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1591 if self.message_handler.route_handler.handle_channel_update(&msg)
1592 .map_err(|e| -> MessageHandlingError { e.into() })? {
1593 should_forward = Some(wire::Message::ChannelUpdate(msg));
1595 self.update_gossip_backlogged();
1597 wire::Message::QueryShortChannelIds(msg) => {
1598 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1600 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1601 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1603 wire::Message::QueryChannelRange(msg) => {
1604 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1606 wire::Message::ReplyChannelRange(msg) => {
1607 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1611 wire::Message::OnionMessage(msg) => {
1612 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1615 // Unknown messages:
1616 wire::Message::Unknown(type_id) if message.is_even() => {
1617 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1618 return Err(PeerHandleError { }.into());
1620 wire::Message::Unknown(type_id) => {
1621 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1623 wire::Message::Custom(custom) => {
1624 self.message_handler.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1630 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>) {
1632 wire::Message::ChannelAnnouncement(ref msg) => {
1633 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1634 let encoded_msg = encode_msg!(msg);
1636 for (_, peer_mutex) in peers.iter() {
1637 let mut peer = peer_mutex.lock().unwrap();
1638 if !peer.handshake_complete() ||
1639 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1642 debug_assert!(peer.their_node_id.is_some());
1643 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1644 if peer.buffer_full_drop_gossip_broadcast() {
1645 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1648 if let Some((_, their_node_id)) = peer.their_node_id {
1649 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1653 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1656 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1659 wire::Message::NodeAnnouncement(ref msg) => {
1660 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1661 let encoded_msg = encode_msg!(msg);
1663 for (_, peer_mutex) in peers.iter() {
1664 let mut peer = peer_mutex.lock().unwrap();
1665 if !peer.handshake_complete() ||
1666 !peer.should_forward_node_announcement(msg.contents.node_id) {
1669 debug_assert!(peer.their_node_id.is_some());
1670 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1671 if peer.buffer_full_drop_gossip_broadcast() {
1672 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1675 if let Some((_, their_node_id)) = peer.their_node_id {
1676 if their_node_id == msg.contents.node_id {
1680 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1683 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1686 wire::Message::ChannelUpdate(ref msg) => {
1687 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1688 let encoded_msg = encode_msg!(msg);
1690 for (_, peer_mutex) in peers.iter() {
1691 let mut peer = peer_mutex.lock().unwrap();
1692 if !peer.handshake_complete() ||
1693 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1696 debug_assert!(peer.their_node_id.is_some());
1697 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1698 if peer.buffer_full_drop_gossip_broadcast() {
1699 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1702 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1705 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1708 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1712 /// Checks for any events generated by our handlers and processes them. Includes sending most
1713 /// response messages as well as messages generated by calls to handler functions directly (eg
1714 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1716 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1719 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1720 /// or one of the other clients provided in our language bindings.
1722 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1723 /// without doing any work. All available events that need handling will be handled before the
1724 /// other calls return.
1726 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1727 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1728 /// [`send_data`]: SocketDescriptor::send_data
1729 pub fn process_events(&self) {
1730 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1731 if _single_processor_lock.is_err() {
1732 // While we could wake the older sleeper here with a CV and make more even waiting
1733 // times, that would be a lot of overengineering for a simple "reduce total waiter
1735 match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1737 debug_assert!(val, "compare_exchange failed spuriously?");
1741 debug_assert!(!val, "compare_exchange succeeded spuriously?");
1742 // We're the only waiter, as the running process_events may have emptied the
1743 // pending events "long" ago and there are new events for us to process, wait until
1744 // its done and process any leftover events before returning.
1745 _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1746 self.blocked_event_processors.store(false, Ordering::Release);
1751 self.update_gossip_backlogged();
1752 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1754 let mut peers_to_disconnect = HashMap::new();
1755 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1756 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1759 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1760 // buffer by doing things like announcing channels on another node. We should be willing to
1761 // drop optional-ish messages when send buffers get full!
1763 let peers_lock = self.peers.read().unwrap();
1764 let peers = &*peers_lock;
1765 macro_rules! get_peer_for_forwarding {
1766 ($node_id: expr) => {
1768 if peers_to_disconnect.get($node_id).is_some() {
1769 // If we've "disconnected" this peer, do not send to it.
1772 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1773 match descriptor_opt {
1774 Some(descriptor) => match peers.get(&descriptor) {
1775 Some(peer_mutex) => {
1776 let peer_lock = peer_mutex.lock().unwrap();
1777 if !peer_lock.handshake_complete() {
1783 debug_assert!(false, "Inconsistent peers set state!");
1794 for event in events_generated.drain(..) {
1796 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1797 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1798 log_pubkey!(node_id),
1799 log_bytes!(msg.temporary_channel_id));
1800 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1802 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1803 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1804 log_pubkey!(node_id),
1805 log_bytes!(msg.temporary_channel_id));
1806 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1808 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1809 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1810 log_pubkey!(node_id),
1811 log_bytes!(msg.temporary_channel_id),
1812 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1813 // TODO: If the peer is gone we should generate a DiscardFunding event
1814 // indicating to the wallet that they should just throw away this funding transaction
1815 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1817 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1818 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1819 log_pubkey!(node_id),
1820 log_bytes!(msg.channel_id));
1821 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1823 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1824 log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1825 log_pubkey!(node_id),
1826 log_bytes!(msg.channel_id));
1827 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1829 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1830 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1831 log_pubkey!(node_id),
1832 log_bytes!(msg.channel_id));
1833 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1835 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 } } => {
1836 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1837 log_pubkey!(node_id),
1838 update_add_htlcs.len(),
1839 update_fulfill_htlcs.len(),
1840 update_fail_htlcs.len(),
1841 log_bytes!(commitment_signed.channel_id));
1842 let mut peer = get_peer_for_forwarding!(node_id);
1843 for msg in update_add_htlcs {
1844 self.enqueue_message(&mut *peer, msg);
1846 for msg in update_fulfill_htlcs {
1847 self.enqueue_message(&mut *peer, msg);
1849 for msg in update_fail_htlcs {
1850 self.enqueue_message(&mut *peer, msg);
1852 for msg in update_fail_malformed_htlcs {
1853 self.enqueue_message(&mut *peer, msg);
1855 if let &Some(ref msg) = update_fee {
1856 self.enqueue_message(&mut *peer, msg);
1858 self.enqueue_message(&mut *peer, commitment_signed);
1860 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1861 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1862 log_pubkey!(node_id),
1863 log_bytes!(msg.channel_id));
1864 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1866 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1867 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1868 log_pubkey!(node_id),
1869 log_bytes!(msg.channel_id));
1870 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1872 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1873 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1874 log_pubkey!(node_id),
1875 log_bytes!(msg.channel_id));
1876 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1878 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1879 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1880 log_pubkey!(node_id),
1881 log_bytes!(msg.channel_id));
1882 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1884 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
1885 log_debug!(self.logger, "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
1886 log_pubkey!(node_id),
1887 msg.contents.short_channel_id);
1888 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1889 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
1891 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1892 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1893 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1894 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1895 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1898 if let Some(msg) = update_msg {
1899 match self.message_handler.route_handler.handle_channel_update(&msg) {
1900 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1901 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1906 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1907 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1908 match self.message_handler.route_handler.handle_channel_update(&msg) {
1909 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1910 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1914 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1915 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
1916 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1917 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1918 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1922 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1923 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1924 log_pubkey!(node_id), msg.contents.short_channel_id);
1925 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1927 MessageSendEvent::HandleError { ref node_id, ref action } => {
1929 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1930 // We do not have the peers write lock, so we just store that we're
1931 // about to disconenct the peer and do it after we finish
1932 // processing most messages.
1933 peers_to_disconnect.insert(*node_id, msg.clone());
1935 msgs::ErrorAction::IgnoreAndLog(level) => {
1936 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1938 msgs::ErrorAction::IgnoreDuplicateGossip => {},
1939 msgs::ErrorAction::IgnoreError => {
1940 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1942 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1943 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1944 log_pubkey!(node_id),
1946 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1948 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1949 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1950 log_pubkey!(node_id),
1952 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1956 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1957 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1959 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1960 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1962 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1963 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1964 log_pubkey!(node_id),
1965 msg.short_channel_ids.len(),
1967 msg.number_of_blocks,
1969 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1971 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1972 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1977 for (node_id, msg) in self.message_handler.custom_message_handler.get_and_clear_pending_msg() {
1978 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1979 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1982 for (descriptor, peer_mutex) in peers.iter() {
1983 let mut peer = peer_mutex.lock().unwrap();
1984 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
1985 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
1988 if !peers_to_disconnect.is_empty() {
1989 let mut peers_lock = self.peers.write().unwrap();
1990 let peers = &mut *peers_lock;
1991 for (node_id, msg) in peers_to_disconnect.drain() {
1992 // Note that since we are holding the peers *write* lock we can
1993 // remove from node_id_to_descriptor immediately (as no other
1994 // thread can be holding the peer lock if we have the global write
1997 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1998 if let Some(mut descriptor) = descriptor_opt {
1999 if let Some(peer_mutex) = peers.remove(&descriptor) {
2000 let mut peer = peer_mutex.lock().unwrap();
2001 if let Some(msg) = msg {
2002 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2003 log_pubkey!(node_id),
2005 self.enqueue_message(&mut *peer, &msg);
2006 // This isn't guaranteed to work, but if there is enough free
2007 // room in the send buffer, put the error message there...
2008 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
2010 self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
2011 } else { debug_assert!(false, "Missing connection for peer"); }
2017 /// Indicates that the given socket descriptor's connection is now closed.
2018 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
2019 self.disconnect_event_internal(descriptor);
2022 fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
2023 if !peer.handshake_complete() {
2024 log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
2025 descriptor.disconnect_socket();
2029 debug_assert!(peer.their_node_id.is_some());
2030 if let Some((node_id, _)) = peer.their_node_id {
2031 log_trace!(self.logger, "Disconnecting peer with id {} due to {}", node_id, reason);
2032 self.message_handler.chan_handler.peer_disconnected(&node_id);
2033 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2035 descriptor.disconnect_socket();
2038 fn disconnect_event_internal(&self, descriptor: &Descriptor) {
2039 let mut peers = self.peers.write().unwrap();
2040 let peer_option = peers.remove(descriptor);
2043 // This is most likely a simple race condition where the user found that the socket
2044 // was disconnected, then we told the user to `disconnect_socket()`, then they
2045 // called this method. Either way we're disconnected, return.
2047 Some(peer_lock) => {
2048 let peer = peer_lock.lock().unwrap();
2049 if let Some((node_id, _)) = peer.their_node_id {
2050 log_trace!(self.logger, "Handling disconnection of peer {}", log_pubkey!(node_id));
2051 let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2052 debug_assert!(removed.is_some(), "descriptor maps should be consistent");
2053 if !peer.handshake_complete() { return; }
2054 self.message_handler.chan_handler.peer_disconnected(&node_id);
2055 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2061 /// Disconnect a peer given its node id.
2063 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
2064 /// peer. Thus, be very careful about reentrancy issues.
2066 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
2067 pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
2068 let mut peers_lock = self.peers.write().unwrap();
2069 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
2070 let peer_opt = peers_lock.remove(&descriptor);
2071 if let Some(peer_mutex) = peer_opt {
2072 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
2073 } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
2077 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
2078 /// an indication that TCP sockets have stalled even if we weren't around to time them out
2079 /// using regular ping/pongs.
2080 pub fn disconnect_all_peers(&self) {
2081 let mut peers_lock = self.peers.write().unwrap();
2082 self.node_id_to_descriptor.lock().unwrap().clear();
2083 let peers = &mut *peers_lock;
2084 for (descriptor, peer_mutex) in peers.drain() {
2085 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2089 /// This is called when we're blocked on sending additional gossip messages until we receive a
2090 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2091 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2092 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2093 if peer.awaiting_pong_timer_tick_intervals == 0 {
2094 peer.awaiting_pong_timer_tick_intervals = -1;
2095 let ping = msgs::Ping {
2099 self.enqueue_message(peer, &ping);
2103 /// Send pings to each peer and disconnect those which did not respond to the last round of
2106 /// This may be called on any timescale you want, however, roughly once every ten seconds is
2107 /// preferred. The call rate determines both how often we send a ping to our peers and how much
2108 /// time they have to respond before we disconnect them.
2110 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2113 /// [`send_data`]: SocketDescriptor::send_data
2114 pub fn timer_tick_occurred(&self) {
2115 let mut descriptors_needing_disconnect = Vec::new();
2117 let peers_lock = self.peers.read().unwrap();
2119 self.update_gossip_backlogged();
2120 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2122 for (descriptor, peer_mutex) in peers_lock.iter() {
2123 let mut peer = peer_mutex.lock().unwrap();
2124 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2126 if !peer.handshake_complete() {
2127 // The peer needs to complete its handshake before we can exchange messages. We
2128 // give peers one timer tick to complete handshake, reusing
2129 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2130 // for handshake completion.
2131 if peer.awaiting_pong_timer_tick_intervals != 0 {
2132 descriptors_needing_disconnect.push(descriptor.clone());
2134 peer.awaiting_pong_timer_tick_intervals = 1;
2138 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2139 debug_assert!(peer.their_node_id.is_some());
2141 loop { // Used as a `goto` to skip writing a Ping message.
2142 if peer.awaiting_pong_timer_tick_intervals == -1 {
2143 // Magic value set in `maybe_send_extra_ping`.
2144 peer.awaiting_pong_timer_tick_intervals = 1;
2145 peer.received_message_since_timer_tick = false;
2149 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2150 || peer.awaiting_pong_timer_tick_intervals as u64 >
2151 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2153 descriptors_needing_disconnect.push(descriptor.clone());
2156 peer.received_message_since_timer_tick = false;
2158 if peer.awaiting_pong_timer_tick_intervals > 0 {
2159 peer.awaiting_pong_timer_tick_intervals += 1;
2163 peer.awaiting_pong_timer_tick_intervals = 1;
2164 let ping = msgs::Ping {
2168 self.enqueue_message(&mut *peer, &ping);
2171 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2175 if !descriptors_needing_disconnect.is_empty() {
2177 let mut peers_lock = self.peers.write().unwrap();
2178 for descriptor in descriptors_needing_disconnect {
2179 if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2180 let peer = peer_mutex.lock().unwrap();
2181 if let Some((node_id, _)) = peer.their_node_id {
2182 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2184 self.do_disconnect(descriptor, &*peer, "ping/handshake timeout");
2192 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2193 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2194 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2196 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2199 // ...by failing to compile if the number of addresses that would be half of a message is
2200 // smaller than 100:
2201 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2203 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2204 /// peers. Note that peers will likely ignore this message unless we have at least one public
2205 /// channel which has at least six confirmations on-chain.
2207 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2208 /// node to humans. They carry no in-protocol meaning.
2210 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2211 /// accepts incoming connections. These will be included in the node_announcement, publicly
2212 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2213 /// addresses should likely contain only Tor Onion addresses.
2215 /// Panics if `addresses` is absurdly large (more than 100).
2217 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2218 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2219 if addresses.len() > 100 {
2220 panic!("More than half the message size was taken up by public addresses!");
2223 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2224 // addresses be sorted for future compatibility.
2225 addresses.sort_by_key(|addr| addr.get_id());
2227 let features = self.message_handler.chan_handler.provided_node_features()
2228 | self.message_handler.route_handler.provided_node_features()
2229 | self.message_handler.onion_message_handler.provided_node_features()
2230 | self.message_handler.custom_message_handler.provided_node_features();
2231 let announcement = msgs::UnsignedNodeAnnouncement {
2233 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2234 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2236 alias: NodeAlias(alias),
2238 excess_address_data: Vec::new(),
2239 excess_data: Vec::new(),
2241 let node_announce_sig = match self.node_signer.sign_gossip_message(
2242 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2246 log_error!(self.logger, "Failed to generate signature for node_announcement");
2251 let msg = msgs::NodeAnnouncement {
2252 signature: node_announce_sig,
2253 contents: announcement
2256 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2257 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2258 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2262 fn is_gossip_msg(type_id: u16) -> bool {
2264 msgs::ChannelAnnouncement::TYPE |
2265 msgs::ChannelUpdate::TYPE |
2266 msgs::NodeAnnouncement::TYPE |
2267 msgs::QueryChannelRange::TYPE |
2268 msgs::ReplyChannelRange::TYPE |
2269 msgs::QueryShortChannelIds::TYPE |
2270 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2277 use crate::sign::{NodeSigner, Recipient};
2279 use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2280 use crate::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2281 use crate::ln::{msgs, wire};
2282 use crate::ln::msgs::NetAddress;
2283 use crate::util::test_utils;
2285 use bitcoin::secp256k1::SecretKey;
2287 use crate::prelude::*;
2288 use crate::sync::{Arc, Mutex};
2289 use core::sync::atomic::{AtomicBool, Ordering};
2292 struct FileDescriptor {
2294 outbound_data: Arc<Mutex<Vec<u8>>>,
2295 disconnect: Arc<AtomicBool>,
2297 impl PartialEq for FileDescriptor {
2298 fn eq(&self, other: &Self) -> bool {
2302 impl Eq for FileDescriptor { }
2303 impl core::hash::Hash for FileDescriptor {
2304 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2305 self.fd.hash(hasher)
2309 impl SocketDescriptor for FileDescriptor {
2310 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2311 self.outbound_data.lock().unwrap().extend_from_slice(data);
2315 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2318 struct PeerManagerCfg {
2319 chan_handler: test_utils::TestChannelMessageHandler,
2320 routing_handler: test_utils::TestRoutingMessageHandler,
2321 logger: test_utils::TestLogger,
2322 node_signer: test_utils::TestNodeSigner,
2325 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2326 let mut cfgs = Vec::new();
2327 for i in 0..peer_count {
2328 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2331 chan_handler: test_utils::TestChannelMessageHandler::new(),
2332 logger: test_utils::TestLogger::new(),
2333 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2334 node_signer: test_utils::TestNodeSigner::new(node_secret),
2342 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>> {
2343 let mut peers = Vec::new();
2344 for i in 0..peer_count {
2345 let ephemeral_bytes = [i as u8; 32];
2346 let msg_handler = MessageHandler {
2347 chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler,
2348 onion_message_handler: IgnoringMessageHandler {}, custom_message_handler: IgnoringMessageHandler {}
2350 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, &cfgs[i].node_signer);
2357 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) {
2358 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2359 let mut fd_a = FileDescriptor {
2360 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2361 disconnect: Arc::new(AtomicBool::new(false)),
2363 let addr_a = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1000};
2364 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2365 let mut fd_b = FileDescriptor {
2366 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2367 disconnect: Arc::new(AtomicBool::new(false)),
2369 let addr_b = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1001};
2370 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2371 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2372 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2373 peer_a.process_events();
2375 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2376 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2378 peer_b.process_events();
2379 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2380 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2382 peer_a.process_events();
2383 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2384 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2386 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
2387 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));
2389 (fd_a.clone(), fd_b.clone())
2393 #[cfg(feature = "std")]
2394 fn fuzz_threaded_connections() {
2395 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2396 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2397 // with our internal map consistency, and is a generally good smoke test of disconnection.
2398 let cfgs = Arc::new(create_peermgr_cfgs(2));
2399 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2400 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2402 let start_time = std::time::Instant::now();
2403 macro_rules! spawn_thread { ($id: expr) => { {
2404 let peers = Arc::clone(&peers);
2405 let cfgs = Arc::clone(&cfgs);
2406 std::thread::spawn(move || {
2408 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2409 let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2410 let mut fd_a = FileDescriptor {
2411 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2412 disconnect: Arc::new(AtomicBool::new(false)),
2414 let addr_a = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1000};
2415 let mut fd_b = FileDescriptor {
2416 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2417 disconnect: Arc::new(AtomicBool::new(false)),
2419 let addr_b = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1001};
2420 let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2421 peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2422 if peers[0].read_event(&mut fd_a, &initial_data).is_err() { break; }
2424 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2425 peers[0].process_events();
2426 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2427 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2428 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2430 peers[1].process_events();
2431 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2432 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2433 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2435 cfgs[0].chan_handler.pending_events.lock().unwrap()
2436 .push(crate::events::MessageSendEvent::SendShutdown {
2437 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2438 msg: msgs::Shutdown {
2439 channel_id: [0; 32],
2440 scriptpubkey: bitcoin::Script::new(),
2443 cfgs[1].chan_handler.pending_events.lock().unwrap()
2444 .push(crate::events::MessageSendEvent::SendShutdown {
2445 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2446 msg: msgs::Shutdown {
2447 channel_id: [0; 32],
2448 scriptpubkey: bitcoin::Script::new(),
2453 peers[0].timer_tick_occurred();
2454 peers[1].timer_tick_occurred();
2458 peers[0].socket_disconnected(&fd_a);
2459 peers[1].socket_disconnected(&fd_b);
2461 std::thread::sleep(std::time::Duration::from_micros(1));
2465 let thrd_a = spawn_thread!(1);
2466 let thrd_b = spawn_thread!(2);
2468 thrd_a.join().unwrap();
2469 thrd_b.join().unwrap();
2473 fn test_disconnect_peer() {
2474 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2475 // push a DisconnectPeer event to remove the node flagged by id
2476 let cfgs = create_peermgr_cfgs(2);
2477 let peers = create_network(2, &cfgs);
2478 establish_connection(&peers[0], &peers[1]);
2479 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2481 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2482 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2484 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2487 peers[0].process_events();
2488 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2492 fn test_send_simple_msg() {
2493 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2494 // push a message from one peer to another.
2495 let cfgs = create_peermgr_cfgs(2);
2496 let a_chan_handler = test_utils::TestChannelMessageHandler::new();
2497 let b_chan_handler = test_utils::TestChannelMessageHandler::new();
2498 let mut peers = create_network(2, &cfgs);
2499 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2500 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2502 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2504 let msg = msgs::Shutdown { channel_id: [42; 32], scriptpubkey: bitcoin::Script::new() };
2505 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2506 node_id: their_id, msg: msg.clone()
2508 peers[0].message_handler.chan_handler = &a_chan_handler;
2510 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2511 peers[1].message_handler.chan_handler = &b_chan_handler;
2513 peers[0].process_events();
2515 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2516 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2520 fn test_non_init_first_msg() {
2521 // Simple test of the first message received over a connection being something other than
2522 // Init. This results in an immediate disconnection, which previously included a spurious
2523 // peer_disconnected event handed to event handlers (which would panic in
2524 // `TestChannelMessageHandler` here).
2525 let cfgs = create_peermgr_cfgs(2);
2526 let peers = create_network(2, &cfgs);
2528 let mut fd_dup = FileDescriptor {
2529 fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2530 disconnect: Arc::new(AtomicBool::new(false)),
2532 let addr_dup = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1003};
2533 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
2534 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
2536 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
2537 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
2538 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
2539 peers[0].process_events();
2541 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
2542 let (act_three, _) =
2543 dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
2544 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
2546 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
2547 let msg_bytes = dup_encryptor.encrypt_message(¬_init_msg);
2548 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
2552 fn test_disconnect_all_peer() {
2553 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2554 // then calls disconnect_all_peers
2555 let cfgs = create_peermgr_cfgs(2);
2556 let peers = create_network(2, &cfgs);
2557 establish_connection(&peers[0], &peers[1]);
2558 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2560 peers[0].disconnect_all_peers();
2561 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2565 fn test_timer_tick_occurred() {
2566 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2567 let cfgs = create_peermgr_cfgs(2);
2568 let peers = create_network(2, &cfgs);
2569 establish_connection(&peers[0], &peers[1]);
2570 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2572 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2573 peers[0].timer_tick_occurred();
2574 peers[0].process_events();
2575 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2577 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2578 peers[0].timer_tick_occurred();
2579 peers[0].process_events();
2580 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2584 fn test_do_attempt_write_data() {
2585 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2586 let cfgs = create_peermgr_cfgs(2);
2587 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2588 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2589 let peers = create_network(2, &cfgs);
2591 // By calling establish_connect, we trigger do_attempt_write_data between
2592 // the peers. Previously this function would mistakenly enter an infinite loop
2593 // when there were more channel messages available than could fit into a peer's
2594 // buffer. This issue would now be detected by this test (because we use custom
2595 // RoutingMessageHandlers that intentionally return more channel messages
2596 // than can fit into a peer's buffer).
2597 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2599 // Make each peer to read the messages that the other peer just wrote to them. Note that
2600 // due to the max-message-before-ping limits this may take a few iterations to complete.
2601 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2602 peers[1].process_events();
2603 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2604 assert!(!a_read_data.is_empty());
2606 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2607 peers[0].process_events();
2609 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2610 assert!(!b_read_data.is_empty());
2611 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2613 peers[0].process_events();
2614 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2617 // Check that each peer has received the expected number of channel updates and channel
2619 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2620 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2621 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2622 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2626 fn test_handshake_timeout() {
2627 // Tests that we time out a peer still waiting on handshake completion after a full timer
2629 let cfgs = create_peermgr_cfgs(2);
2630 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2631 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2632 let peers = create_network(2, &cfgs);
2634 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2635 let mut fd_a = FileDescriptor {
2636 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2637 disconnect: Arc::new(AtomicBool::new(false)),
2639 let mut fd_b = FileDescriptor {
2640 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2641 disconnect: Arc::new(AtomicBool::new(false)),
2643 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2644 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2646 // If we get a single timer tick before completion, that's fine
2647 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2648 peers[0].timer_tick_occurred();
2649 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2651 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2652 peers[0].process_events();
2653 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2654 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2655 peers[1].process_events();
2657 // ...but if we get a second timer tick, we should disconnect the peer
2658 peers[0].timer_tick_occurred();
2659 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2661 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2662 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
2666 fn test_filter_addresses(){
2667 // Tests the filter_addresses function.
2670 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2671 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2672 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2673 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2674 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2675 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2678 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2679 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2680 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2681 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2682 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2683 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2686 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2687 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2688 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2689 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2690 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2691 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2694 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2695 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2696 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2697 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2698 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2699 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2702 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2703 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2704 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2705 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2706 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2707 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2710 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2711 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2712 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2713 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2714 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2715 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2718 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2719 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2720 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2721 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2722 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2723 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2725 // For (192.88.99/24)
2726 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2727 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2728 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2729 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2730 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2731 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2733 // For other IPv4 addresses
2734 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2735 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2736 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2737 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2738 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2739 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2742 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2743 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2744 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2745 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2746 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2747 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2749 // For other IPv6 addresses
2750 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2751 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2752 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2753 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2754 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2755 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2758 assert_eq!(filter_addresses(None), None);