vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-feerates.7.md

125 lines
5.7 KiB
Markdown
Raw Permalink Normal View History

doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
lightning-feerates -- Command for querying recommended onchain feerates
=======================================================================
SYNOPSIS
--------
**feerates** *style*
DESCRIPTION
-----------
docs: Update references from c-lightning to Core-Lightning
2022-05-13 16:54:36 +01:00
The **feerates** command returns the feerates that CLN will use.
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
The feerates will be based on the recommended feerates from the backend.
The backend may fail to provide estimates, but if it was able to provide
docs: Update references from c-lightning to Core-Lightning
2022-05-13 16:54:36 +01:00
estimates in the past, CLN will continue to use those for a while.
CLN will also smoothen feerate estimations from the backend.
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
*style* is either of the two strings:
* *perkw* - provide feerate in units of satoshis per 1000 weight.
* *perkb* - provide feerate in units of satoshis per 1000 virtual bytes.
Bitcoin transactions have non-witness and witness bytes:
* Non-witness bytes count as 4 weight, 1 virtual byte.
All bytes other than SegWit witness count as non-witness bytes.
* Witness bytes count as 1 weight, 0.25 virtual bytes.
Thus, all *perkb* feerates will be exactly 4 times *perkw* feerates.
To compute the fee for a transaction, multiply its weight or virtual bytes
by the appropriate *perkw* or *perkw* feerate
returned by this command,
then divide by 1000.
There is currently no way to change these feerates from the RPC.
If you need custom control over onchain feerates,
you will need to provide your own plugin
that replaces the `bcli` plugin backend.
For commands like lightning-withdraw(7) or lightning-fundchannel(7) you
can provide a preferred feerate directly as a parameter,
which will override the recommended feerates returned by **feerates**.
RETURN VALUE
------------
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
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 22:33:09 +01:00
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
- **perkb** (object, optional): If *style* parameter was perkb:
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 22:45:06 +01:00
- **min\_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend
- **max\_acceptable** (u32): The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet).
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
- **opening** (u32, optional): Default feerate for lightning-fundchannel(7) and lightning-withdraw(7)
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 22:45:06 +01:00
- **mutual\_close** (u32, optional): Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer.
fromschema.py: escape underscores in descriptions
2022-11-11 02:03:13 +00:00
- **unilateral\_close** (u32, optional): Feerate for commitment\_transaction in a live channel which we originally funded
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 22:45:06 +01:00
- **delayed\_to\_us** (u32, optional): Feerate for returning unilateral close funds to our wallet
- **htlc\_resolution** (u32, optional): Feerate for returning unilateral close HTLC outputs to our wallet
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
- **penalty** (u32, optional): Feerate to start at when penalizing a cheat attempt
- **perkw** (object, optional): If *style* parameter was perkw:
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 22:45:06 +01:00
- **min\_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend
- **max\_acceptable** (u32): The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet).
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
- **opening** (u32, optional): Default feerate for lightning-fundchannel(7) and lightning-withdraw(7)
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 22:45:06 +01:00
- **mutual\_close** (u32, optional): Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer.
fromschema.py: escape underscores in descriptions
2022-11-11 02:03:13 +00:00
- **unilateral\_close** (u32, optional): Feerate for commitment\_transaction in a live channel which we originally funded
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 22:45:06 +01:00
- **delayed\_to\_us** (u32, optional): Feerate for returning unilateral close funds to our wallet
- **htlc\_resolution** (u32, optional): Feerate for returning unilateral close HTLC outputs to our wallet
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
- **penalty** (u32, optional): Feerate to start at when penalizing a cheat attempt
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 22:45:06 +01:00
- **onchain\_fee\_estimates** (object, optional):
- **opening\_channel\_satoshis** (u64): Estimated cost of typical channel open
- **mutual\_close\_satoshis** (u64): Estimated cost of typical channel close
- **unilateral\_close\_satoshis** (u64): Estimated cost of typical unilateral close (without HTLCs)
- **htlc\_timeout\_satoshis** (u64): Estimated cost of typical HTLC timeout transaction
- **htlc\_success\_satoshis** (u64): Estimated cost of typical HTLC fulfillment transaction
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
The following warnings may also be returned:
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 22:33:09 +01:00
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 22:45:06 +01:00
- **warning\_missing\_feerates**: Some fee estimates are missing
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 11:07:59 +01:00
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
ERRORS
------
The **feerates** command will never error,
however some fields may be missing in the result
if feerate estimates for that kind of transaction are unavailable.
NOTES
-----
Many other commands have a *feerate* parameter, which can be the strings
*urgent*, *normal*, or *slow*.
These are mapped to the **feerates** outputs as:
* *urgent* - equal to *unilateral\_close*
* *normal* - equal to *opening*
* *slow* - equal to *min\_acceptable*.
TRIVIA
------
In C-lightning we like to call the weight unit "sipa"
in honor of Pieter Wuille,
who uses the name "sipa" on IRC and elsewhere.
Internally we call the *perkw* style as "feerate per kilosipa".
AUTHOR
------
doc: fix lightning-config(5) -> lightningd-config(5) < <email> > -> <<email>> in markdown files
2021-06-29 15:34:20 +01:00
ZmnSCPxj <<ZmnSCPxj@protonmail.com>> wrote the initial version of this
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
manpage.
SEE ALSO
--------
chaintopology: new command 'parsefeerate' Useful for parsing a passed in feerate before calling lightningd with it, e.g. when you need to know what the feerate is for a fundpsbt before calling fundpsbt Changelog-Added: JSON-RPC: new command `parsefeerate` which takes a feerate string and returns the calculated perkw/perkb
2021-06-23 20:31:47 +01:00
lightning-parsefeerate(7), lightning-fundchannel(7), lightning-withdraw(7),
doc: escape more naughty underscores The only time underscores aren't special in Markdown is when they appear in preformatted text. We have gotten away with not escaping underscores where an asterisk-enclosed span or the paragraph ends before the next underscore appears, but this is fragile and bad practice. Conversely, there are many places where we have not escaped underscores but needed to. Escape all underscores that do not appear in preformatted blocks or preformatted spans and are not themselves delineating emphasized spans. The changes in this commit are exactly the result of executing the following Bash code: ```bash e=':x;' # begin loop e+='s/^' # anchor match at beginning of line e+='(' # begin capturing subexpression e+='(' # begin list of alternatives e+='[^`_\\]|' # any mundane character, or e+='`([^`\\]|\\.)*`|' # backtick-enclosed span, or e+='\b_|_\b|' # underscore at boundary, or e+='\\.' # backslash-escaped character e+=')*' # any number of the preceding alternatives e+=')' # end capturing subexpression e+='\B_\B/\1\\_/;' # escape non-formatting underscore e+='tx' # repeat loop if we escaped an underscore escape_underscores=( sed # use extended regular expressions -E # skip over indented blocks (following an empty line) -e '/^$/{:i;n;/^( {4,}|\t)/bi}' # skip over preformatted blocks -e '/^\s*```/,/^\s*```/{p;d}' # skip over generated sections -e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}' # escape underscores -e "${e}" ) "${escape_underscores[@]}" -i doc/*.[0-9].md ``` Changelog-None
2022-11-11 01:44:56 +00:00
lightning-txprepare(7), lightning-fundchannel\_start(7).
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
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 02:33:16 +01:00
docs: handle "added": "version" and "deprecated": "version" from schemas. This means we will document deprecations and additions, rather than just pretending they've always been that way! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-09 23:51:01 +00:00
[comment]: # ( SHA256STAMP:4b1fa6f6ac4a6f9218486d9b42c8bc684fd48ad615b5644a0cd6650719d32a78)