lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: setchannelfee 'all' feature

issue-2504
Michael Schmoock 6 years ago
committed by Rusty Russell
parent
162a97894d
commit
f1add556d6
4 changed files with 26 additions and 14 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      doc/lightning-setchannelfee.7
  2. 9
      doc/lightning-setchannelfee.7.txt
  3. 11
      doc/lightningd-config.5
  4. 10
      doc/lightningd-config.5.txt

10
doc/lightning-setchannelfee.7
View File

@ -1,13 +1,13 @@
'\" t '\" t
.\" Title: lightning-setchannelfee .\" Title: lightning-setchannelfee
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 03/15/2019 .\" Date: 03/18/2019
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-SETCHANNE" "7" "03/15/2019" "\ \&" "\ \&" .TH "LIGHTNING\-SETCHANNE" "7" "03/18/2019" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -36,14 +36,14 @@ lightning-setchannelfee \- Command for setting specific routing fees on a lightn
.sp .sp
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\&. 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\&.
.sp .sp
\fIid\fR is required and should contain a scid (short channel ID), channel id or peerid (pubkey) of the channel to be modified\&. \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\&.
.sp .sp
\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\&. \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\&.
.sp .sp
\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\&. \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" .SH "RETURN VALUE"
.sp .sp
On success, an object with fields \fIchannel_id\fR, \fIshort_channel_id\fR, \fIbase\fR and \fIppm\fR, describing the new values for this cannel, is returned\&. 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" .SH "ERRORS"
.sp .sp
The following error codes may occur: The following error codes may occur:

9
doc/lightning-setchannelfee.7.txt
View File

@ -18,7 +18,9 @@ This can be checked by *listpeers* reporting a 'state' of CHANNELD_NORMAL
or CHANNELD_AWAITING_LOCKIN for the channel. or CHANNELD_AWAITING_LOCKIN for the channel.
'id' is required and should contain a scid (short channel ID), channel id 'id' is required and should contain a scid (short channel ID), channel id
or peerid (pubkey) of the channel to be modified. or peerid (pubkey) of the channel to be modified. If 'id' is set to "all",
the fees for all channels are updated that are in state CHANNELD_NORMAL or
CHANNELD_AWAITING_LOCKIN.
'base' is an optional value in millisatoshi that is added as base fee to 'base' 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 any routed payment. If the parameter is left out, the global config
@ -34,8 +36,9 @@ is left out, the global config value will be used again.
RETURN VALUE RETURN VALUE
------------ ------------
On success, an object with fields 'channel_id', 'short_channel_id', 'base' On success, an object with the new values 'base' and 'ppm' along with an array
and 'ppm', describing the new values for this cannel, is returned. 'channels' which contains objects with fields 'peer_id', 'channel_id' and
'short_channel_id'.
ERRORS ERRORS
------ ------

11
doc/lightningd-config.5
View File

@ -2,12 +2,12 @@
.\" Title: lightningd-config .\" Title: lightningd-config
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 03/03/2019 .\" Date: 03/05/2019
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNINGD\-CONFIG" "5" "03/03/2019" "\ \&" "\ \&" .TH "LIGHTNINGD\-CONFIG" "5" "03/05/2019" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -188,12 +188,12 @@ Up to 32 UTF\-8 characters to tag your node\&. Completely silly, since anyone ca
.PP .PP
\fBfee\-base\fR=\fIMILLISATOSHI\fR \fBfee\-base\fR=\fIMILLISATOSHI\fR
.RS 4 .RS 4
The base fee to charge for every payment which passes through\&. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones\&. The base fee to charge for every payment which passes through\&. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones\&. If you want to change fees for existing channels, use the RPC call lightningd\-setchannelfee(7)\&.
.RE .RE
.PP .PP
\fBfee\-per\-satoshi\fR=\fIMILLIONTHS\fR \fBfee\-per\-satoshi\fR=\fIMILLIONTHS\fR
.RS 4 .RS 4
This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&. Changing this value will only affect new channels and not existing ones\&. This is the proportional fee to charge for every payment which passes through\&. As percentages are too coarse, it\(cqs in millionths, so 10000 is 1%, 1000 is 0\&.1%\&. Changing this value will only affect new channels and not existing ones\&. If you want to change fees for existing channels, use the RPC call lightningd\-setchannelfee(7)\&.
.RE .RE
.PP .PP
\fBignore\-fee\-limits\fR=\fIBOOL\fR \fBignore\-fee\-limits\fR=\fIBOOL\fR
@ -485,6 +485,9 @@ You should report bugs on our github issues page, and maybe submit a fix to gain
.SH "AUTHOR" .SH "AUTHOR"
.sp .sp
Rusty Russell <rusty@rustcorp\&.com\&.au> wrote this man page, and much of the configuration language, but many others did the hard work of actually implementing these options\&. Rusty Russell <rusty@rustcorp\&.com\&.au> wrote this man page, and much of the configuration language, but many others did the hard work of actually implementing these options\&.
.SH "SEE ALSO"
.sp
lightning\-listconfigs(7) lightningd\-setchannelfee(7)
.SH "RESOURCES" .SH "RESOURCES"
.sp .sp
Main web site: https://github\&.com/ElementsProject/lightning Main web site: https://github\&.com/ElementsProject/lightning

10
doc/lightningd-config.5.txt
View File

@ -141,13 +141,15 @@ Lightning node customization options
*fee-base*='MILLISATOSHI':: *fee-base*='MILLISATOSHI'::
The base fee to charge for every payment which passes through. Note that The base fee to charge for every payment which passes through. Note that
millisatoshis are a very, very small unit! Changing this value will only millisatoshis are a very, very small unit! Changing this value will only
affect new channels and not existing ones. affect new channels and not existing ones. If you want to change fees for
existing channels, use the RPC call lightningd-setchannelfee(7).
*fee-per-satoshi*='MILLIONTHS':: *fee-per-satoshi*='MILLIONTHS'::
This is the proportional fee to charge for every payment which passes This is the proportional fee to charge for every payment which passes
through. As percentages are too coarse, it's in millionths, so 10000 through. As percentages are too coarse, it's in millionths, so 10000
is 1%, 1000 is 0.1%. Changing this value will only affect new channels and is 1%, 1000 is 0.1%. Changing this value will only affect new channels and
not existing ones. not existing ones. If you want to change fees for existing channels, use
the RPC call lightningd-setchannelfee(7).
*ignore-fee-limits*='BOOL':: *ignore-fee-limits*='BOOL'::
Allow nodes which establish channels to us to set any fee they Allow nodes which establish channels to us to set any fee they
@ -346,6 +348,10 @@ Rusty Russell <rusty@rustcorp.com.au> wrote this man page, and much
of the configuration language, but many others did the hard work of the configuration language, but many others did the hard work
of actually implementing these options. of actually implementing these options.
SEE ALSO
--------
lightning-listconfigs(7) lightningd-setchannelfee(7)
RESOURCES RESOURCES
--------- ---------
Main web site: https://github.com/ElementsProject/lightning Main web site: https://github.com/ElementsProject/lightning

Write Preview
Loading…
Cancel
Save