aljaz/plugins
1
0
Fork 0
mirror of https://github.com/aljazceru/plugins.git synced 2025-12-20 14:44:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: update rebalance README.md

Browse Source
This commit is contained in:
Michael Schmoock
2019-04-29 23:45:11 +02:00
committed by Christian Decker
parent 5efb86da46
commit e7adbfa161
1 changed files with 40 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
rebalance/README.md
View File

@@ -1,32 +1,52 @@
# Rebalance plugin
This plugin helps to move some msatoshis between your channels using circular payments.
This plugin moves liquidity between your channels using circular payments.
The plugin can be started with `lightningd` by adding the following `--plugin` option
(adjusting the path to wherever the plugins are actually stored):
The plugin can be started with `lightningd` by adding the following `--plugin`
option. As with any `lightningd` plugin, the file has to be executable. As
with any lightning python plugin, `pylightning` must be installed or in your
`PYTHONPATH` environment variable.
```
lightningd --plugin=/path/to/plugins/rebalance.py
```
Once the plugin is active you can rebalance your channels liquidity by running:
`lightning-cli rebalance outgoing_channel_id incoming_channel_id msatoshi [maxfeepercent] [retry_for] [exemptfee]`
The `outgoing_channel_id` is the short_channel_id of the sending channel, `incoming_channel_id` is the id of the
receiving channel. The `maxfeepercent` limits the money paid in fees and defaults to 0.5. The maxfeepercent' is a
percentage of the amount that is to be paid. The `exemptfee` option can be used for tiny payments which would be
dominated by the fee leveraged by forwarding nodes. Setting exemptfee allows the maxfeepercent check to be skipped
on fees that are smaller than exemptfee (default: 5000 millisatoshi).
```
lightning-cli rebalance outgoing_scid incoming_scid [msatoshi] [maxfeepercent] [retry_for] [exemptfee]
```
The command will keep finding routes and retrying the payment until it succeeds, or the given `retry_for` seconds
pass. retry_for defaults to 60 seconds and can only be an integer.
### Tips and Tricks ###
- The ideal amount is not too big, but not too small: it is difficult to find a route for a big payment, however
some node refuses to forward too small amounts (i.e. less than a thousand msatoshi).
- After some failed attempts, may worth checking the `lightningd` logs for further information.
- Channels have a `channel_reserve_satoshis` value, which is usually 1% of the channel's total balance. Initially,
this reserve may not be met, as only one side has funds; but the protocol ensures that there is always progress
toward meeting this reserve, and once met, [it is
maintained.](https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md#rationale)
## Parameters
- The `outgoing_scid` is the short_channel_id of the sending channel,
- The `incoming_scid` is the short_channel_id of the receiving channel.
- OPTIONAL: The `msatoshi` parameter sets the amount in milli-satoshis to be
transferred. If the parameter is left out, the plugin will calucate an amount
that will balance the channels 50%/50%. The parameter can also be given in
other denominations by appending i.e. '10000sat' or '0.01btc'.
- OPTIONAL: `maxfeepercent` is a perecentage limit of the money to be paid in
fees and defaults to 0.5.
- OPTIONAL: `retry_for` defines the number of seconds the plugin will retry to
find a suitable route. Default: 60 seconds.
- OPTIONAL: The `exemptfee` option can be used for tiny payments which would be
dominated by the fee leveraged by forwarding nodes. Setting `exemptfee`
allows the `maxfeepercent` check to be skipped on fees that are smaller than
exemptfee (default: 5000 millisatoshi).
## Tips and Tricks
- To find the correct channel IDs, you can use the `summary` plugin which can
be found [here](https://github.com/lightningd/plugins/tree/master/summary).
- The ideal amount is not too big, but not too small: it is difficult to find a
route for a big payment, however some node refuses to forward too small
amounts (i.e. less than a thousand msatoshi).
- After some failed attempts, may worth checking the `lightningd` logs for
further information.
- Channels have a `channel_reserve_satoshis` value, which is usually 1% of the
channel's total balance. Initially, this reserve may not be met, as only one
side has funds; but the protocol ensures that there is always progress toward
meeting this reserve, and once met, [it is maintained.](https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md#rationale)
Therefore you cannot rebalance a channel to be completely empty or full.