forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lightning-setchannelfee.7.txt
61 lines (49 loc) · 2.21 KB
/
lightning-setchannelfee.7.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
LIGHTNING-SETCHANNELFEE(7)
========================
:doctype: manpage
NAME
----
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 <[email protected]> is the author of this feature.
Rusty Russell <[email protected]> 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