crc: update get_block_hash api, #6250

Author: fdefelici

stacks-node/src/burnchains/rpc/bitcoin_rpc_client/mod.rs

@@ -298,6 +298,22 @@ impl<'de> Deserialize<'de> for TxidWrapperResponse {
     }
 }
 
+/// Response mainly used as deserialization wrapper for [`BurnchainHeaderHash`]
+struct BurnchainHeaderHashWrapperResponse(pub BurnchainHeaderHash);
+
+/// Deserializes a JSON string (hex-encoded, big-endian) into [`BurnchainHeaderHash`],
+/// and wrap it into [`BurnchainHeaderHashWrapperResponse`]
+impl<'de> Deserialize<'de> for BurnchainHeaderHashWrapperResponse {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let hex_str: String = Deserialize::deserialize(deserializer)?;
+        let bhh = BurnchainHeaderHash::from_hex(&hex_str).map_err(serde::de::Error::custom)?;
+        Ok(BurnchainHeaderHashWrapperResponse(bhh))
+    }
+}
+
 /// Client for interacting with a Bitcoin RPC service.
 #[derive(Debug)]
 pub struct BitcoinRpcClient {
@@ -651,13 +667,16 @@ impl BitcoinRpcClient {
     /// * `height` - The height (block number) of the block whose hash is requested.
     ///
     /// # Returns
-    /// A `String` representing the block hash in hexadecimal format.
+    /// A [`BurnchainHeaderHash`] representing the block hash.
     ///
     /// # Availability
     /// - **Since**: Bitcoin Core **v0.9.0**.
-    pub fn get_block_hash(&self, height: u64) -> BitcoinRpcClientResult<String> {
-        Ok(self
-            .global_ep
-            .send(&self.client_id, "getblockhash", vec![height.into()])?)
+    pub fn get_block_hash(&self, height: u64) -> BitcoinRpcClientResult<BurnchainHeaderHash> {
+        let response = self.global_ep.send::<BurnchainHeaderHashWrapperResponse>(
+            &self.client_id,
+            "getblockhash",
+            vec![height.into()],
+        )?;
+        Ok(response.0)
     }
 }

stacks-node/src/burnchains/rpc/bitcoin_rpc_client/tests.rs

@@ -958,7 +958,7 @@ fn test_invalidate_block_ok() {
 #[test]
 fn test_get_block_hash_ok() {
     let height = 1;
-    let expected_hash = "0000";
+    let expected_hash = utils::BITCOIN_BLOCK_HASH;
 
     let expected_request = json!({
         "jsonrpc": "2.0",
@@ -984,8 +984,8 @@ fn test_get_block_hash_ok() {
 
     let client = utils::setup_client(&server);
 
-    let hash = client.get_block_hash(height).expect("Should be ok!");
-    assert_eq!(expected_hash, hash);
+    let bhh = client.get_block_hash(height).expect("Should be ok!");
+    assert_eq!(expected_hash, bhh.to_hex());
 }
 
 #[test]

stacks-node/src/tests/bitcoin_rpc_integrations.rs

@@ -612,10 +612,10 @@ fn test_get_block_hash_ok() {
 
     let client = BitcoinRpcClient::from_stx_config(&config).expect("Client creation ok!");
 
-    let hash = client
+    let bhh = client
         .get_block_hash(0)
         .expect("Should return regtest genesis block hash!");
-    assert_eq!(BITCOIN_REGTEST_FIRST_BLOCK_HASH, hash);
+    assert_eq!(BITCOIN_REGTEST_FIRST_BLOCK_HASH, bhh.to_hex());
 }
 
 #[ignore]