mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
c02a278669
core-lightning/doc/lightning-checkrune.7.md
Rusty Russell dadbdf488c 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-26 10:30:22 +10: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:72ed36d7c47cf43b39c149da7d251c8bd40531b59591a50c4745f5d7aef5854e)