core-lightning/doc/lightning-setchannelfee.7.md
Christian Decker c3254e6639 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-09-02 16:31:36 +02:00

2.3 KiB

lightning-setchannelfee -- Command for setting specific routing fees on a lightning channel

SYNOPSIS

setchannelfee id [base] [ppm]

DESCRIPTION

The setchannelfee 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 listpeers reporting a state of CHANNELD_NORMAL or CHANNELD_AWAITING_LOCKIN for the channel.

id is required and should contain a scid (short channel ID), channel id 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 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 msat or sat, or a number with three decimal places ending in sat, or a number with 1 to 11 decimal places ending in btc.

ppm 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.

RETURN VALUE

On success, an object with the new values base and ppm along with an array channels which contains objects with fields peer_id, channel_id and short_channel_id.

ERRORS

The following error codes may occur:

  • -1: Channel is in incorrect state, i.e. Catchall nonspecific error.
  • -32602: JSONRPC2_INVALID_PARAMS, i.e. Given id is not a channel ID or short channel ID.

AUTHOR

Michael Schmoock <michael@schmoock.net> is the author of this feature. Rusty Russell <rusty@rustcorp.com.au> is mainly responsible for the c-lightning project.

SEE ALSO

lightningd-config(5), lightning-fundchannel(7), lightning-listchannels(7), lightning-listpeers(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning