rgb-cln/doc/lightning-showrunes.7.md

lightning-showrunes -- Command to list previously generated runes
==================================================================

SYNOPSIS
--------

**showrunes** [*rune*]

DESCRIPTION
-----------

The **showrunes** RPC command either lists runes that we stored as we generate them (see lightning-createrune(7)) or decodes the rune given on the command line. 

RETURN VALUE
------------

[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **runes** is returned.  It is an array of objects, where each object contains:

- **rune** (string): Base64 encoded rune
- **unique\_id** (string): Unique id assigned when the rune was generated; this is always a u64 for commando runes
- **restrictions** (array of objects): The restrictions on what commands this rune can authorize:
  - **alternatives** (array of objects):
    - **fieldname** (string): The field this restriction applies to; see commando-rune(7)
    - **value** (string): The value accepted for this field
    - **condition** (string): The way to compare fieldname and value
    - **english** (string): English readable description of this alternative
  - **english** (string): English readable summary of alternatives above
- **restrictions\_as\_english** (string): English readable description of the restrictions array above
- **stored** (boolean, optional): This is false if the rune does not appear in our datastore (only possible when `rune` is specified) (always *false*)
- **blacklisted** (boolean, optional): The rune has been blacklisted; see commando-blacklist(7) (always *true*)
- **last\_used** (number, optional): The last time this rune was successfully used *(added 23.11)*
- **our\_rune** (boolean, optional): This is not a rune for this node (only possible when `rune` is specified) (always *false*)

[comment]: # (GENERATE-FROM-SCHEMA-END)

AUTHOR
------

Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible.

SEE ALSO
--------

lightning-commando-showrunes(7), lightning-blacklistrune(7)

RESOURCES
---------

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

[comment]: # ( SHA256STAMP:900e91777cd1e181c87a78913ab6f914585fcd99cd0dba16da19a81159f98aea)
runes: Renamed `listrunes` to `showrunes` 2023-07-25 01:03:33 +01:00			`lightning-showrunes -- Command to list previously generated runes`
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			`==================================================================`

			`SYNOPSIS`
			`--------`

runes: Renamed `listrunes` to `showrunes` 2023-07-25 01:03:33 +01:00			`showrunes [rune]`
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
			`DESCRIPTION`
			`-----------`

runes: Renamed `listrunes` to `showrunes` 2023-07-25 01:03:33 +01:00			`The showrunes RPC command either lists runes that we stored as we generate them (see lightning-createrune(7)) or decodes the rune given on the command line.`
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
			`RETURN VALUE`
			`------------`

			`[comment]: # (GENERATE-FROM-SCHEMA-START)`
			`On success, an object containing runes is returned. It is an array of objects, where each object contains:`

			`- rune (string): Base64 encoded rune`
			`- unique\_id (string): Unique id assigned when the rune was generated; this is always a u64 for commando runes`
			`- restrictions (array of objects): The restrictions on what commands this rune can authorize:`
			`- alternatives (array of objects):`
			`- fieldname (string): The field this restriction applies to; see commando-rune(7)`
			`- value (string): The value accepted for this field`
			`- condition (string): The way to compare fieldname and value`
			`- english (string): English readable description of this alternative`
			`- english (string): English readable summary of alternatives above`
			`- restrictions\_as\_english (string): English readable description of the restrictions array above`
			- stored (boolean, optional): This is false if the rune does not appear in our datastore (only possible when `rune` is specified) (always false)
			`- blacklisted (boolean, optional): The rune has been blacklisted; see commando-blacklist(7) (always true)`
lightning/runes: added last_used in showrunes Changelog-Added: JSON-RPC: `showrunes` new field `last_used` 2023-09-14 03:40:41 +01:00			`- last\_used (number, optional): The last time this rune was successfully used (added 23.11)`
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			- our\_rune (boolean, optional): This is not a rune for this node (only possible when `rune` is specified) (always false)

			`[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-showrunes(7), lightning-blacklistrune(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>`

lightning/runes: added last_used in showrunes Changelog-Added: JSON-RPC: `showrunes` new field `last_used` 2023-09-14 03:40:41 +01:00			`[comment]: # ( SHA256STAMP:900e91777cd1e181c87a78913ab6f914585fcd99cd0dba16da19a81159f98aea)`