1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and P2PGossipSync) with
16 //! messages they should handle, and encoding/sending response messages.
18 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
20 use crate::chain::keysinterface::{KeysManager, NodeSigner, Recipient};
21 use crate::ln::features::{InitFeatures, NodeFeatures};
23 use crate::ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, OnionMessageHandler, RoutingMessageHandler};
24 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
25 use crate::util::ser::{VecWriter, Writeable, Writer};
26 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
28 use crate::ln::wire::Encode;
29 use crate::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
30 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId};
31 use crate::util::atomic_counter::AtomicCounter;
32 use crate::util::events::{MessageSendEvent, MessageSendEventsProvider, OnionMessageProvider};
33 use crate::util::logger::Logger;
35 use crate::prelude::*;
37 use alloc::collections::LinkedList;
38 use crate::sync::{Arc, Mutex, MutexGuard, FairRwLock};
39 use core::sync::atomic::{AtomicBool, AtomicU32, Ordering};
40 use core::{cmp, hash, fmt, mem};
42 use core::convert::Infallible;
43 #[cfg(feature = "std")] use std::error;
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
47 use bitcoin::hashes::{HashEngine, Hash};
49 /// 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)>;
69 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
70 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
71 pub struct IgnoringMessageHandler{}
72 impl MessageSendEventsProvider for IgnoringMessageHandler {
73 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
75 impl RoutingMessageHandler for IgnoringMessageHandler {
76 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
77 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
78 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
79 fn get_next_channel_announcement(&self, _starting_point: u64) ->
80 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
81 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
82 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
83 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
84 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
85 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
86 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
87 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
88 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
91 fn processing_queue_high(&self) -> bool { false }
93 impl OnionMessageProvider for IgnoringMessageHandler {
94 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
96 impl OnionMessageHandler for IgnoringMessageHandler {
97 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
98 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
99 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
100 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
101 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
102 InitFeatures::empty()
105 impl CustomOnionMessageHandler for IgnoringMessageHandler {
106 type CustomMessage = Infallible;
107 fn handle_custom_message(&self, _msg: Infallible) {
108 // Since we always return `None` in the read the handle method should never be called.
111 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
116 impl CustomOnionMessageContents for Infallible {
117 fn tlv_type(&self) -> u64 { unreachable!(); }
120 impl Deref for IgnoringMessageHandler {
121 type Target = IgnoringMessageHandler;
122 fn deref(&self) -> &Self { self }
125 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
126 // method that takes self for it.
127 impl wire::Type for Infallible {
128 fn type_id(&self) -> u16 {
132 impl Writeable for Infallible {
133 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
138 impl wire::CustomMessageReader for IgnoringMessageHandler {
139 type CustomMessage = Infallible;
140 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
145 impl CustomMessageHandler for IgnoringMessageHandler {
146 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
147 // Since we always return `None` in the read the handle method should never be called.
151 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
154 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
155 /// You can provide one of these as the route_handler in a MessageHandler.
156 pub struct ErroringMessageHandler {
157 message_queue: Mutex<Vec<MessageSendEvent>>
159 impl ErroringMessageHandler {
160 /// Constructs a new ErroringMessageHandler
161 pub fn new() -> Self {
162 Self { message_queue: Mutex::new(Vec::new()) }
164 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
165 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
166 action: msgs::ErrorAction::SendErrorMessage {
167 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
169 node_id: node_id.clone(),
173 impl MessageSendEventsProvider for ErroringMessageHandler {
174 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
175 let mut res = Vec::new();
176 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
180 impl ChannelMessageHandler for ErroringMessageHandler {
181 // Any messages which are related to a specific channel generate an error message to let the
182 // peer know we don't care about channels.
183 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
184 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
186 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
187 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
189 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
190 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
192 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
193 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
195 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
196 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
198 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
199 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
201 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
202 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
204 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
205 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
207 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
208 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
210 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
211 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
213 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
214 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
216 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
217 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
219 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
220 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
222 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
223 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
225 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
226 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
228 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
229 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
231 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
232 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
233 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
234 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
235 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
236 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
237 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
238 // Set a number of features which various nodes may require to talk to us. It's totally
239 // reasonable to indicate we "support" all kinds of channel features...we just reject all
241 let mut features = InitFeatures::empty();
242 features.set_data_loss_protect_optional();
243 features.set_upfront_shutdown_script_optional();
244 features.set_variable_length_onion_optional();
245 features.set_static_remote_key_optional();
246 features.set_payment_secret_optional();
247 features.set_basic_mpp_optional();
248 features.set_wumbo_optional();
249 features.set_shutdown_any_segwit_optional();
250 features.set_channel_type_optional();
251 features.set_scid_privacy_optional();
252 features.set_zero_conf_optional();
256 impl Deref for ErroringMessageHandler {
257 type Target = ErroringMessageHandler;
258 fn deref(&self) -> &Self { self }
261 /// Provides references to trait impls which handle different types of messages.
262 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref> where
263 CM::Target: ChannelMessageHandler,
264 RM::Target: RoutingMessageHandler,
265 OM::Target: OnionMessageHandler,
267 /// A message handler which handles messages specific to channels. Usually this is just a
268 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
270 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
271 pub chan_handler: CM,
272 /// A message handler which handles messages updating our knowledge of the network channel
273 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
275 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
276 pub route_handler: RM,
278 /// A message handler which handles onion messages. For now, this can only be an
279 /// [`IgnoringMessageHandler`].
280 pub onion_message_handler: OM,
283 /// Provides an object which can be used to send data to and which uniquely identifies a connection
284 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
285 /// implement Hash to meet the PeerManager API.
287 /// For efficiency, Clone should be relatively cheap for this type.
289 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
290 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
291 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
292 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
293 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
294 /// to simply use another value which is guaranteed to be globally unique instead.
295 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
296 /// Attempts to send some data from the given slice to the peer.
298 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
299 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
300 /// called and further write attempts may occur until that time.
302 /// If the returned size is smaller than `data.len()`, a
303 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
304 /// written. Additionally, until a `send_data` event completes fully, no further
305 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
306 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
309 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
310 /// (indicating that read events should be paused to prevent DoS in the send buffer),
311 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
312 /// `resume_read` of false carries no meaning, and should not cause any action.
313 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
314 /// Disconnect the socket pointed to by this SocketDescriptor.
316 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
317 /// call (doing so is a noop).
318 fn disconnect_socket(&mut self);
321 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
322 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
325 pub struct PeerHandleError { }
326 impl fmt::Debug for PeerHandleError {
327 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
328 formatter.write_str("Peer Sent Invalid Data")
331 impl fmt::Display for PeerHandleError {
332 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
333 formatter.write_str("Peer Sent Invalid Data")
337 #[cfg(feature = "std")]
338 impl error::Error for PeerHandleError {
339 fn description(&self) -> &str {
340 "Peer Sent Invalid Data"
344 enum InitSyncTracker{
346 ChannelsSyncing(u64),
347 NodesSyncing(NodeId),
350 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
351 /// forwarding gossip messages to peers altogether.
352 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
354 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
355 /// we have fewer than this many messages in the outbound buffer again.
356 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
357 /// refilled as we send bytes.
358 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
359 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
361 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
363 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
364 /// the socket receive buffer before receiving the ping.
366 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
367 /// including any network delays, outbound traffic, or the same for messages from other peers.
369 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
370 /// per connected peer to respond to a ping, as long as they send us at least one message during
371 /// each tick, ensuring we aren't actually just disconnected.
372 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
375 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
376 /// two connected peers, assuming most LDK-running systems have at least two cores.
377 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
379 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
380 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
381 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
382 /// process before the next ping.
384 /// Note that we continue responding to other messages even after we've sent this many messages, so
385 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
386 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
387 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
390 channel_encryptor: PeerChannelEncryptor,
391 /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
392 /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
393 their_node_id: Option<(PublicKey, NodeId)>,
394 /// The features provided in the peer's [`msgs::Init`] message.
396 /// This is set only after we've processed the [`msgs::Init`] message and called relevant
397 /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
398 /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
400 their_features: Option<InitFeatures>,
401 their_net_address: Option<NetAddress>,
403 pending_outbound_buffer: LinkedList<Vec<u8>>,
404 pending_outbound_buffer_first_msg_offset: usize,
405 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
406 /// prioritize channel messages over them.
408 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
409 gossip_broadcast_buffer: LinkedList<Vec<u8>>,
410 awaiting_write_event: bool,
412 pending_read_buffer: Vec<u8>,
413 pending_read_buffer_pos: usize,
414 pending_read_is_header: bool,
416 sync_status: InitSyncTracker,
418 msgs_sent_since_pong: usize,
419 awaiting_pong_timer_tick_intervals: i8,
420 received_message_since_timer_tick: bool,
421 sent_gossip_timestamp_filter: bool,
423 /// Indicates we've received a `channel_announcement` since the last time we had
424 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
425 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
426 /// check if we're gossip-processing-backlogged).
427 received_channel_announce_since_backlogged: bool,
429 inbound_connection: bool,
433 /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
434 /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
436 fn handshake_complete(&self) -> bool {
437 self.their_features.is_some()
440 /// Returns true if the channel announcements/updates for the given channel should be
441 /// forwarded to this peer.
442 /// If we are sending our routing table to this peer and we have not yet sent channel
443 /// announcements/updates for the given channel_id then we will send it when we get to that
444 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
445 /// sent the old versions, we should send the update, and so return true here.
446 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
447 if !self.handshake_complete() { return false; }
448 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
449 !self.sent_gossip_timestamp_filter {
452 match self.sync_status {
453 InitSyncTracker::NoSyncRequested => true,
454 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
455 InitSyncTracker::NodesSyncing(_) => true,
459 /// Similar to the above, but for node announcements indexed by node_id.
460 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
461 if !self.handshake_complete() { return false; }
462 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
463 !self.sent_gossip_timestamp_filter {
466 match self.sync_status {
467 InitSyncTracker::NoSyncRequested => true,
468 InitSyncTracker::ChannelsSyncing(_) => false,
469 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
473 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
474 /// buffer still has space and we don't need to pause reads to get some writes out.
475 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
476 if !gossip_processing_backlogged {
477 self.received_channel_announce_since_backlogged = false;
479 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
480 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
483 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
484 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
485 fn should_buffer_gossip_backfill(&self) -> bool {
486 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
487 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
488 && self.handshake_complete()
491 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
492 /// every time the peer's buffer may have been drained.
493 fn should_buffer_onion_message(&self) -> bool {
494 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
495 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
498 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
499 /// buffer. This is checked every time the peer's buffer may have been drained.
500 fn should_buffer_gossip_broadcast(&self) -> bool {
501 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
502 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
505 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
506 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
507 let total_outbound_buffered =
508 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
510 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
511 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
514 fn set_their_node_id(&mut self, node_id: PublicKey) {
515 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
519 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
520 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
521 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
522 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
523 /// issues such as overly long function definitions.
525 /// (C-not exported) as `Arc`s don't make sense in bindings.
526 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>>;
528 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
529 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
530 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
531 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
532 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
533 /// helps with issues such as long function definitions.
535 /// (C-not exported) as general type aliases don't make sense in bindings.
536 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>;
538 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
539 /// socket events into messages which it passes on to its [`MessageHandler`].
541 /// Locks are taken internally, so you must never assume that reentrancy from a
542 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
544 /// Calls to [`read_event`] will decode relevant messages and pass them to the
545 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
546 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
547 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
548 /// calls only after previous ones have returned.
550 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
551 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
552 /// essentially you should default to using a SimpleRefPeerManager, and use a
553 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
554 /// you're using lightning-net-tokio.
556 /// [`read_event`]: PeerManager::read_event
557 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
558 CM::Target: ChannelMessageHandler,
559 RM::Target: RoutingMessageHandler,
560 OM::Target: OnionMessageHandler,
562 CMH::Target: CustomMessageHandler,
563 NS::Target: NodeSigner {
564 message_handler: MessageHandler<CM, RM, OM>,
565 /// Connection state for each connected peer - we have an outer read-write lock which is taken
566 /// as read while we're doing processing for a peer and taken write when a peer is being added
569 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
570 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
571 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
572 /// the `MessageHandler`s for a given peer is already guaranteed.
573 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
574 /// Only add to this set when noise completes.
575 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
576 /// lock held. Entries may be added with only the `peers` read lock held (though the
577 /// `Descriptor` value must already exist in `peers`).
578 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
579 /// We can only have one thread processing events at once, but we don't usually need the full
580 /// `peers` write lock to do so, so instead we block on this empty mutex when entering
581 /// `process_events`.
582 event_processing_lock: Mutex<()>,
583 /// Because event processing is global and always does all available work before returning,
584 /// there is no reason for us to have many event processors waiting on the lock at once.
585 /// Instead, we limit the total blocked event processors to always exactly one by setting this
586 /// when an event process call is waiting.
587 blocked_event_processors: AtomicBool,
589 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
590 /// value increases strictly since we don't assume access to a time source.
591 last_node_announcement_serial: AtomicU32,
593 ephemeral_key_midstate: Sha256Engine,
594 custom_message_handler: CMH,
596 peer_counter: AtomicCounter,
598 gossip_processing_backlogged: AtomicBool,
599 gossip_processing_backlog_lifted: AtomicBool,
604 secp_ctx: Secp256k1<secp256k1::SignOnly>
607 enum MessageHandlingError {
608 PeerHandleError(PeerHandleError),
609 LightningError(LightningError),
612 impl From<PeerHandleError> for MessageHandlingError {
613 fn from(error: PeerHandleError) -> Self {
614 MessageHandlingError::PeerHandleError(error)
618 impl From<LightningError> for MessageHandlingError {
619 fn from(error: LightningError) -> Self {
620 MessageHandlingError::LightningError(error)
624 macro_rules! encode_msg {
626 let mut buffer = VecWriter(Vec::new());
627 wire::write($msg, &mut buffer).unwrap();
632 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
633 CM::Target: ChannelMessageHandler,
634 OM::Target: OnionMessageHandler,
636 NS::Target: NodeSigner {
637 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
638 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
641 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
642 /// cryptographically secure random bytes.
644 /// `current_time` is used as an always-increasing counter that survives across restarts and is
645 /// incremented irregularly internally. In general it is best to simply use the current UNIX
646 /// timestamp, however if it is not available a persistent counter that increases once per
647 /// minute should suffice.
649 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
650 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 {
651 Self::new(MessageHandler {
652 chan_handler: channel_message_handler,
653 route_handler: IgnoringMessageHandler{},
654 onion_message_handler,
655 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
659 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
660 RM::Target: RoutingMessageHandler,
662 NS::Target: NodeSigner {
663 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
664 /// handler or onion message handler is used and onion and channel messages will be ignored (or
665 /// generate error messages). Note that some other lightning implementations time-out connections
666 /// after some time if no channel is built with the peer.
668 /// `current_time` is used as an always-increasing counter that survives across restarts and is
669 /// incremented irregularly internally. In general it is best to simply use the current UNIX
670 /// timestamp, however if it is not available a persistent counter that increases once per
671 /// minute should suffice.
673 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
674 /// cryptographically secure random bytes.
676 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
677 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
678 Self::new(MessageHandler {
679 chan_handler: ErroringMessageHandler::new(),
680 route_handler: routing_message_handler,
681 onion_message_handler: IgnoringMessageHandler{},
682 }, current_time, ephemeral_random_data, logger, IgnoringMessageHandler{}, node_signer)
686 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
687 /// This works around `format!()` taking a reference to each argument, preventing
688 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
689 /// due to lifetime errors.
690 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
691 impl core::fmt::Display for OptionalFromDebugger<'_> {
692 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
693 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
697 /// A function used to filter out local or private addresses
698 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
699 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
700 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
702 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
703 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
704 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
705 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
706 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
707 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
708 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
709 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
710 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
711 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
712 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
713 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
714 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
715 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
716 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
717 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
718 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
719 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
720 // For remaining addresses
721 Some(NetAddress::IPv6{addr: _, port: _}) => None,
722 Some(..) => ip_address,
727 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
728 CM::Target: ChannelMessageHandler,
729 RM::Target: RoutingMessageHandler,
730 OM::Target: OnionMessageHandler,
732 CMH::Target: CustomMessageHandler,
733 NS::Target: NodeSigner
735 /// Constructs a new PeerManager with the given message handlers and node_id secret key
736 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
737 /// cryptographically secure random bytes.
739 /// `current_time` is used as an always-increasing counter that survives across restarts and is
740 /// incremented irregularly internally. In general it is best to simply use the current UNIX
741 /// timestamp, however if it is not available a persistent counter that increases once per
742 /// minute should suffice.
743 pub fn new(message_handler: MessageHandler<CM, RM, OM>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH, node_signer: NS) -> Self {
744 let mut ephemeral_key_midstate = Sha256::engine();
745 ephemeral_key_midstate.input(ephemeral_random_data);
747 let mut secp_ctx = Secp256k1::signing_only();
748 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).into_inner();
749 secp_ctx.seeded_randomize(&ephemeral_hash);
753 peers: FairRwLock::new(HashMap::new()),
754 node_id_to_descriptor: Mutex::new(HashMap::new()),
755 event_processing_lock: Mutex::new(()),
756 blocked_event_processors: AtomicBool::new(false),
757 ephemeral_key_midstate,
758 peer_counter: AtomicCounter::new(),
759 gossip_processing_backlogged: AtomicBool::new(false),
760 gossip_processing_backlog_lifted: AtomicBool::new(false),
761 last_node_announcement_serial: AtomicU32::new(current_time),
763 custom_message_handler,
769 /// Get a list of tuples mapping from node id to network addresses for peers which have
770 /// completed the initial handshake.
772 /// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
773 /// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
774 /// handshake has completed and we are sure the remote peer has the private key for the given
777 /// The returned `Option`s will only be `Some` if an address had been previously given via
778 /// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
779 pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<NetAddress>)> {
780 let peers = self.peers.read().unwrap();
781 peers.values().filter_map(|peer_mutex| {
782 let p = peer_mutex.lock().unwrap();
783 if !p.handshake_complete() {
786 Some((p.their_node_id.unwrap().0, p.their_net_address.clone()))
790 fn get_ephemeral_key(&self) -> SecretKey {
791 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
792 let counter = self.peer_counter.get_increment();
793 ephemeral_hash.input(&counter.to_le_bytes());
794 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
797 /// Indicates a new outbound connection has been established to a node with the given `node_id`
798 /// and an optional remote network address.
800 /// The remote network address adds the option to report a remote IP address back to a connecting
801 /// peer using the init message.
802 /// The user should pass the remote network address of the host they are connected to.
804 /// If an `Err` is returned here you must disconnect the connection immediately.
806 /// Returns a small number of bytes to send to the remote node (currently always 50).
808 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
809 /// [`socket_disconnected()`].
811 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
812 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
813 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
814 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
815 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
817 let mut peers = self.peers.write().unwrap();
818 match peers.entry(descriptor) {
819 hash_map::Entry::Occupied(_) => {
820 debug_assert!(false, "PeerManager driver duplicated descriptors!");
821 Err(PeerHandleError {})
823 hash_map::Entry::Vacant(e) => {
824 e.insert(Mutex::new(Peer {
825 channel_encryptor: peer_encryptor,
827 their_features: None,
828 their_net_address: remote_network_address,
830 pending_outbound_buffer: LinkedList::new(),
831 pending_outbound_buffer_first_msg_offset: 0,
832 gossip_broadcast_buffer: LinkedList::new(),
833 awaiting_write_event: false,
836 pending_read_buffer_pos: 0,
837 pending_read_is_header: false,
839 sync_status: InitSyncTracker::NoSyncRequested,
841 msgs_sent_since_pong: 0,
842 awaiting_pong_timer_tick_intervals: 0,
843 received_message_since_timer_tick: false,
844 sent_gossip_timestamp_filter: false,
846 received_channel_announce_since_backlogged: false,
847 inbound_connection: false,
854 /// Indicates a new inbound connection has been established to a node with an optional remote
857 /// The remote network address adds the option to report a remote IP address back to a connecting
858 /// peer using the init message.
859 /// The user should pass the remote network address of the host they are connected to.
861 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
862 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
863 /// the connection immediately.
865 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
866 /// [`socket_disconnected()`].
868 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
869 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
870 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
871 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
873 let mut peers = self.peers.write().unwrap();
874 match peers.entry(descriptor) {
875 hash_map::Entry::Occupied(_) => {
876 debug_assert!(false, "PeerManager driver duplicated descriptors!");
877 Err(PeerHandleError {})
879 hash_map::Entry::Vacant(e) => {
880 e.insert(Mutex::new(Peer {
881 channel_encryptor: peer_encryptor,
883 their_features: None,
884 their_net_address: remote_network_address,
886 pending_outbound_buffer: LinkedList::new(),
887 pending_outbound_buffer_first_msg_offset: 0,
888 gossip_broadcast_buffer: LinkedList::new(),
889 awaiting_write_event: false,
892 pending_read_buffer_pos: 0,
893 pending_read_is_header: false,
895 sync_status: InitSyncTracker::NoSyncRequested,
897 msgs_sent_since_pong: 0,
898 awaiting_pong_timer_tick_intervals: 0,
899 received_message_since_timer_tick: false,
900 sent_gossip_timestamp_filter: false,
902 received_channel_announce_since_backlogged: false,
903 inbound_connection: true,
910 fn peer_should_read(&self, peer: &mut Peer) -> bool {
911 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
914 fn update_gossip_backlogged(&self) {
915 let new_state = self.message_handler.route_handler.processing_queue_high();
916 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
917 if prev_state && !new_state {
918 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
922 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
923 let mut have_written = false;
924 while !peer.awaiting_write_event {
925 if peer.should_buffer_onion_message() {
926 if let Some((peer_node_id, _)) = peer.their_node_id {
927 if let Some(next_onion_message) =
928 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
929 self.enqueue_message(peer, &next_onion_message);
933 if peer.should_buffer_gossip_broadcast() {
934 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
935 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(&msg[..]));
938 if peer.should_buffer_gossip_backfill() {
939 match peer.sync_status {
940 InitSyncTracker::NoSyncRequested => {},
941 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
942 if let Some((announce, update_a_option, update_b_option)) =
943 self.message_handler.route_handler.get_next_channel_announcement(c)
945 self.enqueue_message(peer, &announce);
946 if let Some(update_a) = update_a_option {
947 self.enqueue_message(peer, &update_a);
949 if let Some(update_b) = update_b_option {
950 self.enqueue_message(peer, &update_b);
952 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
954 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
957 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
958 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
959 self.enqueue_message(peer, &msg);
960 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
962 peer.sync_status = InitSyncTracker::NoSyncRequested;
965 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
966 InitSyncTracker::NodesSyncing(sync_node_id) => {
967 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
968 self.enqueue_message(peer, &msg);
969 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
971 peer.sync_status = InitSyncTracker::NoSyncRequested;
976 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
977 self.maybe_send_extra_ping(peer);
980 let should_read = self.peer_should_read(peer);
981 let next_buff = match peer.pending_outbound_buffer.front() {
983 if force_one_write && !have_written {
985 let data_sent = descriptor.send_data(&[], should_read);
986 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
994 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
995 let data_sent = descriptor.send_data(pending, should_read);
997 peer.pending_outbound_buffer_first_msg_offset += data_sent;
998 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
999 peer.pending_outbound_buffer_first_msg_offset = 0;
1000 peer.pending_outbound_buffer.pop_front();
1002 peer.awaiting_write_event = true;
1007 /// Indicates that there is room to write data to the given socket descriptor.
1009 /// May return an Err to indicate that the connection should be closed.
1011 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1012 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1013 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1014 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
1017 /// [`send_data`]: SocketDescriptor::send_data
1018 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1019 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1020 let peers = self.peers.read().unwrap();
1021 match peers.get(descriptor) {
1023 // This is most likely a simple race condition where the user found that the socket
1024 // was writeable, then we told the user to `disconnect_socket()`, then they called
1025 // this method. Return an error to make sure we get disconnected.
1026 return Err(PeerHandleError { });
1028 Some(peer_mutex) => {
1029 let mut peer = peer_mutex.lock().unwrap();
1030 peer.awaiting_write_event = false;
1031 self.do_attempt_write_data(descriptor, &mut peer, false);
1037 /// Indicates that data was read from the given socket descriptor.
1039 /// May return an Err to indicate that the connection should be closed.
1041 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1042 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1043 /// [`send_data`] calls to handle responses.
1045 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1046 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1049 /// In order to avoid processing too many messages at once per peer, `data` should be on the
1052 /// [`send_data`]: SocketDescriptor::send_data
1053 /// [`process_events`]: PeerManager::process_events
1054 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1055 match self.do_read_event(peer_descriptor, data) {
1058 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
1059 self.disconnect_event_internal(peer_descriptor);
1065 /// Append a message to a peer's pending outbound/write buffer
1066 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1067 if is_gossip_msg(message.type_id()) {
1068 log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1070 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1072 peer.msgs_sent_since_pong += 1;
1073 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1076 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1077 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: Vec<u8>) {
1078 peer.msgs_sent_since_pong += 1;
1079 peer.gossip_broadcast_buffer.push_back(encoded_message);
1082 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1083 let mut pause_read = false;
1084 let peers = self.peers.read().unwrap();
1085 let mut msgs_to_forward = Vec::new();
1086 let mut peer_node_id = None;
1087 match peers.get(peer_descriptor) {
1089 // This is most likely a simple race condition where the user read some bytes
1090 // from the socket, then we told the user to `disconnect_socket()`, then they
1091 // called this method. Return an error to make sure we get disconnected.
1092 return Err(PeerHandleError { });
1094 Some(peer_mutex) => {
1095 let mut read_pos = 0;
1096 while read_pos < data.len() {
1097 macro_rules! try_potential_handleerror {
1098 ($peer: expr, $thing: expr) => {
1103 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
1104 //TODO: Try to push msg
1105 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1106 return Err(PeerHandleError { });
1108 msgs::ErrorAction::IgnoreAndLog(level) => {
1109 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1112 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1113 msgs::ErrorAction::IgnoreError => {
1114 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1117 msgs::ErrorAction::SendErrorMessage { msg } => {
1118 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1119 self.enqueue_message($peer, &msg);
1122 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1123 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1124 self.enqueue_message($peer, &msg);
1133 let mut peer_lock = peer_mutex.lock().unwrap();
1134 let peer = &mut *peer_lock;
1135 let mut msg_to_handle = None;
1136 if peer_node_id.is_none() {
1137 peer_node_id = peer.their_node_id.clone();
1140 assert!(peer.pending_read_buffer.len() > 0);
1141 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1144 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1145 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]);
1146 read_pos += data_to_copy;
1147 peer.pending_read_buffer_pos += data_to_copy;
1150 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1151 peer.pending_read_buffer_pos = 0;
1153 macro_rules! insert_node_id {
1155 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1156 hash_map::Entry::Occupied(e) => {
1157 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1158 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1159 // Check that the peers map is consistent with the
1160 // node_id_to_descriptor map, as this has been broken
1162 debug_assert!(peers.get(e.get()).is_some());
1163 return Err(PeerHandleError { })
1165 hash_map::Entry::Vacant(entry) => {
1166 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1167 entry.insert(peer_descriptor.clone())
1173 let next_step = peer.channel_encryptor.get_noise_step();
1175 NextNoiseStep::ActOne => {
1176 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1177 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1178 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1179 peer.pending_outbound_buffer.push_back(act_two);
1180 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1182 NextNoiseStep::ActTwo => {
1183 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1184 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1185 &self.node_signer));
1186 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1187 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1188 peer.pending_read_is_header = true;
1190 peer.set_their_node_id(their_node_id);
1192 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1193 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1194 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1195 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1196 self.enqueue_message(peer, &resp);
1197 peer.awaiting_pong_timer_tick_intervals = 0;
1199 NextNoiseStep::ActThree => {
1200 let their_node_id = try_potential_handleerror!(peer,
1201 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1202 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1203 peer.pending_read_is_header = true;
1204 peer.set_their_node_id(their_node_id);
1206 let features = self.message_handler.chan_handler.provided_init_features(&their_node_id)
1207 .or(self.message_handler.route_handler.provided_init_features(&their_node_id))
1208 .or(self.message_handler.onion_message_handler.provided_init_features(&their_node_id));
1209 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
1210 self.enqueue_message(peer, &resp);
1211 peer.awaiting_pong_timer_tick_intervals = 0;
1213 NextNoiseStep::NoiseComplete => {
1214 if peer.pending_read_is_header {
1215 let msg_len = try_potential_handleerror!(peer,
1216 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1217 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1218 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1219 if msg_len < 2 { // Need at least the message type tag
1220 return Err(PeerHandleError { });
1222 peer.pending_read_is_header = false;
1224 let msg_data = try_potential_handleerror!(peer,
1225 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
1226 assert!(msg_data.len() >= 2);
1228 // Reset read buffer
1229 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1230 peer.pending_read_buffer.resize(18, 0);
1231 peer.pending_read_is_header = true;
1233 let mut reader = io::Cursor::new(&msg_data[..]);
1234 let message_result = wire::read(&mut reader, &*self.custom_message_handler);
1235 let message = match message_result {
1239 // Note that to avoid recursion we never call
1240 // `do_attempt_write_data` from here, causing
1241 // the messages enqueued here to not actually
1242 // be sent before the peer is disconnected.
1243 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1244 log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1247 (msgs::DecodeError::UnsupportedCompression, _) => {
1248 log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1249 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1252 (_, Some(ty)) if is_gossip_msg(ty) => {
1253 log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1254 self.enqueue_message(peer, &msgs::WarningMessage {
1255 channel_id: [0; 32],
1256 data: format!("Unreadable/bogus gossip message of type {}", ty),
1260 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1261 log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1262 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1263 return Err(PeerHandleError { });
1265 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1266 (msgs::DecodeError::InvalidValue, _) => {
1267 log_debug!(self.logger, "Got an invalid value while deserializing message");
1268 return Err(PeerHandleError { });
1270 (msgs::DecodeError::ShortRead, _) => {
1271 log_debug!(self.logger, "Deserialization failed due to shortness of message");
1272 return Err(PeerHandleError { });
1274 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1275 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1280 msg_to_handle = Some(message);
1285 pause_read = !self.peer_should_read(peer);
1287 if let Some(message) = msg_to_handle {
1288 match self.handle_message(&peer_mutex, peer_lock, message) {
1289 Err(handling_error) => match handling_error {
1290 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1291 MessageHandlingError::LightningError(e) => {
1292 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1296 msgs_to_forward.push(msg);
1305 for msg in msgs_to_forward.drain(..) {
1306 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1312 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1313 /// Returns the message back if it needs to be broadcasted to all other peers.
1316 peer_mutex: &Mutex<Peer>,
1317 mut peer_lock: MutexGuard<Peer>,
1318 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1319 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1320 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;
1321 peer_lock.received_message_since_timer_tick = true;
1323 // Need an Init as first message
1324 if let wire::Message::Init(msg) = message {
1325 if msg.features.requires_unknown_bits() {
1326 log_debug!(self.logger, "Peer features required unknown version bits");
1327 return Err(PeerHandleError { }.into());
1329 if peer_lock.their_features.is_some() {
1330 return Err(PeerHandleError { }.into());
1333 log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1335 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1336 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1337 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1340 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1341 log_debug!(self.logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1342 return Err(PeerHandleError { }.into());
1344 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1345 log_debug!(self.logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1346 return Err(PeerHandleError { }.into());
1348 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1349 log_debug!(self.logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1350 return Err(PeerHandleError { }.into());
1353 peer_lock.their_features = Some(msg.features);
1355 } else if peer_lock.their_features.is_none() {
1356 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1357 return Err(PeerHandleError { }.into());
1360 if let wire::Message::GossipTimestampFilter(_msg) = message {
1361 // When supporting gossip messages, start inital gossip sync only after we receive
1362 // a GossipTimestampFilter
1363 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1364 !peer_lock.sent_gossip_timestamp_filter {
1365 peer_lock.sent_gossip_timestamp_filter = true;
1366 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1371 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1372 peer_lock.received_channel_announce_since_backlogged = true;
1375 mem::drop(peer_lock);
1377 if is_gossip_msg(message.type_id()) {
1378 log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1380 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1383 let mut should_forward = None;
1386 // Setup and Control messages:
1387 wire::Message::Init(_) => {
1390 wire::Message::GossipTimestampFilter(_) => {
1393 wire::Message::Error(msg) => {
1394 let mut data_is_printable = true;
1395 for b in msg.data.bytes() {
1396 if b < 32 || b > 126 {
1397 data_is_printable = false;
1402 if data_is_printable {
1403 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1405 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1407 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1408 if msg.channel_id == [0; 32] {
1409 return Err(PeerHandleError { }.into());
1412 wire::Message::Warning(msg) => {
1413 let mut data_is_printable = true;
1414 for b in msg.data.bytes() {
1415 if b < 32 || b > 126 {
1416 data_is_printable = false;
1421 if data_is_printable {
1422 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1424 log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1428 wire::Message::Ping(msg) => {
1429 if msg.ponglen < 65532 {
1430 let resp = msgs::Pong { byteslen: msg.ponglen };
1431 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1434 wire::Message::Pong(_msg) => {
1435 let mut peer_lock = peer_mutex.lock().unwrap();
1436 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1437 peer_lock.msgs_sent_since_pong = 0;
1440 // Channel messages:
1441 wire::Message::OpenChannel(msg) => {
1442 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1444 wire::Message::AcceptChannel(msg) => {
1445 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1448 wire::Message::FundingCreated(msg) => {
1449 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1451 wire::Message::FundingSigned(msg) => {
1452 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1454 wire::Message::ChannelReady(msg) => {
1455 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1458 wire::Message::Shutdown(msg) => {
1459 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1461 wire::Message::ClosingSigned(msg) => {
1462 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1465 // Commitment messages:
1466 wire::Message::UpdateAddHTLC(msg) => {
1467 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1469 wire::Message::UpdateFulfillHTLC(msg) => {
1470 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1472 wire::Message::UpdateFailHTLC(msg) => {
1473 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1475 wire::Message::UpdateFailMalformedHTLC(msg) => {
1476 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1479 wire::Message::CommitmentSigned(msg) => {
1480 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1482 wire::Message::RevokeAndACK(msg) => {
1483 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1485 wire::Message::UpdateFee(msg) => {
1486 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1488 wire::Message::ChannelReestablish(msg) => {
1489 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1492 // Routing messages:
1493 wire::Message::AnnouncementSignatures(msg) => {
1494 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1496 wire::Message::ChannelAnnouncement(msg) => {
1497 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1498 .map_err(|e| -> MessageHandlingError { e.into() })? {
1499 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1501 self.update_gossip_backlogged();
1503 wire::Message::NodeAnnouncement(msg) => {
1504 if self.message_handler.route_handler.handle_node_announcement(&msg)
1505 .map_err(|e| -> MessageHandlingError { e.into() })? {
1506 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1508 self.update_gossip_backlogged();
1510 wire::Message::ChannelUpdate(msg) => {
1511 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1512 if self.message_handler.route_handler.handle_channel_update(&msg)
1513 .map_err(|e| -> MessageHandlingError { e.into() })? {
1514 should_forward = Some(wire::Message::ChannelUpdate(msg));
1516 self.update_gossip_backlogged();
1518 wire::Message::QueryShortChannelIds(msg) => {
1519 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1521 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1522 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1524 wire::Message::QueryChannelRange(msg) => {
1525 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1527 wire::Message::ReplyChannelRange(msg) => {
1528 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1532 wire::Message::OnionMessage(msg) => {
1533 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1536 // Unknown messages:
1537 wire::Message::Unknown(type_id) if message.is_even() => {
1538 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1539 return Err(PeerHandleError { }.into());
1541 wire::Message::Unknown(type_id) => {
1542 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1544 wire::Message::Custom(custom) => {
1545 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1551 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>) {
1553 wire::Message::ChannelAnnouncement(ref msg) => {
1554 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1555 let encoded_msg = encode_msg!(msg);
1557 for (_, peer_mutex) in peers.iter() {
1558 let mut peer = peer_mutex.lock().unwrap();
1559 if !peer.handshake_complete() ||
1560 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1563 debug_assert!(peer.their_node_id.is_some());
1564 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1565 if peer.buffer_full_drop_gossip_broadcast() {
1566 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1569 if let Some((_, their_node_id)) = peer.their_node_id {
1570 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1574 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1577 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1580 wire::Message::NodeAnnouncement(ref msg) => {
1581 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1582 let encoded_msg = encode_msg!(msg);
1584 for (_, peer_mutex) in peers.iter() {
1585 let mut peer = peer_mutex.lock().unwrap();
1586 if !peer.handshake_complete() ||
1587 !peer.should_forward_node_announcement(msg.contents.node_id) {
1590 debug_assert!(peer.their_node_id.is_some());
1591 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1592 if peer.buffer_full_drop_gossip_broadcast() {
1593 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1596 if let Some((_, their_node_id)) = peer.their_node_id {
1597 if their_node_id == msg.contents.node_id {
1601 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1604 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1607 wire::Message::ChannelUpdate(ref msg) => {
1608 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1609 let encoded_msg = encode_msg!(msg);
1611 for (_, peer_mutex) in peers.iter() {
1612 let mut peer = peer_mutex.lock().unwrap();
1613 if !peer.handshake_complete() ||
1614 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1617 debug_assert!(peer.their_node_id.is_some());
1618 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1619 if peer.buffer_full_drop_gossip_broadcast() {
1620 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1623 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1626 self.enqueue_encoded_gossip_broadcast(&mut *peer, encoded_msg.clone());
1629 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1633 /// Checks for any events generated by our handlers and processes them. Includes sending most
1634 /// response messages as well as messages generated by calls to handler functions directly (eg
1635 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1637 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1640 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1641 /// or one of the other clients provided in our language bindings.
1643 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1644 /// without doing any work. All available events that need handling will be handled before the
1645 /// other calls return.
1647 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1648 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1649 /// [`send_data`]: SocketDescriptor::send_data
1650 pub fn process_events(&self) {
1651 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1652 if _single_processor_lock.is_err() {
1653 // While we could wake the older sleeper here with a CV and make more even waiting
1654 // times, that would be a lot of overengineering for a simple "reduce total waiter
1656 match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1658 debug_assert!(val, "compare_exchange failed spuriously?");
1662 debug_assert!(!val, "compare_exchange succeeded spuriously?");
1663 // We're the only waiter, as the running process_events may have emptied the
1664 // pending events "long" ago and there are new events for us to process, wait until
1665 // its done and process any leftover events before returning.
1666 _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1667 self.blocked_event_processors.store(false, Ordering::Release);
1672 self.update_gossip_backlogged();
1673 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1675 let mut peers_to_disconnect = HashMap::new();
1676 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1677 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1680 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1681 // buffer by doing things like announcing channels on another node. We should be willing to
1682 // drop optional-ish messages when send buffers get full!
1684 let peers_lock = self.peers.read().unwrap();
1685 let peers = &*peers_lock;
1686 macro_rules! get_peer_for_forwarding {
1687 ($node_id: expr) => {
1689 if peers_to_disconnect.get($node_id).is_some() {
1690 // If we've "disconnected" this peer, do not send to it.
1693 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1694 match descriptor_opt {
1695 Some(descriptor) => match peers.get(&descriptor) {
1696 Some(peer_mutex) => {
1697 let peer_lock = peer_mutex.lock().unwrap();
1698 if !peer_lock.handshake_complete() {
1704 debug_assert!(false, "Inconsistent peers set state!");
1715 for event in events_generated.drain(..) {
1717 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1718 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1719 log_pubkey!(node_id),
1720 log_bytes!(msg.temporary_channel_id));
1721 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1723 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1724 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1725 log_pubkey!(node_id),
1726 log_bytes!(msg.temporary_channel_id));
1727 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1729 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1730 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1731 log_pubkey!(node_id),
1732 log_bytes!(msg.temporary_channel_id),
1733 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1734 // TODO: If the peer is gone we should generate a DiscardFunding event
1735 // indicating to the wallet that they should just throw away this funding transaction
1736 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1738 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1739 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1740 log_pubkey!(node_id),
1741 log_bytes!(msg.channel_id));
1742 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1744 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1745 log_debug!(self.logger, "Handling SendChannelReady event in peer_handler for node {} for channel {}",
1746 log_pubkey!(node_id),
1747 log_bytes!(msg.channel_id));
1748 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1750 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1751 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1752 log_pubkey!(node_id),
1753 log_bytes!(msg.channel_id));
1754 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1756 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 } } => {
1757 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1758 log_pubkey!(node_id),
1759 update_add_htlcs.len(),
1760 update_fulfill_htlcs.len(),
1761 update_fail_htlcs.len(),
1762 log_bytes!(commitment_signed.channel_id));
1763 let mut peer = get_peer_for_forwarding!(node_id);
1764 for msg in update_add_htlcs {
1765 self.enqueue_message(&mut *peer, msg);
1767 for msg in update_fulfill_htlcs {
1768 self.enqueue_message(&mut *peer, msg);
1770 for msg in update_fail_htlcs {
1771 self.enqueue_message(&mut *peer, msg);
1773 for msg in update_fail_malformed_htlcs {
1774 self.enqueue_message(&mut *peer, msg);
1776 if let &Some(ref msg) = update_fee {
1777 self.enqueue_message(&mut *peer, msg);
1779 self.enqueue_message(&mut *peer, commitment_signed);
1781 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1782 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1783 log_pubkey!(node_id),
1784 log_bytes!(msg.channel_id));
1785 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1787 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1788 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1789 log_pubkey!(node_id),
1790 log_bytes!(msg.channel_id));
1791 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1793 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1794 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1795 log_pubkey!(node_id),
1796 log_bytes!(msg.channel_id));
1797 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1799 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1800 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1801 log_pubkey!(node_id),
1802 log_bytes!(msg.channel_id));
1803 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1805 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
1806 log_debug!(self.logger, "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
1807 log_pubkey!(node_id),
1808 msg.contents.short_channel_id);
1809 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1810 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
1812 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1813 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1814 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1815 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1816 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1819 if let Some(msg) = update_msg {
1820 match self.message_handler.route_handler.handle_channel_update(&msg) {
1821 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1822 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1827 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1828 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1829 match self.message_handler.route_handler.handle_channel_update(&msg) {
1830 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1831 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1835 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1836 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
1837 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1838 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1839 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1843 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1844 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1845 log_pubkey!(node_id), msg.contents.short_channel_id);
1846 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1848 MessageSendEvent::HandleError { ref node_id, ref action } => {
1850 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1851 // We do not have the peers write lock, so we just store that we're
1852 // about to disconenct the peer and do it after we finish
1853 // processing most messages.
1854 peers_to_disconnect.insert(*node_id, msg.clone());
1856 msgs::ErrorAction::IgnoreAndLog(level) => {
1857 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1859 msgs::ErrorAction::IgnoreDuplicateGossip => {},
1860 msgs::ErrorAction::IgnoreError => {
1861 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1863 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1864 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1865 log_pubkey!(node_id),
1867 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1869 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1870 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1871 log_pubkey!(node_id),
1873 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1877 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1878 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1880 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1881 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1883 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1884 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1885 log_pubkey!(node_id),
1886 msg.short_channel_ids.len(),
1888 msg.number_of_blocks,
1890 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1892 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1893 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1898 for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1899 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1900 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1903 for (descriptor, peer_mutex) in peers.iter() {
1904 let mut peer = peer_mutex.lock().unwrap();
1905 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
1906 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
1909 if !peers_to_disconnect.is_empty() {
1910 let mut peers_lock = self.peers.write().unwrap();
1911 let peers = &mut *peers_lock;
1912 for (node_id, msg) in peers_to_disconnect.drain() {
1913 // Note that since we are holding the peers *write* lock we can
1914 // remove from node_id_to_descriptor immediately (as no other
1915 // thread can be holding the peer lock if we have the global write
1918 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1919 if let Some(mut descriptor) = descriptor_opt {
1920 if let Some(peer_mutex) = peers.remove(&descriptor) {
1921 let mut peer = peer_mutex.lock().unwrap();
1922 if let Some(msg) = msg {
1923 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1924 log_pubkey!(node_id),
1926 self.enqueue_message(&mut *peer, &msg);
1927 // This isn't guaranteed to work, but if there is enough free
1928 // room in the send buffer, put the error message there...
1929 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
1931 self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
1932 } else { debug_assert!(false, "Missing connection for peer"); }
1938 /// Indicates that the given socket descriptor's connection is now closed.
1939 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1940 self.disconnect_event_internal(descriptor);
1943 fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
1944 if !peer.handshake_complete() {
1945 log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
1946 descriptor.disconnect_socket();
1950 debug_assert!(peer.their_node_id.is_some());
1951 if let Some((node_id, _)) = peer.their_node_id {
1952 log_trace!(self.logger, "Disconnecting peer with id {} due to {}", node_id, reason);
1953 self.message_handler.chan_handler.peer_disconnected(&node_id);
1954 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
1956 descriptor.disconnect_socket();
1959 fn disconnect_event_internal(&self, descriptor: &Descriptor) {
1960 let mut peers = self.peers.write().unwrap();
1961 let peer_option = peers.remove(descriptor);
1964 // This is most likely a simple race condition where the user found that the socket
1965 // was disconnected, then we told the user to `disconnect_socket()`, then they
1966 // called this method. Either way we're disconnected, return.
1968 Some(peer_lock) => {
1969 let peer = peer_lock.lock().unwrap();
1970 if let Some((node_id, _)) = peer.their_node_id {
1971 log_trace!(self.logger, "Handling disconnection of peer {}", log_pubkey!(node_id));
1972 let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1973 debug_assert!(removed.is_some(), "descriptor maps should be consistent");
1974 if !peer.handshake_complete() { return; }
1975 self.message_handler.chan_handler.peer_disconnected(&node_id);
1976 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
1982 /// Disconnect a peer given its node id.
1984 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1985 /// peer. Thus, be very careful about reentrancy issues.
1987 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1988 pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
1989 let mut peers_lock = self.peers.write().unwrap();
1990 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1991 let peer_opt = peers_lock.remove(&descriptor);
1992 if let Some(peer_mutex) = peer_opt {
1993 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
1994 } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
1998 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1999 /// an indication that TCP sockets have stalled even if we weren't around to time them out
2000 /// using regular ping/pongs.
2001 pub fn disconnect_all_peers(&self) {
2002 let mut peers_lock = self.peers.write().unwrap();
2003 self.node_id_to_descriptor.lock().unwrap().clear();
2004 let peers = &mut *peers_lock;
2005 for (descriptor, peer_mutex) in peers.drain() {
2006 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2010 /// This is called when we're blocked on sending additional gossip messages until we receive a
2011 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2012 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2013 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2014 if peer.awaiting_pong_timer_tick_intervals == 0 {
2015 peer.awaiting_pong_timer_tick_intervals = -1;
2016 let ping = msgs::Ping {
2020 self.enqueue_message(peer, &ping);
2024 /// Send pings to each peer and disconnect those which did not respond to the last round of
2027 /// This may be called on any timescale you want, however, roughly once every ten seconds is
2028 /// preferred. The call rate determines both how often we send a ping to our peers and how much
2029 /// time they have to respond before we disconnect them.
2031 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2034 /// [`send_data`]: SocketDescriptor::send_data
2035 pub fn timer_tick_occurred(&self) {
2036 let mut descriptors_needing_disconnect = Vec::new();
2038 let peers_lock = self.peers.read().unwrap();
2040 self.update_gossip_backlogged();
2041 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2043 for (descriptor, peer_mutex) in peers_lock.iter() {
2044 let mut peer = peer_mutex.lock().unwrap();
2045 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2047 if !peer.handshake_complete() {
2048 // The peer needs to complete its handshake before we can exchange messages. We
2049 // give peers one timer tick to complete handshake, reusing
2050 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2051 // for handshake completion.
2052 if peer.awaiting_pong_timer_tick_intervals != 0 {
2053 descriptors_needing_disconnect.push(descriptor.clone());
2055 peer.awaiting_pong_timer_tick_intervals = 1;
2059 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2060 debug_assert!(peer.their_node_id.is_some());
2062 loop { // Used as a `goto` to skip writing a Ping message.
2063 if peer.awaiting_pong_timer_tick_intervals == -1 {
2064 // Magic value set in `maybe_send_extra_ping`.
2065 peer.awaiting_pong_timer_tick_intervals = 1;
2066 peer.received_message_since_timer_tick = false;
2070 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2071 || peer.awaiting_pong_timer_tick_intervals as u64 >
2072 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2074 descriptors_needing_disconnect.push(descriptor.clone());
2077 peer.received_message_since_timer_tick = false;
2079 if peer.awaiting_pong_timer_tick_intervals > 0 {
2080 peer.awaiting_pong_timer_tick_intervals += 1;
2084 peer.awaiting_pong_timer_tick_intervals = 1;
2085 let ping = msgs::Ping {
2089 self.enqueue_message(&mut *peer, &ping);
2092 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2096 if !descriptors_needing_disconnect.is_empty() {
2098 let mut peers_lock = self.peers.write().unwrap();
2099 for descriptor in descriptors_needing_disconnect {
2100 if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2101 let peer = peer_mutex.lock().unwrap();
2102 if let Some((node_id, _)) = peer.their_node_id {
2103 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2105 self.do_disconnect(descriptor, &*peer, "ping timeout");
2113 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2114 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2115 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2117 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2120 // ...by failing to compile if the number of addresses that would be half of a message is
2121 // smaller than 100:
2122 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2124 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2125 /// peers. Note that peers will likely ignore this message unless we have at least one public
2126 /// channel which has at least six confirmations on-chain.
2128 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2129 /// node to humans. They carry no in-protocol meaning.
2131 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2132 /// accepts incoming connections. These will be included in the node_announcement, publicly
2133 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2134 /// addresses should likely contain only Tor Onion addresses.
2136 /// Panics if `addresses` is absurdly large (more than 100).
2138 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2139 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2140 if addresses.len() > 100 {
2141 panic!("More than half the message size was taken up by public addresses!");
2144 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2145 // addresses be sorted for future compatibility.
2146 addresses.sort_by_key(|addr| addr.get_id());
2148 let features = self.message_handler.chan_handler.provided_node_features()
2149 .or(self.message_handler.route_handler.provided_node_features())
2150 .or(self.message_handler.onion_message_handler.provided_node_features());
2151 let announcement = msgs::UnsignedNodeAnnouncement {
2153 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2154 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2155 rgb, alias, addresses,
2156 excess_address_data: Vec::new(),
2157 excess_data: Vec::new(),
2159 let node_announce_sig = match self.node_signer.sign_gossip_message(
2160 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2164 log_error!(self.logger, "Failed to generate signature for node_announcement");
2169 let msg = msgs::NodeAnnouncement {
2170 signature: node_announce_sig,
2171 contents: announcement
2174 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2175 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2176 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2180 fn is_gossip_msg(type_id: u16) -> bool {
2182 msgs::ChannelAnnouncement::TYPE |
2183 msgs::ChannelUpdate::TYPE |
2184 msgs::NodeAnnouncement::TYPE |
2185 msgs::QueryChannelRange::TYPE |
2186 msgs::ReplyChannelRange::TYPE |
2187 msgs::QueryShortChannelIds::TYPE |
2188 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2195 use crate::chain::keysinterface::{NodeSigner, Recipient};
2196 use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2197 use crate::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2198 use crate::ln::{msgs, wire};
2199 use crate::ln::msgs::NetAddress;
2200 use crate::util::events;
2201 use crate::util::test_utils;
2203 use bitcoin::secp256k1::SecretKey;
2205 use crate::prelude::*;
2206 use crate::sync::{Arc, Mutex};
2207 use core::sync::atomic::{AtomicBool, Ordering};
2210 struct FileDescriptor {
2212 outbound_data: Arc<Mutex<Vec<u8>>>,
2213 disconnect: Arc<AtomicBool>,
2215 impl PartialEq for FileDescriptor {
2216 fn eq(&self, other: &Self) -> bool {
2220 impl Eq for FileDescriptor { }
2221 impl core::hash::Hash for FileDescriptor {
2222 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2223 self.fd.hash(hasher)
2227 impl SocketDescriptor for FileDescriptor {
2228 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2229 self.outbound_data.lock().unwrap().extend_from_slice(data);
2233 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2236 struct PeerManagerCfg {
2237 chan_handler: test_utils::TestChannelMessageHandler,
2238 routing_handler: test_utils::TestRoutingMessageHandler,
2239 logger: test_utils::TestLogger,
2240 node_signer: test_utils::TestNodeSigner,
2243 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2244 let mut cfgs = Vec::new();
2245 for i in 0..peer_count {
2246 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2249 chan_handler: test_utils::TestChannelMessageHandler::new(),
2250 logger: test_utils::TestLogger::new(),
2251 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2252 node_signer: test_utils::TestNodeSigner::new(node_secret),
2260 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>> {
2261 let mut peers = Vec::new();
2262 for i in 0..peer_count {
2263 let ephemeral_bytes = [i as u8; 32];
2264 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler, onion_message_handler: IgnoringMessageHandler {} };
2265 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {}, &cfgs[i].node_signer);
2272 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) {
2273 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2274 let mut fd_a = FileDescriptor {
2275 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2276 disconnect: Arc::new(AtomicBool::new(false)),
2278 let addr_a = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1000};
2279 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2280 let mut fd_b = FileDescriptor {
2281 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2282 disconnect: Arc::new(AtomicBool::new(false)),
2284 let addr_b = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1001};
2285 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2286 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2287 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2288 peer_a.process_events();
2290 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2291 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2293 peer_b.process_events();
2294 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2295 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2297 peer_a.process_events();
2298 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2299 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2301 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
2302 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));
2304 (fd_a.clone(), fd_b.clone())
2308 #[cfg(feature = "std")]
2309 fn fuzz_threaded_connections() {
2310 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2311 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2312 // with our internal map consistency, and is a generally good smoke test of disconnection.
2313 let cfgs = Arc::new(create_peermgr_cfgs(2));
2314 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2315 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2317 let start_time = std::time::Instant::now();
2318 macro_rules! spawn_thread { ($id: expr) => { {
2319 let peers = Arc::clone(&peers);
2320 let cfgs = Arc::clone(&cfgs);
2321 std::thread::spawn(move || {
2323 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2324 let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2325 let mut fd_a = FileDescriptor {
2326 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2327 disconnect: Arc::new(AtomicBool::new(false)),
2329 let addr_a = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1000};
2330 let mut fd_b = FileDescriptor {
2331 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2332 disconnect: Arc::new(AtomicBool::new(false)),
2334 let addr_b = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1001};
2335 let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2336 peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2337 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2339 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2340 peers[0].process_events();
2341 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2342 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2343 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2345 peers[1].process_events();
2346 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2347 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2348 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2350 cfgs[0].chan_handler.pending_events.lock().unwrap()
2351 .push(crate::util::events::MessageSendEvent::SendShutdown {
2352 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2353 msg: msgs::Shutdown {
2354 channel_id: [0; 32],
2355 scriptpubkey: bitcoin::Script::new(),
2358 cfgs[1].chan_handler.pending_events.lock().unwrap()
2359 .push(crate::util::events::MessageSendEvent::SendShutdown {
2360 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2361 msg: msgs::Shutdown {
2362 channel_id: [0; 32],
2363 scriptpubkey: bitcoin::Script::new(),
2367 peers[0].timer_tick_occurred();
2368 peers[1].timer_tick_occurred();
2371 peers[0].socket_disconnected(&fd_a);
2372 peers[1].socket_disconnected(&fd_b);
2374 std::thread::sleep(std::time::Duration::from_micros(1));
2378 let thrd_a = spawn_thread!(1);
2379 let thrd_b = spawn_thread!(2);
2381 thrd_a.join().unwrap();
2382 thrd_b.join().unwrap();
2386 fn test_disconnect_peer() {
2387 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2388 // push a DisconnectPeer event to remove the node flagged by id
2389 let cfgs = create_peermgr_cfgs(2);
2390 let peers = create_network(2, &cfgs);
2391 establish_connection(&peers[0], &peers[1]);
2392 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2394 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2395 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2397 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2400 peers[0].process_events();
2401 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2405 fn test_send_simple_msg() {
2406 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2407 // push a message from one peer to another.
2408 let cfgs = create_peermgr_cfgs(2);
2409 let a_chan_handler = test_utils::TestChannelMessageHandler::new();
2410 let b_chan_handler = test_utils::TestChannelMessageHandler::new();
2411 let mut peers = create_network(2, &cfgs);
2412 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2413 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2415 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2417 let msg = msgs::Shutdown { channel_id: [42; 32], scriptpubkey: bitcoin::Script::new() };
2418 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2419 node_id: their_id, msg: msg.clone()
2421 peers[0].message_handler.chan_handler = &a_chan_handler;
2423 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2424 peers[1].message_handler.chan_handler = &b_chan_handler;
2426 peers[0].process_events();
2428 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2429 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2433 fn test_non_init_first_msg() {
2434 // Simple test of the first message received over a connection being something other than
2435 // Init. This results in an immediate disconnection, which previously included a spurious
2436 // peer_disconnected event handed to event handlers (which would panic in
2437 // `TestChannelMessageHandler` here).
2438 let cfgs = create_peermgr_cfgs(2);
2439 let peers = create_network(2, &cfgs);
2441 let mut fd_dup = FileDescriptor {
2442 fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2443 disconnect: Arc::new(AtomicBool::new(false)),
2445 let addr_dup = NetAddress::IPv4{addr: [127, 0, 0, 1], port: 1003};
2446 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
2447 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
2449 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
2450 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
2451 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
2452 peers[0].process_events();
2454 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
2455 let (act_three, _) =
2456 dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
2457 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
2459 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
2460 let msg_bytes = dup_encryptor.encrypt_message(¬_init_msg);
2461 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
2465 fn test_disconnect_all_peer() {
2466 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2467 // then calls disconnect_all_peers
2468 let cfgs = create_peermgr_cfgs(2);
2469 let peers = create_network(2, &cfgs);
2470 establish_connection(&peers[0], &peers[1]);
2471 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2473 peers[0].disconnect_all_peers();
2474 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2478 fn test_timer_tick_occurred() {
2479 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
2480 let cfgs = create_peermgr_cfgs(2);
2481 let peers = create_network(2, &cfgs);
2482 establish_connection(&peers[0], &peers[1]);
2483 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2485 // peers[0] awaiting_pong is set to true, but the Peer is still connected
2486 peers[0].timer_tick_occurred();
2487 peers[0].process_events();
2488 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2490 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
2491 peers[0].timer_tick_occurred();
2492 peers[0].process_events();
2493 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2497 fn test_do_attempt_write_data() {
2498 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
2499 let cfgs = create_peermgr_cfgs(2);
2500 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2501 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2502 let peers = create_network(2, &cfgs);
2504 // By calling establish_connect, we trigger do_attempt_write_data between
2505 // the peers. Previously this function would mistakenly enter an infinite loop
2506 // when there were more channel messages available than could fit into a peer's
2507 // buffer. This issue would now be detected by this test (because we use custom
2508 // RoutingMessageHandlers that intentionally return more channel messages
2509 // than can fit into a peer's buffer).
2510 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2512 // Make each peer to read the messages that the other peer just wrote to them. Note that
2513 // due to the max-message-before-ping limits this may take a few iterations to complete.
2514 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
2515 peers[1].process_events();
2516 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2517 assert!(!a_read_data.is_empty());
2519 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
2520 peers[0].process_events();
2522 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2523 assert!(!b_read_data.is_empty());
2524 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2526 peers[0].process_events();
2527 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2530 // Check that each peer has received the expected number of channel updates and channel
2532 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2533 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2534 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
2535 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
2539 fn test_handshake_timeout() {
2540 // Tests that we time out a peer still waiting on handshake completion after a full timer
2542 let cfgs = create_peermgr_cfgs(2);
2543 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2544 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2545 let peers = create_network(2, &cfgs);
2547 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2548 let mut fd_a = FileDescriptor {
2549 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2550 disconnect: Arc::new(AtomicBool::new(false)),
2552 let mut fd_b = FileDescriptor {
2553 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2554 disconnect: Arc::new(AtomicBool::new(false)),
2556 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2557 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2559 // If we get a single timer tick before completion, that's fine
2560 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2561 peers[0].timer_tick_occurred();
2562 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2564 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2565 peers[0].process_events();
2566 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2567 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2568 peers[1].process_events();
2570 // ...but if we get a second timer tick, we should disconnect the peer
2571 peers[0].timer_tick_occurred();
2572 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2574 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2575 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
2579 fn test_filter_addresses(){
2580 // Tests the filter_addresses function.
2583 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2584 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2585 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2586 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2587 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2588 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2591 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2592 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2593 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2594 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2595 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2596 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2599 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2600 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2601 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2602 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2603 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2604 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2607 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2608 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2609 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2610 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2611 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2612 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2615 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2616 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2617 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2618 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2619 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2620 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2623 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2624 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2625 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2626 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2627 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2628 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2631 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2632 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2633 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2634 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2635 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2636 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2638 // For (192.88.99/24)
2639 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2640 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2641 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2642 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2643 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2644 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2646 // For other IPv4 addresses
2647 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2648 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2649 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2650 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2651 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2652 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2655 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2656 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2657 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2658 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2659 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2660 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2662 // For other IPv6 addresses
2663 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2664 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2665 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2666 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2667 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2668 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2671 assert_eq!(filter_addresses(None), None);