Merge #1826: deps(bdk_testenv)!: bump electrsd to 0.36.1

303cc70 docs(testenv): fix rustdocs for `corepc` types (valued mammal)
9393832 build(testenv): `mine_empty_blocks` requires `std` feature (valued mammal)
cbad92e test(bdk_esplora,bdk_electrum): update to new `bdk_testenv` APIs (Leonardo Lima)
b78a9de test(bdk_chain): update to new `bdk_testenv` APIs (Leonardo Lima)
f393145 test(bdk_bitcoind_rpc): update it's tests to use `ClientExt` (valued mammal)
c3f7257 deps(bdk_testenv): bump `electrsd` to `0.36.1` (Leonardo Lima)

Pull request description:

  partially addresses #1949

  ### Description

  Upgrades the `electrsd` version from `0.28.0` to `0.36.1`, migrating from old `bitcoind` to `corepc-node` and using the `corepc-node_28_2` feature.

  Updates the `bitcoind` client type for `TestEnv`, and its internal methods. Also, updates: bdk_bitcoind_rpc, bdk_esplora, bdk_electrum usage of `bdk_testenv` and `TestEnv`.

  ### Notes to the reviewers

  As we are upgrading to the latest `electrsd`, we can drop for now the pinning for `home` in the MSRV step.

  ### Changelog notice

  ```
  ### Added
  - deps(bdk_testenv): introduces `bitcoin and it's `bitcoin/rand-std` feature under `bdk_testenv/std`.
  - test(bdk_bitcoind_rpc): introcuce `ClientExt` trait to use custom testing RPC client with current `bitcoincore-rpc` one.

  ### Changed
  - deps(bdk_testenv)!: bump `electrsd` to `0.36.1`.
  - deps(bdk_testenv): updates `electrsd` feature to `corepc-node_28_2`.
  - test(bdk_bitcoind_rpc): update all tests to use new `ClientExt` trait when building the `Emitter`.
  - test(bdk_chain): update all tests to use new `bdk_testenv`, `electrsd` and `corepc-node` APIs.
  - test(bdk_esplora, bdk_electrum): update all tests to use new `bdk_testenv`, `electrsd` and `corepc-node` APIs.
  - build(testenv): feature gate `mine_empty_blocks`, `reorg_empty_blocks` behind `std` feature.

  ```

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

  #### New Features:

  * [x] I've added tests for the new feature
  * [x] I've added docs for the new feature

ACKs for top commit:
  ValuedMammal:
    ACK 303cc70
  luisschwab:
    ACK 303cc70

Tree-SHA512: 721a328a09d8bf75e6e2903dd2e244fdd211895c3e1a1b9aa5c6ee256ea1b07be9ab25db9a7ffcff88d94e7b05cdd06580598fd09292f5a17471583eb1252435

Author: oleonardolima

ci/pin-msrv.sh

@@ -10,6 +10,4 @@ set -euo pipefail
 # cargo clean
 # rustup override set 1.85.0
 
-cargo update -p home --precise "0.5.11"
-cargo update -p time --precise "0.3.45"
-cargo update -p time-core --precise "0.1.7"
+# e.g cargo update -p home --precise "0.5.11"

crates/bitcoind_rpc/src/lib.rs

@@ -399,7 +399,7 @@ impl BitcoindRpcErrorExt for bitcoincore_rpc::Error {
 #[cfg(test)]
 #[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
-    use crate::{bitcoincore_rpc::RpcApi, Emitter, NO_EXPECTED_MEMPOOL_TXS};
+    use crate::{Emitter, NO_EXPECTED_MEMPOOL_TXS};
     use bdk_chain::local_chain::LocalChain;
     use bdk_testenv::{anyhow, TestEnv};
     use bitcoin::{hashes::Hash, Address, Amount, ScriptBuf, Txid, WScriptHash};
@@ -408,14 +408,15 @@ mod test {
     #[test]
     fn test_expected_mempool_txids_accumulate_and_remove() -> anyhow::Result<()> {
         let env = TestEnv::new()?;
-        let chain = LocalChain::from_genesis(env.rpc_client().get_block_hash(0)?).0;
+        let (chain, _) = LocalChain::from_genesis(env.genesis_hash()?);
         let chain_tip = chain.tip();
-        let mut emitter = Emitter::new(
-            env.rpc_client(),
-            chain_tip.clone(),
-            1,
-            NO_EXPECTED_MEMPOOL_TXS,
-        );
+
+        let rpc_client = bitcoincore_rpc::Client::new(
+            &env.bitcoind.rpc_url(),
+            bitcoincore_rpc::Auth::CookieFile(env.bitcoind.params.cookie_file.clone()),
+        )?;
+
+        let mut emitter = Emitter::new(&rpc_client, chain_tip.clone(), 1, NO_EXPECTED_MEMPOOL_TXS);
 
         env.mine_blocks(100, None)?;
         while emitter.next_block()?.is_some() {}

crates/bitcoind_rpc/tests/common/mod.rs

@@ -0,0 +1,20 @@
+use bdk_testenv::anyhow;
+use bdk_testenv::TestEnv;
+
+/// This trait is used for testing. It allows creating a new [`bitcoincore_rpc::Client`] connected
+/// to the instance of bitcoind running in the test environment. This way the `TestEnv` and the
+/// `Emitter` aren't required to share the same client. In the future when we no longer depend on
+/// `bitcoincore-rpc`, this can be updated to return the production client that is used by BDK.
+pub trait ClientExt {
+    /// Creates a new [`bitcoincore_rpc::Client`] connected to the current node instance.
+    fn get_rpc_client(&self) -> anyhow::Result<bitcoincore_rpc::Client>;
+}
+
+impl ClientExt for TestEnv {
+    fn get_rpc_client(&self) -> anyhow::Result<bitcoincore_rpc::Client> {
+        Ok(bitcoincore_rpc::Client::new(
+            &self.bitcoind.rpc_url(),
+            bitcoincore_rpc::Auth::CookieFile(self.bitcoind.params.cookie_file.clone()),
+        )?)
+    }
+}

crates/bitcoind_rpc/tests/test_emitter.rs

@@ -7,9 +7,16 @@ use bdk_chain::{
     spk_txout::SpkTxOutIndex,
     Balance, BlockId, CanonicalizationParams, IndexedTxGraph, Merge,
 };
-use bdk_testenv::{anyhow, TestEnv};
-use bitcoin::{hashes::Hash, Block, Network, OutPoint, ScriptBuf, WScriptHash};
-use bitcoincore_rpc::RpcApi;
+use bdk_testenv::{
+    anyhow,
+    corepc_node::{Input, Output},
+    TestEnv,
+};
+use bitcoin::{hashes::Hash, Block, Network, ScriptBuf, WScriptHash};
+
+use crate::common::ClientExt;
+
+mod common;
 
 /// Ensure that blocks are emitted in order even after reorg.
 ///
@@ -20,21 +27,18 @@ use bitcoincore_rpc::RpcApi;
 #[test]
 pub fn test_sync_local_chain() -> anyhow::Result<()> {
     let env = TestEnv::new()?;
-    let network_tip = env.rpc_client().get_block_count()?;
-    let (mut local_chain, _) = LocalChain::from_genesis(env.rpc_client().get_block_hash(0)?);
-    let mut emitter = Emitter::new(
-        env.rpc_client(),
-        local_chain.tip(),
-        0,
-        NO_EXPECTED_MEMPOOL_TXS,
-    );
+    let network_tip = env.rpc_client().get_block_count()?.into_model().0;
+    let (mut local_chain, _) = LocalChain::from_genesis(env.genesis_hash()?);
+
+    let client = ClientExt::get_rpc_client(&env)?;
+    let mut emitter = Emitter::new(&client, local_chain.tip(), 0, NO_EXPECTED_MEMPOOL_TXS);
 
     // Mine some blocks and return the actual block hashes.
     // Because initializing `ElectrsD` already mines some blocks, we must include those too when
     // returning block hashes.
     let exp_hashes = {
         let mut hashes = (0..=network_tip)
-            .map(|height| env.rpc_client().get_block_hash(height))
+            .map(|height| env.get_block_hash(height))
             .collect::<Result<Vec<_>, _>>()?;
         hashes.extend(env.mine_blocks(101 - network_tip as usize, None)?);
         hashes
@@ -140,19 +144,24 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
     let addr_0 = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .assume_checked();
+
     let addr_1 = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .assume_checked();
+
     let addr_2 = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .assume_checked();
 
     env.mine_blocks(101, None)?;
 
-    let (mut chain, _) = LocalChain::from_genesis(env.rpc_client().get_block_hash(0)?);
+    let (mut chain, _) = LocalChain::from_genesis(env.genesis_hash()?);
     let mut indexed_tx_graph = IndexedTxGraph::<BlockId, _>::new({
         let mut index = SpkTxOutIndex::<usize>::default();
         index.insert_spk(0, addr_0.script_pubkey());
@@ -161,7 +170,8 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
         index
     });
 
-    let emitter = &mut Emitter::new(env.rpc_client(), chain.tip(), 0, NO_EXPECTED_MEMPOOL_TXS);
+    let client = ClientExt::get_rpc_client(&env)?;
+    let emitter = &mut Emitter::new(&client, chain.tip(), 0, NO_EXPECTED_MEMPOOL_TXS);
 
     while let Some(emission) = emitter.next_block()? {
         let height = emission.block_height();
@@ -174,16 +184,11 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
     let exp_txids = {
         let mut txids = BTreeSet::new();
         for _ in 0..3 {
-            txids.insert(env.rpc_client().send_to_address(
-                &addr_0,
-                Amount::from_sat(10_000),
-                None,
-                None,
-                None,
-                None,
-                None,
-                None,
-            )?);
+            txids.insert(
+                env.rpc_client()
+                    .send_to_address(&addr_0, Amount::from_sat(10_000))?
+                    .txid()?,
+            );
         }
         txids
     };
@@ -210,7 +215,10 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
 
     // mine a block that confirms the 3 txs
     let exp_block_hash = env.mine_blocks(1, None)?[0];
-    let exp_block_height = env.rpc_client().get_block_info(&exp_block_hash)?.height as u32;
+    let exp_block_height = env
+        .rpc_client()
+        .get_block_verbose_one(exp_block_hash)?
+        .height as u32;
     let exp_anchors = exp_txids
         .iter()
         .map({
@@ -250,9 +258,11 @@ fn ensure_block_emitted_after_reorg_is_at_reorg_height() -> anyhow::Result<()> {
     const CHAIN_TIP_HEIGHT: usize = 110;
 
     let env = TestEnv::new()?;
+
+    let client = ClientExt::get_rpc_client(&env)?;
     let mut emitter = Emitter::new(
-        env.rpc_client(),
-        CheckPoint::new(0, env.rpc_client().get_block_hash(0)?),
+        &client,
+        CheckPoint::new(0, env.genesis_hash()?),
         EMITTER_START_HEIGHT as _,
         NO_EXPECTED_MEMPOOL_TXS,
     );
@@ -325,9 +335,11 @@ fn tx_can_become_unconfirmed_after_reorg() -> anyhow::Result<()> {
     const SEND_AMOUNT: Amount = Amount::from_sat(10_000);
 
     let env = TestEnv::new()?;
+
+    let client = ClientExt::get_rpc_client(&env)?;
     let mut emitter = Emitter::new(
-        env.rpc_client(),
-        CheckPoint::new(0, env.rpc_client().get_block_hash(0)?),
+        &client,
+        CheckPoint::new(0, env.genesis_hash()?),
         0,
         NO_EXPECTED_MEMPOOL_TXS,
     );
@@ -336,12 +348,13 @@ fn tx_can_become_unconfirmed_after_reorg() -> anyhow::Result<()> {
     let addr_to_mine = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .assume_checked();
     let spk_to_track = ScriptBuf::new_p2wsh(&WScriptHash::all_zeros());
     let addr_to_track = Address::from_script(&spk_to_track, Network::Regtest)?;
 
     // setup receiver
-    let (mut recv_chain, _) = LocalChain::from_genesis(env.rpc_client().get_block_hash(0)?);
+    let (mut recv_chain, _) = LocalChain::from_genesis(env.genesis_hash()?);
     let mut recv_graph = IndexedTxGraph::<BlockId, _>::new({
         let mut recv_index = SpkTxOutIndex::default();
         recv_index.insert_spk((), spk_to_track.clone());
@@ -358,14 +371,16 @@ fn tx_can_become_unconfirmed_after_reorg() -> anyhow::Result<()> {
         // lock outputs that send to `addr_to_track`
         let outpoints_to_lock = env
             .rpc_client()
-            .get_transaction(&txid, None)?
-            .transaction()?
+            .get_transaction(txid)?
+            .into_model()?
+            .tx
             .output
             .into_iter()
             .enumerate()
             .filter(|(_, txo)| txo.script_pubkey == spk_to_track)
-            .map(|(vout, _)| OutPoint::new(txid, vout as _))
+            .map(|(vout, _)| (txid, vout as u32))
             .collect::<Vec<_>>();
+
         env.rpc_client().lock_unspent(&outpoints_to_lock)?;
 
         let _ = env.mine_blocks(1, None)?;
@@ -413,9 +428,11 @@ fn mempool_avoids_re_emission() -> anyhow::Result<()> {
     const MEMPOOL_TX_COUNT: usize = 2;
 
     let env = TestEnv::new()?;
+
+    let client = ClientExt::get_rpc_client(&env)?;
     let mut emitter = Emitter::new(
-        env.rpc_client(),
-        CheckPoint::new(0, env.rpc_client().get_block_hash(0)?),
+        &client,
+        CheckPoint::new(0, env.genesis_hash()?),
         0,
         NO_EXPECTED_MEMPOOL_TXS,
     );
@@ -424,6 +441,7 @@ fn mempool_avoids_re_emission() -> anyhow::Result<()> {
     let addr = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .assume_checked();
     env.mine_blocks(BLOCKS_TO_MINE, Some(addr.clone()))?;
     while emitter.next_block()?.is_some() {}
@@ -482,10 +500,11 @@ fn no_agreement_point() -> anyhow::Result<()> {
 
     let env = TestEnv::new()?;
 
+    let client = ClientExt::get_rpc_client(&env)?;
     // start height is 99
     let mut emitter = Emitter::new(
-        env.rpc_client(),
-        CheckPoint::new(0, env.rpc_client().get_block_hash(0)?),
+        &client,
+        CheckPoint::new(0, env.genesis_hash()?),
         (PREMINE_COUNT - 2) as u32,
         NO_EXPECTED_MEMPOOL_TXS,
     );
@@ -507,12 +526,12 @@ fn no_agreement_point() -> anyhow::Result<()> {
     let block_hash_100a = block_header_100a.block_hash();
 
     // get hash for block 101a
-    let block_hash_101a = env.rpc_client().get_block_hash(101)?;
+    let block_hash_101a = env.rpc_client().get_block_hash(101)?.block_hash()?;
 
     // invalidate blocks 99a, 100a, 101a
-    env.rpc_client().invalidate_block(&block_hash_99a)?;
-    env.rpc_client().invalidate_block(&block_hash_100a)?;
-    env.rpc_client().invalidate_block(&block_hash_101a)?;
+    env.rpc_client().invalidate_block(block_hash_99a)?;
+    env.rpc_client().invalidate_block(block_hash_100a)?;
+    env.rpc_client().invalidate_block(block_hash_101a)?;
 
     // mine new blocks 99b, 100b, 101b
     env.mine_blocks(3, None)?;
@@ -542,13 +561,11 @@ fn no_agreement_point() -> anyhow::Result<()> {
 #[test]
 fn test_expect_tx_evicted() -> anyhow::Result<()> {
     use bdk_bitcoind_rpc::bitcoincore_rpc::bitcoin;
-    use bdk_bitcoind_rpc::bitcoincore_rpc::bitcoincore_rpc_json::CreateRawTransactionInput;
     use bdk_chain::miniscript;
     use bdk_chain::spk_txout::SpkTxOutIndex;
     use bitcoin::constants::genesis_block;
     use bitcoin::secp256k1::Secp256k1;
     use bitcoin::Network;
-    use std::collections::HashMap;
     let env = TestEnv::new()?;
 
     let s = bdk_testenv::utils::DESCRIPTORS[0];
@@ -570,12 +587,10 @@ fn test_expect_tx_evicted() -> anyhow::Result<()> {
         &Address::from_script(&spk, Network::Regtest)?,
         Amount::ONE_BTC,
     )?;
-    let tx_1 = env
-        .rpc_client()
-        .get_transaction(&txid_1, None)?
-        .transaction()?;
+    let tx_1 = env.rpc_client().get_transaction(txid_1)?.into_model()?.tx;
 
-    let mut emitter = Emitter::new(env.rpc_client(), chain.tip(), 1, core::iter::once(tx_1));
+    let client = ClientExt::get_rpc_client(&env)?;
+    let mut emitter = Emitter::new(&client, chain.tip(), 1, core::iter::once(tx_1));
     while let Some(emission) = emitter.next_block()? {
         let height = emission.block_height();
         chain.apply_header(&emission.block.header, height)?;
@@ -592,25 +607,28 @@ fn test_expect_tx_evicted() -> anyhow::Result<()> {
 
     // Get `prevout` from core.
     let core = env.rpc_client();
-    let tx1 = &core.get_raw_transaction(&txid_1, None)?;
+    let tx1 = core.get_transaction(txid_1)?.into_model()?.tx;
     let txin = &tx1.input[0];
     let op = txin.previous_output;
 
     // Create `tx1b` using the previous output from tx1.
-    let utxo = CreateRawTransactionInput {
+    let utxo = Input {
         txid: op.txid,
-        vout: op.vout,
+        vout: op.vout as u64,
         sequence: None,
     };
-    let addr = core.get_new_address(None, None)?.assume_checked();
-    let tx = core.create_raw_transaction(
-        &[utxo],
-        &HashMap::from([(addr.to_string(), Amount::from_btc(49.99)?)]),
-        None,
-        None,
-    )?;
-    let res = core.sign_raw_transaction_with_wallet(&tx, None, None)?;
-    let tx1b = res.transaction()?;
+
+    let addr = core
+        .get_new_address(None, None)?
+        .address()?
+        .assume_checked();
+
+    let outputs = [Output::new(addr, Amount::from_btc(49.99)?)];
+    let tx = core
+        .create_raw_transaction(&[utxo], &outputs)?
+        .into_model()?
+        .0;
+    let tx1b = core.sign_raw_transaction_with_wallet(&tx)?.into_model()?.tx;
 
     // Send the tx.
     let _txid_2 = core.send_raw_transaction(&tx1b)?;
@@ -651,11 +669,13 @@ fn detect_new_mempool_txs() -> anyhow::Result<()> {
     let addr = env
         .rpc_client()
         .get_new_address(None, None)?
+        .address()?
         .require_network(Network::Regtest)?;
 
+    let client = ClientExt::get_rpc_client(&env)?;
     let mut emitter = Emitter::new(
-        env.rpc_client(),
-        CheckPoint::new(0, env.rpc_client().get_block_hash(0)?),
+        &client,
+        CheckPoint::new(0, env.genesis_hash()?),
         0,
         NO_EXPECTED_MEMPOOL_TXS,
     );