mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 10:39:49 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
76 lines
2.0 KiB
Groff
76 lines
2.0 KiB
Groff
.TH "LIGHTNING-LISTFUNDS" "7" "" "" "lightning-listfunds"
|
||
.SH NAME
|
||
lightning-listfunds - Command showing all funds currently managed by the c-lightning node
|
||
.SH SYNOPSIS
|
||
|
||
\fBlistfunds\fR
|
||
|
||
.SH DESCRIPTION
|
||
|
||
The \fBlistfunds\fR RPC command displays all funds available, either in
|
||
unspent outputs (UTXOs) in the internal wallet or funds locked in
|
||
currently open channels\.
|
||
|
||
.SH RETURN VALUE
|
||
|
||
On success two arrays will be returned: \fIoutputs\fR with funds currently
|
||
locked onchain in UTXOs and \fIchannels\fR with funds readily spendable in
|
||
channels\.
|
||
|
||
|
||
Each entry in \fIoutputs\fR will include:
|
||
|
||
.IP \[bu]
|
||
\fItxid\fR
|
||
.IP \[bu]
|
||
\fIoutput\fR (the index of the output in the transaction)
|
||
.IP \[bu]
|
||
\fIvalue\fR (the output value in satoshis)
|
||
.IP \[bu]
|
||
\fIamount_msat\fR (the same as \fIvalue\fR, but in millisatoshi with \fImsat\fR
|
||
appended)
|
||
.IP \[bu]
|
||
\fIaddress\fR
|
||
.IP \[bu]
|
||
\fIstatus\fR (whether \fIunconfirmed\fR, \fIconfirmed\fR, or \fIspent\fR)
|
||
|
||
|
||
Each entry in \fIchannels\fR will include:
|
||
|
||
.IP \[bu]
|
||
\fIpeer_id\fR - the peer with which the channel is opened\.
|
||
.IP \[bu]
|
||
\fIshort_channel_id\fR - as per BOLT 7 (representing the block,
|
||
transaction number and output index of the channel funding
|
||
transaction)\.
|
||
.IP \[bu]
|
||
\fIchannel_sat\fR - available satoshis on our node’s end of the channel
|
||
(values rounded down to satoshis as internal storage is in
|
||
millisatoshi)\.
|
||
.IP \[bu]
|
||
\fIour_amount_msat\fR - same as above, but in millisatoshis with
|
||
\fImsat\fR appended\.
|
||
.IP \[bu]
|
||
\fIchannel_total_sat\fR - total channel value in satoshi
|
||
.IP \[bu]
|
||
\fIamount_msat\fR - same as above, but in millisatoshis with \fImsat\fR
|
||
appended\.
|
||
.IP \[bu]
|
||
\fIfunding_txid\fR - funding transaction id\.
|
||
.IP \[bu]
|
||
\fIfunding_output\fR - the index of the output in the funding
|
||
transaction\.
|
||
|
||
.SH AUTHOR
|
||
|
||
Felix \fI<fixone@gmail.com\fR> is mainly responsible\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-newaddr\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-withdraw\fR(7)
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|