blacklistrune

blacklistrune -- Command to prevent a rune from working

SYNOPSIS

blacklistrune [start [end]] [relist]

DESCRIPTION

Command added in v23.08.

The blacklistrune RPC command allows you to effectively revoke the rune you have created (and any runes derived from that rune with additional restictions). Attempting to use these runes will be resulted in a Blacklisted rune error message.

Destroy a rune like in olden times with the destroyrune command.

All runes created by lightning have a unique sequential id within them and 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 start specified without end, that single rune is blacklisted. If end is also specified, every rune from start till end inclusive is blacklisted.

  • 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) (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 <[email protected]> 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
    }
  ]
}

Core Lightning is Blockstream's open-source implementation of the Lightning Network optimised for performance. It is highly customizable through modular expandability.

© 2023 Core Lightning
All rights reserved.

X Twitter Logo Streamline Icon: https://streamlinehq.com

X

The official Core Lightning X(Twitter) handle to follow project updates and announcements.

Github Logo 2 Streamline Icon: https://streamlinehq.com

Github

Github repository for source code, issues, and contributions. Visit our project here to explore or contibute.

Telegram

Community-driven telegram group where most of the node operators hang out. Go to https://t.me/lightningd to join.

Discord

Community-driven discord server where the devs flock together. Go to https://discord.gg/V6ay9yNhBQ to join.