deps!: Update bdk_chain to 0.23.0

feat(params): Add options to `{Create,Load}Params` to enable a
persistent cache of script pubkeys.

feat: Update code to account for `first_seen`.

examples: Update example crates dependencies

Note: This change also extends the wallet ChangeSet type by adding
`first_seen` to the tx_graph member, and adding `spk_cache` to the
indexer.

Author: ValuedMammal

examples/example_wallet_electrum/Cargo.toml

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

examples/example_wallet_esplora_async/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2021"
 
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["rusqlite"] }
-bdk_esplora = { version = "0.21.0", features = ["async-https", "tokio"] }
+bdk_esplora = { version = "0.22.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.21.0", features = ["blocking"] }
+bdk_esplora = { version = "0.22.0", features = ["blocking"] }
 anyhow = "1"

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.19.0" }
+bdk_bitcoind_rpc = { version = "0.20.0" }
 
 anyhow = "1"
 clap = { version = "4.5.17", features = ["derive", "env"] }

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.22.0", features = [ "miniscript", "serde" ], default-features = false }
+bdk_chain = { version = "0.23.0", features = [ "miniscript", "serde" ], default-features = false }
 
 # Optional dependencies
 bip39 = { version = "2.0", optional = true }
-bdk_file_store = { version = "0.20.0", optional = true }
+bdk_file_store = { version = "0.21.0", optional = true }
 
 [features]
 default = ["std"]
@@ -40,7 +40,7 @@ test-utils = ["std"]
 [dev-dependencies]
 assert_matches = "1.5.0"
 tempfile = "3"
-bdk_chain = { version = "0.22.0", features = ["rusqlite"] }
+bdk_chain = { version = "0.23.0", features = ["rusqlite"] }
 bdk_wallet = { path = ".", features = ["rusqlite", "file_store", "test-utils"] }
 anyhow = "1"
 rand = "^0.8"

wallet/src/wallet/coin_selection.rs

@@ -750,6 +750,7 @@ mod test {
             value,
             index,
             ChainPosition::Unconfirmed {
+                first_seen: Some(last_seen),
                 last_seen: Some(last_seen),
             },
         )
@@ -850,7 +851,10 @@ mod test {
                             transitively: None,
                         }
                     } else {
-                        ChainPosition::Unconfirmed { last_seen: Some(0) }
+                        ChainPosition::Unconfirmed {
+                            first_seen: Some(1),
+                            last_seen: Some(1),
+                        }
                     },
                 }),
             });
@@ -875,7 +879,10 @@ mod test {
                     keychain: KeychainKind::External,
                     is_spent: false,
                     derivation_index: 42,
-                    chain_position: ChainPosition::Unconfirmed { last_seen: Some(0) },
+                    chain_position: ChainPosition::Unconfirmed {
+                        first_seen: Some(1),
+                        last_seen: Some(1),
+                    },
                 }),
             })
             .collect()
@@ -1231,7 +1238,10 @@ mod test {
         optional.push(utxo(
             Amount::from_sat(500_000),
             3,
-            ChainPosition::<ConfirmationBlockTime>::Unconfirmed { last_seen: Some(0) },
+            ChainPosition::<ConfirmationBlockTime>::Unconfirmed {
+                first_seen: Some(1),
+                last_seen: Some(1),
+            },
         ));
 
         // Defensive assertions, for sanity and in case someone changes the test utxos vector.

wallet/src/wallet/mod.rs

@@ -437,7 +437,12 @@ impl Wallet {
             None => (None, Arc::new(SignersContainer::new())),
         };
 
-        let index = create_indexer(descriptor, change_descriptor, params.lookahead)?;
+        let index = create_indexer(
+            descriptor,
+            change_descriptor,
+            params.lookahead,
+            params.use_spk_cache,
+        )?;
 
         let descriptor = index.get_descriptor(KeychainKind::External).cloned();
         let change_descriptor = index.get_descriptor(KeychainKind::Internal).cloned();
@@ -636,8 +641,13 @@ impl Wallet {
             None => Arc::new(SignersContainer::new()),
         };
 
-        let index = create_indexer(descriptor, change_descriptor, params.lookahead)
-            .map_err(LoadError::Descriptor)?;
+        let index = create_indexer(
+            descriptor,
+            change_descriptor,
+            params.lookahead,
+            params.use_spk_cache,
+        )
+        .map_err(LoadError::Descriptor)?;
 
         let mut indexed_graph = IndexedTxGraph::new(index);
         indexed_graph.apply_changeset(changeset.indexer.into());
@@ -1090,9 +1100,9 @@ impl Wallet {
     ///         "tx is an ancestor of a tx anchored in {}:{}",
     ///         anchor.block_id.height, anchor.block_id.hash,
     ///     ),
-    ///     ChainPosition::Unconfirmed { last_seen } => println!(
-    ///         "tx is last seen at {:?}, it is unconfirmed as it is not anchored in the best chain",
-    ///         last_seen,
+    ///     ChainPosition::Unconfirmed { first_seen, last_seen } => println!(
+    ///         "tx is first seen at {:?}, last seen at {:?}, it is unconfirmed as it is not anchored in the best chain",
+    ///         first_seen, last_seen
     ///     ),
     /// }
     /// ```
@@ -2591,17 +2601,14 @@ fn create_indexer(
     descriptor: ExtendedDescriptor,
     change_descriptor: Option<ExtendedDescriptor>,
     lookahead: u32,
+    use_spk_cache: bool,
 ) -> Result<KeychainTxOutIndex<KeychainKind>, DescriptorError> {
-    let mut indexer = KeychainTxOutIndex::<KeychainKind>::new(lookahead);
+    let mut indexer = KeychainTxOutIndex::<KeychainKind>::new(lookahead, use_spk_cache);
 
-    // let (descriptor, keymap) = descriptor;
-    // let signers = Arc::new(SignersContainer::build(keymap, &descriptor, secp));
     assert!(indexer
         .insert_descriptor(KeychainKind::External, descriptor)
         .expect("first descriptor introduced must succeed"));
 
-    // let (descriptor, keymap) = change_descriptor;
-    // let change_signers = Arc::new(SignersContainer::build(keymap, &descriptor, secp));
     if let Some(change_descriptor) = change_descriptor {
         assert!(indexer
             .insert_descriptor(KeychainKind::Internal, change_descriptor)

wallet/src/wallet/params.rs

@@ -39,6 +39,7 @@ pub struct CreateParams {
     pub(crate) network: Network,
     pub(crate) genesis_hash: Option<BlockHash>,
     pub(crate) lookahead: u32,
+    pub(crate) use_spk_cache: bool,
 }
 
 impl CreateParams {
@@ -61,6 +62,7 @@ impl CreateParams {
             network: Network::Bitcoin,
             genesis_hash: None,
             lookahead: DEFAULT_LOOKAHEAD,
+            use_spk_cache: false,
         }
     }
 
@@ -82,6 +84,7 @@ impl CreateParams {
             network: Network::Bitcoin,
             genesis_hash: None,
             lookahead: DEFAULT_LOOKAHEAD,
+            use_spk_cache: false,
         }
     }
 
@@ -118,6 +121,15 @@ impl CreateParams {
         self
     }
 
+    /// Use a persistent cache of indexed script pubkeys (SPKs).
+    ///
+    /// **Note:** To persist across restarts, this option must also be set at load time with
+    /// [`LoadParams`](LoadParams::use_spk_cache).
+    pub fn use_spk_cache(mut self, use_spk_cache: bool) -> Self {
+        self.use_spk_cache = use_spk_cache;
+        self
+    }
+
     /// Create [`PersistedWallet`] with the given [`WalletPersister`].
     pub fn create_wallet<P>(
         self,
@@ -157,6 +169,7 @@ pub struct LoadParams {
     pub(crate) check_descriptor: Option<Option<DescriptorToExtract>>,
     pub(crate) check_change_descriptor: Option<Option<DescriptorToExtract>>,
     pub(crate) extract_keys: bool,
+    pub(crate) use_spk_cache: bool,
 }
 
 impl LoadParams {
@@ -173,6 +186,7 @@ impl LoadParams {
             check_descriptor: None,
             check_change_descriptor: None,
             extract_keys: false,
+            use_spk_cache: false,
         }
     }
 
@@ -234,6 +248,15 @@ impl LoadParams {
         self
     }
 
+    /// Use a persistent cache of indexed script pubkeys (SPKs).
+    ///
+    /// **Note:** This should only be used if you have previously persisted a cache of script
+    /// pubkeys using [`CreateParams::use_spk_cache`].
+    pub fn use_spk_cache(mut self, use_spk_cache: bool) -> Self {
+        self.use_spk_cache = use_spk_cache;
+        self
+    }
+
     /// Load [`PersistedWallet`] with the given [`WalletPersister`].
     pub fn load_wallet<P>(
         self,

wallet/src/wallet/tx_builder.rs

@@ -1024,7 +1024,10 @@ mod test {
                 txout: TxOut::NULL,
                 keychain: KeychainKind::External,
                 is_spent: false,
-                chain_position: chain::ChainPosition::Unconfirmed { last_seen: Some(0) },
+                chain_position: chain::ChainPosition::Unconfirmed {
+                    first_seen: Some(1),
+                    last_seen: Some(1),
+                },
                 derivation_index: 0,
             },
             LocalOutput {