1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and NetGraphmsgHandler) with messages
16 //! they should handle, and encoding/sending response messages.
18 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
20 use ln::features::InitFeatures;
22 use ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, RoutingMessageHandler};
23 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
24 use util::ser::{VecWriter, Writeable, Writer};
25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
28 use util::atomic_counter::AtomicCounter;
29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
30 use util::logger::Logger;
31 use routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
35 use alloc::collections::LinkedList;
36 use sync::{Arc, Mutex, MutexGuard, FairRwLock};
37 use core::sync::atomic::{AtomicBool, Ordering};
38 use core::{cmp, hash, fmt, mem};
40 use core::convert::Infallible;
41 #[cfg(feature = "std")] use std::error;
43 use bitcoin::hashes::sha256::Hash as Sha256;
44 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
45 use bitcoin::hashes::{HashEngine, Hash};
47 /// Handler for BOLT1-compliant messages.
48 pub trait CustomMessageHandler: wire::CustomMessageReader {
49 /// Called with the message type that was received and the buffer to be read.
50 /// Can return a `MessageHandlingError` if the message could not be handled.
51 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
53 /// Gets the list of pending messages which were generated by the custom message
54 /// handler, clearing the list in the process. The first tuple element must
55 /// correspond to the intended recipients node ids. If no connection to one of the
56 /// specified node does not exist, the message is simply not sent to it.
57 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
60 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
61 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
62 pub struct IgnoringMessageHandler{}
63 impl MessageSendEventsProvider for IgnoringMessageHandler {
64 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
66 impl RoutingMessageHandler for IgnoringMessageHandler {
67 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
68 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
69 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
70 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
71 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
72 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
73 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
74 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
75 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
76 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
77 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
79 impl Deref for IgnoringMessageHandler {
80 type Target = IgnoringMessageHandler;
81 fn deref(&self) -> &Self { self }
84 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
85 // method that takes self for it.
86 impl wire::Type for Infallible {
87 fn type_id(&self) -> u16 {
91 impl Writeable for Infallible {
92 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
97 impl wire::CustomMessageReader for IgnoringMessageHandler {
98 type CustomMessage = Infallible;
99 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
104 impl CustomMessageHandler for IgnoringMessageHandler {
105 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
106 // Since we always return `None` in the read the handle method should never be called.
110 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
113 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
114 /// You can provide one of these as the route_handler in a MessageHandler.
115 pub struct ErroringMessageHandler {
116 message_queue: Mutex<Vec<MessageSendEvent>>
118 impl ErroringMessageHandler {
119 /// Constructs a new ErroringMessageHandler
120 pub fn new() -> Self {
121 Self { message_queue: Mutex::new(Vec::new()) }
123 fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
124 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
125 action: msgs::ErrorAction::SendErrorMessage {
126 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
128 node_id: node_id.clone(),
132 impl MessageSendEventsProvider for ErroringMessageHandler {
133 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
134 let mut res = Vec::new();
135 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
139 impl ChannelMessageHandler for ErroringMessageHandler {
140 // Any messages which are related to a specific channel generate an error message to let the
141 // peer know we don't care about channels.
142 fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
143 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
145 fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
146 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
148 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
149 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
151 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
152 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
154 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
155 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
157 fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
158 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
160 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
161 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
163 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
164 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
166 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
167 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
169 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
170 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
172 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
173 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
175 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
176 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
178 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
179 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
181 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
182 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
184 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
185 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
187 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
188 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
190 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
191 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
192 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
193 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
194 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
196 impl Deref for ErroringMessageHandler {
197 type Target = ErroringMessageHandler;
198 fn deref(&self) -> &Self { self }
201 /// Provides references to trait impls which handle different types of messages.
202 pub struct MessageHandler<CM: Deref, RM: Deref> where
203 CM::Target: ChannelMessageHandler,
204 RM::Target: RoutingMessageHandler {
205 /// A message handler which handles messages specific to channels. Usually this is just a
206 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
208 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
209 pub chan_handler: CM,
210 /// A message handler which handles messages updating our knowledge of the network channel
211 /// graph. Usually this is just a [`NetGraphMsgHandler`] object or an
212 /// [`IgnoringMessageHandler`].
214 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
215 pub route_handler: RM,
218 /// Provides an object which can be used to send data to and which uniquely identifies a connection
219 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
220 /// implement Hash to meet the PeerManager API.
222 /// For efficiency, Clone should be relatively cheap for this type.
224 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
225 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
226 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
227 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
228 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
229 /// to simply use another value which is guaranteed to be globally unique instead.
230 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
231 /// Attempts to send some data from the given slice to the peer.
233 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
234 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
235 /// called and further write attempts may occur until that time.
237 /// If the returned size is smaller than `data.len()`, a
238 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
239 /// written. Additionally, until a `send_data` event completes fully, no further
240 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
241 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
244 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
245 /// (indicating that read events should be paused to prevent DoS in the send buffer),
246 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
247 /// `resume_read` of false carries no meaning, and should not cause any action.
248 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
249 /// Disconnect the socket pointed to by this SocketDescriptor.
251 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
252 /// call (doing so is a noop).
253 fn disconnect_socket(&mut self);
256 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
257 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
260 pub struct PeerHandleError {
261 /// Used to indicate that we probably can't make any future connections to this peer, implying
262 /// we should go ahead and force-close any channels we have with it.
263 pub no_connection_possible: bool,
265 impl fmt::Debug for PeerHandleError {
266 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
267 formatter.write_str("Peer Sent Invalid Data")
270 impl fmt::Display for PeerHandleError {
271 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
272 formatter.write_str("Peer Sent Invalid Data")
276 #[cfg(feature = "std")]
277 impl error::Error for PeerHandleError {
278 fn description(&self) -> &str {
279 "Peer Sent Invalid Data"
283 enum InitSyncTracker{
285 ChannelsSyncing(u64),
286 NodesSyncing(PublicKey),
289 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
290 /// forwarding gossip messages to peers altogether.
291 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
293 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
294 /// we have fewer than this many messages in the outbound buffer again.
295 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
296 /// refilled as we send bytes.
297 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
298 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
300 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
302 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
303 /// the socket receive buffer before receiving the ping.
305 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
306 /// including any network delays, outbound traffic, or the same for messages from other peers.
308 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
309 /// per connected peer to respond to a ping, as long as they send us at least one message during
310 /// each tick, ensuring we aren't actually just disconnected.
311 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
314 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
315 /// two connected peers, assuming most LDK-running systems have at least two cores.
316 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
318 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
319 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
320 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
321 /// process before the next ping.
322 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
325 channel_encryptor: PeerChannelEncryptor,
326 their_node_id: Option<PublicKey>,
327 their_features: Option<InitFeatures>,
328 their_net_address: Option<NetAddress>,
330 pending_outbound_buffer: LinkedList<Vec<u8>>,
331 pending_outbound_buffer_first_msg_offset: usize,
332 awaiting_write_event: bool,
334 pending_read_buffer: Vec<u8>,
335 pending_read_buffer_pos: usize,
336 pending_read_is_header: bool,
338 sync_status: InitSyncTracker,
340 msgs_sent_since_pong: usize,
341 awaiting_pong_timer_tick_intervals: i8,
342 received_message_since_timer_tick: bool,
343 sent_gossip_timestamp_filter: bool,
347 /// Returns true if the channel announcements/updates for the given channel should be
348 /// forwarded to this peer.
349 /// If we are sending our routing table to this peer and we have not yet sent channel
350 /// announcements/updates for the given channel_id then we will send it when we get to that
351 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
352 /// sent the old versions, we should send the update, and so return true here.
353 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
354 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
355 !self.sent_gossip_timestamp_filter {
358 match self.sync_status {
359 InitSyncTracker::NoSyncRequested => true,
360 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
361 InitSyncTracker::NodesSyncing(_) => true,
365 /// Similar to the above, but for node announcements indexed by node_id.
366 fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
367 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
368 !self.sent_gossip_timestamp_filter {
371 match self.sync_status {
372 InitSyncTracker::NoSyncRequested => true,
373 InitSyncTracker::ChannelsSyncing(_) => false,
374 InitSyncTracker::NodesSyncing(pk) => pk < node_id,
379 struct PeerHolder<Descriptor: SocketDescriptor> {
380 /// Peer is under its own mutex for sending and receiving bytes, but note that we do *not* hold
381 /// this mutex while we're processing a message. This is fine as [`PeerManager::read_event`]
382 /// requires that there be no parallel calls for a given peer, so mutual exclusion of messages
383 /// handed to the `MessageHandler`s for a given peer is already guaranteed.
384 peers: HashMap<Descriptor, Mutex<Peer>>,
387 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
388 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
389 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
390 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
391 /// issues such as overly long function definitions.
393 /// (C-not exported) as Arcs don't make sense in bindings
394 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<NetGraphMsgHandler<Arc<NetworkGraph>, Arc<C>, Arc<L>>>, Arc<L>, Arc<IgnoringMessageHandler>>;
396 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
397 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
398 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
399 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
400 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
401 /// helps with issues such as long function definitions.
403 /// (C-not exported) as Arcs don't make sense in bindings
404 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e NetGraphMsgHandler<&'g NetworkGraph, &'h C, &'f L>, &'f L, IgnoringMessageHandler>;
406 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
407 /// socket events into messages which it passes on to its [`MessageHandler`].
409 /// Locks are taken internally, so you must never assume that reentrancy from a
410 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
412 /// Calls to [`read_event`] will decode relevant messages and pass them to the
413 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
414 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
415 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
416 /// calls only after previous ones have returned.
418 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
419 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
420 /// essentially you should default to using a SimpleRefPeerManager, and use a
421 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
422 /// you're using lightning-net-tokio.
424 /// [`read_event`]: PeerManager::read_event
425 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> where
426 CM::Target: ChannelMessageHandler,
427 RM::Target: RoutingMessageHandler,
429 CMH::Target: CustomMessageHandler {
430 message_handler: MessageHandler<CM, RM>,
431 peers: FairRwLock<PeerHolder<Descriptor>>,
432 /// Only add to this set when noise completes.
433 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
434 /// lock held. Entries may be added with only the `peers` read lock held (though the
435 /// `Descriptor` value must already exist in `peers`).
436 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
437 /// We can only have one thread processing events at once, but we don't usually need the full
438 /// `peers` write lock to do so, so instead we block on this empty mutex when entering
439 /// `process_events`.
440 event_processing_lock: Mutex<()>,
441 /// Because event processing is global and always does all available work before returning,
442 /// there is no reason for us to have many event processors waiting on the lock at once.
443 /// Instead, we limit the total blocked event processors to always exactly one by setting this
444 /// when an event process call is waiting.
445 blocked_event_processors: AtomicBool,
446 our_node_secret: SecretKey,
447 ephemeral_key_midstate: Sha256Engine,
448 custom_message_handler: CMH,
450 peer_counter: AtomicCounter,
455 enum MessageHandlingError {
456 PeerHandleError(PeerHandleError),
457 LightningError(LightningError),
460 impl From<PeerHandleError> for MessageHandlingError {
461 fn from(error: PeerHandleError) -> Self {
462 MessageHandlingError::PeerHandleError(error)
466 impl From<LightningError> for MessageHandlingError {
467 fn from(error: LightningError) -> Self {
468 MessageHandlingError::LightningError(error)
472 macro_rules! encode_msg {
474 let mut buffer = VecWriter(Vec::new());
475 wire::write($msg, &mut buffer).unwrap();
480 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L, IgnoringMessageHandler> where
481 CM::Target: ChannelMessageHandler,
483 /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
484 /// handler is used and network graph messages are ignored.
486 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
487 /// cryptographically secure random bytes.
489 /// (C-not exported) as we can't export a PeerManager with a dummy route handler
490 pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
491 Self::new(MessageHandler {
492 chan_handler: channel_message_handler,
493 route_handler: IgnoringMessageHandler{},
494 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
498 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L, IgnoringMessageHandler> where
499 RM::Target: RoutingMessageHandler,
501 /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
502 /// handler is used and messages related to channels will be ignored (or generate error
503 /// messages). Note that some other lightning implementations time-out connections after some
504 /// time if no channel is built with the peer.
506 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
507 /// cryptographically secure random bytes.
509 /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
510 pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
511 Self::new(MessageHandler {
512 chan_handler: ErroringMessageHandler::new(),
513 route_handler: routing_message_handler,
514 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
518 /// A simple wrapper that optionally prints " from <pubkey>" for an optional pubkey.
519 /// This works around `format!()` taking a reference to each argument, preventing
520 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
521 /// due to lifetime errors.
522 struct OptionalFromDebugger<'a>(&'a Option<PublicKey>);
523 impl core::fmt::Display for OptionalFromDebugger<'_> {
524 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
525 if let Some(node_id) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
529 /// A function used to filter out local or private addresses
530 /// https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml
531 /// https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
532 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
534 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
535 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
536 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
537 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
538 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
539 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
540 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
541 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
542 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
543 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
544 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
545 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
546 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
547 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
548 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
549 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
550 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
551 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
552 // For remaining addresses
553 Some(NetAddress::IPv6{addr: _, port: _}) => None,
554 Some(..) => ip_address,
559 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> PeerManager<Descriptor, CM, RM, L, CMH> where
560 CM::Target: ChannelMessageHandler,
561 RM::Target: RoutingMessageHandler,
563 CMH::Target: CustomMessageHandler {
564 /// Constructs a new PeerManager with the given message handlers and node_id secret key
565 /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
566 /// cryptographically secure random bytes.
567 pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH) -> Self {
568 let mut ephemeral_key_midstate = Sha256::engine();
569 ephemeral_key_midstate.input(ephemeral_random_data);
573 peers: FairRwLock::new(PeerHolder {
574 peers: HashMap::new(),
576 node_id_to_descriptor: Mutex::new(HashMap::new()),
577 event_processing_lock: Mutex::new(()),
578 blocked_event_processors: AtomicBool::new(false),
580 ephemeral_key_midstate,
581 peer_counter: AtomicCounter::new(),
583 custom_message_handler,
587 /// Get the list of node ids for peers which have completed the initial handshake.
589 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
590 /// new_outbound_connection, however entries will only appear once the initial handshake has
591 /// completed and we are sure the remote peer has the private key for the given node_id.
592 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
593 let peers = self.peers.read().unwrap();
594 peers.peers.values().filter_map(|peer_mutex| {
595 let p = peer_mutex.lock().unwrap();
596 if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
603 fn get_ephemeral_key(&self) -> SecretKey {
604 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
605 let counter = self.peer_counter.get_increment();
606 ephemeral_hash.input(&counter.to_le_bytes());
607 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
610 /// Indicates a new outbound connection has been established to a node with the given node_id
611 /// and an optional remote network address.
613 /// The remote network address adds the option to report a remote IP address back to a connecting
614 /// peer using the init message.
615 /// The user should pass the remote network address of the host they are connected to.
617 /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
618 /// descriptor but must disconnect the connection immediately.
620 /// Returns a small number of bytes to send to the remote node (currently always 50).
622 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
623 /// [`socket_disconnected()`].
625 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
626 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
627 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
628 let res = peer_encryptor.get_act_one().to_vec();
629 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
631 let mut peers = self.peers.write().unwrap();
632 if peers.peers.insert(descriptor, Mutex::new(Peer {
633 channel_encryptor: peer_encryptor,
635 their_features: None,
636 their_net_address: remote_network_address,
638 pending_outbound_buffer: LinkedList::new(),
639 pending_outbound_buffer_first_msg_offset: 0,
640 awaiting_write_event: false,
643 pending_read_buffer_pos: 0,
644 pending_read_is_header: false,
646 sync_status: InitSyncTracker::NoSyncRequested,
648 msgs_sent_since_pong: 0,
649 awaiting_pong_timer_tick_intervals: 0,
650 received_message_since_timer_tick: false,
651 sent_gossip_timestamp_filter: false,
653 panic!("PeerManager driver duplicated descriptors!");
658 /// Indicates a new inbound connection has been established to a node with an optional remote
661 /// The remote network address adds the option to report a remote IP address back to a connecting
662 /// peer using the init message.
663 /// The user should pass the remote network address of the host they are connected to.
665 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
666 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
667 /// call socket_disconnected for the new descriptor but must disconnect the connection
670 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
671 /// [`socket_disconnected()`].
673 /// [`socket_disconnected()`]: PeerManager::socket_disconnected
674 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
675 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
676 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
678 let mut peers = self.peers.write().unwrap();
679 if peers.peers.insert(descriptor, Mutex::new(Peer {
680 channel_encryptor: peer_encryptor,
682 their_features: None,
683 their_net_address: remote_network_address,
685 pending_outbound_buffer: LinkedList::new(),
686 pending_outbound_buffer_first_msg_offset: 0,
687 awaiting_write_event: false,
690 pending_read_buffer_pos: 0,
691 pending_read_is_header: false,
693 sync_status: InitSyncTracker::NoSyncRequested,
695 msgs_sent_since_pong: 0,
696 awaiting_pong_timer_tick_intervals: 0,
697 received_message_since_timer_tick: false,
698 sent_gossip_timestamp_filter: false,
700 panic!("PeerManager driver duplicated descriptors!");
705 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
706 while !peer.awaiting_write_event {
707 if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE && peer.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK {
708 match peer.sync_status {
709 InitSyncTracker::NoSyncRequested => {},
710 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
711 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
712 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
713 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
714 self.enqueue_message(peer, announce);
715 if let &Some(ref update_a) = update_a_option {
716 self.enqueue_message(peer, update_a);
718 if let &Some(ref update_b) = update_b_option {
719 self.enqueue_message(peer, update_b);
721 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
723 if all_messages.is_empty() || all_messages.len() != steps as usize {
724 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
727 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
728 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
729 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
730 for msg in all_messages.iter() {
731 self.enqueue_message(peer, msg);
732 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
734 if all_messages.is_empty() || all_messages.len() != steps as usize {
735 peer.sync_status = InitSyncTracker::NoSyncRequested;
738 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
739 InitSyncTracker::NodesSyncing(key) => {
740 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
741 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
742 for msg in all_messages.iter() {
743 self.enqueue_message(peer, msg);
744 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
746 if all_messages.is_empty() || all_messages.len() != steps as usize {
747 peer.sync_status = InitSyncTracker::NoSyncRequested;
752 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
753 self.maybe_send_extra_ping(peer);
757 let next_buff = match peer.pending_outbound_buffer.front() {
762 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
763 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
764 let data_sent = descriptor.send_data(pending, should_be_reading);
765 peer.pending_outbound_buffer_first_msg_offset += data_sent;
766 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
768 peer.pending_outbound_buffer_first_msg_offset = 0;
769 peer.pending_outbound_buffer.pop_front();
771 peer.awaiting_write_event = true;
776 /// Indicates that there is room to write data to the given socket descriptor.
778 /// May return an Err to indicate that the connection should be closed.
780 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
781 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
782 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
783 /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
786 /// [`send_data`]: SocketDescriptor::send_data
787 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
788 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
789 let peers = self.peers.read().unwrap();
790 match peers.peers.get(descriptor) {
792 // This is most likely a simple race condition where the user found that the socket
793 // was writeable, then we told the user to `disconnect_socket()`, then they called
794 // this method. Return an error to make sure we get disconnected.
795 return Err(PeerHandleError { no_connection_possible: false });
797 Some(peer_mutex) => {
798 let mut peer = peer_mutex.lock().unwrap();
799 peer.awaiting_write_event = false;
800 self.do_attempt_write_data(descriptor, &mut peer);
806 /// Indicates that data was read from the given socket descriptor.
808 /// May return an Err to indicate that the connection should be closed.
810 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
811 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
812 /// [`send_data`] calls to handle responses.
814 /// If `Ok(true)` is returned, further read_events should not be triggered until a
815 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
818 /// [`send_data`]: SocketDescriptor::send_data
819 /// [`process_events`]: PeerManager::process_events
820 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
821 match self.do_read_event(peer_descriptor, data) {
824 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
825 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
831 /// Append a message to a peer's pending outbound/write buffer
832 fn enqueue_encoded_message(&self, peer: &mut Peer, encoded_message: &Vec<u8>) {
833 peer.msgs_sent_since_pong += 1;
834 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
837 /// Append a message to a peer's pending outbound/write buffer
838 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
839 let mut buffer = VecWriter(Vec::with_capacity(2048));
840 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
842 if is_gossip_msg(message.type_id()) {
843 log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
845 log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()))
847 self.enqueue_encoded_message(peer, &buffer.0);
850 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
851 let mut pause_read = false;
852 let peers = self.peers.read().unwrap();
853 let mut msgs_to_forward = Vec::new();
854 let mut peer_node_id = None;
855 match peers.peers.get(peer_descriptor) {
857 // This is most likely a simple race condition where the user read some bytes
858 // from the socket, then we told the user to `disconnect_socket()`, then they
859 // called this method. Return an error to make sure we get disconnected.
860 return Err(PeerHandleError { no_connection_possible: false });
862 Some(peer_mutex) => {
863 let mut read_pos = 0;
864 while read_pos < data.len() {
865 macro_rules! try_potential_handleerror {
866 ($peer: expr, $thing: expr) => {
871 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
872 //TODO: Try to push msg
873 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
874 return Err(PeerHandleError{ no_connection_possible: false });
876 msgs::ErrorAction::IgnoreAndLog(level) => {
877 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
880 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
881 msgs::ErrorAction::IgnoreError => {
882 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
885 msgs::ErrorAction::SendErrorMessage { msg } => {
886 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
887 self.enqueue_message($peer, &msg);
890 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
891 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
892 self.enqueue_message($peer, &msg);
901 let mut peer_lock = peer_mutex.lock().unwrap();
902 let peer = &mut *peer_lock;
903 let mut msg_to_handle = None;
904 if peer_node_id.is_none() {
905 peer_node_id = peer.their_node_id.clone();
908 assert!(peer.pending_read_buffer.len() > 0);
909 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
912 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
913 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]);
914 read_pos += data_to_copy;
915 peer.pending_read_buffer_pos += data_to_copy;
918 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
919 peer.pending_read_buffer_pos = 0;
921 macro_rules! insert_node_id {
923 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap()) {
924 hash_map::Entry::Occupied(_) => {
925 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
926 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
927 return Err(PeerHandleError{ no_connection_possible: false })
929 hash_map::Entry::Vacant(entry) => {
930 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
931 entry.insert(peer_descriptor.clone())
937 let next_step = peer.channel_encryptor.get_noise_step();
939 NextNoiseStep::ActOne => {
940 let act_two = try_potential_handleerror!(peer,
941 peer.channel_encryptor.process_act_one_with_keys(&peer.pending_read_buffer[..], &self.our_node_secret, self.get_ephemeral_key())).to_vec();
942 peer.pending_outbound_buffer.push_back(act_two);
943 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
945 NextNoiseStep::ActTwo => {
946 let (act_three, their_node_id) = try_potential_handleerror!(peer,
947 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
948 peer.pending_outbound_buffer.push_back(act_three.to_vec());
949 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
950 peer.pending_read_is_header = true;
952 peer.their_node_id = Some(their_node_id);
954 let features = InitFeatures::known();
955 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
956 self.enqueue_message(peer, &resp);
957 peer.awaiting_pong_timer_tick_intervals = 0;
959 NextNoiseStep::ActThree => {
960 let their_node_id = try_potential_handleerror!(peer,
961 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
962 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
963 peer.pending_read_is_header = true;
964 peer.their_node_id = Some(their_node_id);
966 let features = InitFeatures::known();
967 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
968 self.enqueue_message(peer, &resp);
969 peer.awaiting_pong_timer_tick_intervals = 0;
971 NextNoiseStep::NoiseComplete => {
972 if peer.pending_read_is_header {
973 let msg_len = try_potential_handleerror!(peer,
974 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
975 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
976 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
977 if msg_len < 2 { // Need at least the message type tag
978 return Err(PeerHandleError{ no_connection_possible: false });
980 peer.pending_read_is_header = false;
982 let msg_data = try_potential_handleerror!(peer,
983 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
984 assert!(msg_data.len() >= 2);
987 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
988 peer.pending_read_buffer.resize(18, 0);
989 peer.pending_read_is_header = true;
991 let mut reader = io::Cursor::new(&msg_data[..]);
992 let message_result = wire::read(&mut reader, &*self.custom_message_handler);
993 let message = match message_result {
997 // Note that to avoid recursion we never call
998 // `do_attempt_write_data` from here, causing
999 // the messages enqueued here to not actually
1000 // be sent before the peer is disconnected.
1001 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1002 log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1005 (msgs::DecodeError::UnsupportedCompression, _) => {
1006 log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1007 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1010 (_, Some(ty)) if is_gossip_msg(ty) => {
1011 log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1012 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unreadable/bogus gossip message".to_owned() });
1015 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1016 log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1017 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1018 return Err(PeerHandleError { no_connection_possible: false });
1020 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { no_connection_possible: false }),
1021 (msgs::DecodeError::InvalidValue, _) => {
1022 log_debug!(self.logger, "Got an invalid value while deserializing message");
1023 return Err(PeerHandleError { no_connection_possible: false });
1025 (msgs::DecodeError::ShortRead, _) => {
1026 log_debug!(self.logger, "Deserialization failed due to shortness of message");
1027 return Err(PeerHandleError { no_connection_possible: false });
1029 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { no_connection_possible: false }),
1030 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { no_connection_possible: false }),
1035 msg_to_handle = Some(message);
1040 pause_read = peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
1042 if let Some(message) = msg_to_handle {
1043 match self.handle_message(&peer_mutex, peer_lock, message) {
1044 Err(handling_error) => match handling_error {
1045 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1046 MessageHandlingError::LightningError(e) => {
1047 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1051 msgs_to_forward.push(msg);
1060 for msg in msgs_to_forward.drain(..) {
1061 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref());
1067 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1068 /// Returns the message back if it needs to be broadcasted to all other peers.
1071 peer_mutex: &Mutex<Peer>,
1072 mut peer_lock: MutexGuard<Peer>,
1073 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1074 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1075 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages");
1076 peer_lock.received_message_since_timer_tick = true;
1078 // Need an Init as first message
1079 if let wire::Message::Init(msg) = message {
1080 if msg.features.requires_unknown_bits() {
1081 log_debug!(self.logger, "Peer features required unknown version bits");
1082 return Err(PeerHandleError{ no_connection_possible: true }.into());
1084 if peer_lock.their_features.is_some() {
1085 return Err(PeerHandleError{ no_connection_possible: false }.into());
1088 log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1090 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1091 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1092 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1095 if !msg.features.supports_static_remote_key() {
1096 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(their_node_id));
1097 return Err(PeerHandleError{ no_connection_possible: true }.into());
1100 self.message_handler.route_handler.peer_connected(&their_node_id, &msg);
1102 self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
1103 peer_lock.their_features = Some(msg.features);
1105 } else if peer_lock.their_features.is_none() {
1106 log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1107 return Err(PeerHandleError{ no_connection_possible: false }.into());
1110 if let wire::Message::GossipTimestampFilter(_msg) = message {
1111 // When supporting gossip messages, start inital gossip sync only after we receive
1112 // a GossipTimestampFilter
1113 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1114 !peer_lock.sent_gossip_timestamp_filter {
1115 peer_lock.sent_gossip_timestamp_filter = true;
1116 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1121 let their_features = peer_lock.their_features.clone();
1122 mem::drop(peer_lock);
1124 if is_gossip_msg(message.type_id()) {
1125 log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1127 log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1130 let mut should_forward = None;
1133 // Setup and Control messages:
1134 wire::Message::Init(_) => {
1137 wire::Message::GossipTimestampFilter(_) => {
1140 wire::Message::Error(msg) => {
1141 let mut data_is_printable = true;
1142 for b in msg.data.bytes() {
1143 if b < 32 || b > 126 {
1144 data_is_printable = false;
1149 if data_is_printable {
1150 log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1152 log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1154 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1155 if msg.channel_id == [0; 32] {
1156 return Err(PeerHandleError{ no_connection_possible: true }.into());
1159 wire::Message::Warning(msg) => {
1160 let mut data_is_printable = true;
1161 for b in msg.data.bytes() {
1162 if b < 32 || b > 126 {
1163 data_is_printable = false;
1168 if data_is_printable {
1169 log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1171 log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1175 wire::Message::Ping(msg) => {
1176 if msg.ponglen < 65532 {
1177 let resp = msgs::Pong { byteslen: msg.ponglen };
1178 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1181 wire::Message::Pong(_msg) => {
1182 let mut peer_lock = peer_mutex.lock().unwrap();
1183 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1184 peer_lock.msgs_sent_since_pong = 0;
1187 // Channel messages:
1188 wire::Message::OpenChannel(msg) => {
1189 self.message_handler.chan_handler.handle_open_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1191 wire::Message::AcceptChannel(msg) => {
1192 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1195 wire::Message::FundingCreated(msg) => {
1196 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1198 wire::Message::FundingSigned(msg) => {
1199 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1201 wire::Message::FundingLocked(msg) => {
1202 self.message_handler.chan_handler.handle_funding_locked(&their_node_id, &msg);
1205 wire::Message::Shutdown(msg) => {
1206 self.message_handler.chan_handler.handle_shutdown(&their_node_id, their_features.as_ref().unwrap(), &msg);
1208 wire::Message::ClosingSigned(msg) => {
1209 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1212 // Commitment messages:
1213 wire::Message::UpdateAddHTLC(msg) => {
1214 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1216 wire::Message::UpdateFulfillHTLC(msg) => {
1217 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1219 wire::Message::UpdateFailHTLC(msg) => {
1220 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1222 wire::Message::UpdateFailMalformedHTLC(msg) => {
1223 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1226 wire::Message::CommitmentSigned(msg) => {
1227 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1229 wire::Message::RevokeAndACK(msg) => {
1230 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1232 wire::Message::UpdateFee(msg) => {
1233 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1235 wire::Message::ChannelReestablish(msg) => {
1236 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1239 // Routing messages:
1240 wire::Message::AnnouncementSignatures(msg) => {
1241 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1243 wire::Message::ChannelAnnouncement(msg) => {
1244 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1245 .map_err(|e| -> MessageHandlingError { e.into() })? {
1246 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1249 wire::Message::NodeAnnouncement(msg) => {
1250 if self.message_handler.route_handler.handle_node_announcement(&msg)
1251 .map_err(|e| -> MessageHandlingError { e.into() })? {
1252 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1255 wire::Message::ChannelUpdate(msg) => {
1256 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1257 if self.message_handler.route_handler.handle_channel_update(&msg)
1258 .map_err(|e| -> MessageHandlingError { e.into() })? {
1259 should_forward = Some(wire::Message::ChannelUpdate(msg));
1262 wire::Message::QueryShortChannelIds(msg) => {
1263 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1265 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1266 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1268 wire::Message::QueryChannelRange(msg) => {
1269 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1271 wire::Message::ReplyChannelRange(msg) => {
1272 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1275 // Unknown messages:
1276 wire::Message::Unknown(type_id) if message.is_even() => {
1277 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1278 // Fail the channel if message is an even, unknown type as per BOLT #1.
1279 return Err(PeerHandleError{ no_connection_possible: true }.into());
1281 wire::Message::Unknown(type_id) => {
1282 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1284 wire::Message::Custom(custom) => {
1285 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1291 fn forward_broadcast_msg(&self, peers: &PeerHolder<Descriptor>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1293 wire::Message::ChannelAnnouncement(ref msg) => {
1294 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1295 let encoded_msg = encode_msg!(msg);
1297 for (_, peer_mutex) in peers.peers.iter() {
1298 let mut peer = peer_mutex.lock().unwrap();
1299 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1300 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1303 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1304 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1306 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1309 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1310 peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1313 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1316 self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1319 wire::Message::NodeAnnouncement(ref msg) => {
1320 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1321 let encoded_msg = encode_msg!(msg);
1323 for (_, peer_mutex) in peers.peers.iter() {
1324 let mut peer = peer_mutex.lock().unwrap();
1325 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1326 !peer.should_forward_node_announcement(msg.contents.node_id) {
1329 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1330 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1332 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1335 if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1338 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1341 self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1344 wire::Message::ChannelUpdate(ref msg) => {
1345 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1346 let encoded_msg = encode_msg!(msg);
1348 for (_, peer_mutex) in peers.peers.iter() {
1349 let mut peer = peer_mutex.lock().unwrap();
1350 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1351 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1354 if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1355 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1357 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1360 if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1363 self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1366 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1370 /// Checks for any events generated by our handlers and processes them. Includes sending most
1371 /// response messages as well as messages generated by calls to handler functions directly (eg
1372 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1374 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1377 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1378 /// or one of the other clients provided in our language bindings.
1380 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1381 /// without doing any work. All available events that need handling will be handled before the
1382 /// other calls return.
1384 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1385 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1386 /// [`send_data`]: SocketDescriptor::send_data
1387 pub fn process_events(&self) {
1388 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1389 if _single_processor_lock.is_err() {
1390 // While we could wake the older sleeper here with a CV and make more even waiting
1391 // times, that would be a lot of overengineering for a simple "reduce total waiter
1393 match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1395 debug_assert!(val, "compare_exchange failed spuriously?");
1399 debug_assert!(!val, "compare_exchange succeeded spuriously?");
1400 // We're the only waiter, as the running process_events may have emptied the
1401 // pending events "long" ago and there are new events for us to process, wait until
1402 // its done and process any leftover events before returning.
1403 _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1404 self.blocked_event_processors.store(false, Ordering::Release);
1409 let mut peers_to_disconnect = HashMap::new();
1410 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1411 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1414 // TODO: There are some DoS attacks here where you can flood someone's outbound send
1415 // buffer by doing things like announcing channels on another node. We should be willing to
1416 // drop optional-ish messages when send buffers get full!
1418 let peers_lock = self.peers.read().unwrap();
1419 let peers = &*peers_lock;
1420 macro_rules! get_peer_for_forwarding {
1421 ($node_id: expr) => {
1423 if peers_to_disconnect.get($node_id).is_some() {
1424 // If we've "disconnected" this peer, do not send to it.
1427 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1428 match descriptor_opt {
1429 Some(descriptor) => match peers.peers.get(&descriptor) {
1430 Some(peer_mutex) => {
1431 let peer_lock = peer_mutex.lock().unwrap();
1432 if peer_lock.their_features.is_none() {
1438 debug_assert!(false, "Inconsistent peers set state!");
1449 for event in events_generated.drain(..) {
1451 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1452 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1453 log_pubkey!(node_id),
1454 log_bytes!(msg.temporary_channel_id));
1455 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1457 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1458 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1459 log_pubkey!(node_id),
1460 log_bytes!(msg.temporary_channel_id));
1461 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1463 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1464 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1465 log_pubkey!(node_id),
1466 log_bytes!(msg.temporary_channel_id),
1467 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1468 // TODO: If the peer is gone we should generate a DiscardFunding event
1469 // indicating to the wallet that they should just throw away this funding transaction
1470 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1472 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1473 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1474 log_pubkey!(node_id),
1475 log_bytes!(msg.channel_id));
1476 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1478 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1479 log_debug!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1480 log_pubkey!(node_id),
1481 log_bytes!(msg.channel_id));
1482 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1484 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1485 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1486 log_pubkey!(node_id),
1487 log_bytes!(msg.channel_id));
1488 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1490 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 } } => {
1491 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1492 log_pubkey!(node_id),
1493 update_add_htlcs.len(),
1494 update_fulfill_htlcs.len(),
1495 update_fail_htlcs.len(),
1496 log_bytes!(commitment_signed.channel_id));
1497 let mut peer = get_peer_for_forwarding!(node_id);
1498 for msg in update_add_htlcs {
1499 self.enqueue_message(&mut *peer, msg);
1501 for msg in update_fulfill_htlcs {
1502 self.enqueue_message(&mut *peer, msg);
1504 for msg in update_fail_htlcs {
1505 self.enqueue_message(&mut *peer, msg);
1507 for msg in update_fail_malformed_htlcs {
1508 self.enqueue_message(&mut *peer, msg);
1510 if let &Some(ref msg) = update_fee {
1511 self.enqueue_message(&mut *peer, msg);
1513 self.enqueue_message(&mut *peer, commitment_signed);
1515 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1516 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1517 log_pubkey!(node_id),
1518 log_bytes!(msg.channel_id));
1519 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1521 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1522 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1523 log_pubkey!(node_id),
1524 log_bytes!(msg.channel_id));
1525 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1527 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1528 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1529 log_pubkey!(node_id),
1530 log_bytes!(msg.channel_id));
1531 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1533 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1534 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1535 log_pubkey!(node_id),
1536 log_bytes!(msg.channel_id));
1537 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1539 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1540 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1541 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1542 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1543 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1546 match self.message_handler.route_handler.handle_channel_update(&update_msg) {
1547 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1548 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None),
1552 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1553 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1554 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1555 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1556 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1560 MessageSendEvent::BroadcastChannelUpdate { msg } => {
1561 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1562 match self.message_handler.route_handler.handle_channel_update(&msg) {
1563 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1564 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1568 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1569 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1570 log_pubkey!(node_id), msg.contents.short_channel_id);
1571 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1573 MessageSendEvent::HandleError { ref node_id, ref action } => {
1575 msgs::ErrorAction::DisconnectPeer { ref msg } => {
1576 // We do not have the peers write lock, so we just store that we're
1577 // about to disconenct the peer and do it after we finish
1578 // processing most messages.
1579 peers_to_disconnect.insert(*node_id, msg.clone());
1581 msgs::ErrorAction::IgnoreAndLog(level) => {
1582 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1584 msgs::ErrorAction::IgnoreDuplicateGossip => {},
1585 msgs::ErrorAction::IgnoreError => {
1586 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1588 msgs::ErrorAction::SendErrorMessage { ref msg } => {
1589 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1590 log_pubkey!(node_id),
1592 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1594 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1595 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1596 log_pubkey!(node_id),
1598 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1602 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1603 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1605 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1606 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1608 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1609 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1610 log_pubkey!(node_id),
1611 msg.short_channel_ids.len(),
1613 msg.number_of_blocks,
1615 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1617 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1618 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1623 for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1624 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1625 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1628 for (descriptor, peer_mutex) in peers.peers.iter() {
1629 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer_mutex.lock().unwrap());
1632 if !peers_to_disconnect.is_empty() {
1633 let mut peers_lock = self.peers.write().unwrap();
1634 let peers = &mut *peers_lock;
1635 for (node_id, msg) in peers_to_disconnect.drain() {
1636 // Note that since we are holding the peers *write* lock we can
1637 // remove from node_id_to_descriptor immediately (as no other
1638 // thread can be holding the peer lock if we have the global write
1641 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1642 if let Some(peer_mutex) = peers.peers.remove(&descriptor) {
1643 if let Some(msg) = msg {
1644 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1645 log_pubkey!(node_id),
1647 let mut peer = peer_mutex.lock().unwrap();
1648 self.enqueue_message(&mut *peer, &msg);
1649 // This isn't guaranteed to work, but if there is enough free
1650 // room in the send buffer, put the error message there...
1651 self.do_attempt_write_data(&mut descriptor, &mut *peer);
1653 log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1656 descriptor.disconnect_socket();
1657 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1663 /// Indicates that the given socket descriptor's connection is now closed.
1664 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1665 self.disconnect_event_internal(descriptor, false);
1668 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1669 let mut peers = self.peers.write().unwrap();
1670 let peer_option = peers.peers.remove(descriptor);
1673 // This is most likely a simple race condition where the user found that the socket
1674 // was disconnected, then we told the user to `disconnect_socket()`, then they
1675 // called this method. Either way we're disconnected, return.
1677 Some(peer_lock) => {
1678 let peer = peer_lock.lock().unwrap();
1679 match peer.their_node_id {
1681 log_trace!(self.logger,
1682 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1683 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1684 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1685 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1693 /// Disconnect a peer given its node id.
1695 /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1696 /// force-closing any channels we have with it.
1698 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1699 /// peer. Thus, be very careful about reentrancy issues.
1701 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1702 pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1703 let mut peers_lock = self.peers.write().unwrap();
1704 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1705 log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1706 peers_lock.peers.remove(&descriptor);
1707 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1708 descriptor.disconnect_socket();
1712 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1713 /// an indication that TCP sockets have stalled even if we weren't around to time them out
1714 /// using regular ping/pongs.
1715 pub fn disconnect_all_peers(&self) {
1716 let mut peers_lock = self.peers.write().unwrap();
1717 self.node_id_to_descriptor.lock().unwrap().clear();
1718 let peers = &mut *peers_lock;
1719 for (mut descriptor, peer) in peers.peers.drain() {
1720 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1721 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1722 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1724 descriptor.disconnect_socket();
1728 /// This is called when we're blocked on sending additional gossip messages until we receive a
1729 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1730 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1731 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1732 if peer.awaiting_pong_timer_tick_intervals == 0 {
1733 peer.awaiting_pong_timer_tick_intervals = -1;
1734 let ping = msgs::Ping {
1738 self.enqueue_message(peer, &ping);
1742 /// Send pings to each peer and disconnect those which did not respond to the last round of
1745 /// This may be called on any timescale you want, however, roughly once every ten seconds is
1746 /// preferred. The call rate determines both how often we send a ping to our peers and how much
1747 /// time they have to respond before we disconnect them.
1749 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1752 /// [`send_data`]: SocketDescriptor::send_data
1753 pub fn timer_tick_occurred(&self) {
1754 let mut descriptors_needing_disconnect = Vec::new();
1756 let peers_lock = self.peers.read().unwrap();
1758 for (descriptor, peer_mutex) in peers_lock.peers.iter() {
1759 let mut peer = peer_mutex.lock().unwrap();
1760 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1761 // The peer needs to complete its handshake before we can exchange messages. We
1762 // give peers one timer tick to complete handshake, reusing
1763 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1764 // for handshake completion.
1765 if peer.awaiting_pong_timer_tick_intervals != 0 {
1766 descriptors_needing_disconnect.push(descriptor.clone());
1768 peer.awaiting_pong_timer_tick_intervals = 1;
1773 if peer.awaiting_pong_timer_tick_intervals == -1 {
1774 // Magic value set in `maybe_send_extra_ping`.
1775 peer.awaiting_pong_timer_tick_intervals = 1;
1776 peer.received_message_since_timer_tick = false;
1780 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
1781 || peer.awaiting_pong_timer_tick_intervals as u64 >
1782 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.peers.len() as u64
1784 descriptors_needing_disconnect.push(descriptor.clone());
1787 peer.received_message_since_timer_tick = false;
1789 if peer.awaiting_pong_timer_tick_intervals > 0 {
1790 peer.awaiting_pong_timer_tick_intervals += 1;
1794 peer.awaiting_pong_timer_tick_intervals = 1;
1795 let ping = msgs::Ping {
1799 self.enqueue_message(&mut *peer, &ping);
1800 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer);
1804 if !descriptors_needing_disconnect.is_empty() {
1806 let mut peers_lock = self.peers.write().unwrap();
1807 for descriptor in descriptors_needing_disconnect.iter() {
1808 if let Some(peer) = peers_lock.peers.remove(&descriptor) {
1809 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1810 log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1811 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1812 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1818 for mut descriptor in descriptors_needing_disconnect.drain(..) {
1819 descriptor.disconnect_socket();
1825 fn is_gossip_msg(type_id: u16) -> bool {
1827 msgs::ChannelAnnouncement::TYPE |
1828 msgs::ChannelUpdate::TYPE |
1829 msgs::NodeAnnouncement::TYPE |
1830 msgs::QueryChannelRange::TYPE |
1831 msgs::ReplyChannelRange::TYPE |
1832 msgs::QueryShortChannelIds::TYPE |
1833 msgs::ReplyShortChannelIdsEnd::TYPE => true,
1840 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
1842 use ln::msgs::NetAddress;
1844 use util::test_utils;
1846 use bitcoin::secp256k1::Secp256k1;
1847 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1850 use sync::{Arc, Mutex};
1851 use core::sync::atomic::Ordering;
1854 struct FileDescriptor {
1856 outbound_data: Arc<Mutex<Vec<u8>>>,
1858 impl PartialEq for FileDescriptor {
1859 fn eq(&self, other: &Self) -> bool {
1863 impl Eq for FileDescriptor { }
1864 impl core::hash::Hash for FileDescriptor {
1865 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1866 self.fd.hash(hasher)
1870 impl SocketDescriptor for FileDescriptor {
1871 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1872 self.outbound_data.lock().unwrap().extend_from_slice(data);
1876 fn disconnect_socket(&mut self) {}
1879 struct PeerManagerCfg {
1880 chan_handler: test_utils::TestChannelMessageHandler,
1881 routing_handler: test_utils::TestRoutingMessageHandler,
1882 logger: test_utils::TestLogger,
1885 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1886 let mut cfgs = Vec::new();
1887 for _ in 0..peer_count {
1890 chan_handler: test_utils::TestChannelMessageHandler::new(),
1891 logger: test_utils::TestLogger::new(),
1892 routing_handler: test_utils::TestRoutingMessageHandler::new(),
1900 fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>> {
1901 let mut peers = Vec::new();
1902 for i in 0..peer_count {
1903 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1904 let ephemeral_bytes = [i as u8; 32];
1905 let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1906 let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {});
1913 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>) -> (FileDescriptor, FileDescriptor) {
1914 let secp_ctx = Secp256k1::new();
1915 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1916 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1917 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1918 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
1919 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();
1920 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1921 peer_a.process_events();
1922 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1923 peer_b.process_events();
1924 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1925 peer_a.process_events();
1926 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1927 (fd_a.clone(), fd_b.clone())
1931 fn test_disconnect_peer() {
1932 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1933 // push a DisconnectPeer event to remove the node flagged by id
1934 let cfgs = create_peermgr_cfgs(2);
1935 let chan_handler = test_utils::TestChannelMessageHandler::new();
1936 let mut peers = create_network(2, &cfgs);
1937 establish_connection(&peers[0], &peers[1]);
1938 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 1);
1940 let secp_ctx = Secp256k1::new();
1941 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1943 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1945 action: msgs::ErrorAction::DisconnectPeer { msg: None },
1947 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1948 peers[0].message_handler.chan_handler = &chan_handler;
1950 peers[0].process_events();
1951 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 0);
1955 fn test_timer_tick_occurred() {
1956 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1957 let cfgs = create_peermgr_cfgs(2);
1958 let peers = create_network(2, &cfgs);
1959 establish_connection(&peers[0], &peers[1]);
1960 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 1);
1962 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1963 peers[0].timer_tick_occurred();
1964 peers[0].process_events();
1965 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 1);
1967 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1968 peers[0].timer_tick_occurred();
1969 peers[0].process_events();
1970 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 0);
1974 fn test_do_attempt_write_data() {
1975 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1976 let cfgs = create_peermgr_cfgs(2);
1977 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1978 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1979 let peers = create_network(2, &cfgs);
1981 // By calling establish_connect, we trigger do_attempt_write_data between
1982 // the peers. Previously this function would mistakenly enter an infinite loop
1983 // when there were more channel messages available than could fit into a peer's
1984 // buffer. This issue would now be detected by this test (because we use custom
1985 // RoutingMessageHandlers that intentionally return more channel messages
1986 // than can fit into a peer's buffer).
1987 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1989 // Make each peer to read the messages that the other peer just wrote to them. Note that
1990 // due to the max-message-before-ping limits this may take a few iterations to complete.
1991 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
1992 peers[1].process_events();
1993 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
1994 assert!(!a_read_data.is_empty());
1996 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
1997 peers[0].process_events();
1999 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2000 assert!(!b_read_data.is_empty());
2001 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
2003 peers[0].process_events();
2004 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2007 // Check that each peer has received the expected number of channel updates and channel
2009 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
2010 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
2011 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
2012 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
2016 fn test_handshake_timeout() {
2017 // Tests that we time out a peer still waiting on handshake completion after a full timer
2019 let cfgs = create_peermgr_cfgs(2);
2020 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2021 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2022 let peers = create_network(2, &cfgs);
2024 let secp_ctx = Secp256k1::new();
2025 let a_id = PublicKey::from_secret_key(&secp_ctx, &peers[0].our_node_secret);
2026 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2027 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2028 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2029 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2031 // If we get a single timer tick before completion, that's fine
2032 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 1);
2033 peers[0].timer_tick_occurred();
2034 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 1);
2036 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2037 peers[0].process_events();
2038 assert_eq!(peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
2039 peers[1].process_events();
2041 // ...but if we get a second timer tick, we should disconnect the peer
2042 peers[0].timer_tick_occurred();
2043 assert_eq!(peers[0].peers.read().unwrap().peers.len(), 0);
2045 assert!(peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).is_err());
2049 fn test_filter_addresses(){
2050 // Tests the filter_addresses function.
2053 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2054 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2055 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2056 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2057 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2058 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2061 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2062 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2063 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2064 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2065 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2066 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2069 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2070 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2071 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2072 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2073 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2074 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2077 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2078 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2079 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2080 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2081 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2082 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2085 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2086 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2087 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2088 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2089 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2090 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2093 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2094 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2095 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2096 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2097 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2098 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2101 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2102 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2103 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2104 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2105 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2106 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2108 // For (192.88.99/24)
2109 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2110 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2111 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2112 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2113 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2114 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2116 // For other IPv4 addresses
2117 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2118 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2119 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2120 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2121 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2122 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2125 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2126 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2127 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2128 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2129 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2130 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2132 // For other IPv6 addresses
2133 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2134 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2135 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2136 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2137 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2138 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2141 assert_eq!(filter_addresses(None), None);