mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00

Rusty Russell 3a49320dd1 doc: language tidyups and a few minor refinements.

Some additional detail was warranted in several places, though the
listconfigs is better off simply referring to lightningd-config.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Fixed: doc: Many missing manual pages were completed

2020-09-08 14:55:29 +09:30

1.3 KiB

Raw Blame History

lightning-ping -- Command to check if a node is up.

SYNOPSIS

ping id [len] [pongbytes]

DESCRIPTION

The ping command checks if the node with id is ready to talk. It accepts the following parameters:

id: A string that represents the node id;
len: A integer that represents the length of the ping (default 128);
pongbytes: An integer that represents the length of the reply (default 128).

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "ping",
  "params": {
    "len": 128,
    "pongbytes": 128
  }
}

RETURN VALUE

On success, the command will return an object with a single string.

totlen: A string that represents the answer length of the reply message (including header)

On failure, one of the following error codes may be returned:

-32602: Error in given parameters or unknown peer.

EXAMPLE JSON RESPONSE

{
   "totlen": 132
}

AUTHOR

Vincenzo Palazzo <vincenzo.palazzo@protonmail.com> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command.

RESOURCES

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

1.3 KiB Raw Blame History