mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
135 lines
3.8 KiB
Groff
Generated
135 lines
3.8 KiB
Groff
Generated
.TH "LIGHTNING-LISTCHANNELS" "7" "" "" "lightning-listchannels"
|
|
.SH NAME
|
|
lightning-listchannels - Command to query active lightning channels in the entire network
|
|
.SH SYNOPSIS
|
|
|
|
\fBlistchannels\fR [\fIshort_channel_id\fR] [\fIsource\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBlistchannels\fR 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 \fIshort_channel_id\fR is supplied, then only known channels with a
|
|
matching \fIshort_channel_id\fR are returned\.
|
|
|
|
|
|
If \fIsource\fR is supplied, then only channels leading from that node id
|
|
are returned\.
|
|
|
|
|
|
If neither 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\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object with a "channels" key is returned containing a
|
|
list of 0 or more objects\.
|
|
|
|
|
|
Each object in the list contains the following data:
|
|
|
|
.IP \[bu]
|
|
\fIsource\fR : The node providing entry to the channel, specifying the
|
|
fees charged for using the channel in that direction\.
|
|
.IP \[bu]
|
|
\fIdestination\fR : The node providing the exit point for the channel\.
|
|
.IP \[bu]
|
|
\fIshort_channel_id\fR : The channel identifier\.
|
|
.IP \[bu]
|
|
\fIpublic\fR : Boolean value, is publicly available\. Non-local channels
|
|
will only ever have this value set to true\. Local channels are
|
|
side-loaded by this node, rather than obtained through the gossip
|
|
network, and so may have this value set to false\.
|
|
.IP \[bu]
|
|
\fIsatoshis\fR : Funds available in the channel\.
|
|
.IP \[bu]
|
|
\fIamount_sat\fR : Same as above, but ending in \fIsat\fR\.
|
|
.IP \[bu]
|
|
\fImessage_flags\fR : Bitfield showing the presence of optional fields
|
|
in the \fIchannel_update\fR message (BOLT #7)\.
|
|
.IP \[bu]
|
|
\fIchannel_flags\fR : Bitfields indicating the direction of the channel
|
|
and signaling various options concerning the channel\. (BOLT #7)\.
|
|
.IP \[bu]
|
|
\fIactive\fR : Boolean value, is available for routing\. This is linked
|
|
to the channel flags data, where if the second bit is set, signals a
|
|
channels temporary unavailability (due to loss of connectivity) OR
|
|
permanent unavailability where the channel has been closed but not
|
|
settlement on-chain\.
|
|
.IP \[bu]
|
|
\fIlast_update\fR : Unix timestamp (seconds) showing when the last
|
|
channel_update message was received\.
|
|
.IP \[bu]
|
|
\fIbase_fee_millisatoshi\fR : The base fee (in millisatoshi) charged
|
|
for the HTLC (BOLT #2)\.
|
|
.IP \[bu]
|
|
\fIfee_per_millionth\fR : The amount (in millionths of a satoshi)
|
|
charged per transferred satoshi (BOLT #2)\.
|
|
.IP \[bu]
|
|
\fIdelay\fR : The number of blocks delay required to wait for on-chain
|
|
settlement when unilaterally closing the channel (BOLT #2)\.
|
|
.IP \[bu]
|
|
\fIhtlc_minimum_msat\fR : The minimum payment which can be send
|
|
through this channel\.
|
|
.IP \[bu]
|
|
\fIhtlc_maximum_msat\fR : The maximum payment which can be send
|
|
through this channel\.
|
|
|
|
|
|
If \fIshort_channel_id\fR or \fIsource\fR is supplied and no matching channels
|
|
are found, a "channels" object with an empty list is returned\.
|
|
|
|
.SH ERRORS
|
|
|
|
If \fIshort_channel_id\fR is not a valid short_channel_id, an error
|
|
message will be returned:
|
|
|
|
.nf
|
|
.RS
|
|
{ "code" : -32602,
|
|
"message" : "'short_channel_id' should be a short channel id, not '...'" }
|
|
|
|
|
|
.RE
|
|
|
|
.fi
|
|
|
|
Similarly if \fIsource\fR is not a valid pubkey\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Michael Hawkins \fI<michael.hawkins@protonmail.com\fR>\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-fundchannel\fR(7), \fBlightning-listnodes\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
|
|
Lightning RFC site
|
|
|
|
.IP \[bu]
|
|
|
|
BOLT #2:
|
|
\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md\fR
|
|
|
|
|
|
.IP \[bu]
|
|
|
|
BOLT #7:
|
|
\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md\fR
|
|
|
|
|
|
|
|
.HL
|
|
|
|
Last updated 2019-06-12 11:16:20 CEST
|
|
|