LIGHTNING-GETINFO(7)

πŸ“¦
version 26.06.9 Β· 2 versions
, in nixpkgs unstable

πŸ’… LIGHTNING-GETINFO(7) β€” the glow-up

okay so bestie, welcome to lightning-getinfo(7), the getinfo command page ✨


🌸 NAME

getinfo β€” the command that gives you all the tea about your Core Lightning node πŸ”₯


πŸŽ€ SYNOPSIS

getinfo

πŸ’– DESCRIPTION

getinfo gives a summary of the current running node. that's it, that's the vibe β€” one call, whole personality revealed πŸ’…


✨ RETURN VALUE

on success, you get an object back, containing:

  • id (pubkey) β€” the public key that's unique to this node 🫢
  • alias (string) (up to 32 characters) β€” the fun alias this node will advertize πŸŽ€
  • color (hex) (always 6 characters) β€” the favorite RGB color this node will advertize 🌈
  • num_peers (u32) β€” the total count of peers, connected or with channels πŸ‘―
  • num_pending_channels (u32) β€” the total count of channels being opened ⏳
  • num_active_channels (u32) β€” the total count of channels in normal state βœ…
  • num_inactive_channels (u32) β€” the total count of channels waiting for opening or closing transactions to be mined 😴
  • version (string) β€” identifies what bugs you are running into πŸ’€ (their words, not mine, but iconic)
  • lightning-dir (string) β€” identifies where you can find the configuration and other related files πŸ—‚οΈ
  • blockheight (u32) β€” the highest block height we've learned πŸ“ˆ
  • network (string) β€” represents the type of network on the node are working (e.g: bitcoin, testnet, or regtest) 🌍
  • fees_collected_msat (msat) β€” total routing fees collected by this node πŸ’°
  • address (array of objects) β€” the addresses we announce to the world 🌐 (added v23.02):
    • type (string) (one of "dns", "ipv4", "ipv6", "torv2", "torv3") β€” type of connection (until 23.08, websocket was also allowed). (added v23.02)
    • port (u16) β€” port number. (added v23.02)

if type is "dns", "ipv4", "ipv6", "torv2" or "torv3": - address (string): address in expected format for type. (added v23.02)

  • our_features (object, optional) β€” our BOLT #9 feature bits (as hexstring) for various contexts.:
    • init (hex) β€” features (incl. globalfeatures) in our init message, these also restrict what we offer in open_channel or accept in accept_channel.
    • node (hex) β€” features in our node_announcement message.
    • channel (hex) β€” negotiated channel features we (as channel initiator) publish in the channel_announcement message.
    • invoice (hex) β€” features in our BOLT11 invoices.
  • binding (array of objects, optional) β€” the addresses we are listening on.:
    • type (string) (one of "local socket", "websocket", "ipv4", "ipv6", "torv2", "torv3") β€” type of connection.
    • address (string, optional) β€” address in expected format for type.
    • port (u16, optional) β€” port number.

if type is "local socket": - socket (string): socket filename.

if type is "websocket": - subtype (string): type of address.


the following warnings may also be returned πŸ‘€

  • warning_bitcoind_sync β€” bitcoind is not up-to-date with network. 😬
  • warning_lightningd_sync β€” lightningd is still loading latest blocks from bitcoind. 🫠

πŸ’€ ERRORS

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

  • -32602 β€” error in given parameters or some error happened during the command process. 😭

πŸ‘‘ 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. giving credit where credit is due, periodt 🫢


πŸ¦‹ SEE ALSO

lightning-connect(7), lightning-fundchannel(7), lightning-listconfigs(7)


🌟 RESOURCES

main web site: https://github.com/ElementsProject/lightning


πŸ“ EXAMPLES

example 1:

request:

$ lightning-cli getinfo

{
  "id": "example:getinfo#1",
  "method": "getinfo",
  "params": {}
}

response:

{
  "id": "nodeid020202020202020202020202020202020202020202020202020202020202",
  "alias": "SILENTARTIST",
  "color": "022d22",
  "num_peers": 0,
  "num_pending_channels": 0,
  "num_active_channels": 0,
  "num_inactive_channels": 0,
  "address": [],
  "binding": [
    {
      "type": "ipv4",
      "address": "127.0.0.1",
      "port": 19735
    }
  ],
  "version": "v25.05",
  "blockheight": 110,
  "network": "regtest",
  "fees_collected_msat": 0,
  "lightning-dir": "/tmp/.lightning/regtest",
  "our_features": {
    "init": "0898882a8a59a1",
    "node": "8898882a8a59a1",
    "channel": "",
    "invoice": "02000002024100"
  }
}

ngl bestie, "alias": "SILENTARTIST" with zero peers is such main character energy πŸ’€βœ¨

mwah, that's the whole page! this one's from Core Lightning v26.06.9, and the page itself is dated LIGHTNING-GETINFO(7) β€” go forth and getinfo responsibly, ily πŸ«ΆπŸ’–

πŸ“¦ where this page comes from