Add Socks5Proxy wrapper type

Useful for the `local` constructor which uses the typical proxy hosted
by the Tor daemon.

Author: rustaceanrob

examples/bitcoin.rs

@@ -32,6 +32,8 @@ async fn main() {
         ))
         // Add some initial peers
         .add_peers(seeds.into_iter().map(From::from))
+        // Connections over Tor are supported by Socks5 proxy
+        // .socks5_proxy(bip157::Socks5Proxy::local())
         // Create the node and client
         .build();
     // Run the node on a separate task

src/builder.rs

@@ -1,13 +1,12 @@
-use std::net::SocketAddr;
 use std::{path::PathBuf, time::Duration};
 
 use bitcoin::Network;
 
 use super::{client::Client, node::Node};
 use crate::chain::ChainState;
 use crate::network::ConnectionType;
-use crate::TrustedPeer;
 use crate::{Config, FilterType};
+use crate::{Socks5Proxy, TrustedPeer};
 
 const MIN_PEERS: u8 = 1;
 const MAX_PEERS: u8 = 15;
@@ -125,7 +124,7 @@ impl Builder {
 
     /// Route network traffic through a Tor daemon using a Socks5 proxy. Currently, proxies
     /// must be reachable by IP address.
-    pub fn socks5_proxy(mut self, proxy: impl Into<SocketAddr>) -> Self {
+    pub fn socks5_proxy(mut self, proxy: impl Into<Socks5Proxy>) -> Self {
         let ip_addr = proxy.into();
         let connection = ConnectionType::Socks5Proxy(ip_addr);
         self.config.connection_type = connection;

src/lib.rs

@@ -62,7 +62,7 @@ pub mod node;
 
 use chain::Filter;
 
-use std::net::{IpAddr, SocketAddr};
+use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 use std::path::PathBuf;
 
 // Re-exports
@@ -294,6 +294,26 @@ impl From<SocketAddr> for TrustedPeer {
     }
 }
 
+/// Route network traffic through a Socks5 proxy, typically used by a Tor daemon.
+#[derive(Debug, Clone)]
+pub struct Socks5Proxy(SocketAddr);
+
+impl Socks5Proxy {
+    /// Connect to the default local Socks5 proxy hosted at `127.0.0.1:9050`.
+    pub const fn local() -> Self {
+        Socks5Proxy(SocketAddr::new(
+            IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
+            9050,
+        ))
+    }
+}
+
+impl From<SocketAddr> for Socks5Proxy {
+    fn from(value: SocketAddr) -> Self {
+        Self(value)
+    }
+}
+
 #[derive(Debug, Clone, Copy)]
 enum NodeState {
     // We are behind on block headers according to our peers.

src/network/mod.rs

@@ -1,7 +1,7 @@
 use std::{
     collections::{HashMap, HashSet},
     fs::{self, File},
-    net::{IpAddr, SocketAddr},
+    net::IpAddr,
     path::PathBuf,
     time::Duration,
 };
@@ -28,6 +28,8 @@ use tokio::{net::TcpStream, time::Instant};
 
 use error::PeerError;
 
+use crate::Socks5Proxy;
+
 pub(crate) mod dns;
 pub(crate) mod error;
 pub(crate) mod inbound;
@@ -130,11 +132,11 @@ impl LastBlockMonitor {
     }
 }
 
-#[derive(Debug, Clone, Copy, Default)]
+#[derive(Debug, Clone, Default)]
 pub(crate) enum ConnectionType {
     #[default]
     ClearNet,
-    Socks5Proxy(SocketAddr),
+    Socks5Proxy(Socks5Proxy),
 }
 
 impl ConnectionType {
@@ -177,7 +179,7 @@ impl ConnectionType {
                     _ => return Err(PeerError::UnreachableSocketAddr),
                 };
                 let socks5_timeout =
-                    tokio::time::timeout(handshake_timeout, create_socks5(*proxy, addr, port))
+                    tokio::time::timeout(handshake_timeout, create_socks5(proxy.0, addr, port))
                         .await
                         .map_err(|_| PeerError::ConnectionFailed)?;
                 let tcp_stream = socks5_timeout.map_err(PeerError::Socks5)?;