mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
716a3b11a5
core-lightning/doc/lightning-listfunds.7.md
Christian Decker c3254e6639 docs: Update manpages to be recognized correctly by mrkd 
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.
2019-09-02 16:31:36 +02:00

1.9 KiB
Raw Blame 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 node’s 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