feat!: move spk_clients to bdk_core

Also introduced extension trait for builder methods that take in a
`KeychainTxOutIndex`.

`Indexed<T>` and `KeychainIndexed<T>` are also moved to `bdk_core`.

Author: evanlinjin

crates/chain/src/indexer/keychain_txout.rs

@@ -4,6 +4,7 @@
 use crate::{
     collections::*,
     miniscript::{Descriptor, DescriptorPublicKey},
+    spk_client::{FullScanRequestBuilder, SyncRequestBuilder},
     spk_iter::BIP32_MAX_INDEX,
     spk_txout::SpkTxOutIndex,
     DescriptorExt, DescriptorId, Indexed, Indexer, KeychainIndexed, SpkIterator,
@@ -875,3 +876,43 @@ impl Merge for ChangeSet {
         self.last_revealed.is_empty()
     }
 }
+
+/// Trait to extend [`SyncRequestBuilder`].
+pub trait SyncRequestBuilderExt<K> {
+    /// Add [`Script`](bitcoin::Script)s that are revealed by the `indexer` of the given `spk_range`
+    /// that will be synced against.
+    fn revealed_spks_from_indexer<R>(self, indexer: &KeychainTxOutIndex<K>, spk_range: R) -> Self
+    where
+        R: core::ops::RangeBounds<K>;
+
+    /// Add [`Script`](bitcoin::Script)s that are revealed by the `indexer` but currently unused.
+    fn unused_spks_from_indexer(self, indexer: &KeychainTxOutIndex<K>) -> Self;
+}
+
+impl<K: Clone + Ord + core::fmt::Debug> SyncRequestBuilderExt<K> for SyncRequestBuilder<(K, u32)> {
+    fn revealed_spks_from_indexer<R>(self, indexer: &KeychainTxOutIndex<K>, spk_range: R) -> Self
+    where
+        R: core::ops::RangeBounds<K>,
+    {
+        self.spks_with_indexes(indexer.revealed_spks(spk_range))
+    }
+
+    fn unused_spks_from_indexer(self, indexer: &KeychainTxOutIndex<K>) -> Self {
+        self.spks_with_indexes(indexer.unused_spks())
+    }
+}
+
+/// Trait to extend [`FullScanRequestBuilder`].
+pub trait FullScanRequestBuilderExt<K> {
+    /// Add spk iterators for each keychain tracked in `indexer`.
+    fn spks_from_indexer(self, indexer: &KeychainTxOutIndex<K>) -> Self;
+}
+
+impl<K: Clone + Ord + core::fmt::Debug> FullScanRequestBuilderExt<K> for FullScanRequestBuilder<K> {
+    fn spks_from_indexer(mut self, indexer: &KeychainTxOutIndex<K>) -> Self {
+        for (keychain, spks) in indexer.all_unbounded_spk_iters() {
+            self = self.spks_for_keychain(keychain, spks);
+        }
+        self
+    }
+}

crates/chain/src/lib.rs

@@ -61,7 +61,6 @@ pub use indexer::keychain_txout;
 pub use spk_iter::*;
 #[cfg(feature = "rusqlite")]
 pub mod rusqlite_impl;
-pub mod spk_client;
 
 pub extern crate bdk_core;
 pub use bdk_core::*;
@@ -81,11 +80,6 @@ extern crate std;
 /// How many confirmations are needed f or a coinbase output to be spent.
 pub const COINBASE_MATURITY: u32 = 100;
 
-/// A tuple of keychain index and `T` representing the indexed value.
-pub type Indexed<T> = (u32, T);
-/// A tuple of keychain `K`, derivation index (`u32`) and a `T` associated with them.
-pub type KeychainIndexed<K, T> = ((K, u32), T);
-
 /// A wrapper that we use to impl remote traits for types in our crate or dependency crates.
 pub struct Impl<T>(pub T);
 

crates/core/Cargo.toml

@@ -19,3 +19,6 @@ hashbrown = { version = "0.9.1", optional = true }
 default = ["std"]
 std = ["bitcoin/std"]
 serde = ["dep:serde", "bitcoin/serde", "hashbrown?/serde"]
+
+[dev-dependencies]
+bdk_chain = { version = "0.17.0", path = "../chain" }

crates/core/src/lib.rs

@@ -54,12 +54,19 @@ pub mod collections {
     pub use hashbrown::hash_map;
 }
 
+/// A tuple of keychain index and `T` representing the indexed value.
+pub type Indexed<T> = (u32, T);
+/// A tuple of keychain `K`, derivation index (`u32`) and a `T` associated with them.
+pub type KeychainIndexed<K, T> = ((K, u32), T);
+
 mod chain_data;
 pub use chain_data::*;
 
 mod checkpoint;
 pub use checkpoint::*;
 
+pub mod spk_client;
+
 /// Core structures for [`TxGraph`].
 ///
 /// [`TxGraph`]: https://docs.rs/bdk_chain/latest/bdk_chain/tx_graph/struct.TxGraph.html

crates/chain/src/spk_client.rs renamed to crates/core/src/spk_client.rs

@@ -2,8 +2,7 @@
 use crate::{
     alloc::{boxed::Box, collections::VecDeque, vec::Vec},
     collections::BTreeMap,
-    local_chain::CheckPoint,
-    ConfirmationBlockTime, Indexed,
+    CheckPoint, ConfirmationBlockTime, Indexed,
 };
 use bitcoin::{OutPoint, Script, ScriptBuf, Txid};
 
@@ -101,27 +100,6 @@ impl<I> Default for SyncRequestBuilder<I> {
     }
 }
 
-#[cfg(feature = "miniscript")]
-impl<K: Clone + Ord + core::fmt::Debug + Send + Sync> SyncRequestBuilder<(K, u32)> {
-    /// Add [`Script`]s that are revealed by the `indexer` of the given `spk_range` that will be
-    /// synced against.
-    pub fn revealed_spks_from_indexer(
-        self,
-        indexer: &crate::indexer::keychain_txout::KeychainTxOutIndex<K>,
-        spk_range: impl core::ops::RangeBounds<K>,
-    ) -> Self {
-        self.spks_with_indexes(indexer.revealed_spks(spk_range))
-    }
-
-    /// Add [`Script`]s that are revealed by the `indexer` but currently unused.
-    pub fn unused_spks_from_indexer(
-        self,
-        indexer: &crate::indexer::keychain_txout::KeychainTxOutIndex<K>,
-    ) -> Self {
-        self.spks_with_indexes(indexer.unused_spks())
-    }
-}
-
 impl SyncRequestBuilder<()> {
     /// Add [`Script`]s that will be synced against.
     pub fn spks(self, spks: impl IntoIterator<Item = ScriptBuf>) -> Self {
@@ -132,7 +110,7 @@ impl SyncRequestBuilder<()> {
 impl<I> SyncRequestBuilder<I> {
     /// Set the initial chain tip for the sync request.
     ///
-    /// This is used to update [`LocalChain`](crate::local_chain::LocalChain).
+    /// This is used to update [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
     pub fn chain_tip(mut self, cp: CheckPoint) -> Self {
         self.inner.chain_tip = Some(cp);
         self
@@ -143,7 +121,7 @@ impl<I> SyncRequestBuilder<I> {
     /// # Example
     ///
     /// Sync revealed script pubkeys obtained from a
-    /// [`KeychainTxOutIndex`](crate::keychain_txout::KeychainTxOutIndex).
+    /// [`KeychainTxOutIndex`](../../bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).
     ///
     /// ```rust
     /// # use bdk_chain::spk_client::SyncRequest;
@@ -216,9 +194,9 @@ impl<I> SyncRequestBuilder<I> {
 ///
 /// ```rust
 /// # use bdk_chain::{bitcoin::{hashes::Hash, ScriptBuf}, local_chain::LocalChain};
+/// # use bdk_chain::spk_client::SyncRequest;
 /// # let (local_chain, _) = LocalChain::from_genesis_hash(Hash::all_zeros());
 /// # let scripts = [ScriptBuf::default(), ScriptBuf::default()];
-/// # use bdk_chain::spk_client::SyncRequest;
 /// // Construct a sync request.
 /// let sync_request = SyncRequest::builder()
 ///     // Provide chain tip of the local wallet.
@@ -345,9 +323,11 @@ impl<I> SyncRequest<I> {
 #[must_use]
 #[derive(Debug)]
 pub struct SyncResult<A = ConfirmationBlockTime> {
-    /// The update to apply to the receiving [`TxGraph`](crate::tx_graph::TxGraph).
+    /// The update to apply to the receiving
+    /// [`TxGraph`](../../bdk_chain/tx_graph/struct.TxGraph.html).
     pub graph_update: crate::tx_graph::Update<A>,
-    /// The update to apply to the receiving [`LocalChain`](crate::local_chain::LocalChain).
+    /// The update to apply to the receiving
+    /// [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
     pub chain_update: Option<CheckPoint>,
 }
 
@@ -374,24 +354,10 @@ impl<K> Default for FullScanRequestBuilder<K> {
     }
 }
 
-#[cfg(feature = "miniscript")]
-impl<K: Ord + Clone + core::fmt::Debug> FullScanRequestBuilder<K> {
-    /// Add spk iterators for each keychain tracked in `indexer`.
-    pub fn spks_from_indexer(
-        mut self,
-        indexer: &crate::indexer::keychain_txout::KeychainTxOutIndex<K>,
-    ) -> Self {
-        for (keychain, spks) in indexer.all_unbounded_spk_iters() {
-            self = self.spks_for_keychain(keychain, spks);
-        }
-        self
-    }
-}
-
 impl<K: Ord> FullScanRequestBuilder<K> {
     /// Set the initial chain tip for the full scan request.
     ///
-    /// This is used to update [`LocalChain`](crate::local_chain::LocalChain).
+    /// This is used to update [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
     pub fn chain_tip(mut self, tip: CheckPoint) -> Self {
         self.inner.chain_tip = Some(tip);
         self
@@ -496,9 +462,10 @@ impl<K: Ord + Clone> FullScanRequest<K> {
 #[must_use]
 #[derive(Debug)]
 pub struct FullScanResult<K, A = ConfirmationBlockTime> {
-    /// The update to apply to the receiving [`LocalChain`](crate::local_chain::LocalChain).
+    /// The update to apply to the receiving
+    /// [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
     pub graph_update: crate::tx_graph::Update<A>,
-    /// The update to apply to the receiving [`TxGraph`](crate::tx_graph::TxGraph).
+    /// The update to apply to the receiving [`TxGraph`](../../bdk_chain/tx_graph/struct.TxGraph.html).
     pub chain_update: Option<CheckPoint>,
     /// Last active indices for the corresponding keychains (`K`).
     pub last_active_indices: BTreeMap<K, u32>,

crates/testenv/src/lib.rs

@@ -4,7 +4,8 @@ use bdk_chain::{
         secp256k1::rand::random, transaction, Address, Amount, Block, BlockHash, CompactTarget,
         ScriptBuf, ScriptHash, Transaction, TxIn, TxOut, Txid,
     },
-    BlockId, local_chain::CheckPoint,
+    local_chain::CheckPoint,
+    BlockId,
 };
 use bitcoincore_rpc::{
     bitcoincore_rpc_json::{GetBlockTemplateModes, GetBlockTemplateRules},

crates/wallet/src/wallet/mod.rs

@@ -2472,6 +2472,7 @@ impl Wallet {
     /// [`SyncRequest`] collects all revealed script pubkeys from the wallet keychain needed to
     /// start a blockchain sync with a spk based blockchain client.
     pub fn start_sync_with_revealed_spks(&self) -> SyncRequestBuilder<(KeychainKind, u32)> {
+        use bdk_chain::keychain_txout::SyncRequestBuilderExt;
         SyncRequest::builder()
             .chain_tip(self.chain.tip())
             .revealed_spks_from_indexer(&self.indexed_graph.index, ..)
@@ -2486,6 +2487,7 @@ impl Wallet {
     /// This operation is generally only used when importing or restoring a previously used wallet
     /// in which the list of used scripts is not known.
     pub fn start_full_scan(&self) -> FullScanRequestBuilder<KeychainKind> {
+        use bdk_chain::keychain_txout::FullScanRequestBuilderExt;
         FullScanRequest::builder()
             .chain_tip(self.chain.tip())
             .spks_from_indexer(&self.indexed_graph.index)

example-crates/example_esplora/src/main.rs

@@ -6,6 +6,7 @@ use std::{
 
 use bdk_chain::{
     bitcoin::Network,
+    keychain_txout::FullScanRequestBuilderExt,
     spk_client::{FullScanRequest, SyncRequest},
     Merge,
 };