LIGHTNING-BLACKLISTRUNE(7)

🎀 NAME 🎀

okay so this is the page for LIGHTNING-BLACKLISTRUNE(7), and it's literally about the blacklistrune command — the one that prevents a rune from working. yes bestie, we're doing rune revocation today 💅

✨ SYNOPSIS ✨

blacklistrune [start [end]] [relist]

🦋 DESCRIPTION 🦋

Command added in v23.08. slay.

The blacklistrune RPC command lets you effectively revoke the rune you created — and any runes derived from that rune with additional restrictions. If you try to use one of those blacklisted runes, you get a Blacklisted rune error message. periodt.

destroyrune is an alias for blacklistrune: it does exactly the same thing. Rune restrictions treat it as blacklistrune, so method/blacklistrune also forbids destroyrune. iykyk.

All runes created by lightning have a unique sequential id within them, and they can be blacklisted in ranges for efficiency. The command always returns the blacklisted ranges on success. If no parameters are specified, no changes have been made. If you give start without end, that single rune is blacklisted. If end is also specified, every rune from start till end inclusive is blacklisted.

The blacklist is stored in the database, but runes are checked with the hsm_secret. If you restore an older database, runes you blacklisted after that backup work again, so blacklist them again. Runes created after that backup are only added to showrunes when they are first used.

ok this part is important bestie: backup + hsm_secret behavior is real, don't skip it 🙈

• start (u64, optional) — first rune unique id to blacklist.
• end (u64, optional) — final rune unique id to blacklist (defaults to start).
• relist (boolean, optional) — undo the blacklisting (if any) of every rune in range start to end (inclusive). When called with a rune (via commando or clnrest), only a rune without restrictions can do this (added v25.02).

🌈 RETURN VALUE 🌈

On success, an object containing blacklist is returned. It is an array of objects, where each object contains:

• start (u64) — unique id of first rune in this blacklist range.
• end (u64) — unique id of last rune in this blacklist range.

👑 AUTHOR 👑

Shahana Farooqui sfarooqui@blockstream.com is mainly responsible.

💖 SEE ALSO 💖

• lightning-commando-blacklist(7)
• lightning-showrunes(7)

⭐ RESOURCES ⭐

Main web site: https://github.com/ElementsProject/lightning

🧚 EXAMPLES 🧚

Example 1

Request:

$ lightning-cli blacklistrune -k "start"=1

{
  "id": "example:blacklistrune#1",
  "method": "blacklistrune",
  "params": {
    "start": 1
  }
}

Response:

{
  "blacklist": [
    {
      "start": 1,
      "end": 1
    }
  ]
}

Example 2

Request:

$ lightning-cli blacklistrune -k "start"=0 "end"=2

{
  "id": "example:blacklistrune#2",
  "method": "blacklistrune",
  "params": {
    "start": 0,
    "end": 2
  }
}

Response:

{
  "blacklist": [
    {
      "start": 0,
      "end": 2
    }
  ]
}

Example 3

Request:

$ lightning-cli blacklistrune -k "start"=3 "end"=4

{
  "id": "example:blacklistrune#3",
  "method": "blacklistrune",
  "params": {
    "start": 3,
    "end": 4
  }
}

Response:

{
  "blacklist": [
    {
      "start": 0,
      "end": 4
    }
  ]
}

Example 4: This undoes the blacklisting of rune 3 only

Request:

$ lightning-cli blacklistrune -k "start"=3 "relist"=True

{
  "id": "example:blacklistrune#4",
  "method": "blacklistrune",
  "params": {
    "start": 3,
    "relist": true
  }
}

Response:

{
  "blacklist": [
    {
      "start": 0,
      "end": 2
    },
    {
      "start": 4,
      "end": 4
    }
  ]
}

---

ok that's the whole page, bestie — footer vibes: Core Lightning v26.06.9 and the manual is LIGHTNING-BLACKLISTRUNE(7) 💖✨