Merge #17: Allow to retrieve a block header by hash

92606cc Test `get_header_by_hash` rather than `get_height` (Elias Rohrer)
6673912 Deprecate `get_height` (Elias Rohrer)
9e233ef Allow to retrieve a block header by hash (Elias Rohrer)

Pull request description:

  ~~Based on #13 since it probably land soon.~~

  This PR adds a method allowing to retrieve a `BlockHeader` via a given `BlockHash` and reuses it in `get_height`.

Top commit has no ACKs.

Tree-SHA512: 2be894f7e745e317b02512183e073806e90145cbde9ad89f10e5782d6bc302da6d72adb0cef0fce7cd746e4f7b93fba0844a640bc30457ccafbcf19dd5673254

Author: vladimirfomene

src/async.rs

@@ -113,10 +113,18 @@ impl AsyncClient {
         Ok(Some(resp.error_for_status()?.json().await?))
     }
 
+    #[deprecated(
+        since = "0.1.2",
+        note = "Deprecated to improve alignment with Esplora API. Users should use `get_block_hash` and `get_header_by_hash` methods directly."
+    )]
     /// Get a [`BlockHeader`] given a particular block height.
     pub async fn get_header(&self, block_height: u32) -> Result<BlockHeader, Error> {
         let block_hash = self.get_block_hash(block_height).await?;
+        self.get_header_by_hash(&block_hash).await
+    }
 
+    /// Get a [`BlockHeader`] given a particular block hash.
+    pub async fn get_header_by_hash(&self, block_hash: &BlockHash) -> Result<BlockHeader, Error> {
         let resp = self
             .client
             .get(&format!("{}/block/{}/header", self.url, block_hash))

src/blocking.rs

@@ -127,9 +127,17 @@ impl BlockingClient {
     }
 
     /// Get a [`BlockHeader`] given a particular block height.
+    #[deprecated(
+        since = "0.1.2",
+        note = "Deprecated to improve alignment with Esplora API. Users should use `get_block_hash` and `get_header_by_hash` methods directly."
+    )]
     pub fn get_header(&self, block_height: u32) -> Result<BlockHeader, Error> {
         let block_hash = self.get_block_hash(block_height)?;
+        self.get_header_by_hash(&block_hash)
+    }
 
+    /// Get a [`BlockHeader`] given a particular block hash.
+    pub fn get_header_by_hash(&self, block_hash: &BlockHash) -> Result<BlockHeader, Error> {
         let resp = self
             .agent
             .get(&format!("{}/block/{}/header", self.url, block_hash))

src/lib.rs

@@ -450,10 +450,13 @@ mod test {
 
     #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
     #[tokio::test]
-    async fn test_get_header() {
+    async fn test_get_header_by_hash() {
         let (blocking_client, async_client) = setup_clients().await;
-        let block_header = blocking_client.get_header(53).unwrap();
-        let block_header_async = async_client.get_header(53).await.unwrap();
+
+        let block_hash = BITCOIND.client.get_block_hash(23).unwrap();
+
+        let block_header = blocking_client.get_header_by_hash(&block_hash).unwrap();
+        let block_header_async = async_client.get_header_by_hash(&block_hash).await.unwrap();
         assert_eq!(block_header, block_header_async);
     }