This is a bot that sends notifications for imbalanced and (force) closed lightning channels to a Discord channel. It also incorporates features for channel management like force closing channels that have been inactive for longer that a configured amount of time.
Only LND version 0.9.0-beta or higher is supported. Also Discord is currently the only service to which the bot can send its notifications.
The features set of the bot are subject to change and are updated as needed for managing our LND nodes.
The main feature of this bot is its notification service. If either less than 30% or more than 70% of the capacity of a channel is on the side of the LND that it is connected to, the bot will send a notification. Once the channel is balanced again according to the said requirements, the bot will also send a notification. The bot doesn't send these balance notifications for private channels unless the channel is configured as significant channel.
If a channel is closed the bot will also send a notification. Force closed channels have a special notification to indicate that something went wrong and your node needs your attention.
All of these notifications contain the channel ID and, depending on the type of notification, other relevant information. The interval at which the channels should be checked can be configured.
Channels of special significance can be set in the config file. Those significant channels have an alias to be able to easily identify them in the notifications, custom ratios that make them considered imbalanced and their notifications stick out from all the normal channels.
More to come...
The channel cleaner takes care of force closing zombie channels. The interval at which the channels should be checked for zombies and the number of days that are needed for a channel to become a zombie are configurable.
The bot can be configured either by CLI arguments or with a TOML config file:
# Notification options
[notifications]
# Interval in seconds at which the channel balances and closed channels should be checked. Set to 0 to disable this feature
interval = 60
# Channel Cleaner options
[channelcleaner]
# Interval in hours at which inactive channels should be checked and possibly closed. Set to 0 to disable this feature
interval = 24
# After how many days of inactivity a **public** channel should be force closed
maxInactiveTime = 30
# After how many days of inactivity a **private** channel should be force closed
maxInactivePrivate = 60
# Discord options
[discord]
# Prefix for Discord every message sent
prefix = "[channels-testnet-btc]"
# Name of the Discord channel to which the notifications should be sent
channel = "testnet"
# Discord authentication token
token = "<token>"
# LND options
[lnd]
host = "127.0.0.1"
port = 10009
certificate = "/home/bitcoin/.lnd/tls.cert"
# This does not have to be the admin macaroon. The read only one is enough in case the bot should not force close channels
macaroon = "/home/bitcoin/.lnd/data/chain/bitcoin/testnet/admin.macaroon"
# Set a significant channel
# There is no upper limit to the number of significant channels
[[significantchannels]]
# Give the channel a name to make them easily identifiable in the notifications
alias = "wumbo-boltz"
# Channel ID of the channel
channelid = 619899158240231424
# The ratio is calculated with: local balance / channel capacity
# The minimal ratio before the channel is considered imbalanced
minratio = "0.1"
# The maximal ratio before the channel is considered imbalanced
maxration = "0.6"