Merge #208: deps!: update bdk_chain to 0.22.0

e125014 feat(examples): Change `example_wallet_rpc` to detect evictions. (志宇)
12b00e0 feat(wallet): Add method `apply_evicted_txs` (valued mammal)
a247215 deps!: update bdk_chain to 0.22.0 (valued mammal)
f882945 ci: Unpin some dependencies (valued mammal)

Pull request description:

  This PR updates `bdk_chain` dependency to the latest version 0.22.0

  ### Notes to the reviewers

  This PR doesn't make use of `CanonicalizationParams` for any advanced use cases - instead we rely on the default params for all tx-graph queries.

  fixes #202
  fixes #224

  ### Changelog notice

  - deps: bump `bdk_chain` to 0.22.0
  - deps: bump `bdk_file_store` to 0.20.0

  #### Added

  - Added `start_sync_with_revealed_spks_at`
  - Added `start_full_scan_at`
  - Added `apply_evicted_txs`

  #### Changed

  - `start_sync_with_revealed_spks` is feature gated by "std", as it uses the system time to provide the time of the sync and also the tx last-seen.
  - `apply_update` no longer requires std, as the timestamp is provided in the sync / full scan request
  - `start_full_scan` is also gated behind "std"
  - `start_sync_*` now includes the expected SPK history (via `list_expected_spk_txids`)

  #### Removed

  - Removed `apply_update_at`

  #### BREAKING

  - `bdk_core::TxUpdate` is non-exhaustive bitcoindevkit/bdk#1838
  - For the optional file_store feature, the Load variant of the `FileStoreError` is changed to hold a new inner type bitcoindevkit/bdk#1684

  #### Changes to persisted data

  The `tx_graph::ChangeSet` gained a new default-able field `last_evicted` to persist the fact that a tx is no longer part of the canonical chain.

  ### 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
  * [x] I've added docs for the new feature
  * [x] This pull request breaks the existng API
  * [x] I'm linking the issue being fixed by this PR

ACKs for top commit:
  notmandatory:
    ACK e125014

Tree-SHA512: 91f77e4268aac0aaee2503a3fdca13754fc291159b9f37b0997be8c011b02b8ac16b4b6a7edbbb731005c83b37d438666fb803dbe18a6b9496b11f7e3e1ab155

Author: notmandatory

ci/pin-msrv.sh

@@ -10,13 +10,4 @@ set -euo pipefail
 # cargo clean
 # rustup override set 1.63.0
 
-cargo update -p home --precise "0.5.5"
-cargo update -p url --precise "2.5.0"
-cargo update -p tokio --precise "1.38.1"
-cargo update -p tokio-util --precise "0.7.11"
-cargo update -p indexmap --precise "2.5.0"
-cargo update -p security-framework-sys --precise "2.11.1"
-cargo update -p ring --precise "0.17.12"
 cargo update -p once_cell --precise "1.20.3"
-cargo update -p minreq --precise "2.13.2"
-cargo update -p native-tls --precise "0.2.13"

examples/example_wallet_electrum/Cargo.toml

@@ -5,5 +5,5 @@ edition = "2021"
 
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
-bdk_electrum = { version = "0.21" }
+bdk_electrum = { version = "0.22.0" }
 anyhow = "1"

examples/example_wallet_electrum/src/main.rs

@@ -22,7 +22,7 @@ const ELECTRUM_URL: &str = "ssl://electrum.blockstream.info:60002";
 fn main() -> Result<(), anyhow::Error> {
     let db_path = "bdk-electrum-example.db";
 
-    let mut db = Store::<bdk_wallet::ChangeSet>::open_or_create_new(DB_MAGIC.as_bytes(), db_path)?;
+    let (mut db, _) = Store::<bdk_wallet::ChangeSet>::load_or_create(DB_MAGIC.as_bytes(), db_path)?;
 
     let wallet_opt = Wallet::load()
         .descriptor(KeychainKind::External, Some(EXTERNAL_DESC))

examples/example_wallet_esplora_async/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2021"
 
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["rusqlite"] }
-bdk_esplora = { version = "0.20", features = ["async-https", "tokio"] }
+bdk_esplora = { version = "0.21.0", features = ["async-https", "tokio"] }
 tokio = { version = "1.38.1", features = ["rt", "rt-multi-thread", "macros"] }
 anyhow = "1"

examples/example_wallet_esplora_blocking/Cargo.toml

@@ -8,5 +8,5 @@ publish = false
 
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
-bdk_esplora = { version = "0.20", features = ["blocking"] }
+bdk_esplora = { version = "0.21.0", features = ["blocking"] }
 anyhow = "1"

examples/example_wallet_esplora_blocking/src/main.rs

@@ -19,7 +19,7 @@ const INTERNAL_DESC: &str = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7
 const ESPLORA_URL: &str = "http://signet.bitcoindevkit.net";
 
 fn main() -> Result<(), anyhow::Error> {
-    let mut db = Store::<bdk_wallet::ChangeSet>::open_or_create_new(DB_MAGIC.as_bytes(), DB_PATH)?;
+    let (mut db, _) = Store::<bdk_wallet::ChangeSet>::load_or_create(DB_MAGIC.as_bytes(), DB_PATH)?;
 
     let wallet_opt = Wallet::load()
         .descriptor(KeychainKind::External, Some(EXTERNAL_DESC))

examples/example_wallet_rpc/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
-bdk_bitcoind_rpc = { version = "0.18" }
+bdk_bitcoind_rpc = { version = "0.19.0" }
 
 anyhow = "1"
 clap = { version = "4.5.17", features = ["derive", "env"] }

examples/example_wallet_rpc/src/main.rs

@@ -1,14 +1,19 @@
 use bdk_bitcoind_rpc::{
     bitcoincore_rpc::{Auth, Client, RpcApi},
-    Emitter,
+    Emitter, MempoolEvent,
 };
 use bdk_wallet::{
-    bitcoin::{Block, Network, Transaction},
+    bitcoin::{Block, Network},
     file_store::Store,
     KeychainKind, Wallet,
 };
 use clap::{self, Parser};
-use std::{path::PathBuf, sync::mpsc::sync_channel, thread::spawn, time::Instant};
+use std::{
+    path::PathBuf,
+    sync::{mpsc::sync_channel, Arc},
+    thread::spawn,
+    time::Instant,
+};
 
 const DB_MAGIC: &str = "bdk-rpc-wallet-example";
 
@@ -73,21 +78,21 @@ impl Args {
 enum Emission {
     SigTerm,
     Block(bdk_bitcoind_rpc::BlockEvent<Block>),
-    Mempool(Vec<(Transaction, u64)>),
+    Mempool(MempoolEvent),
 }
 
 fn main() -> anyhow::Result<()> {
     let args = Args::parse();
 
-    let rpc_client = args.client()?;
+    let rpc_client = Arc::new(args.client()?);
     println!(
         "Connected to Bitcoin Core RPC at {:?}",
         rpc_client.get_blockchain_info().unwrap()
     );
 
     let start_load_wallet = Instant::now();
-    let mut db =
-        Store::<bdk_wallet::ChangeSet>::open_or_create_new(DB_MAGIC.as_bytes(), args.db_path)?;
+    let (mut db, _) =
+        Store::<bdk_wallet::ChangeSet>::load_or_create(DB_MAGIC.as_bytes(), args.db_path)?;
     let wallet_opt = Wallet::load()
         .descriptor(KeychainKind::External, Some(args.descriptor.clone()))
         .descriptor(KeychainKind::Internal, args.change_descriptor.clone())
@@ -129,9 +134,15 @@ fn main() -> anyhow::Result<()> {
             .expect("failed to send sigterm")
     });
 
-    let emitter_tip = wallet_tip.clone();
+    let mut emitter = Emitter::new(
+        rpc_client,
+        wallet_tip,
+        args.start_height,
+        wallet
+            .transactions()
+            .filter(|tx| tx.chain_position.is_unconfirmed()),
+    );
     spawn(move || -> Result<(), anyhow::Error> {
-        let mut emitter = Emitter::new(&rpc_client, emitter_tip, args.start_height);
         while let Some(emission) = emitter.next_block()? {
             sender.send(Emission::Block(emission))?;
         }
@@ -160,9 +171,10 @@ fn main() -> anyhow::Result<()> {
                     hash, height, elapsed
                 );
             }
-            Emission::Mempool(mempool_emission) => {
+            Emission::Mempool(event) => {
                 let start_apply_mempool = Instant::now();
-                wallet.apply_unconfirmed_txs(mempool_emission);
+                wallet.apply_evicted_txs(event.evicted_ats());
+                wallet.apply_unconfirmed_txs(event.new_txs);
                 wallet.persist(&mut db)?;
                 println!(
                     "Applied unconfirmed transactions in {}s",

wallet/Cargo.toml

@@ -21,11 +21,11 @@ miniscript = { version = "12.3.1", features = [ "serde" ], default-features = fa
 bitcoin = { version = "0.32.4", features = [ "serde", "base64" ], default-features = false }
 serde = { version = "^1.0", features = ["derive"] }
 serde_json = { version = "^1.0" }
-bdk_chain = { version = "0.21.1", features = [ "miniscript", "serde" ], default-features = false }
-bdk_file_store = { version = "0.18.1", optional = true }
+bdk_chain = { version = "0.22.0", features = [ "miniscript", "serde" ], default-features = false }
 
 # Optional dependencies
 bip39 = { version = "2.0", optional = true }
+bdk_file_store = { version = "0.20.0", optional = true }
 
 [features]
 default = ["std"]
@@ -40,9 +40,8 @@ test-utils = ["std"]
 [dev-dependencies]
 assert_matches = "1.5.0"
 tempfile = "3"
-bdk_chain = { version = "0.21.1", features = ["rusqlite"] }
+bdk_chain = { version = "0.22.0", features = ["rusqlite"] }
 bdk_wallet = { path = ".", features = ["rusqlite", "file_store", "test-utils"] }
-bdk_file_store = { version = "0.18.1" }
 anyhow = "1"
 rand = "^0.8"
 

wallet/README.md

@@ -65,13 +65,12 @@ To persist `Wallet` state data use a data store crate that reads and writes [`Ch
 
 **Example**
 
-<!-- compile_fail because outpoint and txout are fake variables -->
 ```rust,no_run
 use bdk_wallet::{bitcoin::Network, KeychainKind, ChangeSet, Wallet};
 
 // Open or create a new file store for wallet data.
-let mut db =
-    bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+let (mut db, _changeset) =
+    bdk_file_store::Store::<ChangeSet>::load_or_create(b"magic_bytes", "/tmp/my_wallet.db")
         .expect("create store");
 
 // Create a wallet with initial wallet data read from the file store.

wallet/src/test_utils.rs

@@ -4,7 +4,7 @@ use alloc::string::ToString;
 use alloc::sync::Arc;
 use core::str::FromStr;
 
-use bdk_chain::{tx_graph, BlockId, ConfirmationBlockTime};
+use bdk_chain::{BlockId, ConfirmationBlockTime, TxUpdate};
 use bitcoin::{
     absolute, hashes::Hash, transaction, Address, Amount, BlockHash, FeeRate, Network, OutPoint,
     Transaction, TxIn, TxOut, Txid,
@@ -312,43 +312,45 @@ pub fn insert_checkpoint(wallet: &mut Wallet, block: BlockId) {
         .unwrap();
 }
 
-/// Insert transaction
+/// Inserts a transaction into the local view, assuming it is currently present in the mempool.
+///
+/// This can be used, for example, to track a transaction immediately after it is broadcast.
 pub fn insert_tx(wallet: &mut Wallet, tx: Transaction) {
+    let txid = tx.compute_txid();
+    let seen_at = std::time::UNIX_EPOCH.elapsed().unwrap().as_secs();
+    let mut tx_update = TxUpdate::default();
+    tx_update.txs = vec![Arc::new(tx)];
+    tx_update.seen_ats = [(txid, seen_at)].into();
     wallet
         .apply_update(Update {
-            tx_update: bdk_chain::TxUpdate {
-                txs: vec![Arc::new(tx)],
-                ..Default::default()
-            },
+            tx_update,
             ..Default::default()
         })
-        .unwrap();
+        .expect("failed to apply update");
 }
 
 /// Simulates confirming a tx with `txid` by applying an update to the wallet containing
 /// the given `anchor`. Note: to be considered confirmed the anchor block must exist in
 /// the current active chain.
 pub fn insert_anchor(wallet: &mut Wallet, txid: Txid, anchor: ConfirmationBlockTime) {
+    let mut tx_update = TxUpdate::default();
+    tx_update.anchors = [(anchor, txid)].into();
     wallet
         .apply_update(Update {
-            tx_update: tx_graph::TxUpdate {
-                anchors: [(anchor, txid)].into(),
-                ..Default::default()
-            },
+            tx_update,
             ..Default::default()
         })
-        .unwrap();
+        .expect("failed to apply update");
 }
 
 /// Marks the given `txid` seen as unconfirmed at `seen_at`
 pub fn insert_seen_at(wallet: &mut Wallet, txid: Txid, seen_at: u64) {
+    let mut tx_update = TxUpdate::default();
+    tx_update.seen_ats = [(txid, seen_at)].into();
     wallet
-        .apply_update(crate::Update {
-            tx_update: tx_graph::TxUpdate {
-                seen_ats: [(txid, seen_at)].into_iter().collect(),
-                ..Default::default()
-            },
+        .apply_update(Update {
+            tx_update,
             ..Default::default()
         })
-        .unwrap();
+        .expect("failed to apply update");
 }