2.3 KiB

Raw Blame History

lightning-listnodes -- Command to get the list of nodes in the known network.

SYNOPSIS

listnodes [id]

DESCRIPTION

The listnodes command returns nodes the node has learned about via gossip messages, or a single one if the node id was specified.

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "listnodes",
  "params": {
    "id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a"
  }
}

RETURN VALUE

On success, an object containing nodes is returned. It is an array of objects, where each object contains:

nodeid (pubkey): the public key of the node
last_update (u32, optional): A node_announcement has been received for this node (UNIX timestamp)

If last_update is present:

alias (string): The fun alias this node advertized (up to 32 characters)
color (hex): The favorite RGB color this node advertized (always 6 characters)
features (hex): BOLT #9 features bitmap this node advertized
addresses (array of objects): The addresses this node advertized:
- type (string): Type of connection (one of "ipv4", "ipv6", "torv2", "torv3")
- address (string): address in expected format for type
- port (u16): port number comment: # (GENERATE-FROM-SCHEMA-END)

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

-32602: Error in given parameters.

EXAMPLE JSON RESPONSE

{
   "nodes": [
      {
         "nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a",
         "alias": "some_alias",
         "color": "68f442",
         "last_timestamp": 1597213741,
         "features": "02a2a1",
         "addresses": [
            {
               "type": "ipv4",
               "address": "zzz.yy.xx.xx",
               "port": 9735
            }
         ]
      }
    ]
}

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.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning comment: # ( SHA256STAMP:2f644d55512f5c03e3894341fb039fc1b7d2ebc5f210547fdb324d2f23689b37)

2.3 KiB Raw Blame History