refactor(core): spk_client types take generics

Author: LagginTimes

crates/core/src/spk_client.rs

@@ -4,7 +4,7 @@ use crate::{
     collections::BTreeMap,
     CheckPoint, ConfirmationBlockTime, Indexed,
 };
-use bitcoin::{OutPoint, Script, ScriptBuf, Txid};
+use bitcoin::{BlockHash, OutPoint, Script, ScriptBuf, Txid};
 
 type InspectSync<I> = dyn FnMut(SyncItem<I>, SyncProgress) + Send + 'static;
 
@@ -90,8 +90,8 @@ impl SyncProgress {
 ///
 /// Construct with [`SyncRequest::builder`].
 #[must_use]
-pub struct SyncRequestBuilder<I = ()> {
-    inner: SyncRequest<I>,
+pub struct SyncRequestBuilder<I = (), B = BlockHash> {
+    inner: SyncRequest<I, B>,
 }
 
 impl SyncRequestBuilder<()> {
@@ -101,11 +101,11 @@ impl SyncRequestBuilder<()> {
     }
 }
 
-impl<I> SyncRequestBuilder<I> {
+impl<I, B> SyncRequestBuilder<I, B> {
     /// Set the initial chain tip for the sync request.
     ///
     /// This is used to update [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
-    pub fn chain_tip(mut self, cp: CheckPoint) -> Self {
+    pub fn chain_tip(mut self, cp: CheckPoint<B>) -> Self {
         self.inner.chain_tip = Some(cp);
         self
     }
@@ -118,6 +118,7 @@ impl<I> SyncRequestBuilder<I> {
     /// [`KeychainTxOutIndex`](../../bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).
     ///
     /// ```rust
+    /// # use bdk_chain::bitcoin::BlockHash;
     /// # use bdk_chain::spk_client::SyncRequest;
     /// # use bdk_chain::indexer::keychain_txout::KeychainTxOutIndex;
     /// # use bdk_chain::miniscript::{Descriptor, DescriptorPublicKey};
@@ -135,15 +136,15 @@ impl<I> SyncRequestBuilder<I> {
     /// let (newly_revealed_spks, _changeset) = indexer
     ///     .reveal_to_target("descriptor_a", 21)
     ///     .expect("keychain must exist");
-    /// let _request = SyncRequest::builder()
+    /// let _request: SyncRequest<u32, BlockHash> = SyncRequest::builder()
     ///     .spks_with_indexes(newly_revealed_spks)
     ///     .build();
     ///
     /// // Sync all revealed spks in the indexer. This time, spks may be derived from different
     /// // keychains. Each spk will be indexed with `(&'static str, u32)` where `&'static str` is
     /// // the keychain identifier and `u32` is the derivation index.
     /// let all_revealed_spks = indexer.revealed_spks(..);
-    /// let _request = SyncRequest::builder()
+    /// let _request: SyncRequest<(&str, u32), BlockHash> = SyncRequest::builder()
     ///     .spks_with_indexes(all_revealed_spks)
     ///     .build();
     /// # Ok::<_, bdk_chain::keychain_txout::InsertDescriptorError<_>>(())
@@ -175,7 +176,7 @@ impl<I> SyncRequestBuilder<I> {
     }
 
     /// Build the [`SyncRequest`].
-    pub fn build(self) -> SyncRequest<I> {
+    pub fn build(self) -> SyncRequest<I, B> {
         self.inner
     }
 }
@@ -203,9 +204,9 @@ impl<I> SyncRequestBuilder<I> {
 ///     .build();
 /// ```
 #[must_use]
-pub struct SyncRequest<I = ()> {
+pub struct SyncRequest<I = (), B = BlockHash> {
     start_time: u64,
-    chain_tip: Option<CheckPoint>,
+    chain_tip: Option<CheckPoint<B>>,
     spks: VecDeque<(I, ScriptBuf)>,
     spks_consumed: usize,
     txids: VecDeque<Txid>,
@@ -215,13 +216,13 @@ pub struct SyncRequest<I = ()> {
     inspect: Box<InspectSync<I>>,
 }
 
-impl<I> From<SyncRequestBuilder<I>> for SyncRequest<I> {
-    fn from(builder: SyncRequestBuilder<I>) -> Self {
+impl<I, B> From<SyncRequestBuilder<I, B>> for SyncRequest<I, B> {
+    fn from(builder: SyncRequestBuilder<I, B>) -> Self {
         builder.inner
     }
 }
 
-impl<I> SyncRequest<I> {
+impl<I, B> SyncRequest<I, B> {
     /// Start building [`SyncRequest`] with a given `start_time`.
     ///
     /// `start_time` specifies the start time of sync. Chain sources can use this value to set
@@ -230,7 +231,7 @@ impl<I> SyncRequest<I> {
     ///
     /// Use [`SyncRequest::builder`] to use the current timestamp as `start_time` (this requires
     /// `feature = "std"`).
-    pub fn builder_at(start_time: u64) -> SyncRequestBuilder<I> {
+    pub fn builder_at(start_time: u64) -> SyncRequestBuilder<I, B> {
         SyncRequestBuilder {
             inner: Self {
                 start_time,
@@ -252,7 +253,7 @@ impl<I> SyncRequest<I> {
     /// is not available.
     #[cfg(feature = "std")]
     #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
-    pub fn builder() -> SyncRequestBuilder<I> {
+    pub fn builder() -> SyncRequestBuilder<I, B> {
         let start_time = std::time::UNIX_EPOCH
             .elapsed()
             .expect("failed to get current timestamp")
@@ -278,7 +279,7 @@ impl<I> SyncRequest<I> {
     }
 
     /// Get the chain tip [`CheckPoint`] of this request (if any).
-    pub fn chain_tip(&self) -> Option<CheckPoint> {
+    pub fn chain_tip(&self) -> Option<CheckPoint<B>> {
         self.chain_tip.clone()
     }
 
@@ -314,17 +315,17 @@ impl<I> SyncRequest<I> {
 
     /// Iterate over [`ScriptBuf`]s contained in this request.
     pub fn iter_spks(&mut self) -> impl ExactSizeIterator<Item = ScriptBuf> + '_ {
-        SyncIter::<I, ScriptBuf>::new(self)
+        SyncIter::<I, B, ScriptBuf>::new(self)
     }
 
     /// Iterate over [`Txid`]s contained in this request.
     pub fn iter_txids(&mut self) -> impl ExactSizeIterator<Item = Txid> + '_ {
-        SyncIter::<I, Txid>::new(self)
+        SyncIter::<I, B, Txid>::new(self)
     }
 
     /// Iterate over [`OutPoint`]s contained in this request.
     pub fn iter_outpoints(&mut self) -> impl ExactSizeIterator<Item = OutPoint> + '_ {
-        SyncIter::<I, OutPoint>::new(self)
+        SyncIter::<I, B, OutPoint>::new(self)
     }
 
     fn _call_inspect(&mut self, item: SyncItem<I>) {
@@ -338,14 +339,14 @@ impl<I> SyncRequest<I> {
 /// See also [`SyncRequest`].
 #[must_use]
 #[derive(Debug)]
-pub struct SyncResponse<A = ConfirmationBlockTime> {
+pub struct SyncResponse<B = BlockHash, A = ConfirmationBlockTime> {
     /// Relevant transaction data discovered during the scan.
     pub tx_update: crate::TxUpdate<A>,
     /// Changes to the chain discovered during the scan.
-    pub chain_update: Option<CheckPoint>,
+    pub chain_update: Option<CheckPoint<B>>,
 }
 
-impl<A> Default for SyncResponse<A> {
+impl<B, A> Default for SyncResponse<B, A> {
     fn default() -> Self {
         Self {
             tx_update: Default::default(),
@@ -358,15 +359,15 @@ impl<A> Default for SyncResponse<A> {
 ///
 /// Construct with [`FullScanRequest::builder`].
 #[must_use]
-pub struct FullScanRequestBuilder<K> {
-    inner: FullScanRequest<K>,
+pub struct FullScanRequestBuilder<K, B = BlockHash> {
+    inner: FullScanRequest<K, B>,
 }
 
-impl<K: Ord> FullScanRequestBuilder<K> {
+impl<K: Ord, B> FullScanRequestBuilder<K, B> {
     /// Set the initial chain tip for the full scan request.
     ///
     /// This is used to update [`LocalChain`](../../bdk_chain/local_chain/struct.LocalChain.html).
-    pub fn chain_tip(mut self, tip: CheckPoint) -> Self {
+    pub fn chain_tip(mut self, tip: CheckPoint<B>) -> Self {
         self.inner.chain_tip = Some(tip);
         self
     }
@@ -393,7 +394,7 @@ impl<K: Ord> FullScanRequestBuilder<K> {
     }
 
     /// Build the [`FullScanRequest`].
-    pub fn build(self) -> FullScanRequest<K> {
+    pub fn build(self) -> FullScanRequest<K, B> {
         self.inner
     }
 }
@@ -406,20 +407,20 @@ impl<K: Ord> FullScanRequestBuilder<K> {
 /// used scripts is not known. The full scan process also updates the chain from the given
 /// [`chain_tip`](FullScanRequestBuilder::chain_tip) (if provided).
 #[must_use]
-pub struct FullScanRequest<K> {
+pub struct FullScanRequest<K, B = BlockHash> {
     start_time: u64,
-    chain_tip: Option<CheckPoint>,
+    chain_tip: Option<CheckPoint<B>>,
     spks_by_keychain: BTreeMap<K, Box<dyn Iterator<Item = Indexed<ScriptBuf>> + Send>>,
     inspect: Box<InspectFullScan<K>>,
 }
 
-impl<K> From<FullScanRequestBuilder<K>> for FullScanRequest<K> {
-    fn from(builder: FullScanRequestBuilder<K>) -> Self {
+impl<K, B> From<FullScanRequestBuilder<K, B>> for FullScanRequest<K, B> {
+    fn from(builder: FullScanRequestBuilder<K, B>) -> Self {
         builder.inner
     }
 }
 
-impl<K: Ord + Clone> FullScanRequest<K> {
+impl<K: Ord + Clone, B> FullScanRequest<K, B> {
     /// Start building a [`FullScanRequest`] with a given `start_time`.
     ///
     /// `start_time` specifies the start time of sync. Chain sources can use this value to set
@@ -428,7 +429,7 @@ impl<K: Ord + Clone> FullScanRequest<K> {
     ///
     /// Use [`FullScanRequest::builder`] to use the current timestamp as `start_time` (this
     /// requires `feature = "std`).
-    pub fn builder_at(start_time: u64) -> FullScanRequestBuilder<K> {
+    pub fn builder_at(start_time: u64) -> FullScanRequestBuilder<K, B> {
         FullScanRequestBuilder {
             inner: Self {
                 start_time,
@@ -445,7 +446,7 @@ impl<K: Ord + Clone> FullScanRequest<K> {
     /// "std"` is not available.
     #[cfg(feature = "std")]
     #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
-    pub fn builder() -> FullScanRequestBuilder<K> {
+    pub fn builder() -> FullScanRequestBuilder<K, B> {
         let start_time = std::time::UNIX_EPOCH
             .elapsed()
             .expect("failed to get current timestamp")
@@ -459,7 +460,7 @@ impl<K: Ord + Clone> FullScanRequest<K> {
     }
 
     /// Get the chain tip [`CheckPoint`] of this request (if any).
-    pub fn chain_tip(&self) -> Option<CheckPoint> {
+    pub fn chain_tip(&self) -> Option<CheckPoint<B>> {
         self.chain_tip.clone()
     }
 
@@ -491,17 +492,17 @@ impl<K: Ord + Clone> FullScanRequest<K> {
 /// See also [`FullScanRequest`].
 #[must_use]
 #[derive(Debug)]
-pub struct FullScanResponse<K, A = ConfirmationBlockTime> {
+pub struct FullScanResponse<K, B = BlockHash, A = ConfirmationBlockTime> {
     /// Relevant transaction data discovered during the scan.
     pub tx_update: crate::TxUpdate<A>,
     /// Last active indices for the corresponding keychains (`K`). An index is active if it had a
     /// transaction associated with the script pubkey at that index.
     pub last_active_indices: BTreeMap<K, u32>,
     /// Changes to the chain discovered during the scan.
-    pub chain_update: Option<CheckPoint>,
+    pub chain_update: Option<CheckPoint<B>>,
 }
 
-impl<K, A> Default for FullScanResponse<K, A> {
+impl<K, B, A> Default for FullScanResponse<K, B, A> {
     fn default() -> Self {
         Self {
             tx_update: Default::default(),
@@ -527,23 +528,26 @@ impl<K: Ord + Clone> Iterator for KeychainSpkIter<'_, K> {
     }
 }
 
-struct SyncIter<'r, I, Item> {
-    request: &'r mut SyncRequest<I>,
+struct SyncIter<'r, I, B, Item> {
+    request: &'r mut SyncRequest<I, B>,
     marker: core::marker::PhantomData<Item>,
 }
 
-impl<'r, I, Item> SyncIter<'r, I, Item> {
-    fn new(request: &'r mut SyncRequest<I>) -> Self {
+impl<'r, I, B, Item> SyncIter<'r, I, B, Item> {
+    fn new(request: &'r mut SyncRequest<I, B>) -> Self {
         Self {
             request,
             marker: core::marker::PhantomData,
         }
     }
 }
 
-impl<'r, I, Item> ExactSizeIterator for SyncIter<'r, I, Item> where SyncIter<'r, I, Item>: Iterator {}
+impl<'r, I, B, Item> ExactSizeIterator for SyncIter<'r, I, B, Item> where
+    SyncIter<'r, I, B, Item>: Iterator
+{
+}
 
-impl<I> Iterator for SyncIter<'_, I, ScriptBuf> {
+impl<I, B> Iterator for SyncIter<'_, I, B, ScriptBuf> {
     type Item = ScriptBuf;
 
     fn next(&mut self) -> Option<Self::Item> {
@@ -556,7 +560,7 @@ impl<I> Iterator for SyncIter<'_, I, ScriptBuf> {
     }
 }
 
-impl<I> Iterator for SyncIter<'_, I, Txid> {
+impl<I, B> Iterator for SyncIter<'_, I, B, Txid> {
     type Item = Txid;
 
     fn next(&mut self) -> Option<Self::Item> {
@@ -569,7 +573,7 @@ impl<I> Iterator for SyncIter<'_, I, Txid> {
     }
 }
 
-impl<I> Iterator for SyncIter<'_, I, OutPoint> {
+impl<I, B> Iterator for SyncIter<'_, I, B, OutPoint> {
     type Item = OutPoint;
 
     fn next(&mut self) -> Option<Self::Item> {