lightningd: implement unblacklist.

Signed-off-by: Rusty Russell <[email protected]>
Changelog-Added: JSON-RPC: `blacklistrune` now has an option to un-blacklist (`relist`).

Author: rustyrussell

.msggen.json

@@ -997,6 +997,7 @@
         },
         "BlacklistruneRequest": {
             "BlacklistRune.end": 2,
+            "BlacklistRune.relist": 3,
             "BlacklistRune.start": 1
         },
         "BlacklistruneResponse": {
@@ -5127,6 +5128,10 @@
             "added": "pre-v0.10.1",
             "deprecated": null
         },
+        "BlacklistRune.relist": {
+            "added": "v25.02",
+            "deprecated": null
+        },
         "BlacklistRune.start": {
             "added": "pre-v0.10.1",
             "deprecated": null

cln-grpc/proto/node.proto

@@ -4678,6 +4678,13 @@
             "description": [
               "Final rune unique id to blacklist (defaults to start)."
             ]
+          },
+          "relist": {
+            "type": "boolean",
+            "added": "v25.02",
+            "description": [
+              "Undo the blacklisting (if any) of every rune in range start to end (inclusive)"
+            ]
           }
         },
         "dependentUpon": {
@@ -4785,6 +4792,31 @@
               }
             ]
           }
+        },
+        {
+          "description": [
+            "This undoes the blacklisting of rune 3 only"
+          ],
+          "request": {
+            "id": "example:blacklistrune#4",
+            "method": "blacklistrune",
+            "params": {
+              "start": 3,
+              "relist": true
+            }
+          },
+          "response": {
+            "blacklist": [
+              {
+                "start": 0,
+                "end": 2
+              },
+              {
+                "start": 4,
+                "end": 4
+              }
+            ]
+          }
         }
       ]
     },

cln-grpc/src/convert.rs

@@ -26,6 +26,13 @@
         "description": [
           "Final rune unique id to blacklist (defaults to start)."
         ]
+      },
+      "relist": {
+        "type": "boolean",
+        "added": "v25.02",
+        "description": [
+          "Undo the blacklisting (if any) of every rune in range start to end (inclusive)"
+        ]
       }
     },
     "dependentUpon": {
@@ -133,6 +140,31 @@
           }
         ]
       }
+    },
+    {
+      "description": [
+        "This undoes the blacklisting of rune 3 only"
+      ],
+      "request": {
+        "id": "example:blacklistrune#4",
+        "method": "blacklistrune",
+        "params": {
+          "start": 3,
+          "relist": true
+        }
+      },
+      "response": {
+        "blacklist": [
+          {
+            "start": 0,
+            "end": 2
+          },
+          {
+            "start": 4,
+            "end": 4
+          }
+        ]
+      }
     }
   ]
 }

cln-rpc/src/model.rs

@@ -646,9 +646,13 @@ static struct command_result *json_blacklistrune(struct command *cmd,
 {
 	u64 *start, *end;
 	struct rune_blacklist *blist;
+	bool *relist;
 
 	if (!param_check(cmd, buffer, params,
-			 p_opt("start", param_u64, &start), p_opt("end", param_u64, &end), NULL))
+			 p_opt("start", param_u64, &start),
+			 p_opt("end", param_u64, &end),
+			 p_opt_def("relist", param_bool, &relist, false),
+			 NULL))
 		return command_param_failed();
 
 	if (end && !start) {
@@ -659,7 +663,7 @@ static struct command_result *json_blacklistrune(struct command *cmd,
 		end = start;
 	}
 
-	if (*end >= MAX_BLACKLIST_NUM) {
+	if (end && *end >= MAX_BLACKLIST_NUM) {
 		return command_fail(cmd, JSONRPC2_INVALID_PARAMS, "Cannot blacklist beyond %u", MAX_BLACKLIST_NUM);
 	}
 
@@ -672,7 +676,10 @@ static struct command_result *json_blacklistrune(struct command *cmd,
 	}
 
 	/* Include end */
-	bitmap_fill_range(cmd->ld->runes->blist_bitmap, *start, (*end)+1);
+	if (*relist)
+		bitmap_zero_range(cmd->ld->runes->blist_bitmap, *start, (*end)+1);
+	else
+		bitmap_fill_range(cmd->ld->runes->blist_bitmap, *start, (*end)+1);
 
 	/* Convert to list once, use for db and for list_blacklist */
 	blist = bitmap_to_blacklist(cmd, cmd->ld->runes->blist_bitmap, MAX_BLACKLIST_NUM);

contrib/msggen/msggen/schema.json

@@ -795,6 +795,8 @@ def generate_runes_examples(l1, l2, l3):
         update_example(node=l2, method='blacklistrune', params={'start': 1})
         update_example(node=l2, method='blacklistrune', params={'start': 0, 'end': 2})
         update_example(node=l2, method='blacklistrune', params={'start': 3, 'end': 4})
+        update_example(node=l2, method='blacklistrune', params={'start': 3, 'relist': True},
+                       description=['This undoes the blacklisting of rune 3 only'])
 
         # Commando runes
         rune_l11 = update_example(node=l1, method='commando-rune', params={}, description=['This creates a fresh rune which can do anything:'])

contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py

@@ -409,6 +409,39 @@ def test_blacklistrune(node_factory):
     blacklisted_rune = l1.rpc.showrunes(rune='geZmO6U7yqpHn-moaX93FVMVWrDRfSNY4AXx9ypLcqg9MQ==')['runes'][0]['blacklisted']
     assert blacklisted_rune is True
 
+    # Sigh.  Someone blacklisted too much, so we added this!
+    blacklist = l1.rpc.blacklistrune(start=10, relist=True)
+    assert blacklist == {'blacklist': [{'start': 0, 'end': 6},
+                                       {'start': 9, 'end': 9}]}
+
+    with pytest.raises(RpcError, match='Cannot blacklist beyond'):
+        l1.rpc.blacklistrune(start=100_000_000, relist=True)
+
+    blacklist = l1.rpc.blacklistrune(start=9, end=9, relist=True)
+    assert blacklist == {'blacklist': [{'start': 0, 'end': 6}]}
+
+    blacklist = l1.rpc.blacklistrune(start=1, end=2, relist=True)
+    assert blacklist == {'blacklist': [{'start': 0, 'end': 0},
+                                       {'start': 3, 'end': 6}]}
+
+    blacklist = l1.rpc.blacklistrune(start=4, relist=True)
+    assert blacklist == {'blacklist': [{'start': 0, 'end': 0},
+                                       {'start': 3, 'end': 3},
+                                       {'start': 5, 'end': 6}]}
+
+    blacklist = l1.rpc.blacklistrune(start=0, end=3, relist=True)
+    assert blacklist == {'blacklist': [{'start': 5, 'end': 6}]}
+
+    # Database should be persistent
+    l1.restart()
+
+    blacklist = l1.rpc.blacklistrune()
+    assert blacklist == {'blacklist': [{'start': 5, 'end': 6}]}
+
+    # Last deletion.
+    blacklist = l1.rpc.blacklistrune(start=0, end=99_999_999, relist=True)
+    assert blacklist == {'blacklist': []}
+
 
 def test_badrune(node_factory):
     """Test invalid UTF-8 encodings in rune: used to make us kill the offers plugin which implements decode, as it gave bad utf8!"""