Code Monkey home page Code Monkey logo

channel-bot's Introduction

Boltz Channel Bot GitHub Action

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.10.0-beta or higher is supported. Also, Discord is currently the only service to which the bot can send its notifications.

Features

The features set of the bot are subject to change and are updated as needed for managing our LND nodes.

Notifications

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.

Significant channels

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.

Channel management

More to come...

Channel cleaner

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.

Installation

go get -d github.com/BoltzExchange/channel-bot

cd $GOPATH/src/github.com/BoltzExchange/channel-bot

make build && make install

You can confirm successful installation by running the channel-bot command with the --help argument.

channel-bot --help

Configuration

The bot can be configured either by CLI arguments, or with a TOML config file.

CLI Arguments

channel-bot --help

Config

example/channel-bot.toml

Disclaimer

Use at your own discretion.

channel-bot's People

Contributors

matthewlilley avatar michael1011 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.