Axelar Checker

Overview

Axelar Validator Checker is a Node.js application designed to provide tracking features for running blockchain nodes, specifically tailored for Axelar network validators. The application includes a Telegram bot for monitoring validators' uptime, poll votes, supported EVM chains, and RPC health mechanism.

Features

• Validator Tracking: Monitor validators' uptime, poll votes, supported EVM chains, and RPC health.
• Environment Configuration: Utilize an environment file for seamless deployment to Docker. All features are configurable via environment variables.
• Poll Vote Indexing: Index poll votes based on the specified voter address to facilitate tracking and analysis.
• Telegram Notifications: Receive notifications via Telegram based on uptime thresholds and operator performance.

Requirements

Before deploying the application, ensure you have the following prerequisites:

• Docker installed on your system

Docker Installation

To install Docker, follow the steps below:

1. Official Docker Installation Script:

   To quickly install Docker, you can use Docker's official installation script:

   curl -fsSL https://get.docker.com -o get-docker.sh
   sudo sh get-docker.sh

   This script installs Docker on your system.

2. Adding User to the Docker Group (or Please use root user to run container):

   To run Docker commands without sudo, add your user to the docker group:

   sudo usermod -aG docker $USER

   After this command, you may need to log out and log back in for the changes to take effect.

3. Verification of Docker Installation:

   To check if Docker was successfully installed:

   docker --version

   This command prints the installed version of Docker.

Getting Started

To deploy Axelar Validator Checker to Docker, follow these steps:

1. Clone this repository to your local machine.
2. Navigate to the project directory.
3. Create an .env file with the following variables:
   • AXELAR_MAINNET_REST_BASE_URLS: Specify at least three URLs for Axelar Mainnet REST API endpoints.
   • AXELAR_WS_URLS: Specify at least three WebSocket URLs for Axelar.
   • AXELAR_RPC_BASE_URLS: Specify at least three RPC base URLs for Axelar.
   • AXELAR_LCD_BASE_URLS: Specify at least three LCD base URLs for Axelar.
   • AXELAR_VOTER_ADDRESS: Provide your Axelar voter address for poll vote indexing.
   • TG_TOKEN: Generate your own Telegram token and include it in the .env file for Telegram notifications.

Environment Variables

Ensure to include proper environment variables in your .env file please check .env.example file.

Docker Deployment

Once your environment file is configured, you can deploy the deamon application to Docker using the following command:

docker-compose -f docker-compose.prod.yml up -d --build --force-recreate

After Docker Deployment

Please find your bot on Telegram (add the bot to the Telegram group if you wish), and then send the /start or /help command to begin the conversation.

Usage

• Access the Telegram bot to track validators' uptime, poll votes, and more.
• Monitor notifications sent via Telegram based on uptime thresholds and operator performance.

License

This project is licensed under the MIT License