Merge #13: Query block hash by by block height

7c66cf1 Add integration test for get_block_hash() (Gabriel Comte)
a0f1aca Query block hash by by block height (Gabriel Comte)

Pull request description:

  Give the possibility to query a block hash by providing its corresponding block height

Top commit has no ACKs.

Tree-SHA512: e6ae7a1804f6e08079e05db665ab7f32c48af338ed3c6b257102f5721af0e8cd312abbe1f0bdb2429cc3c0969dab3e5ab5ac97f228f47d89b8eedb9ddebc3378

Author: vladimirfomene

src/async.rs

@@ -115,22 +115,11 @@ impl AsyncClient {
 
     /// Get a [`BlockHeader`] given a particular block height.
     pub async fn get_header(&self, block_height: u32) -> Result<BlockHeader, Error> {
-        let resp = self
-            .client
-            .get(&format!("{}/block-height/{}", self.url, block_height))
-            .send()
-            .await?;
-
-        if let StatusCode::NOT_FOUND = resp.status() {
-            return Err(Error::HeaderHeightNotFound(block_height));
-        }
-        let bytes = resp.bytes().await?;
-        let hash =
-            std::str::from_utf8(&bytes).map_err(|_| Error::HeaderHeightNotFound(block_height))?;
+        let block_hash = self.get_block_hash(block_height).await?;
 
         let resp = self
             .client
-            .get(&format!("{}/block/{}/header", self.url, hash))
+            .get(&format!("{}/block/{}/header", self.url, block_hash))
             .send()
             .await?;
 
@@ -209,6 +198,23 @@ impl AsyncClient {
         )?)
     }
 
+    /// Get the [`BlockHash`] of a specific block height
+    pub async fn get_block_hash(&self, block_height: u32) -> Result<BlockHash, Error> {
+        let resp = self
+            .client
+            .get(&format!("{}/block-height/{}", self.url, block_height))
+            .send()
+            .await?;
+
+        if let StatusCode::NOT_FOUND = resp.status() {
+            return Err(Error::HeaderHeightNotFound(block_height));
+        }
+
+        Ok(BlockHash::from_str(
+            &resp.error_for_status()?.text().await?,
+        )?)
+    }
+
     /// Get confirmed transaction history for the specified address/scripthash,
     /// sorted with newest first. Returns 25 transactions per page.
     /// More can be requested by specifying the last txid seen by the previous query.

src/blocking.rs

@@ -128,23 +128,11 @@ impl BlockingClient {
 
     /// Get a [`BlockHeader`] given a particular block height.
     pub fn get_header(&self, block_height: u32) -> Result<BlockHeader, Error> {
-        let resp = self
-            .agent
-            .get(&format!("{}/block-height/{}", self.url, block_height))
-            .call();
-
-        let bytes = match resp {
-            Ok(resp) => Ok(into_bytes(resp)?),
-            Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
-            Err(e) => Err(Error::Ureq(e)),
-        }?;
-
-        let hash =
-            std::str::from_utf8(&bytes).map_err(|_| Error::HeaderHeightNotFound(block_height))?;
+        let block_hash = self.get_block_hash(block_height)?;
 
         let resp = self
             .agent
-            .get(&format!("{}/block/{}/header", self.url, hash))
+            .get(&format!("{}/block/{}/header", self.url, block_hash))
             .call();
 
         match resp {
@@ -231,7 +219,27 @@ impl BlockingClient {
             .get(&format!("{}/blocks/tip/hash", self.url))
             .call();
 
-        match resp {
+        Self::process_block_result(resp)
+    }
+
+    /// Get the [`BlockHash`] of a specific block height
+    pub fn get_block_hash(&self, block_height: u32) -> Result<BlockHash, Error> {
+        let resp = self
+            .agent
+            .get(&format!("{}/block-height/{}", self.url, block_height))
+            .call();
+
+        if let Err(ureq::Error::Status(code, _)) = resp {
+            if is_status_not_found(code) {
+                return Err(Error::HeaderHeightNotFound(block_height));
+            }
+        }
+
+        Self::process_block_result(resp)
+    }
+
+    fn process_block_result(response: Result<Response, ureq::Error>) -> Result<BlockHash, Error> {
+        match response {
             Ok(resp) => Ok(BlockHash::from_str(&resp.into_string()?)?),
             Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
             Err(e) => Err(Error::Ureq(e)),

src/lib.rs

@@ -545,6 +545,19 @@ mod test {
         assert_eq!(tip_hash, tip_hash_async);
     }
 
+    #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
+    #[tokio::test]
+    async fn test_get_block_hash() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let block_hash = BITCOIND.client.get_block_hash(21).unwrap();
+
+        let block_hash_blocking = blocking_client.get_block_hash(21).unwrap();
+        let block_hash_async = async_client.get_block_hash(21).await.unwrap();
+        assert_eq!(block_hash, block_hash_blocking);
+        assert_eq!(block_hash, block_hash_async);
+    }
+
     #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
     #[tokio::test]
     async fn test_get_txid_at_block_index() {