esplora_client/

lib.rs

//! An extensible blocking/async Esplora client
//!
//! This library provides an extensible blocking and
//! async Esplora client to query Esplora's backend.
//!
//! The library provides the possibility to build a blocking
//! client using [`minreq`] and an async client using [`reqwest`].
//! The library supports communicating to Esplora via a proxy
//! and also using TLS (SSL) for secure communication.
//!
//!
//! ## Usage
//!
//! You can create a blocking client as follows:
//!
//! ```no_run
//! # #[cfg(feature = "blocking")]
//! # {
//! use esplora_client::Builder;
//! let builder = Builder::new("https://blockstream.info/testnet/api");
//! let blocking_client = builder.build_blocking();
//! # Ok::<(), esplora_client::Error>(());
//! # }
//! ```
//!
//! Here is an example of how to create an asynchronous client.
//!
//! ```no_run
//! # #[cfg(all(feature = "async", feature = "tokio"))]
//! # {
//! use esplora_client::Builder;
//! let builder = Builder::new("https://blockstream.info/testnet/api");
//! let async_client = builder.build_async();
//! # Ok::<(), esplora_client::Error>(());
//! # }
//! ```
//!
//! ## Features
//!
//! By default the library enables all features. To specify
//! specific features, set `default-features` to `false` in your `Cargo.toml`
//! and specify the features you want. This will look like this:
//!
//! `esplora-client = { version = "*", default-features = false, features =
//! ["blocking"] }`
//!
//! * `blocking` enables [`minreq`], the blocking client with proxy.
//! * `blocking-https` enables [`minreq`], the blocking client with proxy and TLS (SSL) capabilities
//!   using the default [`minreq`] backend.
//! * `blocking-https-rustls` enables [`minreq`], the blocking client with proxy and TLS (SSL)
//!   capabilities using the `rustls` backend.
//! * `blocking-https-native` enables [`minreq`], the blocking client with proxy and TLS (SSL)
//!   capabilities using the platform's native TLS backend (likely OpenSSL).
//! * `blocking-https-bundled` enables [`minreq`], the blocking client with proxy and TLS (SSL)
//!   capabilities using a bundled OpenSSL library backend.
//! * `async` enables [`reqwest`], the async client with proxy capabilities.
//! * `async-https` enables [`reqwest`], the async client with support for proxying and TLS (SSL)
//!   using the default [`reqwest`] TLS backend.
//! * `async-https-native` enables [`reqwest`], the async client with support for proxying and TLS
//!   (SSL) using the platform's native TLS backend (likely OpenSSL).
//! * `async-https-rustls` enables [`reqwest`], the async client with support for proxying and TLS
//!   (SSL) using the `rustls` TLS backend.
//! * `async-https-rustls-manual-roots` enables [`reqwest`], the async client with support for
//!   proxying and TLS (SSL) using the `rustls` TLS backend without using the default root
//!   certificates.
//!
//! [`dont remove this line or cargo doc will break`]: https://example.com
#![cfg_attr(not(feature = "minreq"), doc = "[`minreq`]: https://docs.rs/minreq")]
#![cfg_attr(not(feature = "reqwest"), doc = "[`reqwest`]: https://docs.rs/reqwest")]
#![allow(clippy::result_large_err)]
#![warn(missing_docs)]

use std::collections::HashMap;
use std::fmt;
use std::num::TryFromIntError;
use std::time::Duration;

#[cfg(feature = "async")]
pub use r#async::Sleeper;

pub mod api;
#[cfg(feature = "async")]
pub mod r#async;
#[cfg(feature = "blocking")]
pub mod blocking;

pub use api::*;
#[cfg(feature = "blocking")]
pub use blocking::BlockingClient;
#[cfg(feature = "async")]
pub use r#async::AsyncClient;

/// Response status codes for which the request may be retried.
pub const RETRYABLE_ERROR_CODES: [u16; 3] = [
    429, // TOO_MANY_REQUESTS
    500, // INTERNAL_SERVER_ERROR
    503, // SERVICE_UNAVAILABLE
];

/// Base backoff in milliseconds.
const BASE_BACKOFF_MILLIS: Duration = Duration::from_millis(256);

/// Default max retries.
const DEFAULT_MAX_RETRIES: usize = 6;

/// Get a fee value in sats/vbytes from the estimates
/// that matches the confirmation target set as parameter.
///
/// Returns `None` if no feerate estimate is found at or below `target`
/// confirmations.
pub fn convert_fee_rate(target: usize, estimates: HashMap<u16, f64>) -> Option<f32> {
    estimates
        .into_iter()
        .filter(|(k, _)| *k as usize <= target)
        .max_by_key(|(k, _)| *k)
        .map(|(_, v)| v as f32)
}

/// A builder for an [`AsyncClient`] or [`BlockingClient`].
#[derive(Debug, Clone)]
pub struct Builder {
    /// The URL of the Esplora server.
    pub base_url: String,
    /// Optional URL of the proxy to use to make requests to the Esplora server
    ///
    /// The string should be formatted as:
    /// `<protocol>://<user>:<password>@host:<port>`.
    ///
    /// Note that the format of this value and the supported protocols change
    /// slightly between the blocking version of the client (using `minreq`)
    /// and the async version (using `reqwest`). For more details check with
    /// the documentation of the two crates. Both of them are compiled with
    /// the `socks` feature enabled.
    ///
    /// The proxy is ignored when targeting `wasm32`.
    pub proxy: Option<String>,
    /// Socket timeout.
    pub timeout: Option<u64>,
    /// HTTP headers to set on every request made to Esplora server.
    pub headers: HashMap<String, String>,
    /// Max retries
    pub max_retries: usize,
}

impl Builder {
    /// Instantiate a new builder
    pub fn new(base_url: &str) -> Self {
        Builder {
            base_url: base_url.to_string(),
            proxy: None,
            timeout: None,
            headers: HashMap::new(),
            max_retries: DEFAULT_MAX_RETRIES,
        }
    }

    /// Set the proxy of the builder
    pub fn proxy(mut self, proxy: &str) -> Self {
        self.proxy = Some(proxy.to_string());
        self
    }

    /// Set the timeout of the builder
    pub fn timeout(mut self, timeout: u64) -> Self {
        self.timeout = Some(timeout);
        self
    }

    /// Add a header to set on each request
    pub fn header(mut self, key: &str, value: &str) -> Self {
        self.headers.insert(key.to_string(), value.to_string());
        self
    }

    /// Set the maximum number of times to retry a request if the response status
    /// is one of [`RETRYABLE_ERROR_CODES`].
    pub fn max_retries(mut self, count: usize) -> Self {
        self.max_retries = count;
        self
    }

    /// Build a blocking client from builder
    #[cfg(feature = "blocking")]
    pub fn build_blocking(self) -> BlockingClient {
        BlockingClient::from_builder(self)
    }

    /// Build an asynchronous client from builder
    #[cfg(all(feature = "async", feature = "tokio"))]
    pub fn build_async(self) -> Result<AsyncClient, Error> {
        AsyncClient::from_builder(self)
    }

    /// Build an asynchronous client from builder where the returned client uses a
    /// user-defined [`Sleeper`].
    #[cfg(feature = "async")]
    pub fn build_async_with_sleeper<S: Sleeper>(self) -> Result<AsyncClient<S>, Error> {
        AsyncClient::from_builder(self)
    }
}

/// Errors that can happen during a request to `Esplora` servers.
#[derive(Debug)]
pub enum Error {
    /// Error during `minreq` HTTP request
    #[cfg(feature = "blocking")]
    Minreq(::minreq::Error),
    /// Error during reqwest HTTP request
    #[cfg(feature = "async")]
    Reqwest(::reqwest::Error),
    /// HTTP response error
    HttpResponse {
        /// The HTTP status code returned by the server.
        status: u16,
        /// The error message content.
        message: String,
    },
    /// Invalid number returned
    Parsing(std::num::ParseIntError),
    /// Invalid status code, unable to convert to `u16`
    StatusCode(TryFromIntError),
    /// Invalid Bitcoin data returned
    BitcoinEncoding(bitcoin::consensus::encode::Error),
    /// Invalid hex data returned (attempting to create an array)
    HexToArray(bitcoin::hex::HexToArrayError),
    /// Invalid hex data returned (attempting to create a vector)
    HexToBytes(bitcoin::hex::HexToBytesError),
    /// Transaction not found
    TransactionNotFound(Txid),
    /// Block Header height not found
    HeaderHeightNotFound(u32),
    /// Block Header hash not found
    HeaderHashNotFound(BlockHash),
    /// Invalid HTTP Header name specified
    InvalidHttpHeaderName(String),
    /// Invalid HTTP Header value specified
    InvalidHttpHeaderValue(String),
    /// The server sent an invalid response
    InvalidResponse,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{self:?}")
    }
}

macro_rules! impl_error {
    ( $from:ty, $to:ident ) => {
        impl_error!($from, $to, Error);
    };
    ( $from:ty, $to:ident, $impl_for:ty ) => {
        impl std::convert::From<$from> for $impl_for {
            fn from(err: $from) -> Self {
                <$impl_for>::$to(err)
            }
        }
    };
}

impl std::error::Error for Error {}
#[cfg(feature = "blocking")]
impl_error!(::minreq::Error, Minreq, Error);
#[cfg(feature = "async")]
impl_error!(::reqwest::Error, Reqwest, Error);
impl_error!(std::num::ParseIntError, Parsing, Error);
impl_error!(bitcoin::consensus::encode::Error, BitcoinEncoding, Error);
impl_error!(bitcoin::hex::HexToArrayError, HexToArray, Error);
impl_error!(bitcoin::hex::HexToBytesError, HexToBytes, Error);

#[cfg(test)]
mod test {
    use super::*;
    use electrsd::{corepc_node, ElectrsD};
    use lazy_static::lazy_static;
    use std::env;
    use std::str::FromStr;
    use tokio::sync::Mutex;
    #[cfg(all(feature = "blocking", feature = "async"))]
    use {
        bitcoin::{hashes::Hash, Amount},
        corepc_node::AddressType,
        electrsd::electrum_client::ElectrumApi,
        std::time::Duration,
        tokio::sync::OnceCell,
    };

    lazy_static! {
        static ref BITCOIND: corepc_node::Node = {
            let bitcoind_exe = env::var("BITCOIND_EXE")
                .ok()
                .or_else(|| corepc_node::downloaded_exe_path().ok())
                .expect(
                    "you need to provide an env var BITCOIND_EXE or specify a bitcoind version feature",
                );
            let conf = corepc_node::Conf::default();
            corepc_node::Node::with_conf(bitcoind_exe, &conf).unwrap()
        };
        static ref ELECTRSD: ElectrsD = {
            let electrs_exe = env::var("ELECTRS_EXE")
                .ok()
                .or_else(electrsd::downloaded_exe_path)
                .expect(
                    "you need to provide env var ELECTRS_EXE or specify an electrsd version feature",
                );
            let mut conf = electrsd::Conf::default();
            conf.http_enabled = true;
            ElectrsD::with_conf(electrs_exe, &BITCOIND, &conf).unwrap()
        };
        static ref MINER: Mutex<()> = Mutex::new(());
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    static PREMINE: OnceCell<()> = OnceCell::const_new();

    #[cfg(all(feature = "blocking", feature = "async"))]
    async fn setup_clients() -> (BlockingClient, AsyncClient) {
        setup_clients_with_headers(HashMap::new()).await
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    async fn setup_clients_with_headers(
        headers: HashMap<String, String>,
    ) -> (BlockingClient, AsyncClient) {
        PREMINE
            .get_or_init(|| async {
                let _miner = MINER.lock().await;
                generate_blocks_and_wait(101);
            })
            .await;

        let esplora_url = ELECTRSD.esplora_url.as_ref().unwrap();

        let mut builder = Builder::new(&format!("http://{esplora_url}"));
        if !headers.is_empty() {
            builder.headers = headers;
        }

        let blocking_client = builder.build_blocking();

        let builder_async = Builder::new(&format!("http://{esplora_url}"));

        #[cfg(feature = "tokio")]
        let async_client = builder_async.build_async().unwrap();

        #[cfg(not(feature = "tokio"))]
        let async_client = builder_async
            .build_async_with_sleeper::<r#async::DefaultSleeper>()
            .unwrap();

        (blocking_client, async_client)
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    fn generate_blocks_and_wait(num: usize) {
        let cur_height = BITCOIND.client.get_block_count().unwrap().0;
        generate_blocks(num);
        wait_for_block(cur_height as usize + num);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    fn generate_blocks(num: usize) {
        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let _block_hashes = BITCOIND.client.generate_to_address(num, &address).unwrap();
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    fn wait_for_block(min_height: usize) {
        let mut header = ELECTRSD.client.block_headers_subscribe().unwrap();
        loop {
            if header.height >= min_height {
                break;
            }
            header = exponential_backoff_poll(|| {
                ELECTRSD.trigger().unwrap();
                ELECTRSD.client.ping().unwrap();
                ELECTRSD.client.block_headers_pop().unwrap()
            });
        }
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    fn exponential_backoff_poll<T, F>(mut poll: F) -> T
    where
        F: FnMut() -> Option<T>,
    {
        let mut delay = Duration::from_millis(64);
        loop {
            match poll() {
                Some(data) => break data,
                None if delay.as_millis() < 512 => delay = delay.mul_f32(2.0),
                None => {}
            }

            std::thread::sleep(delay);
        }
    }

    #[test]
    fn feerate_parsing() {
        let esplora_fees = serde_json::from_str::<HashMap<u16, f64>>(
            r#"{
  "25": 1.015,
  "5": 2.3280000000000003,
  "12": 2.0109999999999997,
  "15": 1.018,
  "17": 1.018,
  "11": 2.0109999999999997,
  "3": 3.01,
  "2": 4.9830000000000005,
  "6": 2.2359999999999998,
  "21": 1.018,
  "13": 1.081,
  "7": 2.2359999999999998,
  "8": 2.2359999999999998,
  "16": 1.018,
  "20": 1.018,
  "22": 1.017,
  "23": 1.017,
  "504": 1,
  "9": 2.2359999999999998,
  "14": 1.018,
  "10": 2.0109999999999997,
  "24": 1.017,
  "1008": 1,
  "1": 4.9830000000000005,
  "4": 2.3280000000000003,
  "19": 1.018,
  "144": 1,
  "18": 1.018
}
"#,
        )
        .unwrap();
        assert!(convert_fee_rate(1, HashMap::new()).is_none());
        assert_eq!(convert_fee_rate(6, esplora_fees.clone()).unwrap(), 2.236);
        assert_eq!(
            convert_fee_rate(26, esplora_fees.clone()).unwrap(),
            1.015,
            "should inherit from value for 25"
        );
        assert!(
            convert_fee_rate(0, esplora_fees).is_none(),
            "should not return feerate for 0 target"
        );
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx = blocking_client.get_tx(&txid).unwrap();
        let tx_async = async_client.get_tx(&txid).await.unwrap();
        assert_eq!(tx, tx_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx_no_opt() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx_no_opt = blocking_client.get_tx_no_opt(&txid).unwrap();
        let tx_no_opt_async = async_client.get_tx_no_opt(&txid).await.unwrap();
        assert_eq!(tx_no_opt, tx_no_opt_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx_status() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx_status = blocking_client.get_tx_status(&txid).unwrap();
        let tx_status_async = async_client.get_tx_status(&txid).await.unwrap();
        assert_eq!(tx_status, tx_status_async);
        assert!(tx_status.confirmed);

        // Bogus txid returns a TxStatus with false, None, None, None
        let txid = Txid::hash(b"ayyyy lmao");
        let tx_status = blocking_client.get_tx_status(&txid).unwrap();
        let tx_status_async = async_client.get_tx_status(&txid).await.unwrap();
        assert_eq!(tx_status, tx_status_async);
        assert!(!tx_status.confirmed);
        assert!(tx_status.block_height.is_none());
        assert!(tx_status.block_hash.is_none());
        assert!(tx_status.block_time.is_none());
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx_info() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx_res = BITCOIND
            .client
            .get_transaction(txid)
            .unwrap()
            .into_model()
            .unwrap();
        let tx_exp: Transaction = tx_res.tx;
        let tx_block_height = BITCOIND
            .client
            .get_block_header_verbose(&tx_res.block_hash.unwrap())
            .unwrap()
            .into_model()
            .unwrap()
            .height;

        let tx_info = blocking_client
            .get_tx_info(&txid)
            .unwrap()
            .expect("must get tx");
        let tx_info_async = async_client
            .get_tx_info(&txid)
            .await
            .unwrap()
            .expect("must get tx");
        assert_eq!(tx_info, tx_info_async);
        assert_eq!(tx_info.txid, txid);
        assert_eq!(tx_info.to_tx(), tx_exp);
        assert_eq!(tx_info.size, tx_exp.total_size());
        assert_eq!(tx_info.weight(), tx_exp.weight());
        assert_eq!(tx_info.fee(), tx_res.fee.unwrap().unsigned_abs());
        assert!(tx_info.status.confirmed);
        assert_eq!(tx_info.status.block_height, Some(tx_block_height));
        assert_eq!(tx_info.status.block_hash, tx_res.block_hash);
        assert_eq!(
            tx_info.status.block_time,
            tx_res.block_time.map(|bt| bt as u64)
        );

        let txid = Txid::hash(b"not exist");
        assert_eq!(blocking_client.get_tx_info(&txid).unwrap(), None);
        assert_eq!(async_client.get_tx_info(&txid).await.unwrap(), None);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_header_by_hash() {
        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BITCOIND
            .client
            .get_block_hash(23)
            .unwrap()
            .block_hash()
            .unwrap();

        let block_header = blocking_client.get_header_by_hash(&block_hash).unwrap();
        let block_header_async = async_client.get_header_by_hash(&block_hash).await.unwrap();
        assert_eq!(block_header, block_header_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_status() {
        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BITCOIND
            .client
            .get_block_hash(21)
            .unwrap()
            .block_hash()
            .unwrap();
        let next_block_hash = BITCOIND
            .client
            .get_block_hash(22)
            .unwrap()
            .block_hash()
            .unwrap();

        let expected = BlockStatus {
            in_best_chain: true,
            height: Some(21),
            next_best: Some(next_block_hash),
        };

        let block_status = blocking_client.get_block_status(&block_hash).unwrap();
        let block_status_async = async_client.get_block_status(&block_hash).await.unwrap();
        assert_eq!(expected, block_status);
        assert_eq!(expected, block_status_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_non_existing_block_status() {
        // Esplora returns the same status for orphaned blocks as for non-existing
        // blocks: non-existing: https://blockstream.info/api/block/0000000000000000000000000000000000000000000000000000000000000000/status
        // orphaned: https://blockstream.info/api/block/000000000000000000181b1a2354620f66868a723c0c4d5b24e4be8bdfc35a7f/status
        // (Here the block is cited as orphaned: https://bitcoinchain.com/block_explorer/block/000000000000000000181b1a2354620f66868a723c0c4d5b24e4be8bdfc35a7f/ )
        // For this reason, we only test for the non-existing case here.

        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BlockHash::all_zeros();

        let expected = BlockStatus {
            in_best_chain: false,
            height: None,
            next_best: None,
        };

        let block_status = blocking_client.get_block_status(&block_hash).unwrap();
        let block_status_async = async_client.get_block_status(&block_hash).await.unwrap();
        assert_eq!(expected, block_status);
        assert_eq!(expected, block_status_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_by_hash() {
        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BITCOIND
            .client
            .get_block_hash(21)
            .unwrap()
            .block_hash()
            .unwrap();

        let expected = Some(BITCOIND.client.get_block(block_hash).unwrap());

        let block = blocking_client.get_block_by_hash(&block_hash).unwrap();
        let block_async = async_client.get_block_by_hash(&block_hash).await.unwrap();
        assert_eq!(expected, block);
        assert_eq!(expected, block_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_that_errors_are_propagated() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx = blocking_client.get_tx(&txid).unwrap();
        let async_res = async_client.broadcast(tx.as_ref().unwrap()).await;
        let blocking_res = blocking_client.broadcast(tx.as_ref().unwrap());
        assert!(async_res.is_err());
        assert!(matches!(
            async_res.unwrap_err(),
            Error::HttpResponse { status: 400, message } if message.contains("-27")
        ));
        assert!(blocking_res.is_err());
        assert!(matches!(
            blocking_res.unwrap_err(),
            Error::HttpResponse { status: 400, message } if message.contains("-27")
        ));
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_by_hash_not_existing() {
        let (blocking_client, async_client) = setup_clients().await;

        let block = blocking_client
            .get_block_by_hash(&BlockHash::all_zeros())
            .unwrap();
        let block_async = async_client
            .get_block_by_hash(&BlockHash::all_zeros())
            .await
            .unwrap();
        assert!(block.is_none());
        assert!(block_async.is_none());
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_merkle_proof() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let merkle_proof = blocking_client.get_merkle_proof(&txid).unwrap().unwrap();
        let merkle_proof_async = async_client.get_merkle_proof(&txid).await.unwrap().unwrap();
        assert_eq!(merkle_proof, merkle_proof_async);
        assert!(merkle_proof.pos > 0);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_merkle_block() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let merkle_block = blocking_client.get_merkle_block(&txid).unwrap().unwrap();
        let merkle_block_async = async_client.get_merkle_block(&txid).await.unwrap().unwrap();
        assert_eq!(merkle_block, merkle_block_async);

        let mut matches = vec![txid];
        let mut indexes = vec![];
        let root = merkle_block
            .txn
            .extract_matches(&mut matches, &mut indexes)
            .unwrap();
        assert_eq!(root, merkle_block.header.merkle_root);
        assert_eq!(indexes.len(), 1);
        assert!(indexes[0] > 0);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_output_status() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let output_status = blocking_client
            .get_output_status(&txid, 1)
            .unwrap()
            .unwrap();
        let output_status_async = async_client
            .get_output_status(&txid, 1)
            .await
            .unwrap()
            .unwrap();

        assert_eq!(output_status, output_status_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_height() {
        let (blocking_client, async_client) = setup_clients().await;
        let block_height = blocking_client.get_height().unwrap();
        let block_height_async = async_client.get_height().await.unwrap();
        assert!(block_height > 0);
        assert_eq!(block_height, block_height_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tip_hash() {
        let (blocking_client, async_client) = setup_clients().await;
        let tip_hash = blocking_client.get_tip_hash().unwrap();
        let tip_hash_async = async_client.get_tip_hash().await.unwrap();
        assert_eq!(tip_hash, tip_hash_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_hash() {
        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BITCOIND
            .client
            .get_block_hash(21)
            .unwrap()
            .block_hash()
            .unwrap();

        let block_hash_blocking = blocking_client.get_block_hash(21).unwrap();
        let block_hash_async = async_client.get_block_hash(21).await.unwrap();
        assert_eq!(block_hash, block_hash_blocking);
        assert_eq!(block_hash, block_hash_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_txid_at_block_index() {
        let (blocking_client, async_client) = setup_clients().await;

        let block_hash = BITCOIND
            .client
            .get_block_hash(23)
            .unwrap()
            .block_hash()
            .unwrap();

        let txid_at_block_index = blocking_client
            .get_txid_at_block_index(&block_hash, 0)
            .unwrap()
            .unwrap();
        let txid_at_block_index_async = async_client
            .get_txid_at_block_index(&block_hash, 0)
            .await
            .unwrap()
            .unwrap();
        assert_eq!(txid_at_block_index, txid_at_block_index_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_fee_estimates() {
        let (blocking_client, async_client) = setup_clients().await;
        let fee_estimates = blocking_client.get_fee_estimates().unwrap();
        let fee_estimates_async = async_client.get_fee_estimates().await.unwrap();
        assert_eq!(fee_estimates.len(), fee_estimates_async.len());
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_scripthash_txs() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let expected_tx = BITCOIND
            .client
            .get_transaction(txid)
            .unwrap()
            .into_model()
            .unwrap()
            .tx;
        let script = &expected_tx.output[0].script_pubkey;
        let scripthash_txs_txids: Vec<Txid> = blocking_client
            .scripthash_txs(script, None)
            .unwrap()
            .iter()
            .map(|tx| tx.txid)
            .collect();
        let scripthash_txs_txids_async: Vec<Txid> = async_client
            .scripthash_txs(script, None)
            .await
            .unwrap()
            .iter()
            .map(|tx| tx.txid)
            .collect();
        assert_eq!(scripthash_txs_txids, scripthash_txs_txids_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_info() {
        let (blocking_client, async_client) = setup_clients().await;

        // Genesis block `BlockHash` on regtest.
        let blockhash_genesis =
            BlockHash::from_str("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206")
                .unwrap();

        let block_info_blocking = blocking_client.get_block_info(&blockhash_genesis).unwrap();
        let block_info_async = async_client
            .get_block_info(&blockhash_genesis)
            .await
            .unwrap();

        assert_eq!(block_info_async, block_info_blocking);
        assert_eq!(block_info_async.id, blockhash_genesis);
        assert_eq!(block_info_async.height, 0);
        assert_eq!(block_info_async.previousblockhash, None);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_txids() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        // Create 5 transactions and mine a block.
        let txids: Vec<_> = (0..5)
            .map(|_| {
                BITCOIND
                    .client
                    .send_to_address(&address, Amount::from_sat(1000))
                    .unwrap()
                    .txid()
                    .unwrap()
            })
            .collect();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        // Get the block hash at the chain's tip.
        let blockhash = blocking_client.get_tip_hash().unwrap();

        let txids_async = async_client.get_block_txids(&blockhash).await.unwrap();
        let txids_blocking = blocking_client.get_block_txids(&blockhash).unwrap();

        assert_eq!(txids_async, txids_blocking);

        // Compare expected and received (skipping the coinbase TXID).
        for expected_txid in txids.iter() {
            assert!(txids_async.contains(expected_txid));
        }
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_txs() {
        let (blocking_client, async_client) = setup_clients().await;

        let _miner = MINER.lock().await;
        let blockhash = blocking_client.get_tip_hash().unwrap();

        let txs_blocking = blocking_client.get_block_txs(&blockhash, None).unwrap();
        let txs_async = async_client.get_block_txs(&blockhash, None).await.unwrap();

        assert_ne!(txs_blocking.len(), 0);
        assert_eq!(txs_blocking.len(), txs_async.len());
    }

    #[allow(deprecated)]
    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_blocks() {
        let (blocking_client, async_client) = setup_clients().await;
        let start_height = BITCOIND.client.get_block_count().unwrap().0;
        let blocks1 = blocking_client.get_blocks(None).unwrap();
        let blocks_async1 = async_client.get_blocks(None).await.unwrap();
        assert_eq!(blocks1[0].time.height, start_height as u32);
        assert_eq!(blocks1, blocks_async1);
        generate_blocks_and_wait(10);
        let blocks2 = blocking_client.get_blocks(None).unwrap();
        let blocks_async2 = async_client.get_blocks(None).await.unwrap();
        assert_eq!(blocks2, blocks_async2);
        assert_ne!(blocks2, blocks1);
        let blocks3 = blocking_client
            .get_blocks(Some(start_height as u32))
            .unwrap();
        let blocks_async3 = async_client
            .get_blocks(Some(start_height as u32))
            .await
            .unwrap();
        assert_eq!(blocks3, blocks_async3);
        assert_eq!(blocks3[0].time.height, start_height as u32);
        assert_eq!(blocks3, blocks1);
        let blocks_genesis = blocking_client.get_blocks(Some(0)).unwrap();
        let blocks_genesis_async = async_client.get_blocks(Some(0)).await.unwrap();
        assert_eq!(blocks_genesis, blocks_genesis_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_block_infos() {
        let (blocking_client, async_client) = setup_clients().await;

        let start_height = BITCOIND.client.get_block_count().unwrap().0;

        let blocks_blocking_0 = blocking_client.get_block_infos(None).unwrap();
        let blocks_async_0 = async_client.get_block_infos(None).await.unwrap();
        assert_eq!(blocks_blocking_0[0].height, start_height as u32);
        assert_eq!(blocks_blocking_0, blocks_async_0);

        generate_blocks_and_wait(10);

        let blocks_blocking_1 = blocking_client.get_block_infos(None).unwrap();
        let blocks_async_1 = async_client.get_block_infos(None).await.unwrap();
        assert_eq!(blocks_blocking_1, blocks_async_1);
        assert_ne!(blocks_blocking_0, blocks_blocking_1);

        let blocks_blocking_2 = blocking_client
            .get_block_infos(Some(start_height as u32))
            .unwrap();
        let blocks_async_3 = async_client
            .get_block_infos(Some(start_height as u32))
            .await
            .unwrap();
        assert_eq!(blocks_blocking_2, blocks_async_3);
        assert_eq!(blocks_blocking_2[0].height, start_height as u32);
        assert_eq!(blocks_blocking_2, blocks_blocking_0);

        let blocks_blocking_genesis = blocking_client.get_block_infos(Some(0)).unwrap();
        let blocks_async_genesis = async_client.get_block_infos(Some(0)).await.unwrap();
        assert_eq!(blocks_blocking_genesis, blocks_async_genesis);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx_with_http_header() {
        let headers = [(
            "Authorization".to_string(),
            "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==".to_string(),
        )]
        .into();
        let (blocking_client, async_client) = setup_clients_with_headers(headers).await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let tx = blocking_client.get_tx(&txid).unwrap();
        let tx_async = async_client.get_tx(&txid).await.unwrap();
        assert_eq!(tx, tx_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_address_stats() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        let _txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();

        let address_stats_blocking = blocking_client.get_address_stats(&address).unwrap();
        let address_stats_async = async_client.get_address_stats(&address).await.unwrap();
        assert_eq!(address_stats_blocking, address_stats_async);
        assert_eq!(address_stats_async.chain_stats.funded_txo_count, 0);

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let address_stats_blocking = blocking_client.get_address_stats(&address).unwrap();
        let address_stats_async = async_client.get_address_stats(&address).await.unwrap();
        assert_eq!(address_stats_blocking, address_stats_async);
        assert_eq!(address_stats_async.chain_stats.funded_txo_count, 1);
        assert_eq!(address_stats_async.chain_stats.funded_txo_sum, 1000);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_scripthash_stats() {
        let (blocking_client, async_client) = setup_clients().await;

        // Create an address of each type.
        let address_legacy = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let address_p2sh_segwit = BITCOIND
            .client
            .new_address_with_type(AddressType::P2shSegwit)
            .unwrap();
        let address_bech32 = BITCOIND
            .client
            .new_address_with_type(AddressType::Bech32)
            .unwrap();
        let address_bech32m = BITCOIND
            .client
            .new_address_with_type(AddressType::Bech32m)
            .unwrap();

        // Send a transaction to each address.
        let _txid = BITCOIND
            .client
            .send_to_address(&address_legacy, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _txid = BITCOIND
            .client
            .send_to_address(&address_p2sh_segwit, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _txid = BITCOIND
            .client
            .send_to_address(&address_bech32, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();
        let _txid = BITCOIND
            .client
            .send_to_address(&address_bech32m, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        // Derive each addresses script.
        let script_legacy = address_legacy.script_pubkey();
        let script_p2sh_segwit = address_p2sh_segwit.script_pubkey();
        let script_bech32 = address_bech32.script_pubkey();
        let script_bech32m = address_bech32m.script_pubkey();

        // P2PKH
        let scripthash_stats_blocking_legacy = blocking_client
            .get_scripthash_stats(&script_legacy)
            .unwrap();
        let scripthash_stats_async_legacy = async_client
            .get_scripthash_stats(&script_legacy)
            .await
            .unwrap();
        assert_eq!(
            scripthash_stats_blocking_legacy,
            scripthash_stats_async_legacy
        );
        assert_eq!(
            scripthash_stats_blocking_legacy.chain_stats.funded_txo_sum,
            1000
        );
        assert_eq!(scripthash_stats_blocking_legacy.chain_stats.tx_count, 1);

        // P2SH-P2WSH
        let scripthash_stats_blocking_p2sh_segwit = blocking_client
            .get_scripthash_stats(&script_p2sh_segwit)
            .unwrap();
        let scripthash_stats_async_p2sh_segwit = async_client
            .get_scripthash_stats(&script_p2sh_segwit)
            .await
            .unwrap();
        assert_eq!(
            scripthash_stats_blocking_p2sh_segwit,
            scripthash_stats_async_p2sh_segwit
        );
        assert_eq!(
            scripthash_stats_blocking_p2sh_segwit
                .chain_stats
                .funded_txo_sum,
            1000
        );
        assert_eq!(
            scripthash_stats_blocking_p2sh_segwit.chain_stats.tx_count,
            1
        );

        // P2WPKH / P2WSH
        let scripthash_stats_blocking_bech32 = blocking_client
            .get_scripthash_stats(&script_bech32)
            .unwrap();
        let scripthash_stats_async_bech32 = async_client
            .get_scripthash_stats(&script_bech32)
            .await
            .unwrap();
        assert_eq!(
            scripthash_stats_blocking_bech32,
            scripthash_stats_async_bech32
        );
        assert_eq!(
            scripthash_stats_blocking_bech32.chain_stats.funded_txo_sum,
            1000
        );
        assert_eq!(scripthash_stats_blocking_bech32.chain_stats.tx_count, 1);

        // P2TR
        let scripthash_stats_blocking_bech32m = blocking_client
            .get_scripthash_stats(&script_bech32m)
            .unwrap();
        let scripthash_stats_async_bech32m = async_client
            .get_scripthash_stats(&script_bech32m)
            .await
            .unwrap();
        assert_eq!(
            scripthash_stats_blocking_bech32m,
            scripthash_stats_async_bech32m
        );
        assert_eq!(
            scripthash_stats_blocking_bech32m.chain_stats.funded_txo_sum,
            1000
        );
        assert_eq!(scripthash_stats_blocking_bech32m.chain_stats.tx_count, 1);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_address_txs() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(1000))
            .unwrap()
            .txid()
            .unwrap();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let address_txs_blocking = blocking_client.get_address_txs(&address, None).unwrap();
        let address_txs_async = async_client.get_address_txs(&address, None).await.unwrap();

        assert_eq!(address_txs_blocking, address_txs_async);
        assert_eq!(address_txs_async[0].txid, txid);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_address_utxos() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        let _txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(21000))
            .unwrap()
            .txid()
            .unwrap();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let address_utxos_blocking = blocking_client.get_address_utxos(&address).unwrap();
        let address_utxos_async = async_client.get_address_utxos(&address).await.unwrap();

        assert_ne!(address_utxos_blocking.len(), 0);
        assert_ne!(address_utxos_async.len(), 0);
        assert_eq!(address_utxos_blocking, address_utxos_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_scripthash_utxos() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();
        let script = address.script_pubkey();

        let _txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(21000))
            .unwrap()
            .txid()
            .unwrap();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let scripthash_utxos_blocking = blocking_client.get_scripthash_utxos(&script).unwrap();
        let scripthash_utxos_async = async_client.get_scripthash_utxos(&script).await.unwrap();

        assert_ne!(scripthash_utxos_blocking.len(), 0);
        assert_ne!(scripthash_utxos_async.len(), 0);
        assert_eq!(scripthash_utxos_blocking, scripthash_utxos_async);
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_get_tx_outspends() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        let txid = BITCOIND
            .client
            .send_to_address(&address, Amount::from_sat(21000))
            .unwrap()
            .txid()
            .unwrap();

        let _miner = MINER.lock().await;
        generate_blocks_and_wait(1);

        let outspends_blocking = blocking_client.get_tx_outspends(&txid).unwrap();
        let outspends_async = async_client.get_tx_outspends(&txid).await.unwrap();

        // Assert that there are 2 outputs: 21K sat and (coinbase - 21K sat).
        assert_eq!(outspends_blocking.len(), 2);
        assert_eq!(outspends_async.len(), 2);
        assert_eq!(outspends_blocking, outspends_async);

        // Assert that both outputs are returned as unspent (spent == false).
        assert!(outspends_blocking.iter().all(|output| !output.spent));
    }

    #[cfg(all(feature = "blocking", feature = "async"))]
    #[tokio::test]
    async fn test_mempool_methods() {
        let (blocking_client, async_client) = setup_clients().await;

        let address = BITCOIND
            .client
            .new_address_with_type(AddressType::Legacy)
            .unwrap();

        for _ in 0..5 {
            let _txid = BITCOIND
                .client
                .send_to_address(&address, Amount::from_sat(1000))
                .unwrap()
                .txid()
                .unwrap();
        }

        // Wait for transactions to propagate to electrs' mempool.
        tokio::time::sleep(tokio::time::Duration::from_secs(10)).await;

        // Test `get_mempool_stats`
        let stats_blocking = blocking_client.get_mempool_stats().unwrap();
        let stats_async = async_client.get_mempool_stats().await.unwrap();
        assert_eq!(stats_blocking, stats_async);
        assert!(stats_blocking.count >= 5);

        // Test `get_mempool_recent_txs`
        let recent_blocking = blocking_client.get_mempool_recent_txs().unwrap();
        let recent_async = async_client.get_mempool_recent_txs().await.unwrap();
        assert_eq!(recent_blocking, recent_async);
        assert!(recent_blocking.len() <= 10);
        assert!(!recent_blocking.is_empty());

        // Test `get_mempool_txids`
        let txids_blocking = blocking_client.get_mempool_txids().unwrap();
        let txids_async = async_client.get_mempool_txids().await.unwrap();
        assert_eq!(txids_blocking, txids_async);
        assert!(txids_blocking.len() >= 5);

        // Test `get_mempool_scripthash_txs`
        let script = address.script_pubkey();
        let scripthash_txs_blocking = blocking_client.get_mempool_scripthash_txs(&script).unwrap();
        let scripthash_txs_async = async_client
            .get_mempool_scripthash_txs(&script)
            .await
            .unwrap();
        assert_eq!(scripthash_txs_blocking, scripthash_txs_async);
        assert_eq!(scripthash_txs_blocking.len(), 5);

        // Test `get_mempool_address_txs`
        let mempool_address_txs_blocking =
            blocking_client.get_mempool_address_txs(&address).unwrap();
        let mempool_address_txs_async = async_client
            .get_mempool_address_txs(&address)
            .await
            .unwrap();
        assert_eq!(mempool_address_txs_blocking, mempool_address_txs_async);
        assert_eq!(mempool_address_txs_blocking.len(), 5);
    }
}