rpc: Integrate the status flow in the listsendpays command

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

Author: vincenzopalazzo

lightningd/offer.c

@@ -282,7 +282,7 @@ static struct command_result *prev_payment(struct command *cmd,
 	bool prev_paid = false;
 
 	assert(!invreq->payer_info);
-	payments = wallet_payment_list(cmd, cmd->ld->wallet, NULL);
+	payments = wallet_payment_list(cmd, cmd->ld->wallet, NULL, NULL);
 
 	for (size_t i = 0; i < tal_count(payments); i++) {
 		const struct tlv_invoice *inv;

lightningd/pay.c

@@ -860,7 +860,7 @@ send_payment_core(struct lightningd *ld,
 	bool have_complete = false;
 
 	/* Now, do we already have one or more payments? */
-	payments = wallet_payment_list(tmpctx, ld->wallet, rhash);
+	payments = wallet_payment_list(tmpctx, ld->wallet, rhash, NULL);
 	for (size_t i = 0; i < tal_count(payments); i++) {
 		log_debug(ld->log, "Payment %zu/%zu: %s %s",
 			  i, tal_count(payments),
@@ -1516,12 +1516,13 @@ static struct command_result *json_listsendpays(struct command *cmd,
 	const struct wallet_payment **payments;
 	struct json_stream *response;
 	struct sha256 *rhash;
-	const char *invstring;
+	const char *invstring, *status_str;
 
 	if (!param(cmd, buffer, params,
 		   /* FIXME: parameter should be invstring now */
 		   p_opt("bolt11", param_string, &invstring),
 		   p_opt("payment_hash", param_sha256, &rhash),
+		   p_opt("status", param_string, &status_str),
 		   NULL))
 		return command_param_failed();
 
@@ -1553,7 +1554,14 @@ static struct command_result *json_listsendpays(struct command *cmd,
 		}
 	}
 
-	payments = wallet_payment_list(cmd, cmd->ld->wallet, rhash);
+	if (status_str) {
+		enum wallet_payment_status status;
+
+		if (!string_to_payment_status(status_str, &status))
+			return command_fail(cmd, JSONRPC2_INVALID_PARAMS, "Unrecognized status: %s", status_str);
+		payments = wallet_payment_list(cmd, cmd->ld->wallet, rhash, &status);
+	} else
+		payments = wallet_payment_list(cmd, cmd->ld->wallet, rhash, NULL);
 
 	response = json_stream_success(cmd);
 
@@ -1606,7 +1614,7 @@ static struct command_result *json_delpay(struct command *cmd,
 				payment_status_to_string(status));
 	}
 
-	payments = wallet_payment_list(cmd, cmd->ld->wallet, payment_hash);
+	payments = wallet_payment_list(cmd, cmd->ld->wallet, payment_hash, NULL);
 
 	if (tal_count(payments) == 0)
 		return command_fail(cmd, PAY_NO_SUCH_PAYMENT, "Unknown payment with payment_hash: %s",

tests/test_pay.py

@@ -4613,3 +4613,26 @@ def test_pay_low_max_htlcs(node_factory):
     l1.daemon.wait_for_log(
         r'Number of pre-split HTLCs \([0-9]+\) exceeds our HTLC budget \([0-9]+\), skipping pre-splitter'
     )
+
+
+def test_listpays_with_filter_by_status(node_factory, bitcoind):
+    """
+    This test check if the filtering by status of the command listpays
+    has some mistakes.
+    """
+
+    # Create the line graph l2 -> l1 with a channel of 10 ** 5 sat!
+    l2, l1 = node_factory.line_graph(2, fundamount=10**5, wait_for_announce=True)
+
+    inv = l1.rpc.invoice(10 ** 5, 'inv', 'inv')
+    l2.rpc.pay(inv['bolt11'])
+
+    wait_for(lambda: l2.rpc.listpays(inv['bolt11'])['pays'][0]['status'] == 'complete')
+
+    # test if the node is still ready
+    payments = l2.rpc.call("listpays", {"status": 'failed'})
+
+    assert len(payments['pays']) == 0
+
+    payments = l2.rpc.listpays()
+    assert len(l2.rpc.listpays()['pays']) == 1