1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and P2PGossipSync) with
16 //! messages they should handle, and encoding/sending response messages.
18 use bitcoin::blockdata::constants::ChainHash;
19 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
21 use crate::sign::{KeysManager, NodeSigner, Recipient};
22 use crate::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
23 use crate::ln::ChannelId;
24 use crate::ln::features::{InitFeatures, NodeFeatures};
26 use crate::ln::msgs::{ChannelMessageHandler, LightningError, SocketAddress, OnionMessageHandler, RoutingMessageHandler};
27 #[cfg(not(c_bindings))]
28 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
29 use crate::util::ser::{VecWriter, Writeable, Writer};
30 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor, NextNoiseStep, MessageBuf, MSG_BUF_ALLOC_SIZE};
32 use crate::ln::wire::{Encode, Type};
33 #[cfg(not(c_bindings))]
34 use crate::onion_message::{SimpleArcOnionMessenger, SimpleRefOnionMessenger};
35 use crate::onion_message::{CustomOnionMessageHandler, OffersMessage, OffersMessageHandler, OnionMessageContents, PendingOnionMessage};
36 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, NodeAlias};
37 use crate::util::atomic_counter::AtomicCounter;
38 use crate::util::logger::{Logger, WithContext};
39 use crate::util::string::PrintableString;
41 use crate::prelude::*;
43 use alloc::collections::VecDeque;
44 use crate::sync::{Arc, Mutex, MutexGuard, FairRwLock};
45 use core::sync::atomic::{AtomicBool, AtomicU32, AtomicI32, Ordering};
46 use core::{cmp, hash, fmt, mem};
48 use core::convert::Infallible;
49 #[cfg(feature = "std")] use std::error;
51 use bitcoin::hashes::sha256::Hash as Sha256;
52 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
53 use bitcoin::hashes::{HashEngine, Hash};
55 /// A handler provided to [`PeerManager`] for reading and handling custom messages.
57 /// [BOLT 1] specifies a custom message type range for use with experimental or application-specific
58 /// messages. `CustomMessageHandler` allows for user-defined handling of such types. See the
59 /// [`lightning_custom_message`] crate for tools useful in composing more than one custom handler.
61 /// [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
62 /// [`lightning_custom_message`]: https://docs.rs/lightning_custom_message/latest/lightning_custom_message
63 pub trait CustomMessageHandler: wire::CustomMessageReader {
64 /// Handles the given message sent from `sender_node_id`, possibly producing messages for
65 /// [`CustomMessageHandler::get_and_clear_pending_msg`] to return and thus for [`PeerManager`]
67 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
69 /// Returns the list of pending messages that were generated by the handler, clearing the list
70 /// in the process. Each message is paired with the node id of the intended recipient. If no
71 /// connection to the node exists, then the message is simply not sent.
72 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
74 /// Gets the node feature flags which this handler itself supports. All available handlers are
75 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
76 /// which are broadcasted in our [`NodeAnnouncement`] message.
78 /// [`NodeAnnouncement`]: crate::ln::msgs::NodeAnnouncement
79 fn provided_node_features(&self) -> NodeFeatures;
81 /// Gets the init feature flags which should be sent to the given peer. All available handlers
82 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
83 /// which are sent in our [`Init`] message.
85 /// [`Init`]: crate::ln::msgs::Init
86 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
89 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
90 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
91 pub struct IgnoringMessageHandler{}
92 impl EventsProvider for IgnoringMessageHandler {
93 fn process_pending_events<H: Deref>(&self, _handler: H) where H::Target: EventHandler {}
95 impl MessageSendEventsProvider for IgnoringMessageHandler {
96 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
98 impl RoutingMessageHandler for IgnoringMessageHandler {
99 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
100 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
101 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
102 fn get_next_channel_announcement(&self, _starting_point: u64) ->
103 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
104 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
105 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
106 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
107 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
108 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
109 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
110 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
111 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
112 InitFeatures::empty()
114 fn processing_queue_high(&self) -> bool { false }
116 impl OnionMessageHandler for IgnoringMessageHandler {
117 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
118 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
119 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
120 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
121 fn timer_tick_occurred(&self) {}
122 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
123 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
124 InitFeatures::empty()
127 impl OffersMessageHandler for IgnoringMessageHandler {
128 fn handle_message(&self, _msg: OffersMessage) -> Option<OffersMessage> { None }
130 impl CustomOnionMessageHandler for IgnoringMessageHandler {
131 type CustomMessage = Infallible;
132 fn handle_custom_message(&self, _msg: Infallible) -> Option<Infallible> {
133 // Since we always return `None` in the read the handle method should never be called.
136 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
139 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Infallible>> {
144 impl OnionMessageContents for Infallible {
145 fn tlv_type(&self) -> u64 { unreachable!(); }
148 impl Deref for IgnoringMessageHandler {
149 type Target = IgnoringMessageHandler;
150 fn deref(&self) -> &Self { self }
153 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
154 // method that takes self for it.
155 impl wire::Type for Infallible {
156 fn type_id(&self) -> u16 {
160 impl Writeable for Infallible {
161 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
166 impl wire::CustomMessageReader for IgnoringMessageHandler {
167 type CustomMessage = Infallible;
168 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
173 impl CustomMessageHandler for IgnoringMessageHandler {
174 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
175 // Since we always return `None` in the read the handle method should never be called.
179 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
181 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
183 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
184 InitFeatures::empty()
188 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
189 /// You can provide one of these as the route_handler in a MessageHandler.
190 pub struct ErroringMessageHandler {
191 message_queue: Mutex<Vec<MessageSendEvent>>
193 impl ErroringMessageHandler {
194 /// Constructs a new ErroringMessageHandler
195 pub fn new() -> Self {
196 Self { message_queue: Mutex::new(Vec::new()) }
198 fn push_error(&self, node_id: &PublicKey, channel_id: ChannelId) {
199 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
200 action: msgs::ErrorAction::SendErrorMessage {
201 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
203 node_id: node_id.clone(),
207 impl MessageSendEventsProvider for ErroringMessageHandler {
208 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
209 let mut res = Vec::new();
210 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
214 impl ChannelMessageHandler for ErroringMessageHandler {
215 // Any messages which are related to a specific channel generate an error message to let the
216 // peer know we don't care about channels.
217 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
218 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
220 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
221 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
223 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
224 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
226 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
227 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
229 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
230 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
232 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
233 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
235 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
236 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
238 fn handle_stfu(&self, their_node_id: &PublicKey, msg: &msgs::Stfu) {
239 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
241 fn handle_splice(&self, their_node_id: &PublicKey, msg: &msgs::Splice) {
242 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
244 fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
245 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
247 fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
248 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
250 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
251 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
253 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
254 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
256 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
257 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
259 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
260 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
262 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
263 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
265 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
266 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
268 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
269 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
271 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
272 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
274 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
275 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
277 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
278 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
279 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
280 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
281 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
282 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
283 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
284 // Set a number of features which various nodes may require to talk to us. It's totally
285 // reasonable to indicate we "support" all kinds of channel features...we just reject all
287 let mut features = InitFeatures::empty();
288 features.set_data_loss_protect_optional();
289 features.set_upfront_shutdown_script_optional();
290 features.set_variable_length_onion_optional();
291 features.set_static_remote_key_optional();
292 features.set_payment_secret_optional();
293 features.set_basic_mpp_optional();
294 features.set_wumbo_optional();
295 features.set_shutdown_any_segwit_optional();
296 features.set_channel_type_optional();
297 features.set_scid_privacy_optional();
298 features.set_zero_conf_optional();
302 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
303 // We don't enforce any chains upon peer connection for `ErroringMessageHandler` and leave it up
304 // to users of `ErroringMessageHandler` to make decisions on network compatiblility.
305 // There's not really any way to pull in specific networks here, and hardcoding can cause breakages.
309 fn handle_open_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
310 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
313 fn handle_accept_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
314 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
317 fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
318 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
321 fn handle_tx_add_output(&self, their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
322 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
325 fn handle_tx_remove_input(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
326 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
329 fn handle_tx_remove_output(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
330 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
333 fn handle_tx_complete(&self, their_node_id: &PublicKey, msg: &msgs::TxComplete) {
334 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
337 fn handle_tx_signatures(&self, their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
338 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
341 fn handle_tx_init_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
342 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
345 fn handle_tx_ack_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
346 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
349 fn handle_tx_abort(&self, their_node_id: &PublicKey, msg: &msgs::TxAbort) {
350 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
354 impl Deref for ErroringMessageHandler {
355 type Target = ErroringMessageHandler;
356 fn deref(&self) -> &Self { self }
359 /// Provides references to trait impls which handle different types of messages.
360 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref, CustomM: Deref> where
361 CM::Target: ChannelMessageHandler,
362 RM::Target: RoutingMessageHandler,
363 OM::Target: OnionMessageHandler,
364 CustomM::Target: CustomMessageHandler,
366 /// A message handler which handles messages specific to channels. Usually this is just a
367 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
369 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
370 pub chan_handler: CM,
371 /// A message handler which handles messages updating our knowledge of the network channel
372 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
374 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
375 pub route_handler: RM,
377 /// A message handler which handles onion messages. This should generally be an
378 /// [`OnionMessenger`], but can also be an [`IgnoringMessageHandler`].
380 /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
381 pub onion_message_handler: OM,
383 /// A message handler which handles custom messages. The only LDK-provided implementation is
384 /// [`IgnoringMessageHandler`].
385 pub custom_message_handler: CustomM,
388 /// Provides an object which can be used to send data to and which uniquely identifies a connection
389 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
390 /// implement Hash to meet the PeerManager API.
392 /// For efficiency, [`Clone`] should be relatively cheap for this type.
394 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
395 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
396 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
397 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
398 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
399 /// to simply use another value which is guaranteed to be globally unique instead.
400 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
401 /// Attempts to send some data from the given slice to the peer.
403 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
404 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
405 /// called and further write attempts may occur until that time.
407 /// If the returned size is smaller than `data.len()`, a
408 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
409 /// written. Additionally, until a `send_data` event completes fully, no further
410 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
411 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
414 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
415 /// (indicating that read events should be paused to prevent DoS in the send buffer),
416 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
417 /// `resume_read` of false carries no meaning, and should not cause any action.
418 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
419 /// Disconnect the socket pointed to by this SocketDescriptor.
421 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
422 /// call (doing so is a noop).
423 fn disconnect_socket(&mut self);
426 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
427 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
430 pub struct PeerHandleError { }
431 impl fmt::Debug for PeerHandleError {
432 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
433 formatter.write_str("Peer Sent Invalid Data")
436 impl fmt::Display for PeerHandleError {
437 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
438 formatter.write_str("Peer Sent Invalid Data")
442 #[cfg(feature = "std")]
443 impl error::Error for PeerHandleError {
444 fn description(&self) -> &str {
445 "Peer Sent Invalid Data"
449 enum InitSyncTracker{
451 ChannelsSyncing(u64),
452 NodesSyncing(NodeId),
455 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
456 /// forwarding gossip messages to peers altogether.
457 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
459 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
460 /// we have fewer than this many messages in the outbound buffer again.
461 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
462 /// refilled as we send bytes.
463 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
464 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
466 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
468 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
469 /// the socket receive buffer before receiving the ping.
471 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
472 /// including any network delays, outbound traffic, or the same for messages from other peers.
474 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
475 /// per connected peer to respond to a ping, as long as they send us at least one message during
476 /// each tick, ensuring we aren't actually just disconnected.
477 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
480 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
481 /// two connected peers, assuming most LDK-running systems have at least two cores.
482 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
484 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
485 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
486 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
487 /// process before the next ping.
489 /// Note that we continue responding to other messages even after we've sent this many messages, so
490 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
491 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
492 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
495 channel_encryptor: PeerChannelEncryptor,
496 /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
497 /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
498 their_node_id: Option<(PublicKey, NodeId)>,
499 /// The features provided in the peer's [`msgs::Init`] message.
501 /// This is set only after we've processed the [`msgs::Init`] message and called relevant
502 /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
503 /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
505 their_features: Option<InitFeatures>,
506 their_socket_address: Option<SocketAddress>,
508 pending_outbound_buffer: VecDeque<Vec<u8>>,
509 pending_outbound_buffer_first_msg_offset: usize,
510 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
511 /// prioritize channel messages over them.
513 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
514 gossip_broadcast_buffer: VecDeque<MessageBuf>,
515 awaiting_write_event: bool,
517 pending_read_buffer: Vec<u8>,
518 pending_read_buffer_pos: usize,
519 pending_read_is_header: bool,
521 sync_status: InitSyncTracker,
523 msgs_sent_since_pong: usize,
524 awaiting_pong_timer_tick_intervals: i64,
525 received_message_since_timer_tick: bool,
526 sent_gossip_timestamp_filter: bool,
528 /// Indicates we've received a `channel_announcement` since the last time we had
529 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
530 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
531 /// check if we're gossip-processing-backlogged).
532 received_channel_announce_since_backlogged: bool,
534 inbound_connection: bool,
538 /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
539 /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
541 fn handshake_complete(&self) -> bool {
542 self.their_features.is_some()
545 /// Returns true if the channel announcements/updates for the given channel should be
546 /// forwarded to this peer.
547 /// If we are sending our routing table to this peer and we have not yet sent channel
548 /// announcements/updates for the given channel_id then we will send it when we get to that
549 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
550 /// sent the old versions, we should send the update, and so return true here.
551 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
552 if !self.handshake_complete() { return false; }
553 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
554 !self.sent_gossip_timestamp_filter {
557 match self.sync_status {
558 InitSyncTracker::NoSyncRequested => true,
559 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
560 InitSyncTracker::NodesSyncing(_) => true,
564 /// Similar to the above, but for node announcements indexed by node_id.
565 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
566 if !self.handshake_complete() { return false; }
567 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
568 !self.sent_gossip_timestamp_filter {
571 match self.sync_status {
572 InitSyncTracker::NoSyncRequested => true,
573 InitSyncTracker::ChannelsSyncing(_) => false,
574 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
578 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
579 /// buffer still has space and we don't need to pause reads to get some writes out.
580 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
581 if !gossip_processing_backlogged {
582 self.received_channel_announce_since_backlogged = false;
584 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
585 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
588 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
589 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
590 fn should_buffer_gossip_backfill(&self) -> bool {
591 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
592 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
593 && self.handshake_complete()
596 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
597 /// every time the peer's buffer may have been drained.
598 fn should_buffer_onion_message(&self) -> bool {
599 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
600 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
603 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
604 /// buffer. This is checked every time the peer's buffer may have been drained.
605 fn should_buffer_gossip_broadcast(&self) -> bool {
606 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
607 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
610 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
611 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
612 let total_outbound_buffered =
613 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
615 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
616 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
619 fn set_their_node_id(&mut self, node_id: PublicKey) {
620 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
624 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
625 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
626 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
627 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
628 /// issues such as overly long function definitions.
630 /// This is not exported to bindings users as type aliases aren't supported in most languages.
631 #[cfg(not(c_bindings))]
632 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<
634 Arc<SimpleArcChannelManager<M, T, F, L>>,
635 Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, C, Arc<L>>>,
636 Arc<SimpleArcOnionMessenger<M, T, F, L>>,
638 IgnoringMessageHandler,
642 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
643 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
644 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
645 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
646 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
647 /// helps with issues such as long function definitions.
649 /// This is not exported to bindings users as type aliases aren't supported in most languages.
650 #[cfg(not(c_bindings))]
651 pub type SimpleRefPeerManager<
652 'a, 'b, 'c, 'd, 'e, 'f, 'logger, 'h, 'i, 'j, 'graph, 'k, SD, M, T, F, C, L
655 &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, M, T, F, L>,
656 &'f P2PGossipSync<&'graph NetworkGraph<&'logger L>, C, &'logger L>,
657 &'h SimpleRefOnionMessenger<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, 'j, 'k, M, T, F, L>,
659 IgnoringMessageHandler,
664 /// A generic trait which is implemented for all [`PeerManager`]s. This makes bounding functions or
665 /// structs on any [`PeerManager`] much simpler as only this trait is needed as a bound, rather
666 /// than the full set of bounds on [`PeerManager`] itself.
668 /// This is not exported to bindings users as general cover traits aren't useful in other
670 #[allow(missing_docs)]
671 pub trait APeerManager {
672 type Descriptor: SocketDescriptor;
673 type CMT: ChannelMessageHandler + ?Sized;
674 type CM: Deref<Target=Self::CMT>;
675 type RMT: RoutingMessageHandler + ?Sized;
676 type RM: Deref<Target=Self::RMT>;
677 type OMT: OnionMessageHandler + ?Sized;
678 type OM: Deref<Target=Self::OMT>;
679 type LT: Logger + ?Sized;
680 type L: Deref<Target=Self::LT>;
681 type CMHT: CustomMessageHandler + ?Sized;
682 type CMH: Deref<Target=Self::CMHT>;
683 type NST: NodeSigner + ?Sized;
684 type NS: Deref<Target=Self::NST>;
685 /// Gets a reference to the underlying [`PeerManager`].
686 fn as_ref(&self) -> &PeerManager<Self::Descriptor, Self::CM, Self::RM, Self::OM, Self::L, Self::CMH, Self::NS>;
689 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref>
690 APeerManager for PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
691 CM::Target: ChannelMessageHandler,
692 RM::Target: RoutingMessageHandler,
693 OM::Target: OnionMessageHandler,
695 CMH::Target: CustomMessageHandler,
696 NS::Target: NodeSigner,
698 type Descriptor = Descriptor;
699 type CMT = <CM as Deref>::Target;
701 type RMT = <RM as Deref>::Target;
703 type OMT = <OM as Deref>::Target;
705 type LT = <L as Deref>::Target;
707 type CMHT = <CMH as Deref>::Target;
709 type NST = <NS as Deref>::Target;
711 fn as_ref(&self) -> &PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> { self }
714 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
715 /// socket events into messages which it passes on to its [`MessageHandler`].
717 /// Locks are taken internally, so you must never assume that reentrancy from a
718 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
720 /// Calls to [`read_event`] will decode relevant messages and pass them to the
721 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
722 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
723 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
724 /// calls only after previous ones have returned.
726 /// Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
727 /// a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
728 /// essentially you should default to using a [`SimpleRefPeerManager`], and use a
729 /// [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
730 /// you're using lightning-net-tokio.
732 /// [`read_event`]: PeerManager::read_event
733 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
734 CM::Target: ChannelMessageHandler,
735 RM::Target: RoutingMessageHandler,
736 OM::Target: OnionMessageHandler,
738 CMH::Target: CustomMessageHandler,
739 NS::Target: NodeSigner {
740 message_handler: MessageHandler<CM, RM, OM, CMH>,
741 /// Connection state for each connected peer - we have an outer read-write lock which is taken
742 /// as read while we're doing processing for a peer and taken write when a peer is being added
745 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
746 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
747 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
748 /// the `MessageHandler`s for a given peer is already guaranteed.
749 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
750 /// Only add to this set when noise completes.
751 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
752 /// lock held. Entries may be added with only the `peers` read lock held (though the
753 /// `Descriptor` value must already exist in `peers`).
754 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
755 /// We can only have one thread processing events at once, but if a second call to
756 /// `process_events` happens while a first call is in progress, one of the two calls needs to
757 /// start from the top to ensure any new messages are also handled.
759 /// Because the event handler calls into user code which may block, we don't want to block a
760 /// second thread waiting for another thread to handle events which is then blocked on user
761 /// code, so we store an atomic counter here:
762 /// * 0 indicates no event processor is running
763 /// * 1 indicates an event processor is running
764 /// * > 1 indicates an event processor is running but needs to start again from the top once
765 /// it finishes as another thread tried to start processing events but returned early.
766 event_processing_state: AtomicI32,
768 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
769 /// value increases strictly since we don't assume access to a time source.
770 last_node_announcement_serial: AtomicU32,
772 ephemeral_key_midstate: Sha256Engine,
774 peer_counter: AtomicCounter,
776 gossip_processing_backlogged: AtomicBool,
777 gossip_processing_backlog_lifted: AtomicBool,
782 secp_ctx: Secp256k1<secp256k1::SignOnly>
785 enum MessageHandlingError {
786 PeerHandleError(PeerHandleError),
787 LightningError(LightningError),
790 impl From<PeerHandleError> for MessageHandlingError {
791 fn from(error: PeerHandleError) -> Self {
792 MessageHandlingError::PeerHandleError(error)
796 impl From<LightningError> for MessageHandlingError {
797 fn from(error: LightningError) -> Self {
798 MessageHandlingError::LightningError(error)
802 macro_rules! encode_msg {
804 let mut buffer = VecWriter(Vec::with_capacity(MSG_BUF_ALLOC_SIZE));
805 wire::write($msg, &mut buffer).unwrap();
810 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
811 CM::Target: ChannelMessageHandler,
812 OM::Target: OnionMessageHandler,
814 NS::Target: NodeSigner {
815 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
816 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
819 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
820 /// cryptographically secure random bytes.
822 /// `current_time` is used as an always-increasing counter that survives across restarts and is
823 /// incremented irregularly internally. In general it is best to simply use the current UNIX
824 /// timestamp, however if it is not available a persistent counter that increases once per
825 /// minute should suffice.
827 /// This is not exported to bindings users as we can't export a PeerManager with a dummy route handler
828 pub fn new_channel_only(channel_message_handler: CM, onion_message_handler: OM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
829 Self::new(MessageHandler {
830 chan_handler: channel_message_handler,
831 route_handler: IgnoringMessageHandler{},
832 onion_message_handler,
833 custom_message_handler: IgnoringMessageHandler{},
834 }, current_time, ephemeral_random_data, logger, node_signer)
838 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
839 RM::Target: RoutingMessageHandler,
841 NS::Target: NodeSigner {
842 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
843 /// handler or onion message handler is used and onion and channel messages will be ignored (or
844 /// generate error messages). Note that some other lightning implementations time-out connections
845 /// after some time if no channel is built with the peer.
847 /// `current_time` is used as an always-increasing counter that survives across restarts and is
848 /// incremented irregularly internally. In general it is best to simply use the current UNIX
849 /// timestamp, however if it is not available a persistent counter that increases once per
850 /// minute should suffice.
852 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
853 /// cryptographically secure random bytes.
855 /// This is not exported to bindings users as we can't export a PeerManager with a dummy channel handler
856 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
857 Self::new(MessageHandler {
858 chan_handler: ErroringMessageHandler::new(),
859 route_handler: routing_message_handler,
860 onion_message_handler: IgnoringMessageHandler{},
861 custom_message_handler: IgnoringMessageHandler{},
862 }, current_time, ephemeral_random_data, logger, node_signer)
866 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
867 /// This works around `format!()` taking a reference to each argument, preventing
868 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
869 /// due to lifetime errors.
870 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
871 impl core::fmt::Display for OptionalFromDebugger<'_> {
872 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
873 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
877 /// A function used to filter out local or private addresses
878 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
879 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
880 fn filter_addresses(ip_address: Option<SocketAddress>) -> Option<SocketAddress> {
882 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
883 Some(SocketAddress::TcpIpV4{addr: [10, _, _, _], port: _}) => None,
884 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
885 Some(SocketAddress::TcpIpV4{addr: [0, _, _, _], port: _}) => None,
886 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
887 Some(SocketAddress::TcpIpV4{addr: [100, 64..=127, _, _], port: _}) => None,
888 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
889 Some(SocketAddress::TcpIpV4{addr: [127, _, _, _], port: _}) => None,
890 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
891 Some(SocketAddress::TcpIpV4{addr: [169, 254, _, _], port: _}) => None,
892 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
893 Some(SocketAddress::TcpIpV4{addr: [172, 16..=31, _, _], port: _}) => None,
894 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
895 Some(SocketAddress::TcpIpV4{addr: [192, 168, _, _], port: _}) => None,
896 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
897 Some(SocketAddress::TcpIpV4{addr: [192, 88, 99, _], port: _}) => None,
898 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
899 Some(SocketAddress::TcpIpV6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
900 // For remaining addresses
901 Some(SocketAddress::TcpIpV6{addr: _, port: _}) => None,
902 Some(..) => ip_address,
907 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
908 CM::Target: ChannelMessageHandler,
909 RM::Target: RoutingMessageHandler,
910 OM::Target: OnionMessageHandler,
912 CMH::Target: CustomMessageHandler,
913 NS::Target: NodeSigner
915 /// Constructs a new `PeerManager` with the given message handlers.
917 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
918 /// cryptographically secure random bytes.
920 /// `current_time` is used as an always-increasing counter that survives across restarts and is
921 /// incremented irregularly internally. In general it is best to simply use the current UNIX
922 /// timestamp, however if it is not available a persistent counter that increases once per
923 /// minute should suffice.
924 pub fn new(message_handler: MessageHandler<CM, RM, OM, CMH>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
925 let mut ephemeral_key_midstate = Sha256::engine();
926 ephemeral_key_midstate.input(ephemeral_random_data);
928 let mut secp_ctx = Secp256k1::signing_only();
929 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).to_byte_array();
930 secp_ctx.seeded_randomize(&ephemeral_hash);
934 peers: FairRwLock::new(HashMap::new()),
935 node_id_to_descriptor: Mutex::new(HashMap::new()),
936 event_processing_state: AtomicI32::new(0),
937 ephemeral_key_midstate,
938 peer_counter: AtomicCounter::new(),
939 gossip_processing_backlogged: AtomicBool::new(false),
940 gossip_processing_backlog_lifted: AtomicBool::new(false),
941 last_node_announcement_serial: AtomicU32::new(current_time),
948 /// Get a list of tuples mapping from node id to network addresses for peers which have
949 /// completed the initial handshake.
951 /// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
952 /// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
953 /// handshake has completed and we are sure the remote peer has the private key for the given
956 /// The returned `Option`s will only be `Some` if an address had been previously given via
957 /// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
958 pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
959 let peers = self.peers.read().unwrap();
960 peers.values().filter_map(|peer_mutex| {
961 let p = peer_mutex.lock().unwrap();
962 if !p.handshake_complete() {
965 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
969 fn get_ephemeral_key(&self) -> SecretKey {
970 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
971 let counter = self.peer_counter.get_increment();
972 ephemeral_hash.input(&counter.to_le_bytes());
973 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).to_byte_array()).expect("You broke SHA-256!")
976 fn init_features(&self, their_node_id: &PublicKey) -> InitFeatures {
977 self.message_handler.chan_handler.provided_init_features(their_node_id)
978 | self.message_handler.route_handler.provided_init_features(their_node_id)
979 | self.message_handler.onion_message_handler.provided_init_features(their_node_id)
980 | self.message_handler.custom_message_handler.provided_init_features(their_node_id)
983 /// Indicates a new outbound connection has been established to a node with the given `node_id`
984 /// and an optional remote network address.
986 /// The remote network address adds the option to report a remote IP address back to a connecting
987 /// peer using the init message.
988 /// The user should pass the remote network address of the host they are connected to.
990 /// If an `Err` is returned here you must disconnect the connection immediately.
992 /// Returns a small number of bytes to send to the remote node (currently always 50).
994 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
995 /// [`socket_disconnected`].
997 /// [`socket_disconnected`]: PeerManager::socket_disconnected
998 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<Vec<u8>, PeerHandleError> {
999 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
1000 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
1001 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
1003 let mut peers = self.peers.write().unwrap();
1004 match peers.entry(descriptor) {
1005 hash_map::Entry::Occupied(_) => {
1006 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1007 Err(PeerHandleError {})
1009 hash_map::Entry::Vacant(e) => {
1010 e.insert(Mutex::new(Peer {
1011 channel_encryptor: peer_encryptor,
1012 their_node_id: None,
1013 their_features: None,
1014 their_socket_address: remote_network_address,
1016 pending_outbound_buffer: VecDeque::new(),
1017 pending_outbound_buffer_first_msg_offset: 0,
1018 gossip_broadcast_buffer: VecDeque::new(),
1019 awaiting_write_event: false,
1021 pending_read_buffer,
1022 pending_read_buffer_pos: 0,
1023 pending_read_is_header: false,
1025 sync_status: InitSyncTracker::NoSyncRequested,
1027 msgs_sent_since_pong: 0,
1028 awaiting_pong_timer_tick_intervals: 0,
1029 received_message_since_timer_tick: false,
1030 sent_gossip_timestamp_filter: false,
1032 received_channel_announce_since_backlogged: false,
1033 inbound_connection: false,
1040 /// Indicates a new inbound connection has been established to a node with an optional remote
1041 /// network address.
1043 /// The remote network address adds the option to report a remote IP address back to a connecting
1044 /// peer using the init message.
1045 /// The user should pass the remote network address of the host they are connected to.
1047 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
1048 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
1049 /// the connection immediately.
1051 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1052 /// [`socket_disconnected`].
1054 /// [`socket_disconnected`]: PeerManager::socket_disconnected
1055 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<(), PeerHandleError> {
1056 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
1057 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
1059 let mut peers = self.peers.write().unwrap();
1060 match peers.entry(descriptor) {
1061 hash_map::Entry::Occupied(_) => {
1062 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1063 Err(PeerHandleError {})
1065 hash_map::Entry::Vacant(e) => {
1066 e.insert(Mutex::new(Peer {
1067 channel_encryptor: peer_encryptor,
1068 their_node_id: None,
1069 their_features: None,
1070 their_socket_address: remote_network_address,
1072 pending_outbound_buffer: VecDeque::new(),
1073 pending_outbound_buffer_first_msg_offset: 0,
1074 gossip_broadcast_buffer: VecDeque::new(),
1075 awaiting_write_event: false,
1077 pending_read_buffer,
1078 pending_read_buffer_pos: 0,
1079 pending_read_is_header: false,
1081 sync_status: InitSyncTracker::NoSyncRequested,
1083 msgs_sent_since_pong: 0,
1084 awaiting_pong_timer_tick_intervals: 0,
1085 received_message_since_timer_tick: false,
1086 sent_gossip_timestamp_filter: false,
1088 received_channel_announce_since_backlogged: false,
1089 inbound_connection: true,
1096 fn peer_should_read(&self, peer: &mut Peer) -> bool {
1097 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
1100 fn update_gossip_backlogged(&self) {
1101 let new_state = self.message_handler.route_handler.processing_queue_high();
1102 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
1103 if prev_state && !new_state {
1104 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
1108 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
1109 let mut have_written = false;
1110 while !peer.awaiting_write_event {
1111 if peer.should_buffer_onion_message() {
1112 if let Some((peer_node_id, _)) = peer.their_node_id {
1113 if let Some(next_onion_message) =
1114 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
1115 self.enqueue_message(peer, &next_onion_message);
1119 if peer.should_buffer_gossip_broadcast() {
1120 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
1121 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(msg));
1124 if peer.should_buffer_gossip_backfill() {
1125 match peer.sync_status {
1126 InitSyncTracker::NoSyncRequested => {},
1127 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
1128 if let Some((announce, update_a_option, update_b_option)) =
1129 self.message_handler.route_handler.get_next_channel_announcement(c)
1131 self.enqueue_message(peer, &announce);
1132 if let Some(update_a) = update_a_option {
1133 self.enqueue_message(peer, &update_a);
1135 if let Some(update_b) = update_b_option {
1136 self.enqueue_message(peer, &update_b);
1138 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
1140 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
1143 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
1144 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
1145 self.enqueue_message(peer, &msg);
1146 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1148 peer.sync_status = InitSyncTracker::NoSyncRequested;
1151 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
1152 InitSyncTracker::NodesSyncing(sync_node_id) => {
1153 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
1154 self.enqueue_message(peer, &msg);
1155 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1157 peer.sync_status = InitSyncTracker::NoSyncRequested;
1162 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
1163 self.maybe_send_extra_ping(peer);
1166 let should_read = self.peer_should_read(peer);
1167 let next_buff = match peer.pending_outbound_buffer.front() {
1169 if force_one_write && !have_written {
1171 let data_sent = descriptor.send_data(&[], should_read);
1172 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
1180 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
1181 let data_sent = descriptor.send_data(pending, should_read);
1182 have_written = true;
1183 peer.pending_outbound_buffer_first_msg_offset += data_sent;
1184 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
1185 peer.pending_outbound_buffer_first_msg_offset = 0;
1186 peer.pending_outbound_buffer.pop_front();
1187 const VEC_SIZE: usize = ::core::mem::size_of::<Vec<u8>>();
1188 let large_capacity = peer.pending_outbound_buffer.capacity() > 4096 / VEC_SIZE;
1189 let lots_of_slack = peer.pending_outbound_buffer.len()
1190 < peer.pending_outbound_buffer.capacity() / 2;
1191 if large_capacity && lots_of_slack {
1192 peer.pending_outbound_buffer.shrink_to_fit();
1195 peer.awaiting_write_event = true;
1200 /// Indicates that there is room to write data to the given socket descriptor.
1202 /// May return an Err to indicate that the connection should be closed.
1204 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1205 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1206 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1207 /// ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
1210 /// [`send_data`]: SocketDescriptor::send_data
1211 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1212 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1213 let peers = self.peers.read().unwrap();
1214 match peers.get(descriptor) {
1216 // This is most likely a simple race condition where the user found that the socket
1217 // was writeable, then we told the user to `disconnect_socket()`, then they called
1218 // this method. Return an error to make sure we get disconnected.
1219 return Err(PeerHandleError { });
1221 Some(peer_mutex) => {
1222 let mut peer = peer_mutex.lock().unwrap();
1223 peer.awaiting_write_event = false;
1224 self.do_attempt_write_data(descriptor, &mut peer, false);
1230 /// Indicates that data was read from the given socket descriptor.
1232 /// May return an Err to indicate that the connection should be closed.
1234 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1235 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1236 /// [`send_data`] calls to handle responses.
1238 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1239 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1242 /// In order to avoid processing too many messages at once per peer, `data` should be on the
1245 /// [`send_data`]: SocketDescriptor::send_data
1246 /// [`process_events`]: PeerManager::process_events
1247 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1248 match self.do_read_event(peer_descriptor, data) {
1251 log_trace!(self.logger, "Disconnecting peer due to a protocol error (usually a duplicate connection).");
1252 self.disconnect_event_internal(peer_descriptor);
1258 /// Append a message to a peer's pending outbound/write buffer
1259 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1260 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1261 if is_gossip_msg(message.type_id()) {
1262 log_gossip!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1264 log_trace!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1266 peer.msgs_sent_since_pong += 1;
1267 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1270 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1271 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: MessageBuf) {
1272 peer.msgs_sent_since_pong += 1;
1273 debug_assert!(peer.gossip_broadcast_buffer.len() <= OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP);
1274 peer.gossip_broadcast_buffer.push_back(encoded_message);
1277 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1278 let mut pause_read = false;
1279 let peers = self.peers.read().unwrap();
1280 let mut msgs_to_forward = Vec::new();
1281 let mut peer_node_id = None;
1282 match peers.get(peer_descriptor) {
1284 // This is most likely a simple race condition where the user read some bytes
1285 // from the socket, then we told the user to `disconnect_socket()`, then they
1286 // called this method. Return an error to make sure we get disconnected.
1287 return Err(PeerHandleError { });
1289 Some(peer_mutex) => {
1290 let mut read_pos = 0;
1291 while read_pos < data.len() {
1292 macro_rules! try_potential_handleerror {
1293 ($peer: expr, $thing: expr) => {
1298 msgs::ErrorAction::DisconnectPeer { .. } => {
1299 // We may have an `ErrorMessage` to send to the peer,
1300 // but writing to the socket while reading can lead to
1301 // re-entrant code and possibly unexpected behavior. The
1302 // message send is optimistic anyway, and in this case
1303 // we immediately disconnect the peer.
1304 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1305 return Err(PeerHandleError { });
1307 msgs::ErrorAction::DisconnectPeerWithWarning { .. } => {
1308 // We have a `WarningMessage` to send to the peer, but
1309 // writing to the socket while reading can lead to
1310 // re-entrant code and possibly unexpected behavior. The
1311 // message send is optimistic anyway, and in this case
1312 // we immediately disconnect the peer.
1313 log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1314 return Err(PeerHandleError { });
1316 msgs::ErrorAction::IgnoreAndLog(level) => {
1317 log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1320 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1321 msgs::ErrorAction::IgnoreError => {
1322 log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1325 msgs::ErrorAction::SendErrorMessage { msg } => {
1326 log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1327 self.enqueue_message($peer, &msg);
1330 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1331 log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1332 self.enqueue_message($peer, &msg);
1341 let mut peer_lock = peer_mutex.lock().unwrap();
1342 let peer = &mut *peer_lock;
1343 let mut msg_to_handle = None;
1344 if peer_node_id.is_none() {
1345 peer_node_id = peer.their_node_id.clone();
1348 assert!(peer.pending_read_buffer.len() > 0);
1349 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1352 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1353 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]);
1354 read_pos += data_to_copy;
1355 peer.pending_read_buffer_pos += data_to_copy;
1358 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1359 peer.pending_read_buffer_pos = 0;
1361 macro_rules! insert_node_id {
1363 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1364 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1365 hash_map::Entry::Occupied(e) => {
1366 log_trace!(logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1367 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1368 // Check that the peers map is consistent with the
1369 // node_id_to_descriptor map, as this has been broken
1371 debug_assert!(peers.get(e.get()).is_some());
1372 return Err(PeerHandleError { })
1374 hash_map::Entry::Vacant(entry) => {
1375 log_debug!(logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1376 entry.insert(peer_descriptor.clone())
1382 let next_step = peer.channel_encryptor.get_noise_step();
1384 NextNoiseStep::ActOne => {
1385 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1386 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1387 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1388 peer.pending_outbound_buffer.push_back(act_two);
1389 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1391 NextNoiseStep::ActTwo => {
1392 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1393 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1394 &self.node_signer));
1395 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1396 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1397 peer.pending_read_is_header = true;
1399 peer.set_their_node_id(their_node_id);
1401 let features = self.init_features(&their_node_id);
1402 let networks = self.message_handler.chan_handler.get_chain_hashes();
1403 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1404 self.enqueue_message(peer, &resp);
1405 peer.awaiting_pong_timer_tick_intervals = 0;
1407 NextNoiseStep::ActThree => {
1408 let their_node_id = try_potential_handleerror!(peer,
1409 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1410 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1411 peer.pending_read_is_header = true;
1412 peer.set_their_node_id(their_node_id);
1414 let features = self.init_features(&their_node_id);
1415 let networks = self.message_handler.chan_handler.get_chain_hashes();
1416 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1417 self.enqueue_message(peer, &resp);
1418 peer.awaiting_pong_timer_tick_intervals = 0;
1420 NextNoiseStep::NoiseComplete => {
1421 if peer.pending_read_is_header {
1422 let msg_len = try_potential_handleerror!(peer,
1423 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1424 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1425 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1426 if msg_len < 2 { // Need at least the message type tag
1427 return Err(PeerHandleError { });
1429 peer.pending_read_is_header = false;
1431 debug_assert!(peer.pending_read_buffer.len() >= 2 + 16);
1432 try_potential_handleerror!(peer,
1433 peer.channel_encryptor.decrypt_message(&mut peer.pending_read_buffer[..]));
1435 let mut reader = io::Cursor::new(&peer.pending_read_buffer[..peer.pending_read_buffer.len() - 16]);
1436 let message_result = wire::read(&mut reader, &*self.message_handler.custom_message_handler);
1438 // Reset read buffer
1439 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1440 peer.pending_read_buffer.resize(18, 0);
1441 peer.pending_read_is_header = true;
1443 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1444 let message = match message_result {
1448 // Note that to avoid re-entrancy we never call
1449 // `do_attempt_write_data` from here, causing
1450 // the messages enqueued here to not actually
1451 // be sent before the peer is disconnected.
1452 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1453 log_gossip!(logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1456 (msgs::DecodeError::UnsupportedCompression, _) => {
1457 log_gossip!(logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1458 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: ChannelId::new_zero(), data: "Unsupported message compression: zlib".to_owned() });
1461 (_, Some(ty)) if is_gossip_msg(ty) => {
1462 log_gossip!(logger, "Got an invalid value while deserializing a gossip message");
1463 self.enqueue_message(peer, &msgs::WarningMessage {
1464 channel_id: ChannelId::new_zero(),
1465 data: format!("Unreadable/bogus gossip message of type {}", ty),
1469 (msgs::DecodeError::UnknownRequiredFeature, _) => {
1470 log_debug!(logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1471 return Err(PeerHandleError { });
1473 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1474 (msgs::DecodeError::InvalidValue, _) => {
1475 log_debug!(logger, "Got an invalid value while deserializing message");
1476 return Err(PeerHandleError { });
1478 (msgs::DecodeError::ShortRead, _) => {
1479 log_debug!(logger, "Deserialization failed due to shortness of message");
1480 return Err(PeerHandleError { });
1482 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1483 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1488 msg_to_handle = Some(message);
1493 pause_read = !self.peer_should_read(peer);
1495 if let Some(message) = msg_to_handle {
1496 match self.handle_message(&peer_mutex, peer_lock, message) {
1497 Err(handling_error) => match handling_error {
1498 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1499 MessageHandlingError::LightningError(e) => {
1500 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1504 msgs_to_forward.push(msg);
1513 for msg in msgs_to_forward.drain(..) {
1514 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1520 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1521 /// Returns the message back if it needs to be broadcasted to all other peers.
1524 peer_mutex: &Mutex<Peer>,
1525 mut peer_lock: MutexGuard<Peer>,
1526 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1527 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1528 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages").0;
1529 let logger = WithContext::from(&self.logger, Some(their_node_id), None);
1530 peer_lock.received_message_since_timer_tick = true;
1532 // Need an Init as first message
1533 if let wire::Message::Init(msg) = message {
1534 // Check if we have any compatible chains if the `networks` field is specified.
1535 if let Some(networks) = &msg.networks {
1536 if let Some(our_chains) = self.message_handler.chan_handler.get_chain_hashes() {
1537 let mut have_compatible_chains = false;
1538 'our_chains: for our_chain in our_chains.iter() {
1539 for their_chain in networks {
1540 if our_chain == their_chain {
1541 have_compatible_chains = true;
1546 if !have_compatible_chains {
1547 log_debug!(logger, "Peer does not support any of our supported chains");
1548 return Err(PeerHandleError { }.into());
1553 let our_features = self.init_features(&their_node_id);
1554 if msg.features.requires_unknown_bits_from(&our_features) {
1555 log_debug!(logger, "Peer requires features unknown to us");
1556 return Err(PeerHandleError { }.into());
1559 if our_features.requires_unknown_bits_from(&msg.features) {
1560 log_debug!(logger, "We require features unknown to our peer");
1561 return Err(PeerHandleError { }.into());
1564 if peer_lock.their_features.is_some() {
1565 return Err(PeerHandleError { }.into());
1568 log_info!(logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1570 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1571 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1572 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1575 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1576 log_debug!(logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1577 return Err(PeerHandleError { }.into());
1579 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1580 log_debug!(logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1581 return Err(PeerHandleError { }.into());
1583 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1584 log_debug!(logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1585 return Err(PeerHandleError { }.into());
1588 peer_lock.their_features = Some(msg.features);
1590 } else if peer_lock.their_features.is_none() {
1591 log_debug!(logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1592 return Err(PeerHandleError { }.into());
1595 if let wire::Message::GossipTimestampFilter(_msg) = message {
1596 // When supporting gossip messages, start inital gossip sync only after we receive
1597 // a GossipTimestampFilter
1598 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1599 !peer_lock.sent_gossip_timestamp_filter {
1600 peer_lock.sent_gossip_timestamp_filter = true;
1601 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1606 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1607 peer_lock.received_channel_announce_since_backlogged = true;
1610 mem::drop(peer_lock);
1612 if is_gossip_msg(message.type_id()) {
1613 log_gossip!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1615 log_trace!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1618 let mut should_forward = None;
1621 // Setup and Control messages:
1622 wire::Message::Init(_) => {
1625 wire::Message::GossipTimestampFilter(_) => {
1628 wire::Message::Error(msg) => {
1629 log_debug!(logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1630 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1631 if msg.channel_id.is_zero() {
1632 return Err(PeerHandleError { }.into());
1635 wire::Message::Warning(msg) => {
1636 log_debug!(logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1639 wire::Message::Ping(msg) => {
1640 if msg.ponglen < 65532 {
1641 let resp = msgs::Pong { byteslen: msg.ponglen };
1642 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1645 wire::Message::Pong(_msg) => {
1646 let mut peer_lock = peer_mutex.lock().unwrap();
1647 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1648 peer_lock.msgs_sent_since_pong = 0;
1651 // Channel messages:
1652 wire::Message::OpenChannel(msg) => {
1653 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1655 wire::Message::OpenChannelV2(msg) => {
1656 self.message_handler.chan_handler.handle_open_channel_v2(&their_node_id, &msg);
1658 wire::Message::AcceptChannel(msg) => {
1659 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1661 wire::Message::AcceptChannelV2(msg) => {
1662 self.message_handler.chan_handler.handle_accept_channel_v2(&their_node_id, &msg);
1665 wire::Message::FundingCreated(msg) => {
1666 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1668 wire::Message::FundingSigned(msg) => {
1669 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1671 wire::Message::ChannelReady(msg) => {
1672 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1675 // Quiescence messages:
1676 wire::Message::Stfu(msg) => {
1677 self.message_handler.chan_handler.handle_stfu(&their_node_id, &msg);
1680 // Splicing messages:
1681 wire::Message::Splice(msg) => {
1682 self.message_handler.chan_handler.handle_splice(&their_node_id, &msg);
1684 wire::Message::SpliceAck(msg) => {
1685 self.message_handler.chan_handler.handle_splice_ack(&their_node_id, &msg);
1687 wire::Message::SpliceLocked(msg) => {
1688 self.message_handler.chan_handler.handle_splice_locked(&their_node_id, &msg);
1691 // Interactive transaction construction messages:
1692 wire::Message::TxAddInput(msg) => {
1693 self.message_handler.chan_handler.handle_tx_add_input(&their_node_id, &msg);
1695 wire::Message::TxAddOutput(msg) => {
1696 self.message_handler.chan_handler.handle_tx_add_output(&their_node_id, &msg);
1698 wire::Message::TxRemoveInput(msg) => {
1699 self.message_handler.chan_handler.handle_tx_remove_input(&their_node_id, &msg);
1701 wire::Message::TxRemoveOutput(msg) => {
1702 self.message_handler.chan_handler.handle_tx_remove_output(&their_node_id, &msg);
1704 wire::Message::TxComplete(msg) => {
1705 self.message_handler.chan_handler.handle_tx_complete(&their_node_id, &msg);
1707 wire::Message::TxSignatures(msg) => {
1708 self.message_handler.chan_handler.handle_tx_signatures(&their_node_id, &msg);
1710 wire::Message::TxInitRbf(msg) => {
1711 self.message_handler.chan_handler.handle_tx_init_rbf(&their_node_id, &msg);
1713 wire::Message::TxAckRbf(msg) => {
1714 self.message_handler.chan_handler.handle_tx_ack_rbf(&their_node_id, &msg);
1716 wire::Message::TxAbort(msg) => {
1717 self.message_handler.chan_handler.handle_tx_abort(&their_node_id, &msg);
1720 wire::Message::Shutdown(msg) => {
1721 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1723 wire::Message::ClosingSigned(msg) => {
1724 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1727 // Commitment messages:
1728 wire::Message::UpdateAddHTLC(msg) => {
1729 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1731 wire::Message::UpdateFulfillHTLC(msg) => {
1732 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1734 wire::Message::UpdateFailHTLC(msg) => {
1735 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1737 wire::Message::UpdateFailMalformedHTLC(msg) => {
1738 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1741 wire::Message::CommitmentSigned(msg) => {
1742 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1744 wire::Message::RevokeAndACK(msg) => {
1745 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1747 wire::Message::UpdateFee(msg) => {
1748 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1750 wire::Message::ChannelReestablish(msg) => {
1751 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1754 // Routing messages:
1755 wire::Message::AnnouncementSignatures(msg) => {
1756 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1758 wire::Message::ChannelAnnouncement(msg) => {
1759 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1760 .map_err(|e| -> MessageHandlingError { e.into() })? {
1761 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1763 self.update_gossip_backlogged();
1765 wire::Message::NodeAnnouncement(msg) => {
1766 if self.message_handler.route_handler.handle_node_announcement(&msg)
1767 .map_err(|e| -> MessageHandlingError { e.into() })? {
1768 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1770 self.update_gossip_backlogged();
1772 wire::Message::ChannelUpdate(msg) => {
1773 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1774 if self.message_handler.route_handler.handle_channel_update(&msg)
1775 .map_err(|e| -> MessageHandlingError { e.into() })? {
1776 should_forward = Some(wire::Message::ChannelUpdate(msg));
1778 self.update_gossip_backlogged();
1780 wire::Message::QueryShortChannelIds(msg) => {
1781 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1783 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1784 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1786 wire::Message::QueryChannelRange(msg) => {
1787 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1789 wire::Message::ReplyChannelRange(msg) => {
1790 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1794 wire::Message::OnionMessage(msg) => {
1795 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1798 // Unknown messages:
1799 wire::Message::Unknown(type_id) if message.is_even() => {
1800 log_debug!(logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1801 return Err(PeerHandleError { }.into());
1803 wire::Message::Unknown(type_id) => {
1804 log_trace!(logger, "Received unknown odd message of type {}, ignoring", type_id);
1806 wire::Message::Custom(custom) => {
1807 self.message_handler.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1813 fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1815 wire::Message::ChannelAnnouncement(ref msg) => {
1816 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1817 let encoded_msg = encode_msg!(msg);
1819 for (_, peer_mutex) in peers.iter() {
1820 let mut peer = peer_mutex.lock().unwrap();
1821 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1822 if !peer.handshake_complete() ||
1823 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1826 debug_assert!(peer.their_node_id.is_some());
1827 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1828 if peer.buffer_full_drop_gossip_broadcast() {
1829 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1832 if let Some((_, their_node_id)) = peer.their_node_id {
1833 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1837 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1840 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1843 wire::Message::NodeAnnouncement(ref msg) => {
1844 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1845 let encoded_msg = encode_msg!(msg);
1847 for (_, peer_mutex) in peers.iter() {
1848 let mut peer = peer_mutex.lock().unwrap();
1849 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1850 if !peer.handshake_complete() ||
1851 !peer.should_forward_node_announcement(msg.contents.node_id) {
1854 debug_assert!(peer.their_node_id.is_some());
1855 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1856 if peer.buffer_full_drop_gossip_broadcast() {
1857 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1860 if let Some((_, their_node_id)) = peer.their_node_id {
1861 if their_node_id == msg.contents.node_id {
1865 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1868 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1871 wire::Message::ChannelUpdate(ref msg) => {
1872 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1873 let encoded_msg = encode_msg!(msg);
1875 for (_, peer_mutex) in peers.iter() {
1876 let mut peer = peer_mutex.lock().unwrap();
1877 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1878 if !peer.handshake_complete() ||
1879 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1882 debug_assert!(peer.their_node_id.is_some());
1883 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1884 if peer.buffer_full_drop_gossip_broadcast() {
1885 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1888 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1891 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1894 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1898 /// Checks for any events generated by our handlers and processes them. Includes sending most
1899 /// response messages as well as messages generated by calls to handler functions directly (eg
1900 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1902 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1905 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1906 /// or one of the other clients provided in our language bindings.
1908 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1909 /// without doing any work. All available events that need handling will be handled before the
1910 /// other calls return.
1912 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1913 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1914 /// [`send_data`]: SocketDescriptor::send_data
1915 pub fn process_events(&self) {
1916 if self.event_processing_state.fetch_add(1, Ordering::AcqRel) > 0 {
1917 // If we're not the first event processor to get here, just return early, the increment
1918 // we just did will be treated as "go around again" at the end.
1923 self.update_gossip_backlogged();
1924 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1926 let mut peers_to_disconnect = HashMap::new();
1929 let peers_lock = self.peers.read().unwrap();
1931 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1932 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1934 let peers = &*peers_lock;
1935 macro_rules! get_peer_for_forwarding {
1936 ($node_id: expr) => {
1938 if peers_to_disconnect.get($node_id).is_some() {
1939 // If we've "disconnected" this peer, do not send to it.
1942 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1943 match descriptor_opt {
1944 Some(descriptor) => match peers.get(&descriptor) {
1945 Some(peer_mutex) => {
1946 let peer_lock = peer_mutex.lock().unwrap();
1947 if !peer_lock.handshake_complete() {
1953 debug_assert!(false, "Inconsistent peers set state!");
1964 for event in events_generated.drain(..) {
1966 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1967 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1968 log_pubkey!(node_id),
1969 &msg.temporary_channel_id);
1970 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1972 MessageSendEvent::SendAcceptChannelV2 { ref node_id, ref msg } => {
1973 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendAcceptChannelV2 event in peer_handler for node {} for channel {}",
1974 log_pubkey!(node_id),
1975 &msg.temporary_channel_id);
1976 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1978 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1979 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1980 log_pubkey!(node_id),
1981 &msg.temporary_channel_id);
1982 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1984 MessageSendEvent::SendOpenChannelV2 { ref node_id, ref msg } => {
1985 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendOpenChannelV2 event in peer_handler for node {} for channel {}",
1986 log_pubkey!(node_id),
1987 &msg.temporary_channel_id);
1988 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1990 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1991 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1992 log_pubkey!(node_id),
1993 &msg.temporary_channel_id,
1994 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1995 // TODO: If the peer is gone we should generate a DiscardFunding event
1996 // indicating to the wallet that they should just throw away this funding transaction
1997 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1999 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
2000 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
2001 log_pubkey!(node_id),
2003 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2005 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
2006 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReady event in peer_handler for node {} for channel {}",
2007 log_pubkey!(node_id),
2009 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2011 MessageSendEvent::SendStfu { ref node_id, ref msg} => {
2012 log_debug!(self.logger, "Handling SendStfu event in peer_handler for node {} for channel {}",
2013 log_pubkey!(node_id),
2015 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2017 MessageSendEvent::SendSplice { ref node_id, ref msg} => {
2018 log_debug!(self.logger, "Handling SendSplice event in peer_handler for node {} for channel {}",
2019 log_pubkey!(node_id),
2021 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2023 MessageSendEvent::SendSpliceAck { ref node_id, ref msg} => {
2024 log_debug!(self.logger, "Handling SendSpliceAck event in peer_handler for node {} for channel {}",
2025 log_pubkey!(node_id),
2027 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2029 MessageSendEvent::SendSpliceLocked { ref node_id, ref msg} => {
2030 log_debug!(self.logger, "Handling SendSpliceLocked event in peer_handler for node {} for channel {}",
2031 log_pubkey!(node_id),
2033 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2035 MessageSendEvent::SendTxAddInput { ref node_id, ref msg } => {
2036 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddInput event in peer_handler for node {} for channel {}",
2037 log_pubkey!(node_id),
2039 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2041 MessageSendEvent::SendTxAddOutput { ref node_id, ref msg } => {
2042 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddOutput event in peer_handler for node {} for channel {}",
2043 log_pubkey!(node_id),
2045 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2047 MessageSendEvent::SendTxRemoveInput { ref node_id, ref msg } => {
2048 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveInput event in peer_handler for node {} for channel {}",
2049 log_pubkey!(node_id),
2051 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2053 MessageSendEvent::SendTxRemoveOutput { ref node_id, ref msg } => {
2054 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveOutput event in peer_handler for node {} for channel {}",
2055 log_pubkey!(node_id),
2057 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2059 MessageSendEvent::SendTxComplete { ref node_id, ref msg } => {
2060 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxComplete event in peer_handler for node {} for channel {}",
2061 log_pubkey!(node_id),
2063 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2065 MessageSendEvent::SendTxSignatures { ref node_id, ref msg } => {
2066 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxSignatures event in peer_handler for node {} for channel {}",
2067 log_pubkey!(node_id),
2069 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2071 MessageSendEvent::SendTxInitRbf { ref node_id, ref msg } => {
2072 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxInitRbf event in peer_handler for node {} for channel {}",
2073 log_pubkey!(node_id),
2075 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2077 MessageSendEvent::SendTxAckRbf { ref node_id, ref msg } => {
2078 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAckRbf event in peer_handler for node {} for channel {}",
2079 log_pubkey!(node_id),
2081 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2083 MessageSendEvent::SendTxAbort { ref node_id, ref msg } => {
2084 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAbort event in peer_handler for node {} for channel {}",
2085 log_pubkey!(node_id),
2087 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2089 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
2090 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
2091 log_pubkey!(node_id),
2093 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2095 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 } } => {
2096 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(commitment_signed.channel_id)), "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
2097 log_pubkey!(node_id),
2098 update_add_htlcs.len(),
2099 update_fulfill_htlcs.len(),
2100 update_fail_htlcs.len(),
2101 &commitment_signed.channel_id);
2102 let mut peer = get_peer_for_forwarding!(node_id);
2103 for msg in update_add_htlcs {
2104 self.enqueue_message(&mut *peer, msg);
2106 for msg in update_fulfill_htlcs {
2107 self.enqueue_message(&mut *peer, msg);
2109 for msg in update_fail_htlcs {
2110 self.enqueue_message(&mut *peer, msg);
2112 for msg in update_fail_malformed_htlcs {
2113 self.enqueue_message(&mut *peer, msg);
2115 if let &Some(ref msg) = update_fee {
2116 self.enqueue_message(&mut *peer, msg);
2118 self.enqueue_message(&mut *peer, commitment_signed);
2120 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2121 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
2122 log_pubkey!(node_id),
2124 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2126 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
2127 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
2128 log_pubkey!(node_id),
2130 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2132 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
2133 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling Shutdown event in peer_handler for node {} for channel {}",
2134 log_pubkey!(node_id),
2136 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2138 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
2139 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
2140 log_pubkey!(node_id),
2142 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2144 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
2145 log_debug!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
2146 log_pubkey!(node_id),
2147 msg.contents.short_channel_id);
2148 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2149 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
2151 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
2152 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
2153 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
2154 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2155 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
2158 if let Some(msg) = update_msg {
2159 match self.message_handler.route_handler.handle_channel_update(&msg) {
2160 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2161 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2166 MessageSendEvent::BroadcastChannelUpdate { msg } => {
2167 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for contents {:?}", msg.contents);
2168 match self.message_handler.route_handler.handle_channel_update(&msg) {
2169 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2170 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2174 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
2175 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
2176 match self.message_handler.route_handler.handle_node_announcement(&msg) {
2177 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2178 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
2182 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
2183 log_trace!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
2184 log_pubkey!(node_id), msg.contents.short_channel_id);
2185 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2187 MessageSendEvent::HandleError { node_id, action } => {
2188 let logger = WithContext::from(&self.logger, Some(node_id), None);
2190 msgs::ErrorAction::DisconnectPeer { msg } => {
2191 if let Some(msg) = msg.as_ref() {
2192 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2193 log_pubkey!(node_id), msg.data);
2195 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {}",
2196 log_pubkey!(node_id));
2198 // We do not have the peers write lock, so we just store that we're
2199 // about to disconenct the peer and do it after we finish
2200 // processing most messages.
2201 let msg = msg.map(|msg| wire::Message::<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>::Error(msg));
2202 peers_to_disconnect.insert(node_id, msg);
2204 msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
2205 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2206 log_pubkey!(node_id), msg.data);
2207 // We do not have the peers write lock, so we just store that we're
2208 // about to disconenct the peer and do it after we finish
2209 // processing most messages.
2210 peers_to_disconnect.insert(node_id, Some(wire::Message::Warning(msg)));
2212 msgs::ErrorAction::IgnoreAndLog(level) => {
2213 log_given_level!(logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2215 msgs::ErrorAction::IgnoreDuplicateGossip => {},
2216 msgs::ErrorAction::IgnoreError => {
2217 log_debug!(logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2219 msgs::ErrorAction::SendErrorMessage { ref msg } => {
2220 log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
2221 log_pubkey!(node_id),
2223 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2225 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
2226 log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
2227 log_pubkey!(node_id),
2229 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2233 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
2234 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2236 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
2237 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2239 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
2240 log_gossip!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
2241 log_pubkey!(node_id),
2242 msg.short_channel_ids.len(),
2244 msg.number_of_blocks,
2246 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2248 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
2249 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2254 for (node_id, msg) in self.message_handler.custom_message_handler.get_and_clear_pending_msg() {
2255 if peers_to_disconnect.get(&node_id).is_some() { continue; }
2256 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
2259 for (descriptor, peer_mutex) in peers.iter() {
2260 let mut peer = peer_mutex.lock().unwrap();
2261 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2262 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
2265 if !peers_to_disconnect.is_empty() {
2266 let mut peers_lock = self.peers.write().unwrap();
2267 let peers = &mut *peers_lock;
2268 for (node_id, msg) in peers_to_disconnect.drain() {
2269 // Note that since we are holding the peers *write* lock we can
2270 // remove from node_id_to_descriptor immediately (as no other
2271 // thread can be holding the peer lock if we have the global write
2274 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2275 if let Some(mut descriptor) = descriptor_opt {
2276 if let Some(peer_mutex) = peers.remove(&descriptor) {
2277 let mut peer = peer_mutex.lock().unwrap();
2278 if let Some(msg) = msg {
2279 self.enqueue_message(&mut *peer, &msg);
2280 // This isn't guaranteed to work, but if there is enough free
2281 // room in the send buffer, put the error message there...
2282 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
2284 self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
2285 } else { debug_assert!(false, "Missing connection for peer"); }
2290 if self.event_processing_state.fetch_sub(1, Ordering::AcqRel) != 1 {
2291 // If another thread incremented the state while we were running we should go
2292 // around again, but only once.
2293 self.event_processing_state.store(1, Ordering::Release);
2300 /// Indicates that the given socket descriptor's connection is now closed.
2301 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
2302 self.disconnect_event_internal(descriptor);
2305 fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
2306 if !peer.handshake_complete() {
2307 log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
2308 descriptor.disconnect_socket();
2312 debug_assert!(peer.their_node_id.is_some());
2313 if let Some((node_id, _)) = peer.their_node_id {
2314 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Disconnecting peer with id {} due to {}", node_id, reason);
2315 self.message_handler.chan_handler.peer_disconnected(&node_id);
2316 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2318 descriptor.disconnect_socket();
2321 fn disconnect_event_internal(&self, descriptor: &Descriptor) {
2322 let mut peers = self.peers.write().unwrap();
2323 let peer_option = peers.remove(descriptor);
2326 // This is most likely a simple race condition where the user found that the socket
2327 // was disconnected, then we told the user to `disconnect_socket()`, then they
2328 // called this method. Either way we're disconnected, return.
2330 Some(peer_lock) => {
2331 let peer = peer_lock.lock().unwrap();
2332 if let Some((node_id, _)) = peer.their_node_id {
2333 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Handling disconnection of peer {}", log_pubkey!(node_id));
2334 let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2335 debug_assert!(removed.is_some(), "descriptor maps should be consistent");
2336 if !peer.handshake_complete() { return; }
2337 self.message_handler.chan_handler.peer_disconnected(&node_id);
2338 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2344 /// Disconnect a peer given its node id.
2346 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
2347 /// peer. Thus, be very careful about reentrancy issues.
2349 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
2350 pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
2351 let mut peers_lock = self.peers.write().unwrap();
2352 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
2353 let peer_opt = peers_lock.remove(&descriptor);
2354 if let Some(peer_mutex) = peer_opt {
2355 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
2356 } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
2360 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
2361 /// an indication that TCP sockets have stalled even if we weren't around to time them out
2362 /// using regular ping/pongs.
2363 pub fn disconnect_all_peers(&self) {
2364 let mut peers_lock = self.peers.write().unwrap();
2365 self.node_id_to_descriptor.lock().unwrap().clear();
2366 let peers = &mut *peers_lock;
2367 for (descriptor, peer_mutex) in peers.drain() {
2368 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2372 /// This is called when we're blocked on sending additional gossip messages until we receive a
2373 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2374 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2375 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2376 if peer.awaiting_pong_timer_tick_intervals == 0 {
2377 peer.awaiting_pong_timer_tick_intervals = -1;
2378 let ping = msgs::Ping {
2382 self.enqueue_message(peer, &ping);
2386 /// Send pings to each peer and disconnect those which did not respond to the last round of
2389 /// This may be called on any timescale you want, however, roughly once every ten seconds is
2390 /// preferred. The call rate determines both how often we send a ping to our peers and how much
2391 /// time they have to respond before we disconnect them.
2393 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2396 /// [`send_data`]: SocketDescriptor::send_data
2397 pub fn timer_tick_occurred(&self) {
2398 let mut descriptors_needing_disconnect = Vec::new();
2400 let peers_lock = self.peers.read().unwrap();
2402 self.update_gossip_backlogged();
2403 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2405 for (descriptor, peer_mutex) in peers_lock.iter() {
2406 let mut peer = peer_mutex.lock().unwrap();
2407 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2409 if !peer.handshake_complete() {
2410 // The peer needs to complete its handshake before we can exchange messages. We
2411 // give peers one timer tick to complete handshake, reusing
2412 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2413 // for handshake completion.
2414 if peer.awaiting_pong_timer_tick_intervals != 0 {
2415 descriptors_needing_disconnect.push(descriptor.clone());
2417 peer.awaiting_pong_timer_tick_intervals = 1;
2421 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2422 debug_assert!(peer.their_node_id.is_some());
2424 loop { // Used as a `goto` to skip writing a Ping message.
2425 if peer.awaiting_pong_timer_tick_intervals == -1 {
2426 // Magic value set in `maybe_send_extra_ping`.
2427 peer.awaiting_pong_timer_tick_intervals = 1;
2428 peer.received_message_since_timer_tick = false;
2432 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2433 || peer.awaiting_pong_timer_tick_intervals as u64 >
2434 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2436 descriptors_needing_disconnect.push(descriptor.clone());
2439 peer.received_message_since_timer_tick = false;
2441 if peer.awaiting_pong_timer_tick_intervals > 0 {
2442 peer.awaiting_pong_timer_tick_intervals += 1;
2446 peer.awaiting_pong_timer_tick_intervals = 1;
2447 let ping = msgs::Ping {
2451 self.enqueue_message(&mut *peer, &ping);
2454 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2458 if !descriptors_needing_disconnect.is_empty() {
2460 let mut peers_lock = self.peers.write().unwrap();
2461 for descriptor in descriptors_needing_disconnect {
2462 if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2463 let peer = peer_mutex.lock().unwrap();
2464 if let Some((node_id, _)) = peer.their_node_id {
2465 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2467 self.do_disconnect(descriptor, &*peer, "ping/handshake timeout");
2475 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2476 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2477 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2479 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (SocketAddress::MAX_LEN as u32 + 1) / 2;
2482 // ...by failing to compile if the number of addresses that would be half of a message is
2483 // smaller than 100:
2484 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2486 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2487 /// peers. Note that peers will likely ignore this message unless we have at least one public
2488 /// channel which has at least six confirmations on-chain.
2490 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2491 /// node to humans. They carry no in-protocol meaning.
2493 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2494 /// accepts incoming connections. These will be included in the node_announcement, publicly
2495 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2496 /// addresses should likely contain only Tor Onion addresses.
2498 /// Panics if `addresses` is absurdly large (more than 100).
2500 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2501 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<SocketAddress>) {
2502 if addresses.len() > 100 {
2503 panic!("More than half the message size was taken up by public addresses!");
2506 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2507 // addresses be sorted for future compatibility.
2508 addresses.sort_by_key(|addr| addr.get_id());
2510 let features = self.message_handler.chan_handler.provided_node_features()
2511 | self.message_handler.route_handler.provided_node_features()
2512 | self.message_handler.onion_message_handler.provided_node_features()
2513 | self.message_handler.custom_message_handler.provided_node_features();
2514 let announcement = msgs::UnsignedNodeAnnouncement {
2516 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2517 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2519 alias: NodeAlias(alias),
2521 excess_address_data: Vec::new(),
2522 excess_data: Vec::new(),
2524 let node_announce_sig = match self.node_signer.sign_gossip_message(
2525 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2529 log_error!(self.logger, "Failed to generate signature for node_announcement");
2534 let msg = msgs::NodeAnnouncement {
2535 signature: node_announce_sig,
2536 contents: announcement
2539 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2540 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2541 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2545 fn is_gossip_msg(type_id: u16) -> bool {
2547 msgs::ChannelAnnouncement::TYPE |
2548 msgs::ChannelUpdate::TYPE |
2549 msgs::NodeAnnouncement::TYPE |
2550 msgs::QueryChannelRange::TYPE |
2551 msgs::ReplyChannelRange::TYPE |
2552 msgs::QueryShortChannelIds::TYPE |
2553 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2560 use crate::sign::{NodeSigner, Recipient};
2563 use crate::ln::ChannelId;
2564 use crate::ln::features::{InitFeatures, NodeFeatures};
2565 use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2566 use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2567 use crate::ln::{msgs, wire};
2568 use crate::ln::msgs::{LightningError, SocketAddress};
2569 use crate::util::test_utils;
2571 use bitcoin::Network;
2572 use bitcoin::blockdata::constants::ChainHash;
2573 use bitcoin::secp256k1::{PublicKey, SecretKey};
2575 use crate::prelude::*;
2576 use crate::sync::{Arc, Mutex};
2577 use core::convert::Infallible;
2578 use core::sync::atomic::{AtomicBool, Ordering};
2581 struct FileDescriptor {
2583 outbound_data: Arc<Mutex<Vec<u8>>>,
2584 disconnect: Arc<AtomicBool>,
2586 impl PartialEq for FileDescriptor {
2587 fn eq(&self, other: &Self) -> bool {
2591 impl Eq for FileDescriptor { }
2592 impl core::hash::Hash for FileDescriptor {
2593 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2594 self.fd.hash(hasher)
2598 impl SocketDescriptor for FileDescriptor {
2599 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2600 self.outbound_data.lock().unwrap().extend_from_slice(data);
2604 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2607 struct PeerManagerCfg {
2608 chan_handler: test_utils::TestChannelMessageHandler,
2609 routing_handler: test_utils::TestRoutingMessageHandler,
2610 custom_handler: TestCustomMessageHandler,
2611 logger: test_utils::TestLogger,
2612 node_signer: test_utils::TestNodeSigner,
2615 struct TestCustomMessageHandler {
2616 features: InitFeatures,
2619 impl wire::CustomMessageReader for TestCustomMessageHandler {
2620 type CustomMessage = Infallible;
2621 fn read<R: io::Read>(&self, _: u16, _: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
2626 impl CustomMessageHandler for TestCustomMessageHandler {
2627 fn handle_custom_message(&self, _: Infallible, _: &PublicKey) -> Result<(), LightningError> {
2631 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
2633 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
2635 fn provided_init_features(&self, _: &PublicKey) -> InitFeatures {
2636 self.features.clone()
2640 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2641 let mut cfgs = Vec::new();
2642 for i in 0..peer_count {
2643 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2645 let mut feature_bits = vec![0u8; 33];
2646 feature_bits[32] = 0b00000001;
2647 InitFeatures::from_le_bytes(feature_bits)
2651 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2652 logger: test_utils::TestLogger::new(),
2653 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2654 custom_handler: TestCustomMessageHandler { features },
2655 node_signer: test_utils::TestNodeSigner::new(node_secret),
2663 fn create_feature_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2664 let mut cfgs = Vec::new();
2665 for i in 0..peer_count {
2666 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2668 let mut feature_bits = vec![0u8; 33 + i + 1];
2669 feature_bits[33 + i] = 0b00000001;
2670 InitFeatures::from_le_bytes(feature_bits)
2674 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2675 logger: test_utils::TestLogger::new(),
2676 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2677 custom_handler: TestCustomMessageHandler { features },
2678 node_signer: test_utils::TestNodeSigner::new(node_secret),
2686 fn create_chain_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2687 let mut cfgs = Vec::new();
2688 for i in 0..peer_count {
2689 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2690 let features = InitFeatures::from_le_bytes(vec![0u8; 33]);
2691 let network = ChainHash::from(&[i as u8; 32]);
2694 chan_handler: test_utils::TestChannelMessageHandler::new(network),
2695 logger: test_utils::TestLogger::new(),
2696 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2697 custom_handler: TestCustomMessageHandler { features },
2698 node_signer: test_utils::TestNodeSigner::new(node_secret),
2706 fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>> {
2707 let mut peers = Vec::new();
2708 for i in 0..peer_count {
2709 let ephemeral_bytes = [i as u8; 32];
2710 let msg_handler = MessageHandler {
2711 chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler,
2712 onion_message_handler: IgnoringMessageHandler {}, custom_message_handler: &cfgs[i].custom_handler
2714 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, &cfgs[i].node_signer);
2721 fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, IgnoringMessageHandler, &'a test_utils::TestLogger, &'a TestCustomMessageHandler, &'a test_utils::TestNodeSigner>) -> (FileDescriptor, FileDescriptor) {
2722 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2723 let mut fd_a = FileDescriptor {
2724 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2725 disconnect: Arc::new(AtomicBool::new(false)),
2727 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2728 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2729 let mut fd_b = FileDescriptor {
2730 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2731 disconnect: Arc::new(AtomicBool::new(false)),
2733 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2734 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2735 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2736 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2737 peer_a.process_events();
2739 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2740 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2742 peer_b.process_events();
2743 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2744 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2746 peer_a.process_events();
2747 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2748 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2750 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
2751 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));
2753 (fd_a.clone(), fd_b.clone())
2757 #[cfg(feature = "std")]
2758 fn fuzz_threaded_connections() {
2759 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2760 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2761 // with our internal map consistency, and is a generally good smoke test of disconnection.
2762 let cfgs = Arc::new(create_peermgr_cfgs(2));
2763 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2764 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2766 let start_time = std::time::Instant::now();
2767 macro_rules! spawn_thread { ($id: expr) => { {
2768 let peers = Arc::clone(&peers);
2769 let cfgs = Arc::clone(&cfgs);
2770 std::thread::spawn(move || {
2772 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2773 let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2774 let mut fd_a = FileDescriptor {
2775 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2776 disconnect: Arc::new(AtomicBool::new(false)),
2778 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2779 let mut fd_b = FileDescriptor {
2780 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2781 disconnect: Arc::new(AtomicBool::new(false)),
2783 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2784 let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2785 peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2786 if peers[0].read_event(&mut fd_a, &initial_data).is_err() { break; }
2788 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2789 peers[0].process_events();
2790 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2791 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2792 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2794 peers[1].process_events();
2795 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2796 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2797 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2799 cfgs[0].chan_handler.pending_events.lock().unwrap()
2800 .push(crate::events::MessageSendEvent::SendShutdown {
2801 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2802 msg: msgs::Shutdown {
2803 channel_id: ChannelId::new_zero(),
2804 scriptpubkey: bitcoin::ScriptBuf::new(),
2807 cfgs[1].chan_handler.pending_events.lock().unwrap()
2808 .push(crate::events::MessageSendEvent::SendShutdown {
2809 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2810 msg: msgs::Shutdown {
2811 channel_id: ChannelId::new_zero(),
2812 scriptpubkey: bitcoin::ScriptBuf::new(),
2817 peers[0].timer_tick_occurred();
2818 peers[1].timer_tick_occurred();
2822 peers[0].socket_disconnected(&fd_a);
2823 peers[1].socket_disconnected(&fd_b);
2825 std::thread::sleep(std::time::Duration::from_micros(1));
2829 let thrd_a = spawn_thread!(1);
2830 let thrd_b = spawn_thread!(2);
2832 thrd_a.join().unwrap();
2833 thrd_b.join().unwrap();
2837 fn test_feature_incompatible_peers() {
2838 let cfgs = create_peermgr_cfgs(2);
2839 let incompatible_cfgs = create_feature_incompatible_peermgr_cfgs(2);
2841 let peers = create_network(2, &cfgs);
2842 let incompatible_peers = create_network(2, &incompatible_cfgs);
2843 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2844 for (peer_a, peer_b) in peer_pairs.iter() {
2845 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2846 let mut fd_a = FileDescriptor {
2847 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2848 disconnect: Arc::new(AtomicBool::new(false)),
2850 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2851 let mut fd_b = FileDescriptor {
2852 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2853 disconnect: Arc::new(AtomicBool::new(false)),
2855 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2856 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2857 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2858 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2859 peer_a.process_events();
2861 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2862 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2864 peer_b.process_events();
2865 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2867 // Should fail because of unknown required features
2868 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2873 fn test_chain_incompatible_peers() {
2874 let cfgs = create_peermgr_cfgs(2);
2875 let incompatible_cfgs = create_chain_incompatible_peermgr_cfgs(2);
2877 let peers = create_network(2, &cfgs);
2878 let incompatible_peers = create_network(2, &incompatible_cfgs);
2879 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2880 for (peer_a, peer_b) in peer_pairs.iter() {
2881 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2882 let mut fd_a = FileDescriptor {
2883 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2884 disconnect: Arc::new(AtomicBool::new(false)),
2886 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2887 let mut fd_b = FileDescriptor {
2888 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2889 disconnect: Arc::new(AtomicBool::new(false)),
2891 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2892 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2893 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2894 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2895 peer_a.process_events();
2897 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2898 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2900 peer_b.process_events();
2901 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2903 // Should fail because of incompatible chains
2904 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2909 fn test_disconnect_peer() {
2910 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2911 // push a DisconnectPeer event to remove the node flagged by id
2912 let cfgs = create_peermgr_cfgs(2);
2913 let peers = create_network(2, &cfgs);
2914 establish_connection(&peers[0], &peers[1]);
2915 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2917 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2918 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2920 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2923 peers[0].process_events();
2924 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2928 fn test_send_simple_msg() {
2929 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2930 // push a message from one peer to another.
2931 let cfgs = create_peermgr_cfgs(2);
2932 let a_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2933 let b_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2934 let mut peers = create_network(2, &cfgs);
2935 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2936 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2938 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2940 let msg = msgs::Shutdown { channel_id: ChannelId::from_bytes([42; 32]), scriptpubkey: bitcoin::ScriptBuf::new() };
2941 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2942 node_id: their_id, msg: msg.clone()
2944 peers[0].message_handler.chan_handler = &a_chan_handler;
2946 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2947 peers[1].message_handler.chan_handler = &b_chan_handler;
2949 peers[0].process_events();
2951 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2952 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2956 fn test_non_init_first_msg() {
2957 // Simple test of the first message received over a connection being something other than
2958 // Init. This results in an immediate disconnection, which previously included a spurious
2959 // peer_disconnected event handed to event handlers (which would panic in
2960 // `TestChannelMessageHandler` here).
2961 let cfgs = create_peermgr_cfgs(2);
2962 let peers = create_network(2, &cfgs);
2964 let mut fd_dup = FileDescriptor {
2965 fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2966 disconnect: Arc::new(AtomicBool::new(false)),
2968 let addr_dup = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1003};
2969 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
2970 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
2972 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
2973 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
2974 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
2975 peers[0].process_events();
2977 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
2978 let (act_three, _) =
2979 dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
2980 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
2982 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
2983 let msg_bytes = dup_encryptor.encrypt_message(¬_init_msg);
2984 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
2988 fn test_disconnect_all_peer() {
2989 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2990 // then calls disconnect_all_peers
2991 let cfgs = create_peermgr_cfgs(2);
2992 let peers = create_network(2, &cfgs);
2993 establish_connection(&peers[0], &peers[1]);
2994 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2996 peers[0].disconnect_all_peers();
2997 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3001 fn test_timer_tick_occurred() {
3002 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
3003 let cfgs = create_peermgr_cfgs(2);
3004 let peers = create_network(2, &cfgs);
3005 establish_connection(&peers[0], &peers[1]);
3006 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3008 // peers[0] awaiting_pong is set to true, but the Peer is still connected
3009 peers[0].timer_tick_occurred();
3010 peers[0].process_events();
3011 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3013 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
3014 peers[0].timer_tick_occurred();
3015 peers[0].process_events();
3016 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3020 fn test_do_attempt_write_data() {
3021 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
3022 let cfgs = create_peermgr_cfgs(2);
3023 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3024 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3025 let peers = create_network(2, &cfgs);
3027 // By calling establish_connect, we trigger do_attempt_write_data between
3028 // the peers. Previously this function would mistakenly enter an infinite loop
3029 // when there were more channel messages available than could fit into a peer's
3030 // buffer. This issue would now be detected by this test (because we use custom
3031 // RoutingMessageHandlers that intentionally return more channel messages
3032 // than can fit into a peer's buffer).
3033 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
3035 // Make each peer to read the messages that the other peer just wrote to them. Note that
3036 // due to the max-message-before-ping limits this may take a few iterations to complete.
3037 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
3038 peers[1].process_events();
3039 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3040 assert!(!a_read_data.is_empty());
3042 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
3043 peers[0].process_events();
3045 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3046 assert!(!b_read_data.is_empty());
3047 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
3049 peers[0].process_events();
3050 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
3053 // Check that each peer has received the expected number of channel updates and channel
3055 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3056 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3057 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3058 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3062 fn test_handshake_timeout() {
3063 // Tests that we time out a peer still waiting on handshake completion after a full timer
3065 let cfgs = create_peermgr_cfgs(2);
3066 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3067 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3068 let peers = create_network(2, &cfgs);
3070 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
3071 let mut fd_a = FileDescriptor {
3072 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3073 disconnect: Arc::new(AtomicBool::new(false)),
3075 let mut fd_b = FileDescriptor {
3076 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3077 disconnect: Arc::new(AtomicBool::new(false)),
3079 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
3080 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
3082 // If we get a single timer tick before completion, that's fine
3083 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3084 peers[0].timer_tick_occurred();
3085 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3087 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
3088 peers[0].process_events();
3089 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3090 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
3091 peers[1].process_events();
3093 // ...but if we get a second timer tick, we should disconnect the peer
3094 peers[0].timer_tick_occurred();
3095 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3097 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3098 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
3102 fn test_filter_addresses(){
3103 // Tests the filter_addresses function.
3106 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 0, 0], port: 1000};
3107 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3108 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 255, 201], port: 1000};
3109 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3110 let ip_address = SocketAddress::TcpIpV4{addr: [10, 255, 255, 255], port: 1000};
3111 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3114 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 0, 0], port: 1000};
3115 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3116 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 255, 187], port: 1000};
3117 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3118 let ip_address = SocketAddress::TcpIpV4{addr: [0, 255, 255, 255], port: 1000};
3119 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3122 let ip_address = SocketAddress::TcpIpV4{addr: [100, 64, 0, 0], port: 1000};
3123 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3124 let ip_address = SocketAddress::TcpIpV4{addr: [100, 78, 255, 0], port: 1000};
3125 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3126 let ip_address = SocketAddress::TcpIpV4{addr: [100, 127, 255, 255], port: 1000};
3127 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3130 let ip_address = SocketAddress::TcpIpV4{addr: [127, 0, 0, 0], port: 1000};
3131 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3132 let ip_address = SocketAddress::TcpIpV4{addr: [127, 65, 73, 0], port: 1000};
3133 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3134 let ip_address = SocketAddress::TcpIpV4{addr: [127, 255, 255, 255], port: 1000};
3135 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3138 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 0, 0], port: 1000};
3139 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3140 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 221, 101], port: 1000};
3141 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3142 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 255, 255], port: 1000};
3143 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3146 let ip_address = SocketAddress::TcpIpV4{addr: [172, 16, 0, 0], port: 1000};
3147 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3148 let ip_address = SocketAddress::TcpIpV4{addr: [172, 27, 101, 23], port: 1000};
3149 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3150 let ip_address = SocketAddress::TcpIpV4{addr: [172, 31, 255, 255], port: 1000};
3151 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3154 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 0, 0], port: 1000};
3155 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3156 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 205, 159], port: 1000};
3157 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3158 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 255, 255], port: 1000};
3159 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3161 // For (192.88.99/24)
3162 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 0], port: 1000};
3163 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3164 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 140], port: 1000};
3165 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3166 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 255], port: 1000};
3167 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3169 // For other IPv4 addresses
3170 let ip_address = SocketAddress::TcpIpV4{addr: [188, 255, 99, 0], port: 1000};
3171 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3172 let ip_address = SocketAddress::TcpIpV4{addr: [123, 8, 129, 14], port: 1000};
3173 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3174 let ip_address = SocketAddress::TcpIpV4{addr: [2, 88, 9, 255], port: 1000};
3175 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3178 let ip_address = SocketAddress::TcpIpV6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
3179 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3180 let ip_address = SocketAddress::TcpIpV6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
3181 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3182 let ip_address = SocketAddress::TcpIpV6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
3183 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3185 // For other IPv6 addresses
3186 let ip_address = SocketAddress::TcpIpV6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
3187 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3188 let ip_address = SocketAddress::TcpIpV6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
3189 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3190 let ip_address = SocketAddress::TcpIpV6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
3191 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3194 assert_eq!(filter_addresses(None), None);
3198 #[cfg(feature = "std")]
3199 fn test_process_events_multithreaded() {
3200 use std::time::{Duration, Instant};
3201 // Test that `process_events` getting called on multiple threads doesn't generate too many
3203 // Each time `process_events` goes around the loop we call
3204 // `get_and_clear_pending_msg_events`, which we count using the `TestMessageHandler`.
3205 // Because the loop should go around once more after a call which fails to take the
3206 // single-threaded lock, if we write zero to the counter before calling `process_events` we
3207 // should never observe there having been more than 2 loop iterations.
3208 // Further, because the last thread to exit will call `process_events` before returning, we
3209 // should always have at least one count at the end.
3210 let cfg = Arc::new(create_peermgr_cfgs(1));
3211 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
3212 let peer = Arc::new(create_network(1, unsafe { &*(&*cfg as *const _) as &'static _ }).pop().unwrap());
3214 let exit_flag = Arc::new(AtomicBool::new(false));
3215 macro_rules! spawn_thread { () => { {
3216 let thread_cfg = Arc::clone(&cfg);
3217 let thread_peer = Arc::clone(&peer);
3218 let thread_exit = Arc::clone(&exit_flag);
3219 std::thread::spawn(move || {
3220 while !thread_exit.load(Ordering::Acquire) {
3221 thread_cfg[0].chan_handler.message_fetch_counter.store(0, Ordering::Release);
3222 thread_peer.process_events();
3223 std::thread::sleep(Duration::from_micros(1));
3228 let thread_a = spawn_thread!();
3229 let thread_b = spawn_thread!();
3230 let thread_c = spawn_thread!();
3232 let start_time = Instant::now();
3233 while start_time.elapsed() < Duration::from_millis(100) {
3234 let val = cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire);
3236 std::thread::yield_now(); // Winblowz seemingly doesn't ever interrupt threads?!
3239 exit_flag.store(true, Ordering::Release);
3240 thread_a.join().unwrap();
3241 thread_b.join().unwrap();
3242 thread_c.join().unwrap();
3243 assert!(cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire) >= 1);