Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 3.76 KB

README.md

File metadata and controls

89 lines (68 loc) · 3.76 KB
Raw

Beacon Chain Validator Alerting

Monitors multiple Beacon Chain validators using the free Beaconchain API.

  • This tool has been developed for teams or individuals that manage hundreds or thousands of validators.
  • Valid for any chain supported by Beaconchain, such as Ethereum Mainnet, Gnosis, and Prater.
  • Uses Discord as the destination for the alerts, but it should be really easy to support any other platform.

Tool developed and maintained by Stakely.io, a professional non-custodial staking service established as a new generation of node operators for blockchains of the Web3 ecosystem.


Requirements

  • Node.js 16 or higher
  • An accesible MySQL server with the following schema:
CREATE TABLE `beacon_chain_validators_monitoring` (
  `beacon_chain_validator_monitoring_id` int UNSIGNED NOT NULL,
  `public_key` varchar(96) COLLATE utf8mb4_unicode_ci NOT NULL,
  `validator_index` int UNSIGNED DEFAULT NULL,
  `network` varchar(32) COLLATE utf8mb4_unicode_ci NOT NULL,
  `protocol` varchar(30) COLLATE utf8mb4_unicode_ci NOT NULL,
  `balance` bigint DEFAULT NULL,
  `is_alert_active` tinyint(1) NOT NULL DEFAULT '1',
  `slashed` tinyint(1) DEFAULT NULL,
  `status` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `last_epoch_checked` int UNSIGNED DEFAULT NULL,
  `vc_location` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

Setup

Copy the env.example file to .env and set your custom variables.

Install the Node.js dependencies with npm install.


Run

Load validator public keys

Place one or more deposit data json files in the deposits/ folder and import the public keys. The network will be auto detected.

node src/import_deposits.js deposits/<file name>
# Eg. node src/import_deposits.js deposits/deposit_data-1641143430.json

Check validators

You can test if the script works properly with

node src/check_validators.js <network>
# Eg. node src/check_validators.js gnosis

Configure the Crontab to execute the check_validators.js script periodically. This example performs two checks per network per hour.

crontab -e
23,43 * * * * node /your/custom/path/beacon-chain-validator-alerting/src/check_validators.js mainnet  >> /your/custom/path/beacon-chain-validator-alerting/mainnet.log 2>&1
24,44 * * * * node /your/custom/path/beacon-chain-validator-alerting/src/check_validators.js gnosis  >> /your/custom/path/beacon-chain-validator-alerting/gnosis.log 2>&1
25,45 * * * * node /your/custom/path/beacon-chain-validator-alerting/src/check_validators.js prater  >> /your/custom/path/beacon-chain-validator-alerting/prater.log 2>&1

If you have many validators you may need to reduce the check period in order to not hit the Beaconchain API rate limit.

An alternative is to pay for the Beaconchain Paid API.

DVT validators update

There is a script to load dvt dinamyc validators into DB. As the validator set may be changing due to DVT; we built this script that will ensure having the last set in our db. It will insert new validators, update existing ones with last metada and delte the vals that have left the set.

  • Right now it only works with SSV

You can test if the script works properly with

node src/dvt_validators_update.js <dvt_software> <network>
# Eg. node src/dvt_validators_update.js ssv mainnet

Configure the Crontab to execute the check_validators.js script periodically. Proposed crontab is every 6 hours

crontab -e
0 */6 * * * node /your/custom/path/beacon-chain-validator-alerting/src/dvt_validators_update.js ssv mainnet