Skip to content

Commit 460c717

Browse files
committed
fixup: Remind people tor_connect_outbound returns a future that yields a future
And point them to `connect_outbound` docs.
1 parent 313c6a5 commit 460c717

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lightning-net-tokio/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -477,6 +477,9 @@ where
477477

478478
/// Routes [`connect_outbound`] through Tor. Implements stream isolation for each connection
479479
/// using a stream isolation parameter sourced from [`EntropySource::get_secure_random_bytes`].
480+
///
481+
/// Returns a future (as the fn is async) that yields another future, see [`connect_outbound`] for
482+
/// details on this return value.
480483
pub async fn tor_connect_outbound<PM: Deref + 'static + Send + Sync + Clone, ES: Deref>(
481484
peer_manager: PM, their_node_id: PublicKey, addr: SocketAddress, tor_proxy_addr: SocketAddr,
482485
entropy_source: ES,

0 commit comments

Comments
 (0)