feat: add get_mempool_stats

Author: luisschwab

src/async.rs

@@ -27,9 +27,9 @@ use log::{debug, error, info, trace};
 use reqwest::{header, Client, Response};
 
 use crate::{
-    AddressStats, BlockInformation, BlockStatus, BlockSummary, Builder, Error, MerkleProof,
-    OutputSpendStatus, OutputStatus, ScriptHashStats, Tx, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
-    RETRYABLE_ERROR_CODES,
+    AddressStats, BlockInformation, BlockStatus, BlockSummary, Builder, Error, MempoolStats,
+    MerkleProof, OutputSpendStatus, OutputStatus, ScriptHashStats, Tx, TxStatus, Utxo,
+    BASE_BACKOFF_MILLIS, RETRYABLE_ERROR_CODES,
 };
 
 #[derive(Debug, Clone)]
@@ -459,6 +459,11 @@ impl<S: Sleeper> AsyncClient<S> {
         self.get_response_json(&path).await
     }
 
+    /// Get statistics about the mempool.
+    pub async fn get_mempool_stats(&self) -> Result<MempoolStats, Error> {
+        self.get_response_json("/mempool").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

@@ -28,9 +28,9 @@ use bitcoin::hex::{DisplayHex, FromHex};
 use bitcoin::{Address, Block, BlockHash, MerkleBlock, Script, Transaction, Txid};
 
 use crate::{
-    AddressStats, BlockInformation, BlockStatus, BlockSummary, Builder, Error, MerkleProof,
-    OutputSpendStatus, OutputStatus, ScriptHashStats, Tx, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
-    RETRYABLE_ERROR_CODES,
+    AddressStats, BlockInformation, BlockStatus, BlockSummary, Builder, Error, MempoolStats,
+    MerkleProof, OutputSpendStatus, OutputStatus, ScriptHashStats, Tx, TxStatus, Utxo,
+    BASE_BACKOFF_MILLIS, RETRYABLE_ERROR_CODES,
 };
 
 #[derive(Debug, Clone)]
@@ -316,6 +316,11 @@ impl BlockingClient {
             .map(|s| BlockHash::from_str(s.as_str()).map_err(Error::HexToArray))?
     }
 
+    /// Get statistics about the mempool.
+    pub fn get_mempool_stats(&self) -> Result<MempoolStats, Error> {
+        self.get_response_json("/mempool")
+    }
+
     /// 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 fn get_fee_estimates(&self) -> Result<HashMap<u16, f64>, Error> {

src/lib.rs

@@ -873,6 +873,39 @@ mod test {
         assert_eq!(txid_at_block_index, txid_at_block_index_async);
     }
 
+    #[cfg(all(feature = "blocking", feature = "async"))]
+    #[tokio::test]
+    async fn test_get_mempool_stats() {
+        let (blocking_client, async_client) = setup_clients().await;
+        let address = BITCOIND
+            .client
+            .new_address_with_type(AddressType::Legacy)
+            .unwrap();
+
+        for _ in 0..5 {
+            BITCOIND
+                .client
+                .send_to_address(&address, Amount::from_sat(1000))
+                .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 stats_blocking = blocking_client.get_mempool_stats().unwrap();
+        let stats_async = async_client.get_mempool_stats().await.unwrap();
+
+        assert_eq!(stats_blocking, stats_async);
+
+        assert!(stats_blocking.count >= 5);
+        assert!(stats_blocking.vsize > 0);
+        assert!(stats_blocking.total_fee > 0);
+
+        if stats_blocking.count > 0 {
+            assert!(!stats_blocking.fee_histogram.is_empty());
+        }
+    }
+
     #[cfg(all(feature = "blocking", feature = "async"))]
     #[tokio::test]
     async fn test_get_fee_estimates() {