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::{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 use crate::util::ser::{VecWriter, Writeable, Writer};
28 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor, NextNoiseStep, MessageBuf, MSG_BUF_ALLOC_SIZE};
30 use crate::ln::wire::{Encode, Type};
31 use crate::onion_message::messenger::{CustomOnionMessageHandler, PendingOnionMessage};
32 use crate::onion_message::offers::{OffersMessage, OffersMessageHandler};
33 use crate::onion_message::packet::OnionMessageContents;
34 use crate::routing::gossip::{NodeId, NodeAlias};
35 use crate::util::atomic_counter::AtomicCounter;
36 use crate::util::logger::{Level, Logger, WithContext};
37 use crate::util::string::PrintableString;
39 use crate::prelude::*;
41 use alloc::collections::VecDeque;
42 use crate::sync::{Mutex, MutexGuard, FairRwLock};
43 use core::sync::atomic::{AtomicBool, AtomicU32, AtomicI32, Ordering};
44 use core::{cmp, hash, fmt, mem};
46 use core::convert::Infallible;
47 #[cfg(feature = "std")]
49 #[cfg(not(c_bindings))]
51 crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager},
52 crate::onion_message::messenger::{SimpleArcOnionMessenger, SimpleRefOnionMessenger},
53 crate::routing::gossip::{NetworkGraph, P2PGossipSync},
54 crate::sign::KeysManager,
58 use bitcoin::hashes::sha256::Hash as Sha256;
59 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
60 use bitcoin::hashes::{HashEngine, Hash};
62 /// A handler provided to [`PeerManager`] for reading and handling custom messages.
64 /// [BOLT 1] specifies a custom message type range for use with experimental or application-specific
65 /// messages. `CustomMessageHandler` allows for user-defined handling of such types. See the
66 /// [`lightning_custom_message`] crate for tools useful in composing more than one custom handler.
68 /// [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
69 /// [`lightning_custom_message`]: https://docs.rs/lightning_custom_message/latest/lightning_custom_message
70 pub trait CustomMessageHandler: wire::CustomMessageReader {
71 /// Handles the given message sent from `sender_node_id`, possibly producing messages for
72 /// [`CustomMessageHandler::get_and_clear_pending_msg`] to return and thus for [`PeerManager`]
74 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
76 /// Returns the list of pending messages that were generated by the handler, clearing the list
77 /// in the process. Each message is paired with the node id of the intended recipient. If no
78 /// connection to the node exists, then the message is simply not sent.
79 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
81 /// Gets the node feature flags which this handler itself supports. All available handlers are
82 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
83 /// which are broadcasted in our [`NodeAnnouncement`] message.
85 /// [`NodeAnnouncement`]: crate::ln::msgs::NodeAnnouncement
86 fn provided_node_features(&self) -> NodeFeatures;
88 /// Gets the init feature flags which should be sent to the given peer. All available handlers
89 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
90 /// which are sent in our [`Init`] message.
92 /// [`Init`]: crate::ln::msgs::Init
93 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
96 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
97 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
98 pub struct IgnoringMessageHandler{}
99 impl EventsProvider for IgnoringMessageHandler {
100 fn process_pending_events<H: Deref>(&self, _handler: H) where H::Target: EventHandler {}
102 impl MessageSendEventsProvider for IgnoringMessageHandler {
103 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
105 impl RoutingMessageHandler for IgnoringMessageHandler {
106 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
107 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
108 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
109 fn get_next_channel_announcement(&self, _starting_point: u64) ->
110 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
111 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
112 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
113 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
114 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
115 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
116 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
117 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
118 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
119 InitFeatures::empty()
121 fn processing_queue_high(&self) -> bool { false }
123 impl OnionMessageHandler for IgnoringMessageHandler {
124 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
125 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
126 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
127 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
128 fn timer_tick_occurred(&self) {}
129 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
130 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
131 InitFeatures::empty()
134 impl OffersMessageHandler for IgnoringMessageHandler {
135 fn handle_message(&self, _msg: OffersMessage) -> Option<OffersMessage> { None }
137 impl CustomOnionMessageHandler for IgnoringMessageHandler {
138 type CustomMessage = Infallible;
139 fn handle_custom_message(&self, _msg: Infallible) -> Option<Infallible> {
140 // Since we always return `None` in the read the handle method should never be called.
143 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
146 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Infallible>> {
151 impl OnionMessageContents for Infallible {
152 fn tlv_type(&self) -> u64 { unreachable!(); }
155 impl Deref for IgnoringMessageHandler {
156 type Target = IgnoringMessageHandler;
157 fn deref(&self) -> &Self { self }
160 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
161 // method that takes self for it.
162 impl wire::Type for Infallible {
163 fn type_id(&self) -> u16 {
167 impl Writeable for Infallible {
168 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
173 impl wire::CustomMessageReader for IgnoringMessageHandler {
174 type CustomMessage = Infallible;
175 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
180 impl CustomMessageHandler for IgnoringMessageHandler {
181 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
182 // Since we always return `None` in the read the handle method should never be called.
186 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
188 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
190 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
191 InitFeatures::empty()
195 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
196 /// You can provide one of these as the route_handler in a MessageHandler.
197 pub struct ErroringMessageHandler {
198 message_queue: Mutex<Vec<MessageSendEvent>>
200 impl ErroringMessageHandler {
201 /// Constructs a new ErroringMessageHandler
202 pub fn new() -> Self {
203 Self { message_queue: Mutex::new(Vec::new()) }
205 fn push_error(&self, node_id: &PublicKey, channel_id: ChannelId) {
206 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
207 action: msgs::ErrorAction::SendErrorMessage {
208 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
210 node_id: node_id.clone(),
214 impl MessageSendEventsProvider for ErroringMessageHandler {
215 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
216 let mut res = Vec::new();
217 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
221 impl ChannelMessageHandler for ErroringMessageHandler {
222 // Any messages which are related to a specific channel generate an error message to let the
223 // peer know we don't care about channels.
224 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
225 ErroringMessageHandler::push_error(self, their_node_id, msg.common_fields.temporary_channel_id);
227 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
228 ErroringMessageHandler::push_error(self, their_node_id, msg.common_fields.temporary_channel_id);
230 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
231 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
233 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
234 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
236 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
237 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
239 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
240 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
242 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
243 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
245 fn handle_stfu(&self, their_node_id: &PublicKey, msg: &msgs::Stfu) {
246 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
248 fn handle_splice(&self, their_node_id: &PublicKey, msg: &msgs::Splice) {
249 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
251 fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
252 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
254 fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
255 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
257 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
258 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
260 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
261 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
263 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
264 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
266 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
267 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
269 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
270 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
272 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
273 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
275 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
276 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
278 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
279 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
281 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
282 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
284 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
285 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
286 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
287 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
288 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
289 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
290 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
291 // Set a number of features which various nodes may require to talk to us. It's totally
292 // reasonable to indicate we "support" all kinds of channel features...we just reject all
294 let mut features = InitFeatures::empty();
295 features.set_data_loss_protect_optional();
296 features.set_upfront_shutdown_script_optional();
297 features.set_variable_length_onion_optional();
298 features.set_static_remote_key_optional();
299 features.set_payment_secret_optional();
300 features.set_basic_mpp_optional();
301 features.set_wumbo_optional();
302 features.set_shutdown_any_segwit_optional();
303 features.set_channel_type_optional();
304 features.set_scid_privacy_optional();
305 features.set_zero_conf_optional();
306 features.set_route_blinding_optional();
310 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
311 // We don't enforce any chains upon peer connection for `ErroringMessageHandler` and leave it up
312 // to users of `ErroringMessageHandler` to make decisions on network compatiblility.
313 // There's not really any way to pull in specific networks here, and hardcoding can cause breakages.
317 fn handle_open_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
318 ErroringMessageHandler::push_error(self, their_node_id, msg.common_fields.temporary_channel_id);
321 fn handle_accept_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
322 ErroringMessageHandler::push_error(self, their_node_id, msg.common_fields.temporary_channel_id);
325 fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
326 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
329 fn handle_tx_add_output(&self, their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
330 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
333 fn handle_tx_remove_input(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
334 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
337 fn handle_tx_remove_output(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
338 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
341 fn handle_tx_complete(&self, their_node_id: &PublicKey, msg: &msgs::TxComplete) {
342 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
345 fn handle_tx_signatures(&self, their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
346 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
349 fn handle_tx_init_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
350 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
353 fn handle_tx_ack_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
354 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
357 fn handle_tx_abort(&self, their_node_id: &PublicKey, msg: &msgs::TxAbort) {
358 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
362 impl Deref for ErroringMessageHandler {
363 type Target = ErroringMessageHandler;
364 fn deref(&self) -> &Self { self }
367 /// Provides references to trait impls which handle different types of messages.
368 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref, CustomM: Deref> where
369 CM::Target: ChannelMessageHandler,
370 RM::Target: RoutingMessageHandler,
371 OM::Target: OnionMessageHandler,
372 CustomM::Target: CustomMessageHandler,
374 /// A message handler which handles messages specific to channels. Usually this is just a
375 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
377 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
378 pub chan_handler: CM,
379 /// A message handler which handles messages updating our knowledge of the network channel
380 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
382 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
383 pub route_handler: RM,
385 /// A message handler which handles onion messages. This should generally be an
386 /// [`OnionMessenger`], but can also be an [`IgnoringMessageHandler`].
388 /// [`OnionMessenger`]: crate::onion_message::messenger::OnionMessenger
389 pub onion_message_handler: OM,
391 /// A message handler which handles custom messages. The only LDK-provided implementation is
392 /// [`IgnoringMessageHandler`].
393 pub custom_message_handler: CustomM,
396 /// Provides an object which can be used to send data to and which uniquely identifies a connection
397 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
398 /// implement Hash to meet the PeerManager API.
400 /// For efficiency, [`Clone`] should be relatively cheap for this type.
402 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
403 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
404 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
405 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
406 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
407 /// to simply use another value which is guaranteed to be globally unique instead.
408 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
409 /// Attempts to send some data from the given slice to the peer.
411 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
412 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
413 /// called and further write attempts may occur until that time.
415 /// If the returned size is smaller than `data.len()`, a
416 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
417 /// written. Additionally, until a `send_data` event completes fully, no further
418 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
419 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
422 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
423 /// (indicating that read events should be paused to prevent DoS in the send buffer),
424 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
425 /// `resume_read` of false carries no meaning, and should not cause any action.
426 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
427 /// Disconnect the socket pointed to by this SocketDescriptor.
429 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
430 /// call (doing so is a noop).
431 fn disconnect_socket(&mut self);
434 /// Details of a connected peer as returned by [`PeerManager::list_peers`].
435 pub struct PeerDetails {
436 /// The node id of the peer.
438 /// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
439 /// passed in to [`PeerManager::new_outbound_connection`].
440 pub counterparty_node_id: PublicKey,
441 /// The socket address the peer provided in the initial handshake.
443 /// Will only be `Some` if an address had been previously provided to
444 /// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
445 pub socket_address: Option<SocketAddress>,
446 /// The features the peer provided in the initial handshake.
447 pub init_features: InitFeatures,
448 /// Indicates the direction of the peer connection.
450 /// Will be `true` for inbound connections, and `false` for outbound connections.
451 pub is_inbound_connection: bool,
454 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
455 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
458 pub struct PeerHandleError { }
459 impl fmt::Debug for PeerHandleError {
460 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
461 formatter.write_str("Peer Sent Invalid Data")
464 impl fmt::Display for PeerHandleError {
465 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
466 formatter.write_str("Peer Sent Invalid Data")
470 #[cfg(feature = "std")]
471 impl error::Error for PeerHandleError {
472 fn description(&self) -> &str {
473 "Peer Sent Invalid Data"
477 enum InitSyncTracker{
479 ChannelsSyncing(u64),
480 NodesSyncing(NodeId),
483 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
484 /// forwarding gossip messages to peers altogether.
485 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
487 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
488 /// we have fewer than this many messages in the outbound buffer again.
489 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
490 /// refilled as we send bytes.
491 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
492 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
494 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
496 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
497 /// the socket receive buffer before receiving the ping.
499 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
500 /// including any network delays, outbound traffic, or the same for messages from other peers.
502 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
503 /// per connected peer to respond to a ping, as long as they send us at least one message during
504 /// each tick, ensuring we aren't actually just disconnected.
505 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
508 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
509 /// two connected peers, assuming most LDK-running systems have at least two cores.
510 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
512 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
513 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
514 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
515 /// process before the next ping.
517 /// Note that we continue responding to other messages even after we've sent this many messages, so
518 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
519 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
520 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
523 channel_encryptor: PeerChannelEncryptor,
524 /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
525 /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
526 their_node_id: Option<(PublicKey, NodeId)>,
527 /// The features provided in the peer's [`msgs::Init`] message.
529 /// This is set only after we've processed the [`msgs::Init`] message and called relevant
530 /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
531 /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
533 their_features: Option<InitFeatures>,
534 their_socket_address: Option<SocketAddress>,
536 pending_outbound_buffer: VecDeque<Vec<u8>>,
537 pending_outbound_buffer_first_msg_offset: usize,
538 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
539 /// prioritize channel messages over them.
541 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
542 gossip_broadcast_buffer: VecDeque<MessageBuf>,
543 awaiting_write_event: bool,
545 pending_read_buffer: Vec<u8>,
546 pending_read_buffer_pos: usize,
547 pending_read_is_header: bool,
549 sync_status: InitSyncTracker,
551 msgs_sent_since_pong: usize,
552 awaiting_pong_timer_tick_intervals: i64,
553 received_message_since_timer_tick: bool,
554 sent_gossip_timestamp_filter: bool,
556 /// Indicates we've received a `channel_announcement` since the last time we had
557 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
558 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
559 /// check if we're gossip-processing-backlogged).
560 received_channel_announce_since_backlogged: bool,
562 inbound_connection: bool,
566 /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
567 /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
569 fn handshake_complete(&self) -> bool {
570 self.their_features.is_some()
573 /// Returns true if the channel announcements/updates for the given channel should be
574 /// forwarded to this peer.
575 /// If we are sending our routing table to this peer and we have not yet sent channel
576 /// announcements/updates for the given channel_id then we will send it when we get to that
577 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
578 /// sent the old versions, we should send the update, and so return true here.
579 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
580 if !self.handshake_complete() { return false; }
581 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
582 !self.sent_gossip_timestamp_filter {
585 match self.sync_status {
586 InitSyncTracker::NoSyncRequested => true,
587 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
588 InitSyncTracker::NodesSyncing(_) => true,
592 /// Similar to the above, but for node announcements indexed by node_id.
593 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
594 if !self.handshake_complete() { return false; }
595 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
596 !self.sent_gossip_timestamp_filter {
599 match self.sync_status {
600 InitSyncTracker::NoSyncRequested => true,
601 InitSyncTracker::ChannelsSyncing(_) => false,
602 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
606 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
607 /// buffer still has space and we don't need to pause reads to get some writes out.
608 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
609 if !gossip_processing_backlogged {
610 self.received_channel_announce_since_backlogged = false;
612 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
613 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
616 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
617 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
618 fn should_buffer_gossip_backfill(&self) -> bool {
619 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
620 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
621 && self.handshake_complete()
624 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
625 /// every time the peer's buffer may have been drained.
626 fn should_buffer_onion_message(&self) -> bool {
627 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
628 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
631 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
632 /// buffer. This is checked every time the peer's buffer may have been drained.
633 fn should_buffer_gossip_broadcast(&self) -> bool {
634 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
635 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
638 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
639 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
640 let total_outbound_buffered =
641 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
643 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
644 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
647 fn set_their_node_id(&mut self, node_id: PublicKey) {
648 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
652 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
653 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
654 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
655 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
656 /// issues such as overly long function definitions.
658 /// This is not exported to bindings users as type aliases aren't supported in most languages.
659 #[cfg(not(c_bindings))]
660 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<
662 Arc<SimpleArcChannelManager<M, T, F, L>>,
663 Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, C, Arc<L>>>,
664 Arc<SimpleArcOnionMessenger<M, T, F, L>>,
666 IgnoringMessageHandler,
670 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
671 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
672 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
673 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
674 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
675 /// helps with issues such as long function definitions.
677 /// This is not exported to bindings users as type aliases aren't supported in most languages.
678 #[cfg(not(c_bindings))]
679 pub type SimpleRefPeerManager<
680 'a, 'b, 'c, 'd, 'e, 'f, 'logger, 'h, 'i, 'j, 'graph, 'k, SD, M, T, F, C, L
683 &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, M, T, F, L>,
684 &'f P2PGossipSync<&'graph NetworkGraph<&'logger L>, C, &'logger L>,
685 &'h SimpleRefOnionMessenger<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, 'j, 'k, M, T, F, L>,
687 IgnoringMessageHandler,
692 /// A generic trait which is implemented for all [`PeerManager`]s. This makes bounding functions or
693 /// structs on any [`PeerManager`] much simpler as only this trait is needed as a bound, rather
694 /// than the full set of bounds on [`PeerManager`] itself.
696 /// This is not exported to bindings users as general cover traits aren't useful in other
698 #[allow(missing_docs)]
699 pub trait APeerManager {
700 type Descriptor: SocketDescriptor;
701 type CMT: ChannelMessageHandler + ?Sized;
702 type CM: Deref<Target=Self::CMT>;
703 type RMT: RoutingMessageHandler + ?Sized;
704 type RM: Deref<Target=Self::RMT>;
705 type OMT: OnionMessageHandler + ?Sized;
706 type OM: Deref<Target=Self::OMT>;
707 type LT: Logger + ?Sized;
708 type L: Deref<Target=Self::LT>;
709 type CMHT: CustomMessageHandler + ?Sized;
710 type CMH: Deref<Target=Self::CMHT>;
711 type NST: NodeSigner + ?Sized;
712 type NS: Deref<Target=Self::NST>;
713 /// Gets a reference to the underlying [`PeerManager`].
714 fn as_ref(&self) -> &PeerManager<Self::Descriptor, Self::CM, Self::RM, Self::OM, Self::L, Self::CMH, Self::NS>;
715 /// Returns the peer manager's [`OnionMessageHandler`].
716 fn onion_message_handler(&self) -> &Self::OMT;
719 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref>
720 APeerManager for PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
721 CM::Target: ChannelMessageHandler,
722 RM::Target: RoutingMessageHandler,
723 OM::Target: OnionMessageHandler,
725 CMH::Target: CustomMessageHandler,
726 NS::Target: NodeSigner,
728 type Descriptor = Descriptor;
729 type CMT = <CM as Deref>::Target;
731 type RMT = <RM as Deref>::Target;
733 type OMT = <OM as Deref>::Target;
735 type LT = <L as Deref>::Target;
737 type CMHT = <CMH as Deref>::Target;
739 type NST = <NS as Deref>::Target;
741 fn as_ref(&self) -> &PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> { self }
742 fn onion_message_handler(&self) -> &Self::OMT {
743 self.message_handler.onion_message_handler.deref()
747 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
748 /// socket events into messages which it passes on to its [`MessageHandler`].
750 /// Locks are taken internally, so you must never assume that reentrancy from a
751 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
753 /// Calls to [`read_event`] will decode relevant messages and pass them to the
754 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
755 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
756 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
757 /// calls only after previous ones have returned.
759 /// Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
760 /// a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
761 /// essentially you should default to using a [`SimpleRefPeerManager`], and use a
762 /// [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
763 /// you're using lightning-net-tokio.
765 /// [`read_event`]: PeerManager::read_event
766 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
767 CM::Target: ChannelMessageHandler,
768 RM::Target: RoutingMessageHandler,
769 OM::Target: OnionMessageHandler,
771 CMH::Target: CustomMessageHandler,
772 NS::Target: NodeSigner {
773 message_handler: MessageHandler<CM, RM, OM, CMH>,
774 /// Connection state for each connected peer - we have an outer read-write lock which is taken
775 /// as read while we're doing processing for a peer and taken write when a peer is being added
778 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
779 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
780 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
781 /// the `MessageHandler`s for a given peer is already guaranteed.
782 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
783 /// Only add to this set when noise completes.
784 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
785 /// lock held. Entries may be added with only the `peers` read lock held (though the
786 /// `Descriptor` value must already exist in `peers`).
787 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
788 /// We can only have one thread processing events at once, but if a second call to
789 /// `process_events` happens while a first call is in progress, one of the two calls needs to
790 /// start from the top to ensure any new messages are also handled.
792 /// Because the event handler calls into user code which may block, we don't want to block a
793 /// second thread waiting for another thread to handle events which is then blocked on user
794 /// code, so we store an atomic counter here:
795 /// * 0 indicates no event processor is running
796 /// * 1 indicates an event processor is running
797 /// * > 1 indicates an event processor is running but needs to start again from the top once
798 /// it finishes as another thread tried to start processing events but returned early.
799 event_processing_state: AtomicI32,
801 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
802 /// value increases strictly since we don't assume access to a time source.
803 last_node_announcement_serial: AtomicU32,
805 ephemeral_key_midstate: Sha256Engine,
807 peer_counter: AtomicCounter,
809 gossip_processing_backlogged: AtomicBool,
810 gossip_processing_backlog_lifted: AtomicBool,
815 secp_ctx: Secp256k1<secp256k1::SignOnly>
818 enum MessageHandlingError {
819 PeerHandleError(PeerHandleError),
820 LightningError(LightningError),
823 impl From<PeerHandleError> for MessageHandlingError {
824 fn from(error: PeerHandleError) -> Self {
825 MessageHandlingError::PeerHandleError(error)
829 impl From<LightningError> for MessageHandlingError {
830 fn from(error: LightningError) -> Self {
831 MessageHandlingError::LightningError(error)
835 macro_rules! encode_msg {
837 let mut buffer = VecWriter(Vec::with_capacity(MSG_BUF_ALLOC_SIZE));
838 wire::write($msg, &mut buffer).unwrap();
843 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
844 CM::Target: ChannelMessageHandler,
845 OM::Target: OnionMessageHandler,
847 NS::Target: NodeSigner {
848 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
849 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
852 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
853 /// cryptographically secure random bytes.
855 /// `current_time` is used as an always-increasing counter that survives across restarts and is
856 /// incremented irregularly internally. In general it is best to simply use the current UNIX
857 /// timestamp, however if it is not available a persistent counter that increases once per
858 /// minute should suffice.
860 /// This is not exported to bindings users as we can't export a PeerManager with a dummy route handler
861 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 {
862 Self::new(MessageHandler {
863 chan_handler: channel_message_handler,
864 route_handler: IgnoringMessageHandler{},
865 onion_message_handler,
866 custom_message_handler: IgnoringMessageHandler{},
867 }, current_time, ephemeral_random_data, logger, node_signer)
871 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
872 RM::Target: RoutingMessageHandler,
874 NS::Target: NodeSigner {
875 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
876 /// handler or onion message handler is used and onion and channel messages will be ignored (or
877 /// generate error messages). Note that some other lightning implementations time-out connections
878 /// after some time if no channel is built with the peer.
880 /// `current_time` is used as an always-increasing counter that survives across restarts and is
881 /// incremented irregularly internally. In general it is best to simply use the current UNIX
882 /// timestamp, however if it is not available a persistent counter that increases once per
883 /// minute should suffice.
885 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
886 /// cryptographically secure random bytes.
888 /// This is not exported to bindings users as we can't export a PeerManager with a dummy channel handler
889 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
890 Self::new(MessageHandler {
891 chan_handler: ErroringMessageHandler::new(),
892 route_handler: routing_message_handler,
893 onion_message_handler: IgnoringMessageHandler{},
894 custom_message_handler: IgnoringMessageHandler{},
895 }, current_time, ephemeral_random_data, logger, node_signer)
899 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
900 /// This works around `format!()` taking a reference to each argument, preventing
901 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
902 /// due to lifetime errors.
903 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
904 impl core::fmt::Display for OptionalFromDebugger<'_> {
905 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
906 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
910 /// A function used to filter out local or private addresses
911 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
912 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
913 fn filter_addresses(ip_address: Option<SocketAddress>) -> Option<SocketAddress> {
915 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
916 Some(SocketAddress::TcpIpV4{addr: [10, _, _, _], port: _}) => None,
917 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
918 Some(SocketAddress::TcpIpV4{addr: [0, _, _, _], port: _}) => None,
919 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
920 Some(SocketAddress::TcpIpV4{addr: [100, 64..=127, _, _], port: _}) => None,
921 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
922 Some(SocketAddress::TcpIpV4{addr: [127, _, _, _], port: _}) => None,
923 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
924 Some(SocketAddress::TcpIpV4{addr: [169, 254, _, _], port: _}) => None,
925 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
926 Some(SocketAddress::TcpIpV4{addr: [172, 16..=31, _, _], port: _}) => None,
927 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
928 Some(SocketAddress::TcpIpV4{addr: [192, 168, _, _], port: _}) => None,
929 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
930 Some(SocketAddress::TcpIpV4{addr: [192, 88, 99, _], port: _}) => None,
931 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
932 Some(SocketAddress::TcpIpV6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
933 // For remaining addresses
934 Some(SocketAddress::TcpIpV6{addr: _, port: _}) => None,
935 Some(..) => ip_address,
940 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
941 CM::Target: ChannelMessageHandler,
942 RM::Target: RoutingMessageHandler,
943 OM::Target: OnionMessageHandler,
945 CMH::Target: CustomMessageHandler,
946 NS::Target: NodeSigner
948 /// Constructs a new `PeerManager` with the given message handlers.
950 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
951 /// cryptographically secure random bytes.
953 /// `current_time` is used as an always-increasing counter that survives across restarts and is
954 /// incremented irregularly internally. In general it is best to simply use the current UNIX
955 /// timestamp, however if it is not available a persistent counter that increases once per
956 /// minute should suffice.
957 pub fn new(message_handler: MessageHandler<CM, RM, OM, CMH>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
958 let mut ephemeral_key_midstate = Sha256::engine();
959 ephemeral_key_midstate.input(ephemeral_random_data);
961 let mut secp_ctx = Secp256k1::signing_only();
962 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).to_byte_array();
963 secp_ctx.seeded_randomize(&ephemeral_hash);
967 peers: FairRwLock::new(new_hash_map()),
968 node_id_to_descriptor: Mutex::new(new_hash_map()),
969 event_processing_state: AtomicI32::new(0),
970 ephemeral_key_midstate,
971 peer_counter: AtomicCounter::new(),
972 gossip_processing_backlogged: AtomicBool::new(false),
973 gossip_processing_backlog_lifted: AtomicBool::new(false),
974 last_node_announcement_serial: AtomicU32::new(current_time),
981 /// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
983 pub fn list_peers(&self) -> Vec<PeerDetails> {
984 let peers = self.peers.read().unwrap();
985 peers.values().filter_map(|peer_mutex| {
986 let p = peer_mutex.lock().unwrap();
987 if !p.handshake_complete() {
990 let details = PeerDetails {
991 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
993 counterparty_node_id: p.their_node_id.unwrap().0,
994 socket_address: p.their_socket_address.clone(),
995 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
997 init_features: p.their_features.clone().unwrap(),
998 is_inbound_connection: p.inbound_connection,
1004 /// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
1006 /// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
1007 pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
1008 let peers = self.peers.read().unwrap();
1009 peers.values().find_map(|peer_mutex| {
1010 let p = peer_mutex.lock().unwrap();
1011 if !p.handshake_complete() {
1015 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
1017 let counterparty_node_id = p.their_node_id.unwrap().0;
1019 if counterparty_node_id != *their_node_id {
1023 let details = PeerDetails {
1024 counterparty_node_id,
1025 socket_address: p.their_socket_address.clone(),
1026 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
1028 init_features: p.their_features.clone().unwrap(),
1029 is_inbound_connection: p.inbound_connection,
1035 fn get_ephemeral_key(&self) -> SecretKey {
1036 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
1037 let counter = self.peer_counter.get_increment();
1038 ephemeral_hash.input(&counter.to_le_bytes());
1039 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).to_byte_array()).expect("You broke SHA-256!")
1042 fn init_features(&self, their_node_id: &PublicKey) -> InitFeatures {
1043 self.message_handler.chan_handler.provided_init_features(their_node_id)
1044 | self.message_handler.route_handler.provided_init_features(their_node_id)
1045 | self.message_handler.onion_message_handler.provided_init_features(their_node_id)
1046 | self.message_handler.custom_message_handler.provided_init_features(their_node_id)
1049 /// Indicates a new outbound connection has been established to a node with the given `node_id`
1050 /// and an optional remote network address.
1052 /// The remote network address adds the option to report a remote IP address back to a connecting
1053 /// peer using the init message.
1054 /// The user should pass the remote network address of the host they are connected to.
1056 /// If an `Err` is returned here you must disconnect the connection immediately.
1058 /// Returns a small number of bytes to send to the remote node (currently always 50).
1060 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1061 /// [`socket_disconnected`].
1063 /// [`socket_disconnected`]: PeerManager::socket_disconnected
1064 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<Vec<u8>, PeerHandleError> {
1065 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
1066 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
1067 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
1069 let mut peers = self.peers.write().unwrap();
1070 match peers.entry(descriptor) {
1071 hash_map::Entry::Occupied(_) => {
1072 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1073 Err(PeerHandleError {})
1075 hash_map::Entry::Vacant(e) => {
1076 e.insert(Mutex::new(Peer {
1077 channel_encryptor: peer_encryptor,
1078 their_node_id: None,
1079 their_features: None,
1080 their_socket_address: remote_network_address,
1082 pending_outbound_buffer: VecDeque::new(),
1083 pending_outbound_buffer_first_msg_offset: 0,
1084 gossip_broadcast_buffer: VecDeque::new(),
1085 awaiting_write_event: false,
1087 pending_read_buffer,
1088 pending_read_buffer_pos: 0,
1089 pending_read_is_header: false,
1091 sync_status: InitSyncTracker::NoSyncRequested,
1093 msgs_sent_since_pong: 0,
1094 awaiting_pong_timer_tick_intervals: 0,
1095 received_message_since_timer_tick: false,
1096 sent_gossip_timestamp_filter: false,
1098 received_channel_announce_since_backlogged: false,
1099 inbound_connection: false,
1106 /// Indicates a new inbound connection has been established to a node with an optional remote
1107 /// network address.
1109 /// The remote network address adds the option to report a remote IP address back to a connecting
1110 /// peer using the init message.
1111 /// The user should pass the remote network address of the host they are connected to.
1113 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
1114 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
1115 /// the connection immediately.
1117 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1118 /// [`socket_disconnected`].
1120 /// [`socket_disconnected`]: PeerManager::socket_disconnected
1121 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<(), PeerHandleError> {
1122 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
1123 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
1125 let mut peers = self.peers.write().unwrap();
1126 match peers.entry(descriptor) {
1127 hash_map::Entry::Occupied(_) => {
1128 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1129 Err(PeerHandleError {})
1131 hash_map::Entry::Vacant(e) => {
1132 e.insert(Mutex::new(Peer {
1133 channel_encryptor: peer_encryptor,
1134 their_node_id: None,
1135 their_features: None,
1136 their_socket_address: remote_network_address,
1138 pending_outbound_buffer: VecDeque::new(),
1139 pending_outbound_buffer_first_msg_offset: 0,
1140 gossip_broadcast_buffer: VecDeque::new(),
1141 awaiting_write_event: false,
1143 pending_read_buffer,
1144 pending_read_buffer_pos: 0,
1145 pending_read_is_header: false,
1147 sync_status: InitSyncTracker::NoSyncRequested,
1149 msgs_sent_since_pong: 0,
1150 awaiting_pong_timer_tick_intervals: 0,
1151 received_message_since_timer_tick: false,
1152 sent_gossip_timestamp_filter: false,
1154 received_channel_announce_since_backlogged: false,
1155 inbound_connection: true,
1162 fn peer_should_read(&self, peer: &mut Peer) -> bool {
1163 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
1166 fn update_gossip_backlogged(&self) {
1167 let new_state = self.message_handler.route_handler.processing_queue_high();
1168 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
1169 if prev_state && !new_state {
1170 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
1174 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
1175 let mut have_written = false;
1176 while !peer.awaiting_write_event {
1177 if peer.should_buffer_onion_message() {
1178 if let Some((peer_node_id, _)) = peer.their_node_id {
1179 if let Some(next_onion_message) =
1180 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
1181 self.enqueue_message(peer, &next_onion_message);
1185 if peer.should_buffer_gossip_broadcast() {
1186 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
1187 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(msg));
1190 if peer.should_buffer_gossip_backfill() {
1191 match peer.sync_status {
1192 InitSyncTracker::NoSyncRequested => {},
1193 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
1194 if let Some((announce, update_a_option, update_b_option)) =
1195 self.message_handler.route_handler.get_next_channel_announcement(c)
1197 self.enqueue_message(peer, &announce);
1198 if let Some(update_a) = update_a_option {
1199 self.enqueue_message(peer, &update_a);
1201 if let Some(update_b) = update_b_option {
1202 self.enqueue_message(peer, &update_b);
1204 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
1206 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
1209 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
1210 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
1211 self.enqueue_message(peer, &msg);
1212 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1214 peer.sync_status = InitSyncTracker::NoSyncRequested;
1217 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
1218 InitSyncTracker::NodesSyncing(sync_node_id) => {
1219 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
1220 self.enqueue_message(peer, &msg);
1221 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1223 peer.sync_status = InitSyncTracker::NoSyncRequested;
1228 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
1229 self.maybe_send_extra_ping(peer);
1232 let should_read = self.peer_should_read(peer);
1233 let next_buff = match peer.pending_outbound_buffer.front() {
1235 if force_one_write && !have_written {
1237 let data_sent = descriptor.send_data(&[], should_read);
1238 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
1246 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
1247 let data_sent = descriptor.send_data(pending, should_read);
1248 have_written = true;
1249 peer.pending_outbound_buffer_first_msg_offset += data_sent;
1250 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
1251 peer.pending_outbound_buffer_first_msg_offset = 0;
1252 peer.pending_outbound_buffer.pop_front();
1253 const VEC_SIZE: usize = ::core::mem::size_of::<Vec<u8>>();
1254 let large_capacity = peer.pending_outbound_buffer.capacity() > 4096 / VEC_SIZE;
1255 let lots_of_slack = peer.pending_outbound_buffer.len()
1256 < peer.pending_outbound_buffer.capacity() / 2;
1257 if large_capacity && lots_of_slack {
1258 peer.pending_outbound_buffer.shrink_to_fit();
1261 peer.awaiting_write_event = true;
1266 /// Indicates that there is room to write data to the given socket descriptor.
1268 /// May return an Err to indicate that the connection should be closed.
1270 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1271 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1272 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1273 /// ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
1276 /// [`send_data`]: SocketDescriptor::send_data
1277 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1278 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1279 let peers = self.peers.read().unwrap();
1280 match peers.get(descriptor) {
1282 // This is most likely a simple race condition where the user found that the socket
1283 // was writeable, then we told the user to `disconnect_socket()`, then they called
1284 // this method. Return an error to make sure we get disconnected.
1285 return Err(PeerHandleError { });
1287 Some(peer_mutex) => {
1288 let mut peer = peer_mutex.lock().unwrap();
1289 peer.awaiting_write_event = false;
1290 self.do_attempt_write_data(descriptor, &mut peer, false);
1296 /// Indicates that data was read from the given socket descriptor.
1298 /// May return an Err to indicate that the connection should be closed.
1300 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1301 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1302 /// [`send_data`] calls to handle responses.
1304 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1305 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1308 /// In order to avoid processing too many messages at once per peer, `data` should be on the
1311 /// [`send_data`]: SocketDescriptor::send_data
1312 /// [`process_events`]: PeerManager::process_events
1313 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1314 match self.do_read_event(peer_descriptor, data) {
1317 log_trace!(self.logger, "Disconnecting peer due to a protocol error (usually a duplicate connection).");
1318 self.disconnect_event_internal(peer_descriptor);
1324 /// Append a message to a peer's pending outbound/write buffer
1325 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1326 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1327 if is_gossip_msg(message.type_id()) {
1328 log_gossip!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1330 log_trace!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1332 peer.msgs_sent_since_pong += 1;
1333 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1336 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1337 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: MessageBuf) {
1338 peer.msgs_sent_since_pong += 1;
1339 debug_assert!(peer.gossip_broadcast_buffer.len() <= OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP);
1340 peer.gossip_broadcast_buffer.push_back(encoded_message);
1343 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1344 let mut pause_read = false;
1345 let peers = self.peers.read().unwrap();
1346 let mut msgs_to_forward = Vec::new();
1347 let mut peer_node_id = None;
1348 match peers.get(peer_descriptor) {
1350 // This is most likely a simple race condition where the user read some bytes
1351 // from the socket, then we told the user to `disconnect_socket()`, then they
1352 // called this method. Return an error to make sure we get disconnected.
1353 return Err(PeerHandleError { });
1355 Some(peer_mutex) => {
1356 let mut read_pos = 0;
1357 while read_pos < data.len() {
1358 macro_rules! try_potential_handleerror {
1359 ($peer: expr, $thing: expr) => {{
1361 let logger = WithContext::from(&self.logger, peer_node_id.map(|(id, _)| id), None);
1366 msgs::ErrorAction::DisconnectPeer { .. } => {
1367 // We may have an `ErrorMessage` to send to the peer,
1368 // but writing to the socket while reading can lead to
1369 // re-entrant code and possibly unexpected behavior. The
1370 // message send is optimistic anyway, and in this case
1371 // we immediately disconnect the peer.
1372 log_debug!(logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1373 return Err(PeerHandleError { });
1375 msgs::ErrorAction::DisconnectPeerWithWarning { .. } => {
1376 // We have a `WarningMessage` to send to the peer, but
1377 // writing to the socket while reading can lead to
1378 // re-entrant code and possibly unexpected behavior. The
1379 // message send is optimistic anyway, and in this case
1380 // we immediately disconnect the peer.
1381 log_debug!(logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1382 return Err(PeerHandleError { });
1384 msgs::ErrorAction::IgnoreAndLog(level) => {
1385 log_given_level!(logger, level, "Error handling {}message{}; ignoring: {}",
1386 if level == Level::Gossip { "gossip " } else { "" },
1387 OptionalFromDebugger(&peer_node_id), e.err);
1390 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1391 msgs::ErrorAction::IgnoreError => {
1392 log_debug!(logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1395 msgs::ErrorAction::SendErrorMessage { msg } => {
1396 log_debug!(logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1397 self.enqueue_message($peer, &msg);
1400 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1401 log_given_level!(logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1402 self.enqueue_message($peer, &msg);
1411 let mut peer_lock = peer_mutex.lock().unwrap();
1412 let peer = &mut *peer_lock;
1413 let mut msg_to_handle = None;
1414 if peer_node_id.is_none() {
1415 peer_node_id = peer.their_node_id.clone();
1418 assert!(peer.pending_read_buffer.len() > 0);
1419 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1422 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1423 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]);
1424 read_pos += data_to_copy;
1425 peer.pending_read_buffer_pos += data_to_copy;
1428 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1429 peer.pending_read_buffer_pos = 0;
1431 macro_rules! insert_node_id {
1433 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1434 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1435 hash_map::Entry::Occupied(e) => {
1436 log_trace!(logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1437 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1438 // Check that the peers map is consistent with the
1439 // node_id_to_descriptor map, as this has been broken
1441 debug_assert!(peers.get(e.get()).is_some());
1442 return Err(PeerHandleError { })
1444 hash_map::Entry::Vacant(entry) => {
1445 log_debug!(logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1446 entry.insert(peer_descriptor.clone())
1452 let next_step = peer.channel_encryptor.get_noise_step();
1454 NextNoiseStep::ActOne => {
1455 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1456 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1457 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1458 peer.pending_outbound_buffer.push_back(act_two);
1459 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1461 NextNoiseStep::ActTwo => {
1462 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1463 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1464 &self.node_signer));
1465 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1466 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1467 peer.pending_read_is_header = true;
1469 peer.set_their_node_id(their_node_id);
1471 let features = self.init_features(&their_node_id);
1472 let networks = self.message_handler.chan_handler.get_chain_hashes();
1473 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1474 self.enqueue_message(peer, &resp);
1475 peer.awaiting_pong_timer_tick_intervals = 0;
1477 NextNoiseStep::ActThree => {
1478 let their_node_id = try_potential_handleerror!(peer,
1479 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1480 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1481 peer.pending_read_is_header = true;
1482 peer.set_their_node_id(their_node_id);
1484 let features = self.init_features(&their_node_id);
1485 let networks = self.message_handler.chan_handler.get_chain_hashes();
1486 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1487 self.enqueue_message(peer, &resp);
1488 peer.awaiting_pong_timer_tick_intervals = 0;
1490 NextNoiseStep::NoiseComplete => {
1491 if peer.pending_read_is_header {
1492 let msg_len = try_potential_handleerror!(peer,
1493 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1494 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1495 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1496 if msg_len < 2 { // Need at least the message type tag
1497 return Err(PeerHandleError { });
1499 peer.pending_read_is_header = false;
1501 debug_assert!(peer.pending_read_buffer.len() >= 2 + 16);
1502 try_potential_handleerror!(peer,
1503 peer.channel_encryptor.decrypt_message(&mut peer.pending_read_buffer[..]));
1505 let mut reader = io::Cursor::new(&peer.pending_read_buffer[..peer.pending_read_buffer.len() - 16]);
1506 let message_result = wire::read(&mut reader, &*self.message_handler.custom_message_handler);
1508 // Reset read buffer
1509 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1510 peer.pending_read_buffer.resize(18, 0);
1511 peer.pending_read_is_header = true;
1513 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1514 let message = match message_result {
1518 // Note that to avoid re-entrancy we never call
1519 // `do_attempt_write_data` from here, causing
1520 // the messages enqueued here to not actually
1521 // be sent before the peer is disconnected.
1522 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1523 log_gossip!(logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1526 (msgs::DecodeError::UnsupportedCompression, _) => {
1527 log_gossip!(logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1528 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: ChannelId::new_zero(), data: "Unsupported message compression: zlib".to_owned() });
1531 (_, Some(ty)) if is_gossip_msg(ty) => {
1532 log_gossip!(logger, "Got an invalid value while deserializing a gossip message");
1533 self.enqueue_message(peer, &msgs::WarningMessage {
1534 channel_id: ChannelId::new_zero(),
1535 data: format!("Unreadable/bogus gossip message of type {}", ty),
1539 (msgs::DecodeError::UnknownRequiredFeature, _) => {
1540 log_debug!(logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1541 return Err(PeerHandleError { });
1543 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1544 (msgs::DecodeError::InvalidValue, _) => {
1545 log_debug!(logger, "Got an invalid value while deserializing message");
1546 return Err(PeerHandleError { });
1548 (msgs::DecodeError::ShortRead, _) => {
1549 log_debug!(logger, "Deserialization failed due to shortness of message");
1550 return Err(PeerHandleError { });
1552 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1553 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1558 msg_to_handle = Some(message);
1563 pause_read = !self.peer_should_read(peer);
1565 if let Some(message) = msg_to_handle {
1566 match self.handle_message(&peer_mutex, peer_lock, message) {
1567 Err(handling_error) => match handling_error {
1568 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1569 MessageHandlingError::LightningError(e) => {
1570 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1574 msgs_to_forward.push(msg);
1583 for msg in msgs_to_forward.drain(..) {
1584 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1590 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1592 /// Returns the message back if it needs to be broadcasted to all other peers.
1595 peer_mutex: &Mutex<Peer>,
1596 peer_lock: MutexGuard<Peer>,
1597 message: wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1598 ) -> Result<Option<wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1599 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;
1600 let logger = WithContext::from(&self.logger, Some(their_node_id), None);
1602 let message = match self.do_handle_message_holding_peer_lock(peer_lock, message, &their_node_id, &logger)? {
1603 Some(processed_message) => processed_message,
1604 None => return Ok(None),
1607 self.do_handle_message_without_peer_lock(peer_mutex, message, &their_node_id, &logger)
1610 // Conducts all message processing that requires us to hold the `peer_lock`.
1612 // Returns `None` if the message was fully processed and otherwise returns the message back to
1613 // allow it to be subsequently processed by `do_handle_message_without_peer_lock`.
1614 fn do_handle_message_holding_peer_lock<'a>(
1616 mut peer_lock: MutexGuard<Peer>,
1617 message: wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>,
1618 their_node_id: &PublicKey,
1619 logger: &WithContext<'a, L>
1620 ) -> Result<Option<wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError>
1622 peer_lock.received_message_since_timer_tick = true;
1624 // Need an Init as first message
1625 if let wire::Message::Init(msg) = message {
1626 // Check if we have any compatible chains if the `networks` field is specified.
1627 if let Some(networks) = &msg.networks {
1628 if let Some(our_chains) = self.message_handler.chan_handler.get_chain_hashes() {
1629 let mut have_compatible_chains = false;
1630 'our_chains: for our_chain in our_chains.iter() {
1631 for their_chain in networks {
1632 if our_chain == their_chain {
1633 have_compatible_chains = true;
1638 if !have_compatible_chains {
1639 log_debug!(logger, "Peer does not support any of our supported chains");
1640 return Err(PeerHandleError { }.into());
1645 let our_features = self.init_features(&their_node_id);
1646 if msg.features.requires_unknown_bits_from(&our_features) {
1647 log_debug!(logger, "Peer requires features unknown to us");
1648 return Err(PeerHandleError { }.into());
1651 if our_features.requires_unknown_bits_from(&msg.features) {
1652 log_debug!(logger, "We require features unknown to our peer");
1653 return Err(PeerHandleError { }.into());
1656 if peer_lock.their_features.is_some() {
1657 return Err(PeerHandleError { }.into());
1660 log_info!(logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1662 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1663 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1664 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1667 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1668 log_debug!(logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1669 return Err(PeerHandleError { }.into());
1671 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1672 log_debug!(logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1673 return Err(PeerHandleError { }.into());
1675 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1676 log_debug!(logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1677 return Err(PeerHandleError { }.into());
1680 peer_lock.their_features = Some(msg.features);
1682 } else if peer_lock.their_features.is_none() {
1683 log_debug!(logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1684 return Err(PeerHandleError { }.into());
1687 if let wire::Message::GossipTimestampFilter(_msg) = message {
1688 // When supporting gossip messages, start initial gossip sync only after we receive
1689 // a GossipTimestampFilter
1690 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1691 !peer_lock.sent_gossip_timestamp_filter {
1692 peer_lock.sent_gossip_timestamp_filter = true;
1693 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1698 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1699 peer_lock.received_channel_announce_since_backlogged = true;
1705 // Conducts all message processing that doesn't require us to hold the `peer_lock`.
1707 // Returns the message back if it needs to be broadcasted to all other peers.
1708 fn do_handle_message_without_peer_lock<'a>(
1710 peer_mutex: &Mutex<Peer>,
1711 message: wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>,
1712 their_node_id: &PublicKey,
1713 logger: &WithContext<'a, L>
1714 ) -> Result<Option<wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError>
1716 if is_gossip_msg(message.type_id()) {
1717 log_gossip!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1719 log_trace!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1722 let mut should_forward = None;
1725 // Setup and Control messages:
1726 wire::Message::Init(_) => {
1729 wire::Message::GossipTimestampFilter(_) => {
1732 wire::Message::Error(msg) => {
1733 log_debug!(logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1734 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1735 if msg.channel_id.is_zero() {
1736 return Err(PeerHandleError { }.into());
1739 wire::Message::Warning(msg) => {
1740 log_debug!(logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1743 wire::Message::Ping(msg) => {
1744 if msg.ponglen < 65532 {
1745 let resp = msgs::Pong { byteslen: msg.ponglen };
1746 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1749 wire::Message::Pong(_msg) => {
1750 let mut peer_lock = peer_mutex.lock().unwrap();
1751 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1752 peer_lock.msgs_sent_since_pong = 0;
1755 // Channel messages:
1756 wire::Message::OpenChannel(msg) => {
1757 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1759 wire::Message::OpenChannelV2(msg) => {
1760 self.message_handler.chan_handler.handle_open_channel_v2(&their_node_id, &msg);
1762 wire::Message::AcceptChannel(msg) => {
1763 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1765 wire::Message::AcceptChannelV2(msg) => {
1766 self.message_handler.chan_handler.handle_accept_channel_v2(&their_node_id, &msg);
1769 wire::Message::FundingCreated(msg) => {
1770 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1772 wire::Message::FundingSigned(msg) => {
1773 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1775 wire::Message::ChannelReady(msg) => {
1776 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1779 // Quiescence messages:
1780 wire::Message::Stfu(msg) => {
1781 self.message_handler.chan_handler.handle_stfu(&their_node_id, &msg);
1784 // Splicing messages:
1785 wire::Message::Splice(msg) => {
1786 self.message_handler.chan_handler.handle_splice(&their_node_id, &msg);
1788 wire::Message::SpliceAck(msg) => {
1789 self.message_handler.chan_handler.handle_splice_ack(&their_node_id, &msg);
1791 wire::Message::SpliceLocked(msg) => {
1792 self.message_handler.chan_handler.handle_splice_locked(&their_node_id, &msg);
1795 // Interactive transaction construction messages:
1796 wire::Message::TxAddInput(msg) => {
1797 self.message_handler.chan_handler.handle_tx_add_input(&their_node_id, &msg);
1799 wire::Message::TxAddOutput(msg) => {
1800 self.message_handler.chan_handler.handle_tx_add_output(&their_node_id, &msg);
1802 wire::Message::TxRemoveInput(msg) => {
1803 self.message_handler.chan_handler.handle_tx_remove_input(&their_node_id, &msg);
1805 wire::Message::TxRemoveOutput(msg) => {
1806 self.message_handler.chan_handler.handle_tx_remove_output(&their_node_id, &msg);
1808 wire::Message::TxComplete(msg) => {
1809 self.message_handler.chan_handler.handle_tx_complete(&their_node_id, &msg);
1811 wire::Message::TxSignatures(msg) => {
1812 self.message_handler.chan_handler.handle_tx_signatures(&their_node_id, &msg);
1814 wire::Message::TxInitRbf(msg) => {
1815 self.message_handler.chan_handler.handle_tx_init_rbf(&their_node_id, &msg);
1817 wire::Message::TxAckRbf(msg) => {
1818 self.message_handler.chan_handler.handle_tx_ack_rbf(&their_node_id, &msg);
1820 wire::Message::TxAbort(msg) => {
1821 self.message_handler.chan_handler.handle_tx_abort(&their_node_id, &msg);
1824 wire::Message::Shutdown(msg) => {
1825 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1827 wire::Message::ClosingSigned(msg) => {
1828 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1831 // Commitment messages:
1832 wire::Message::UpdateAddHTLC(msg) => {
1833 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1835 wire::Message::UpdateFulfillHTLC(msg) => {
1836 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1838 wire::Message::UpdateFailHTLC(msg) => {
1839 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1841 wire::Message::UpdateFailMalformedHTLC(msg) => {
1842 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1845 wire::Message::CommitmentSigned(msg) => {
1846 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1848 wire::Message::RevokeAndACK(msg) => {
1849 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1851 wire::Message::UpdateFee(msg) => {
1852 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1854 wire::Message::ChannelReestablish(msg) => {
1855 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1858 // Routing messages:
1859 wire::Message::AnnouncementSignatures(msg) => {
1860 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1862 wire::Message::ChannelAnnouncement(msg) => {
1863 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1864 .map_err(|e| -> MessageHandlingError { e.into() })? {
1865 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1867 self.update_gossip_backlogged();
1869 wire::Message::NodeAnnouncement(msg) => {
1870 if self.message_handler.route_handler.handle_node_announcement(&msg)
1871 .map_err(|e| -> MessageHandlingError { e.into() })? {
1872 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1874 self.update_gossip_backlogged();
1876 wire::Message::ChannelUpdate(msg) => {
1877 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1878 if self.message_handler.route_handler.handle_channel_update(&msg)
1879 .map_err(|e| -> MessageHandlingError { e.into() })? {
1880 should_forward = Some(wire::Message::ChannelUpdate(msg));
1882 self.update_gossip_backlogged();
1884 wire::Message::QueryShortChannelIds(msg) => {
1885 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1887 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1888 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1890 wire::Message::QueryChannelRange(msg) => {
1891 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1893 wire::Message::ReplyChannelRange(msg) => {
1894 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1898 wire::Message::OnionMessage(msg) => {
1899 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1902 // Unknown messages:
1903 wire::Message::Unknown(type_id) if message.is_even() => {
1904 log_debug!(logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1905 return Err(PeerHandleError { }.into());
1907 wire::Message::Unknown(type_id) => {
1908 log_trace!(logger, "Received unknown odd message of type {}, ignoring", type_id);
1910 wire::Message::Custom(custom) => {
1911 self.message_handler.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1917 fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1919 wire::Message::ChannelAnnouncement(ref msg) => {
1920 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1921 let encoded_msg = encode_msg!(msg);
1923 for (_, peer_mutex) in peers.iter() {
1924 let mut peer = peer_mutex.lock().unwrap();
1925 if !peer.handshake_complete() ||
1926 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1929 debug_assert!(peer.their_node_id.is_some());
1930 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1931 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1932 if peer.buffer_full_drop_gossip_broadcast() {
1933 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1936 if let Some((_, their_node_id)) = peer.their_node_id {
1937 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1941 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1944 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1947 wire::Message::NodeAnnouncement(ref msg) => {
1948 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1949 let encoded_msg = encode_msg!(msg);
1951 for (_, peer_mutex) in peers.iter() {
1952 let mut peer = peer_mutex.lock().unwrap();
1953 if !peer.handshake_complete() ||
1954 !peer.should_forward_node_announcement(msg.contents.node_id) {
1957 debug_assert!(peer.their_node_id.is_some());
1958 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1959 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1960 if peer.buffer_full_drop_gossip_broadcast() {
1961 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1964 if let Some((_, their_node_id)) = peer.their_node_id {
1965 if their_node_id == msg.contents.node_id {
1969 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1972 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1975 wire::Message::ChannelUpdate(ref msg) => {
1976 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1977 let encoded_msg = encode_msg!(msg);
1979 for (_, peer_mutex) in peers.iter() {
1980 let mut peer = peer_mutex.lock().unwrap();
1981 if !peer.handshake_complete() ||
1982 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1985 debug_assert!(peer.their_node_id.is_some());
1986 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1987 let logger = WithContext::from(&self.logger, peer.their_node_id.map(|p| p.0), None);
1988 if peer.buffer_full_drop_gossip_broadcast() {
1989 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1992 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1995 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1998 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
2002 /// Checks for any events generated by our handlers and processes them. Includes sending most
2003 /// response messages as well as messages generated by calls to handler functions directly (eg
2004 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
2006 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2009 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
2010 /// or one of the other clients provided in our language bindings.
2012 /// Note that if there are any other calls to this function waiting on lock(s) this may return
2013 /// without doing any work. All available events that need handling will be handled before the
2014 /// other calls return.
2016 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2017 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
2018 /// [`send_data`]: SocketDescriptor::send_data
2019 pub fn process_events(&self) {
2020 if self.event_processing_state.fetch_add(1, Ordering::AcqRel) > 0 {
2021 // If we're not the first event processor to get here, just return early, the increment
2022 // we just did will be treated as "go around again" at the end.
2027 self.update_gossip_backlogged();
2028 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2030 let mut peers_to_disconnect = new_hash_map();
2033 let peers_lock = self.peers.read().unwrap();
2035 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
2036 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
2038 let peers = &*peers_lock;
2039 macro_rules! get_peer_for_forwarding {
2040 ($node_id: expr) => {
2042 if peers_to_disconnect.get($node_id).is_some() {
2043 // If we've "disconnected" this peer, do not send to it.
2046 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
2047 match descriptor_opt {
2048 Some(descriptor) => match peers.get(&descriptor) {
2049 Some(peer_mutex) => {
2050 let peer_lock = peer_mutex.lock().unwrap();
2051 if !peer_lock.handshake_complete() {
2057 debug_assert!(false, "Inconsistent peers set state!");
2068 for event in events_generated.drain(..) {
2070 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
2071 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.common_fields.temporary_channel_id)), "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
2072 log_pubkey!(node_id),
2073 &msg.common_fields.temporary_channel_id);
2074 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2076 MessageSendEvent::SendAcceptChannelV2 { ref node_id, ref msg } => {
2077 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.common_fields.temporary_channel_id)), "Handling SendAcceptChannelV2 event in peer_handler for node {} for channel {}",
2078 log_pubkey!(node_id),
2079 &msg.common_fields.temporary_channel_id);
2080 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2082 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
2083 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.common_fields.temporary_channel_id)), "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
2084 log_pubkey!(node_id),
2085 &msg.common_fields.temporary_channel_id);
2086 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2088 MessageSendEvent::SendOpenChannelV2 { ref node_id, ref msg } => {
2089 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.common_fields.temporary_channel_id)), "Handling SendOpenChannelV2 event in peer_handler for node {} for channel {}",
2090 log_pubkey!(node_id),
2091 &msg.common_fields.temporary_channel_id);
2092 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2094 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
2095 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 {})",
2096 log_pubkey!(node_id),
2097 &msg.temporary_channel_id,
2098 ChannelId::v1_from_funding_txid(msg.funding_txid.as_byte_array(), msg.funding_output_index));
2099 // TODO: If the peer is gone we should generate a DiscardFunding event
2100 // indicating to the wallet that they should just throw away this funding transaction
2101 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2103 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
2104 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
2105 log_pubkey!(node_id),
2107 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2109 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
2110 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReady event in peer_handler for node {} for channel {}",
2111 log_pubkey!(node_id),
2113 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2115 MessageSendEvent::SendStfu { ref node_id, ref msg} => {
2116 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2117 log_debug!(logger, "Handling SendStfu event in peer_handler for node {} for channel {}",
2118 log_pubkey!(node_id),
2120 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2122 MessageSendEvent::SendSplice { ref node_id, ref msg} => {
2123 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2124 log_debug!(logger, "Handling SendSplice event in peer_handler for node {} for channel {}",
2125 log_pubkey!(node_id),
2127 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2129 MessageSendEvent::SendSpliceAck { ref node_id, ref msg} => {
2130 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2131 log_debug!(logger, "Handling SendSpliceAck event in peer_handler for node {} for channel {}",
2132 log_pubkey!(node_id),
2134 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2136 MessageSendEvent::SendSpliceLocked { ref node_id, ref msg} => {
2137 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2138 log_debug!(logger, "Handling SendSpliceLocked event in peer_handler for node {} for channel {}",
2139 log_pubkey!(node_id),
2141 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2143 MessageSendEvent::SendTxAddInput { ref node_id, ref msg } => {
2144 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddInput event in peer_handler for node {} for channel {}",
2145 log_pubkey!(node_id),
2147 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2149 MessageSendEvent::SendTxAddOutput { ref node_id, ref msg } => {
2150 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddOutput event in peer_handler for node {} for channel {}",
2151 log_pubkey!(node_id),
2153 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2155 MessageSendEvent::SendTxRemoveInput { ref node_id, ref msg } => {
2156 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveInput event in peer_handler for node {} for channel {}",
2157 log_pubkey!(node_id),
2159 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2161 MessageSendEvent::SendTxRemoveOutput { ref node_id, ref msg } => {
2162 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveOutput event in peer_handler for node {} for channel {}",
2163 log_pubkey!(node_id),
2165 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2167 MessageSendEvent::SendTxComplete { ref node_id, ref msg } => {
2168 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxComplete event in peer_handler for node {} for channel {}",
2169 log_pubkey!(node_id),
2171 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2173 MessageSendEvent::SendTxSignatures { ref node_id, ref msg } => {
2174 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxSignatures event in peer_handler for node {} for channel {}",
2175 log_pubkey!(node_id),
2177 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2179 MessageSendEvent::SendTxInitRbf { ref node_id, ref msg } => {
2180 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxInitRbf event in peer_handler for node {} for channel {}",
2181 log_pubkey!(node_id),
2183 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2185 MessageSendEvent::SendTxAckRbf { ref node_id, ref msg } => {
2186 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAckRbf event in peer_handler for node {} for channel {}",
2187 log_pubkey!(node_id),
2189 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2191 MessageSendEvent::SendTxAbort { ref node_id, ref msg } => {
2192 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAbort event in peer_handler for node {} for channel {}",
2193 log_pubkey!(node_id),
2195 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2197 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
2198 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
2199 log_pubkey!(node_id),
2201 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2203 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 } } => {
2204 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 {}",
2205 log_pubkey!(node_id),
2206 update_add_htlcs.len(),
2207 update_fulfill_htlcs.len(),
2208 update_fail_htlcs.len(),
2209 &commitment_signed.channel_id);
2210 let mut peer = get_peer_for_forwarding!(node_id);
2211 for msg in update_add_htlcs {
2212 self.enqueue_message(&mut *peer, msg);
2214 for msg in update_fulfill_htlcs {
2215 self.enqueue_message(&mut *peer, msg);
2217 for msg in update_fail_htlcs {
2218 self.enqueue_message(&mut *peer, msg);
2220 for msg in update_fail_malformed_htlcs {
2221 self.enqueue_message(&mut *peer, msg);
2223 if let &Some(ref msg) = update_fee {
2224 self.enqueue_message(&mut *peer, msg);
2226 self.enqueue_message(&mut *peer, commitment_signed);
2228 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2229 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
2230 log_pubkey!(node_id),
2232 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2234 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
2235 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
2236 log_pubkey!(node_id),
2238 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2240 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
2241 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling Shutdown event in peer_handler for node {} for channel {}",
2242 log_pubkey!(node_id),
2244 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2246 MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
2247 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
2248 log_pubkey!(node_id),
2250 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2252 MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
2253 log_debug!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
2254 log_pubkey!(node_id),
2255 msg.contents.short_channel_id);
2256 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2257 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
2259 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
2260 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
2261 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
2262 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2263 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
2266 if let Some(msg) = update_msg {
2267 match self.message_handler.route_handler.handle_channel_update(&msg) {
2268 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2269 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2274 MessageSendEvent::BroadcastChannelUpdate { msg } => {
2275 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for contents {:?}", msg.contents);
2276 match self.message_handler.route_handler.handle_channel_update(&msg) {
2277 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2278 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2282 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
2283 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
2284 match self.message_handler.route_handler.handle_node_announcement(&msg) {
2285 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2286 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
2290 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
2291 log_trace!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
2292 log_pubkey!(node_id), msg.contents.short_channel_id);
2293 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2295 MessageSendEvent::HandleError { node_id, action } => {
2296 let logger = WithContext::from(&self.logger, Some(node_id), None);
2298 msgs::ErrorAction::DisconnectPeer { msg } => {
2299 if let Some(msg) = msg.as_ref() {
2300 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2301 log_pubkey!(node_id), msg.data);
2303 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {}",
2304 log_pubkey!(node_id));
2306 // We do not have the peers write lock, so we just store that we're
2307 // about to disconnect the peer and do it after we finish
2308 // processing most messages.
2309 let msg = msg.map(|msg| wire::Message::<<<CMH as Deref>::Target as wire::CustomMessageReader>::CustomMessage>::Error(msg));
2310 peers_to_disconnect.insert(node_id, msg);
2312 msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
2313 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2314 log_pubkey!(node_id), msg.data);
2315 // We do not have the peers write lock, so we just store that we're
2316 // about to disconnect the peer and do it after we finish
2317 // processing most messages.
2318 peers_to_disconnect.insert(node_id, Some(wire::Message::Warning(msg)));
2320 msgs::ErrorAction::IgnoreAndLog(level) => {
2321 log_given_level!(logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2323 msgs::ErrorAction::IgnoreDuplicateGossip => {},
2324 msgs::ErrorAction::IgnoreError => {
2325 log_debug!(logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2327 msgs::ErrorAction::SendErrorMessage { ref msg } => {
2328 log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
2329 log_pubkey!(node_id),
2331 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2333 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
2334 log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
2335 log_pubkey!(node_id),
2337 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2341 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
2342 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2344 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
2345 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2347 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
2348 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={}",
2349 log_pubkey!(node_id),
2350 msg.short_channel_ids.len(),
2352 msg.number_of_blocks,
2354 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2356 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
2357 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2362 for (node_id, msg) in self.message_handler.custom_message_handler.get_and_clear_pending_msg() {
2363 if peers_to_disconnect.get(&node_id).is_some() { continue; }
2364 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
2367 for (descriptor, peer_mutex) in peers.iter() {
2368 let mut peer = peer_mutex.lock().unwrap();
2369 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2370 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
2373 if !peers_to_disconnect.is_empty() {
2374 let mut peers_lock = self.peers.write().unwrap();
2375 let peers = &mut *peers_lock;
2376 for (node_id, msg) in peers_to_disconnect.drain() {
2377 // Note that since we are holding the peers *write* lock we can
2378 // remove from node_id_to_descriptor immediately (as no other
2379 // thread can be holding the peer lock if we have the global write
2382 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2383 if let Some(mut descriptor) = descriptor_opt {
2384 if let Some(peer_mutex) = peers.remove(&descriptor) {
2385 let mut peer = peer_mutex.lock().unwrap();
2386 if let Some(msg) = msg {
2387 self.enqueue_message(&mut *peer, &msg);
2388 // This isn't guaranteed to work, but if there is enough free
2389 // room in the send buffer, put the error message there...
2390 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
2392 self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
2393 } else { debug_assert!(false, "Missing connection for peer"); }
2398 if self.event_processing_state.fetch_sub(1, Ordering::AcqRel) != 1 {
2399 // If another thread incremented the state while we were running we should go
2400 // around again, but only once.
2401 self.event_processing_state.store(1, Ordering::Release);
2408 /// Indicates that the given socket descriptor's connection is now closed.
2409 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
2410 self.disconnect_event_internal(descriptor);
2413 fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
2414 if !peer.handshake_complete() {
2415 log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
2416 descriptor.disconnect_socket();
2420 debug_assert!(peer.their_node_id.is_some());
2421 if let Some((node_id, _)) = peer.their_node_id {
2422 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Disconnecting peer with id {} due to {}", node_id, reason);
2423 self.message_handler.chan_handler.peer_disconnected(&node_id);
2424 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2426 descriptor.disconnect_socket();
2429 fn disconnect_event_internal(&self, descriptor: &Descriptor) {
2430 let mut peers = self.peers.write().unwrap();
2431 let peer_option = peers.remove(descriptor);
2434 // This is most likely a simple race condition where the user found that the socket
2435 // was disconnected, then we told the user to `disconnect_socket()`, then they
2436 // called this method. Either way we're disconnected, return.
2438 Some(peer_lock) => {
2439 let peer = peer_lock.lock().unwrap();
2440 if let Some((node_id, _)) = peer.their_node_id {
2441 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Handling disconnection of peer {}", log_pubkey!(node_id));
2442 let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2443 debug_assert!(removed.is_some(), "descriptor maps should be consistent");
2444 if !peer.handshake_complete() { return; }
2445 self.message_handler.chan_handler.peer_disconnected(&node_id);
2446 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2452 /// Disconnect a peer given its node id.
2454 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
2455 /// peer. Thus, be very careful about reentrancy issues.
2457 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
2458 pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
2459 let mut peers_lock = self.peers.write().unwrap();
2460 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
2461 let peer_opt = peers_lock.remove(&descriptor);
2462 if let Some(peer_mutex) = peer_opt {
2463 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
2464 } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
2468 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
2469 /// an indication that TCP sockets have stalled even if we weren't around to time them out
2470 /// using regular ping/pongs.
2471 pub fn disconnect_all_peers(&self) {
2472 let mut peers_lock = self.peers.write().unwrap();
2473 self.node_id_to_descriptor.lock().unwrap().clear();
2474 let peers = &mut *peers_lock;
2475 for (descriptor, peer_mutex) in peers.drain() {
2476 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2480 /// This is called when we're blocked on sending additional gossip messages until we receive a
2481 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2482 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2483 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2484 if peer.awaiting_pong_timer_tick_intervals == 0 {
2485 peer.awaiting_pong_timer_tick_intervals = -1;
2486 let ping = msgs::Ping {
2490 self.enqueue_message(peer, &ping);
2494 /// Send pings to each peer and disconnect those which did not respond to the last round of
2497 /// This may be called on any timescale you want, however, roughly once every ten seconds is
2498 /// preferred. The call rate determines both how often we send a ping to our peers and how much
2499 /// time they have to respond before we disconnect them.
2501 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2504 /// [`send_data`]: SocketDescriptor::send_data
2505 pub fn timer_tick_occurred(&self) {
2506 let mut descriptors_needing_disconnect = Vec::new();
2508 let peers_lock = self.peers.read().unwrap();
2510 self.update_gossip_backlogged();
2511 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2513 for (descriptor, peer_mutex) in peers_lock.iter() {
2514 let mut peer = peer_mutex.lock().unwrap();
2515 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2517 if !peer.handshake_complete() {
2518 // The peer needs to complete its handshake before we can exchange messages. We
2519 // give peers one timer tick to complete handshake, reusing
2520 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2521 // for handshake completion.
2522 if peer.awaiting_pong_timer_tick_intervals != 0 {
2523 descriptors_needing_disconnect.push(descriptor.clone());
2525 peer.awaiting_pong_timer_tick_intervals = 1;
2529 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2530 debug_assert!(peer.their_node_id.is_some());
2532 loop { // Used as a `goto` to skip writing a Ping message.
2533 if peer.awaiting_pong_timer_tick_intervals == -1 {
2534 // Magic value set in `maybe_send_extra_ping`.
2535 peer.awaiting_pong_timer_tick_intervals = 1;
2536 peer.received_message_since_timer_tick = false;
2540 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2541 || peer.awaiting_pong_timer_tick_intervals as u64 >
2542 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2544 descriptors_needing_disconnect.push(descriptor.clone());
2547 peer.received_message_since_timer_tick = false;
2549 if peer.awaiting_pong_timer_tick_intervals > 0 {
2550 peer.awaiting_pong_timer_tick_intervals += 1;
2554 peer.awaiting_pong_timer_tick_intervals = 1;
2555 let ping = msgs::Ping {
2559 self.enqueue_message(&mut *peer, &ping);
2562 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2566 if !descriptors_needing_disconnect.is_empty() {
2568 let mut peers_lock = self.peers.write().unwrap();
2569 for descriptor in descriptors_needing_disconnect {
2570 if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2571 let peer = peer_mutex.lock().unwrap();
2572 if let Some((node_id, _)) = peer.their_node_id {
2573 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2575 self.do_disconnect(descriptor, &*peer, "ping/handshake timeout");
2583 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2584 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2585 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2587 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (SocketAddress::MAX_LEN as u32 + 1) / 2;
2589 // ...by failing to compile if the number of addresses that would be half of a message is
2590 // smaller than 100:
2591 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2593 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2594 /// peers. Note that peers will likely ignore this message unless we have at least one public
2595 /// channel which has at least six confirmations on-chain.
2597 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2598 /// node to humans. They carry no in-protocol meaning.
2600 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2601 /// accepts incoming connections. These will be included in the node_announcement, publicly
2602 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2603 /// addresses should likely contain only Tor Onion addresses.
2605 /// Panics if `addresses` is absurdly large (more than 100).
2607 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2608 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<SocketAddress>) {
2609 if addresses.len() > 100 {
2610 panic!("More than half the message size was taken up by public addresses!");
2613 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2614 // addresses be sorted for future compatibility.
2615 addresses.sort_by_key(|addr| addr.get_id());
2617 let features = self.message_handler.chan_handler.provided_node_features()
2618 | self.message_handler.route_handler.provided_node_features()
2619 | self.message_handler.onion_message_handler.provided_node_features()
2620 | self.message_handler.custom_message_handler.provided_node_features();
2621 let announcement = msgs::UnsignedNodeAnnouncement {
2623 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2624 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2626 alias: NodeAlias(alias),
2628 excess_address_data: Vec::new(),
2629 excess_data: Vec::new(),
2631 let node_announce_sig = match self.node_signer.sign_gossip_message(
2632 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2636 log_error!(self.logger, "Failed to generate signature for node_announcement");
2641 let msg = msgs::NodeAnnouncement {
2642 signature: node_announce_sig,
2643 contents: announcement
2646 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2647 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2648 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2652 fn is_gossip_msg(type_id: u16) -> bool {
2654 msgs::ChannelAnnouncement::TYPE |
2655 msgs::ChannelUpdate::TYPE |
2656 msgs::NodeAnnouncement::TYPE |
2657 msgs::QueryChannelRange::TYPE |
2658 msgs::ReplyChannelRange::TYPE |
2659 msgs::QueryShortChannelIds::TYPE |
2660 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2667 use crate::sign::{NodeSigner, Recipient};
2670 use crate::ln::ChannelId;
2671 use crate::ln::features::{InitFeatures, NodeFeatures};
2672 use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2673 use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2674 use crate::ln::{msgs, wire};
2675 use crate::ln::msgs::{LightningError, SocketAddress};
2676 use crate::util::test_utils;
2678 use bitcoin::Network;
2679 use bitcoin::blockdata::constants::ChainHash;
2680 use bitcoin::secp256k1::{PublicKey, SecretKey};
2682 use crate::prelude::*;
2683 use crate::sync::{Arc, Mutex};
2684 use core::convert::Infallible;
2685 use core::sync::atomic::{AtomicBool, Ordering};
2688 struct FileDescriptor {
2690 outbound_data: Arc<Mutex<Vec<u8>>>,
2691 disconnect: Arc<AtomicBool>,
2693 impl PartialEq for FileDescriptor {
2694 fn eq(&self, other: &Self) -> bool {
2698 impl Eq for FileDescriptor { }
2699 impl core::hash::Hash for FileDescriptor {
2700 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2701 self.fd.hash(hasher)
2705 impl SocketDescriptor for FileDescriptor {
2706 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2707 self.outbound_data.lock().unwrap().extend_from_slice(data);
2711 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2714 struct PeerManagerCfg {
2715 chan_handler: test_utils::TestChannelMessageHandler,
2716 routing_handler: test_utils::TestRoutingMessageHandler,
2717 custom_handler: TestCustomMessageHandler,
2718 logger: test_utils::TestLogger,
2719 node_signer: test_utils::TestNodeSigner,
2722 struct TestCustomMessageHandler {
2723 features: InitFeatures,
2726 impl wire::CustomMessageReader for TestCustomMessageHandler {
2727 type CustomMessage = Infallible;
2728 fn read<R: io::Read>(&self, _: u16, _: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
2733 impl CustomMessageHandler for TestCustomMessageHandler {
2734 fn handle_custom_message(&self, _: Infallible, _: &PublicKey) -> Result<(), LightningError> {
2738 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
2740 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
2742 fn provided_init_features(&self, _: &PublicKey) -> InitFeatures {
2743 self.features.clone()
2747 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2748 let mut cfgs = Vec::new();
2749 for i in 0..peer_count {
2750 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2752 let mut feature_bits = vec![0u8; 33];
2753 feature_bits[32] = 0b00000001;
2754 InitFeatures::from_le_bytes(feature_bits)
2758 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2759 logger: test_utils::TestLogger::new(),
2760 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2761 custom_handler: TestCustomMessageHandler { features },
2762 node_signer: test_utils::TestNodeSigner::new(node_secret),
2770 fn create_feature_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2771 let mut cfgs = Vec::new();
2772 for i in 0..peer_count {
2773 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2775 let mut feature_bits = vec![0u8; 33 + i + 1];
2776 feature_bits[33 + i] = 0b00000001;
2777 InitFeatures::from_le_bytes(feature_bits)
2781 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2782 logger: test_utils::TestLogger::new(),
2783 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2784 custom_handler: TestCustomMessageHandler { features },
2785 node_signer: test_utils::TestNodeSigner::new(node_secret),
2793 fn create_chain_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2794 let mut cfgs = Vec::new();
2795 for i in 0..peer_count {
2796 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2797 let features = InitFeatures::from_le_bytes(vec![0u8; 33]);
2798 let network = ChainHash::from(&[i as u8; 32]);
2801 chan_handler: test_utils::TestChannelMessageHandler::new(network),
2802 logger: test_utils::TestLogger::new(),
2803 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2804 custom_handler: TestCustomMessageHandler { features },
2805 node_signer: test_utils::TestNodeSigner::new(node_secret),
2813 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>> {
2814 let mut peers = Vec::new();
2815 for i in 0..peer_count {
2816 let ephemeral_bytes = [i as u8; 32];
2817 let msg_handler = MessageHandler {
2818 chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler,
2819 onion_message_handler: IgnoringMessageHandler {}, custom_message_handler: &cfgs[i].custom_handler
2821 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, &cfgs[i].node_signer);
2828 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) {
2829 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2830 let mut fd_a = FileDescriptor {
2831 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2832 disconnect: Arc::new(AtomicBool::new(false)),
2834 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2835 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2836 let features_a = peer_a.init_features(&id_b);
2837 let features_b = peer_b.init_features(&id_a);
2838 let mut fd_b = FileDescriptor {
2839 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2840 disconnect: Arc::new(AtomicBool::new(false)),
2842 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2843 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2844 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2845 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2846 peer_a.process_events();
2848 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2849 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2851 peer_b.process_events();
2852 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2853 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2855 peer_a.process_events();
2856 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2857 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2859 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
2860 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
2861 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
2862 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
2863 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
2864 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
2865 (fd_a.clone(), fd_b.clone())
2869 #[cfg(feature = "std")]
2870 fn fuzz_threaded_connections() {
2871 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2872 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2873 // with our internal map consistency, and is a generally good smoke test of disconnection.
2874 let cfgs = Arc::new(create_peermgr_cfgs(2));
2875 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2876 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2878 let start_time = std::time::Instant::now();
2879 macro_rules! spawn_thread { ($id: expr) => { {
2880 let peers = Arc::clone(&peers);
2881 let cfgs = Arc::clone(&cfgs);
2882 std::thread::spawn(move || {
2884 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2885 let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2886 let mut fd_a = FileDescriptor {
2887 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2888 disconnect: Arc::new(AtomicBool::new(false)),
2890 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2891 let mut fd_b = FileDescriptor {
2892 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2893 disconnect: Arc::new(AtomicBool::new(false)),
2895 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2896 let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2897 peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2898 if peers[0].read_event(&mut fd_a, &initial_data).is_err() { break; }
2900 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2901 peers[0].process_events();
2902 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2903 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2904 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2906 peers[1].process_events();
2907 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2908 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2909 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2911 cfgs[0].chan_handler.pending_events.lock().unwrap()
2912 .push(crate::events::MessageSendEvent::SendShutdown {
2913 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2914 msg: msgs::Shutdown {
2915 channel_id: ChannelId::new_zero(),
2916 scriptpubkey: bitcoin::ScriptBuf::new(),
2919 cfgs[1].chan_handler.pending_events.lock().unwrap()
2920 .push(crate::events::MessageSendEvent::SendShutdown {
2921 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2922 msg: msgs::Shutdown {
2923 channel_id: ChannelId::new_zero(),
2924 scriptpubkey: bitcoin::ScriptBuf::new(),
2929 peers[0].timer_tick_occurred();
2930 peers[1].timer_tick_occurred();
2934 peers[0].socket_disconnected(&fd_a);
2935 peers[1].socket_disconnected(&fd_b);
2937 std::thread::sleep(std::time::Duration::from_micros(1));
2941 let thrd_a = spawn_thread!(1);
2942 let thrd_b = spawn_thread!(2);
2944 thrd_a.join().unwrap();
2945 thrd_b.join().unwrap();
2949 fn test_feature_incompatible_peers() {
2950 let cfgs = create_peermgr_cfgs(2);
2951 let incompatible_cfgs = create_feature_incompatible_peermgr_cfgs(2);
2953 let peers = create_network(2, &cfgs);
2954 let incompatible_peers = create_network(2, &incompatible_cfgs);
2955 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2956 for (peer_a, peer_b) in peer_pairs.iter() {
2957 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2958 let mut fd_a = FileDescriptor {
2959 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2960 disconnect: Arc::new(AtomicBool::new(false)),
2962 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2963 let mut fd_b = FileDescriptor {
2964 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2965 disconnect: Arc::new(AtomicBool::new(false)),
2967 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2968 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2969 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2970 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2971 peer_a.process_events();
2973 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2974 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2976 peer_b.process_events();
2977 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2979 // Should fail because of unknown required features
2980 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2985 fn test_chain_incompatible_peers() {
2986 let cfgs = create_peermgr_cfgs(2);
2987 let incompatible_cfgs = create_chain_incompatible_peermgr_cfgs(2);
2989 let peers = create_network(2, &cfgs);
2990 let incompatible_peers = create_network(2, &incompatible_cfgs);
2991 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2992 for (peer_a, peer_b) in peer_pairs.iter() {
2993 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2994 let mut fd_a = FileDescriptor {
2995 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2996 disconnect: Arc::new(AtomicBool::new(false)),
2998 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2999 let mut fd_b = FileDescriptor {
3000 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3001 disconnect: Arc::new(AtomicBool::new(false)),
3003 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
3004 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
3005 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
3006 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
3007 peer_a.process_events();
3009 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3010 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
3012 peer_b.process_events();
3013 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3015 // Should fail because of incompatible chains
3016 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
3021 fn test_disconnect_peer() {
3022 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
3023 // push a DisconnectPeer event to remove the node flagged by id
3024 let cfgs = create_peermgr_cfgs(2);
3025 let peers = create_network(2, &cfgs);
3026 establish_connection(&peers[0], &peers[1]);
3027 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3029 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
3030 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
3032 action: msgs::ErrorAction::DisconnectPeer { msg: None },
3035 peers[0].process_events();
3036 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3040 fn test_send_simple_msg() {
3041 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
3042 // push a message from one peer to another.
3043 let cfgs = create_peermgr_cfgs(2);
3044 let a_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
3045 let b_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
3046 let mut peers = create_network(2, &cfgs);
3047 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
3048 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3050 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
3052 let msg = msgs::Shutdown { channel_id: ChannelId::from_bytes([42; 32]), scriptpubkey: bitcoin::ScriptBuf::new() };
3053 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
3054 node_id: their_id, msg: msg.clone()
3056 peers[0].message_handler.chan_handler = &a_chan_handler;
3058 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
3059 peers[1].message_handler.chan_handler = &b_chan_handler;
3061 peers[0].process_events();
3063 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3064 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
3068 fn test_non_init_first_msg() {
3069 // Simple test of the first message received over a connection being something other than
3070 // Init. This results in an immediate disconnection, which previously included a spurious
3071 // peer_disconnected event handed to event handlers (which would panic in
3072 // `TestChannelMessageHandler` here).
3073 let cfgs = create_peermgr_cfgs(2);
3074 let peers = create_network(2, &cfgs);
3076 let mut fd_dup = FileDescriptor {
3077 fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
3078 disconnect: Arc::new(AtomicBool::new(false)),
3080 let addr_dup = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1003};
3081 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
3082 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
3084 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
3085 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
3086 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
3087 peers[0].process_events();
3089 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
3090 let (act_three, _) =
3091 dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
3092 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
3094 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
3095 let msg_bytes = dup_encryptor.encrypt_message(¬_init_msg);
3096 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
3100 fn test_disconnect_all_peer() {
3101 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
3102 // then calls disconnect_all_peers
3103 let cfgs = create_peermgr_cfgs(2);
3104 let peers = create_network(2, &cfgs);
3105 establish_connection(&peers[0], &peers[1]);
3106 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3108 peers[0].disconnect_all_peers();
3109 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3113 fn test_timer_tick_occurred() {
3114 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
3115 let cfgs = create_peermgr_cfgs(2);
3116 let peers = create_network(2, &cfgs);
3117 establish_connection(&peers[0], &peers[1]);
3118 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3120 // peers[0] awaiting_pong is set to true, but the Peer is still connected
3121 peers[0].timer_tick_occurred();
3122 peers[0].process_events();
3123 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3125 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
3126 peers[0].timer_tick_occurred();
3127 peers[0].process_events();
3128 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3132 fn test_do_attempt_write_data() {
3133 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
3134 let cfgs = create_peermgr_cfgs(2);
3135 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3136 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3137 let peers = create_network(2, &cfgs);
3139 // By calling establish_connect, we trigger do_attempt_write_data between
3140 // the peers. Previously this function would mistakenly enter an infinite loop
3141 // when there were more channel messages available than could fit into a peer's
3142 // buffer. This issue would now be detected by this test (because we use custom
3143 // RoutingMessageHandlers that intentionally return more channel messages
3144 // than can fit into a peer's buffer).
3145 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
3147 // Make each peer to read the messages that the other peer just wrote to them. Note that
3148 // due to the max-message-before-ping limits this may take a few iterations to complete.
3149 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
3150 peers[1].process_events();
3151 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3152 assert!(!a_read_data.is_empty());
3154 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
3155 peers[0].process_events();
3157 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3158 assert!(!b_read_data.is_empty());
3159 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
3161 peers[0].process_events();
3162 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
3165 // Check that each peer has received the expected number of channel updates and channel
3167 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3168 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3169 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3170 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3174 fn test_handshake_timeout() {
3175 // Tests that we time out a peer still waiting on handshake completion after a full timer
3177 let cfgs = create_peermgr_cfgs(2);
3178 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3179 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3180 let peers = create_network(2, &cfgs);
3182 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
3183 let mut fd_a = FileDescriptor {
3184 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3185 disconnect: Arc::new(AtomicBool::new(false)),
3187 let mut fd_b = FileDescriptor {
3188 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3189 disconnect: Arc::new(AtomicBool::new(false)),
3191 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
3192 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
3194 // If we get a single timer tick before completion, that's fine
3195 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3196 peers[0].timer_tick_occurred();
3197 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3199 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
3200 peers[0].process_events();
3201 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3202 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
3203 peers[1].process_events();
3205 // ...but if we get a second timer tick, we should disconnect the peer
3206 peers[0].timer_tick_occurred();
3207 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3209 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3210 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
3214 fn test_filter_addresses(){
3215 // Tests the filter_addresses function.
3218 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 0, 0], port: 1000};
3219 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3220 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 255, 201], port: 1000};
3221 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3222 let ip_address = SocketAddress::TcpIpV4{addr: [10, 255, 255, 255], port: 1000};
3223 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3226 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 0, 0], port: 1000};
3227 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3228 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 255, 187], port: 1000};
3229 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3230 let ip_address = SocketAddress::TcpIpV4{addr: [0, 255, 255, 255], port: 1000};
3231 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3234 let ip_address = SocketAddress::TcpIpV4{addr: [100, 64, 0, 0], port: 1000};
3235 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3236 let ip_address = SocketAddress::TcpIpV4{addr: [100, 78, 255, 0], port: 1000};
3237 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3238 let ip_address = SocketAddress::TcpIpV4{addr: [100, 127, 255, 255], port: 1000};
3239 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3242 let ip_address = SocketAddress::TcpIpV4{addr: [127, 0, 0, 0], port: 1000};
3243 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3244 let ip_address = SocketAddress::TcpIpV4{addr: [127, 65, 73, 0], port: 1000};
3245 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3246 let ip_address = SocketAddress::TcpIpV4{addr: [127, 255, 255, 255], port: 1000};
3247 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3250 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 0, 0], port: 1000};
3251 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3252 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 221, 101], port: 1000};
3253 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3254 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 255, 255], port: 1000};
3255 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3258 let ip_address = SocketAddress::TcpIpV4{addr: [172, 16, 0, 0], port: 1000};
3259 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3260 let ip_address = SocketAddress::TcpIpV4{addr: [172, 27, 101, 23], port: 1000};
3261 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3262 let ip_address = SocketAddress::TcpIpV4{addr: [172, 31, 255, 255], port: 1000};
3263 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3266 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 0, 0], port: 1000};
3267 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3268 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 205, 159], port: 1000};
3269 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3270 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 255, 255], port: 1000};
3271 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3273 // For (192.88.99/24)
3274 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 0], port: 1000};
3275 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3276 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 140], port: 1000};
3277 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3278 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 255], port: 1000};
3279 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3281 // For other IPv4 addresses
3282 let ip_address = SocketAddress::TcpIpV4{addr: [188, 255, 99, 0], port: 1000};
3283 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3284 let ip_address = SocketAddress::TcpIpV4{addr: [123, 8, 129, 14], port: 1000};
3285 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3286 let ip_address = SocketAddress::TcpIpV4{addr: [2, 88, 9, 255], port: 1000};
3287 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3290 let ip_address = SocketAddress::TcpIpV6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
3291 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3292 let ip_address = SocketAddress::TcpIpV6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
3293 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3294 let ip_address = SocketAddress::TcpIpV6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
3295 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3297 // For other IPv6 addresses
3298 let ip_address = SocketAddress::TcpIpV6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
3299 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3300 let ip_address = SocketAddress::TcpIpV6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
3301 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3302 let ip_address = SocketAddress::TcpIpV6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
3303 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3306 assert_eq!(filter_addresses(None), None);
3310 #[cfg(feature = "std")]
3311 fn test_process_events_multithreaded() {
3312 use std::time::{Duration, Instant};
3313 // Test that `process_events` getting called on multiple threads doesn't generate too many
3315 // Each time `process_events` goes around the loop we call
3316 // `get_and_clear_pending_msg_events`, which we count using the `TestMessageHandler`.
3317 // Because the loop should go around once more after a call which fails to take the
3318 // single-threaded lock, if we write zero to the counter before calling `process_events` we
3319 // should never observe there having been more than 2 loop iterations.
3320 // Further, because the last thread to exit will call `process_events` before returning, we
3321 // should always have at least one count at the end.
3322 let cfg = Arc::new(create_peermgr_cfgs(1));
3323 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
3324 let peer = Arc::new(create_network(1, unsafe { &*(&*cfg as *const _) as &'static _ }).pop().unwrap());
3326 let exit_flag = Arc::new(AtomicBool::new(false));
3327 macro_rules! spawn_thread { () => { {
3328 let thread_cfg = Arc::clone(&cfg);
3329 let thread_peer = Arc::clone(&peer);
3330 let thread_exit = Arc::clone(&exit_flag);
3331 std::thread::spawn(move || {
3332 while !thread_exit.load(Ordering::Acquire) {
3333 thread_cfg[0].chan_handler.message_fetch_counter.store(0, Ordering::Release);
3334 thread_peer.process_events();
3335 std::thread::sleep(Duration::from_micros(1));
3340 let thread_a = spawn_thread!();
3341 let thread_b = spawn_thread!();
3342 let thread_c = spawn_thread!();
3344 let start_time = Instant::now();
3345 while start_time.elapsed() < Duration::from_millis(100) {
3346 let val = cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire);
3348 std::thread::yield_now(); // Winblowz seemingly doesn't ever interrupt threads?!
3351 exit_flag.store(true, Ordering::Release);
3352 thread_a.join().unwrap();
3353 thread_b.join().unwrap();
3354 thread_c.join().unwrap();
3355 assert!(cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire) >= 1);