track-burn-bot

The track-burn-bot is a Python-based Discord bot designed to monitor and report burn transactions in a given blockchain. It provides the block number, block hash, transaction ID, the number of burned coins in the transaction, and the total number of burned coins in a given blockchain, by sending a message to a specified Discord channel.

Prerequisites

1. Python 3.7 or later: You can verify your Python version by running python --version in your command prompt.
2. SQLite3: This is included in the Python standard library for Python versions 2.5 and later.
3. Python packages:
   • discord.py
   • aiohttp

You can install these Python packages using pip and the included requirements file:

pip install -r requirements.txt

Configuration

SQLite Database

The bot uses a SQLite database to persist the state of the last processed block and the total burned coins. The database file, burnbot.db, is automatically created when the bot starts if it doesn't already exist. It contains a single table, burnbot, with the fields last_processed_block (integer) and total_burned_coins (real).

RPC Configuration

To connect to a local daemon running your target blockchain, you need to provide the rpcuser and rpcpassword from your local daemon's configuration file. These values should be set in burnbot.py:

rpc_user = 'RPC_USER'  # Replace with your rpcuser
rpc_password = 'RPC_PASSWORD'  # Replace with your rpcpassword

Discord Bot Token

You'll need to obtain the token for your Discord bot from the Discord Developer Portal and specify it in burnbot.py:

bot.run('your-bot-token')  # Replace with your Discord bot token

Update Interval

The bot checks for burn transactions at a set interval, which can be adjusted in burnbot.py:

@tasks.loop(seconds=15)  # Adjust the interval as desired

Blockchain Information Method

Depending on the Bitcoin Core version used by your target blockchain, the method to retrieve blockchain information might vary. For newer versions, replace 'getinfo' with 'getblockchaininfo' or another appropriate command:

async with session.post('http://localhost:14531', json={'method': 'getinfo'}) as response:  # Change 'getinfo' as necessary

RPC Port

Make sure the RPC port matches the one used by your target blockchain. The default port is 14531 for Innova:

async with session.post('http://localhost:14531', json={'method': 'getinfo'}) as response:  # Change port number as necessary

Discord Channel ID

Set the ID of the Discord channel where the bot will post updates:

channel = bot.get_channel(CHANNEL_ID)  # Replace CHANNEL_ID with your actual Discord channel ID

Running the Bot

To start the bot, navigate to the directory containing burnbot.py in your terminal and run:

python burnbot.py

Upon successful connection to Discord, the bot will print a message in the terminal with its username.

Usage

Start the bot after your blockchain is synced. It will automatically begin checking for burn transactions from the last processed block, or from block 0 if it's the bot's first run. Once it reaches the most recent block, it will start an automated check based on the interval you specified. When it detects a burn transaction

, it will send a message to the designated Discord channel with the block number, block hash, transaction ID, number of burned coins in the transaction, and the total number of burned coins in the chain so far.

If you want to use logging, checkout the logger branch. It's slower but will produce a bot.log file for output inspection. The python-rpc branch contains integrations with the innova-pythonrpc library, which is currently in testing and might not work.

For any issues, check the terminal for error messages or debugging information.