feat(client): add get_scripthash_utxos

Author: luisschwab

src/async.rs

@@ -475,10 +475,19 @@ impl<S: Sleeper> AsyncClient<S> {
         Ok(blocks)
     }
 
-    /// Get all UTXOs locked to an address.
+    /// Get all [`TxOut`]s locked to an [`Address`].
     pub async fn get_address_utxos(&self, address: &Address) -> Result<Vec<Utxo>, Error> {
-        self.get_response_json(&format!("/address/{address}/utxo"))
-            .await
+        let path = format!("/address/{address}/utxo");
+
+        self.get_response_json(&path).await
+    }
+
+    /// Get all [`TxOut`]s locked to a [`Script`] hash.
+    pub async fn get_scripthash_utxos(&self, script: &Script) -> Result<Vec<Utxo>, Error> {
+        let script_hash = sha256::Hash::hash(script.as_bytes());
+        let path = format!("/scripthash/{script_hash}/utxo");
+
+        self.get_response_json(&path).await
     }
 
     /// Get the underlying base URL.

src/blocking.rs

@@ -403,9 +403,19 @@ impl BlockingClient {
         Ok(blocks)
     }
 
-    /// Get all UTXOs locked to an address.
+    /// Get all [`TxOut`]s locked to an [`Address`].
     pub fn get_address_utxos(&self, address: &Address) -> Result<Vec<Utxo>, Error> {
-        self.get_response_json(&format!("/address/{address}/utxo"))
+        let path = format!("/address/{address}/utxo");
+
+        self.get_response_json(&path)
+    }
+
+    /// Get all [`TxOut`]s locked to a [`Script`] hash.
+    pub fn get_scripthash_utxos(&self, script: &Script) -> Result<Vec<Utxo>, Error> {
+        let script_hash = sha256::Hash::hash(script.as_bytes());
+        let path = format!("/scripthash/{script_hash}/utxo");
+
+        self.get_response_json(&path)
     }
 
     /// Sends a GET request to the given `url`, retrying failed attempts

src/lib.rs

@@ -1279,6 +1279,35 @@ mod test {
         assert_eq!(address_utxos_blocking, address_utxos_async);
     }
 
+    #[cfg(all(feature = "blocking", feature = "async"))]
+    #[tokio::test]
+    async fn test_get_scripthash_utxos() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let address = BITCOIND
+            .client
+            .new_address_with_type(AddressType::Legacy)
+            .unwrap();
+        let script = address.script_pubkey();
+
+        let _txid = BITCOIND
+            .client
+            .send_to_address(&address, Amount::from_sat(21000))
+            .unwrap()
+            .txid()
+            .unwrap();
+
+        let _miner = MINER.lock().await;
+        generate_blocks_and_wait(1);
+
+        let scripthash_utxos_blocking = blocking_client.get_scripthash_utxos(&script).unwrap();
+        let scripthash_utxos_async = async_client.get_scripthash_utxos(&script).await.unwrap();
+
+        assert_ne!(scripthash_utxos_blocking.len(), 0);
+        assert_ne!(scripthash_utxos_async.len(), 0);
+        assert_eq!(scripthash_utxos_blocking, scripthash_utxos_async);
+    }
+
     #[cfg(all(feature = "blocking", feature = "async"))]
     #[tokio::test]
     async fn test_get_tx_outspends() {