lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Fixed mistake inside the docs 

Thanks @rustyrussell.

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
bump-pyln-proto
Vincenzo Palazzo 4 years ago
committed by Rusty Russell
parent
0b0c5898ff
commit
dde25b712c
20 changed files with 1006 additions and 14 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 11
      doc/Makefile
  2. 122
      doc/lightning-getinfo.7
  3. 2
      doc/lightning-getinfo.7.md
  4. 96
      doc/lightning-getlog.7
  5. 2
      doc/lightning-getlog.7.md
  6. 69
      doc/lightning-help.7
  7. 2
      doc/lightning-help.7.md
  8. 236
      doc/lightning-listconfigs.7
  9. 2
      doc/lightning-listconfigs.7.md
  10. 96
      doc/lightning-listnodes.7
  11. 2
      doc/lightning-listnodes.7.md
  12. 120
      doc/lightning-listtransactions.7
  13. 2
      doc/lightning-listtransactions.7.md
  14. 72
      doc/lightning-ping.7
  15. 3
      doc/lightning-ping.7.md
  16. 70
      doc/lightning-sendpsbt.7
  17. 6
      doc/lightning-sendpsbt.7.md
  18. 67
      doc/lightning-signpsbt.7
  19. 6
      doc/lightning-signpsbt.7.md
  20. 34
      doc/lightning-stop.7

11
doc/Makefile
View File

@ -54,7 +54,16 @@ MANPAGES := doc/lightning-cli.1 \
doc/lightning-waitblockheight.7 \
doc/lightning-waitsendpay.7 \
doc/lightning-withdraw.7 \
doc/lightning-ping.7
doc/lightning-ping.7 \
doc/lightning-stop.7 \
doc/lightning-signpsbt.7 \
doc/lightning-sendpsbt.7 \
doc/lightning-getinfo.7 \
doc/lightning-listtransactions.7 \
doc/lightning-listnodes.7 \
doc/lightning-listconfigs.7 \
doc/lightning-help.7 \
doc/lightning-getlog.7
doc-all: $(MANPAGES) doc/index.rst

122
doc/lightning-getinfo.7
View File

@ -0,0 +1,122 @@
.TH "LIGHTNING-GETINFO" "7" "" "" "lightning-getinfo"
.SH NAME
lightning-getinfo - Command to receive all information about the c-lightning node\.
.SH SYNOPSIS
\fBgetinfo\fR
.SH DESCRIPTION
The \fBgetinfo\fR is a RPC command which is possible receive all node informations\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "getinfo",
"params": {}
}
.RE
.fi
.SH RETURN VALUE
On success, an object with the following information is returned:
.RS
.IP \[bu]
\fIid\fR: A string that rappresents the public key of the node\. It will rappresent the node on the public network\.
.IP \[bu]
\fIalias\fR: A string that rappresents the alias of the node, by default is calculate from the public key (node id)\.
.IP \[bu]
\fIcolor\fR: A string that rappresents the color of the node\.
.IP \[bu]
\fInum_peers\fR: An integer that rappresents the number of peer connect to the node\.
.IP \[bu]
\fInum_pending_channels\fR: An integer that rappresents the number of channel with pending status\.
.IP \[bu]
\fInum_active_channels\fR: A integer that rappresents the number of channel with the active status\.
.IP \[bu]
\fInum_inactive_channels\fR: A integer that rappresents the number of channel with the inactive status\.
.IP \[bu]
\fIaddress\fR: An array that rappresents all addresses of the node, each object inside the array contains the following proprieties:.RS
.IP \[bu]
\fItype\fR: A string that rappresents the type of the address (ipv4 or ipv6)\.
.IP \[bu]
\fIaddress\fR: A string that rappresents the value of the address\.
.IP \[bu]
\fIport\fR: An integer that rappresents the port where the node are listening with this address\.
.RE
.IP \[bu]
\fIbinding\fR: An array that rappresents all addresses where the node is binded\. Each object contains the same object type of the address propriety above\.
.IP \[bu]
\fIversion\fR: A string that rappresents the version of the node\.
.IP \[bu]
\fIblockheight\fR: An integer that rappresents the blockchain height\.
.IP \[bu]
\fInetwork\fR: A string that rappresents the type of network on the node are working (i\.e: bitcoin, testnet, regtest)\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters or some error happened during the command process\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d",
"alias": "SLICKERGOPHER",
"color": "02bf81",
"num_peers": 0,
"num_pending_channels": 0,
"num_active_channels": 0,
"num_inactive_channels": 0,
"address": [
{
"type": "torv3",
"address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion",
"port": 9736
},
{
"type": "torv3",
"address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion",
"port": 9736
}
],
"binding": [
{
"type": "ipv4",
"address": "127.0.0.1",
"port": 9736
}
],
"version": "0.9.0",
"blockheight": 644297,
"network": "bitcoin",
"msatoshi_fees_collected": 0,
"fees_collected_msat": "0msat",
"lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin"
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-listconfigs\fR(7)\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-getinfo.7.md
View File

@ -45,7 +45,7 @@ On success, an object with the following information is returned:
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters or some error happened during the command process.
- -32602: Error in given parameters or some error happened during the command process.
EXAMPLE JSON RESPONSE
-----

96
doc/lightning-getlog.7
View File

@ -0,0 +1,96 @@
.TH "LIGHTNING-GETLOG" "7" "" "" "lightning-getlog"
.SH NAME
lightning-getlog - Command to show logs\.
.SH SYNOPSIS
\fBgetlog\fR [level]
.SH DESCRIPTION
The \fBgetlog\fR the RPC command to show logs, with optional log \fIlevel\fR\.
.RS
.IP \[bu]
\fIlevel\fR: A string that rappresent the log level (info, unusual, debug, io)\.
.RE
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "getlog",
"params": {
"level": "debug"
}
}
.RE
.fi
.SH RETURN VALUE
On success, a object will be return with the following parameters:
.RS
.IP \[bu]
\fIcreated_at\fR: An floating point value that rappresent the {}\.
.IP \[bu]
\fIbytes_used\fR: A string that rappresent the dimension in bytes of the log file\.
.IP \[bu]
\fIbytes_max\fR: An integer that rappresent the max dimension in bytes of log file\.
.IP \[bu]
\fIlog\fR: An array of object where each elements contains the following proprieties:.RS
.IP \[bu]
\fItype\fR: A string that rappresent the log level\. The propriety can have an value equal to SKIPPED\.
.IP \[bu]
\fItime\fR: A floating point value that rappresent the time\.
.IP \[bu]
\fIsource\fR: A string that rappresent the source of line\.
.IP \[bu]
\fIlog\fR: A string that rappresent the content of line\.
.RE
.IP \[bu]
\fInum_skipped\fR: An integer that it is present only if the log level is equal to SKIPPED\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"created_at": "1598192543.820753463",
"bytes_used": 89285843,
"bytes_max": 104857600,
"log": [
{
"type": "SKIPPED",
"num_skipped": 45
},
{
"type": "INFO",
"time": "0.453627568",
"source": "plugin-autopilot.py",
"log": "RPC method 'autopilot-run-once' does not have a docstring."
}
]
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-getlog.7.md
View File

@ -43,7 +43,7 @@ On success, a object will be return with the following parameters:
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters.
- -32602: Error in given parameters.
EXAMPLE JSON RESPONSE
---------------------

69
doc/lightning-help.7
View File

@ -0,0 +1,69 @@
.TH "LIGHTNING-HELP" "7" "" "" "lightning-help"
.SH NAME
lightning-help - Command to return all information about RPC commands\.
.SH SYNOPSIS
\fBhelp\fR
.SH DESCRIPTION
The \fBhelp\fR is a RPC command which is possible consult all information about the RPC commands\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "help",
"params": {}
}
.RE
.fi
.SH RETURN VALUE
On success, a object will be return with the following proprieties:
.RS
.IP \[bu]
\fIcommand\fR: A string that rappresent the stucture of the command\.
.IP \[bu]
\fIcategory\fR: A string that rappresent the category\.
.IP \[bu]
\fIdescription\fR: A string that rappresent the description\.
.IP \[bu]
\fIverbose\fR: A string that rappresent the verbode description\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"help": [
{
"command": "autocleaninvoice [cycle_seconds] [expired_by]",
"category": "plugin",
"description": "Set up autoclean of expired invoices. ",
"verbose": "Perform cleanup every {cycle_seconds} (default 3600), or disable autoclean if 0. Clean up expired invoices that have expired for {expired_by} seconds (default 86400). "
}
]
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-help.7.md
View File

@ -33,7 +33,7 @@ On success, a object will be return with the following proprieties:
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters.
- -32602: Error in given parameters.
EXAMPLE JSON RESPONSE
---------------------

236
doc/lightning-listconfigs.7
View File

@ -0,0 +1,236 @@
.TH "LIGHTNING-LISTCONFIGS" "7" "" "" "lightning-listconfigs"
.SH NAME
lightning-listconfigs - Command to list all configuration options\.
.SH SYNOPSIS
\fBlistconfigs\fR [config]
.SH DESCRIPTION
The \fBlistconfigs\fR teh RPC command to list all configuration options, or with \fIconfig\fR, just that one\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "listconfigs",
"params": {}
}
.RE
.fi
.SH RETURN VALUE
On success, an object with the following proprieties is returned:
.RS
.IP \[bu]
\fI# version\fR: A string that rappresents the version of node\.
.IP \[bu]
\fIlightning-di\fR: A string that rappresents the work dir of the node\.
.IP \[bu]
\fInetwork\fR: A string that rappresents the network (e\.g: bitcoin)\.
.IP \[bu]
\fIallow-deprecated-apis\fR: A boolean value that rappresent if the deprecated api are avaible on the node\.
.IP \[bu]
\fIrpc-file\fR: A string that rappresent the location of the rpc file\.
.IP \[bu]
\fIplugins\fR: A array that rappresent the no important plugin registered\. Each object contains the following proprieties:.RS
.IP \[bu]
\fIpath\fR: A string that rappresent the path of plugin\.
.IP \[bu]
\fIname\fR: A string that rappresent the name of plugin\.
.IP \[bu]
\fIoptions\fR: A object that contains all options accepted from comand line, if the plugin accepted parameters from command line\.
.RE
.IP \[bu]
\fIimportant-plugins\fR: An array that rappresent all important pluging registered to the node\. Each object contains the same proprieties of \fIplugin\fR array\.
.IP \[bu]
\fIdisable-plugin\fR: An array of string that rappresent the name of plugin disabled\.
.IP \[bu]
\fIalways-use-proxy\fR: A boolean value that rappresent if the node utilize always the proxy\.
.IP \[bu]
\fIdaemon\fR: A boolean value is the node have the daemon propriety enabled\.
.IP \[bu]
\fIwallet\fR: A string that rappresent the location of wallet with database url convention\.
.IP \[bu]
\fIwumbo\fR: A boolean value that rappresent the value of wumbo propriety\.
.IP \[bu]
\fIrgb\fR: A string that rappresent the color of the node\.
.IP \[bu]
\fIalias\fR: A string that rappresent the alias of the node\.
.IP \[bu]
\fIpid-file\fR: A string that rappresent the location of the pid file\.
.IP \[bu]
\fIignore-fee-limits\fR: A boolean value that rappresent is the node ignore the fee limit\.
.IP \[bu]
\fIwatchtime-blocks\fR: An integer that rappresent the watchtime of the blocks\.
.IP \[bu]
\fImax-locktime-blocks\fR: A integer that rappresent that max locktime for blocks\.
.IP \[bu]
\fIfunding-confirms\fR: An integer that rappresent the number of funding transaction confermation\.
.IP \[bu]
\fIcommit-fee-min\fR: A integer that rappresent the minimum commit fee\.
.IP \[bu]
\fIcommit-fee-max\fR: A integer that rappresent the maximum commit fee\.
.IP \[bu]
\fIcltv-delta\fR: An integer that rappresent the value of cltv delta\.
.IP \[bu]
\fIcltv-final\fR: An integer that rappresent the value of cltv final\.
.IP \[bu]
\fIcommit-time\fR: An integer that rappresent the value of commit time\.
.IP \[bu]
\fIfee-base\fR: A integer that rappresent the value of fee base\.
.IP \[bu]
\fIrescan\fR: A integer that rappresent the number of block that the node must rescan before to run\.
.IP \[bu]
\fIfee-per-satoshi\fR: An integer that rappresent the fee for satoshi\.
.IP \[bu]
\fImax-concurrent-htlcs\fR: A integer that rappresent the number of HTLCs one channel can handle concurrently in each direction\.
.IP \[bu]
\fImin-capacity-sat\fR: A integer that rappresent the minimal effective channel capacity in satoshi to accept for channel opening requests\.
.IP \[bu]
\fIaddr\fR: A string that rappresent the address where the node are listen\.
.IP \[bu]
\fIbind-addr\fR: A string that rappresent the address or UNIX domine socket where the node are listen\.
.IP \[bu]
\fIannounce-addr\fR: A string that rappresent the address where the node is annunced\.
.IP \[bu]
\fIoffline\fR: A boolean value that rappresent if the node is offline\.
.IP \[bu]
\fIautolisten\fR: A boolean value that rappresent if the autolisten is enabled\.
.IP \[bu]
\fIproxy\fR: A string that rappresent the proxy address\.
.IP \[bu]
\fIdisable-dns\fR: A boolean value that rappresent if the dns is disabled\.
.IP \[bu]
\fIenable-autotor-v2-mode\fR: A boolean value that rappresent if the Tor v2 is enabled\.
.IP \[bu]
\fIencrypted-hsm\fR: A boolean value that rappresent if the wallet is encrypted\.
.IP \[bu]
\fIrpc-file-mode\fR: A string that rappresent the value rpc-file-mode\.
.IP \[bu]
\fIlog-level\fR: A string that rappresent the level of log\.
.IP \[bu]
\fIlog-prefix\fR: A string that rappresent the log prefix\.
On failure, one of the following error codes may be returned:
.IP \[bu]
-32602: Error in given parameters or field with \fIconfig\fR name doesn't exist\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"# version": "v0.9.0-1",
"lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev",
"network": "testnet",
"allow-deprecated-apis": true,
"rpc-file": "lightning-rpc",
"plugins": [
{
"path": "/home/vincent/Github/plugins/sauron/sauron.py",
"name": "sauron.py",
"options": {
"sauron-api-endpoint": "http://blockstream.info/testnet/api/",
"sauron-tor-proxy": ""
}
},
{
"path": "/home/vincent/Github/reckless/reckless.py",
"name": "reckless.py"
}
],
"important-plugins": [
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean",
"name": "autoclean",
"options": {
"autocleaninvoice-cycle": null,
"autocleaninvoice-expired-by": null
}
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel",
"name": "fundchannel"
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend",
"name": "keysend"
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/pay",
"name": "pay",
"options": {
"disable-mpp": false
}
}
],
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/keysend",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay",
"plugin": "/home/vincent/Github/plugins/sauron/sauron.py",
"plugin": "/home/vincent/Github/reckless/reckless.py",
"disable-plugin": [
"bcli"
],
"always-use-proxy": false,
"daemon": "false",
"wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3",
"wumbo": false,
"wumbo": false,
"rgb": "03ad98",
"alias": "BRUCEWAYN-TES-DEV",
"pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...",
"ignore-fee-limits": true,
"watchtime-blocks": 6,
"max-locktime-blocks": 2016,
"funding-confirms": 1,
"commit-fee-min": 0,
"commit-fee-max": 0,
"cltv-delta": 6,
"cltv-final": 10,
"commit-time": 10,
"fee-base": 1,
"rescan": 30,
"fee-per-satoshi": 10,
"max-concurrent-htlcs": 483,
"min-capacity-sat": 10000,
"addr": "autotor:127.0.0.1:9051",
"bind-addr": "127.0.0.1:9735",
"announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735",
"offline": "false",
"autolisten": true,
"proxy": "127.0.0.1:9050",
"disable-dns": "false",
"enable-autotor-v2-mode": "false",
"encrypted-hsm": false,
"rpc-file-mode": "0600",
"log-level": "DEBUG",
"log-prefix": "lightningd",
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-getinfo\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-listconfigs.7.md
View File

@ -73,7 +73,7 @@ On success, an object with the following proprieties is returned:
- *log-prefix*: A string that rappresent the log prefix.
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters or field with *config* name doesn't exist.
- -32602: Error in given parameters or field with *config* name doesn't exist.
EXAMPLE JSON RESPONSE
---------------------

96
doc/lightning-listnodes.7
View File

@ -0,0 +1,96 @@
.TH "LIGHTNING-LISTNODES" "7" "" "" "lightning-listnodes"
.SH NAME
lightning-listnodes - Command to get the list of nodes in the own node network\.
.SH SYNOPSIS
\fBlistnodes\fR [id]
.SH DESCRIPTION
The \fBlistnodes\fR command returns nodes in the own node network, or a single one if the node \fIid\fR was specified\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "listnodes",
"params": {
"id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a"
}
}
.RE
.fi
.SH RETURN VALUE
On success, the command will return a list of nodes, each object represents a node, with the following details:
.RS
.IP \[bu]
\fInodeid\fR: A string that rappresents the node id\.
.IP \[bu]
\fIalias\fR: A string that rappresents alias of the node on the network\.
.IP \[bu]
\fIcolor\fR: A string that rappresents the personal color of the node\.
.IP \[bu]
\fIlast_timestamp\fR: An integer that rappresent the last timestamp\.
.IP \[bu]
\fIfeatures\fR: A string that rappresent the features value\.
.IP \[bu]
\fIaddresses\fR: An array that rappresent the addreses avaible\. Each address is rappresented with an object with the following properties:.RS
.IP \[bu]
\fItype\fR: A string that rappresent the address type (ipv4 or ipv6)\.
.IP \[bu]
\fIaddress\fR: A string that rappresent the address value\.
.IP \[bu]
\fIport\fR: An integer that rappresent the port number where the node are listening\.
.RE
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"nodes": [
{
"nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a",
"alias": "some_alias",
"color": "68f442",
"last_timestamp": 1597213741,
"features": "02a2a1",
"addresses": [
{
"type": "ipv4",
"address": "zzz.yy.xx.xx",
"port": 9735
}
]
}
]
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
FIXME:
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-listnodes.7.md
View File

@ -40,7 +40,7 @@ On success, the command will return a list of nodes, each object represents a no
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters.
- -32602: Error in given parameters.
EXAMPLE JSON RESPONSE
-----

120
doc/lightning-listtransactions.7
View File

@ -0,0 +1,120 @@
.TH "LIGHTNING-LISTTRANSACTIONS" "7" "" "" "lightning-listtransactions"
.SH NAME
lightning-listtransactions - Command to get the list of transactions that was stored in the wallet\.
.SH SYNOPSIS
\fBlisttransactions\fR
.SH DESCRIPTION
The \fBlisttransactions\fR command returns transactions tracked in the wallet\. This includes deposits, withdrawals and transactions related to channels\. A transaction may have multiple types, e\.g\., a transaction may both be a close and a deposit if it closes the channel and returns funds to the wallet\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "listtransactions",
"params": {}
}
.RE
.fi
.SH RETURN VALUE
On success, the command will return a list of transactions, each object represents a transaction, with the following details:
.RS
.IP \[bu]
\fIhash\fR: A string that rappresents the hash of transaction, which the caller can use to find it on the blockchain\.
.IP \[bu]
\fIrawtx\fR: A string that rappresents the hexadecimal dump of the transaction\.
.IP \[bu]
\fIblockheight\fR: An integer that rappresents the block height that contains the transaction on the blockchain\.
.IP \[bu]
\fItxindex\fR: An integer that rappresent the transaction index inside the block\.
.IP \[bu]
\fIlocktime\fR: An integer that rappresent the locktime\.
.IP \[bu]
\fIversion\fR: An integer that rappresent the version\.
.IP \[bu]
\fIinputs\fR: A list of spent transaction outputs, each spent transaction output is rappresented with an object with the following properties:.RS
.IP \[bu]
\fItxid\fR: A string that rappresent the hash of transaction\. This is the output index of the transaction output being spent\.
.IP \[bu]
\fIindex\fR: An integer that rappresent the index of transaction\.
.IP \[bu]
\fIsequence\fR: An integer that rappresent the sequence number\.
.RE
.IP \[bu]
\fIoutputs\fR: A list of transactions, each transaction is rappresented with an object with the following proprieties:.RS
.IP \[bu]
\fIindex\fR: An integer that rappresent the index of transaction\.
.IP \[bu]
\fIsatoshis\fR: A string that rappresent the amount in millisatoshi\.
.IP \[bu]
\fIscriptPubKey\fR: A string that contains the lock script in hexadecimal dump form\.
.RE
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"transactions": [
{
"hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0",
"rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000",
"blockheight": 0,
"txindex": 0,
"locktime": 0,
"version": 2,
"inputs": [
{
"txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270",
"index": 1,
"sequence": 4294967295
},
{
"txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2",
"index": 0,
"sequence": 4294967295
}
],
"outputs": [
{
"index": 0,
"satoshis": "88721000msat",
"scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87"
}
]
}
]
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-newaddr\fR(7), \fBlightning-listfunds\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-listtransactions.7.md
View File

@ -42,7 +42,7 @@ On success, the command will return a list of transactions, each object represen
- *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.
- -32602: Error in given parameters.
EXAMPLE JSON RESPONSE
-----

72
doc/lightning-ping.7
View File

@ -0,0 +1,72 @@
.TH "LIGHTNING-PING" "7" "" "" "lightning-ping"
.SH NAME
lightning-ping - Command to check if a node is up\.
.SH SYNOPSIS
\fBping\fR \fIid\fR [len] [pongbytes]
.SH DESCRIPTION
The \fBping\fR command check if the node with id is ready to talk\. It accept the following parameter:
.RS
.IP \[bu]
\fIid\fR: A string that rappresent the node id;
.IP \[bu]
\fIlen\fR: A integer that rappresent the lenght of {\.\.\.}, by default is 128;
.IP \[bu]
\fIpongbytes\fR: An integer that rappresent the lenght of {}, by default is 128\.
.RE
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "ping",
"params": {
"len": 128,
"pongbytes": 128
}
}
.RE
.fi
.SH RETURN VALUE
On success, the command will return an object with a single string\.
.RS
.IP \[bu]
\fItotlen\fR: A string that rappresent the answer lenght of {}\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters or unknow peer\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"totlen": 132
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-connect\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

3
doc/lightning-ping.7.md
View File

@ -36,7 +36,8 @@ 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.
- -32602: Error in given parameters or unknow peer.
EXAMPLE JSON RESPONSE
-----

70
doc/lightning-sendpsbt.7
View File

@ -0,0 +1,70 @@
.TH "LIGHTNING-SENDPSBT" "7" "" "" "lightning-sendpsbt"
.SH NAME
lightning-sendpsbt - Command to finalize, extract and send a partially signed bitcoin transaction (PSBT)\.
.SH SYNOPSIS
\fBsendpsbt\fR \fIpsbt\fR
.SH DESCRIPTION
The \fBsendpsbt\fR is a low-level RPC command which sent a PSBT\.
.RS
.IP \[bu]
\fIpsbt\fR: A string that rappresent psbt value\.
.RE
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "sendpsbt",
"params": {
"psbt": "some_psbt"
}
}
.RE
.fi
.SH RETURN VALUE
On success, the tx and txid of the transaction are returned, as well as the channel_id of the newly created channel\.
.RS
.IP \[bu]
\fItxid\fR: A string that rappresent the hash of transaction\.
.IP \[bu]
\fItx\fR: A string that rappresent the hexadecimal dump of the transaction\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters or some error happened during the command process\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"txid": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0",
"tx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000",
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-fundpsbt\fR(7), \fBlightning-signpsbt\fR(7), \fBlightning-listtransactions\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

6
doc/lightning-sendpsbt.7.md
View File

@ -11,7 +11,7 @@ DESCRIPTION
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 caller can build a psbt with command *fundpsbt*.
- *psbt*: A string that rappresent psbt value.
EXAMPLE JSON REQUEST
--------------------
@ -31,12 +31,12 @@ RETURN VALUE
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.
- *tx*: A string that rappresent the hexadecimal dump of the transaction.
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters or some error happened during the command process.
- -32602: Error in given parameters or some error happened during the command process.
EXAMPLE JSON RESPONSE
---------------------

67
doc/lightning-signpsbt.7
View File

@ -0,0 +1,67 @@
.TH "LIGHTNING-SIGNPSBT" "7" "" "" "lightning-signpsbt"
.SH NAME
lightning-signpsbt - Command to sign a wallet's inputs on a provided bitcoin transaction (PSBT)\.
.SH SYNOPSIS
\fBsignpsbt\fR \fIpsbt\fR
.SH DESCRIPTION
The \fBsignpsbt\fR is a low-level RPC command which sign a PSBT\.
.RS
.IP \[bu]
\fIpsbt\fR: A string that rappresent the psbt value\.
.RE
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "signpsbt",
"params": {
"psbt": "some_psbt"
}
}
.RE
.fi
.SH RETURN VALUE
On success, a object will be return with a string\.
.RS
.IP \[bu]
\fIpsbt\fR: A string that rappresent the psbt value\.
.RE
On failure, one of the following error codes may be returned:
.RS
.IP \[bu]
-32602: Error in given parameters or there aren't wallet's inputs to sign\.
.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
"psbt": "some_psbt"
}
.RE
.fi
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH SEE ALSO
\fBlightning-fundpsbt\fR(7), \fBlightning-sendpsbt\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

6
doc/lightning-signpsbt.7.md
View File

@ -11,7 +11,7 @@ DESCRIPTION
The **signpsbt** is a low-level RPC command which sign a PSBT.
- *psbt*: A string that rappresent the hexadecimal of the psbt.
- *psbt*: A string that rappresent the psbt value.
EXAMPLE JSON REQUEST
--------------------
@ -30,11 +30,11 @@ RETURN VALUE
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 psbt value.
On failure, one of the following error codes may be returned:
- -32602. Error in given parameters or there aren't wallet's inputs to sign.
- -32602: Error in given parameters or there aren't wallet's inputs to sign.
EXAMPLE JSON RESPONSE
---------------------

34
doc/lightning-stop.7
View File

@ -0,0 +1,34 @@
.TH "LIGHTNING-STOP" "7" "" "" "lightning-stop"
.SH NAME
lightning-stop - Command to shut-off c-lightning node\.
.SH SYNOPSIS
\fBstop\fR
.SH DESCRIPTION
The \fBstop\fR is a RPC command to shut-off the c-lightning node\.
.SH EXAMPLE JSON REQUEST
.nf
.RS
{
"id": 82,
"method": "stop",
"params": {}
}
.RE
.fi
.SH RETURN VALUE
On success, the command will return a empty object\.
.SH AUTHOR
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
Write Preview
Loading…
Cancel
Save