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
151a431628
core-lightning/doc/lightning-check.7.md
Rusty Russell 3b622f06c3 lightningd: use param_check on all commands which do extra checks. 
This makes `check` much more thorough, and useful.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: JSON-RPC: `check` now does much more checking on every command (not just basic parameter types).
2023-10-26 12:59:55 +10:30

1.3 KiB
Raw Blame History

lightning-check -- Command for verifying parameters

SYNOPSIS

check command_to_check [parameters]

DESCRIPTION

The check RPC command verifies another command without actually making any changes.

The command_to_check is the name of the relevant command.

parameters is the command's parameters.

This is guaranteed to be safe, and will do all checks up to the point where something in the system would need to be altered (such as checking that channels are in the right state, peers connected, etc).

It does not guarantee successful execution of the command in all cases. For example, a call to lightning-getroute(7) may still fail to find a route even if checking the parameters succeeds.

RETURN VALUE

On success, an object is returned, containing:

  • command_to_check (string): the command_to_check argument

AUTHOR

Mark Beckwith <wythe@intrig.com> and Rusty Russell <rusty@rustcorp.com.au> are mainly responsible.

RESOURCES

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