mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
4e39dc0c9b
core-lightning/doc/lightning-checkrune.7.md
Rusty Russell bb38f83b88 checkrune: make nodeid and method optional. 
nodeid is only useful when we know the peer we're talking to (e.g. commando).

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
No-schema-diff-check: We're simply making optional, not deprecating!
2023-09-12 15:19:02 +09:30

1.3 KiB
Raw Blame History

lightning-checkrune -- Command to Validate Rune

SYNOPSIS

checkrune rune [nodeid] [method] [params]

DESCRIPTION

The checkrune RPC command checks the validity/authorization rights of specified rune for the given nodeid, method, and params.

If successful, the rune "usage" counter (used for ratelimiting) is incremented.

See lightning-createrune(7) for the fields in the rune which are checked.

RETURN VALUE

On success, an object is returned, containing:

  • valid (boolean): true if the rune is valid

The following error codes may occur:

  • RUNE_NOT_AUTHORIZED (1501): rune is not for this node (or perhaps completely invalid)
  • RUNE_NOT_PERMITTED (1502): rune does not allow this usage (includes a detailed reason why)
  • RUNE_BLACKLISTED (1503): rune has been explicitly blacklisted.

AUTHOR

Shahana Farooqui <sfarooqui@blockstream.com> is mainly responsible for consolidating logic from commando.

SEE ALSO

lightning-createrune(7), lightning-blacklistrune(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning comment: # ( SHA256STAMP:977acf366f8fde1411f2c78d072b34b38b456e95381a6bce8fe6855a2d91434a)