showrunes

showrunes -- Command to list previously generated runes

SYNOPSIS

showrunes [rune]

DESCRIPTION

Command added in v23.08.

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.

rune (string, optional): If specified, only details of that rune will be returned.

RETURN VALUE

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) (always false): This is false if the rune does not appear in our datastore (only possible when rune is specified).
blacklisted (boolean, optional) (always true): The rune has been blacklisted; see commando-blacklist(7).
last_used (number, optional): The last time this rune was successfully used. (added v23.11)
our_rune (boolean, optional) (always false): This is not a rune for this node (only possible when rune is specified).

AUTHOR

Shahana Farooqui [email protected] is mainly responsible.

SEE ALSO

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

RESOURCES

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

EXAMPLES

Example 1:

Request:

lightning-cli showrunes -k "rune"="7cKJyALVY0_LLVV-AB9oetXjipOdyt0EhOuYrSS42fM9MA=="

{
  "id": "example:showrunes#1",
  "method": "showrunes",
  "params": {
    "rune": "7cKJyALVY0_LLVV-AB9oetXjipOdyt0EhOuYrSS42fM9MA=="
  }
}

Response:

{
  "runes": [
    {
      "rune": "7cKJyALVY0_LLVV-AB9oetXjipOdyt0EhOuYrSS42fM9MA==",
      "last_used": 1738000000.0,
      "unique_id": "0",
      "restrictions": [],
      "restrictions_as_english": ""
    }
  ]
}

Example 2:

Request:

lightning-cli showrunes

{
  "id": "example:showrunes#2",
  "method": "showrunes",
  "params": {}
}

Response:

{
  "runes": [
    {
      "rune": "7cKJyALVY0_LLVV-AB9oetXjipOdyt0EhOuYrSS42fM9MA==",
      "last_used": 1738000000.0,
      "unique_id": "0",
      "restrictions": [],
      "restrictions_as_english": ""
    },
    {
      "rune": "UcVH186Z5ldtHgscIaNAZ_fdUstCR6OCwiVV7CPx_q09MSZpZF4wMzgxOTRiNWYzMmJkZjBhYTU5OCZtZXRob2Q9bGlzdHBlZXJz",
      "last_used": 1738000000.0,
      "unique_id": "1",
      "restrictions": [
        {
          "alternatives": [
            {
              "fieldname": "id",
              "value": "038194b5f32bdf0aa598",
              "condition": "^",
              "english": "id starts with 038194b5f32bdf0aa598"
            }
          ],
          "english": "id starts with 038194b5f32bdf0aa598"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "listpeers",
              "condition": "=",
              "english": "method equal to listpeers"
            }
          ],
          "english": "method equal to listpeers"
        }
      ],
      "restrictions_as_english": "id starts with 038194b5f32bdf0aa598 AND method equal to listpeers"
    },
    {
      "rune": "a0noy2CAu8-s2xSgJuBW09hqB_YsqLkwIDy5qkftGMk9MiZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==",
      "last_used": 1738000000.0,
      "unique_id": "2",
      "restrictions": [
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "pay",
              "condition": "=",
              "english": "method equal to pay"
            }
          ],
          "english": "method equal to pay"
        },
        {
          "alternatives": [
            {
              "fieldname": "pnameamountmsat",
              "value": "10000",
              "condition": "<",
              "english": "pnameamountmsat < 10000"
            }
          ],
          "english": "pnameamountmsat < 10000"
        }
      ],
      "restrictions_as_english": "method equal to pay AND pnameamountmsat < 10000"
    },
    {
      "rune": "Gkeu3QUOzaVotP3UPksvbE-vRHOrFkaA99tDLo6u7vo9MyZpZD0wMzgxOTRiNWYzMmJkZjBhYTU5ODEyYzg2YzRlZjdhZDJmMjk0MTA0ZmEwMjdkMWFjZTliNDY5YmI2Zjg4Y2YzN2ImbWV0aG9kPWxpc3RwZWVycyZwbnVtPTEmcG5hbWVpZD0wMzgxOTRiNWYzMmJkZjBhYTU5ODEyYzg2YzRlZjdhZDJmMjk0MTA0ZmEwMjdkMWFjZTliNDY5YmI2Zjg4Y2YzN2J8cGFycjA9MDM4MTk0YjVmMzJiZGYwYWE1OTgxMmM4NmM0ZWY3YWQyZjI5NDEwNGZhMDI3ZDFhY2U5YjQ2OWJiNmY4OGNmMzdi",
      "unique_id": "3",
      "restrictions": [
        {
          "alternatives": [
            {
              "fieldname": "id",
              "value": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
              "condition": "=",
              "english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
            }
          ],
          "english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "listpeers",
              "condition": "=",
              "english": "method equal to listpeers"
            }
          ],
          "english": "method equal to listpeers"
        },
        {
          "alternatives": [
            {
              "fieldname": "pnum",
              "value": "1",
              "condition": "=",
              "english": "pnum equal to 1"
            }
          ],
          "english": "pnum equal to 1"
        },
        {
          "alternatives": [
            {
              "fieldname": "pnameid",
              "value": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
              "condition": "=",
              "english": "pnameid equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
            },
            {
              "fieldname": "parr0",
              "value": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
              "condition": "=",
              "english": "parr0 equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
            }
          ],
          "english": "pnameid equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b OR parr0 equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
        }
      ],
      "restrictions_as_english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b AND method equal to listpeers AND pnum equal to 1 AND pnameid equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b OR parr0 equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
    },
    {
      "rune": "zdBiT-O_Qs5EF2TtHqOUXn53aAB-CHEU28pWli3Odl89NCZpZD0wMzgxOTRiNWYzMmJkZjBhYTU5ODEyYzg2YzRlZjdhZDJmMjk0MTA0ZmEwMjdkMWFjZTliNDY5YmI2Zjg4Y2YzN2ImbWV0aG9kPWxpc3RwZWVycyZwbnVtPTEmcG5hbWVpZF4wMzgxOTRiNWYzMmJkZjBhYTU5OHxwYXJyMF4wMzgxOTRiNWYzMmJkZjBhYTU5OA==",
      "unique_id": "4",
      "restrictions": [
        {
          "alternatives": [
            {
              "fieldname": "id",
              "value": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
              "condition": "=",
              "english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
            }
          ],
          "english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "listpeers",
              "condition": "=",
              "english": "method equal to listpeers"
            }
          ],
          "english": "method equal to listpeers"
        },
        {
          "alternatives": [
            {
              "fieldname": "pnum",
              "value": "1",
              "condition": "=",
              "english": "pnum equal to 1"
            }
          ],
          "english": "pnum equal to 1"
        },
        {
          "alternatives": [
            {
              "fieldname": "pnameid",
              "value": "038194b5f32bdf0aa598",
              "condition": "^",
              "english": "pnameid starts with 038194b5f32bdf0aa598"
            },
            {
              "fieldname": "parr0",
              "value": "038194b5f32bdf0aa598",
              "condition": "^",
              "english": "parr0 starts with 038194b5f32bdf0aa598"
            }
          ],
          "english": "pnameid starts with 038194b5f32bdf0aa598 OR parr0 starts with 038194b5f32bdf0aa598"
        }
      ],
      "restrictions_as_english": "id equal to 038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b AND method equal to listpeers AND pnum equal to 1 AND pnameid starts with 038194b5f32bdf0aa598 OR parr0 starts with 038194b5f32bdf0aa598"
    },
    {
      "rune": "s9ADu3o6N8KvZLDJ6dnsSnaXKUtlr0_fDEzbI6TYCsw9NSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5fG1ldGhvZD1wYXl8bWV0aG9kPXhwYXkmbWV0aG9kL2xpc3RkYXRhc3RvcmUmbWV0aG9kL3BheXxwZXI9MWRheSZtZXRob2QvcGF5fHBuYW1lYW1vdW50X21zYXQ8MTAwMDAwMDAxJm1ldGhvZC94cGF5fHBlcj0xZGF5Jm1ldGhvZC94cGF5fHBuYW1lYW1vdW50X21zYXQ8MTAwMDAwMDAx",
      "unique_id": "5",
      "restrictions": [
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "list",
              "condition": "^",
              "english": "method starts with list"
            },
            {
              "fieldname": "method",
              "value": "get",
              "condition": "^",
              "english": "method starts with get"
            },
            {
              "fieldname": "method",
              "value": "summary",
              "condition": "=",
              "english": "method equal to summary"
            },
            {
              "fieldname": "method",
              "value": "pay",
              "condition": "=",
              "english": "method equal to pay"
            },
            {
              "fieldname": "method",
              "value": "xpay",
              "condition": "=",
              "english": "method equal to xpay"
            }
          ],
          "english": "method starts with list OR method starts with get OR method equal to summary OR method equal to pay OR method equal to xpay"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "listdatastore",
              "condition": "/",
              "english": "method unequal to listdatastore"
            }
          ],
          "english": "method unequal to listdatastore"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "pay",
              "condition": "/",
              "english": "method unequal to pay"
            },
            {
              "fieldname": "per",
              "value": "1day",
              "condition": "=",
              "english": "per equal to 1day"
            }
          ],
          "english": "method unequal to pay OR per equal to 1day"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "pay",
              "condition": "/",
              "english": "method unequal to pay"
            },
            {
              "fieldname": "pnameamount_msat",
              "value": "100000001",
              "condition": "<",
              "english": "pnameamount_msat < 100000001"
            }
          ],
          "english": "method unequal to pay OR pnameamount_msat < 100000001"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "xpay",
              "condition": "/",
              "english": "method unequal to xpay"
            },
            {
              "fieldname": "per",
              "value": "1day",
              "condition": "=",
              "english": "per equal to 1day"
            }
          ],
          "english": "method unequal to xpay OR per equal to 1day"
        },
        {
          "alternatives": [
            {
              "fieldname": "method",
              "value": "xpay",
              "condition": "/",
              "english": "method unequal to xpay"
            },
            {
              "fieldname": "pnameamount_msat",
              "value": "100000001",
              "condition": "<",
              "english": "pnameamount_msat < 100000001"
            }
          ],
          "english": "method unequal to xpay OR pnameamount_msat < 100000001"
        }
      ],
      "restrictions_as_english": "method starts with list OR method starts with get OR method equal to summary OR method equal to pay OR method equal to xpay AND method unequal to listdatastore AND method unequal to pay OR per equal to 1day AND method unequal to pay OR pnameamount_msat < 100000001 AND method unequal to xpay OR per equal to 1day AND method unequal to xpay OR pnameamount_msat < 100000001"
    }
  ]
}