https://github.com/stackzoo/voltbot

Lightning node bot ⚡🤖
https://github.com/stackzoo/voltbot

automation bitcoin bot golang lightning-network lnd slack

Last synced: 3 months ago
JSON representation

Lightning node bot ⚡🤖

• Host: GitHub
• URL: https://github.com/stackzoo/voltbot
• Owner: stackzoo
• Created: 2023-12-17T16:30:10.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-08T15:11:39.000Z (12 months ago)
• Last Synced: 2024-09-28T20:23:27.789Z (3 months ago)
• Topics: automation, bitcoin, bot, golang, lightning-network, lnd, slack
• Language: Go
• Homepage:
• Size: 1.42 MB
• Stars: 10
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# VOLTBOT

[![oci](https://github.com/stackzoo/voltbot/actions/workflows/oci.yaml/badge.svg)](https://github.com/stackzoo/voltbot/actions/workflows/oci.yaml)

[![Latest Release](https://img.shields.io/github/release/stackzoo/voltbot.svg)](https://github.com/stackzoo/voltbot/releases/latest)

[![Go Report Card](https://goreportcard.com/badge/github.com/stackzoo/voltbot)](https://goreportcard.com/report/github.com/stackzoo/voltbot)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  



Lightning node bot ⚡🤖

### Supported Products

- [Slack](https://slack.com/)

### Supported Lightning Nodes Implementations

- [LND](https://github.com/lightningnetwork/lnd)

## Abstract

Voltbot is a lightweight bot that retrieves lightning node stats and send them via different channels.  

This can be beneficial for monitoring node instances.  

Voltbot communicates with the *LND* instance through [gRPC](https://grpc.io/).  

## Instructions

To operate, the bot requires reading configuration data from a JSON file.  

The configuration file must be located within the `config` folder at the root directory and must be named `voltbot_config.json`.  

You can take a look at the example file inside the `config` folder:  

```json

{

    "lnd_node_endpoint": "",

    "lnd_node_tls_cert_path": "config/tls.cert",

    "lnd_node_macaroon_hex_path": "config/macaroon.hex",

    "slack_channel_id": "",

    "slack_token": ""

}

```  

At present, the retrieval of statistics is hard-coded to occur every *360 minutes* (6 hours).  

### Run with docker

The project includes a GitHub Action that publishes an OCI image (container) to the GitHub registry when a new version is tagged.  

Consequently, it is possible to run the project directly as a container.  

  

  

Pull the image:  

```console

docker pull ghcr.io/stackzoo/voltbot:0.0.5

```  

And the run the container by mapping the local folder that contains the configuration files:  

```console

docker run -v "/your/local/config/path/config:/config" ghcr.io/stackzoo/voltbot:0.0.5

```  

>[!Note]

> You can also pull the Image compiled for ARM architecture, for example if you want to run the bot on a raspberry pi or another edge device.  

> In order to do that you just need to use the "-arm" tag, for example: `docker pull ghcr.io/stackzoo/voltbot:0.0.5-arm`  

All the published Images can be found [here](https://github.com/stackzoo/voltbot/pkgs/container/voltbot).

## Example