diff --git a/doc/lightning-getinfo.7 b/doc/lightning-getinfo.7 index 5d1bb242f748..c126082a7208 100644 --- a/doc/lightning-getinfo.7 +++ b/doc/lightning-getinfo.7 @@ -26,38 +26,38 @@ On success, an object with the following information is returned: .RS .IP \[bu] -\fIid\fR: A string that represents the public key of the node\. It will represents the node on the public network\. +\fIid\fR: Hex-encoded public key of the node\. It will represents the node on the public network\. .IP \[bu] -\fIalias\fR: A string that represents the alias of the node, by default is calculate from the public key (node id)\. This is just for fun; the name can be anything and is not unique! +\fIalias\fR: User-chosen node name, by default is calculated from the public key (node id)\. This is just for fun; the name can be anything and is not unique! .IP \[bu] -\fIcolor\fR: A string that represents the preferred color of the node\. +\fIcolor\fR: User-chosen node color as a hexadecimal string\. Like the alias, this is just for fun\. .IP \[bu] -\fInum_peers\fR: An integer that represents the number of peer connect to the node\. +\fInum_peers\fR: Number of peer connected\. .IP \[bu] -\fInum_pending_channels\fR: An integer that represents the number of channel which are still awaiting opening confirmation\. +\fInum_pending_channels\fR: Number of channels which are still awaiting opening confirmation\. .IP \[bu] -\fInum_active_channels\fR: A integer that represents the number of channel which are currently open\. +\fInum_active_channels\fR: Number of channels which are currently open\. .IP \[bu] -\fInum_inactive_channels\fR: A integer that represents the number of channel which are closing\. +\fInum_inactive_channels\fR: Number of channels which are closing\. .IP \[bu] -\fIaddress\fR: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:.RS +\fIaddress\fR: An array with the published addresses of the node as objects, each object contains the following properties:.RS .IP \[bu] -\fItype\fR: A string that represents the type of the address (currently \fBipv4\fR, \fBipv6\fR, \fBtorv3\fR or \fBtorv4\fR)\. +\fItype\fR: Address type (\fB"ipv4"\fR, \fB"ipv6"\fR, \fB"torv2"\fR or \fB"torv3"\fR)\. .IP \[bu] -\fIaddress\fR: A string that represents the value of the address\. +\fIaddress\fR: IP or \fB.onion\fR hidden service address as a string\. .IP \[bu] -\fIport\fR: An integer that represents the port where the node is listening with this address\. +\fIport\fR: Port number as an integer\. .RE .IP \[bu] -\fIbinding\fR: An array that represents all addresses where the node is binded\. Each object contains the same object type of the address propriety above\. +\fIbinding\fR: An array with addresses to which the node is bound\. Properties of the objects are the same as above\. .IP \[bu] -\fIversion\fR: A string that represents the version of the node\. +\fIversion\fR: Version of the lightningd software currently running\. .IP \[bu] -\fIblockheight\fR: An integer that represents the blockchain height\. +\fIblockheight\fR: Height of the last Bitcoin block processed by the node\. .IP \[bu] -\fInetwork\fR: A string that represents the type of network on the node are working (e\.g: \fBbitcoin\fR, \fBtestnet\fR, or \fBregtest\fR)\. +\fInetwork\fR: Bitcoin network the node is currently running on (e\.g: \fBbitcoin\fR, \fBtestnet\fR, or \fBregtest\fR)\. .RE @@ -120,4 +120,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:9e6a0e0c25569bfc9d23b07e84392a3f70f6c94a86cd482fbf48c3d668a1796d +\" SHA256STAMP:9168066f50de0a43855d1d257931e800fd5d3cb5d02f3ea995582acd6e3e0818 diff --git a/doc/lightning-getinfo.7.md b/doc/lightning-getinfo.7.md index a5e09b2313a9..6a86a4e23420 100644 --- a/doc/lightning-getinfo.7.md +++ b/doc/lightning-getinfo.7.md @@ -27,21 +27,21 @@ RETURN VALUE On success, an object with the following information is returned: -- *id*: A string that represents the public key of the node. It will represents the node on the public network. -- *alias*: A string that represents the alias of the node, by default is calculate from the public key (node id). This is just for fun; the name can be anything and is not unique! -- *color*: A string that represents the preferred color of the node. -- *num_peers*: An integer that represents the number of peer connect to the node. -- *num_pending_channels*: An integer that represents the number of channel which are still awaiting opening confirmation. -- *num_active_channels*: A integer that represents the number of channel which are currently open. -- *num_inactive_channels*: A integer that represents the number of channel which are closing. -- *address*: An array that represents all published addresses of the node, each object inside the array contains the following proprieties: - - *type*: A string that represents the type of the address (currently `ipv4`, `ipv6`, `torv3` or `torv4`). - - *address*: A string that represents the value of the address. - - *port*: An integer that represents the port where the node is listening with this address. -- *binding*: An array that represents all addresses where the node is binded. Each object contains the same object type of the address propriety above. -- *version*: A string that represents the version of the node. -- *blockheight*: An integer that represents the blockchain height. -- *network*: A string that represents the type of network on the node are working (e.g: `bitcoin`, `testnet`, or `regtest`). +- *id*: Hex-encoded public key of the node. It represents the node on the public network. +- *alias*: User-chosen node name, by default is calculated from the public key (node id). This is just for fun; the name can be anything and is not unique! +- *color*: User-chosen node color as a hexadecimal string. Like the alias, this is just for fun. +- *num_peers*: Number of peer connected. +- *num_pending_channels*: Number of channels which are still awaiting opening confirmation. +- *num_active_channels*: Number of channels which are currently open. +- *num_inactive_channels*: Number of channels which are closing. +- *address*: An array with the published addresses of the node as objects, each object contains the following properties: + - *type*: Address type (`"ipv4"`, `"ipv6"`, `"torv2"` or `"torv3"`). + - *address*: IP or `.onion` hidden service address as a string. + - *port*: Port number as an integer. +- *binding*: An array with addresses to which the node is bound. Properties of the objects are the same as above. +- *version*: Version of the lightningd software currently running. +- *blockheight*: Height of the last Bitcoin block processed by the node. +- *network*: Bitcoin network the node is currently running on (e.g: `bitcoin`, `testnet`, or `regtest`). On failure, one of the following error codes may be returned: diff --git a/doc/lightning-getlog.7 b/doc/lightning-getlog.7 index 003940c85ebf..49317c0d2a63 100644 --- a/doc/lightning-getlog.7 +++ b/doc/lightning-getlog.7 @@ -11,7 +11,7 @@ The \fBgetlog\fR the RPC command to show logs, with optional log \fIlevel\fR\. .RS .IP \[bu] -\fIlevel\fR: A string that represents the log level (\fIbroken\fR, \fIunusual\fR, \fIinfo\fR, \fIdebug\fR, or \fIio\fR)\. The default is \fIinfo\fR\. +\fIlevel\fR: Desired log level (\fIbroken\fR, \fIunusual\fR, \fIinfo\fR, \fIdebug\fR, or \fIio\fR) to filter on\. The default is \fIinfo\fR\. .RE .SH EXAMPLE JSON REQUEST @@ -33,21 +33,21 @@ On success, a object will be return with the following parameters: .RS .IP \[bu] -\fIcreated_at\fR: An floating point value that represents the UNIX timestamp when logging began\. +\fIcreated_at\fR: The UNIX timestamp of when the logging began as a float\. .IP \[bu] -\fIbytes_used\fR: A string that represents the dimension in bytes of the log file\. +\fIbytes_used\fR: Size in bytes of the log file\. .IP \[bu] -\fIbytes_max\fR: An integer that represents the max dimension in bytes of log file\. +\fIbytes_max\fR: Maximum size in bytes of the log file\. .IP \[bu] \fIlog\fR: An array of objects where each element contains the following proprieties:.RS .IP \[bu] -\fItype\fR: A string that represents the log level\. The propriety can have an value equal to SKIPPED to indicate the existence of omitted entries\. +\fItype\fR: The log level of this entry\. This property can have a value equal to \fB"SKIPPED"\fR to indicate the existence of omitted entries\. .IP \[bu] -\fItime\fR: A floating point value that represents the time since \fIcreated_at\fR\. +\fItime\fR: A floating point value that represents the time passed since \fIcreated_at\fR\. .IP \[bu] -\fIsource\fR: A string that represents the source of line\. +\fIsource\fR: The file that emitted this log entry\. .IP \[bu] -\fIlog\fR: A string that represents the content of line\. +\fIlog\fR: The log contents\. .RE @@ -94,4 +94,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:789e23927120d0fefd374592a3c655244fd6c28a122368bdd8da2f3cdde66798 +\" SHA256STAMP:c146790d28774e52ed5350835ad2e2357af4da8724910a7da14ca94da2493b85 diff --git a/doc/lightning-getlog.7.md b/doc/lightning-getlog.7.md index dad81dc0fecb..22d81a17f532 100644 --- a/doc/lightning-getlog.7.md +++ b/doc/lightning-getlog.7.md @@ -11,7 +11,7 @@ DESCRIPTION The **getlog** the RPC command to show logs, with optional log *level*. -- *level*: A string that represents the log level (*broken*, *unusual*, *info*, *debug*, or *io*). The default is *info*. +- *level*: Desired log level (*broken*, *unusual*, *info*, *debug*, or *io*) to filter on. The default is *info*. EXAMPLE JSON REQUEST -------------------- @@ -30,16 +30,16 @@ RETURN VALUE On success, a object will be return with the following parameters: -- *created_at*: An floating point value that represents the UNIX timestamp when logging began. -- *bytes_used*: A string that represents the dimension in bytes of the log file. -- *bytes_max*: An integer that represents the max dimension in bytes of log file. +- *created_at*: The UNIX timestamp of when the logging began as a float. +- *bytes_used*: Size in bytes of the log file. +- *bytes_max*: Maximum size in bytes of the log file. - *log*: An array of objects where each element contains the following proprieties: - - *type*: A string that represents the log level. The propriety can have an value equal to SKIPPED to indicate the existence of omitted entries. - - *time*: A floating point value that represents the time since *created_at*. - - *source*: A string that represents the source of line. - - *log*: A string that represents the content of line. + - *type*: The log level of this entry. This property can have a value equal to `"SKIPPED"` to indicate the existence of omitted entries. + - *time*: A floating point value that represents the time passed since *created_at*. + - *source*: The file that emitted this log entry. + - *log*: The log contents. - *num_skipped*: An integer that it is present only if the log level is equal to SKIPPED. - + On failure, one of the following error codes may be returned: diff --git a/doc/lightning-help.7 b/doc/lightning-help.7 index b7c3bf8ec118..d96e2927a143 100644 --- a/doc/lightning-help.7 +++ b/doc/lightning-help.7 @@ -33,11 +33,11 @@ On success, a object will be return with the following proprieties: .IP \[bu] \fIcommand\fR: A string that represents the stucture of the command\. .IP \[bu] -\fIcategory\fR: A string that represents the category\. +\fIcategory\fR: Command category\. .IP \[bu] -\fIdescription\fR: A string that represents the description\. +\fIdescription\fR: A short description of the command and its basic parameters\. .IP \[bu] -\fIverbose\fR: A string that represents the verbode description\. +\fIverbose\fR: A longer description of what the command does\. .RE @@ -72,4 +72,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:cbd027bd9117d2e71167ab1c9d95a63c90b8e9c556dd75e951d4913a2891cb37 +\" SHA256STAMP:3f90993f540106b04367e0bab9edc803b614b2f1cb236a3564f289c39447d35a diff --git a/doc/lightning-help.7.md b/doc/lightning-help.7.md index 31626b39af05..36477be0ec77 100644 --- a/doc/lightning-help.7.md +++ b/doc/lightning-help.7.md @@ -31,9 +31,9 @@ RETURN VALUE On success, a object will be return with the following proprieties: - *command*: A string that represents the stucture of the command. -- *category*: A string that represents the category. -- *description*: A string that represents the description. -- *verbose*: A string that represents the verbode description. +- *category*: Command category. +- *description*: A short description of the command and its basic parameters. +- *verbose*: A longer description of what the command does. On failure, one of the following error codes may be returned: diff --git a/doc/lightning-listconfigs.7 b/doc/lightning-listconfigs.7 index d54182a7f5f9..aa92e3c02e07 100644 --- a/doc/lightning-listconfigs.7 +++ b/doc/lightning-listconfigs.7 @@ -33,20 +33,20 @@ Additional members include: .RS .IP \[bu] -\fI# version\fR: A string that represents the version of node\. +\fI# version\fR: Version of lightningd software that is currently running\. .IP \[bu] -\fIplugins\fR: A array that represents the non-important plugin registered\. Each object contains the following members:.RS +\fIplugins\fR: A array of the non-important plugin currently running\. Each object contains the following members:.RS .IP \[bu] -\fIpath\fR: A string that represents the path of plugin\. +\fIpath\fR: Path of the plugin executable\. .IP \[bu] -\fIname\fR: A string that represents the name of plugin\. +\fIname\fR: The plugin name\. .IP \[bu] \fIoptions\fR: A object that contains all options accepted from command line or configuration file, if the plugin has opitions .RE .IP \[bu] -\fIimportant-plugins\fR: An array that represents all important plugins registered to the node\. Each object contains the same members as the \fIplugin\fR array\. +\fIimportant-plugins\fR: An array of the important plugins currently running\. Each object contains the same members as the \fIplugin\fR array\. .RE @@ -164,4 +164,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:19542af1d9c13e31ec6fada46f85a080433c2c7a863779a8b9e3ac86a5903b48 +\" SHA256STAMP:731429885d3a8d6cf3b0f8f982ffaf3658a850b238b21727ab0184949488ca9b diff --git a/doc/lightning-listconfigs.7.md b/doc/lightning-listconfigs.7.md index 1f01658f2e32..eebd2817ff6e 100644 --- a/doc/lightning-listconfigs.7.md +++ b/doc/lightning-listconfigs.7.md @@ -33,12 +33,12 @@ the configuration file(s) and command line. Additional members include: -- *# version*: A string that represents the version of node. -- *plugins*: A array that represents the non-important plugin registered. Each object contains the following members: - - *path*: A string that represents the path of plugin. - - *name*: A string that represents the name of plugin. +- *# version*: Version of lightningd software that is currently running. +- *plugins*: A array of the non-important plugin currently running. Each object contains the following members: + - *path*: Path of the plugin executable. + - *name*: The plugin name. - *options*: A object that contains all options accepted from command line or configuration file, if the plugin has opitions -- *important-plugins*: An array that represents all important plugins registered to the node. Each object contains the same members as the *plugin* array. +- *important-plugins*: An array of the important plugins currently running. Each object contains the same members as the *plugin* array. On failure, one of the following error codes may be returned: diff --git a/doc/lightning-listnodes.7 b/doc/lightning-listnodes.7 index 886638a5d8d1..d0ae23cafba5 100644 --- a/doc/lightning-listnodes.7 +++ b/doc/lightning-listnodes.7 @@ -28,7 +28,7 @@ On success, the command will return a list of nodes, each object represents a no .RS .IP \[bu] -\fInodeid\fR: A string that represents the node id\. +\fInodeid\fR: Hex-encoded pubkey of the node\. .RE @@ -37,21 +37,21 @@ are also returned: .RS .IP \[bu] -\fIalias\fR: A string that represents alias of the node on the network\. +\fIalias\fR: The user-chosen node name as a string\. .IP \[bu] -\fIcolor\fR: A string that represents the personal color of the node\. +\fIcolor\fR: The user-chosen node color as a hexadecimal string\. .IP \[bu] -\fIlast_timestamp\fR: An integer that represents the timestamp of the last-received node_announcement message\. +\fIlast_timestamp\fR: The last-received node_announcement message as a UNIX timestamp integer\. .IP \[bu] -\fIfeatures\fR: A string that represents the features value\. +\fIfeatures\fR: Hex-encoded features bitstring\. .IP \[bu] -\fIaddresses\fR: An array that represents the addreses avaible\. Each address is represented with an object with the following properties:.RS +\fIaddresses\fR: An array of the node's public addresses\. Each address is represented by an object with the following properties:.RS .IP \[bu] -\fItype\fR: A string that represents the address type (ipv4 or ipv6)\. +\fItype\fR: Address type (\fB"ipv4"\fR, \fB"ipv6"\fR, \fB"torv2"\fR or \fB"torv3"\fR)\. .IP \[bu] -\fIaddress\fR: A string that represents the address value\. +\fIaddress\fR: IP or \fB.onion\fR hidden service address as a string\. .IP \[bu] -\fIport\fR: An integer that represents the port number where the node are listening\. +\fIport\fR: Port number as an integer\. .RE @@ -95,10 +95,10 @@ Vincenzo Palazzo \fI wrote the initial versi .SH SEE ALSO -FIXME: +FIXME: .SH RESOURCES Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:901b147ccbfe0a18310a44ca848b623e83fa3c68912dacadefd045d4a2095523 +\" SHA256STAMP:b9e69c3b1db9430c998dff00a3221c0a7da0bd7af45dfcf4e26d12adf9656836 diff --git a/doc/lightning-listnodes.7.md b/doc/lightning-listnodes.7.md index 333f3f3abc68..33a0f831c3c4 100644 --- a/doc/lightning-listnodes.7.md +++ b/doc/lightning-listnodes.7.md @@ -28,22 +28,22 @@ RETURN VALUE On success, the command will return a list of nodes, each object represents a node, with the following details: -- *nodeid*: A string that represents the node id. +- *nodeid*: Hex-encoded pubkey of the node. For nodes which have sent a node_announcement message, the following are also returned: -- *alias*: A string that represents alias of the node on the network. -- *color*: A string that represents the personal color of the node. -- *last_timestamp*: An integer that represents the timestamp of the last-received node_announcement message. -- *features*: A string that represents the features value. -- *addresses*: An array that represents the addreses avaible. Each address is represented with an object with the following properties: - - *type*: A string that represents the address type (ipv4 or ipv6). - - *address*: A string that represents the address value. - - *port*: An integer that represents the port number where the node are listening. - +- *alias*: The user-chosen node name as a string. +- *color*: The user-chosen node color as a hexadecimal string. +- *last_timestamp*: The last-received node_announcement message as a UNIX timestamp integer. +- *features*: Hex-encoded features bitstring. +- *addresses*: An array of the node's public addresses. Each address is represented by an object with the following properties: + - *type*: Address type (`"ipv4"`, `"ipv6"`, `"torv2"` or `"torv3"`). + - *address*: IP or `.onion` hidden service address as a string. + - *port*: Port number as an integer. + On failure, one of the following error codes may be returned: - + - -32602: Error in given parameters. EXAMPLE JSON RESPONSE @@ -78,7 +78,7 @@ Vincenzo Palazzo <> wrote the initial version o SEE ALSO -------- -FIXME: +FIXME: RESOURCES --------- diff --git a/doc/lightning-listtransactions.7 b/doc/lightning-listtransactions.7 index 9355dd788432..30ad4294f48b 100644 --- a/doc/lightning-listtransactions.7 +++ b/doc/lightning-listtransactions.7 @@ -26,34 +26,34 @@ On success, the command will return a list of transactions, each object represen .RS .IP \[bu] -\fIhash\fR: A string that represents the hash of transaction, which the caller can use to find it on the blockchain\. +\fIhash\fR: The transaction id, a hex-encoded hash of the transaction, which the caller can use to find it on the blockchain\. .IP \[bu] -\fIrawtx\fR: A string that represents the hexadecimal dump of the transaction\. +\fIrawtx\fR: Hex-encoded serialized transaction\. .IP \[bu] -\fIblockheight\fR: An integer that represents the block height that contains the transaction on the blockchain\. +\fIblockheight\fR: Height of the block that contains the transaction on the blockchain\. .IP \[bu] -\fItxindex\fR: An integer that represents the transaction index inside the block\. +\fItxindex\fR: The transaction index inside the block\. .IP \[bu] -\fIlocktime\fR: An integer that represents the nLocktime field\. +\fIlocktime\fR: The nLocktime field as an integer\. .IP \[bu] -\fIversion\fR: An integer that represents the nVersion field\. +\fIversion\fR: The nVersion field as an integer\. .IP \[bu] \fIinputs\fR: A list of spent transaction outputs, each spent transaction output is represented with an object with the following properties:.RS .IP \[bu] -\fItxid\fR: A string that represents the hash of transaction\. This is the output index of the transaction output being spent\. +\fItxid\fR: The transaction id of the output being spent\. .IP \[bu] -\fIindex\fR: An integer that represents the index of transaction\. +\fIindex\fR: Index of this output on the transaction id above\. .IP \[bu] -\fIsequence\fR: An integer that represents the nSequence field\. +\fIsequence\fR: The nSequence value of this input\. .RE .IP \[bu] \fIoutputs\fR: A list of transactions, each transaction is represented with an object with the following proprieties:.RS .IP \[bu] -\fIindex\fR: An integer that represents the index of transaction\. +\fIindex\fR: Index of this output\. .IP \[bu] -\fIsatoshis\fR: A string that represents the amount in millisatoshi\. +\fIsatoshis\fR: Output amount in satoshis\. .IP \[bu] \fIscriptPubKey\fR: A string that contains the lock script in hexadecimal dump form\. @@ -118,4 +118,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:88c68faf136cd7ce305bab0b89813d1c0122b8f31688a2dc9c064f7cba480a1d +\" SHA256STAMP:55d85f8090b4d640bc5cf1b4b251637ffa9829f2c65d2e0668089a25214144ac diff --git a/doc/lightning-listtransactions.7.md b/doc/lightning-listtransactions.7.md index cf8b47d2024e..815f877f6e33 100644 --- a/doc/lightning-listtransactions.7.md +++ b/doc/lightning-listtransactions.7.md @@ -26,21 +26,21 @@ RETURN VALUE On success, the command will return a list of transactions, each object represents a transaction, with the following details: -- *hash*: A string that represents the hash of transaction, which the caller can use to find it on the blockchain. -- *rawtx*: A string that represents the hexadecimal dump of the transaction. -- *blockheight*: An integer that represents the block height that contains the transaction on the blockchain. -- *txindex*: An integer that represents the transaction index inside the block. -- *locktime*: An integer that represents the nLocktime field. -- *version*: An integer that represents the nVersion field. +- *hash*: The transaction id, a hex-encoded hash of the transaction, which the caller can use to find it on the blockchain. +- *rawtx*: Hex-encoded serialized transaction. +- *blockheight*: Height of the block that contains the transaction on the blockchain. +- *txindex*: The transaction index inside the block. +- *locktime*: The nLocktime field as an integer. +- *version*: The nVersion field as an integer. - *inputs*: A list of spent transaction outputs, each spent transaction output is represented with an object with the following properties: - - *txid*: A string that represents the hash of transaction. This is the output index of the transaction output being spent. - - *index*: An integer that represents the index of transaction. - - *sequence*: An integer that represents the nSequence field. + - *txid*: The transaction id of the output being spent. + - *index*: Index of this output on the transaction id above. + - *sequence*: The nSequence value of this input. - *outputs*: A list of transactions, each transaction is represented with an object with the following proprieties: - - *index*: An integer that represents the index of transaction. - - *satoshis*: A string that represents the amount in millisatoshi. + - *index*: Index of this output. + - *satoshis*: Output amount in satoshis. - *scriptPubKey*: A string that contains the lock script in hexadecimal dump form. - + On failure, one of the following error codes may be returned: - -32602: Error in given parameters. diff --git a/doc/lightning-ping.7 b/doc/lightning-ping.7 index aca80e7b2561..49a7bcf8140b 100644 --- a/doc/lightning-ping.7 +++ b/doc/lightning-ping.7 @@ -11,7 +11,7 @@ The \fBping\fR command checks if the node with \fIid\fR is ready to talk\. It ac .RS .IP \[bu] -\fIid\fR: A string that represents the node id; +\fIid\fR: Hex-encoded pubkey of the target node; .IP \[bu] \fIlen\fR: A integer that represents the length of the ping (default 128); .IP \[bu] @@ -38,7 +38,7 @@ On success, the command will return an object with a single string\. .RS .IP \[bu] -\fItotlen\fR: A string that represents the answer length of the reply message (including header) +\fItotlen\fR: The length of the reply message (including header) .RE @@ -70,4 +70,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:eac5506bc761a2a9570a92c7e533b4c6ba72c56c4d69dce773887a9f88ea7ac2 +\" SHA256STAMP:fdbfb8b640c7b927d5393a68a066ebf57034cb9516f1a3877305aadd9962b9ea diff --git a/doc/lightning-ping.7.md b/doc/lightning-ping.7.md index 9f2e0bf306ac..f442ca698171 100644 --- a/doc/lightning-ping.7.md +++ b/doc/lightning-ping.7.md @@ -11,7 +11,7 @@ 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; +- *id*: Hex-encoded pubkey of the target node; - *len*: A integer that represents the length of the ping (default 128); - *pongbytes*: An integer that represents the length of the reply (default 128). @@ -33,7 +33,7 @@ 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) +- *totlen*: The length of the reply message (including header) On failure, one of the following error codes may be returned: diff --git a/doc/lightning-sendpsbt.7 b/doc/lightning-sendpsbt.7 index c54bd9faaa3f..244a5451cbe5 100644 --- a/doc/lightning-sendpsbt.7 +++ b/doc/lightning-sendpsbt.7 @@ -11,7 +11,7 @@ The \fBsendpsbt\fR is a low-level RPC command which sends a fully-signed PSBT\. .RS .IP \[bu] -\fIpsbt\fR: A string that represents psbt value\. +\fIpsbt\fR: A base64-encoded string of the PSBT\. .RE .SH EXAMPLE JSON REQUEST @@ -21,7 +21,7 @@ The \fBsendpsbt\fR is a low-level RPC command which sends a fully-signed PSBT\. "id": 82, "method": "sendpsbt", "params": { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHQBAAAAAcEKbzkcVvItfXURLb6PtIlar9N9jVKBZuxm34PsxGxgAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdueU1wUqAQAAABl2qRRxMMXp8bpyw7zzcTTnkjHukFng14isAAAAAAABAIUCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wNSAQH/////AgDyBSoBAAAAF6kU8Lg4vWyj9numjGv33kmU8Xj7+XiHAAAAAAAAAAAmaiSqIant4vYcP3HR3v0/qZnfo2lTdVxpBol5mWK0i+vYNpdOjPkAAAAAAQEgAPIFKgEAAAAXqRTwuDi9bKP2e6aMa/feSZTxePv5eIcBBxcWABT3We/RPg4o3h4maqWGMKzDVE01JQEIawJHMEQCIDFf4Y8vEDgQEkYVPOMyZas7eDpL1In8OSqKhrYftufXAiAdGOETFcD4Ge/y5e9BAwJZYueRvfUnmCzFQhmA5F9oOwEhA5EQC8GjcXM6YayF40YJviaUnNI2O7BMaUHZOWS7qJAoAAAiAgMAI5tx4a99gMvc9XHlmZjIpfz56hXBUrCTKexXf1CyURDRNMcTAAAAgAAAAIAsAACAAA==" } } .RE @@ -33,9 +33,9 @@ On success, the tx and txid of the transaction are returned\. .RS .IP \[bu] -\fItxid\fR: A string that represents the hash of transaction\. +\fItxid\fR: Hex-encoded hash of transaction\. .IP \[bu] -\fItx\fR: A string that represents the hexadecimal dump of the transaction\. +\fItx\fR: Hex-encoded serialized transaction\. .RE @@ -68,4 +68,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:795058b68607af4148d2866faa88b3743269e1641725c95efcabdbe82c886420 +\" SHA256STAMP:bdd6f15eb7603939bf8e2e356a18112027b4aab29cdabcfbf3d67544ec253ca1 diff --git a/doc/lightning-sendpsbt.7.md b/doc/lightning-sendpsbt.7.md index 20e1ac3f4848..b7e11ad54281 100644 --- a/doc/lightning-sendpsbt.7.md +++ b/doc/lightning-sendpsbt.7.md @@ -11,7 +11,7 @@ DESCRIPTION The **sendpsbt** is a low-level RPC command which sends a fully-signed PSBT. -- *psbt*: A string that represents psbt value. +- *psbt*: A base64-encoded string of the PSBT. EXAMPLE JSON REQUEST -------------------- @@ -21,7 +21,7 @@ EXAMPLE JSON REQUEST "id": 82, "method": "sendpsbt", "params": { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHQBAAAAAcEKbzkcVvItfXURLb6PtIlar9N9jVKBZuxm34PsxGxgAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdueU1wUqAQAAABl2qRRxMMXp8bpyw7zzcTTnkjHukFng14isAAAAAAABAIUCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wNSAQH/////AgDyBSoBAAAAF6kU8Lg4vWyj9numjGv33kmU8Xj7+XiHAAAAAAAAAAAmaiSqIant4vYcP3HR3v0/qZnfo2lTdVxpBol5mWK0i+vYNpdOjPkAAAAAAQEgAPIFKgEAAAAXqRTwuDi9bKP2e6aMa/feSZTxePv5eIcBBxcWABT3We/RPg4o3h4maqWGMKzDVE01JQEIawJHMEQCIDFf4Y8vEDgQEkYVPOMyZas7eDpL1In8OSqKhrYftufXAiAdGOETFcD4Ge/y5e9BAwJZYueRvfUnmCzFQhmA5F9oOwEhA5EQC8GjcXM6YayF40YJviaUnNI2O7BMaUHZOWS7qJAoAAAiAgMAI5tx4a99gMvc9XHlmZjIpfz56hXBUrCTKexXf1CyURDRNMcTAAAAgAAAAIAsAACAAA==" } } ``` @@ -31,8 +31,8 @@ RETURN VALUE On success, the tx and txid of the transaction are returned. -- *txid*: A string that represents the hash of transaction. -- *tx*: A string that represents the hexadecimal dump of the transaction. +- *txid*: Hex-encoded hash of transaction. +- *tx*: Hex-encoded serialized transaction. On failure, one of the following error codes may be returned: diff --git a/doc/lightning-signpsbt.7 b/doc/lightning-signpsbt.7 index 0f5641c9f68e..1036a5bd9c91 100644 --- a/doc/lightning-signpsbt.7 +++ b/doc/lightning-signpsbt.7 @@ -12,7 +12,7 @@ BIP-174\. .RS .IP \[bu] -\fIpsbt\fR: A string that represents the PSBT value\. +\fIpsbt\fR: A base64-encoded string of the PSBT\. .IP \[bu] \fIsignonly\fR: An optional array of input numbers to sign\. @@ -33,7 +33,7 @@ if the inputs to be signed were not previously reserved\. "id": 82, "method": "signpsbt", "params": { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHEBAAAAAZ+dQXWMU0UUQW5guh1gAqRk6qV1EfswIxDz/l6pI4BYAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdue0RKASAAAAABYAFKswhKbTAJ6fHwhnBttaS62vUkitAAAAAAAAAAA=" } } .RE @@ -45,7 +45,7 @@ On success, a object will be returned with a string\. .RS .IP \[bu] -\fIpsbt\fR: A string that represents the psbt value with all inputs signed transaction\. +\fIpsbt\fR: A base64-PSBT with the specified inputs signed\. .RE @@ -60,14 +60,14 @@ On failure, one of the following error codes may be returned: .nf .RS { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHQBAAAAAcEKbzkcVvItfXURLb6PtIlar9N9jVKBZuxm34PsxGxgAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdueU1wUqAQAAABl2qRRxMMXp8bpyw7zzcTTnkjHukFng14isAAAAAAABAIUCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wNSAQH/////AgDyBSoBAAAAF6kU8Lg4vWyj9numjGv33kmU8Xj7+XiHAAAAAAAAAAAmaiSqIant4vYcP3HR3v0/qZnfo2lTdVxpBol5mWK0i+vYNpdOjPkAAAAAAQEgAPIFKgEAAAAXqRTwuDi9bKP2e6aMa/feSZTxePv5eIcBBxcWABT3We/RPg4o3h4maqWGMKzDVE01JQEIawJHMEQCIDFf4Y8vEDgQEkYVPOMyZas7eDpL1In8OSqKhrYftufXAiAdGOETFcD4Ge/y5e9BAwJZYueRvfUnmCzFQhmA5F9oOwEhA5EQC8GjcXM6YayF40YJviaUnNI2O7BMaUHZOWS7qJAoAAAiAgMAI5tx4a99gMvc9XHlmZjIpfz56hXBUrCTKexXf1CyURDRNMcTAAAAgAAAAIAsAACAAA==" } .RE .fi .SH AUTHOR -Vincenzo Palazzo \fI wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\. +Vincenzo Palazzo \fI wrote the initial version of this man page, but many others did the hard work of actually implementing this RPC command\. .SH SEE ALSO @@ -77,4 +77,4 @@ Vincenzo Palazzo \fI wrote the initial versi Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:5d7f12bed20a73dabf41d219ccd960e4e36a4674e8528d95ef26f7c8c55b1a0f +\" SHA256STAMP:f6463fb4a57eac3950a8d3876bd2c9bcd298f378f6fb98af0a1001b14161746e diff --git a/doc/lightning-signpsbt.7.md b/doc/lightning-signpsbt.7.md index 7c3ae9490d2d..93daf57bc588 100644 --- a/doc/lightning-signpsbt.7.md +++ b/doc/lightning-signpsbt.7.md @@ -12,7 +12,7 @@ DESCRIPTION **signpsbt** is a low-level RPC command which signs a PSBT as defined by BIP-174. -- *psbt*: A string that represents the PSBT value. +- *psbt*: A base64-encoded string of the PSBT. - *signonly*: An optional array of input numbers to sign. By default, all known inputs are signed, and others ignored: with @@ -30,7 +30,7 @@ EXAMPLE JSON REQUEST "id": 82, "method": "signpsbt", "params": { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHEBAAAAAZ+dQXWMU0UUQW5guh1gAqRk6qV1EfswIxDz/l6pI4BYAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdue0RKASAAAAABYAFKswhKbTAJ6fHwhnBttaS62vUkitAAAAAAAAAAA=" } } ``` @@ -40,7 +40,7 @@ RETURN VALUE On success, a object will be returned with a string. -- *psbt*: A string that represents the psbt value with all inputs signed transaction. +- *psbt*: A base64-PSBT with the specified inputs signed. On failure, one of the following error codes may be returned: @@ -51,14 +51,14 @@ EXAMPLE JSON RESPONSE ```json { - "psbt": "some_psbt" + "psbt": "cHNidP8BAHQBAAAAAcEKbzkcVvItfXURLb6PtIlar9N9jVKBZuxm34PsxGxgAAAAAAD/////AuQGAAAAAAAAFgAUNiXEouqXR2CoFjaP0V3ncVlEdueU1wUqAQAAABl2qRRxMMXp8bpyw7zzcTTnkjHukFng14isAAAAAAABAIUCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wNSAQH/////AgDyBSoBAAAAF6kU8Lg4vWyj9numjGv33kmU8Xj7+XiHAAAAAAAAAAAmaiSqIant4vYcP3HR3v0/qZnfo2lTdVxpBol5mWK0i+vYNpdOjPkAAAAAAQEgAPIFKgEAAAAXqRTwuDi9bKP2e6aMa/feSZTxePv5eIcBBxcWABT3We/RPg4o3h4maqWGMKzDVE01JQEIawJHMEQCIDFf4Y8vEDgQEkYVPOMyZas7eDpL1In8OSqKhrYftufXAiAdGOETFcD4Ge/y5e9BAwJZYueRvfUnmCzFQhmA5F9oOwEhA5EQC8GjcXM6YayF40YJviaUnNI2O7BMaUHZOWS7qJAoAAAiAgMAI5tx4a99gMvc9XHlmZjIpfz56hXBUrCTKexXf1CyURDRNMcTAAAAgAAAAIAsAACAAA==" } ``` AUTHOR ------ -Vincenzo Palazzo <> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command. +Vincenzo Palazzo <> wrote the initial version of this man page, but many others did the hard work of actually implementing this RPC command. SEE ALSO --------