add txids param to listspendtxs

Author: pythcoiner

doc/API.md

@@ -210,12 +210,14 @@ This command does not return anything for now.
 
 List stored Spend transactions.
 
-#### Request
 
-This command does not take any parameter for now.
+If `txids` is specified, only list transactions whose `txid` is in `txids`(empty list of `txids` is not allowed).
 
-| Field         | Type              | Description                                                 |
-| ------------- | ----------------- | ----------------------------------------------------------- |
+#### Request
+
+| Field         | Type                       | Description                          |
+| ------------- | -------------------------- | ------------------------------------ |
+| `txids`       | array of string (optional) | Ids of the transactions to retrieve  |
 
 #### Response
 

src/commands/mod.rs

@@ -580,13 +580,25 @@ impl DaemonControl {
         }
     }
 
-    pub fn list_spend(&self) -> ListSpendResult {
+    pub fn list_spend(&self, txids: Option<Vec<bitcoin::Txid>>) -> ListSpendResult {
         let mut db_conn = self.db.connection();
-        let spend_txs = db_conn
-            .list_spend()
+        let spend_psbts = db_conn.list_spend();
+
+        let txids_set: Option<HashSet<_>> =
+            txids.as_ref().map(|list| list.iter().cloned().collect());
+
+        let spend_txs = spend_psbts
             .into_iter()
+            .filter(|(psbt, _)| {
+                if let Some(set) = &txids_set {
+                    set.contains(&psbt.unsigned_tx.txid())
+                } else {
+                    true
+                }
+            })
             .map(|(psbt, updated_at)| ListSpendEntry { psbt, updated_at })
             .collect();
+
         ListSpendResult { spend_txs }
     }
 

src/jsonrpc/api.rs

@@ -10,7 +10,7 @@ use std::{
     str::FromStr,
 };
 
-use miniscript::bitcoin::{self, psbt::Psbt};
+use miniscript::bitcoin::{self, psbt::Psbt, Txid};
 
 fn create_spend(control: &DaemonControl, params: Params) -> Result<serde_json::Value, Error> {
     let destinations = params
@@ -226,6 +226,34 @@ fn list_confirmed(control: &DaemonControl, params: Params) -> Result<serde_json:
     ))
 }
 
+fn list_spendtxs(
+    control: &DaemonControl,
+    params: Option<Params>,
+) -> Result<serde_json::Value, Error> {
+    let txids: Option<Vec<bitcoin::Txid>> = if let Some(p) = params {
+        let tx_ids = p.get(0, "txids");
+        if let Some(ids) = tx_ids {
+            let ids: Vec<Txid> = ids
+                .as_array()
+                .and_then(|arr| {
+                    arr.iter()
+                        .map(|entry| entry.as_str().and_then(|e| bitcoin::Txid::from_str(e).ok()))
+                        .collect()
+                })
+                .ok_or_else(|| Error::invalid_params("Invalid 'txids' parameter."))?;
+            if ids.is_empty() {
+                return Err(Error::invalid_params("Invalid 'txids' parameter."));
+            }
+            Some(ids)
+        } else {
+            None
+        }
+    } else {
+        None
+    };
+    Ok(serde_json::json!(&control.list_spend(txids)))
+}
+
 fn list_transactions(control: &DaemonControl, params: Params) -> Result<serde_json::Value, Error> {
     let txids: Vec<bitcoin::Txid> = params
         .get(0, "txids")
@@ -391,7 +419,7 @@ pub fn handle_request(control: &DaemonControl, req: Request) -> Result<Response,
             })?;
             list_confirmed(control, params)?
         }
-        "listspendtxs" => serde_json::json!(&control.list_spend()),
+        "listspendtxs" => list_spendtxs(control, req.params)?,
         "listtransactions" => {
             let params = req.params.ok_or_else(|| {
                 Error::invalid_params(

tests/test_rpc.py

@@ -457,6 +457,33 @@ def test_list_spend(lianad, bitcoind):
     lianad.rpc.updatespend(res["psbt"])
     lianad.rpc.updatespend(res_b["psbt"])
 
+    # Check 'txids' parameter
+    list_res = lianad.rpc.listspendtxs()["spend_txs"]
+
+    txid = bitcoind.rpc.decodepsbt(list_res[0]['psbt'])['tx']['txid']
+
+    filtered_res = lianad.rpc.listspendtxs(txids=[txid])
+    assert filtered_res['spend_txs'][0]['psbt'] == list_res[0]['psbt']
+    assert len(filtered_res) == 1
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=[])
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=[txid, 123])
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=[0])
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=[123])
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=['abc'])
+
+    with pytest.raises(RpcError, match="Invalid params: Invalid 'txids' parameter."):
+        lianad.rpc.listspendtxs(txids=['123'])
+
     # Listing all Spend transactions will list them both. It'll tell us which one has
     # change and which one doesn't.
     list_res = lianad.rpc.listspendtxs()["spend_txs"]