README.md

tfgrid monitoring bot

This is a bot to monitor some TFGrid functionalities here is a list:

• liveness of grid proxy on different networks and rmb call behavior to some farmer nodes. If all selected farmer nodes failed for a specific network the bot will send an alert message otherwise It won't send any messages.
• the balance in accounts and send warnings if it is under some threshold.
• transactions to/from stellar bridge.

How to start

• Create a new telegram bot if you don't have.

• Create a new env file .env, for example:

  TESTNET_MNEMONIC=<your mainnet mnemonic>
  MAINNET_MNEMONIC=<your testnet mnemonic>
  DEVNET_MNEMONIC=<your devnet mnemonic>
  QANET_MNEMONIC=<your qanet mnemonic>
  DEV_FARM_NAME=Freefarm
  QA_FARM_NAME=Freefarm
  MAIN_FARM_NAME=Freefarm
  TEST_FARM_NAME=FreeFarm
  BOT_TOKEN=<bot token. you got it after creating the bot>
  CHAT_ID=<your personal chat ID, where bot will send you >
  MINS=<number of minutes between each message>
  PUBLIC_STELLAR_SECRET=<stellar account secret on stellar public network>
  PUBLIC_STELLAR_ADDRESS=<stellar account address on stellar public network>
  TEST_STELLAR_SECRET=<stellar account secret on stellar test network>
  TEST_STELLAR_ADDRESS=<stellar account address on stellar test network>

| Note: wallets on Stellar should have some lumens for the fees, stellar charges about 0.00001 xlm per txn.

• Create a new json file wallets.json and add the list of addresses you want to monitor, for example:

  {
  "testnet": [
      {
      "name": "<your wallet name>",
      "address": "<your tfchain address>",
      "threshold": 700
      }
  ],
  "mainnet": [
      {
      "name": "<your wallet name>",
      "address": "<your tfchain address>",
      "threshold": 700
      }
  ],
  "devnet": [
      {
      "name": "<your wallet name>",
      "address": "<your tfchain address>",
      "threshold": 700
      }
  ],
  "qanet": [
      {
      "name": "<your wallet name>",
      "address": "<your tfchain address>",
      "threshold": 700
      }
  ]
  }

• Run the bot:

  • From the src:

    go run main.go -e .env -w wallets.json -d

  • From the release binary:

    Download the latest from the releases page

    sudo cp monitoring-bot /usr/local/bin
    monitoring-bot -e .env -w wallets.json -d

    Where

    • -e .env is the environment file (default is .env)
    • -w wallets.json is the json file of wallets to be monitored (default is wallets.json)
    • -d is set to allow debug level while monitoring (default is false)

• Run using docker:

  • build

  docker build -t monitoring-bot -f Dockerfile ../

  • run (mount .env and wallets.json from your current directory to the container using -v)

  docker run -v $(pwd)/wallets.json:/wallets.json -v $(pwd)/.env:/.env monitoring-bot run -e /.env -w /wallets.json -d

Create a bot if you don't have

• Open telegram app

• Create a new bot

  1. Find telegram bot named "@botfarther"
  2. Type /newbot
  

• Get the bot token

  1. In the same bot named "@botfarther"
  2. Type /token
  3. Choose your bot
  

• Get your chat ID

  1. Search for @RawDataBot and select Telegram Bot Raw from the drop-down list.
  2. In the json returned, you will find it in section message -> chat -> id
  

Build

make build

Test

make test