Merge #25: Add get raw block endpoint

199c6ec Add get raw block endpoint (benthecarman)

Pull request description:

  This will be needed for implementing LDKs `BlockSource` trait

Top commit has no ACKs.

Tree-SHA512: b59f4933f6ba03dc36805b9728e57f480fe33a1e1908d2affa1028c27548fd4426c66261a087f5414bf790380c4f68f8ed8d8012f84deaa039f96a746d3f3ad2

Author: vladimirfomene

src/async.rs

@@ -17,7 +17,7 @@ use std::str::FromStr;
 use bitcoin::consensus::{deserialize, serialize};
 use bitcoin::hashes::hex::{FromHex, ToHex};
 use bitcoin::hashes::{sha256, Hash};
-use bitcoin::{BlockHash, BlockHeader, Script, Transaction, Txid};
+use bitcoin::{Block, BlockHash, BlockHeader, Script, Transaction, Txid};
 
 #[allow(unused_imports)]
 use log::{debug, error, info, trace};
@@ -147,6 +147,20 @@ impl AsyncClient {
         Ok(resp.error_for_status()?.json().await?)
     }
 
+    /// Get a [`Block`] given a particular [`BlockHash`].
+    pub async fn get_block_by_hash(&self, block_hash: &BlockHash) -> Result<Option<Block>, Error> {
+        let resp = self
+            .client
+            .get(&format!("{}/block/{}/raw", self.url, block_hash))
+            .send()
+            .await?;
+
+        if let StatusCode::NOT_FOUND = resp.status() {
+            return Ok(None);
+        }
+        Ok(Some(deserialize(&resp.error_for_status()?.bytes().await?)?))
+    }
+
     /// Get a merkle inclusion proof for a [`Transaction`] with the given [`Txid`].
     pub async fn get_merkle_proof(&self, tx_hash: &Txid) -> Result<Option<MerkleProof>, Error> {
         let resp = self

src/blocking.rs

@@ -25,7 +25,7 @@ use ureq::{Agent, Proxy, Response};
 use bitcoin::consensus::{deserialize, serialize};
 use bitcoin::hashes::hex::{FromHex, ToHex};
 use bitcoin::hashes::{sha256, Hash};
-use bitcoin::{BlockHash, BlockHeader, Script, Transaction, Txid};
+use bitcoin::{Block, BlockHash, BlockHeader, Script, Transaction, Txid};
 
 use crate::{BlockStatus, Builder, Error, MerkleProof, OutputStatus, Tx, TxStatus};
 
@@ -164,6 +164,25 @@ impl BlockingClient {
         }
     }
 
+    /// Get a [`Block`] given a particular [`BlockHash`].
+    pub fn get_block_by_hash(&self, block_hash: &BlockHash) -> Result<Option<Block>, Error> {
+        let resp = self
+            .agent
+            .get(&format!("{}/block/{}/raw", self.url, block_hash))
+            .call();
+
+        match resp {
+            Ok(resp) => Ok(Some(deserialize(&into_bytes(resp)?)?)),
+            Err(ureq::Error::Status(code, _)) => {
+                if is_status_not_found(code) {
+                    return Ok(None);
+                }
+                Err(Error::HttpResponse(code))
+            }
+            Err(e) => Err(Error::Ureq(e)),
+        }
+    }
+
     /// Get a merkle inclusion proof for a [`Transaction`] with the given [`Txid`].
     pub fn get_merkle_proof(&self, txid: &Txid) -> Result<Option<MerkleProof>, Error> {
         let resp = self

src/lib.rs

@@ -506,6 +506,37 @@ mod test {
         assert_eq!(expected, block_status_async);
     }
 
+    #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
+    #[tokio::test]
+    async fn test_get_block_by_hash() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let block_hash = BITCOIND.client.get_block_hash(21).unwrap();
+
+        let expected = Some(BITCOIND.client.get_block(&block_hash).unwrap());
+
+        let block = blocking_client.get_block_by_hash(&block_hash).unwrap();
+        let block_async = async_client.get_block_by_hash(&block_hash).await.unwrap();
+        assert_eq!(expected, block);
+        assert_eq!(expected, block_async);
+    }
+
+    #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
+    #[tokio::test]
+    async fn test_get_block_by_hash_not_existing() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let block = blocking_client
+            .get_block_by_hash(&BlockHash::all_zeros())
+            .unwrap();
+        let block_async = async_client
+            .get_block_by_hash(&BlockHash::all_zeros())
+            .await
+            .unwrap();
+        assert!(block.is_none());
+        assert!(block_async.is_none());
+    }
+
     #[cfg(all(feature = "blocking", any(feature = "async", feature = "async-https")))]
     #[tokio::test]
     async fn test_get_merkle_proof() {