feat: introduce bdk_common crate with log macros

Author: LagginTimes

Cargo.toml

@@ -8,6 +8,7 @@ members = [
     "crates/esplora",
     "crates/bitcoind_rpc",
     "crates/testenv",
+    "crates/common",
     "examples/example_cli",
     "examples/example_electrum",
     "examples/example_esplora",

crates/bitcoind_rpc/Cargo.toml

@@ -19,7 +19,7 @@ workspace = true
 bitcoin = { version = "0.32.0", default-features = false }
 bitcoincore-rpc = { version = "0.19.0" }
 bdk_core = { path = "../core", version = "0.6.0", default-features = false }
-tracing = { version = "0.1", optional = true }
+bdk_common = { path = "../common" }
 
 [dev-dependencies]
 bdk_bitcoind_rpc = { path = "." }
@@ -30,7 +30,7 @@ bdk_chain = { path = "../chain" }
 default = ["std"]
 std = ["bitcoin/std", "bdk_core/std"]
 serde = ["bitcoin/serde", "bdk_core/serde"]
-tracing-logs = ["tracing"]
+log = ["bdk_common/log"]
 
 [[example]]
 name = "filter_iter"

crates/bitcoind_rpc/src/lib.rs

@@ -14,16 +14,17 @@
 #[macro_use]
 extern crate alloc;
 
+#[allow(unused_imports)]
+#[macro_use]
+extern crate bdk_common;
+
 use alloc::sync::Arc;
 use bdk_core::collections::{HashMap, HashSet};
 use bdk_core::{BlockId, CheckPoint};
 use bitcoin::{Block, BlockHash, Transaction, Txid};
 use bitcoincore_rpc::{bitcoincore_rpc_json, RpcApi};
 use core::ops::Deref;
 
-#[cfg(feature = "tracing-logs")]
-use tracing::trace;
-
 pub mod bip158;
 
 pub use bitcoincore_rpc;
@@ -127,8 +128,7 @@ where
     pub fn mempool_at(&mut self, sync_time: u64) -> Result<MempoolEvent, bitcoincore_rpc::Error> {
         let client = &*self.client;
 
-        #[cfg(feature = "tracing-logs")]
-        trace!(
+        log_trace!(
             start_height = self.start_height,
             sync_time = sync_time,
             "enter mempool_at"
@@ -174,8 +174,7 @@ where
             ..Default::default()
         };
 
-        #[cfg(feature = "tracing-logs")]
-        trace!(
+        log_trace!(
             rpc_mempool_count = rpc_mempool_txids.len(),
             rpc_height = rpc_tip_height,
             rpc_block_hash = %rpc_tip_hash,
@@ -218,8 +217,7 @@ where
 
     /// Emit the next block height and block (if any).
     pub fn next_block(&mut self) -> Result<Option<BlockEvent<Block>>, bitcoincore_rpc::Error> {
-        #[cfg(feature = "tracing-logs")]
-        trace!(
+        log_trace!(
             last_block_height = self.last_block.as_ref().map(|r| r.height),
             "enter next_block"
         );
@@ -229,8 +227,7 @@ where
             for tx in &block.txdata {
                 self.mempool_snapshot.remove(&tx.compute_txid());
             }
-            #[cfg(feature = "tracing-logs")]
-            trace!(
+            log_trace!(
                 block_height = checkpoint.height(),
                 tx_count = block.txdata.len(),
                 "emit block"
@@ -309,8 +306,7 @@ where
     C: Deref,
     C::Target: RpcApi,
 {
-    #[cfg(feature = "tracing-logs")]
-    trace!(
+    log_trace!(
         last_block_height = emitter.last_block.as_ref().map(|r| r.height),
         start_height = emitter.start_height,
         "enter poll_once"
@@ -324,16 +320,14 @@ where
             let next_hash = client.get_block_hash(emitter.start_height as _)?;
             // make sure last emission is still in best chain
             if client.get_block_hash(last_res.height as _)? != last_res.hash {
-                #[cfg(feature = "tracing-logs")]
-                trace!("block not in best chain");
+                log_trace!("block not in best chain");
                 return Ok(PollResponse::BlockNotInBestChain);
             }
             next_hash
         } else {
             match last_res.nextblockhash {
                 None => {
-                    #[cfg(feature = "tracing-logs")]
-                    trace!("no more blocks");
+                    log_trace!("no more blocks");
                     return Ok(PollResponse::NoMoreBlocks);
                 }
                 Some(next_hash) => next_hash,
@@ -342,13 +336,11 @@ where
 
         let res = client.get_block_info(&next_hash)?;
         if res.confirmations < 0 {
-            #[cfg(feature = "tracing-logs")]
-            trace!("block not in best chain");
+            log_trace!("block not in best chain");
             return Ok(PollResponse::BlockNotInBestChain);
         }
 
-        #[cfg(feature = "tracing-logs")]
-        trace!(
+        log_trace!(
             height = res.height,
             hash   = %res.hash,
             "agreement found"
@@ -372,8 +364,7 @@ where
         };
 
         // agreement point found
-        #[cfg(feature = "tracing-logs")]
-        trace!(
+        log_trace!(
             "poll(): PollResponse::AgreementFound, height={}, hash={}",
             res.height,
             res.hash

crates/common/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "bdk_common"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.63"
+homepage = "https://bitcoindevkit.org"
+repository = "https://github.com/bitcoindevkit/bdk"
+description = "Shared utilities and macros for BDK chain sources."
+license = "MIT OR Apache-2.0"
+publish = false
+
+[dependencies]
+tracing = { version = "0.1", optional = true }
+
+[features]
+log = ["tracing"]

crates/common/src/lib.rs

@@ -0,0 +1,5 @@
+#[cfg(feature = "log")]
+pub use tracing;
+
+#[macro_use]
+mod log;

crates/common/src/log.rs

@@ -0,0 +1,99 @@
+/// Trace-level logging. Expands to `tracing::trace!()` when the `log` feature is enabled,
+/// otherwise into a no-op.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_trace {
+    ($($tt:tt)*) => {
+        $crate::tracing::trace!($($tt)*);
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_trace {
+    ($($tt:tt)*) => {};
+}
+
+/// Trace-level span. Expands to `tracing::trace_span!()` when the `log` feature is enabled,
+/// otherwise to a dummy no-op span whose `.entered()` does nothing.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_span {
+    ( $($tts:tt)* ) => {
+        $crate::tracing::trace_span!($($tts)*)
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_span {
+    ( $($tts:tt)* ) => {{
+        struct NoopSpan;
+        impl NoopSpan {
+            #[allow(dead_code)]
+            pub fn entered(self) -> NoopEntered {
+                NoopEntered
+            }
+        }
+        struct NoopEntered;
+        NoopSpan
+    }};
+}
+
+/// Debug-level logging. Expands to `tracing::debug!()` when the `log` feature is enabled,
+/// otherwise into a no-op.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_debug {
+    ($($tt:tt)*) => {
+        $crate::tracing::debug!($($tt)*);
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_debug {
+    ($($tt:tt)*) => {};
+}
+
+/// Info-level logging. Expands to `tracing::info!()` when the `log` feature is enabled,
+/// otherwise into a no-op.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_info {
+    ($($tt:tt)*) => {
+        $crate::tracing::info!($($tt)*);
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_info {
+    ($($tt:tt)*) => {};
+}
+
+/// Warn-level logging. Expands to `tracing::warn!()` when the `log` feature is enabled,
+/// otherwise into a no-op.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_warn {
+    ($($tt:tt)*) => {
+        $crate::tracing::warn!($($tt)*);
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_warn {
+    ($($tt:tt)*) => {};
+}
+
+/// Error-level logging. Expands to `tracing::error!()` when the `log` feature is enabled,
+/// otherwise into a no-op.
+#[cfg(feature = "log")]
+#[macro_export]
+macro_rules! log_error {
+    ($($tt:tt)*) => {
+        $crate::tracing::error!($($tt)*);
+    };
+}
+#[cfg(not(feature = "log"))]
+#[macro_export]
+macro_rules! log_error {
+    ($($tt:tt)*) => {};
+}

crates/electrum/Cargo.toml

@@ -14,8 +14,8 @@ workspace = true
 
 [dependencies]
 bdk_core = { path = "../core", version = "0.6.0" }
+bdk_common = { path = "../common" }
 electrum-client = { version = "0.24.0", features = [ "proxy" ], default-features = false }
-tracing = { version = "0.1", optional = true }
 
 [dev-dependencies]
 bdk_testenv = { path = "../testenv" }
@@ -27,7 +27,7 @@ default = ["use-rustls"]
 use-rustls = ["electrum-client/use-rustls"]
 use-rustls-ring = ["electrum-client/use-rustls-ring"]
 use-openssl = ["electrum-client/use-openssl"]
-tracing-logs = ["tracing"]
+log = ["bdk_common/log"]
 
 [[test]]
 name = "test_electrum"