core-lightning/doc/lightning-listfunds.7.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

lightning-listfunds -- Command showing all funds currently managed by the c-lightning node
==========================================================================================
SYNOPSIS
--------
**listfunds**
DESCRIPTION
-----------
The **listfunds** RPC command displays all funds available, either in
unspent outputs (UTXOs) in the internal wallet or funds locked in
currently open channels.
RETURN VALUE
------------
On success two arrays will be returned: *outputs* with funds currently
locked onchain in UTXOs and *channels* with funds readily spendable in
channels.
Each entry in *outputs* will include:
- *txid*
- *output* (the index of the output in the transaction)
- *value* (the output value in satoshis)
- *amount\_msat* (the same as *value*, but in millisatoshi with *msat*
appended)
- *address*
- *status* (whether *unconfirmed*, *confirmed*, or *spent*)
Each entry in *channels* will include:
- *peer\_id* - the peer with which the channel is opened.
- *short\_channel\_id* - as per BOLT 7 (representing the block,
transaction number and output index of the channel funding
transaction).
- *channel\_sat* - available satoshis on our nodes end of the channel
(values rounded down to satoshis as internal storage is in
millisatoshi).
- *our\_amount\_msat* - same as above, but in millisatoshis with
*msat* appended.
- *channel\_total\_sat* - total channel value in satoshi
- *amount\_msat* - same as above, but in millisatoshis with *msat*
appended.
- *funding\_txid* - funding transaction id.
- *funding\_output* - the index of the output in the funding
transaction.
AUTHOR
------
Felix <<fixone@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-newaddr(7), lightning-fundchannel(7), lightning-withdraw(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>