This script can be run continuously to attempt to create a balanced node or one can run it on-demand.

Special bos tags ab_for_out/ab_for_in/ab_for_2w are used. Tag names can be configured in the script.

ab_for_out tag contains all peers which you want to mostly keep local (i.e. they flow out to generate routing or your) ab_for_in tag contains all peers which you want to mostly keep remote (i.e. they flow in through your node and generate routing for your). ab_for_2w contains peers which you want to keep 2 way balanced with local balance priority. They flow both ways. Make sure you select the peer carefully otherwise they can end up with stuck local.

in the script you can define multiple tags for in or out using --tag tagname --tag tagname syntax.

Collect a set "sendout set" of peers with outbouond > OUT_OVER_CAPACITY (these are channels which are sent to remote using --out). You can add a list of peers which need to be omitted here if you do not want to use them as --out peers. Peers in ab_for_in tag are added to sendout_set.

Collect a set "bringin_set" peers with outbound < IN_TARGET_OUTBOUND*80% (these are depleted channels and need some minimal liquidity using --in). You can add a list of peers which need to be omitted if you do not want them to be used as --in peers. Peers in ab_for_out tag are added to the bringin_set.

In Step 1 for every peer in bringin_set, a random out peer is selected from sendout_set and bos rebalance is performend to ensure at least IN_TARGET_OUTBOUND liquidity.

In Step 2 for every peer in sendout_set, a random in peer is selected from bringin_set and bos rebalance is performed to ensure outbound capacity as 50:50 on the out peer.

In Step 3 for every peer in ab_for_out, a random out peer is selected from sendout_set and rebalance is performend to maximise local balance.

In step 4, for every peer in ab_for_in, a random in peer is selected from bringin_set and rebalance is performed to maximise remote balance.

In step 5, if you have LOOP channel, rebalance is performed to bring loop balance to local (to avoid channel closure by LOOP).

Please ensure IN_TARGET_OUTBOUND should be less than your entire node OUT_BOUND/CAPACITY. Recommended 20% (0.2) tends to work for most nodes but can be adjusted.

The script can be updated to suit your individual needs. Further optimisation can be built. Please send suggestion to author (or report via issue report).

Most nodes end up suffering from lack of liquidit on their local balace which leads to routing failure on their node as well as loss of reputation and reliability on the network, leading to their node being ignored on paths where there is liquidity.

This script attempts to keep a minimum local balance on most channels to ensure reasonbale routing. Coupled with liquidity driven fee policy (low fee on high local, high fee on low local) it can create a two way routing node and improve the node position within the network.

This script run continuously to attempt to create a balanced node. The main idea is to keep minimial liquidity on each channel to at least route some payments. The user is expected to customise the script with respect to fees and other parameters. These are available to edit on top of the script. It can be executed in a TMUX session continuously as:

cd ~
git clone https://github.com/BhaagBoseDK/autorebalance

The above will get the repository in ~/autorebalance directory For updates do

cd ~/autorebalance
git pull

You should customise the script to your individual needs. Read it at least once speicially the user configuration section.

Test it using

cd ~/autorebalance
. ./autorebalance.sh 

Then run continuously if you are comfortable.

while true; do . ~/autorebalance/autorebalance.sh; done

Or, it can be executed as a daily cron job. BOS (Balance of Satoshi) needs to be installed Add the following in crontab to run regulary. Change path as appropriate

42 21 * * * ~/autorebalance/autorebalance.sh >> ~/autorebalance/autorebalance.log 2>&1

Change TIP=0 if you do not wish to tip the author.

You may have to configure myBOS variable if the script is unable to determine bos installation.

Author: VS https://t.me/BhaagBoseDk

Contact on telegram if there are issues running the script.

Change History:

#0.0.1 - first version
#0.0.2 - Added Tip for fun
#0.0.3 - Handling various bos instllations
#0.0.4 - Improvement after bos 10.20.0
#0.1.0 - Reduced Sleep Time, minor varibale name change, other minor updates
#0.1.1 - Placeholder for customised rebalances; added Out->In rebalcne for heavy local;
         change to array from local file
         use of temporary in memory file system for working directories
         change to array from local file
#0.1.2 - use bos call to get MY_KEY
       - bugfix with temp directory to use PWD if temp area not created.
#0.1.3 - use special bos tags in peer selection if defined.
#0.1.4 - allow multiple bos tags
#0.1.5 - bug fixes in peer selection
       - only use active nodes
       - Indicate the executing step number.
#0.1.6 - Do a nudge to idle peers
       - bos version 11.10.0
#0.1.7 - Rebalance CHIVO to remote
       - bos clean-failed-payments upon exit
#0.1.8 - Nudge Idle for IN
       - Use Chivo for Idle in special loop
       - Send Idle Nudge
#0.1.9 - Use MINIMUM LIQUIDITY to select suitable peers
       - code cleanup added functions for each step.
#0.2.0 - Using unclassified peers in the high value rebalnce.
       - init after each function
       - Reorder sequence and other logics
       - Check depleting peers after successful rebalance
       - Random Reconnect
#0.2.1 - Step Text
       - Favour zerofees for --in peers
       - Avoid Not required if Global Avoid is defined (bos 11.16.1 onwards)
#0.2.2 - Fee Variables can be defined in environment now.
       - Only init when required (after events which change channel capacity)
       - Only do 25% of peers for Chivo
#0.2.3 - Place for two way channels
       - Sniper Mode (keep hitting until capacity reached)
#0.2.4 - Minimimm Liquidity related minor adjustments.
#0.2.5 - Randomise Loop Rebalance
       - Using AVOID for send.
#0.2.6 - Changes related to leaving Minimum Liquidity on Channels.
       - make zero fee peers available for out rebalance too.
       - only rebalance 2w which have routed in last active_days
       - Append to peers file
       - Only rebalance if there was a recent forward.
       - Dynamic Rebalance Fee based on OUT channel.
#0.2.7 - Minor Changes
#      - IN,OUT_REBAL targets instead of 100%.
#0.2.8 - Avoid high fee routes