chore: gate criterion benches behind cfg(bdk_bench)

ci: bump nightly docs toolchain to 2024-11-17

Author: ValuedMammal

.github/workflows/nightly_docs.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v4
       - name: Set default toolchain
-        run: rustup default nightly-2024-05-12
+        run: rustup default nightly-2024-11-17
       - name: Set profile
         run: rustup set profile minimal
       - name: Update toolchain

Cargo.toml

@@ -26,3 +26,9 @@ authors = ["Bitcoin Dev Kit Developers"]
 [workspace.lints.clippy]
 print_stdout = "deny"
 print_stderr = "deny"
+
+[workspace.lints.rust.unexpected_cfgs]
+level = "forbid"
+check-cfg = [
+    "cfg(bdk_bench)",
+]

bench/Cargo.toml

@@ -8,5 +8,5 @@ name = "bench"
 harness = false
 
 [dependencies]
-bdk_chain = { path = "../crates/chain" }
+bdk_chain = { path = "../crates/chain", features = ["criterion"] }
 criterion = { version = "0.5", default-features = false }

bench/README.md

@@ -1,3 +1,5 @@
-# To run benches
+# BDK bench
 
-`cargo bench`
+To run benchmarks in the current directory:
+    
+`RUSTFLAGS="--cfg=bdk_bench" cargo bench`

crates/chain/Cargo.toml

@@ -20,7 +20,6 @@ bitcoin = { version = "0.32.0", default-features = false }
 bdk_core = { path = "../core", version = "0.3.0", default-features = false }
 serde = { version = "1", optional = true, features = ["derive", "rc"] }
 miniscript = { version = "12.0.0", optional = true, default-features = false }
-criterion = { version = "0.5", default-features = false }
 
 # Feature dependencies
 rusqlite = { version = "0.31.0", features = ["bundled"], optional = true }
@@ -31,6 +30,9 @@ rand = "0.8"
 proptest = "1.2.0"
 bdk_testenv = { path = "../testenv", default-features = false }
 
+[target.'cfg(bdk_bench)'.dependencies]
+criterion = { version = "0.5", optional = true, default-features = false }
+
 
 [features]
 default = ["std", "miniscript"]

crates/chain/src/lib.rs

@@ -68,6 +68,8 @@ pub use bdk_core::*;
 #[allow(unused_imports)]
 #[macro_use]
 extern crate alloc;
+#[cfg(bdk_bench)]
+extern crate criterion;
 #[cfg(feature = "rusqlite")]
 pub extern crate rusqlite;
 #[cfg(feature = "serde")]

crates/chain/src/tx_graph.rs

@@ -1557,6 +1557,7 @@ fn tx_outpoint_range(txid: Txid) -> RangeInclusive<OutPoint> {
 /// Bench
 #[allow(unused)]
 #[allow(missing_docs)]
+#[cfg(bdk_bench)]
 pub mod bench {
     use std::str::FromStr;
 
@@ -1652,14 +1653,13 @@ pub mod bench {
     pub fn filter_chain_unspents(bench: &mut Criterion) {
         let (graph, chain) = get_params();
         // TODO: insert conflicts
-        let outpoints = graph.index.outpoints().clone();
         bench.bench_function("filter_chain_unspents", |b| {
             b.iter(|| {
                 TxGraph::filter_chain_unspents(
                     graph.graph(),
                     &chain,
                     chain.tip().block_id(),
-                    outpoints.clone(),
+                    graph.index.outpoints().clone(),
                 )
             })
         });