1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Top level peer message handling and socket handling logic lives here.
12 //! Instead of actually servicing sockets ourselves we require that you implement the
13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
15 //! call into the provided message handlers (probably a ChannelManager and P2PGossipSync) with
16 //! messages they should handle, and encoding/sending response messages.
18 use bitcoin::blockdata::constants::ChainHash;
19 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
21 use crate::sign::{KeysManager, NodeSigner, Recipient};
22 use crate::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
23 use crate::ln::ChannelId;
24 use crate::ln::features::{InitFeatures, NodeFeatures};
26 use crate::ln::msgs::{ChannelMessageHandler, LightningError, SocketAddress, OnionMessageHandler, RoutingMessageHandler};
27 #[cfg(not(c_bindings))]
28 use crate::ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
29 use crate::util::ser::{VecWriter, Writeable, Writer};
30 use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor, NextNoiseStep, MessageBuf, MSG_BUF_ALLOC_SIZE};
32 use crate::ln::wire::{Encode, Type};
33 #[cfg(not(c_bindings))]
34 use crate::onion_message::{SimpleArcOnionMessenger, SimpleRefOnionMessenger};
35 use crate::onion_message::{CustomOnionMessageHandler, OffersMessage, OffersMessageHandler, OnionMessageContents, PendingOnionMessage};
36 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, NodeAlias};
37 use crate::util::atomic_counter::AtomicCounter;
38 use crate::util::logger::{Logger, WithContext};
39 use crate::util::string::PrintableString;
41 use crate::prelude::*;
43 use alloc::collections::VecDeque;
44 use crate::sync::{Arc, Mutex, MutexGuard, FairRwLock};
45 use core::sync::atomic::{AtomicBool, AtomicU32, AtomicI32, Ordering};
46 use core::{cmp, hash, fmt, mem};
48 use core::convert::Infallible;
49 #[cfg(feature = "std")] use std::error;
51 use bitcoin::hashes::sha256::Hash as Sha256;
52 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
53 use bitcoin::hashes::{HashEngine, Hash};
55 /// A handler provided to [`PeerManager`] for reading and handling custom messages.
57 /// [BOLT 1] specifies a custom message type range for use with experimental or application-specific
58 /// messages. `CustomMessageHandler` allows for user-defined handling of such types. See the
59 /// [`lightning_custom_message`] crate for tools useful in composing more than one custom handler.
61 /// [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
62 /// [`lightning_custom_message`]: https://docs.rs/lightning_custom_message/latest/lightning_custom_message
63 pub trait CustomMessageHandler: wire::CustomMessageReader {
64 /// Handles the given message sent from `sender_node_id`, possibly producing messages for
65 /// [`CustomMessageHandler::get_and_clear_pending_msg`] to return and thus for [`PeerManager`]
67 fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
69 /// Returns the list of pending messages that were generated by the handler, clearing the list
70 /// in the process. Each message is paired with the node id of the intended recipient. If no
71 /// connection to the node exists, then the message is simply not sent.
72 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
74 /// Gets the node feature flags which this handler itself supports. All available handlers are
75 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
76 /// which are broadcasted in our [`NodeAnnouncement`] message.
78 /// [`NodeAnnouncement`]: crate::ln::msgs::NodeAnnouncement
79 fn provided_node_features(&self) -> NodeFeatures;
81 /// Gets the init feature flags which should be sent to the given peer. All available handlers
82 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
83 /// which are sent in our [`Init`] message.
85 /// [`Init`]: crate::ln::msgs::Init
86 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
89 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
90 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
91 pub struct IgnoringMessageHandler{}
92 impl EventsProvider for IgnoringMessageHandler {
93 fn process_pending_events<H: Deref>(&self, _handler: H) where H::Target: EventHandler {}
95 impl MessageSendEventsProvider for IgnoringMessageHandler {
96 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
98 impl RoutingMessageHandler for IgnoringMessageHandler {
99 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
100 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
101 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
102 fn get_next_channel_announcement(&self, _starting_point: u64) ->
103 Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { None }
104 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> { None }
105 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
106 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
107 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
108 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
109 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
110 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
111 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
112 InitFeatures::empty()
114 fn processing_queue_high(&self) -> bool { false }
116 impl OnionMessageHandler for IgnoringMessageHandler {
117 fn handle_onion_message(&self, _their_node_id: &PublicKey, _msg: &msgs::OnionMessage) {}
118 fn next_onion_message_for_peer(&self, _peer_node_id: PublicKey) -> Option<msgs::OnionMessage> { None }
119 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
120 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
121 fn timer_tick_occurred(&self) {}
122 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
123 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
124 InitFeatures::empty()
127 impl OffersMessageHandler for IgnoringMessageHandler {
128 fn handle_message(&self, _msg: OffersMessage) -> Option<OffersMessage> { None }
130 impl CustomOnionMessageHandler for IgnoringMessageHandler {
131 type CustomMessage = Infallible;
132 fn handle_custom_message(&self, _msg: Infallible) -> Option<Infallible> {
133 // Since we always return `None` in the read the handle method should never be called.
136 fn read_custom_message<R: io::Read>(&self, _msg_type: u64, _buffer: &mut R) -> Result<Option<Infallible>, msgs::DecodeError> where Self: Sized {
139 fn release_pending_custom_messages(&self) -> Vec<PendingOnionMessage<Infallible>> {
144 impl OnionMessageContents for Infallible {
145 fn tlv_type(&self) -> u64 { unreachable!(); }
148 impl Deref for IgnoringMessageHandler {
149 type Target = IgnoringMessageHandler;
150 fn deref(&self) -> &Self { self }
153 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
154 // method that takes self for it.
155 impl wire::Type for Infallible {
156 fn type_id(&self) -> u16 {
160 impl Writeable for Infallible {
161 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
166 impl wire::CustomMessageReader for IgnoringMessageHandler {
167 type CustomMessage = Infallible;
168 fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
173 impl CustomMessageHandler for IgnoringMessageHandler {
174 fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
175 // Since we always return `None` in the read the handle method should never be called.
179 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
181 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
183 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
184 InitFeatures::empty()
188 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
189 /// You can provide one of these as the route_handler in a MessageHandler.
190 pub struct ErroringMessageHandler {
191 message_queue: Mutex<Vec<MessageSendEvent>>
193 impl ErroringMessageHandler {
194 /// Constructs a new ErroringMessageHandler
195 pub fn new() -> Self {
196 Self { message_queue: Mutex::new(Vec::new()) }
198 fn push_error(&self, node_id: &PublicKey, channel_id: ChannelId) {
199 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
200 action: msgs::ErrorAction::SendErrorMessage {
201 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
203 node_id: node_id.clone(),
207 impl MessageSendEventsProvider for ErroringMessageHandler {
208 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
209 let mut res = Vec::new();
210 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
214 impl ChannelMessageHandler for ErroringMessageHandler {
215 // Any messages which are related to a specific channel generate an error message to let the
216 // peer know we don't care about channels.
217 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
218 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
220 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
221 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
223 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
224 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
226 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
227 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
229 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
230 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
232 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
233 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
235 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
236 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
238 fn handle_stfu(&self, their_node_id: &PublicKey, msg: &msgs::Stfu) {
239 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
241 fn handle_splice(&self, their_node_id: &PublicKey, msg: &msgs::Splice) {
242 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
244 fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
245 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
247 fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
248 ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
250 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
251 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
253 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
254 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
256 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
257 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
259 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
260 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
262 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
263 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
265 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
266 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
268 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
269 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
271 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
272 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
274 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
275 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
277 // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
278 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
279 fn peer_disconnected(&self, _their_node_id: &PublicKey) {}
280 fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
281 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
282 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
283 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures {
284 // Set a number of features which various nodes may require to talk to us. It's totally
285 // reasonable to indicate we "support" all kinds of channel features...we just reject all
287 let mut features = InitFeatures::empty();
288 features.set_data_loss_protect_optional();
289 features.set_upfront_shutdown_script_optional();
290 features.set_variable_length_onion_optional();
291 features.set_static_remote_key_optional();
292 features.set_payment_secret_optional();
293 features.set_basic_mpp_optional();
294 features.set_wumbo_optional();
295 features.set_shutdown_any_segwit_optional();
296 features.set_channel_type_optional();
297 features.set_scid_privacy_optional();
298 features.set_zero_conf_optional();
302 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
303 // We don't enforce any chains upon peer connection for `ErroringMessageHandler` and leave it up
304 // to users of `ErroringMessageHandler` to make decisions on network compatiblility.
305 // There's not really any way to pull in specific networks here, and hardcoding can cause breakages.
309 fn handle_open_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
310 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
313 fn handle_accept_channel_v2(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
314 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
317 fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
318 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
321 fn handle_tx_add_output(&self, their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
322 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
325 fn handle_tx_remove_input(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
326 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
329 fn handle_tx_remove_output(&self, their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
330 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
333 fn handle_tx_complete(&self, their_node_id: &PublicKey, msg: &msgs::TxComplete) {
334 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
337 fn handle_tx_signatures(&self, their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
338 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
341 fn handle_tx_init_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
342 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
345 fn handle_tx_ack_rbf(&self, their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
346 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
349 fn handle_tx_abort(&self, their_node_id: &PublicKey, msg: &msgs::TxAbort) {
350 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
354 impl Deref for ErroringMessageHandler {
355 type Target = ErroringMessageHandler;
356 fn deref(&self) -> &Self { self }
359 /// Provides references to trait impls which handle different types of messages.
360 pub struct MessageHandler<CM: Deref, RM: Deref, OM: Deref, CustomM: Deref> where
361 CM::Target: ChannelMessageHandler,
362 RM::Target: RoutingMessageHandler,
363 OM::Target: OnionMessageHandler,
364 CustomM::Target: CustomMessageHandler,
366 /// A message handler which handles messages specific to channels. Usually this is just a
367 /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
369 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
370 pub chan_handler: CM,
371 /// A message handler which handles messages updating our knowledge of the network channel
372 /// graph. Usually this is just a [`P2PGossipSync`] object or an [`IgnoringMessageHandler`].
374 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
375 pub route_handler: RM,
377 /// A message handler which handles onion messages. This should generally be an
378 /// [`OnionMessenger`], but can also be an [`IgnoringMessageHandler`].
380 /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
381 pub onion_message_handler: OM,
383 /// A message handler which handles custom messages. The only LDK-provided implementation is
384 /// [`IgnoringMessageHandler`].
385 pub custom_message_handler: CustomM,
388 /// Provides an object which can be used to send data to and which uniquely identifies a connection
389 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
390 /// implement Hash to meet the PeerManager API.
392 /// For efficiency, [`Clone`] should be relatively cheap for this type.
394 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
395 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
396 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
397 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
398 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
399 /// to simply use another value which is guaranteed to be globally unique instead.
400 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
401 /// Attempts to send some data from the given slice to the peer.
403 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
404 /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
405 /// called and further write attempts may occur until that time.
407 /// If the returned size is smaller than `data.len()`, a
408 /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
409 /// written. Additionally, until a `send_data` event completes fully, no further
410 /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
411 /// prevent denial-of-service issues, you should not read or buffer any data from the socket
414 /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
415 /// (indicating that read events should be paused to prevent DoS in the send buffer),
416 /// `resume_read` may be set indicating that read events on this descriptor should resume. A
417 /// `resume_read` of false carries no meaning, and should not cause any action.
418 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
419 /// Disconnect the socket pointed to by this SocketDescriptor.
421 /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
422 /// call (doing so is a noop).
423 fn disconnect_socket(&mut self);
426 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
427 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
430 pub struct PeerHandleError { }
431 impl fmt::Debug for PeerHandleError {
432 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
433 formatter.write_str("Peer Sent Invalid Data")
436 impl fmt::Display for PeerHandleError {
437 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
438 formatter.write_str("Peer Sent Invalid Data")
442 #[cfg(feature = "std")]
443 impl error::Error for PeerHandleError {
444 fn description(&self) -> &str {
445 "Peer Sent Invalid Data"
449 enum InitSyncTracker{
451 ChannelsSyncing(u64),
452 NodesSyncing(NodeId),
455 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
456 /// forwarding gossip messages to peers altogether.
457 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
459 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
460 /// we have fewer than this many messages in the outbound buffer again.
461 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
462 /// refilled as we send bytes.
463 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 12;
464 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
466 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
468 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
469 /// the socket receive buffer before receiving the ping.
471 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
472 /// including any network delays, outbound traffic, or the same for messages from other peers.
474 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
475 /// per connected peer to respond to a ping, as long as they send us at least one message during
476 /// each tick, ensuring we aren't actually just disconnected.
477 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
480 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
481 /// two connected peers, assuming most LDK-running systems have at least two cores.
482 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
484 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
485 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
486 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
487 /// process before the next ping.
489 /// Note that we continue responding to other messages even after we've sent this many messages, so
490 /// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
491 /// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
492 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
495 channel_encryptor: PeerChannelEncryptor,
496 /// We cache a `NodeId` here to avoid serializing peers' keys every time we forward gossip
497 /// messages in `PeerManager`. Use `Peer::set_their_node_id` to modify this field.
498 their_node_id: Option<(PublicKey, NodeId)>,
499 /// The features provided in the peer's [`msgs::Init`] message.
501 /// This is set only after we've processed the [`msgs::Init`] message and called relevant
502 /// `peer_connected` handler methods. Thus, this field is set *iff* we've finished our
503 /// handshake and can talk to this peer normally (though use [`Peer::handshake_complete`] to
505 their_features: Option<InitFeatures>,
506 their_socket_address: Option<SocketAddress>,
508 pending_outbound_buffer: VecDeque<Vec<u8>>,
509 pending_outbound_buffer_first_msg_offset: usize,
510 /// Queue gossip broadcasts separately from `pending_outbound_buffer` so we can easily
511 /// prioritize channel messages over them.
513 /// Note that these messages are *not* encrypted/MAC'd, and are only serialized.
514 gossip_broadcast_buffer: VecDeque<MessageBuf>,
515 awaiting_write_event: bool,
517 pending_read_buffer: Vec<u8>,
518 pending_read_buffer_pos: usize,
519 pending_read_is_header: bool,
521 sync_status: InitSyncTracker,
523 msgs_sent_since_pong: usize,
524 awaiting_pong_timer_tick_intervals: i64,
525 received_message_since_timer_tick: bool,
526 sent_gossip_timestamp_filter: bool,
528 /// Indicates we've received a `channel_announcement` since the last time we had
529 /// [`PeerManager::gossip_processing_backlogged`] set (or, really, that we've received a
530 /// `channel_announcement` at all - we set this unconditionally but unset it every time we
531 /// check if we're gossip-processing-backlogged).
532 received_channel_announce_since_backlogged: bool,
534 inbound_connection: bool,
538 /// True after we've processed the [`msgs::Init`] message and called relevant `peer_connected`
539 /// handler methods. Thus, this implies we've finished our handshake and can talk to this peer
541 fn handshake_complete(&self) -> bool {
542 self.their_features.is_some()
545 /// Returns true if the channel announcements/updates for the given channel should be
546 /// forwarded to this peer.
547 /// If we are sending our routing table to this peer and we have not yet sent channel
548 /// announcements/updates for the given channel_id then we will send it when we get to that
549 /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
550 /// sent the old versions, we should send the update, and so return true here.
551 fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
552 if !self.handshake_complete() { return false; }
553 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
554 !self.sent_gossip_timestamp_filter {
557 match self.sync_status {
558 InitSyncTracker::NoSyncRequested => true,
559 InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
560 InitSyncTracker::NodesSyncing(_) => true,
564 /// Similar to the above, but for node announcements indexed by node_id.
565 fn should_forward_node_announcement(&self, node_id: NodeId) -> bool {
566 if !self.handshake_complete() { return false; }
567 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
568 !self.sent_gossip_timestamp_filter {
571 match self.sync_status {
572 InitSyncTracker::NoSyncRequested => true,
573 InitSyncTracker::ChannelsSyncing(_) => false,
574 InitSyncTracker::NodesSyncing(sync_node_id) => sync_node_id.as_slice() < node_id.as_slice(),
578 /// Returns whether we should be reading bytes from this peer, based on whether its outbound
579 /// buffer still has space and we don't need to pause reads to get some writes out.
580 fn should_read(&mut self, gossip_processing_backlogged: bool) -> bool {
581 if !gossip_processing_backlogged {
582 self.received_channel_announce_since_backlogged = false;
584 self.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE &&
585 (!gossip_processing_backlogged || !self.received_channel_announce_since_backlogged)
588 /// Determines if we should push additional gossip background sync (aka "backfill") onto a peer's
589 /// outbound buffer. This is checked every time the peer's buffer may have been drained.
590 fn should_buffer_gossip_backfill(&self) -> bool {
591 self.pending_outbound_buffer.is_empty() && self.gossip_broadcast_buffer.is_empty()
592 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
593 && self.handshake_complete()
596 /// Determines if we should push an onion message onto a peer's outbound buffer. This is checked
597 /// every time the peer's buffer may have been drained.
598 fn should_buffer_onion_message(&self) -> bool {
599 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
600 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
603 /// Determines if we should push additional gossip broadcast messages onto a peer's outbound
604 /// buffer. This is checked every time the peer's buffer may have been drained.
605 fn should_buffer_gossip_broadcast(&self) -> bool {
606 self.pending_outbound_buffer.is_empty() && self.handshake_complete()
607 && self.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK
610 /// Returns whether this peer's outbound buffers are full and we should drop gossip broadcasts.
611 fn buffer_full_drop_gossip_broadcast(&self) -> bool {
612 let total_outbound_buffered =
613 self.gossip_broadcast_buffer.len() + self.pending_outbound_buffer.len();
615 total_outbound_buffered > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP ||
616 self.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
619 fn set_their_node_id(&mut self, node_id: PublicKey) {
620 self.their_node_id = Some((node_id, NodeId::from_pubkey(&node_id)));
624 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
625 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
626 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
627 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
628 /// issues such as overly long function definitions.
630 /// This is not exported to bindings users as type aliases aren't supported in most languages.
631 #[cfg(not(c_bindings))]
632 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<
634 Arc<SimpleArcChannelManager<M, T, F, L>>,
635 Arc<P2PGossipSync<Arc<NetworkGraph<Arc<L>>>, C, Arc<L>>>,
636 Arc<SimpleArcOnionMessenger<M, T, F, L>>,
638 IgnoringMessageHandler,
642 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
643 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
644 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
645 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
646 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
647 /// helps with issues such as long function definitions.
649 /// This is not exported to bindings users as type aliases aren't supported in most languages.
650 #[cfg(not(c_bindings))]
651 pub type SimpleRefPeerManager<
652 'a, 'b, 'c, 'd, 'e, 'f, 'logger, 'h, 'i, 'j, 'graph, 'k, SD, M, T, F, C, L
655 &'j SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, M, T, F, L>,
656 &'f P2PGossipSync<&'graph NetworkGraph<&'logger L>, C, &'logger L>,
657 &'h SimpleRefOnionMessenger<'a, 'b, 'c, 'd, 'e, 'graph, 'logger, 'i, 'j, 'k, M, T, F, L>,
659 IgnoringMessageHandler,
664 /// A generic trait which is implemented for all [`PeerManager`]s. This makes bounding functions or
665 /// structs on any [`PeerManager`] much simpler as only this trait is needed as a bound, rather
666 /// than the full set of bounds on [`PeerManager`] itself.
668 /// This is not exported to bindings users as general cover traits aren't useful in other
670 #[allow(missing_docs)]
671 pub trait APeerManager {
672 type Descriptor: SocketDescriptor;
673 type CMT: ChannelMessageHandler + ?Sized;
674 type CM: Deref<Target=Self::CMT>;
675 type RMT: RoutingMessageHandler + ?Sized;
676 type RM: Deref<Target=Self::RMT>;
677 type OMT: OnionMessageHandler + ?Sized;
678 type OM: Deref<Target=Self::OMT>;
679 type LT: Logger + ?Sized;
680 type L: Deref<Target=Self::LT>;
681 type CMHT: CustomMessageHandler + ?Sized;
682 type CMH: Deref<Target=Self::CMHT>;
683 type NST: NodeSigner + ?Sized;
684 type NS: Deref<Target=Self::NST>;
685 /// Gets a reference to the underlying [`PeerManager`].
686 fn as_ref(&self) -> &PeerManager<Self::Descriptor, Self::CM, Self::RM, Self::OM, Self::L, Self::CMH, Self::NS>;
687 /// Returns the peer manager's [`OnionMessageHandler`].
688 fn onion_message_handler(&self) -> &Self::OMT;
691 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref>
692 APeerManager for PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
693 CM::Target: ChannelMessageHandler,
694 RM::Target: RoutingMessageHandler,
695 OM::Target: OnionMessageHandler,
697 CMH::Target: CustomMessageHandler,
698 NS::Target: NodeSigner,
700 type Descriptor = Descriptor;
701 type CMT = <CM as Deref>::Target;
703 type RMT = <RM as Deref>::Target;
705 type OMT = <OM as Deref>::Target;
707 type LT = <L as Deref>::Target;
709 type CMHT = <CMH as Deref>::Target;
711 type NST = <NS as Deref>::Target;
713 fn as_ref(&self) -> &PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> { self }
714 fn onion_message_handler(&self) -> &Self::OMT {
715 self.message_handler.onion_message_handler.deref()
719 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
720 /// socket events into messages which it passes on to its [`MessageHandler`].
722 /// Locks are taken internally, so you must never assume that reentrancy from a
723 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
725 /// Calls to [`read_event`] will decode relevant messages and pass them to the
726 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
727 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
728 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
729 /// calls only after previous ones have returned.
731 /// Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
732 /// a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
733 /// essentially you should default to using a [`SimpleRefPeerManager`], and use a
734 /// [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
735 /// you're using lightning-net-tokio.
737 /// [`read_event`]: PeerManager::read_event
738 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> where
739 CM::Target: ChannelMessageHandler,
740 RM::Target: RoutingMessageHandler,
741 OM::Target: OnionMessageHandler,
743 CMH::Target: CustomMessageHandler,
744 NS::Target: NodeSigner {
745 message_handler: MessageHandler<CM, RM, OM, CMH>,
746 /// Connection state for each connected peer - we have an outer read-write lock which is taken
747 /// as read while we're doing processing for a peer and taken write when a peer is being added
750 /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
751 /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
752 /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
753 /// the `MessageHandler`s for a given peer is already guaranteed.
754 peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
755 /// Only add to this set when noise completes.
756 /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
757 /// lock held. Entries may be added with only the `peers` read lock held (though the
758 /// `Descriptor` value must already exist in `peers`).
759 node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
760 /// We can only have one thread processing events at once, but if a second call to
761 /// `process_events` happens while a first call is in progress, one of the two calls needs to
762 /// start from the top to ensure any new messages are also handled.
764 /// Because the event handler calls into user code which may block, we don't want to block a
765 /// second thread waiting for another thread to handle events which is then blocked on user
766 /// code, so we store an atomic counter here:
767 /// * 0 indicates no event processor is running
768 /// * 1 indicates an event processor is running
769 /// * > 1 indicates an event processor is running but needs to start again from the top once
770 /// it finishes as another thread tried to start processing events but returned early.
771 event_processing_state: AtomicI32,
773 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
774 /// value increases strictly since we don't assume access to a time source.
775 last_node_announcement_serial: AtomicU32,
777 ephemeral_key_midstate: Sha256Engine,
779 peer_counter: AtomicCounter,
781 gossip_processing_backlogged: AtomicBool,
782 gossip_processing_backlog_lifted: AtomicBool,
787 secp_ctx: Secp256k1<secp256k1::SignOnly>
790 enum MessageHandlingError {
791 PeerHandleError(PeerHandleError),
792 LightningError(LightningError),
795 impl From<PeerHandleError> for MessageHandlingError {
796 fn from(error: PeerHandleError) -> Self {
797 MessageHandlingError::PeerHandleError(error)
801 impl From<LightningError> for MessageHandlingError {
802 fn from(error: LightningError) -> Self {
803 MessageHandlingError::LightningError(error)
807 macro_rules! encode_msg {
809 let mut buffer = VecWriter(Vec::with_capacity(MSG_BUF_ALLOC_SIZE));
810 wire::write($msg, &mut buffer).unwrap();
815 impl<Descriptor: SocketDescriptor, CM: Deref, OM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, OM, L, IgnoringMessageHandler, NS> where
816 CM::Target: ChannelMessageHandler,
817 OM::Target: OnionMessageHandler,
819 NS::Target: NodeSigner {
820 /// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
821 /// `OnionMessageHandler`. No routing message handler is used and network graph messages are
824 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
825 /// cryptographically secure random bytes.
827 /// `current_time` is used as an always-increasing counter that survives across restarts and is
828 /// incremented irregularly internally. In general it is best to simply use the current UNIX
829 /// timestamp, however if it is not available a persistent counter that increases once per
830 /// minute should suffice.
832 /// This is not exported to bindings users as we can't export a PeerManager with a dummy route handler
833 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 {
834 Self::new(MessageHandler {
835 chan_handler: channel_message_handler,
836 route_handler: IgnoringMessageHandler{},
837 onion_message_handler,
838 custom_message_handler: IgnoringMessageHandler{},
839 }, current_time, ephemeral_random_data, logger, node_signer)
843 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref, NS: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, IgnoringMessageHandler, L, IgnoringMessageHandler, NS> where
844 RM::Target: RoutingMessageHandler,
846 NS::Target: NodeSigner {
847 /// Constructs a new `PeerManager` with the given `RoutingMessageHandler`. No channel message
848 /// handler or onion message handler is used and onion and channel messages will be ignored (or
849 /// generate error messages). Note that some other lightning implementations time-out connections
850 /// after some time if no channel is built with the peer.
852 /// `current_time` is used as an always-increasing counter that survives across restarts and is
853 /// incremented irregularly internally. In general it is best to simply use the current UNIX
854 /// timestamp, however if it is not available a persistent counter that increases once per
855 /// minute should suffice.
857 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
858 /// cryptographically secure random bytes.
860 /// This is not exported to bindings users as we can't export a PeerManager with a dummy channel handler
861 pub fn new_routing_only(routing_message_handler: RM, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
862 Self::new(MessageHandler {
863 chan_handler: ErroringMessageHandler::new(),
864 route_handler: routing_message_handler,
865 onion_message_handler: IgnoringMessageHandler{},
866 custom_message_handler: IgnoringMessageHandler{},
867 }, current_time, ephemeral_random_data, logger, node_signer)
871 /// A simple wrapper that optionally prints ` from <pubkey>` for an optional pubkey.
872 /// This works around `format!()` taking a reference to each argument, preventing
873 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
874 /// due to lifetime errors.
875 struct OptionalFromDebugger<'a>(&'a Option<(PublicKey, NodeId)>);
876 impl core::fmt::Display for OptionalFromDebugger<'_> {
877 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
878 if let Some((node_id, _)) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
882 /// A function used to filter out local or private addresses
883 /// <https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml>
884 /// <https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml>
885 fn filter_addresses(ip_address: Option<SocketAddress>) -> Option<SocketAddress> {
887 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
888 Some(SocketAddress::TcpIpV4{addr: [10, _, _, _], port: _}) => None,
889 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
890 Some(SocketAddress::TcpIpV4{addr: [0, _, _, _], port: _}) => None,
891 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
892 Some(SocketAddress::TcpIpV4{addr: [100, 64..=127, _, _], port: _}) => None,
893 // For IPv4 range 127.0.0.0 - 127.255.255.255 (127/8)
894 Some(SocketAddress::TcpIpV4{addr: [127, _, _, _], port: _}) => None,
895 // For IPv4 range 169.254.0.0 - 169.254.255.255 (169.254/16)
896 Some(SocketAddress::TcpIpV4{addr: [169, 254, _, _], port: _}) => None,
897 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
898 Some(SocketAddress::TcpIpV4{addr: [172, 16..=31, _, _], port: _}) => None,
899 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
900 Some(SocketAddress::TcpIpV4{addr: [192, 168, _, _], port: _}) => None,
901 // For IPv4 range 192.88.99.0 - 192.88.99.255 (192.88.99/24)
902 Some(SocketAddress::TcpIpV4{addr: [192, 88, 99, _], port: _}) => None,
903 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
904 Some(SocketAddress::TcpIpV6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
905 // For remaining addresses
906 Some(SocketAddress::TcpIpV6{addr: _, port: _}) => None,
907 Some(..) => ip_address,
912 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CMH: Deref, NS: Deref> PeerManager<Descriptor, CM, RM, OM, L, CMH, NS> where
913 CM::Target: ChannelMessageHandler,
914 RM::Target: RoutingMessageHandler,
915 OM::Target: OnionMessageHandler,
917 CMH::Target: CustomMessageHandler,
918 NS::Target: NodeSigner
920 /// Constructs a new `PeerManager` with the given message handlers.
922 /// `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
923 /// cryptographically secure random bytes.
925 /// `current_time` is used as an always-increasing counter that survives across restarts and is
926 /// incremented irregularly internally. In general it is best to simply use the current UNIX
927 /// timestamp, however if it is not available a persistent counter that increases once per
928 /// minute should suffice.
929 pub fn new(message_handler: MessageHandler<CM, RM, OM, CMH>, current_time: u32, ephemeral_random_data: &[u8; 32], logger: L, node_signer: NS) -> Self {
930 let mut ephemeral_key_midstate = Sha256::engine();
931 ephemeral_key_midstate.input(ephemeral_random_data);
933 let mut secp_ctx = Secp256k1::signing_only();
934 let ephemeral_hash = Sha256::from_engine(ephemeral_key_midstate.clone()).to_byte_array();
935 secp_ctx.seeded_randomize(&ephemeral_hash);
939 peers: FairRwLock::new(HashMap::new()),
940 node_id_to_descriptor: Mutex::new(HashMap::new()),
941 event_processing_state: AtomicI32::new(0),
942 ephemeral_key_midstate,
943 peer_counter: AtomicCounter::new(),
944 gossip_processing_backlogged: AtomicBool::new(false),
945 gossip_processing_backlog_lifted: AtomicBool::new(false),
946 last_node_announcement_serial: AtomicU32::new(current_time),
953 /// Get a list of tuples mapping from node id to network addresses for peers which have
954 /// completed the initial handshake.
956 /// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
957 /// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
958 /// handshake has completed and we are sure the remote peer has the private key for the given
961 /// The returned `Option`s will only be `Some` if an address had been previously given via
962 /// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
963 pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
964 let peers = self.peers.read().unwrap();
965 peers.values().filter_map(|peer_mutex| {
966 let p = peer_mutex.lock().unwrap();
967 if !p.handshake_complete() {
970 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
974 fn get_ephemeral_key(&self) -> SecretKey {
975 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
976 let counter = self.peer_counter.get_increment();
977 ephemeral_hash.input(&counter.to_le_bytes());
978 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).to_byte_array()).expect("You broke SHA-256!")
981 fn init_features(&self, their_node_id: &PublicKey) -> InitFeatures {
982 self.message_handler.chan_handler.provided_init_features(their_node_id)
983 | self.message_handler.route_handler.provided_init_features(their_node_id)
984 | self.message_handler.onion_message_handler.provided_init_features(their_node_id)
985 | self.message_handler.custom_message_handler.provided_init_features(their_node_id)
988 /// Indicates a new outbound connection has been established to a node with the given `node_id`
989 /// and an optional remote network address.
991 /// The remote network address adds the option to report a remote IP address back to a connecting
992 /// peer using the init message.
993 /// The user should pass the remote network address of the host they are connected to.
995 /// If an `Err` is returned here you must disconnect the connection immediately.
997 /// Returns a small number of bytes to send to the remote node (currently always 50).
999 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1000 /// [`socket_disconnected`].
1002 /// [`socket_disconnected`]: PeerManager::socket_disconnected
1003 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<Vec<u8>, PeerHandleError> {
1004 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
1005 let res = peer_encryptor.get_act_one(&self.secp_ctx).to_vec();
1006 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
1008 let mut peers = self.peers.write().unwrap();
1009 match peers.entry(descriptor) {
1010 hash_map::Entry::Occupied(_) => {
1011 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1012 Err(PeerHandleError {})
1014 hash_map::Entry::Vacant(e) => {
1015 e.insert(Mutex::new(Peer {
1016 channel_encryptor: peer_encryptor,
1017 their_node_id: None,
1018 their_features: None,
1019 their_socket_address: remote_network_address,
1021 pending_outbound_buffer: VecDeque::new(),
1022 pending_outbound_buffer_first_msg_offset: 0,
1023 gossip_broadcast_buffer: VecDeque::new(),
1024 awaiting_write_event: false,
1026 pending_read_buffer,
1027 pending_read_buffer_pos: 0,
1028 pending_read_is_header: false,
1030 sync_status: InitSyncTracker::NoSyncRequested,
1032 msgs_sent_since_pong: 0,
1033 awaiting_pong_timer_tick_intervals: 0,
1034 received_message_since_timer_tick: false,
1035 sent_gossip_timestamp_filter: false,
1037 received_channel_announce_since_backlogged: false,
1038 inbound_connection: false,
1045 /// Indicates a new inbound connection has been established to a node with an optional remote
1046 /// network address.
1048 /// The remote network address adds the option to report a remote IP address back to a connecting
1049 /// peer using the init message.
1050 /// The user should pass the remote network address of the host they are connected to.
1052 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
1053 /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
1054 /// the connection immediately.
1056 /// Panics if descriptor is duplicative with some other descriptor which has not yet been
1057 /// [`socket_disconnected`].
1059 /// [`socket_disconnected`]: PeerManager::socket_disconnected
1060 pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<SocketAddress>) -> Result<(), PeerHandleError> {
1061 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.node_signer);
1062 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
1064 let mut peers = self.peers.write().unwrap();
1065 match peers.entry(descriptor) {
1066 hash_map::Entry::Occupied(_) => {
1067 debug_assert!(false, "PeerManager driver duplicated descriptors!");
1068 Err(PeerHandleError {})
1070 hash_map::Entry::Vacant(e) => {
1071 e.insert(Mutex::new(Peer {
1072 channel_encryptor: peer_encryptor,
1073 their_node_id: None,
1074 their_features: None,
1075 their_socket_address: remote_network_address,
1077 pending_outbound_buffer: VecDeque::new(),
1078 pending_outbound_buffer_first_msg_offset: 0,
1079 gossip_broadcast_buffer: VecDeque::new(),
1080 awaiting_write_event: false,
1082 pending_read_buffer,
1083 pending_read_buffer_pos: 0,
1084 pending_read_is_header: false,
1086 sync_status: InitSyncTracker::NoSyncRequested,
1088 msgs_sent_since_pong: 0,
1089 awaiting_pong_timer_tick_intervals: 0,
1090 received_message_since_timer_tick: false,
1091 sent_gossip_timestamp_filter: false,
1093 received_channel_announce_since_backlogged: false,
1094 inbound_connection: true,
1101 fn peer_should_read(&self, peer: &mut Peer) -> bool {
1102 peer.should_read(self.gossip_processing_backlogged.load(Ordering::Relaxed))
1105 fn update_gossip_backlogged(&self) {
1106 let new_state = self.message_handler.route_handler.processing_queue_high();
1107 let prev_state = self.gossip_processing_backlogged.swap(new_state, Ordering::Relaxed);
1108 if prev_state && !new_state {
1109 self.gossip_processing_backlog_lifted.store(true, Ordering::Relaxed);
1113 fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer, force_one_write: bool) {
1114 let mut have_written = false;
1115 while !peer.awaiting_write_event {
1116 if peer.should_buffer_onion_message() {
1117 if let Some((peer_node_id, _)) = peer.their_node_id {
1118 if let Some(next_onion_message) =
1119 self.message_handler.onion_message_handler.next_onion_message_for_peer(peer_node_id) {
1120 self.enqueue_message(peer, &next_onion_message);
1124 if peer.should_buffer_gossip_broadcast() {
1125 if let Some(msg) = peer.gossip_broadcast_buffer.pop_front() {
1126 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_buffer(msg));
1129 if peer.should_buffer_gossip_backfill() {
1130 match peer.sync_status {
1131 InitSyncTracker::NoSyncRequested => {},
1132 InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
1133 if let Some((announce, update_a_option, update_b_option)) =
1134 self.message_handler.route_handler.get_next_channel_announcement(c)
1136 self.enqueue_message(peer, &announce);
1137 if let Some(update_a) = update_a_option {
1138 self.enqueue_message(peer, &update_a);
1140 if let Some(update_b) = update_b_option {
1141 self.enqueue_message(peer, &update_b);
1143 peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
1145 peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
1148 InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
1149 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(None) {
1150 self.enqueue_message(peer, &msg);
1151 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1153 peer.sync_status = InitSyncTracker::NoSyncRequested;
1156 InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
1157 InitSyncTracker::NodesSyncing(sync_node_id) => {
1158 if let Some(msg) = self.message_handler.route_handler.get_next_node_announcement(Some(&sync_node_id)) {
1159 self.enqueue_message(peer, &msg);
1160 peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
1162 peer.sync_status = InitSyncTracker::NoSyncRequested;
1167 if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
1168 self.maybe_send_extra_ping(peer);
1171 let should_read = self.peer_should_read(peer);
1172 let next_buff = match peer.pending_outbound_buffer.front() {
1174 if force_one_write && !have_written {
1176 let data_sent = descriptor.send_data(&[], should_read);
1177 debug_assert_eq!(data_sent, 0, "Can't write more than no data");
1185 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
1186 let data_sent = descriptor.send_data(pending, should_read);
1187 have_written = true;
1188 peer.pending_outbound_buffer_first_msg_offset += data_sent;
1189 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() {
1190 peer.pending_outbound_buffer_first_msg_offset = 0;
1191 peer.pending_outbound_buffer.pop_front();
1192 const VEC_SIZE: usize = ::core::mem::size_of::<Vec<u8>>();
1193 let large_capacity = peer.pending_outbound_buffer.capacity() > 4096 / VEC_SIZE;
1194 let lots_of_slack = peer.pending_outbound_buffer.len()
1195 < peer.pending_outbound_buffer.capacity() / 2;
1196 if large_capacity && lots_of_slack {
1197 peer.pending_outbound_buffer.shrink_to_fit();
1200 peer.awaiting_write_event = true;
1205 /// Indicates that there is room to write data to the given socket descriptor.
1207 /// May return an Err to indicate that the connection should be closed.
1209 /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
1210 /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
1211 /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
1212 /// ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
1215 /// [`send_data`]: SocketDescriptor::send_data
1216 /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
1217 pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
1218 let peers = self.peers.read().unwrap();
1219 match peers.get(descriptor) {
1221 // This is most likely a simple race condition where the user found that the socket
1222 // was writeable, then we told the user to `disconnect_socket()`, then they called
1223 // this method. Return an error to make sure we get disconnected.
1224 return Err(PeerHandleError { });
1226 Some(peer_mutex) => {
1227 let mut peer = peer_mutex.lock().unwrap();
1228 peer.awaiting_write_event = false;
1229 self.do_attempt_write_data(descriptor, &mut peer, false);
1235 /// Indicates that data was read from the given socket descriptor.
1237 /// May return an Err to indicate that the connection should be closed.
1239 /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
1240 /// Thus, however, you should call [`process_events`] after any `read_event` to generate
1241 /// [`send_data`] calls to handle responses.
1243 /// If `Ok(true)` is returned, further read_events should not be triggered until a
1244 /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
1247 /// In order to avoid processing too many messages at once per peer, `data` should be on the
1250 /// [`send_data`]: SocketDescriptor::send_data
1251 /// [`process_events`]: PeerManager::process_events
1252 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1253 match self.do_read_event(peer_descriptor, data) {
1256 log_trace!(self.logger, "Disconnecting peer due to a protocol error (usually a duplicate connection).");
1257 self.disconnect_event_internal(peer_descriptor);
1263 /// Append a message to a peer's pending outbound/write buffer
1264 fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
1265 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1266 if is_gossip_msg(message.type_id()) {
1267 log_gossip!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0));
1269 log_trace!(logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap().0))
1271 peer.msgs_sent_since_pong += 1;
1272 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(message));
1275 /// Append a message to a peer's pending outbound/write gossip broadcast buffer
1276 fn enqueue_encoded_gossip_broadcast(&self, peer: &mut Peer, encoded_message: MessageBuf) {
1277 peer.msgs_sent_since_pong += 1;
1278 debug_assert!(peer.gossip_broadcast_buffer.len() <= OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP);
1279 peer.gossip_broadcast_buffer.push_back(encoded_message);
1282 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
1283 let mut pause_read = false;
1284 let peers = self.peers.read().unwrap();
1285 let mut msgs_to_forward = Vec::new();
1286 let mut peer_node_id = None;
1287 match peers.get(peer_descriptor) {
1289 // This is most likely a simple race condition where the user read some bytes
1290 // from the socket, then we told the user to `disconnect_socket()`, then they
1291 // called this method. Return an error to make sure we get disconnected.
1292 return Err(PeerHandleError { });
1294 Some(peer_mutex) => {
1295 let mut read_pos = 0;
1296 while read_pos < data.len() {
1297 macro_rules! try_potential_handleerror {
1298 ($peer: expr, $thing: expr) => {{
1300 let logger = WithContext::from(&self.logger, peer_node_id.map(|(id, _)| id), None);
1305 msgs::ErrorAction::DisconnectPeer { .. } => {
1306 // We may have an `ErrorMessage` to send to the peer,
1307 // but writing to the socket while reading can lead to
1308 // re-entrant code and possibly unexpected behavior. The
1309 // message send is optimistic anyway, and in this case
1310 // we immediately disconnect the peer.
1311 log_debug!(logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1312 return Err(PeerHandleError { });
1314 msgs::ErrorAction::DisconnectPeerWithWarning { .. } => {
1315 // We have a `WarningMessage` to send to the peer, but
1316 // writing to the socket while reading can lead to
1317 // re-entrant code and possibly unexpected behavior. The
1318 // message send is optimistic anyway, and in this case
1319 // we immediately disconnect the peer.
1320 log_debug!(logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1321 return Err(PeerHandleError { });
1323 msgs::ErrorAction::IgnoreAndLog(level) => {
1324 log_given_level!(logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1327 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
1328 msgs::ErrorAction::IgnoreError => {
1329 log_debug!(logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
1332 msgs::ErrorAction::SendErrorMessage { msg } => {
1333 log_debug!(logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1334 self.enqueue_message($peer, &msg);
1337 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
1338 log_given_level!(logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
1339 self.enqueue_message($peer, &msg);
1348 let mut peer_lock = peer_mutex.lock().unwrap();
1349 let peer = &mut *peer_lock;
1350 let mut msg_to_handle = None;
1351 if peer_node_id.is_none() {
1352 peer_node_id = peer.their_node_id.clone();
1355 assert!(peer.pending_read_buffer.len() > 0);
1356 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
1359 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
1360 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]);
1361 read_pos += data_to_copy;
1362 peer.pending_read_buffer_pos += data_to_copy;
1365 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
1366 peer.pending_read_buffer_pos = 0;
1368 macro_rules! insert_node_id {
1370 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1371 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap().0) {
1372 hash_map::Entry::Occupied(e) => {
1373 log_trace!(logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap().0));
1374 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
1375 // Check that the peers map is consistent with the
1376 // node_id_to_descriptor map, as this has been broken
1378 debug_assert!(peers.get(e.get()).is_some());
1379 return Err(PeerHandleError { })
1381 hash_map::Entry::Vacant(entry) => {
1382 log_debug!(logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap().0));
1383 entry.insert(peer_descriptor.clone())
1389 let next_step = peer.channel_encryptor.get_noise_step();
1391 NextNoiseStep::ActOne => {
1392 let act_two = try_potential_handleerror!(peer, peer.channel_encryptor
1393 .process_act_one_with_keys(&peer.pending_read_buffer[..],
1394 &self.node_signer, self.get_ephemeral_key(), &self.secp_ctx)).to_vec();
1395 peer.pending_outbound_buffer.push_back(act_two);
1396 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
1398 NextNoiseStep::ActTwo => {
1399 let (act_three, their_node_id) = try_potential_handleerror!(peer,
1400 peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..],
1401 &self.node_signer));
1402 peer.pending_outbound_buffer.push_back(act_three.to_vec());
1403 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1404 peer.pending_read_is_header = true;
1406 peer.set_their_node_id(their_node_id);
1408 let features = self.init_features(&their_node_id);
1409 let networks = self.message_handler.chan_handler.get_chain_hashes();
1410 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1411 self.enqueue_message(peer, &resp);
1412 peer.awaiting_pong_timer_tick_intervals = 0;
1414 NextNoiseStep::ActThree => {
1415 let their_node_id = try_potential_handleerror!(peer,
1416 peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
1417 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
1418 peer.pending_read_is_header = true;
1419 peer.set_their_node_id(their_node_id);
1421 let features = self.init_features(&their_node_id);
1422 let networks = self.message_handler.chan_handler.get_chain_hashes();
1423 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
1424 self.enqueue_message(peer, &resp);
1425 peer.awaiting_pong_timer_tick_intervals = 0;
1427 NextNoiseStep::NoiseComplete => {
1428 if peer.pending_read_is_header {
1429 let msg_len = try_potential_handleerror!(peer,
1430 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
1431 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1432 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
1433 if msg_len < 2 { // Need at least the message type tag
1434 return Err(PeerHandleError { });
1436 peer.pending_read_is_header = false;
1438 debug_assert!(peer.pending_read_buffer.len() >= 2 + 16);
1439 try_potential_handleerror!(peer,
1440 peer.channel_encryptor.decrypt_message(&mut peer.pending_read_buffer[..]));
1442 let mut reader = io::Cursor::new(&peer.pending_read_buffer[..peer.pending_read_buffer.len() - 16]);
1443 let message_result = wire::read(&mut reader, &*self.message_handler.custom_message_handler);
1445 // Reset read buffer
1446 if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
1447 peer.pending_read_buffer.resize(18, 0);
1448 peer.pending_read_is_header = true;
1450 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1451 let message = match message_result {
1455 // Note that to avoid re-entrancy we never call
1456 // `do_attempt_write_data` from here, causing
1457 // the messages enqueued here to not actually
1458 // be sent before the peer is disconnected.
1459 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1460 log_gossip!(logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1463 (msgs::DecodeError::UnsupportedCompression, _) => {
1464 log_gossip!(logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1465 self.enqueue_message(peer, &msgs::WarningMessage { channel_id: ChannelId::new_zero(), data: "Unsupported message compression: zlib".to_owned() });
1468 (_, Some(ty)) if is_gossip_msg(ty) => {
1469 log_gossip!(logger, "Got an invalid value while deserializing a gossip message");
1470 self.enqueue_message(peer, &msgs::WarningMessage {
1471 channel_id: ChannelId::new_zero(),
1472 data: format!("Unreadable/bogus gossip message of type {}", ty),
1476 (msgs::DecodeError::UnknownRequiredFeature, _) => {
1477 log_debug!(logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1478 return Err(PeerHandleError { });
1480 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { }),
1481 (msgs::DecodeError::InvalidValue, _) => {
1482 log_debug!(logger, "Got an invalid value while deserializing message");
1483 return Err(PeerHandleError { });
1485 (msgs::DecodeError::ShortRead, _) => {
1486 log_debug!(logger, "Deserialization failed due to shortness of message");
1487 return Err(PeerHandleError { });
1489 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { }),
1490 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { }),
1495 msg_to_handle = Some(message);
1500 pause_read = !self.peer_should_read(peer);
1502 if let Some(message) = msg_to_handle {
1503 match self.handle_message(&peer_mutex, peer_lock, message) {
1504 Err(handling_error) => match handling_error {
1505 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1506 MessageHandlingError::LightningError(e) => {
1507 try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1511 msgs_to_forward.push(msg);
1520 for msg in msgs_to_forward.drain(..) {
1521 self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref().map(|(pk, _)| pk));
1527 /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1528 /// Returns the message back if it needs to be broadcasted to all other peers.
1531 peer_mutex: &Mutex<Peer>,
1532 mut peer_lock: MutexGuard<Peer>,
1533 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1534 ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1535 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;
1536 let logger = WithContext::from(&self.logger, Some(their_node_id), None);
1537 peer_lock.received_message_since_timer_tick = true;
1539 // Need an Init as first message
1540 if let wire::Message::Init(msg) = message {
1541 // Check if we have any compatible chains if the `networks` field is specified.
1542 if let Some(networks) = &msg.networks {
1543 if let Some(our_chains) = self.message_handler.chan_handler.get_chain_hashes() {
1544 let mut have_compatible_chains = false;
1545 'our_chains: for our_chain in our_chains.iter() {
1546 for their_chain in networks {
1547 if our_chain == their_chain {
1548 have_compatible_chains = true;
1553 if !have_compatible_chains {
1554 log_debug!(logger, "Peer does not support any of our supported chains");
1555 return Err(PeerHandleError { }.into());
1560 let our_features = self.init_features(&their_node_id);
1561 if msg.features.requires_unknown_bits_from(&our_features) {
1562 log_debug!(logger, "Peer requires features unknown to us");
1563 return Err(PeerHandleError { }.into());
1566 if our_features.requires_unknown_bits_from(&msg.features) {
1567 log_debug!(logger, "We require features unknown to our peer");
1568 return Err(PeerHandleError { }.into());
1571 if peer_lock.their_features.is_some() {
1572 return Err(PeerHandleError { }.into());
1575 log_info!(logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1577 // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1578 if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1579 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1582 if let Err(()) = self.message_handler.route_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1583 log_debug!(logger, "Route Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1584 return Err(PeerHandleError { }.into());
1586 if let Err(()) = self.message_handler.chan_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1587 log_debug!(logger, "Channel Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1588 return Err(PeerHandleError { }.into());
1590 if let Err(()) = self.message_handler.onion_message_handler.peer_connected(&their_node_id, &msg, peer_lock.inbound_connection) {
1591 log_debug!(logger, "Onion Message Handler decided we couldn't communicate with peer {}", log_pubkey!(their_node_id));
1592 return Err(PeerHandleError { }.into());
1595 peer_lock.their_features = Some(msg.features);
1597 } else if peer_lock.their_features.is_none() {
1598 log_debug!(logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1599 return Err(PeerHandleError { }.into());
1602 if let wire::Message::GossipTimestampFilter(_msg) = message {
1603 // When supporting gossip messages, start inital gossip sync only after we receive
1604 // a GossipTimestampFilter
1605 if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1606 !peer_lock.sent_gossip_timestamp_filter {
1607 peer_lock.sent_gossip_timestamp_filter = true;
1608 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1613 if let wire::Message::ChannelAnnouncement(ref _msg) = message {
1614 peer_lock.received_channel_announce_since_backlogged = true;
1617 mem::drop(peer_lock);
1619 if is_gossip_msg(message.type_id()) {
1620 log_gossip!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1622 log_trace!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1625 let mut should_forward = None;
1628 // Setup and Control messages:
1629 wire::Message::Init(_) => {
1632 wire::Message::GossipTimestampFilter(_) => {
1635 wire::Message::Error(msg) => {
1636 log_debug!(logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1637 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1638 if msg.channel_id.is_zero() {
1639 return Err(PeerHandleError { }.into());
1642 wire::Message::Warning(msg) => {
1643 log_debug!(logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), PrintableString(&msg.data));
1646 wire::Message::Ping(msg) => {
1647 if msg.ponglen < 65532 {
1648 let resp = msgs::Pong { byteslen: msg.ponglen };
1649 self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1652 wire::Message::Pong(_msg) => {
1653 let mut peer_lock = peer_mutex.lock().unwrap();
1654 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1655 peer_lock.msgs_sent_since_pong = 0;
1658 // Channel messages:
1659 wire::Message::OpenChannel(msg) => {
1660 self.message_handler.chan_handler.handle_open_channel(&their_node_id, &msg);
1662 wire::Message::OpenChannelV2(msg) => {
1663 self.message_handler.chan_handler.handle_open_channel_v2(&their_node_id, &msg);
1665 wire::Message::AcceptChannel(msg) => {
1666 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, &msg);
1668 wire::Message::AcceptChannelV2(msg) => {
1669 self.message_handler.chan_handler.handle_accept_channel_v2(&their_node_id, &msg);
1672 wire::Message::FundingCreated(msg) => {
1673 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1675 wire::Message::FundingSigned(msg) => {
1676 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1678 wire::Message::ChannelReady(msg) => {
1679 self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
1682 // Quiescence messages:
1683 wire::Message::Stfu(msg) => {
1684 self.message_handler.chan_handler.handle_stfu(&their_node_id, &msg);
1687 // Splicing messages:
1688 wire::Message::Splice(msg) => {
1689 self.message_handler.chan_handler.handle_splice(&their_node_id, &msg);
1691 wire::Message::SpliceAck(msg) => {
1692 self.message_handler.chan_handler.handle_splice_ack(&their_node_id, &msg);
1694 wire::Message::SpliceLocked(msg) => {
1695 self.message_handler.chan_handler.handle_splice_locked(&their_node_id, &msg);
1698 // Interactive transaction construction messages:
1699 wire::Message::TxAddInput(msg) => {
1700 self.message_handler.chan_handler.handle_tx_add_input(&their_node_id, &msg);
1702 wire::Message::TxAddOutput(msg) => {
1703 self.message_handler.chan_handler.handle_tx_add_output(&their_node_id, &msg);
1705 wire::Message::TxRemoveInput(msg) => {
1706 self.message_handler.chan_handler.handle_tx_remove_input(&their_node_id, &msg);
1708 wire::Message::TxRemoveOutput(msg) => {
1709 self.message_handler.chan_handler.handle_tx_remove_output(&their_node_id, &msg);
1711 wire::Message::TxComplete(msg) => {
1712 self.message_handler.chan_handler.handle_tx_complete(&their_node_id, &msg);
1714 wire::Message::TxSignatures(msg) => {
1715 self.message_handler.chan_handler.handle_tx_signatures(&their_node_id, &msg);
1717 wire::Message::TxInitRbf(msg) => {
1718 self.message_handler.chan_handler.handle_tx_init_rbf(&their_node_id, &msg);
1720 wire::Message::TxAckRbf(msg) => {
1721 self.message_handler.chan_handler.handle_tx_ack_rbf(&their_node_id, &msg);
1723 wire::Message::TxAbort(msg) => {
1724 self.message_handler.chan_handler.handle_tx_abort(&their_node_id, &msg);
1727 wire::Message::Shutdown(msg) => {
1728 self.message_handler.chan_handler.handle_shutdown(&their_node_id, &msg);
1730 wire::Message::ClosingSigned(msg) => {
1731 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1734 // Commitment messages:
1735 wire::Message::UpdateAddHTLC(msg) => {
1736 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1738 wire::Message::UpdateFulfillHTLC(msg) => {
1739 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1741 wire::Message::UpdateFailHTLC(msg) => {
1742 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1744 wire::Message::UpdateFailMalformedHTLC(msg) => {
1745 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1748 wire::Message::CommitmentSigned(msg) => {
1749 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1751 wire::Message::RevokeAndACK(msg) => {
1752 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1754 wire::Message::UpdateFee(msg) => {
1755 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1757 wire::Message::ChannelReestablish(msg) => {
1758 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1761 // Routing messages:
1762 wire::Message::AnnouncementSignatures(msg) => {
1763 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1765 wire::Message::ChannelAnnouncement(msg) => {
1766 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1767 .map_err(|e| -> MessageHandlingError { e.into() })? {
1768 should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1770 self.update_gossip_backlogged();
1772 wire::Message::NodeAnnouncement(msg) => {
1773 if self.message_handler.route_handler.handle_node_announcement(&msg)
1774 .map_err(|e| -> MessageHandlingError { e.into() })? {
1775 should_forward = Some(wire::Message::NodeAnnouncement(msg));
1777 self.update_gossip_backlogged();
1779 wire::Message::ChannelUpdate(msg) => {
1780 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1781 if self.message_handler.route_handler.handle_channel_update(&msg)
1782 .map_err(|e| -> MessageHandlingError { e.into() })? {
1783 should_forward = Some(wire::Message::ChannelUpdate(msg));
1785 self.update_gossip_backlogged();
1787 wire::Message::QueryShortChannelIds(msg) => {
1788 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1790 wire::Message::ReplyShortChannelIdsEnd(msg) => {
1791 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1793 wire::Message::QueryChannelRange(msg) => {
1794 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1796 wire::Message::ReplyChannelRange(msg) => {
1797 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1801 wire::Message::OnionMessage(msg) => {
1802 self.message_handler.onion_message_handler.handle_onion_message(&their_node_id, &msg);
1805 // Unknown messages:
1806 wire::Message::Unknown(type_id) if message.is_even() => {
1807 log_debug!(logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1808 return Err(PeerHandleError { }.into());
1810 wire::Message::Unknown(type_id) => {
1811 log_trace!(logger, "Received unknown odd message of type {}, ignoring", type_id);
1813 wire::Message::Custom(custom) => {
1814 self.message_handler.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1820 fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1822 wire::Message::ChannelAnnouncement(ref msg) => {
1823 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1824 let encoded_msg = encode_msg!(msg);
1826 for (_, peer_mutex) in peers.iter() {
1827 let mut peer = peer_mutex.lock().unwrap();
1828 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1829 if !peer.handshake_complete() ||
1830 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1833 debug_assert!(peer.their_node_id.is_some());
1834 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1835 if peer.buffer_full_drop_gossip_broadcast() {
1836 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1839 if let Some((_, their_node_id)) = peer.their_node_id {
1840 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
1844 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1847 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1850 wire::Message::NodeAnnouncement(ref msg) => {
1851 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1852 let encoded_msg = encode_msg!(msg);
1854 for (_, peer_mutex) in peers.iter() {
1855 let mut peer = peer_mutex.lock().unwrap();
1856 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1857 if !peer.handshake_complete() ||
1858 !peer.should_forward_node_announcement(msg.contents.node_id) {
1861 debug_assert!(peer.their_node_id.is_some());
1862 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1863 if peer.buffer_full_drop_gossip_broadcast() {
1864 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1867 if let Some((_, their_node_id)) = peer.their_node_id {
1868 if their_node_id == msg.contents.node_id {
1872 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1875 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1878 wire::Message::ChannelUpdate(ref msg) => {
1879 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1880 let encoded_msg = encode_msg!(msg);
1882 for (_, peer_mutex) in peers.iter() {
1883 let mut peer = peer_mutex.lock().unwrap();
1884 let logger = WithContext::from(&self.logger, Some(peer.their_node_id.unwrap().0), None);
1885 if !peer.handshake_complete() ||
1886 !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1889 debug_assert!(peer.their_node_id.is_some());
1890 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
1891 if peer.buffer_full_drop_gossip_broadcast() {
1892 log_gossip!(logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1895 if except_node.is_some() && peer.their_node_id.as_ref().map(|(pk, _)| pk) == except_node {
1898 self.enqueue_encoded_gossip_broadcast(&mut *peer, MessageBuf::from_encoded(&encoded_msg));
1901 _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1905 /// Checks for any events generated by our handlers and processes them. Includes sending most
1906 /// response messages as well as messages generated by calls to handler functions directly (eg
1907 /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1909 /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1912 /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1913 /// or one of the other clients provided in our language bindings.
1915 /// Note that if there are any other calls to this function waiting on lock(s) this may return
1916 /// without doing any work. All available events that need handling will be handled before the
1917 /// other calls return.
1919 /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1920 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1921 /// [`send_data`]: SocketDescriptor::send_data
1922 pub fn process_events(&self) {
1923 if self.event_processing_state.fetch_add(1, Ordering::AcqRel) > 0 {
1924 // If we're not the first event processor to get here, just return early, the increment
1925 // we just did will be treated as "go around again" at the end.
1930 self.update_gossip_backlogged();
1931 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
1933 let mut peers_to_disconnect = HashMap::new();
1936 let peers_lock = self.peers.read().unwrap();
1938 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1939 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1941 let peers = &*peers_lock;
1942 macro_rules! get_peer_for_forwarding {
1943 ($node_id: expr) => {
1945 if peers_to_disconnect.get($node_id).is_some() {
1946 // If we've "disconnected" this peer, do not send to it.
1949 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1950 match descriptor_opt {
1951 Some(descriptor) => match peers.get(&descriptor) {
1952 Some(peer_mutex) => {
1953 let peer_lock = peer_mutex.lock().unwrap();
1954 if !peer_lock.handshake_complete() {
1960 debug_assert!(false, "Inconsistent peers set state!");
1971 for event in events_generated.drain(..) {
1973 MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1974 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1975 log_pubkey!(node_id),
1976 &msg.temporary_channel_id);
1977 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1979 MessageSendEvent::SendAcceptChannelV2 { ref node_id, ref msg } => {
1980 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendAcceptChannelV2 event in peer_handler for node {} for channel {}",
1981 log_pubkey!(node_id),
1982 &msg.temporary_channel_id);
1983 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1985 MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1986 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1987 log_pubkey!(node_id),
1988 &msg.temporary_channel_id);
1989 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1991 MessageSendEvent::SendOpenChannelV2 { ref node_id, ref msg } => {
1992 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.temporary_channel_id)), "Handling SendOpenChannelV2 event in peer_handler for node {} for channel {}",
1993 log_pubkey!(node_id),
1994 &msg.temporary_channel_id);
1995 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1997 MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1998 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 {})",
1999 log_pubkey!(node_id),
2000 &msg.temporary_channel_id,
2001 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
2002 // TODO: If the peer is gone we should generate a DiscardFunding event
2003 // indicating to the wallet that they should just throw away this funding transaction
2004 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2006 MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
2007 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
2008 log_pubkey!(node_id),
2010 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2012 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
2013 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReady event in peer_handler for node {} for channel {}",
2014 log_pubkey!(node_id),
2016 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2018 MessageSendEvent::SendStfu { ref node_id, ref msg} => {
2019 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2020 log_debug!(logger, "Handling SendStfu event in peer_handler for node {} for channel {}",
2021 log_pubkey!(node_id),
2023 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2025 MessageSendEvent::SendSplice { ref node_id, ref msg} => {
2026 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2027 log_debug!(logger, "Handling SendSplice event in peer_handler for node {} for channel {}",
2028 log_pubkey!(node_id),
2030 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2032 MessageSendEvent::SendSpliceAck { ref node_id, ref msg} => {
2033 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2034 log_debug!(logger, "Handling SendSpliceAck event in peer_handler for node {} for channel {}",
2035 log_pubkey!(node_id),
2037 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2039 MessageSendEvent::SendSpliceLocked { ref node_id, ref msg} => {
2040 let logger = WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id));
2041 log_debug!(logger, "Handling SendSpliceLocked event in peer_handler for node {} for channel {}",
2042 log_pubkey!(node_id),
2044 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2046 MessageSendEvent::SendTxAddInput { ref node_id, ref msg } => {
2047 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddInput event in peer_handler for node {} for channel {}",
2048 log_pubkey!(node_id),
2050 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2052 MessageSendEvent::SendTxAddOutput { ref node_id, ref msg } => {
2053 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAddOutput event in peer_handler for node {} for channel {}",
2054 log_pubkey!(node_id),
2056 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2058 MessageSendEvent::SendTxRemoveInput { ref node_id, ref msg } => {
2059 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveInput event in peer_handler for node {} for channel {}",
2060 log_pubkey!(node_id),
2062 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2064 MessageSendEvent::SendTxRemoveOutput { ref node_id, ref msg } => {
2065 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxRemoveOutput event in peer_handler for node {} for channel {}",
2066 log_pubkey!(node_id),
2068 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2070 MessageSendEvent::SendTxComplete { ref node_id, ref msg } => {
2071 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxComplete event in peer_handler for node {} for channel {}",
2072 log_pubkey!(node_id),
2074 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2076 MessageSendEvent::SendTxSignatures { ref node_id, ref msg } => {
2077 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxSignatures event in peer_handler for node {} for channel {}",
2078 log_pubkey!(node_id),
2080 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2082 MessageSendEvent::SendTxInitRbf { ref node_id, ref msg } => {
2083 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxInitRbf event in peer_handler for node {} for channel {}",
2084 log_pubkey!(node_id),
2086 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2088 MessageSendEvent::SendTxAckRbf { ref node_id, ref msg } => {
2089 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAckRbf event in peer_handler for node {} for channel {}",
2090 log_pubkey!(node_id),
2092 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2094 MessageSendEvent::SendTxAbort { ref node_id, ref msg } => {
2095 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendTxAbort event in peer_handler for node {} for channel {}",
2096 log_pubkey!(node_id),
2098 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2100 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
2101 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
2102 log_pubkey!(node_id),
2104 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2106 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 } } => {
2107 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 {}",
2108 log_pubkey!(node_id),
2109 update_add_htlcs.len(),
2110 update_fulfill_htlcs.len(),
2111 update_fail_htlcs.len(),
2112 &commitment_signed.channel_id);
2113 let mut peer = get_peer_for_forwarding!(node_id);
2114 for msg in update_add_htlcs {
2115 self.enqueue_message(&mut *peer, msg);
2117 for msg in update_fulfill_htlcs {
2118 self.enqueue_message(&mut *peer, msg);
2120 for msg in update_fail_htlcs {
2121 self.enqueue_message(&mut *peer, msg);
2123 for msg in update_fail_malformed_htlcs {
2124 self.enqueue_message(&mut *peer, msg);
2126 if let &Some(ref msg) = update_fee {
2127 self.enqueue_message(&mut *peer, msg);
2129 self.enqueue_message(&mut *peer, commitment_signed);
2131 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2132 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
2133 log_pubkey!(node_id),
2135 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2137 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
2138 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendClosingSigned 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::SendShutdown { ref node_id, ref msg } => {
2144 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling Shutdown 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::SendChannelReestablish { ref node_id, ref msg } => {
2150 log_debug!(WithContext::from(&self.logger, Some(*node_id), Some(msg.channel_id)), "Handling SendChannelReestablish 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::SendChannelAnnouncement { ref node_id, ref msg, ref update_msg } => {
2156 log_debug!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelAnnouncement event in peer_handler for node {} for short channel id {}",
2157 log_pubkey!(node_id),
2158 msg.contents.short_channel_id);
2159 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2160 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), update_msg);
2162 MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
2163 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
2164 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
2165 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2166 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
2169 if let Some(msg) = update_msg {
2170 match self.message_handler.route_handler.handle_channel_update(&msg) {
2171 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2172 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2177 MessageSendEvent::BroadcastChannelUpdate { msg } => {
2178 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for contents {:?}", msg.contents);
2179 match self.message_handler.route_handler.handle_channel_update(&msg) {
2180 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2181 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
2185 MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
2186 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler for node {}", msg.contents.node_id);
2187 match self.message_handler.route_handler.handle_node_announcement(&msg) {
2188 Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
2189 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
2193 MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
2194 log_trace!(WithContext::from(&self.logger, Some(*node_id), None), "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
2195 log_pubkey!(node_id), msg.contents.short_channel_id);
2196 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2198 MessageSendEvent::HandleError { node_id, action } => {
2199 let logger = WithContext::from(&self.logger, Some(node_id), None);
2201 msgs::ErrorAction::DisconnectPeer { msg } => {
2202 if let Some(msg) = msg.as_ref() {
2203 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2204 log_pubkey!(node_id), msg.data);
2206 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {}",
2207 log_pubkey!(node_id));
2209 // We do not have the peers write lock, so we just store that we're
2210 // about to disconenct the peer and do it after we finish
2211 // processing most messages.
2212 let msg = msg.map(|msg| wire::Message::<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>::Error(msg));
2213 peers_to_disconnect.insert(node_id, msg);
2215 msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
2216 log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
2217 log_pubkey!(node_id), msg.data);
2218 // We do not have the peers write lock, so we just store that we're
2219 // about to disconenct the peer and do it after we finish
2220 // processing most messages.
2221 peers_to_disconnect.insert(node_id, Some(wire::Message::Warning(msg)));
2223 msgs::ErrorAction::IgnoreAndLog(level) => {
2224 log_given_level!(logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2226 msgs::ErrorAction::IgnoreDuplicateGossip => {},
2227 msgs::ErrorAction::IgnoreError => {
2228 log_debug!(logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
2230 msgs::ErrorAction::SendErrorMessage { ref msg } => {
2231 log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
2232 log_pubkey!(node_id),
2234 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2236 msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
2237 log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
2238 log_pubkey!(node_id),
2240 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), msg);
2244 MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
2245 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2247 MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
2248 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2250 MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
2251 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={}",
2252 log_pubkey!(node_id),
2253 msg.short_channel_ids.len(),
2255 msg.number_of_blocks,
2257 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2259 MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
2260 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
2265 for (node_id, msg) in self.message_handler.custom_message_handler.get_and_clear_pending_msg() {
2266 if peers_to_disconnect.get(&node_id).is_some() { continue; }
2267 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
2270 for (descriptor, peer_mutex) in peers.iter() {
2271 let mut peer = peer_mutex.lock().unwrap();
2272 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2273 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer, flush_read_disabled);
2276 if !peers_to_disconnect.is_empty() {
2277 let mut peers_lock = self.peers.write().unwrap();
2278 let peers = &mut *peers_lock;
2279 for (node_id, msg) in peers_to_disconnect.drain() {
2280 // Note that since we are holding the peers *write* lock we can
2281 // remove from node_id_to_descriptor immediately (as no other
2282 // thread can be holding the peer lock if we have the global write
2285 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2286 if let Some(mut descriptor) = descriptor_opt {
2287 if let Some(peer_mutex) = peers.remove(&descriptor) {
2288 let mut peer = peer_mutex.lock().unwrap();
2289 if let Some(msg) = msg {
2290 self.enqueue_message(&mut *peer, &msg);
2291 // This isn't guaranteed to work, but if there is enough free
2292 // room in the send buffer, put the error message there...
2293 self.do_attempt_write_data(&mut descriptor, &mut *peer, false);
2295 self.do_disconnect(descriptor, &*peer, "DisconnectPeer HandleError");
2296 } else { debug_assert!(false, "Missing connection for peer"); }
2301 if self.event_processing_state.fetch_sub(1, Ordering::AcqRel) != 1 {
2302 // If another thread incremented the state while we were running we should go
2303 // around again, but only once.
2304 self.event_processing_state.store(1, Ordering::Release);
2311 /// Indicates that the given socket descriptor's connection is now closed.
2312 pub fn socket_disconnected(&self, descriptor: &Descriptor) {
2313 self.disconnect_event_internal(descriptor);
2316 fn do_disconnect(&self, mut descriptor: Descriptor, peer: &Peer, reason: &'static str) {
2317 if !peer.handshake_complete() {
2318 log_trace!(self.logger, "Disconnecting peer which hasn't completed handshake due to {}", reason);
2319 descriptor.disconnect_socket();
2323 debug_assert!(peer.their_node_id.is_some());
2324 if let Some((node_id, _)) = peer.their_node_id {
2325 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Disconnecting peer with id {} due to {}", node_id, reason);
2326 self.message_handler.chan_handler.peer_disconnected(&node_id);
2327 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2329 descriptor.disconnect_socket();
2332 fn disconnect_event_internal(&self, descriptor: &Descriptor) {
2333 let mut peers = self.peers.write().unwrap();
2334 let peer_option = peers.remove(descriptor);
2337 // This is most likely a simple race condition where the user found that the socket
2338 // was disconnected, then we told the user to `disconnect_socket()`, then they
2339 // called this method. Either way we're disconnected, return.
2341 Some(peer_lock) => {
2342 let peer = peer_lock.lock().unwrap();
2343 if let Some((node_id, _)) = peer.their_node_id {
2344 log_trace!(WithContext::from(&self.logger, Some(node_id), None), "Handling disconnection of peer {}", log_pubkey!(node_id));
2345 let removed = self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2346 debug_assert!(removed.is_some(), "descriptor maps should be consistent");
2347 if !peer.handshake_complete() { return; }
2348 self.message_handler.chan_handler.peer_disconnected(&node_id);
2349 self.message_handler.onion_message_handler.peer_disconnected(&node_id);
2355 /// Disconnect a peer given its node id.
2357 /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
2358 /// peer. Thus, be very careful about reentrancy issues.
2360 /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
2361 pub fn disconnect_by_node_id(&self, node_id: PublicKey) {
2362 let mut peers_lock = self.peers.write().unwrap();
2363 if let Some(descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
2364 let peer_opt = peers_lock.remove(&descriptor);
2365 if let Some(peer_mutex) = peer_opt {
2366 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request");
2367 } else { debug_assert!(false, "node_id_to_descriptor thought we had a peer"); }
2371 /// Disconnects all currently-connected peers. This is useful on platforms where there may be
2372 /// an indication that TCP sockets have stalled even if we weren't around to time them out
2373 /// using regular ping/pongs.
2374 pub fn disconnect_all_peers(&self) {
2375 let mut peers_lock = self.peers.write().unwrap();
2376 self.node_id_to_descriptor.lock().unwrap().clear();
2377 let peers = &mut *peers_lock;
2378 for (descriptor, peer_mutex) in peers.drain() {
2379 self.do_disconnect(descriptor, &*peer_mutex.lock().unwrap(), "client request to disconnect all peers");
2383 /// This is called when we're blocked on sending additional gossip messages until we receive a
2384 /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
2385 /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
2386 fn maybe_send_extra_ping(&self, peer: &mut Peer) {
2387 if peer.awaiting_pong_timer_tick_intervals == 0 {
2388 peer.awaiting_pong_timer_tick_intervals = -1;
2389 let ping = msgs::Ping {
2393 self.enqueue_message(peer, &ping);
2397 /// Send pings to each peer and disconnect those which did not respond to the last round of
2400 /// This may be called on any timescale you want, however, roughly once every ten seconds is
2401 /// preferred. The call rate determines both how often we send a ping to our peers and how much
2402 /// time they have to respond before we disconnect them.
2404 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
2407 /// [`send_data`]: SocketDescriptor::send_data
2408 pub fn timer_tick_occurred(&self) {
2409 let mut descriptors_needing_disconnect = Vec::new();
2411 let peers_lock = self.peers.read().unwrap();
2413 self.update_gossip_backlogged();
2414 let flush_read_disabled = self.gossip_processing_backlog_lifted.swap(false, Ordering::Relaxed);
2416 for (descriptor, peer_mutex) in peers_lock.iter() {
2417 let mut peer = peer_mutex.lock().unwrap();
2418 if flush_read_disabled { peer.received_channel_announce_since_backlogged = false; }
2420 if !peer.handshake_complete() {
2421 // The peer needs to complete its handshake before we can exchange messages. We
2422 // give peers one timer tick to complete handshake, reusing
2423 // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
2424 // for handshake completion.
2425 if peer.awaiting_pong_timer_tick_intervals != 0 {
2426 descriptors_needing_disconnect.push(descriptor.clone());
2428 peer.awaiting_pong_timer_tick_intervals = 1;
2432 debug_assert!(peer.channel_encryptor.is_ready_for_encryption());
2433 debug_assert!(peer.their_node_id.is_some());
2435 loop { // Used as a `goto` to skip writing a Ping message.
2436 if peer.awaiting_pong_timer_tick_intervals == -1 {
2437 // Magic value set in `maybe_send_extra_ping`.
2438 peer.awaiting_pong_timer_tick_intervals = 1;
2439 peer.received_message_since_timer_tick = false;
2443 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
2444 || peer.awaiting_pong_timer_tick_intervals as u64 >
2445 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
2447 descriptors_needing_disconnect.push(descriptor.clone());
2450 peer.received_message_since_timer_tick = false;
2452 if peer.awaiting_pong_timer_tick_intervals > 0 {
2453 peer.awaiting_pong_timer_tick_intervals += 1;
2457 peer.awaiting_pong_timer_tick_intervals = 1;
2458 let ping = msgs::Ping {
2462 self.enqueue_message(&mut *peer, &ping);
2465 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer, flush_read_disabled);
2469 if !descriptors_needing_disconnect.is_empty() {
2471 let mut peers_lock = self.peers.write().unwrap();
2472 for descriptor in descriptors_needing_disconnect {
2473 if let Some(peer_mutex) = peers_lock.remove(&descriptor) {
2474 let peer = peer_mutex.lock().unwrap();
2475 if let Some((node_id, _)) = peer.their_node_id {
2476 self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
2478 self.do_disconnect(descriptor, &*peer, "ping/handshake timeout");
2486 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2487 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2488 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2490 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (SocketAddress::MAX_LEN as u32 + 1) / 2;
2493 // ...by failing to compile if the number of addresses that would be half of a message is
2494 // smaller than 100:
2495 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2497 /// Generates a signed node_announcement from the given arguments, sending it to all connected
2498 /// peers. Note that peers will likely ignore this message unless we have at least one public
2499 /// channel which has at least six confirmations on-chain.
2501 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2502 /// node to humans. They carry no in-protocol meaning.
2504 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2505 /// accepts incoming connections. These will be included in the node_announcement, publicly
2506 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2507 /// addresses should likely contain only Tor Onion addresses.
2509 /// Panics if `addresses` is absurdly large (more than 100).
2511 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2512 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<SocketAddress>) {
2513 if addresses.len() > 100 {
2514 panic!("More than half the message size was taken up by public addresses!");
2517 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2518 // addresses be sorted for future compatibility.
2519 addresses.sort_by_key(|addr| addr.get_id());
2521 let features = self.message_handler.chan_handler.provided_node_features()
2522 | self.message_handler.route_handler.provided_node_features()
2523 | self.message_handler.onion_message_handler.provided_node_features()
2524 | self.message_handler.custom_message_handler.provided_node_features();
2525 let announcement = msgs::UnsignedNodeAnnouncement {
2527 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel),
2528 node_id: NodeId::from_pubkey(&self.node_signer.get_node_id(Recipient::Node).unwrap()),
2530 alias: NodeAlias(alias),
2532 excess_address_data: Vec::new(),
2533 excess_data: Vec::new(),
2535 let node_announce_sig = match self.node_signer.sign_gossip_message(
2536 msgs::UnsignedGossipMessage::NodeAnnouncement(&announcement)
2540 log_error!(self.logger, "Failed to generate signature for node_announcement");
2545 let msg = msgs::NodeAnnouncement {
2546 signature: node_announce_sig,
2547 contents: announcement
2550 log_debug!(self.logger, "Broadcasting NodeAnnouncement after passing it to our own RoutingMessageHandler.");
2551 let _ = self.message_handler.route_handler.handle_node_announcement(&msg);
2552 self.forward_broadcast_msg(&*self.peers.read().unwrap(), &wire::Message::NodeAnnouncement(msg), None);
2556 fn is_gossip_msg(type_id: u16) -> bool {
2558 msgs::ChannelAnnouncement::TYPE |
2559 msgs::ChannelUpdate::TYPE |
2560 msgs::NodeAnnouncement::TYPE |
2561 msgs::QueryChannelRange::TYPE |
2562 msgs::ReplyChannelRange::TYPE |
2563 msgs::QueryShortChannelIds::TYPE |
2564 msgs::ReplyShortChannelIdsEnd::TYPE => true,
2571 use crate::sign::{NodeSigner, Recipient};
2574 use crate::ln::ChannelId;
2575 use crate::ln::features::{InitFeatures, NodeFeatures};
2576 use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
2577 use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
2578 use crate::ln::{msgs, wire};
2579 use crate::ln::msgs::{LightningError, SocketAddress};
2580 use crate::util::test_utils;
2582 use bitcoin::Network;
2583 use bitcoin::blockdata::constants::ChainHash;
2584 use bitcoin::secp256k1::{PublicKey, SecretKey};
2586 use crate::prelude::*;
2587 use crate::sync::{Arc, Mutex};
2588 use core::convert::Infallible;
2589 use core::sync::atomic::{AtomicBool, Ordering};
2592 struct FileDescriptor {
2594 outbound_data: Arc<Mutex<Vec<u8>>>,
2595 disconnect: Arc<AtomicBool>,
2597 impl PartialEq for FileDescriptor {
2598 fn eq(&self, other: &Self) -> bool {
2602 impl Eq for FileDescriptor { }
2603 impl core::hash::Hash for FileDescriptor {
2604 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
2605 self.fd.hash(hasher)
2609 impl SocketDescriptor for FileDescriptor {
2610 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
2611 self.outbound_data.lock().unwrap().extend_from_slice(data);
2615 fn disconnect_socket(&mut self) { self.disconnect.store(true, Ordering::Release); }
2618 struct PeerManagerCfg {
2619 chan_handler: test_utils::TestChannelMessageHandler,
2620 routing_handler: test_utils::TestRoutingMessageHandler,
2621 custom_handler: TestCustomMessageHandler,
2622 logger: test_utils::TestLogger,
2623 node_signer: test_utils::TestNodeSigner,
2626 struct TestCustomMessageHandler {
2627 features: InitFeatures,
2630 impl wire::CustomMessageReader for TestCustomMessageHandler {
2631 type CustomMessage = Infallible;
2632 fn read<R: io::Read>(&self, _: u16, _: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
2637 impl CustomMessageHandler for TestCustomMessageHandler {
2638 fn handle_custom_message(&self, _: Infallible, _: &PublicKey) -> Result<(), LightningError> {
2642 fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
2644 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
2646 fn provided_init_features(&self, _: &PublicKey) -> InitFeatures {
2647 self.features.clone()
2651 fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2652 let mut cfgs = Vec::new();
2653 for i in 0..peer_count {
2654 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2656 let mut feature_bits = vec![0u8; 33];
2657 feature_bits[32] = 0b00000001;
2658 InitFeatures::from_le_bytes(feature_bits)
2662 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2663 logger: test_utils::TestLogger::new(),
2664 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2665 custom_handler: TestCustomMessageHandler { features },
2666 node_signer: test_utils::TestNodeSigner::new(node_secret),
2674 fn create_feature_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2675 let mut cfgs = Vec::new();
2676 for i in 0..peer_count {
2677 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2679 let mut feature_bits = vec![0u8; 33 + i + 1];
2680 feature_bits[33 + i] = 0b00000001;
2681 InitFeatures::from_le_bytes(feature_bits)
2685 chan_handler: test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet)),
2686 logger: test_utils::TestLogger::new(),
2687 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2688 custom_handler: TestCustomMessageHandler { features },
2689 node_signer: test_utils::TestNodeSigner::new(node_secret),
2697 fn create_chain_incompatible_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
2698 let mut cfgs = Vec::new();
2699 for i in 0..peer_count {
2700 let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
2701 let features = InitFeatures::from_le_bytes(vec![0u8; 33]);
2702 let network = ChainHash::from(&[i as u8; 32]);
2705 chan_handler: test_utils::TestChannelMessageHandler::new(network),
2706 logger: test_utils::TestLogger::new(),
2707 routing_handler: test_utils::TestRoutingMessageHandler::new(),
2708 custom_handler: TestCustomMessageHandler { features },
2709 node_signer: test_utils::TestNodeSigner::new(node_secret),
2717 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>> {
2718 let mut peers = Vec::new();
2719 for i in 0..peer_count {
2720 let ephemeral_bytes = [i as u8; 32];
2721 let msg_handler = MessageHandler {
2722 chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler,
2723 onion_message_handler: IgnoringMessageHandler {}, custom_message_handler: &cfgs[i].custom_handler
2725 let peer = PeerManager::new(msg_handler, 0, &ephemeral_bytes, &cfgs[i].logger, &cfgs[i].node_signer);
2732 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) {
2733 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2734 let mut fd_a = FileDescriptor {
2735 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2736 disconnect: Arc::new(AtomicBool::new(false)),
2738 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2739 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
2740 let mut fd_b = FileDescriptor {
2741 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2742 disconnect: Arc::new(AtomicBool::new(false)),
2744 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2745 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2746 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2747 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2748 peer_a.process_events();
2750 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2751 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2753 peer_b.process_events();
2754 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2755 assert_eq!(peer_a.read_event(&mut fd_a, &b_data).unwrap(), false);
2757 peer_a.process_events();
2758 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2759 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2761 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
2762 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));
2764 (fd_a.clone(), fd_b.clone())
2768 #[cfg(feature = "std")]
2769 fn fuzz_threaded_connections() {
2770 // Spawn two threads which repeatedly connect two peers together, leading to "got second
2771 // connection with peer" disconnections and rapid reconnect. This previously found an issue
2772 // with our internal map consistency, and is a generally good smoke test of disconnection.
2773 let cfgs = Arc::new(create_peermgr_cfgs(2));
2774 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
2775 let peers = Arc::new(create_network(2, unsafe { &*(&*cfgs as *const _) as &'static _ }));
2777 let start_time = std::time::Instant::now();
2778 macro_rules! spawn_thread { ($id: expr) => { {
2779 let peers = Arc::clone(&peers);
2780 let cfgs = Arc::clone(&cfgs);
2781 std::thread::spawn(move || {
2783 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2784 let id_a = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
2785 let mut fd_a = FileDescriptor {
2786 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2787 disconnect: Arc::new(AtomicBool::new(false)),
2789 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2790 let mut fd_b = FileDescriptor {
2791 fd: $id + ctr * 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2792 disconnect: Arc::new(AtomicBool::new(false)),
2794 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2795 let initial_data = peers[1].new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2796 peers[0].new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2797 if peers[0].read_event(&mut fd_a, &initial_data).is_err() { break; }
2799 while start_time.elapsed() < std::time::Duration::from_secs(1) {
2800 peers[0].process_events();
2801 if fd_a.disconnect.load(Ordering::Acquire) { break; }
2802 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2803 if peers[1].read_event(&mut fd_b, &a_data).is_err() { break; }
2805 peers[1].process_events();
2806 if fd_b.disconnect.load(Ordering::Acquire) { break; }
2807 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2808 if peers[0].read_event(&mut fd_a, &b_data).is_err() { break; }
2810 cfgs[0].chan_handler.pending_events.lock().unwrap()
2811 .push(crate::events::MessageSendEvent::SendShutdown {
2812 node_id: peers[1].node_signer.get_node_id(Recipient::Node).unwrap(),
2813 msg: msgs::Shutdown {
2814 channel_id: ChannelId::new_zero(),
2815 scriptpubkey: bitcoin::ScriptBuf::new(),
2818 cfgs[1].chan_handler.pending_events.lock().unwrap()
2819 .push(crate::events::MessageSendEvent::SendShutdown {
2820 node_id: peers[0].node_signer.get_node_id(Recipient::Node).unwrap(),
2821 msg: msgs::Shutdown {
2822 channel_id: ChannelId::new_zero(),
2823 scriptpubkey: bitcoin::ScriptBuf::new(),
2828 peers[0].timer_tick_occurred();
2829 peers[1].timer_tick_occurred();
2833 peers[0].socket_disconnected(&fd_a);
2834 peers[1].socket_disconnected(&fd_b);
2836 std::thread::sleep(std::time::Duration::from_micros(1));
2840 let thrd_a = spawn_thread!(1);
2841 let thrd_b = spawn_thread!(2);
2843 thrd_a.join().unwrap();
2844 thrd_b.join().unwrap();
2848 fn test_feature_incompatible_peers() {
2849 let cfgs = create_peermgr_cfgs(2);
2850 let incompatible_cfgs = create_feature_incompatible_peermgr_cfgs(2);
2852 let peers = create_network(2, &cfgs);
2853 let incompatible_peers = create_network(2, &incompatible_cfgs);
2854 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2855 for (peer_a, peer_b) in peer_pairs.iter() {
2856 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2857 let mut fd_a = FileDescriptor {
2858 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2859 disconnect: Arc::new(AtomicBool::new(false)),
2861 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2862 let mut fd_b = FileDescriptor {
2863 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2864 disconnect: Arc::new(AtomicBool::new(false)),
2866 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2867 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2868 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2869 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2870 peer_a.process_events();
2872 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2873 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2875 peer_b.process_events();
2876 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2878 // Should fail because of unknown required features
2879 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2884 fn test_chain_incompatible_peers() {
2885 let cfgs = create_peermgr_cfgs(2);
2886 let incompatible_cfgs = create_chain_incompatible_peermgr_cfgs(2);
2888 let peers = create_network(2, &cfgs);
2889 let incompatible_peers = create_network(2, &incompatible_cfgs);
2890 let peer_pairs = [(&peers[0], &incompatible_peers[0]), (&incompatible_peers[1], &peers[1])];
2891 for (peer_a, peer_b) in peer_pairs.iter() {
2892 let id_a = peer_a.node_signer.get_node_id(Recipient::Node).unwrap();
2893 let mut fd_a = FileDescriptor {
2894 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2895 disconnect: Arc::new(AtomicBool::new(false)),
2897 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
2898 let mut fd_b = FileDescriptor {
2899 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
2900 disconnect: Arc::new(AtomicBool::new(false)),
2902 let addr_b = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1001};
2903 let initial_data = peer_b.new_outbound_connection(id_a, fd_b.clone(), Some(addr_a.clone())).unwrap();
2904 peer_a.new_inbound_connection(fd_a.clone(), Some(addr_b.clone())).unwrap();
2905 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
2906 peer_a.process_events();
2908 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2909 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);
2911 peer_b.process_events();
2912 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
2914 // Should fail because of incompatible chains
2915 assert!(peer_a.read_event(&mut fd_a, &b_data).is_err());
2920 fn test_disconnect_peer() {
2921 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2922 // push a DisconnectPeer event to remove the node flagged by id
2923 let cfgs = create_peermgr_cfgs(2);
2924 let peers = create_network(2, &cfgs);
2925 establish_connection(&peers[0], &peers[1]);
2926 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2928 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2929 cfgs[0].chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
2931 action: msgs::ErrorAction::DisconnectPeer { msg: None },
2934 peers[0].process_events();
2935 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2939 fn test_send_simple_msg() {
2940 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
2941 // push a message from one peer to another.
2942 let cfgs = create_peermgr_cfgs(2);
2943 let a_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2944 let b_chan_handler = test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet));
2945 let mut peers = create_network(2, &cfgs);
2946 let (fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
2947 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2949 let their_id = peers[1].node_signer.get_node_id(Recipient::Node).unwrap();
2951 let msg = msgs::Shutdown { channel_id: ChannelId::from_bytes([42; 32]), scriptpubkey: bitcoin::ScriptBuf::new() };
2952 a_chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::SendShutdown {
2953 node_id: their_id, msg: msg.clone()
2955 peers[0].message_handler.chan_handler = &a_chan_handler;
2957 b_chan_handler.expect_receive_msg(wire::Message::Shutdown(msg));
2958 peers[1].message_handler.chan_handler = &b_chan_handler;
2960 peers[0].process_events();
2962 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
2963 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
2967 fn test_non_init_first_msg() {
2968 // Simple test of the first message received over a connection being something other than
2969 // Init. This results in an immediate disconnection, which previously included a spurious
2970 // peer_disconnected event handed to event handlers (which would panic in
2971 // `TestChannelMessageHandler` here).
2972 let cfgs = create_peermgr_cfgs(2);
2973 let peers = create_network(2, &cfgs);
2975 let mut fd_dup = FileDescriptor {
2976 fd: 3, outbound_data: Arc::new(Mutex::new(Vec::new())),
2977 disconnect: Arc::new(AtomicBool::new(false)),
2979 let addr_dup = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1003};
2980 let id_a = cfgs[0].node_signer.get_node_id(Recipient::Node).unwrap();
2981 peers[0].new_inbound_connection(fd_dup.clone(), Some(addr_dup.clone())).unwrap();
2983 let mut dup_encryptor = PeerChannelEncryptor::new_outbound(id_a, SecretKey::from_slice(&[42; 32]).unwrap());
2984 let initial_data = dup_encryptor.get_act_one(&peers[1].secp_ctx);
2985 assert_eq!(peers[0].read_event(&mut fd_dup, &initial_data).unwrap(), false);
2986 peers[0].process_events();
2988 let a_data = fd_dup.outbound_data.lock().unwrap().split_off(0);
2989 let (act_three, _) =
2990 dup_encryptor.process_act_two(&a_data[..], &&cfgs[1].node_signer).unwrap();
2991 assert_eq!(peers[0].read_event(&mut fd_dup, &act_three).unwrap(), false);
2993 let not_init_msg = msgs::Ping { ponglen: 4, byteslen: 0 };
2994 let msg_bytes = dup_encryptor.encrypt_message(¬_init_msg);
2995 assert!(peers[0].read_event(&mut fd_dup, &msg_bytes).is_err());
2999 fn test_disconnect_all_peer() {
3000 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
3001 // then calls disconnect_all_peers
3002 let cfgs = create_peermgr_cfgs(2);
3003 let peers = create_network(2, &cfgs);
3004 establish_connection(&peers[0], &peers[1]);
3005 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3007 peers[0].disconnect_all_peers();
3008 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3012 fn test_timer_tick_occurred() {
3013 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
3014 let cfgs = create_peermgr_cfgs(2);
3015 let peers = create_network(2, &cfgs);
3016 establish_connection(&peers[0], &peers[1]);
3017 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3019 // peers[0] awaiting_pong is set to true, but the Peer is still connected
3020 peers[0].timer_tick_occurred();
3021 peers[0].process_events();
3022 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3024 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
3025 peers[0].timer_tick_occurred();
3026 peers[0].process_events();
3027 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3031 fn test_do_attempt_write_data() {
3032 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
3033 let cfgs = create_peermgr_cfgs(2);
3034 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3035 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3036 let peers = create_network(2, &cfgs);
3038 // By calling establish_connect, we trigger do_attempt_write_data between
3039 // the peers. Previously this function would mistakenly enter an infinite loop
3040 // when there were more channel messages available than could fit into a peer's
3041 // buffer. This issue would now be detected by this test (because we use custom
3042 // RoutingMessageHandlers that intentionally return more channel messages
3043 // than can fit into a peer's buffer).
3044 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
3046 // Make each peer to read the messages that the other peer just wrote to them. Note that
3047 // due to the max-message-before-ping limits this may take a few iterations to complete.
3048 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
3049 peers[1].process_events();
3050 let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3051 assert!(!a_read_data.is_empty());
3053 peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
3054 peers[0].process_events();
3056 let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3057 assert!(!b_read_data.is_empty());
3058 peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
3060 peers[0].process_events();
3061 assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
3064 // Check that each peer has received the expected number of channel updates and channel
3066 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3067 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3068 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 108);
3069 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 54);
3073 fn test_handshake_timeout() {
3074 // Tests that we time out a peer still waiting on handshake completion after a full timer
3076 let cfgs = create_peermgr_cfgs(2);
3077 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
3078 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
3079 let peers = create_network(2, &cfgs);
3081 let a_id = peers[0].node_signer.get_node_id(Recipient::Node).unwrap();
3082 let mut fd_a = FileDescriptor {
3083 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3084 disconnect: Arc::new(AtomicBool::new(false)),
3086 let mut fd_b = FileDescriptor {
3087 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
3088 disconnect: Arc::new(AtomicBool::new(false)),
3090 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
3091 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
3093 // If we get a single timer tick before completion, that's fine
3094 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3095 peers[0].timer_tick_occurred();
3096 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
3098 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
3099 peers[0].process_events();
3100 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
3101 assert_eq!(peers[1].read_event(&mut fd_b, &a_data).unwrap(), false);
3102 peers[1].process_events();
3104 // ...but if we get a second timer tick, we should disconnect the peer
3105 peers[0].timer_tick_occurred();
3106 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
3108 let b_data = fd_b.outbound_data.lock().unwrap().split_off(0);
3109 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
3113 fn test_filter_addresses(){
3114 // Tests the filter_addresses function.
3117 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 0, 0], port: 1000};
3118 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3119 let ip_address = SocketAddress::TcpIpV4{addr: [10, 0, 255, 201], port: 1000};
3120 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3121 let ip_address = SocketAddress::TcpIpV4{addr: [10, 255, 255, 255], port: 1000};
3122 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3125 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 0, 0], port: 1000};
3126 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3127 let ip_address = SocketAddress::TcpIpV4{addr: [0, 0, 255, 187], port: 1000};
3128 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3129 let ip_address = SocketAddress::TcpIpV4{addr: [0, 255, 255, 255], port: 1000};
3130 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3133 let ip_address = SocketAddress::TcpIpV4{addr: [100, 64, 0, 0], port: 1000};
3134 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3135 let ip_address = SocketAddress::TcpIpV4{addr: [100, 78, 255, 0], port: 1000};
3136 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3137 let ip_address = SocketAddress::TcpIpV4{addr: [100, 127, 255, 255], port: 1000};
3138 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3141 let ip_address = SocketAddress::TcpIpV4{addr: [127, 0, 0, 0], port: 1000};
3142 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3143 let ip_address = SocketAddress::TcpIpV4{addr: [127, 65, 73, 0], port: 1000};
3144 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3145 let ip_address = SocketAddress::TcpIpV4{addr: [127, 255, 255, 255], port: 1000};
3146 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3149 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 0, 0], port: 1000};
3150 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3151 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 221, 101], port: 1000};
3152 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3153 let ip_address = SocketAddress::TcpIpV4{addr: [169, 254, 255, 255], port: 1000};
3154 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3157 let ip_address = SocketAddress::TcpIpV4{addr: [172, 16, 0, 0], port: 1000};
3158 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3159 let ip_address = SocketAddress::TcpIpV4{addr: [172, 27, 101, 23], port: 1000};
3160 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3161 let ip_address = SocketAddress::TcpIpV4{addr: [172, 31, 255, 255], port: 1000};
3162 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3165 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 0, 0], port: 1000};
3166 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3167 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 205, 159], port: 1000};
3168 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3169 let ip_address = SocketAddress::TcpIpV4{addr: [192, 168, 255, 255], port: 1000};
3170 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3172 // For (192.88.99/24)
3173 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 0], port: 1000};
3174 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3175 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 140], port: 1000};
3176 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3177 let ip_address = SocketAddress::TcpIpV4{addr: [192, 88, 99, 255], port: 1000};
3178 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3180 // For other IPv4 addresses
3181 let ip_address = SocketAddress::TcpIpV4{addr: [188, 255, 99, 0], port: 1000};
3182 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3183 let ip_address = SocketAddress::TcpIpV4{addr: [123, 8, 129, 14], port: 1000};
3184 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3185 let ip_address = SocketAddress::TcpIpV4{addr: [2, 88, 9, 255], port: 1000};
3186 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3189 let ip_address = SocketAddress::TcpIpV6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
3190 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3191 let ip_address = SocketAddress::TcpIpV6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
3192 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3193 let ip_address = SocketAddress::TcpIpV6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
3194 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
3196 // For other IPv6 addresses
3197 let ip_address = SocketAddress::TcpIpV6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
3198 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3199 let ip_address = SocketAddress::TcpIpV6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
3200 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3201 let ip_address = SocketAddress::TcpIpV6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
3202 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
3205 assert_eq!(filter_addresses(None), None);
3209 #[cfg(feature = "std")]
3210 fn test_process_events_multithreaded() {
3211 use std::time::{Duration, Instant};
3212 // Test that `process_events` getting called on multiple threads doesn't generate too many
3214 // Each time `process_events` goes around the loop we call
3215 // `get_and_clear_pending_msg_events`, which we count using the `TestMessageHandler`.
3216 // Because the loop should go around once more after a call which fails to take the
3217 // single-threaded lock, if we write zero to the counter before calling `process_events` we
3218 // should never observe there having been more than 2 loop iterations.
3219 // Further, because the last thread to exit will call `process_events` before returning, we
3220 // should always have at least one count at the end.
3221 let cfg = Arc::new(create_peermgr_cfgs(1));
3222 // Until we have std::thread::scoped we have to unsafe { turn off the borrow checker }.
3223 let peer = Arc::new(create_network(1, unsafe { &*(&*cfg as *const _) as &'static _ }).pop().unwrap());
3225 let exit_flag = Arc::new(AtomicBool::new(false));
3226 macro_rules! spawn_thread { () => { {
3227 let thread_cfg = Arc::clone(&cfg);
3228 let thread_peer = Arc::clone(&peer);
3229 let thread_exit = Arc::clone(&exit_flag);
3230 std::thread::spawn(move || {
3231 while !thread_exit.load(Ordering::Acquire) {
3232 thread_cfg[0].chan_handler.message_fetch_counter.store(0, Ordering::Release);
3233 thread_peer.process_events();
3234 std::thread::sleep(Duration::from_micros(1));
3239 let thread_a = spawn_thread!();
3240 let thread_b = spawn_thread!();
3241 let thread_c = spawn_thread!();
3243 let start_time = Instant::now();
3244 while start_time.elapsed() < Duration::from_millis(100) {
3245 let val = cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire);
3247 std::thread::yield_now(); // Winblowz seemingly doesn't ever interrupt threads?!
3250 exit_flag.store(true, Ordering::Release);
3251 thread_a.join().unwrap();
3252 thread_b.join().unwrap();
3253 thread_c.join().unwrap();
3254 assert!(cfg[0].chan_handler.message_fetch_counter.load(Ordering::Acquire) >= 1);