SCRT

command module
v0.0.0-...-344a3b9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 20, 2021 License: MIT Imports: 6 Imported by: 0

README

SCRT alerting tool

  • SCRT alerting tool will send alerts to your telegram account about your validator status (jailed or voting) and about missed blocks.

Install Prerequisites

  • Go 13.x+

Getting Started

git clone https://github.com/Chainflow/SCRT.git
cd SCRT
cp example.config.toml config.toml

Configure the following variables in config.toml

  • tg_chat_id

    Telegram chat ID to receive Telegram alerts, required for Telegram alerting.

  • tg_bot_token

    Telegram bot token, required for Telegram alerting. The bot should be added to the chat and should have send message permission.

  • alert_time1 and alert_time2

    These are for regular status updates. To receive validator status daily (twice), configure these parameters in the form of "02:25PM". The time here refers to UTC time.

  • val_operator_addr

    Operator address of your validator which will be used to get staking, delegation and distribution rewards.

  • account_addr

    Your validator account address which will be used to get account informtion etc.

  • validator_hex_addr

    Validator hex address useful to know about last proposed block, missed blocks and voting power.

  • lcd_endpoint

    Address of your lcd client (ex: http://localhost:1317).

  • external_rpc

    External open RPC endpoint(secondary RPC other than your own validator). Useful to gather information like validator caught up, syncing and missed blocks etc.

After populating config.toml - build and run the alerting bot binary

$ go build -o scrt-alert-bot && ./scrt-alert-bot

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL