mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
d8320f015f
core-lightning/doc/lightning-listchannels.7.md

84 lines
3.3 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd 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.
2019-08-31 14:30:56 +02:00
lightning-listchannels -- Command to query active lightning channels in the entire network
==========================================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**listchannels** [*short\_channel\_id*] [*source*] [*destination*]
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
DESCRIPTION
-----------
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).
Use of null I added a hint how to specify source but not short channel id.
2020-03-06 05:41:46 +01:00
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.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
Use of null I added a hint how to specify source but not short channel id.
2020-03-06 05:41:46 +01:00
If *source* is a node id, then only channels leading from that node id
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
are returned.
doc: listchannels filter by destination
2021-06-22 15:42:39 +02:00
If *destination* is a node id, then only channels leading to that node id
are returned.
corrected typo in description
2022-04-20 10:08:54 +02:00
Only one of *short\_channel\_id*, *source* or *destination* can be supplied.
doc: listchannels filter by destination
2021-06-22 15:42:39 +02:00
If nothing is supplied, data on all lightning channels known to this
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
node, are returned. These can be local channels or public channels
broadcast on the gossip network.
RETURN VALUE
------------
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **channels** is returned. It is an array of objects, where each object contains:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:33:09 +02:00
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
- **source** (pubkey): the source node
- **destination** (pubkey): the destination node
doc: escape output types (esp `short_channel_id`). We can also remove the listpeers closer hack, which was removed from the schema already. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 03:08:00 +02:00
- **short\_channel\_id** (short\_channel\_id): short channel id of channel
plugins/topology: add direction field to listchannels. It's a core concept in the spec which isn't directly exposed. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `listchannels` added a `direction` field (0 or 1) as per gossip specification.
2023-01-30 07:07:03 +01:00
- **direction** (u32): direction (0 if source < destination, 1 otherwise).
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
- **public** (boolean): true if this is announced (otherwise it must be our channel)
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:45:06 +02:00
- **amount\_msat** (msat): the total capacity of this channel (always a whole number of satoshis)
- **message\_flags** (u8): as defined by BOLT #7
- **channel\_flags** (u8): as defined by BOLT #7
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
- **active** (boolean): true unless source has disabled it, or it's a local channel and the peer is disconnected or it's still opening or closing
fromschema.py: escape underscores in descriptions
2022-11-11 03:03:13 +01:00
- **last\_update** (u32): UNIX timestamp on the last channel\_update from *source*
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:45:06 +02:00
- **base\_fee\_millisatoshi** (u32): Base fee changed by *source* to use this channel
- **fee\_per\_millionth** (u32): Proportional fee changed by *source* to use this channel, in parts-per-million
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
- **delay** (u32): The number of blocks delay required by *source* to use this channel
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:45:06 +02:00
- **htlc\_minimum\_msat** (msat): The smallest payment *source* will allow via this channel
make-schema: don't include tools/fromschema.py in SHASUMS We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
2022-07-13 17:45:39 +02:00
- **features** (hex): BOLT #9 features bitmap for this channel
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:45:06 +02:00
- **htlc\_maximum\_msat** (msat, optional): The largest payment *source* will allow via this channel
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
doc/schemas: getsharedsecret, help, invoice, listchannels, listforwards And a new "u8" type. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:05:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
doc: listchannels filter by destination
2021-06-22 15:42:39 +02:00
If one of *short\_channel\_id*, *source* or *destination* is supplied and no
matching channels are found, a "channels" object with an empty list is returned.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
doc: unify man pages error sections Change all man pages to follow the style of doc/lightning-pay.7.md for the section on returning errors. Changelog-None
2020-01-07 17:59:24 +01:00
On error the returned object will contain `code` and `message` properties,
with `code` being one of the following:
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
doc: unify man pages error sections Change all man pages to follow the style of doc/lightning-pay.7.md for the section on returning errors. Changelog-None
2020-01-07 17:59:24 +01:00
- -32602: If the given parameters are wrong.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
AUTHOR
------
Michael Hawkins <<michael.hawkins@protonmail.com>>.
SEE ALSO
--------
lightning-fundchannel(7), lightning-listnodes(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
Lightning RFC site
- BOLT \#7:
doc: update references to old BOLTs repo. This reveals that common/test/run-bolt12_merkle-json.c was broken! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-29 05:49:03 +02:00
<https://github.com/lightning/bolts/blob/master/07-routing-gossip.md>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 03:33:16 +02:00
doc/schemas: fix old deprecations. `"deprecated": true` is obsolete; we don't document them anyway. Where it would have otherwise changed the GRPC wrappers, I actually put the version number in. We allow "listchannels" to have "satoshis" since we have some tests that run in deprecated-api mode. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:18 +01:00
[comment]: # ( SHA256STAMP:cef9786aeca2eddaca0d1adf6dc3d0eef442297e0f63d7c49647e65dbca73396)
Reference in New Issue Copy Permalink