Changelog-Added: Adding an "usable_only" argument to the listoffers command.

Author: 21M4TW

.msggen.json

@@ -2869,7 +2869,8 @@
         },
         "ListoffersRequest": {
             "ListOffers.active_only": 2,
-            "ListOffers.offer_id": 1
+            "ListOffers.offer_id": 1,
+            "ListOffers.usable_only": 3
         },
         "ListoffersResponse": {
             "ListOffers.offers[]": 1
@@ -10600,6 +10601,10 @@
             "added": "pre-v0.10.1",
             "deprecated": null
         },
+        "ListOffers.usable_only": {
+            "added": "v26.04",
+            "deprecated": null
+        },
         "ListPays": {
             "added": "pre-v0.10.1",
             "deprecated": null

contrib/msggen/msggen/schema.json

@@ -23271,6 +23271,12 @@
             "description": [
               "If set and is true, only offers with `active` true are returned."
             ]
+          },
+          "usable_only": {
+            "type": "boolean",
+            "description": [
+              "If set and is true, only offers that can be either used multiple times or that have not been used yet are returned."
+            ]
           }
         }
       },

contrib/pyln-client/pyln/client/lightning.py

@@ -1023,7 +1023,7 @@ def listnodes(self, node_id=None):
         }
         return self.call("listnodes", payload)
 
-    def listoffers(self, offer_id=None, active_only=None):
+    def listoffers(self, offer_id=None, active_only=None, usable_only=None):
         """List offers
 
         List all offers, or with {offer_id}, only the offer with that {offer_id} (if it exists).
@@ -1032,6 +1032,7 @@ def listoffers(self, offer_id=None, active_only=None):
         payload = {
             "offer_id": offer_id,
             "active_only": active_only,
+            "usable_only": usable_only,
         }
         return self.call("listoffers", payload)
 

doc/schemas/listoffers.json

@@ -24,6 +24,12 @@
         "description": [
           "If set and is true, only offers with `active` true are returned."
         ]
+      },
+      "usable_only": {
+        "type": "boolean",
+        "description": [
+          "If set and is true, only offers that can be either used multiple times or that have not been used yet are returned."
+        ]
       }
     }
   },

lightningd/offer.c

@@ -157,11 +157,13 @@ static struct command_result *json_listoffers(struct command *cmd,
 	const char *description;
 	const struct json_escape *label;
 	bool *active_only;
+	bool *usable_only;
 	enum offer_status status;
 
 	if (!param(cmd, buffer, params,
 		   p_opt("offer_id", param_sha256, &offer_id),
 		   p_opt_def("active_only", param_bool, &active_only, false),
+		   p_opt_def("usable_only", param_bool, &usable_only, false),
 		   NULL))
 		return command_param_failed();
 
@@ -170,7 +172,9 @@ static struct command_result *json_listoffers(struct command *cmd,
 	if (offer_id) {
 		b12 = wallet_offer_find(tmpctx, wallet, offer_id, &label,
 					&status);
-		if (b12 && offer_status_active(status) >= *active_only) {
+		if (b12 && offer_status_active(status) >= *active_only &&
+		    (offer_status_single(status) == 0 ||
+		     offer_status_used(status) == 0) >= *usable_only) {
 			json_object_start(response, NULL);
 			json_populate_offer(response,
 					    offer_id, b12,
@@ -189,7 +193,9 @@ static struct command_result *json_listoffers(struct command *cmd,
 		     stmt = wallet_offer_id_next(cmd->ld->wallet, stmt, &id)) {
 			b12 = wallet_offer_find(tmpctx, wallet, &id,
 						&label, &status);
-			if (offer_status_active(status) >= *active_only) {
+			if (offer_status_active(status) >= *active_only &&
+			    (offer_status_single(status) == 0 ||
+			     offer_status_used(status) == 0) >= *usable_only) {
 				json_object_start(response, NULL);
 				json_populate_offer(response,
 						    &id, b12,