jriou/flexassistant
Archived
1
0
Fork 0
Code Issues Pull requests Activity
Telegram bot to notify for Flexpool mined or farmed blocks, unpaid balance and transactions
This repository has been archived on 2024-12-18. You can view files and clone it, but cannot push or open issues or pull requests.
5 commits 1 branch 8 tags 247 KiB
Go 98.2%
Makefile 1.8%
Find a file
Julien Riou ebbd4ac2cd
refactor: Use struct to parse API responses 
- Return bytes for each request to the Flexpool API
- Delegate JSON marshalling the higher functions
- Use int64 when possible

BREAKING CHANGE: database structure has to be updated to use integer
instead of real. Please follow instructions to upgrade from 1.0 to 1.1.

Signed-off-by: Julien Riou <julien@riou.xyz>
2021-10-11 08:54:37 +02:00
migrations refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
static feat: Initial release (1.0) 2021-10-06 19:07:41 +02:00
.gitignore feat: Initial release (1.0) 2021-10-06 19:07:41 +02:00
client.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
config.go feat: Add offline/online workers notifications (#1) 2021-10-10 20:56:50 +02:00
db.go feat: Add offline/online workers notifications (#1) 2021-10-10 20:56:50 +02:00
flexassistant.yaml.example feat: Add offline/online workers notifications (#1) 2021-10-10 20:56:50 +02:00
go.mod feat: Initial release (1.0) 2021-10-06 19:07:41 +02:00
go.sum feat: Initial release (1.0) 2021-10-06 19:07:41 +02:00
LICENSE Initial commit 2021-09-29 16:00:24 +02:00
main.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
Makefile docs: Update Makefile and README for release 2021-10-06 19:12:49 +02:00
miner.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
notification.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
pool.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
README.md feat: Add offline/online workers notifications (#1) 2021-10-10 20:56:50 +02:00
UPGRADES.md refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
utils.go refactor: Use struct to parse API responses 2021-10-11 08:54:37 +02:00
VERSION feat: Initial release (1.0) 2021-10-06 19:07:41 +02:00

README.md

flexassistant

Flexpool.io is a famous cryptocurrency mining or farming pool supporting Ethereum and Chia blockchains. As a miner, or a farmer, we like to get notified when a block is mined, or farmed. We also like to keep track of our unpaid balance and our transactions to our personal wallet.

flexassistant is a tool that parses the Flexpool API and sends notifications via Telegram.

Installation

Note: this guide has been written with Linux x86_64 in mind.

Binaries

Go to Releases to download the binary in the version you like (latest is recommended) into a bin directory.

Write checksum information to a local file:

echo checksum > flexassistant-VERSION-Linux-x86_64.sha256sum

Verify checksums to avoid binary corruption:

sha256sum -c flexassistant-VERSION-Linux-x86_64.sha256sum

Compilation

You will need to install Go, Git and a development toolkit (including make) for your environment.

Then, you'll need to download and compile the source code:

git clone https://github.com/jouir/flexassistant.git
cd flexassistant
make

The binary will be available under the bin directory:

ls -l bin/flexassistant

Configuration

flexassistant can be configured using a YaML file. By default, the flexassistant.yaml file is used but it can be another file provided by the -config argument.

As a good start, you can copy the configuration file example:

cp -p flexassistant.yaml.example flexassistant.yaml

Then edit this file at will.

Reference:

  • database-file (optional): file name of the database file to persist information between two executions (SQLite database)
  • max-blocks (optional): maximum number of blocks to retreive from the API
  • max-payments (optional): maximum number of payments to retreive from the API
  • pools (optional): list of pools
    • coin: coin of the pool (ex: eth, xch)
    • enable-blocks (optional): enable block notifications for this pool (disabled by default)
  • miners (optional): list of miners and/or farmers
    • address: address of the miner or the farmer registered on the API
    • enable-balance (optional): enable balance notifications (disabled by default)
    • enable-payments (optional): enable payments notifications (disabled by default)
    • enable-offline-workers (optional): enable offline/online notifications for associated workers (disabled by default)
  • telegram: Telegram configuration
    • token: token of the Telegram bot
    • chat-id (optional if channel-name is present): chat identifier to send Telegram notifications
    • channel-name (optional if chat-id is present): channel name to send Telegram notifications

Usage

Usage of ./flexassistant:
  -config string
        Configuration file name (default "flexassistant.yaml")
  -debug
        Print even more logs
  -quiet
        Log errors only
  -verbose
        Print more logs
  -version
        Print version and exit