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

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-GETINFO(7)	       lightning-getinfo	  LIGHTNING-GETINFO(7)

NAME
       lightning-getinfo  -  Command  to  receive all information about	the c-
       lightning node.

SYNOPSIS
       getinfo

DESCRIPTION
       The getinfo gives a summary of the current running node.

EXAMPLE	JSON REQUEST
	      {
		"id": 82,
		"method": "getinfo",
		"params": {}
	      }

RETURN VALUE
       On success, an object is	returned, containing:

	      o	     id	(pubkey): The public key unique	to this	node

	      o	     alias (string): The fun alias this	 node  will  advertize
		     (up to 32 characters)

	      o	     color (hex): The favorite RGB color this node will	adver-
		     tize (always 6 characters)

	      o	     num_peers (u32): The total	count of peers,	 connected  or
		     with channels

	      o	     num_pending_channels  (u32):  The total count of channels
		     being opened

	      o	     num_active_channels (u32):	The total count	of channels in
		     normal state

	      o	     num_inactive_channels  (u32): The total count of channels
		     waiting for opening or closing transactions to be mined

	      o	     version (string): Identifies what bugs  you  are  running
		     into

	      o	     lightning-dir (string): Identifies	where you can find the
		     configuration and other related files

	      o	     blockheight (u32):	The highest block height we've learned

	      o	     network (string): represents the type of network  on  the
		     node are working (e.g: bitcoin, testnet, or regtest)

	      o	     fees_collected_msat  (msat): Total	routing	fees collected
		     by	this node

	      o	     address (array of objects,	optional):  The	 addresses  we
		     announce to the world:

		     o	    type  (string): Type of connection (one of "ipv4",
			    "ipv6", "torv2", "torv3")

		     o	    address (string): address in expected  format  for
			    type

		     o	    port (u16):	port number

	      o	     binding  (array  of  objects, optional): The addresses we
		     are listening on:

		     o	    type (string): Type	of connection (one  of	"local
			    socket", "ipv4", "ipv6", "torv2", "torv3")

		     o	    address  (string,  optional):  address in expected
			    format for type

		     o	    port (u16, optional): port number

		     o	    socket (string, optional): socket  filename	 (only
			    if type is "local socket")

       The following warnings may also be returned:

	      o	     warning_bitcoind_sync:  Bitcoind  is  not up-to-date with
		     network.

	      o	     warning_lightningd_sync: Lightningd is still loading lat-
		     est blocks	from bitcoind.

       On failure, one of the following	error codes may	be returned:

	      o	     -32602:  Error in given parameters	or some	error happened
		     during the	command	process.

EXAMPLE	JSON RESPONSE
	      {
		 "id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d",
		 "alias": "SLICKERGOPHER",
		 "color": "02bf81",
		 "num_peers": 0,
		 "num_pending_channels": 0,
		 "num_active_channels":	0,
		 "num_inactive_channels": 0,
		 "address": [
		    {
		       "type": "torv3",
		       "address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion",
		       "port": 9736
		    },
		    {
		       "type": "torv3",
		       "address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion",
		       "port": 9736
		    }
		 ],
		 "binding": [
		    {
		       "type": "ipv4",
		       "address": "127.0.0.1",
		       "port": 9736
		    }
		 ],
		 "version": "0.9.0",
		 "blockheight":	644297,
		 "network": "bitcoin",
		 "msatoshi_fees_collected": 0,
		 "fees_collected_msat":	"0msat",
		 "lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin"
	      }

AUTHOR
       Vincenzo	Palazzo	_vincenzo.palazzo@protonmail.com>  wrote  the  initial
       version of this man page, but many others did the hard work of actually
       implementing this rpc command.

SEE ALSO
       lightning-connect(7),   lightning-fundchannel(7),    lightning-listcon-
       figs(7).

RESOURCES
       Main web	site: https://github.com/ElementsProject/lightning

							  LIGHTNING-GETINFO(7)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLE JSON REQUEST | RETURN VALUE | EXAMPLE JSON RESPONSE | AUTHOR | SEE ALSO | RESOURCES

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

home | help