Change trait GetBlockHash to GetBlockInfo

It adds a new function get_block_headers to the original
get_block_hash()

Author: wszdexdrf

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `Excess` enum to handle remaining amount after coin selection.
 - Move change creation from `Wallet::create_tx` to `CoinSelectionAlgorithm::coin_select`.
 - Change the interface of `SqliteDatabase::new` to accept any type that implement AsRef<Path>
+- Change trait `GetBlockHash` to `GetBlockInfo`. A new function is added to the new trait `get_block_header` which expects a block height and returns corresponding block header. This is implemented on every blockchain backend.
 
 ## [v0.20.0] - [v0.19.0]
 

src/blockchain/any.rs

@@ -121,10 +121,13 @@ impl GetTx for AnyBlockchain {
 }
 
 #[maybe_async]
-impl GetBlockHash for AnyBlockchain {
+impl GetBlockInfo for AnyBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         maybe_await!(impl_inner_method!(self, get_block_hash, height))
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        maybe_await!(impl_inner_method!(self, get_block_header, height))
+    }
 }
 
 #[maybe_async]

src/blockchain/compact_filters/mod.rs

@@ -260,14 +260,19 @@ impl GetTx for CompactFiltersBlockchain {
     }
 }
 
-impl GetBlockHash for CompactFiltersBlockchain {
+impl GetBlockInfo for CompactFiltersBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         self.headers
             .get_block_hash(height as usize)?
             .ok_or(Error::CompactFilters(
                 CompactFiltersError::BlockHashNotFound,
             ))
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        self.headers
+            .get_block_header(height as usize)?
+            .ok_or(Error::CompactFilters(CompactFiltersError::InvalidHeaders))
+    }
 }
 
 impl WalletSync for CompactFiltersBlockchain {

src/blockchain/compact_filters/store.rs

@@ -436,6 +436,16 @@ impl ChainStore<Full> {
     }
 
     pub fn get_block_hash(&self, height: usize) -> Result<Option<BlockHash>, CompactFiltersError> {
+        match self.get_block_header(height)? {
+            Some(header) => Ok(Some(header.block_hash())),
+            None => Ok(None),
+        }
+    }
+
+    pub fn get_block_header(
+        &self,
+        height: usize,
+    ) -> Result<Option<BlockHeader>, CompactFiltersError> {
         let read_store = self.store.read().unwrap();
         let cf_handle = read_store.cf_handle(&self.cf_name).unwrap();
 
@@ -444,7 +454,7 @@ impl ChainStore<Full> {
         data.map(|data| {
             let (header, _): (BlockHeader, Uint256) =
                 deserialize(&data).map_err(|_| CompactFiltersError::DataCorruption)?;
-            Ok::<_, CompactFiltersError>(header.block_hash())
+            Ok::<_, CompactFiltersError>(header)
         })
         .transpose()
     }

src/blockchain/electrum.rs

@@ -98,11 +98,15 @@ impl GetTx for ElectrumBlockchain {
     }
 }
 
-impl GetBlockHash for ElectrumBlockchain {
+impl GetBlockInfo for ElectrumBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         let block_header = self.client.block_header(height as usize)?;
         Ok(block_header.block_hash())
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        let block_header = self.client.block_header(height as usize)?;
+        Ok(block_header)
+    }
 }
 
 impl WalletSync for ElectrumBlockchain {

src/blockchain/esplora/reqwest.rs

@@ -118,11 +118,15 @@ impl GetTx for EsploraBlockchain {
 }
 
 #[maybe_async]
-impl GetBlockHash for EsploraBlockchain {
+impl GetBlockInfo for EsploraBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         let block_header = await_or_block!(self.url_client._get_header(height as u32))?;
         Ok(block_header.block_hash())
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        let block_header = await_or_block!(self.url_client._get_header(height as u32))?;
+        Ok(block_header)
+    }
 }
 
 #[maybe_async]

src/blockchain/esplora/ureq.rs

@@ -112,11 +112,15 @@ impl GetTx for EsploraBlockchain {
     }
 }
 
-impl GetBlockHash for EsploraBlockchain {
+impl GetBlockInfo for EsploraBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         let block_header = self.url_client._get_header(height as u32)?;
         Ok(block_header.block_hash())
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        let block_header = await_or_block!(self.url_client._get_header(height as u32))?;
+        Ok(block_header)
+    }
 }
 
 impl WalletSync for EsploraBlockchain {

src/blockchain/mod.rs

@@ -21,7 +21,7 @@ use std::ops::Deref;
 use std::sync::mpsc::{channel, Receiver, Sender};
 use std::sync::Arc;
 
-use bitcoin::{BlockHash, Transaction, Txid};
+use bitcoin::{BlockHash, BlockHeader, Transaction, Txid};
 
 use crate::database::BatchDatabase;
 use crate::error::Error;
@@ -87,7 +87,7 @@ pub enum Capability {
 
 /// Trait that defines the actions that must be supported by a blockchain backend
 #[maybe_async]
-pub trait Blockchain: WalletSync + GetHeight + GetTx + GetBlockHash {
+pub trait Blockchain: WalletSync + GetHeight + GetTx + GetBlockInfo {
     /// Return the set of [`Capability`] supported by this backend
     fn get_capabilities(&self) -> HashSet<Capability>;
     /// Broadcast a transaction
@@ -112,9 +112,11 @@ pub trait GetTx {
 
 #[maybe_async]
 /// Trait for getting block hash by block height
-pub trait GetBlockHash {
+pub trait GetBlockInfo {
     /// fetch block hash given its height
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error>;
+    /// fetch block header given its height
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error>;
 }
 
 /// Trait for blockchains that can sync by updating the database directly.
@@ -367,10 +369,13 @@ impl<T: GetHeight> GetHeight for Arc<T> {
 }
 
 #[maybe_async]
-impl<T: GetBlockHash> GetBlockHash for Arc<T> {
+impl<T: GetBlockInfo> GetBlockInfo for Arc<T> {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         maybe_await!(self.deref().get_block_hash(height))
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        maybe_await!(self.deref().get_block_header(height))
+    }
 }
 
 #[maybe_async]

src/blockchain/rpc.rs

@@ -169,10 +169,14 @@ impl GetHeight for RpcBlockchain {
     }
 }
 
-impl GetBlockHash for RpcBlockchain {
+impl GetBlockInfo for RpcBlockchain {
     fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> {
         Ok(self.client.get_block_hash(height)?)
     }
+    fn get_block_header(&self, height: u64) -> Result<BlockHeader, Error> {
+        let block_hash = self.client.get_block_hash(height)?;
+        Ok(self.client.get_block_header(&block_hash)?)
+    }
 }
 
 impl WalletSync for RpcBlockchain {

src/testutils/blockchain_tests.rs

@@ -1419,7 +1419,7 @@ macro_rules! bdk_blockchain_tests {
             #[test]
             fn test_get_block_hash() {
                 use bitcoincore_rpc::{ RpcApi };
-                use crate::blockchain::GetBlockHash;
+                use crate::blockchain::GetBlockInfo;
 
                 // create wallet with init_wallet
                 let (_, blockchain, _descriptors, mut test_client) = init_single_sig();