feat(client): add get_mempool_address_txs and get_mempool_scripthash_txs

Author: luisschwab

src/async.rs

@@ -401,7 +401,7 @@ impl<S: Sleeper> AsyncClient<S> {
         self.get_response_json(&path).await
     }
 
-    /// Get transaction history for the specified address/scripthash, sorted with newest first.
+    /// Get transaction history for the specified address, sorted with newest first.
     ///
     /// Returns up to 50 mempool transactions plus the first 25 confirmed transactions.
     /// More can be requested by specifying the last txid seen by the previous query.
@@ -418,7 +418,14 @@ impl<S: Sleeper> AsyncClient<S> {
         self.get_response_json(&path).await
     }
 
-    /// Get confirmed transaction history for the specified address/scripthash,
+    /// Get mempool [`Transaction`]s for the specified [`Address`], sorted with newest first.
+    pub async fn get_mempool_address_txs(&self, address: &Address) -> Result<Vec<Tx>, Error> {
+        let path = format!("/address/{address}/txs/mempool");
+
+        self.get_response_json(&path).await
+    }
+
+    /// Get 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.
@@ -436,6 +443,15 @@ impl<S: Sleeper> AsyncClient<S> {
         self.get_response_json(&path).await
     }
 
+    /// Get mempool [`Transaction`] history for the
+    /// specified [`Script`] hash, sorted with newest first.
+    pub async fn get_mempool_scripthash_txs(&self, script: &Script) -> Result<Vec<Tx>, Error> {
+        let script_hash = sha256::Hash::hash(script.as_bytes());
+        let path = format!("/scripthash/{script_hash:x}/txs/mempool");
+
+        self.get_response_json(&path).await
+    }
+
     /// Get an map where the key is the confirmation target (in number of
     /// blocks) and the value is the estimated feerate (in sat/vB).
     pub async fn get_fee_estimates(&self) -> Result<HashMap<u16, f64>, Error> {

src/blocking.rs

@@ -335,7 +335,8 @@ impl BlockingClient {
         self.get_response_json(&path)
     }
 
-    /// Get transaction history for the specified address/scripthash, sorted with newest first.
+    /// Get transaction history for the specified address, sorted with newest
+    /// first.
     ///
     /// Returns up to 50 mempool transactions plus the first 25 confirmed transactions.
     /// More can be requested by specifying the last txid seen by the previous query.
@@ -352,7 +353,14 @@ impl BlockingClient {
         self.get_response_json(&path)
     }
 
-    /// Get confirmed transaction history for the specified address/scripthash,
+    /// Get mempool [`Transaction`]s for the specified [`Address`], sorted with newest first.
+    pub fn get_mempool_address_txs(&self, address: &Address) -> Result<Vec<Tx>, Error> {
+        let path = format!("/address/{address}/txs/mempool");
+
+        self.get_response_json(&path)
+    }
+
+    /// Get transaction history for the specified scripthash,
     /// sorted with newest first. Returns 25 transactions per page.
     /// More can be requested by specifying the last txid seen by the previous
     /// query.
@@ -369,6 +377,15 @@ impl BlockingClient {
         self.get_response_json(&path)
     }
 
+    /// Get mempool [`Transaction`] history for the
+    /// specified [`Script`] hash, sorted with newest first.
+    pub fn get_mempool_scripthash_txs(&self, script: &Script) -> Result<Vec<Tx>, Error> {
+        let script_hash = sha256::Hash::hash(script.as_bytes());
+        let path = format!("/scripthash/{script_hash:x}/txs/mempool");
+
+        self.get_response_json(&path)
+    }
+
     /// Gets some recent block summaries starting at the tip or at `height` if
     /// provided.
     ///

src/lib.rs

@@ -924,6 +924,50 @@ mod test {
         assert_eq!(scripthash_txs_txids, scripthash_txs_txids_async);
     }
 
+    #[cfg(all(feature = "blocking", feature = "async"))]
+    #[tokio::test]
+    async fn test_get_mempool_scripthash_txs() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let address = BITCOIND
+            .client
+            .new_address_with_type(AddressType::Legacy)
+            .unwrap();
+
+        let txid = BITCOIND
+            .client
+            .send_to_address(&address, Amount::from_sat(1000))
+            .unwrap()
+            .txid()
+            .unwrap();
+
+        // Sleep for 5 seconds so the transaction has time to propagate to electrs' mempool.
+        tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;
+
+        let expected_tx = BITCOIND
+            .client
+            .get_transaction(txid)
+            .unwrap()
+            .into_model()
+            .unwrap()
+            .tx;
+        let script = &expected_tx.output[0].script_pubkey;
+        let scripthash_txs_txids: Vec<Txid> = blocking_client
+            .get_mempool_scripthash_txs(script)
+            .unwrap()
+            .iter()
+            .map(|tx| tx.txid)
+            .collect();
+        let scripthash_txs_txids_async: Vec<Txid> = async_client
+            .get_mempool_scripthash_txs(script)
+            .await
+            .unwrap()
+            .iter()
+            .map(|tx| tx.txid)
+            .collect();
+        assert_eq!(scripthash_txs_txids, scripthash_txs_txids_async);
+    }
+
     #[cfg(all(feature = "blocking", feature = "async"))]
     #[tokio::test]
     async fn test_get_blocks() {
@@ -1176,6 +1220,37 @@ mod test {
         assert_eq!(address_txs_async[0].txid, txid);
     }
 
+    #[cfg(all(feature = "blocking", feature = "async"))]
+    #[tokio::test]
+    async fn test_get_mempool_address_txs() {
+        let (blocking_client, async_client) = setup_clients().await;
+
+        let address = BITCOIND
+            .client
+            .new_address_with_type(AddressType::Legacy)
+            .unwrap();
+
+        let txid = BITCOIND
+            .client
+            .send_to_address(&address, Amount::from_sat(1000))
+            .unwrap()
+            .txid()
+            .unwrap();
+
+        // Sleep for 5 seconds so the transaction has time to propagate to electrs' mempool.
+        tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;
+
+        let mempool_address_txs_blocking =
+            blocking_client.get_mempool_address_txs(&address).unwrap();
+        let mempool_address_txs_async = async_client
+            .get_mempool_address_txs(&address)
+            .await
+            .unwrap();
+
+        assert_eq!(mempool_address_txs_blocking, mempool_address_txs_async);
+        assert_eq!(mempool_address_txs_async[0].txid, txid);
+    }
+
     #[cfg(all(feature = "blocking", feature = "async"))]
     #[tokio::test]
     async fn test_get_address_utxos() {