mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 06:41:44 +01:00
Code Issues Projects Releases Wiki Activity

doc/lightning-listchannels.7.md: Fix factual errors.

Browse source 
Changelog-Fixed: Fixed factual errors in `lightning-listchannels.7` documentation.

`delay` is ***not*** the unilateral close delay for that channel-direction!
This commit is contained in:
ZmnSCPxj jxPCSnmZ 2020-02-10 08:39:42 +08:00 • committed by Rusty Russell
parent e92ab89087
commit e6c486f87c
2 changed files with 16 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/lightning-listchannels.7 generated
View file

@ -66,18 +66,20 @@ settlement on-chain\.
channel_update message was received\.
.IP \[bu]
\fIbase_fee_millisatoshi\fR : The base fee (in millisatoshi) charged
for the HTLC (BOLT #2)\.
for the HTLC (BOLT #7; equivalent to \fBfee_base_msat\fR)\.
.IP \[bu]
\fIfee_per_millionth\fR : The amount (in millionths of a satoshi)
charged per transferred satoshi (BOLT #2)\.
charged per transferred satoshi (BOLT #7; equivalent to
\fBfee_proportional_millionths\fR)\.
.IP \[bu]
\fIdelay\fR : The number of blocks delay required to wait for on-chain
settlement when unilaterally closing the channel (BOLT #2)\.
\fIdelay\fR : The number of blocks of additional delay required when
forwarding an HTLC in this direction\. (BOLT #7; equivalent to
\fBcltv_expiry_delta\fR)\.
.IP \[bu]
\fIhtlc_minimum_msat\fR : The minimum payment which can be send
\fIhtlc_minimum_msat\fR : The minimum payment which can be sent
through this channel\.
.IP \[bu]
\fIhtlc_maximum_msat\fR : The maximum payment which can be send
\fIhtlc_maximum_msat\fR : The maximum payment which can be sent
through this channel\.
.RE
@ -111,16 +113,7 @@ Lightning RFC site
.RS
.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
.RE

17
doc/lightning-listchannels.7.md
View file

@ -52,14 +52,16 @@ settlement on-chain.
- *last\_update* : Unix timestamp (seconds) showing when the last
channel\_update message was received.
- *base\_fee\_millisatoshi* : The base fee (in millisatoshi) charged
for the HTLC (BOLT \#2).
for the HTLC (BOLT \#7; equivalent to `fee_base_msat`).
- *fee\_per\_millionth* : The amount (in millionths of a satoshi)
charged per transferred satoshi (BOLT \#2).
- *delay* : The number of blocks delay required to wait for on-chain
settlement when unilaterally closing the channel (BOLT \#2).
- *htlc\_minimum\_msat* : The minimum payment which can be send
charged per transferred satoshi (BOLT \#7; equivalent to
`fee_proportional_millionths`).
- *delay* : The number of blocks of additional delay required when
forwarding an HTLC in this direction. (BOLT \#7; equivalent to
`cltv_expiry_delta`).
- *htlc\_minimum\_msat* : The minimum payment which can be sent
through this channel.
- *htlc\_maximum\_msat* : The maximum payment which can be send
- *htlc\_maximum\_msat* : The maximum payment which can be sent
through this channel.
If *short\_channel\_id* or *source* is supplied and no matching channels
@ -87,8 +89,5 @@ Main web site: <https://github.com/ElementsProject/lightning>
Lightning RFC site
- BOLT \#2:
<https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md>
- BOLT \#7:
<https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md>