Skip to content

Commit c3ca4c2

Browse files
authored
Update README.md
1 parent 8925606 commit c3ca4c2

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,34 @@ It'll allow you to
1111
- Incrementally start the ratio to rebalance with **10%, 30%, 50%, 70%** and remainder ratio to rebalance*
1212
- For < 2M sats channels, the script will strive to achieve a 50:50 ratio. For > 2M Channel size, it'll aim to get 1M at either side
1313

14-
###### Attributes
14+
#### Installation
1515
```
16-
- Fee-Setting
17-
- Direction push (👉) outbound or pull (👈) inbound liquidity
18-
- -j Single channel ID of first and required channel
19-
- -k to -p arguments allow for passing additional optional channels to rebalance
20-
```
16+
$ git clone https://github.com/TrezorHannes/bash-rebalancer
17+
$ nano bash-rebalancer/my_rebalancer.sh
18+
```
19+
1) In case the below LND directory doesn't work for you, add a direct link in line 19 below
20+
2) Alternate the path to your rebalance-lnd directory if it's not in ~/rebalance-lnd/ in line 25
21+
2122

22-
###### Syntax for one channel
23-
`$ ./my_rebalancer.sh -j cidxxxxxxxxxxxxxxx`
23+
##### Syntax for one channel
24+
`$ ./bash-rebalancer/my_rebalancer.sh -j cidxxxxxxxxxxxxxxx`
2425

2526
This command will try one _specific channel_ (j).
2627

27-
###### Syntax for more than one channel
28-
`$ ./my_rebalancer.sh -j cidxxxxxxxxxxxxxxx -k cidxxxxxxxxxxxxxxx -l cidxxxxxxxxxxxxxxx -m cidxxxxxxxxxxxxxxx -n cidxxxxxxxxxxxxxxx -o cidxxxxxxxxxxxxxxx`
28+
##### Syntax for more than one channel
29+
`$ ./bash-rebalancer/my_rebalancer.sh -j cidxxxxxxxxxxxxxxx -k cidxxxxxxxxxxxxxxx -l cidxxxxxxxxxxxxxxx -m cidxxxxxxxxxxxxxxx -n cidxxxxxxxxxxxxxxx -o cidxxxxxxxxxxxxxxx`
2930

3031
This command will try to rebalance _for 6 different channels_ (j-o).
3132

32-
###### Hints
33+
#### Attributes
34+
```
35+
- Fee-Setting
36+
- Direction push (👉) outbound or pull (👈) inbound liquidity
37+
- -j Single channel ID of first and required channel
38+
- -k to -p arguments allow for passing additional optional channels to rebalance
39+
```
40+
41+
#### Hints
3342
1. Since the process is going to take a long time, pending the number of channels you like to rebalance, it's generally advised to **run the bash script via TMUX**.
3443
2. Get a list of target rebalancing channels with `$ lndmanage listchannels rebalance` before-hand, and identify the top 1-7 with too much outbound or too much inbound by hand
3544
3. Focus on the **channels with reasonable fee-settings**. When you use charge-lnd, you may have channels with extra-ordinary high or low pricing to dis- or encourage balancing. Fee-Factor for those channels can have undersirable side-effects (too high or too low ppm).

0 commit comments

Comments
 (0)