Add MempoolClientBuilder and socks feature

Signed-off-by: Yuki Kishimoto <yukikishimoto@protonmail.com>

Author: yukibtc

.github/workflows/ci.yml

@@ -19,12 +19,17 @@ jobs:
   check:
     name: Check crate
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate:
+          - -p mempoolspace
+          - -p mempoolspace --features socks
     steps:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Check
-        run: cargo check
+        run: cargo check -p ${{ matrix.crate }}
       - name: Clippy
-        run: cargo clippy -- -D warnings
+        run: cargo clippy -p ${{ matrix.crate }} -- -D warnings
       - name: Test
-        run: cargo test
+        run: cargo test -p ${{ matrix.crate }}

Cargo.toml

@@ -3,7 +3,10 @@ name = "mempoolspace"
 version = "0.1.0"
 edition = "2024"
 
-# TODO: add socks feature
+[features]
+default = []
+# Enable socks proxy
+socks = ["reqwest/socks"]
 
 [dependencies]
 bitcoin = { version = "0.32", default-features = false, features = ["std", "serde"] }

src/builder.rs

@@ -0,0 +1,74 @@
+//! Mempool client builder
+
+#[cfg(feature = "socks")]
+use std::net::SocketAddr;
+use std::time::Duration;
+
+#[cfg(feature = "socks")]
+use reqwest::Proxy;
+use reqwest::{Client, ClientBuilder};
+use url::Url;
+
+use crate::client::MempoolClient;
+use crate::error::Error;
+
+/// Mempool client builder
+#[derive(Debug, Clone)]
+pub struct MempoolClientBuilder {
+    /// Endpoint URL
+    pub url: Url,
+    /// Timeout for requests
+    pub timeout: Duration,
+    /// Socks5 proxy
+    #[cfg(feature = "socks")]
+    pub proxy: Option<SocketAddr>,
+}
+
+impl MempoolClientBuilder {
+    /// Construct a new builder
+    pub fn new(url: Url) -> Self {
+        Self {
+            url,
+            timeout: Duration::from_secs(60),
+            #[cfg(feature = "socks")]
+            proxy: None,
+        }
+    }
+
+    /// Set a custom timeout
+    #[inline]
+    pub fn timeout(mut self, timeout: Duration) -> Self {
+        self.timeout = timeout;
+        self
+    }
+
+    /// Set proxy
+    #[inline]
+    #[cfg(feature = "socks")]
+    pub fn proxy(mut self, proxy: SocketAddr) -> Self {
+        self.proxy = Some(proxy);
+        self
+    }
+
+    /// Build mempool client
+    pub fn build(self) -> Result<MempoolClient, Error> {
+        // Construct builder
+        let mut builder: ClientBuilder = Client::builder();
+
+        // Set proxy
+        #[cfg(all(feature = "socks", not(target_arch = "wasm32")))]
+        if let Some(proxy) = self.proxy {
+            let proxy: String = format!("socks5h://{proxy}");
+            builder = builder.proxy(Proxy::all(proxy)?);
+        }
+
+        // Set timeout
+        builder = builder.timeout(self.timeout);
+
+        // Build client
+        let client: Client = builder.build()?;
+
+        // Construct client
+        Ok(MempoolClient::from_client(self.url, client))
+    }
+}

src/client.rs

@@ -4,6 +4,7 @@ use bitcoin::Address;
 use reqwest::{Client, Response};
 use url::Url;
 
+use crate::builder::MempoolClientBuilder;
 use crate::error::Error;
 use crate::response::{
     AddressStats, BlockInfo, DifficultyAdjustment, FeeRecommendations, HashrateStats,
@@ -67,10 +68,19 @@ impl MempoolClient {
     /// # let _client = client;
     /// ```
     pub fn new(url: Url) -> Self {
-        Self {
-            url,
-            client: Client::new(),
-        }
+        Self::from_client(url, Client::new())
+    }
+
+    /// Construct a client builder
+    #[inline]
+    pub fn builder(url: Url) -> MempoolClientBuilder {
+        MempoolClientBuilder::new(url)
+    }
+
+    /// Construct new with a custom reqwest [`Client`].
+    #[inline]
+    pub fn from_client(url: Url, client: Client) -> Self {
+        Self { client, url }
     }
 
     /// Get details about difficulty adjustment.

src/lib.rs

@@ -5,6 +5,7 @@
 #![warn(clippy::large_futures)]
 #![warn(rustdoc::bare_urls)]
 
+pub mod builder;
 pub mod client;
 mod deser;
 pub mod error;

src/prelude.rs

@@ -7,6 +7,7 @@
 pub use bitcoin::*;
 pub use url::*;
 
+pub use crate::builder::*;
 pub use crate::client::*;
 pub use crate::error::*;
 pub use crate::response::*;