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 //! A socket handling library for those running in Tokio environments who wish to use
11 //! rust-lightning with native [`TcpStream`]s.
13 //! Designed to be as simple as possible, the high-level usage is almost as simple as "hand over a
14 //! [`TcpStream`] and a reference to a [`PeerManager`] and the rest is handled".
16 //! The [`PeerManager`], due to the fire-and-forget nature of this logic, must be a reference,
17 //! (e.g. an [`Arc`]) and must use the [`SocketDescriptor`] provided here as the [`PeerManager`]'s
18 //! `SocketDescriptor` implementation.
20 //! Three methods are exposed to register a new connection for handling in [`tokio::spawn`] calls;
21 //! see their individual docs for details.
23 //! [`PeerManager`]: lightning::ln::peer_handler::PeerManager
25 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
26 #![deny(broken_intra_doc_links)]
27 #![deny(private_intra_doc_links)]
29 #![deny(missing_docs)]
30 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
32 use bitcoin::secp256k1::PublicKey;
34 use tokio::net::TcpStream;
35 use tokio::{io, time};
36 use tokio::sync::mpsc;
37 use tokio::io::{AsyncReadExt, AsyncWrite, AsyncWriteExt};
39 use lightning::ln::peer_handler;
40 use lightning::ln::peer_handler::SocketDescriptor as LnSocketTrait;
41 use lightning::ln::peer_handler::APeerManager;
42 use lightning::ln::msgs::NetAddress;
45 use std::task::{self, Poll};
46 use std::future::Future;
47 use std::net::SocketAddr;
48 use std::net::TcpStream as StdTcpStream;
49 use std::sync::{Arc, Mutex};
50 use std::sync::atomic::{AtomicU64, Ordering};
51 use std::time::Duration;
55 static ID_COUNTER: AtomicU64 = AtomicU64::new(0);
57 // We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
58 // dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
59 // define a trivial two- and three- select macro with the specific types we need and just use that.
61 pub(crate) enum SelectorOutput {
62 A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
65 pub(crate) struct TwoSelector<
66 A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
73 A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
74 > Future for TwoSelector<A, B> {
75 type Output = SelectorOutput;
76 fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
77 match Pin::new(&mut self.a).poll(ctx) {
78 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
81 match Pin::new(&mut self.b).poll(ctx) {
82 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
89 pub(crate) struct ThreeSelector<
90 A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
98 A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
99 > Future for ThreeSelector<A, B, C> {
100 type Output = SelectorOutput;
101 fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
102 match Pin::new(&mut self.a).poll(ctx) {
103 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
106 match Pin::new(&mut self.b).poll(ctx) {
107 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
110 match Pin::new(&mut self.c).poll(ctx) {
111 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
118 /// Connection contains all our internal state for a connection - we hold a reference to the
119 /// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
120 /// read future (which is returned by schedule_read).
122 writer: Option<io::WriteHalf<TcpStream>>,
123 // Because our PeerManager is templated by user-provided types, and we can't (as far as I can
124 // tell) have a const RawWakerVTable built out of templated functions, we need some indirection
125 // between being woken up with write-ready and calling PeerManager::write_buffer_space_avail.
126 // This provides that indirection, with a Sender which gets handed to the PeerManager Arc on
127 // the schedule_read stack.
129 // An alternative (likely more effecient) approach would involve creating a RawWakerVTable at
130 // runtime with functions templated by the Arc<PeerManager> type, calling
131 // write_buffer_space_avail directly from tokio's write wake, however doing so would require
132 // more unsafe voodo than I really feel like writing.
133 write_avail: mpsc::Sender<()>,
134 // When we are told by rust-lightning to pause read (because we have writes backing up), we do
135 // so by setting read_paused. At that point, the read task will stop reading bytes from the
136 // socket. To wake it up (without otherwise changing its state, we can push a value into this
138 read_waker: mpsc::Sender<()>,
140 rl_requested_disconnect: bool,
144 async fn poll_event_process<PM: Deref + 'static + Send + Sync>(
146 mut event_receiver: mpsc::Receiver<()>,
147 ) where PM::Target: APeerManager<Descriptor = SocketDescriptor> {
149 if event_receiver.recv().await.is_none() {
152 peer_manager.as_ref().process_events();
156 async fn schedule_read<PM: Deref + 'static + Send + Sync + Clone>(
158 us: Arc<Mutex<Self>>,
159 mut reader: io::ReadHalf<TcpStream>,
160 mut read_wake_receiver: mpsc::Receiver<()>,
161 mut write_avail_receiver: mpsc::Receiver<()>,
162 ) where PM::Target: APeerManager<Descriptor = SocketDescriptor> {
163 // Create a waker to wake up poll_event_process, above
164 let (event_waker, event_receiver) = mpsc::channel(1);
165 tokio::spawn(Self::poll_event_process(peer_manager.clone(), event_receiver));
167 // 4KiB is nice and big without handling too many messages all at once, giving other peers
168 // a chance to do some work.
169 let mut buf = [0; 4096];
171 let mut our_descriptor = SocketDescriptor::new(us.clone());
172 // An enum describing why we did/are disconnecting:
174 // Rust-Lightning told us to disconnect, either by returning an Err or by calling
175 // SocketDescriptor::disconnect_socket.
176 // In this case, we do not call peer_manager.socket_disconnected() as Rust-Lightning
177 // already knows we're disconnected.
179 // The connection was disconnected for some other reason, ie because the socket was
181 // In this case, we do need to call peer_manager.socket_disconnected() to inform
182 // Rust-Lightning that the socket is gone.
185 let disconnect_type = loop {
187 let us_lock = us.lock().unwrap();
188 if us_lock.rl_requested_disconnect {
189 break Disconnect::CloseConnection;
193 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
194 let select_result = if read_paused {
196 a: Box::pin(write_avail_receiver.recv()),
197 b: Box::pin(read_wake_receiver.recv()),
201 a: Box::pin(write_avail_receiver.recv()),
202 b: Box::pin(read_wake_receiver.recv()),
203 c: Box::pin(reader.read(&mut buf)),
206 match select_result {
207 SelectorOutput::A(v) => {
208 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
209 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
210 break Disconnect::CloseConnection;
213 SelectorOutput::B(_) => {},
214 SelectorOutput::C(read) => {
216 Ok(0) => break Disconnect::PeerDisconnected,
218 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
219 let mut us_lock = us.lock().unwrap();
223 us_lock.read_paused = true;
226 Err(_) => break Disconnect::CloseConnection,
229 Err(_) => break Disconnect::PeerDisconnected,
233 let _ = event_waker.try_send(());
235 // At this point we've processed a message or two, and reset the ping timer for this
236 // peer, at least in the "are we still receiving messages" context, if we don't give up
237 // our timeslice to another task we may just spin on this peer, starving other peers
238 // and eventually disconnecting them for ping timeouts. Instead, we explicitly yield
240 let _ = tokio::task::yield_now().await;
242 let writer_option = us.lock().unwrap().writer.take();
243 if let Some(mut writer) = writer_option {
244 // If the socket is already closed, shutdown() will fail, so just ignore it.
245 let _ = writer.shutdown().await;
247 if let Disconnect::PeerDisconnected = disconnect_type {
248 peer_manager.as_ref().socket_disconnected(&our_descriptor);
249 peer_manager.as_ref().process_events();
253 fn new(stream: StdTcpStream) -> (io::ReadHalf<TcpStream>, mpsc::Receiver<()>, mpsc::Receiver<()>, Arc<Mutex<Self>>) {
254 // We only ever need a channel of depth 1 here: if we returned a non-full write to the
255 // PeerManager, we will eventually get notified that there is room in the socket to write
256 // new bytes, which will generate an event. That event will be popped off the queue before
257 // we call write_buffer_space_avail, ensuring that we have room to push a new () if, during
258 // the write_buffer_space_avail() call, send_data() returns a non-full write.
259 let (write_avail, write_receiver) = mpsc::channel(1);
260 // Similarly here - our only goal is to make sure the reader wakes up at some point after
261 // we shove a value into the channel which comes after we've reset the read_paused bool to
263 let (read_waker, read_receiver) = mpsc::channel(1);
264 stream.set_nonblocking(true).unwrap();
265 let (reader, writer) = io::split(TcpStream::from_std(stream).unwrap());
267 (reader, write_receiver, read_receiver,
268 Arc::new(Mutex::new(Self {
269 writer: Some(writer), write_avail, read_waker, read_paused: false,
270 rl_requested_disconnect: false,
271 id: ID_COUNTER.fetch_add(1, Ordering::AcqRel)
276 fn get_addr_from_stream(stream: &StdTcpStream) -> Option<NetAddress> {
277 match stream.peer_addr() {
278 Ok(SocketAddr::V4(sockaddr)) => Some(NetAddress::IPv4 {
279 addr: sockaddr.ip().octets(),
280 port: sockaddr.port(),
282 Ok(SocketAddr::V6(sockaddr)) => Some(NetAddress::IPv6 {
283 addr: sockaddr.ip().octets(),
284 port: sockaddr.port(),
290 /// Process incoming messages and feed outgoing messages on the provided socket generated by
291 /// accepting an incoming connection.
293 /// The returned future will complete when the peer is disconnected and associated handling
294 /// futures are freed, though, because all processing futures are spawned with tokio::spawn, you do
295 /// not need to poll the provided future in order to make progress.
296 pub fn setup_inbound<PM: Deref + 'static + Send + Sync + Clone>(
298 stream: StdTcpStream,
299 ) -> impl std::future::Future<Output=()>
300 where PM::Target: APeerManager<Descriptor = SocketDescriptor> {
301 let remote_addr = get_addr_from_stream(&stream);
302 let (reader, write_receiver, read_receiver, us) = Connection::new(stream);
304 let last_us = Arc::clone(&us);
306 let handle_opt = if peer_manager.as_ref().new_inbound_connection(SocketDescriptor::new(us.clone()), remote_addr).is_ok() {
307 Some(tokio::spawn(Connection::schedule_read(peer_manager, us, reader, read_receiver, write_receiver)))
309 // Note that we will skip socket_disconnected here, in accordance with the PeerManager
315 if let Some(handle) = handle_opt {
316 if let Err(e) = handle.await {
317 assert!(e.is_cancelled());
319 // This is certainly not guaranteed to always be true - the read loop may exit
320 // while there are still pending write wakers that need to be woken up after the
321 // socket shutdown(). Still, as a check during testing, to make sure tokio doesn't
322 // keep too many wakers around, this makes sense. The race should be rare (we do
323 // some work after shutdown()) and an error would be a major memory leak.
325 debug_assert!(Arc::try_unwrap(last_us).is_ok());
331 /// Process incoming messages and feed outgoing messages on the provided socket generated by
332 /// making an outbound connection which is expected to be accepted by a peer with the given
333 /// public key. The relevant processing is set to run free (via tokio::spawn).
335 /// The returned future will complete when the peer is disconnected and associated handling
336 /// futures are freed, though, because all processing futures are spawned with tokio::spawn, you do
337 /// not need to poll the provided future in order to make progress.
338 pub fn setup_outbound<PM: Deref + 'static + Send + Sync + Clone>(
340 their_node_id: PublicKey,
341 stream: StdTcpStream,
342 ) -> impl std::future::Future<Output=()>
343 where PM::Target: APeerManager<Descriptor = SocketDescriptor> {
344 let remote_addr = get_addr_from_stream(&stream);
345 let (reader, mut write_receiver, read_receiver, us) = Connection::new(stream);
347 let last_us = Arc::clone(&us);
348 let handle_opt = if let Ok(initial_send) = peer_manager.as_ref().new_outbound_connection(their_node_id, SocketDescriptor::new(us.clone()), remote_addr) {
349 Some(tokio::spawn(async move {
350 // We should essentially always have enough room in a TCP socket buffer to send the
351 // initial 10s of bytes. However, tokio running in single-threaded mode will always
352 // fail writes and wake us back up later to write. Thus, we handle a single
353 // std::task::Poll::Pending but still expect to write the full set of bytes at once
354 // and use a relatively tight timeout.
355 if let Ok(Ok(())) = tokio::time::timeout(Duration::from_millis(100), async {
357 match SocketDescriptor::new(us.clone()).send_data(&initial_send, true) {
358 v if v == initial_send.len() => break Ok(()),
360 write_receiver.recv().await;
361 // In theory we could check for if we've been instructed to disconnect
362 // the peer here, but its OK to just skip it - we'll check for it in
363 // schedule_read prior to any relevant calls into RL.
366 eprintln!("Failed to write first full message to socket!");
367 peer_manager.as_ref().socket_disconnected(&SocketDescriptor::new(Arc::clone(&us)));
373 Connection::schedule_read(peer_manager, us, reader, read_receiver, write_receiver).await;
377 // Note that we will skip socket_disconnected here, in accordance with the PeerManager
383 if let Some(handle) = handle_opt {
384 if let Err(e) = handle.await {
385 assert!(e.is_cancelled());
387 // This is certainly not guaranteed to always be true - the read loop may exit
388 // while there are still pending write wakers that need to be woken up after the
389 // socket shutdown(). Still, as a check during testing, to make sure tokio doesn't
390 // keep too many wakers around, this makes sense. The race should be rare (we do
391 // some work after shutdown()) and an error would be a major memory leak.
393 debug_assert!(Arc::try_unwrap(last_us).is_ok());
399 /// Process incoming messages and feed outgoing messages on a new connection made to the given
400 /// socket address which is expected to be accepted by a peer with the given public key (by
401 /// scheduling futures with tokio::spawn).
403 /// Shorthand for TcpStream::connect(addr) with a timeout followed by setup_outbound().
405 /// Returns a future (as the fn is async) which needs to be polled to complete the connection and
406 /// connection setup. That future then returns a future which will complete when the peer is
407 /// disconnected and associated handling futures are freed, though, because all processing in said
408 /// futures are spawned with tokio::spawn, you do not need to poll the second future in order to
410 pub async fn connect_outbound<PM: Deref + 'static + Send + Sync + Clone>(
412 their_node_id: PublicKey,
414 ) -> Option<impl std::future::Future<Output=()>>
415 where PM::Target: APeerManager<Descriptor = SocketDescriptor> {
416 if let Ok(Ok(stream)) = time::timeout(Duration::from_secs(10), async { TcpStream::connect(&addr).await.map(|s| s.into_std().unwrap()) }).await {
417 Some(setup_outbound(peer_manager, their_node_id, stream))
421 const SOCK_WAKER_VTABLE: task::RawWakerVTable =
422 task::RawWakerVTable::new(clone_socket_waker, wake_socket_waker, wake_socket_waker_by_ref, drop_socket_waker);
424 fn clone_socket_waker(orig_ptr: *const ()) -> task::RawWaker {
425 write_avail_to_waker(orig_ptr as *const mpsc::Sender<()>)
427 // When waking, an error should be fine. Most likely we got two send_datas in a row, both of which
428 // failed to fully write, but we only need to call write_buffer_space_avail() once. Otherwise, the
429 // sending thread may have already gone away due to a socket close, in which case there's nothing
430 // to wake up anyway.
431 fn wake_socket_waker(orig_ptr: *const ()) {
432 let sender = unsafe { &mut *(orig_ptr as *mut mpsc::Sender<()>) };
433 let _ = sender.try_send(());
434 drop_socket_waker(orig_ptr);
436 fn wake_socket_waker_by_ref(orig_ptr: *const ()) {
437 let sender_ptr = orig_ptr as *const mpsc::Sender<()>;
438 let sender = unsafe { (*sender_ptr).clone() };
439 let _ = sender.try_send(());
441 fn drop_socket_waker(orig_ptr: *const ()) {
442 let _orig_box = unsafe { Box::from_raw(orig_ptr as *mut mpsc::Sender<()>) };
443 // _orig_box is now dropped
445 fn write_avail_to_waker(sender: *const mpsc::Sender<()>) -> task::RawWaker {
446 let new_box = Box::leak(Box::new(unsafe { (*sender).clone() }));
447 let new_ptr = new_box as *const mpsc::Sender<()>;
448 task::RawWaker::new(new_ptr as *const (), &SOCK_WAKER_VTABLE)
451 /// The SocketDescriptor used to refer to sockets by a PeerHandler. This is pub only as it is a
452 /// type in the template of PeerHandler.
453 pub struct SocketDescriptor {
454 conn: Arc<Mutex<Connection>>,
457 impl SocketDescriptor {
458 fn new(conn: Arc<Mutex<Connection>>) -> Self {
459 let id = conn.lock().unwrap().id;
463 impl peer_handler::SocketDescriptor for SocketDescriptor {
464 fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize {
465 // To send data, we take a lock on our Connection to access the WriteHalf of the TcpStream,
466 // writing to it if there's room in the kernel buffer, or otherwise create a new Waker with
467 // a SocketDescriptor in it which can wake up the write_avail Sender, waking up the
468 // processing future which will call write_buffer_space_avail and we'll end up back here.
469 let mut us = self.conn.lock().unwrap();
470 if us.writer.is_none() {
471 // The writer gets take()n when it is time to shut down, so just fast-return 0 here.
475 if resume_read && us.read_paused {
476 // The schedule_read future may go to lock up but end up getting woken up by there
477 // being more room in the write buffer, dropping the other end of this Sender
478 // before we get here, so we ignore any failures to wake it up.
479 us.read_paused = false;
480 let _ = us.read_waker.try_send(());
482 if data.is_empty() { return 0; }
483 let waker = unsafe { task::Waker::from_raw(write_avail_to_waker(&us.write_avail)) };
484 let mut ctx = task::Context::from_waker(&waker);
485 let mut written_len = 0;
487 match std::pin::Pin::new(us.writer.as_mut().unwrap()).poll_write(&mut ctx, &data[written_len..]) {
488 task::Poll::Ready(Ok(res)) => {
489 // The tokio docs *seem* to indicate this can't happen, and I certainly don't
490 // know how to handle it if it does (cause it should be a Poll::Pending
494 if written_len == data.len() { return written_len; }
496 task::Poll::Ready(Err(e)) => {
497 // The tokio docs *seem* to indicate this can't happen, and I certainly don't
498 // know how to handle it if it does (cause it should be a Poll::Pending
500 assert_ne!(e.kind(), io::ErrorKind::WouldBlock);
501 // Probably we've already been closed, just return what we have and let the
502 // read thread handle closing logic.
505 task::Poll::Pending => {
506 // We're queued up for a write event now, but we need to make sure we also
507 // pause read given we're now waiting on the remote end to ACK (and in
508 // accordance with the send_data() docs).
509 us.read_paused = true;
510 // Further, to avoid any current pending read causing a `read_event` call, wake
511 // up the read_waker and restart its loop.
512 let _ = us.read_waker.try_send(());
519 fn disconnect_socket(&mut self) {
520 let mut us = self.conn.lock().unwrap();
521 us.rl_requested_disconnect = true;
522 // Wake up the sending thread, assuming it is still alive
523 let _ = us.write_avail.try_send(());
526 impl Clone for SocketDescriptor {
527 fn clone(&self) -> Self {
529 conn: Arc::clone(&self.conn),
534 impl Eq for SocketDescriptor {}
535 impl PartialEq for SocketDescriptor {
536 fn eq(&self, o: &Self) -> bool {
540 impl Hash for SocketDescriptor {
541 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
548 use lightning::ln::features::*;
549 use lightning::ln::msgs::*;
550 use lightning::ln::peer_handler::{MessageHandler, PeerManager};
551 use lightning::ln::features::NodeFeatures;
552 use lightning::routing::gossip::NodeId;
553 use lightning::events::*;
554 use lightning::util::test_utils::TestNodeSigner;
555 use bitcoin::Network;
556 use bitcoin::blockdata::constants::ChainHash;
557 use bitcoin::secp256k1::{Secp256k1, SecretKey, PublicKey};
559 use tokio::sync::mpsc;
562 use std::sync::atomic::{AtomicBool, Ordering};
563 use std::sync::{Arc, Mutex};
564 use std::time::Duration;
566 pub struct TestLogger();
567 impl lightning::util::logger::Logger for TestLogger {
568 fn log(&self, record: &lightning::util::logger::Record) {
569 println!("{:<5} [{} : {}, {}] {}", record.level.to_string(), record.module_path, record.file, record.line, record.args);
574 expected_pubkey: PublicKey,
575 pubkey_connected: mpsc::Sender<()>,
576 pubkey_disconnected: mpsc::Sender<()>,
577 disconnected_flag: AtomicBool,
578 msg_events: Mutex<Vec<MessageSendEvent>>,
580 impl RoutingMessageHandler for MsgHandler {
581 fn handle_node_announcement(&self, _msg: &NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
582 fn handle_channel_announcement(&self, _msg: &ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
583 fn handle_channel_update(&self, _msg: &ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
584 fn get_next_channel_announcement(&self, _starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)> { None }
585 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<NodeAnnouncement> { None }
586 fn peer_connected(&self, _their_node_id: &PublicKey, _init_msg: &Init, _inbound: bool) -> Result<(), ()> { Ok(()) }
587 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
588 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
589 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
590 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
591 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
592 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures { InitFeatures::empty() }
593 fn processing_queue_high(&self) -> bool { false }
595 impl ChannelMessageHandler for MsgHandler {
596 fn handle_open_channel(&self, _their_node_id: &PublicKey, _msg: &OpenChannel) {}
597 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _msg: &AcceptChannel) {}
598 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &FundingCreated) {}
599 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &FundingSigned) {}
600 fn handle_channel_ready(&self, _their_node_id: &PublicKey, _msg: &ChannelReady) {}
601 fn handle_shutdown(&self, _their_node_id: &PublicKey, _msg: &Shutdown) {}
602 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &ClosingSigned) {}
603 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &UpdateAddHTLC) {}
604 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &UpdateFulfillHTLC) {}
605 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &UpdateFailHTLC) {}
606 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &UpdateFailMalformedHTLC) {}
607 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &CommitmentSigned) {}
608 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &RevokeAndACK) {}
609 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &UpdateFee) {}
610 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &AnnouncementSignatures) {}
611 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &ChannelUpdate) {}
612 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, _msg: &OpenChannelV2) {}
613 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, _msg: &AcceptChannelV2) {}
614 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, _msg: &TxAddInput) {}
615 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, _msg: &TxAddOutput) {}
616 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, _msg: &TxRemoveInput) {}
617 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, _msg: &TxRemoveOutput) {}
618 fn handle_tx_complete(&self, _their_node_id: &PublicKey, _msg: &TxComplete) {}
619 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, _msg: &TxSignatures) {}
620 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, _msg: &TxInitRbf) {}
621 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, _msg: &TxAckRbf) {}
622 fn handle_tx_abort(&self, _their_node_id: &PublicKey, _msg: &TxAbort) {}
623 fn peer_disconnected(&self, their_node_id: &PublicKey) {
624 if *their_node_id == self.expected_pubkey {
625 self.disconnected_flag.store(true, Ordering::SeqCst);
626 self.pubkey_disconnected.clone().try_send(()).unwrap();
629 fn peer_connected(&self, their_node_id: &PublicKey, _init_msg: &Init, _inbound: bool) -> Result<(), ()> {
630 if *their_node_id == self.expected_pubkey {
631 self.pubkey_connected.clone().try_send(()).unwrap();
635 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &ChannelReestablish) {}
636 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &ErrorMessage) {}
637 fn provided_node_features(&self) -> NodeFeatures { NodeFeatures::empty() }
638 fn provided_init_features(&self, _their_node_id: &PublicKey) -> InitFeatures { InitFeatures::empty() }
639 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
640 Some(vec![ChainHash::using_genesis_block(Network::Testnet)])
643 impl MessageSendEventsProvider for MsgHandler {
644 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
645 let mut ret = Vec::new();
646 mem::swap(&mut *self.msg_events.lock().unwrap(), &mut ret);
651 fn make_tcp_connection() -> (std::net::TcpStream, std::net::TcpStream) {
652 if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9735") {
653 (std::net::TcpStream::connect("127.0.0.1:9735").unwrap(), listener.accept().unwrap().0)
654 } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:19735") {
655 (std::net::TcpStream::connect("127.0.0.1:19735").unwrap(), listener.accept().unwrap().0)
656 } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9997") {
657 (std::net::TcpStream::connect("127.0.0.1:9997").unwrap(), listener.accept().unwrap().0)
658 } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9998") {
659 (std::net::TcpStream::connect("127.0.0.1:9998").unwrap(), listener.accept().unwrap().0)
660 } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9999") {
661 (std::net::TcpStream::connect("127.0.0.1:9999").unwrap(), listener.accept().unwrap().0)
662 } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:46926") {
663 (std::net::TcpStream::connect("127.0.0.1:46926").unwrap(), listener.accept().unwrap().0)
664 } else { panic!("Failed to bind to v4 localhost on common ports"); }
667 async fn do_basic_connection_test() {
668 let secp_ctx = Secp256k1::new();
669 let a_key = SecretKey::from_slice(&[1; 32]).unwrap();
670 let b_key = SecretKey::from_slice(&[1; 32]).unwrap();
671 let a_pub = PublicKey::from_secret_key(&secp_ctx, &a_key);
672 let b_pub = PublicKey::from_secret_key(&secp_ctx, &b_key);
674 let (a_connected_sender, mut a_connected) = mpsc::channel(1);
675 let (a_disconnected_sender, mut a_disconnected) = mpsc::channel(1);
676 let a_handler = Arc::new(MsgHandler {
677 expected_pubkey: b_pub,
678 pubkey_connected: a_connected_sender,
679 pubkey_disconnected: a_disconnected_sender,
680 disconnected_flag: AtomicBool::new(false),
681 msg_events: Mutex::new(Vec::new()),
683 let a_manager = Arc::new(PeerManager::new(MessageHandler {
684 chan_handler: Arc::clone(&a_handler),
685 route_handler: Arc::clone(&a_handler),
686 onion_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
687 custom_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
688 }, 0, &[1; 32], Arc::new(TestLogger()), Arc::new(TestNodeSigner::new(a_key))));
690 let (b_connected_sender, mut b_connected) = mpsc::channel(1);
691 let (b_disconnected_sender, mut b_disconnected) = mpsc::channel(1);
692 let b_handler = Arc::new(MsgHandler {
693 expected_pubkey: a_pub,
694 pubkey_connected: b_connected_sender,
695 pubkey_disconnected: b_disconnected_sender,
696 disconnected_flag: AtomicBool::new(false),
697 msg_events: Mutex::new(Vec::new()),
699 let b_manager = Arc::new(PeerManager::new(MessageHandler {
700 chan_handler: Arc::clone(&b_handler),
701 route_handler: Arc::clone(&b_handler),
702 onion_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
703 custom_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
704 }, 0, &[2; 32], Arc::new(TestLogger()), Arc::new(TestNodeSigner::new(b_key))));
706 // We bind on localhost, hoping the environment is properly configured with a local
707 // address. This may not always be the case in containers and the like, so if this test is
708 // failing for you check that you have a loopback interface and it is configured with
710 let (conn_a, conn_b) = make_tcp_connection();
712 let fut_a = super::setup_outbound(Arc::clone(&a_manager), b_pub, conn_a);
713 let fut_b = super::setup_inbound(b_manager, conn_b);
715 tokio::time::timeout(Duration::from_secs(10), a_connected.recv()).await.unwrap();
716 tokio::time::timeout(Duration::from_secs(1), b_connected.recv()).await.unwrap();
718 a_handler.msg_events.lock().unwrap().push(MessageSendEvent::HandleError {
719 node_id: b_pub, action: ErrorAction::DisconnectPeer { msg: None }
721 assert!(!a_handler.disconnected_flag.load(Ordering::SeqCst));
722 assert!(!b_handler.disconnected_flag.load(Ordering::SeqCst));
724 a_manager.process_events();
725 tokio::time::timeout(Duration::from_secs(10), a_disconnected.recv()).await.unwrap();
726 tokio::time::timeout(Duration::from_secs(1), b_disconnected.recv()).await.unwrap();
727 assert!(a_handler.disconnected_flag.load(Ordering::SeqCst));
728 assert!(b_handler.disconnected_flag.load(Ordering::SeqCst));
734 #[tokio::test(flavor = "multi_thread")]
735 async fn basic_threaded_connection_test() {
736 do_basic_connection_test().await;
740 async fn basic_unthreaded_connection_test() {
741 do_basic_connection_test().await;
744 async fn race_disconnect_accept() {
745 // Previously, if we handed an already-disconnected socket to `setup_inbound` we'd panic.
746 // This attempts to find other similar races by opening connections and shutting them down
747 // while connecting. Sadly in testing this did *not* reproduce the previous issue.
748 let secp_ctx = Secp256k1::new();
749 let a_key = SecretKey::from_slice(&[1; 32]).unwrap();
750 let b_key = SecretKey::from_slice(&[2; 32]).unwrap();
751 let b_pub = PublicKey::from_secret_key(&secp_ctx, &b_key);
753 let a_manager = Arc::new(PeerManager::new(MessageHandler {
754 chan_handler: Arc::new(lightning::ln::peer_handler::ErroringMessageHandler::new()),
755 onion_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
756 route_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
757 custom_message_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
758 }, 0, &[1; 32], Arc::new(TestLogger()), Arc::new(TestNodeSigner::new(a_key))));
760 // Make two connections, one for an inbound and one for an outbound connection
762 let (conn_a, _) = make_tcp_connection();
766 let (_, conn_b) = make_tcp_connection();
770 // Call connection setup inside new tokio tasks.
771 let manager_reference = Arc::clone(&a_manager);
772 tokio::spawn(async move {
773 super::setup_inbound(manager_reference, conn_a).await
775 tokio::spawn(async move {
776 super::setup_outbound(a_manager, b_pub, conn_b).await
780 #[tokio::test(flavor = "multi_thread")]
781 async fn threaded_race_disconnect_accept() {
782 race_disconnect_accept().await;
786 async fn unthreaded_race_disconnect_accept() {
787 race_disconnect_accept().await;