Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListchannelsRequest

The listchannels RPC command returns data on channels that are known to the node. Because channels may be bidirectional, up to 2 objects will be returned for each channel (one for each direction).

If short_channel_id is a short channel id, then only known channels with a matching short_channel_id are returned. Otherwise, it must be null.

If source is a node id, then only channels leading from that node id are returned.

If destination is a node id, then only channels leading to that node id are returned.

Only one of short_channel_id, source or destination can be supplied. If nothing is supplied, data on all lightning channels known to this node, are returned. These can be local channels or public channels broadcast on the gossip network.

Hierarchy

  • ListchannelsRequest

Index

Properties

destination?: string
short_channel_id?: string
source?: string

Generated using TypeDoc