A Telegram Bot to check your bitcoin wallet.
Getting Started | Configuration | Contributing | License
- Clone this repo
- Install requirements:
pip install -r requirements.txt
- Run bot:
python bot.py
BitcoinWalletBot uses a configs.yml
file on the same folder as bot.py
for configurations.
# Avaliable as a tag
bot_title: "Bitcoin Wallet Viewer"
# Telegram bot token as provided by BotFather
telegram_token : ''
# A list of ints composed of all Telegram user ids
# you want to be able to use the bot
allowed_user_ids:
- 1234567
update_each: 3600 # seconds
date_format: "%d/%m/%Y" # datetime compliant format
hour_format": "%H:%M" # datetime compliant format
money: "USD"
money_format: "en_US"
wallets:
- name: Test Wallet
address: "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2"
- name: Test Wallet
address: "aaa1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2"
# BOT STRINGS ---------------------------------------------
# Each new item is joined by a new line, use \n if you need extra spacing
title:
- "*{title}*"
wallet_view:
- "\n\n*- {wallet}*"
- "💰 *{btc_balance}* BTC"
- "💱 *{money_balance}* in {currency}"
failed_wallet_view:
- "\n\n*- {wallet}*"
- "_Unable to fetch wallet information._"
extra_content:
- "\n\n\n📈 *1BTC* is worth *{btc_value}*"
- "\n_🕗 Last update: {update_date} at {update_time}_"
update_button: "🔄"
updating:
- "_Updating.._"
- "_Updating..._"
- "_Fetching information.._"
- "_Fetching information..._"
- "_Retrieving information.._"
- "_Retrieving information..._"
When you are updating your strings, you can use some tags to display specific information. They are:
{title}
: bot title as specified on your config.yml{update_date}
: date of the last update{update_time}
: time of last update{btc_value}
: the current value of 1 BTC{currency}
: the currency code you specified (e.g.USD
)
Some tags are only avaliable to use when editing the wallet_view section. Normal tags also apply. They are:
{btc_balance}
: the wallet's BTC balance{money_balance}
: the wallet's BTC balance converted to currency{wallet}
: the wallet's name. This is also avaliable on the wallet_view_falied section.{wallet_address}
: the wallet's address. This is also avaliable on the wallet_view_falied section
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.