Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.24 KB

README.md

File metadata and controls

55 lines (37 loc) · 2.24 KB
Raw

Telegram proposal tracker bot by your Bro

What is this

This bot is designed to keep up validator governance activity on a decent level. It tracks upcoming and active proposals in every specified network and gently (sometimes not very:) reminds about the necessity to vote. We at Bro_n_Bro, have used this bot for a while now, and it helps to keep all governance happening in the front. It is targeted mainly at validators (and their teams) but also might be suitable for someone who likes to track specific validator governance activity.

Setup

Firstly fill config.py inside data/ folder.

  1. Insert telegram bot parameters (yes you'll need one to send reminders, use BotFather to create it):
TG_BOT_API_TOKEN = '123456789:jbd78sadvbdy63d37gda37bd8'
CHAT_ID = -122987163
  1. Fill networks part. Rest api with http or https access required (it is the one that usually runs on 1317 port). Validators valoper address required.
    {
        "name": "osmosis",
        "lcd_api": "http://lcd.osmosis-1",
        "validator": "osmovaloper13tk45jkxgf7w0nxquup3suwaz2tx483xe832ge",
        "prefix": "osmo",
        "explorer": "https://www.mintscan.io/osmosis/proposals/"
    }

It is possible to add or remove networks upon own requiremens\set of chains you need to monitor.

  1. Run the thing:
doker-compose up --detach .

Docker image should be built and lauched after. Track container logs to see if everyghing configured correctly.

Behavior

The bot will track active proposals in every chain configured and will send notifications in case the configured validator hasn't voted for every active proposal.

It is possible to adjust notifications timeframes and frequency in config.py.

NOTIFIER_REMINDER_MODES = {
        "SOFT": (range(345_600, 3_036_800), 86_400)

The first time range defines how soon proposal will end, the last one is how often to send reminder. All numbers are in seconds so keep the formatting as it was in case of adjusting.

Also, motivational phrases are located at the very bottom of config.py, which might be updated if needed.