core-lightning/doc/lightning-blacklistrune.7.md
Rusty Russell d492c74e3d docs: document all the rune commands which look like the now-deprecated commando ones.
Rune functionality moved into core from commando plugin.

Changelog-Added: JSON-RPC: `checkrune`: check rune validity for authorization; `createrune` to create/modify rune; `listrunes` to list existing runes; `blacklistrune` to revoke permission of rune

Changelog-Deprecated: JSON-RPC: `commando-rune`, `commando-listrunes` and `commando-blacklist`.

No-schema-diff-check
2023-07-21 16:44:22 +09:30

1.5 KiB

lightning-blacklistrune -- Command to prevent a rune from working

SYNOPSIS

blacklistrune [start [end]]

DESCRIPTION

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.

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.

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-listrunes(7)

RESOURCES

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