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

lightning-listfunds -- Command showing all funds currently managed by the Core Lightning node
==========================================================================================

SYNOPSIS
--------

**listfunds** [*spent*]

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.

*spent* is a boolean: if true, then the *outputs* will include spent outputs
in addition to the unspent ones. Default is false.

RETURN VALUE
------------

[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **outputs** (array of objects):
  - **txid** (txid): the ID of the spendable transaction
  - **output** (u32): the index within *txid*
  - **amount_msat** (msat): the amount of the output
  - **scriptpubkey** (hex): the scriptPubkey of the output
  - **status** (string) (one of "unconfirmed", "confirmed", "spent")
  - **reserved** (boolean): whether this UTXO is currently reserved for an in-flight tx
  - **address** (string, optional): the bitcoin address of the output
  - **redeemscript** (hex, optional): the redeemscript, only if it's p2sh-wrapped

  If **status** is "confirmed":
    - **blockheight** (u32): Block height where it was confirmed

  If **reserved** is "true":
    - **reserved_to_block** (u32): Block height where reservation will expire
- **channels** (array of objects):
  - **peer_id** (pubkey): the peer with which the channel is opened
  - **our_amount_msat** (msat): available satoshis on our node's end of the channel
  - **amount_msat** (msat): total channel value
  - **funding_txid** (txid): funding transaction id
  - **funding_output** (u32): the 0-based index of the output in the funding transaction
  - **connected** (boolean): whether the channel peer is connected
  - **state** (string): the channel state, in particular "CHANNELD_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN")

  If **state** is "CHANNELD_NORMAL":
    - **short_channel_id** (short_channel_id): short channel id of channel

  If **state** is "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN" or "ONCHAIN":
    - **short_channel_id** (short_channel_id, optional): short channel id of channel (only if funding reached lockin depth before closing)

[comment]: # (GENERATE-FROM-SCHEMA-END)

AUTHOR
------

Felix <<fixone@gmail.com>> is mainly responsible.

SEE ALSO
--------

lightning-newaddr(7), lightning-fundchannel(7), lightning-withdraw(7), lightning-listtransactions(7)

RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

[comment]: # ( SHA256STAMP:61be4b00c0485edccb986e1f066cf18a5c9fdb8bca94adc12f0a87a36041a93a)
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-04-06 07:09:48 +02:00			`lightning-listfunds -- Command showing all funds currently managed by the Core Lightning node`
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-08-31 14:30:56 +02:00			`==========================================================================================`
doc/manpages: replace asciidoc by markdown 2019-08-10 01:54:18 +02:00
			`SYNOPSIS`
			`--------`

Remove useless \ 2022-01-26 18:18:49 +01:00			`listfunds [spent]`
doc/manpages: replace asciidoc by markdown 2019-08-10 01:54:18 +02:00
			`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.`

Added spent option to listfunds Changelog-Added: JSON-RPC: The `listfunds` method now includes spent outputs if the `spent` parameter is set to true. 2020-12-22 08:03:15 +01:00			`spent is a boolean: if true, then the outputs will include spent outputs`
			`in addition to the unspent ones. Default is false.`

doc/manpages: replace asciidoc by markdown 2019-08-10 01:54:18 +02:00			`RETURN VALUE`
			`------------`

doc/schemas: listfunds Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-06-16 03:06:17 +02:00			`[comment]: # (GENERATE-FROM-SCHEMA-START)`
			`On success, an object is returned, containing:`
			`- outputs (array of objects):`
			`- txid (txid): the ID of the spendable transaction`
			`- output (u32): the index within txid`
			`- amount_msat (msat): the amount of the output`
			`- scriptpubkey (hex): the scriptPubkey of the output`
			`- status (string) (one of "unconfirmed", "confirmed", "spent")`
Restore description of "reserved" field for listfunds It was lost in 2296d4452f7ba5f112fbf5700974a31dadb66fb4. 2022-05-14 09:31:10 +02:00			`- reserved (boolean): whether this UTXO is currently reserved for an in-flight tx`
doc/schemas: listfunds Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-06-16 03:06:17 +02:00			`- address (string, optional): the bitcoin address of the output`
			`- redeemscript (hex, optional): the redeemscript, only if it's p2sh-wrapped`

			`If status is "confirmed":`
			`- blockheight (u32): Block height where it was confirmed`

			`If reserved is "true":`
			`- reserved_to_block (u32): Block height where reservation will expire`
			`- channels (array of objects):`
			`- peer_id (pubkey): the peer with which the channel is opened`
fix UnicodeDecodeError in doc/lightning-listfunds.7.md 2022-02-04 11:01:00 +01:00			`- our_amount_msat (msat): available satoshis on our node's end of the channel`
doc/schemas: listfunds Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-06-16 03:06:17 +02:00			`- amount_msat (msat): total channel value`
			`- funding_txid (txid): funding transaction id`
			`- funding_output (u32): the 0-based index of the output in the funding transaction`
			`- connected (boolean): whether the channel peer is connected`
			`- state (string): the channel state, in particular "CHANNELD_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN")`

			`If state is "CHANNELD_NORMAL":`
			`- short_channel_id (short_channel_id): short channel id of channel`

			`If state is "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN" or "ONCHAIN":`
			`- short_channel_id (short_channel_id, optional): short channel id of channel (only if funding reached lockin depth before closing)`
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-09-03 12:07:59 +02:00
doc/schemas: listfunds Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-06-16 03:06:17 +02:00			`[comment]: # (GENERATE-FROM-SCHEMA-END)`
doc/manpages: replace asciidoc by markdown 2019-08-10 01:54:18 +02:00
			`AUTHOR`
			`------`

			`Felix <<fixone@gmail.com>> is mainly responsible.`

			`SEE ALSO`
			`--------`

added documentation of commands listnodes, sendpsbt Some grammar mistake was fixed as suggest and more command docs were added. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 2020-08-13 18:19:35 +02:00			`lightning-newaddr(7), lightning-fundchannel(7), lightning-withdraw(7), lightning-listtransactions(7)`
doc/manpages: replace asciidoc by markdown 2019-08-10 01:54:18 +02:00
			`RESOURCES`
			`---------`

			`Main web site: <https://github.com/ElementsProject/lightning>`
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2020-08-25 03:33:16 +02:00
make-schema: don't include tools/fromschema.py in SHASUMS We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables 2022-07-13 17:45:39 +02:00			`[comment]: # ( SHA256STAMP:61be4b00c0485edccb986e1f066cf18a5c9fdb8bca94adc12f0a87a36041a93a)`