2022-04-06 06:09:48 +01:00
lightning-listfunds -- Command showing all funds currently managed by the Core Lightning node
2019-08-31 13:30:56 +01:00
==========================================================================================
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
2022-01-26 17:18:49 +00:00
**listfunds** [*spent*]
2019-08-10 00:54:18 +01: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.
2020-12-22 07:03:15 +00:00
*spent* is a boolean: if true, then the *outputs* will include spent outputs
in addition to the unspent ones. Default is false.
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
2021-06-16 02:06:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
2022-09-05 22:33:09 +01:00
2021-06-16 02:06:17 +01:00
- **outputs** (array of objects):
- **txid** (txid): the ID of the spendable transaction
- **output** (u32): the index within *txid*
2022-09-05 22:45:06 +01:00
- **amount\_msat** (msat): the amount of the output
2021-06-16 02:06:17 +01:00
- **scriptpubkey** (hex): the scriptPubkey of the output
2022-10-17 20:59:57 +01:00
- **status** (string) (one of "unconfirmed", "confirmed", "spent", "immature")
2022-05-14 08:31:10 +01:00
- **reserved** (boolean): whether this UTXO is currently reserved for an in-flight tx
2021-06-16 02:06:17 +01: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":
2022-09-05 22:33:09 +01:00
2021-06-16 02:06:17 +01:00
- **blockheight** (u32): Block height where it was confirmed
If **reserved** is "true":
2022-09-05 22:33:09 +01:00
2022-09-05 22:45:06 +01:00
- **reserved\_to\_block** (u32): Block height where reservation will expire
2021-06-16 02:06:17 +01:00
- **channels** (array of objects):
2022-09-05 22:45:06 +01:00
- **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
2021-06-16 02:06:17 +01:00
- **connected** (boolean): whether the channel peer is connected
2022-11-11 02:03:13 +00:00
- **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")
2023-03-24 08:04:31 +00:00
- **channel\_id** (hash): The full channel\_id (funding txid Xored with output number) *(added v23.05)*
2021-06-16 02:06:17 +01:00
2022-11-11 02:03:13 +00:00
If **state** is "CHANNELD\_NORMAL":
2022-09-05 22:33:09 +01:00
2022-09-08 02:08:00 +01:00
- **short\_channel\_id** (short\_channel\_id): short channel id of channel
2021-06-16 02:06:17 +01:00
2022-11-11 02:03:13 +00:00
If **state** is "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN" or "ONCHAIN":
2022-09-05 22:33:09 +01:00
2022-09-08 02:08:00 +01:00
- **short\_channel\_id** (short\_channel\_id, optional): short channel id of channel (only if funding reached lockin depth before closing)
2021-09-03 11:07:59 +01:00
2021-06-16 02:06:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2019-08-10 00:54:18 +01:00
AUTHOR
------
Felix < < fixone @ gmail . com > > is mainly responsible.
SEE ALSO
--------
2020-08-13 17:19:35 +01:00
lightning-newaddr(7), lightning-fundchannel(7), lightning-withdraw(7), lightning-listtransactions(7)
2019-08-10 00:54:18 +01:00
RESOURCES
---------
Main web site: < https: / / github . com / ElementsProject / lightning >
2020-08-25 02:33:16 +01:00
2023-03-24 08:04:31 +00:00
[comment]: # ( SHA256STAMP:02deef0c91e587aafe3a4b75fa45075c7246566b4baf1e73e00564d36d5a38f4)