Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/enoy19/burst-mining-pool-bot

Telegram Bot that displays Burst mining pool miner data (e.g. pending burst)
https://github.com/enoy19/burst-mining-pool-bot

bot burst burstcoin spring spring-boot telegram telegram-bot

Last synced: 2 months ago
JSON representation

Telegram Bot that displays Burst mining pool miner data (e.g. pending burst)

Awesome Lists containing this project

README

        

# Burst Mining Pool Telegram Bot
This project is a Spring-boot application, that hosts a telegram bot
which can update burst-miners on their current pending payments of their mining pool.
The bot currently supports private and group chats. You can add multiple wallets
to the bot. The bot can monitor each wallet and send automatic notifications on pending
payment changes.

## Contributing
If you want to add a mining pool, please have a look at the wiki:
[Adding support for your pool software](https://github.com/enoy19/burst-mining-pool-bot/wiki/Adding-support-for-your-pool-software)

## Hosting & Configuration
Wiki: [Hosting and Configuration](https://github.com/enoy19/burst-mining-pool-bot/wiki/Hosting-and-Configuration)

## Supported Mining Pools
* [Nogrod](https://github.com/PoC-Consortium/Nogrod) Pools (e.g. [Crypto-guru](https://50-50-pool.burst.cryptoguru.org/) + [Burstcoin.ro](https://pool.burstcoin.ro))
* All pools that provide an HTML table (GET Request) with the [Nogrod /miners](https://50-50-pool.burst.cryptoguru.org/miners) layout (path, table id & column indexes can be configured)

## Commands
### /add_wallet
Adds a wallet to the chat.\
Arguments:
* Burst Address ([Format](https://burstwiki.org/wiki/RS_Address_Format))

### /remove_wallet
Removed a wallet of the chat.\
Arguments:
* Burst Address

### /notification
Activates pending payment change notifications for the given wallet.\
Arguments:
* Burst Address

### /notification_threshold
Sets the notification threshold of a wallet.\
See also: [/threshold_mode](https://github.com/enoy19/burst-mining-pool-bot#threshold_mode)\
Arguments:
* Burst Address
* Threshold (double, must be positive.)

### /threshold_mode
See also: [/notification_threshold](https://github.com/enoy19/burst-mining-pool-bot#notification_threshold) \
Arguments:
* Burst Address
* Threshold mode
* **ACCUMULATE:** Adds all incrementations of your pending payment and notifies you when the amount is greater than your threshold.
* **SINGLE:** Notifications will be sent when a single pending payment increase is greater than your threshold.
* **PAYOUT:** Works like accumulate but only counts payouts (pending payment decreases).

### /pending
Shows the current pending payments for each wallet.

### /share
Shows the current (historical) share for each wallet.

### /effective_capacity
Shows the current effective capacity in TB for each wallet.

### /confirmed_deadlines
Shows the current amount of confirmed deadlines for each wallet.

### /show_wallets
Shows wallets that were added to the chat.

### /donate
Shows donation information about developers and hosts.