Browse Source

Start ping command and fix some convention in other new doc file

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
bump-pyln-proto
Vincenzo Palazzo 5 years ago
committed by Rusty Russell
parent
commit
1a1b2f3d34
  1. 8
      doc/Makefile
  2. 1
      doc/index.rst
  3. 8
      doc/lightning-listnodes.7.md
  4. 8
      doc/lightning-listtransactions.7.md
  5. 0
      doc/lightning-ping.7
  6. 64
      doc/lightning-ping.7.md
  7. 6
      doc/lightning-sendpsbt.7.md
  8. 6
      doc/lightning-signpsbt.7.md

8
doc/Makefile

@ -53,7 +53,13 @@ MANPAGES := doc/lightning-cli.1 \
doc/lightning-waitanyinvoice.7 \ doc/lightning-waitanyinvoice.7 \
doc/lightning-waitblockheight.7 \ doc/lightning-waitblockheight.7 \
doc/lightning-waitsendpay.7 \ doc/lightning-waitsendpay.7 \
doc/lightning-withdraw.7 doc/lightning-withdraw.7 \
doc/lightning-ping.7 \
doc/lihgtning-signpsbt.7 \
doc/lightning-sendpsbt.7 \
doc/lightning-getinfo.7 \
doc/lightning-listtransactions.7 \
doc/lightning-listnodes.7
doc-all: $(MANPAGES) doc/index.rst doc-all: $(MANPAGES) doc/index.rst

1
doc/index.rst

@ -46,6 +46,7 @@ c-lightning Documentation
lightning-fundchannel_complete <lightning-fundchannel_complete.7.md> lightning-fundchannel_complete <lightning-fundchannel_complete.7.md>
lightning-fundchannel_start <lightning-fundchannel_start.7.md> lightning-fundchannel_start <lightning-fundchannel_start.7.md>
lightning-fundpsbt <lightning-fundpsbt.7.md> lightning-fundpsbt <lightning-fundpsbt.7.md>
lightning-getinfo <lightning-getinfo.7.md>
lightning-getroute <lightning-getroute.7.md> lightning-getroute <lightning-getroute.7.md>
lightning-getsharedsecret <lightning-getsharedsecret.7.md> lightning-getsharedsecret <lightning-getsharedsecret.7.md>
lightning-hsmtool <lightning-hsmtool.8.md> lightning-hsmtool <lightning-hsmtool.8.md>

8
doc/lightning-listnodes.7.md

@ -1,4 +1,4 @@
lightning-listnodes -- Command to get the list of nodes in the own node network lightning-listnodes -- Command to get the list of nodes in the own node network.
============================================================ ============================================================
SYNOPSIS SYNOPSIS
@ -32,9 +32,9 @@ On success, the command will return a list of nodes, each object represents a no
- *alias*: A string that rappresents alias of the node on the network. - *alias*: A string that rappresents alias of the node on the network.
- *color*: A string that rappresents the personal color of the node. - *color*: A string that rappresents the personal color of the node.
- *last_timestamp*: An integer that rappresent the last timestamp. - *last_timestamp*: An integer that rappresent the last timestamp.
- *features*: An string that rappresent the features value. - *features*: A string that rappresent the features value.
- *addresses*: An array that rappresent the addreses avaible, each address is rappresented with an object with the following properties: - *addresses*: An array that rappresent the addreses avaible. Each address is rappresented with an object with the following properties:
- *type*: A string that rappresent the type of address (ipv4 or ipv6). - *type*: A string that rappresent the address type (ipv4 or ipv6).
- *address*: A string that rappresent the address value. - *address*: A string that rappresent the address value.
- *port*: An integer that rappresent the port number where the node are listening. - *port*: An integer that rappresent the port number where the node are listening.

8
doc/lightning-listtransactions.7.md

@ -1,4 +1,4 @@
lightning-listtransactions -- Command to get the list of transactions that was stored in the wallet lightning-listtransactions -- Command to get the list of transactions that was stored in the wallet.
============================================================ ============================================================
SYNOPSIS SYNOPSIS
@ -37,9 +37,9 @@ On success, the command will return a list of transactions, each object represen
- *index*: An integer that rappresent the index of transaction. - *index*: An integer that rappresent the index of transaction.
- *sequence*: An integer that rappresent the sequence number. - *sequence*: An integer that rappresent the sequence number.
- *outputs*: A list of transactions, each transaction is rappresented with an object with the following proprieties: - *outputs*: A list of transactions, each transaction is rappresented with an object with the following proprieties:
- *index*: An integer that rappresent the index of transaction. This is the output index of the transaction output. - *index*: An integer that rappresent the index of transaction.
- *satoshis*: A string that rappresent the amount in millisatoshi that contains the transaction. - *satoshis*: A string that rappresent the amount in millisatoshi.
- *scriptPubKey*: A string that contains the lock script in hexadecimal dump form.. - *scriptPubKey*: A string that contains the lock script in hexadecimal dump form.
On failure, one of the following error codes may be returned: On failure, one of the following error codes may be returned:
-32602. Error in given parameters. -32602. Error in given parameters.

0
doc/lightning-ping.7

64
doc/lightning-ping.7.md

@ -0,0 +1,64 @@
lightning-ping -- Command to check if a node is up.
============================================================
SYNOPSIS
--------
**ping** *id* \[len\] \[pongbytes\]
DESCRIPTION
-----------
The **ping** command check if the node with id is ready to talk. It accept the following parameter:
- *id*: A string that rappresent the node id;
- *len*: A integer that rappresent the lenght of {...}, by default is 128;
- *pongbytes*: An integer that rappresent the lenght of {}, by default is 128.
EXAMPLE JSON REQUEST
------------
```json
{
"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 rappresent the answer lenght of {}.
On failure, one of the following error codes may be returned:
-32602. Error in given parameters or unknow peer.
EXAMPLE JSON RESPONSE
-----
```json
{
"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.
SEE ALSO
--------
lightning-connect(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>

6
doc/lightning-sendpsbt.7.md

@ -4,14 +4,14 @@ lightning-sendpsbt -- Command to finalize, extract and send a partially signed b
SYNOPSIS SYNOPSIS
-------- --------
**sendpsbt** \[psbt\] **sendpsbt** psbt
DESCRIPTION DESCRIPTION
----------- -----------
The **sendpsbt** is a low-level RPC command which sent a PSBT. The **sendpsbt** is a low-level RPC command which sent a PSBT.
- *psbt*: A string that rappresent the hexadecimal of the psbt. It is required to run the **sendpsbt** command. The called can build a psbt with a the command *fundpsbt* - *psbt*: A string that rappresent the hexadecimal of the psbt. It is required to run the **sendpsbt** command. The caller can build a psbt with command *fundpsbt*.
EXAMPLE JSON REQUEST EXAMPLE JSON REQUEST
------------ ------------
@ -28,7 +28,7 @@ EXAMPLE JSON REQUEST
RETURN VALUE RETURN VALUE
------------ ------------
On success, the tx and txid of the transaction is returned, as well as the channel_id of the newly created channel. On success, the tx and txid of the transaction are returned, as well as the channel_id of the newly created channel.
- *txid*: A string that rappresent the hash of transaction which the caller can use to find it on the blockchain. - *txid*: A string that rappresent the hash of transaction which the caller can use to find it on the blockchain.
- *tx*: A string that rappresent the hexadecimal dump of the transaction. - *tx*: A string that rappresent the hexadecimal dump of the transaction.

6
doc/lightning-signpsbt.7.md

@ -4,7 +4,7 @@ lightning-signpsbt -- Command to sign a wallet's inputs on a provided bitcoin tr
SYNOPSIS SYNOPSIS
-------- --------
**signpsbt** \[psbt\] **signpsbt** *psbt*
DESCRIPTION DESCRIPTION
----------- -----------
@ -28,13 +28,13 @@ EXAMPLE JSON REQUEST
RETURN VALUE RETURN VALUE
------------ ------------
On success, a object will be return with a string that rappresent the hexadecimal value of psbt. On success, a object will be return with a string.
- *psbt*: A string that rappresent the hexadecimal dump of the psbt. - *psbt*: A string that rappresent the hexadecimal dump of the psbt.
On failure, one of the following error codes may be returned: On failure, one of the following error codes may be returned:
- -32602. Error in given parameters or there isn't wallet inputs to sign. - -32602. Error in given parameters or there aren't wallet's inputs to sign.
EXAMPLE JSON RESPONSE EXAMPLE JSON RESPONSE
----- -----

Loading…
Cancel
Save