mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +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.
71 lines
2.4 KiB
Groff
71 lines
2.4 KiB
Groff
.TH "LIGHTNING-SETCHANNELFEE" "7" "" "" "lightning-setchannelfee"
|
|
.SH NAME
|
|
lightning-setchannelfee - Command for setting specific routing fees on a lightning channel
|
|
.SH SYNOPSIS
|
|
|
|
\fBsetchannelfee\fR \fIid\fR [\fIbase\fR] [\fIppm\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBsetchannelfee\fR RPC command sets channel specific routing fees as
|
|
defined in BOLT #7\. The channel has to be in normal or awaiting state\.
|
|
This can be checked by \fBlistpeers\fR reporting a \fIstate\fR of
|
|
CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN for the channel\.
|
|
|
|
|
|
\fIid\fR is required and should contain a scid (short channel ID), channel
|
|
id or peerid (pubkey) of the channel to be modified\. If \fIid\fR is set to
|
|
"all", the fees for all channels are updated that are in state
|
|
CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN\.
|
|
|
|
|
|
\fIbase\fR is an optional value in millisatoshi that is added as base fee to
|
|
any routed payment\. If the parameter is left out, the global config
|
|
value fee-base will be used again\. It can be a whole number, or a whole
|
|
number ending in \fImsat\fR or \fIsat\fR, or a number with three decimal places
|
|
ending in \fIsat\fR, or a number with 1 to 11 decimal places ending in
|
|
\fIbtc\fR\.
|
|
|
|
|
|
\fIppm\fR is an optional value that is added proportionally per-millionths
|
|
to any routed payment volume in satoshi\. For example, if ppm is 1,000
|
|
and 1,000,000 satoshi is being routed trhough the channel, an
|
|
proportional fee of 1,000 satoshi is added, resulting in a 0\.1% fee\. If
|
|
the parameter is left out, the global config value will be used again\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object with the new values \fIbase\fR and \fIppm\fR along with an
|
|
array \fIchannels\fR which contains objects with fields \fIpeer_id\fR,
|
|
\fIchannel_id\fR and \fIshort_channel_id\fR\.
|
|
|
|
.SH ERRORS
|
|
|
|
The following error codes may occur:
|
|
|
|
.IP \[bu]
|
|
-1: Channel is in incorrect state, i\.e\. Catchall nonspecific error\.
|
|
.IP \[bu]
|
|
-32602: JSONRPC2_INVALID_PARAMS, i\.e\. Given id is not a channel ID
|
|
or short channel ID\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Michael Schmoock \fI<michael@schmoock.net\fR> is the author of this
|
|
feature\. Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly
|
|
responsible for the c-lightning project\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightningd-config\fR(5), \fBlightning-fundchannel\fR(7),
|
|
\fBlightning-listchannels\fR(7), \fBlightning-listpeers\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
.HL
|
|
|
|
Last updated 2019-04-30 17:34:18 CEST
|
|
|