Merge #182: Simplify cargo features

405311a chore: Update justfile (valued mammal)
1aeb576 ci: Add Check job to check build features matrix (valued mammal)
58bbb50 build!: Always implement `calls_made` (valued mammal)
02c72cc build!: Remove unused `minimal` feature (valued mammal)
c2976cf build: Enable plaintext Client using --no-default-features (valued mammal)
bb5c839 build: move away from `use-` feature naming (valued mammal)
19d243a refactor: remove `default` feature gating (valued mammal)
d010264 build: Clean up `proxy` feature (valued mammal)

Pull request description:

  ## Description

  This PR is meant to streamline the handling of feature flags in the library, in particular by removing the Client's dependency on the `proxy` feature and overall simplifying the feature gating logic. Additionally, we move away from the old `use-*` feature naming convention by introducing simpler feature names, remove the unused `minimal` feature, and get rid of conditional compilation for `debug-calls` while retaining the ability to atomically count calls made.

  fixes #91
  fixes #42

ACKs for top commit:
  oleonardolima:
    ACK 405311a

Tree-SHA512: f53229407d957dc7c716b152879b4a376ddc0b30829fe9bc492f9d88c7d287201d6ffa028a90ca4c9f74f557c7759320db4b1ad607bbc314374a3aba0ce82344

Author: oleonardolima

.github/workflows/cont_integration.yml

@@ -30,14 +30,40 @@ jobs:
           toolchain: ${{ matrix.rust }}
       - name: Test
         run: cargo test --verbose --all-features
-      - run: cargo check --verbose --features=use-openssl
-      - run: cargo check --verbose --no-default-features --features=proxy
-      - run: cargo check --verbose --no-default-features --features=minimal
-      - run: cargo check --verbose --no-default-features --features=minimal,debug-calls
-      - run: cargo check --verbose --no-default-features --features=proxy,use-openssl
-      - run: cargo check --verbose --no-default-features --features=proxy,use-rustls
-      - run: cargo check --verbose --no-default-features --features=proxy,use-rustls-ring
-      - run: cargo check --verbose --no-default-features --features=proxy,use-rustls,use-rustls-ring
+
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rust:
+          - stable # STABLE
+          - 1.75.0 # MSRV
+        features:
+          - --features default
+          - --no-default-features
+          - --no-default-features --features proxy
+          - --no-default-features --features openssl
+          - --no-default-features --features rustls
+          - --no-default-features --features rustls-ring
+          - --no-default-features --features proxy,openssl,rustls,rustls-ring
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-${{ github.job }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
+      - name: Install rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ matrix.rust }}
+      - name: Check features
+        run: cargo check --verbose ${{ matrix.features }}
 
   fmt:
     name: Rust fmt

Cargo.toml

@@ -38,10 +38,13 @@ libc = { version = "0.2", optional = true }
 winapi = { version="0.3.9", features=["winsock2"], optional = true }
 
 [features]
-default = ["proxy", "use-rustls"]
-minimal = []
-debug-calls = []
+default = ["proxy", "rustls"]
 proxy = ["byteorder", "winapi", "libc"]
-use-rustls = ["webpki-roots", "rustls/default"]
-use-rustls-ring = ["webpki-roots", "rustls/ring", "rustls/logging", "rustls/std", "rustls/tls12"]
+rustls = ["webpki-roots", "dep:rustls", "rustls/default"]
+rustls-ring = ["webpki-roots", "dep:rustls", "rustls/ring", "rustls/logging", "rustls/std", "rustls/tls12"]
+openssl = ["dep:openssl"]
+
+# Old feature names
+use-rustls = ["rustls"]
+use-rustls-ring = ["rustls-ring"]
 use-openssl = ["openssl"]

justfile

@@ -14,13 +14,23 @@ build:
 # Check code: formatting, compilation, linting, doc comments, and commit signature
 check:
    cargo +nightly fmt --all -- --check
-   cargo check --all-features --all-targets
+   @just _check-features
    cargo clippy --all-features --all-targets -- -D warnings
-   RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps
+   cargo rustdoc --all-features -- -D warnings
    @[ "$(git log --pretty='format:%G?' -1 HEAD)" = "N" ] && \
        echo "\n⚠️  Unsigned commit: BDK requires that commits be signed." || \
        true
 
+# Check feature configurations (matches CI)
+_check-features:
+   cargo check --features "default"
+   cargo check --no-default-features
+   cargo check --no-default-features --features "proxy"
+   cargo check --no-default-features --features "openssl"
+   cargo check --no-default-features --features "rustls"
+   cargo check --no-default-features --features "rustls-ring"
+   cargo check --no-default-features --features "proxy,openssl,rustls,rustls-ring"   
+
 # Format all code
 fmt:
    cargo +nightly fmt

src/api.rs

@@ -187,7 +187,6 @@ where
         (**self).ping()
     }
 
-    #[cfg(feature = "debug-calls")]
     fn calls_made(&self) -> Result<usize, Error> {
         (**self).calls_made()
     }
@@ -453,7 +452,6 @@ pub trait ElectrumApi {
     /// of incoming block header or script notifications.
     fn ping(&self) -> Result<(), Error>;
 
-    #[cfg(feature = "debug-calls")]
     /// Returns the number of network calls made since the creation of the client.
     fn calls_made(&self) -> Result<usize, Error>;
 }
@@ -677,7 +675,6 @@ mod test {
             unreachable!()
         }
 
-        #[cfg(feature = "debug-calls")]
         fn calls_made(&self) -> Result<usize, super::Error> {
             unreachable!()
         }

src/client.rs

@@ -17,13 +17,15 @@ use std::convert::TryFrom;
 /// [`RawClient`](client/struct.RawClient.html) and provides a more user-friendly
 /// constructor that can choose the right backend based on the url prefix.
 ///
-/// **This is available only with the `default` features, or if `proxy` and one ssl implementation are enabled**
+/// **Note the `Socks5` client type requires the `proxy` feature to be enabled.**
 pub enum ClientType {
     #[allow(missing_docs)]
     TCP(RawClient<ElectrumPlaintextStream>),
     #[allow(missing_docs)]
+    #[cfg(any(feature = "openssl", feature = "rustls", feature = "rustls-ring"))]
     SSL(RawClient<ElectrumSslStream>),
     #[allow(missing_docs)]
+    #[cfg(feature = "proxy")]
     Socks5(RawClient<ElectrumProxyStream>),
 }
 
@@ -43,7 +45,9 @@ macro_rules! impl_inner_call {
             let read_client = $self.client_type.read().unwrap();
             let res = match &*read_client {
                 ClientType::TCP(inner) => inner.$name( $($args, )* ),
+                #[cfg(any(feature = "openssl", feature = "rustls", feature = "rustls-ring"))]
                 ClientType::SSL(inner) => inner.$name( $($args, )* ),
+                #[cfg(feature = "proxy")]
                 ClientType::Socks5(inner) => inner.$name( $($args, )* ),
             };
             drop(read_client);
@@ -108,8 +112,10 @@ impl ClientType {
     /// Constructor that supports multiple backends and allows configuration through
     /// the [Config]
     pub fn from_config(url: &str, config: &Config) -> Result<Self, Error> {
+        #[cfg(any(feature = "openssl", feature = "rustls", feature = "rustls-ring"))]
         if url.starts_with("ssl://") {
             let url = url.replacen("ssl://", "", 1);
+            #[cfg(feature = "proxy")]
             let client = match config.socks5() {
                 Some(socks5) => RawClient::new_proxy_ssl(
                     url.as_str(),
@@ -121,19 +127,36 @@ impl ClientType {
                     RawClient::new_ssl(url.as_str(), config.validate_domain(), config.timeout())?
                 }
             };
+            #[cfg(not(feature = "proxy"))]
+            let client =
+                RawClient::new_ssl(url.as_str(), config.validate_domain(), config.timeout())?;
 
-            Ok(ClientType::SSL(client))
-        } else {
-            let url = url.replacen("tcp://", "", 1);
+            return Ok(ClientType::SSL(client));
+        }
 
-            Ok(match config.socks5().as_ref() {
-                None => ClientType::TCP(RawClient::new(url.as_str(), config.timeout())?),
+        #[cfg(not(any(feature = "openssl", feature = "rustls", feature = "rustls-ring")))]
+        if url.starts_with("ssl://") {
+            return Err(Error::Message(
+                "SSL connections require one of the following features to be enabled: openssl, rustls, or rustls-ring".to_string()
+            ));
+        }
+
+        {
+            let url = url.replacen("tcp://", "", 1);
+            #[cfg(feature = "proxy")]
+            let client = match config.socks5() {
                 Some(socks5) => ClientType::Socks5(RawClient::new_proxy(
                     url.as_str(),
                     socks5,
                     config.timeout(),
                 )?),
-            })
+                None => ClientType::TCP(RawClient::new(url.as_str(), config.timeout())?),
+            };
+
+            #[cfg(not(feature = "proxy"))]
+            let client = ClientType::TCP(RawClient::new(url.as_str(), config.timeout())?);
+
+            Ok(client)
         }
     }
 }
@@ -381,7 +404,6 @@ impl ElectrumApi for Client {
     }
 
     #[inline]
-    #[cfg(feature = "debug-calls")]
     fn calls_made(&self) -> Result<usize, Error> {
         impl_inner_call!(self, calls_made)
     }

src/lib.rs

@@ -7,7 +7,7 @@
 //! plaintext connections over a socks proxy, useful for Onion servers. Using different features,
 //! the SSL implementation can be removed or replaced with [`openssl`](https://docs.rs/openssl).
 //!
-//! A `minimal` configuration is also provided, which only includes the plaintext TCP client.
+//! For a minimal configuration the library can be built with `--no-default-features`, which only includes the plaintext TCP client.
 //!
 //! # Example
 //!
@@ -22,46 +22,30 @@
 pub extern crate bitcoin;
 extern crate core;
 extern crate log;
-#[cfg(feature = "use-openssl")]
+#[cfg(feature = "openssl")]
 extern crate openssl;
-#[cfg(all(
-    any(
-        feature = "default",
-        feature = "use-rustls",
-        feature = "use-rustls-ring"
-    ),
-    not(feature = "use-openssl")
-))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 extern crate rustls;
 extern crate serde;
 extern crate serde_json;
 
-#[cfg(any(
-    feature = "default",
-    feature = "use-rustls",
-    feature = "use-rustls-ring"
-))]
+#[cfg(any(feature = "rustls", feature = "rustls-ring"))]
 extern crate webpki_roots;
 
-#[cfg(any(feature = "default", feature = "proxy"))]
+#[cfg(feature = "proxy")]
 extern crate byteorder;
 
-#[cfg(all(unix, any(feature = "default", feature = "proxy")))]
+#[cfg(all(unix, feature = "proxy"))]
 extern crate libc;
-#[cfg(all(windows, any(feature = "default", feature = "proxy")))]
+#[cfg(all(windows, feature = "proxy"))]
 extern crate winapi;
 
-#[cfg(any(feature = "default", feature = "proxy"))]
+#[cfg(feature = "proxy")]
 pub mod socks;
 
 mod api;
 mod batch;
 
-#[cfg(any(
-    all(feature = "proxy", feature = "use-openssl"),
-    all(feature = "proxy", feature = "use-rustls"),
-    all(feature = "proxy", feature = "use-rustls-ring")
-))]
 pub mod client;
 
 mod config;
@@ -73,11 +57,6 @@ pub mod utils;
 
 pub use api::ElectrumApi;
 pub use batch::Batch;
-#[cfg(any(
-    all(feature = "proxy", feature = "use-openssl"),
-    all(feature = "proxy", feature = "use-rustls"),
-    all(feature = "proxy", feature = "use-rustls-ring")
-))]
 pub use client::*;
 pub use config::{Config, ConfigBuilder, Socks5Config};
 pub use types::*;