Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-LISTFUNDS(7)	      lightning-listfunds	LIGHTNING-LISTFUNDS(7)

NAME
       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  un-
       spent  outputs  (UTXOs)	in the internal	wallet or funds	locked in cur-
       rently 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:

	      o	     txid

	      o	     output (the index of the output in	the transaction)

	      o	     value (the	output value in	satoshis)

	      o	     amount_msat (the same as value, but in millisatoshi  with
		     msat appended)

	      o	     address

	      o	     scriptpubkey (the ScriptPubkey of the output, in hex)

	      o	     redeemscript  (the	 redeemscript  of  the output, in hex,
		     only if it's p2sh-wrapped)

	      o	     status (whether unconfirmed, confirmed, or	spent)

	      o	     reserved (whether this is UTXO is currently reserved  for
		     an	in-flight tx)

       Each entry in channels will include:

	      o	     peer_id - the peer	with which the channel is opened.

	      o	     short_channel_id -	as per BOLT 7 (representing the	block,
		     transaction number	and output index of the	channel	 fund-
		     ing transaction).

	      o	     channel_sat - available satoshis on our nodeas end	of the
		     channel (values rounded  down  to	satoshis  as  internal
		     storage is	in millisatoshi).

	      o	     our_amount_msat  -	 same  as  above, but in millisatoshis
		     with msat appended.

	      o	     channel_total_sat - total channel value in	satoshi

	      o	     amount_msat - same	as above, but  in  millisatoshis  with
		     msat appended.

	      o	     funding_txid - funding transaction	id.

	      o	     funding_output  -	the index of the output	in the funding
		     transaction.

	      o	     connected - whether the channel peer is connected.

	      o	     state - the channel state,	in particular  CHANNELD_NORMAL
		     means the channel can be used normally.

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

							LIGHTNING-LISTFUNDS(7)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO | RESOURCES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=lightning-listfunds&sektion=7&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help