vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-blacklistrune.7.md

45 lines
1.6 KiB
Markdown
Raw Normal View History

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 02:25:45 +01:00
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.
runes: create and blacklist commands aliases - Added `invokerune` alias for `createrune` - Added `destroyrune` alias for `blacklistrune`
2023-07-25 01:03:28 +01:00
Destroy a rune like in olden times with the **destroyrune** command.
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 02:25:45 +01:00
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
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
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
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
------
Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible.
SEE ALSO
--------
runes: Renamed `listrunes` to `showrunes`
2023-07-25 01:03:33 +01:00
lightning-commando-blacklist(7), lightning-showrunes(7)
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 02:25:45 +01:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 00:28:53 +00:00
[comment]: # ( SHA256STAMP:7f9e7ab72e0e8d6e7cc59c560a274ffcfd5d257c73e37866d05ffa74d587fb3f)