Skip to content

w3f/polkadot-watcher-validator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a8fb450 · Jun 11, 2024
May 8, 2024
Oct 21, 2022
Jun 11, 2024
Mar 11, 2023
Jul 27, 2022
May 8, 2024
Aug 19, 2022
Sep 29, 2021
May 11, 2020
Oct 13, 2021
Jan 17, 2020
May 8, 2024
Apr 19, 2024
May 11, 2020
Jun 11, 2024
Jun 11, 2024
Aug 13, 2020
Jun 11, 2024

Repository files navigation

CircleCI

polkadot-watcher-validator

How to Run

Requirements

git clone https://github.com/w3f/polkadot-watcher.git
cd polkadot-watcher
cp config/main.sample.yaml config/main.yaml 
#just the first time

yarn
yarn build
yarn start

About

The watcher is a nodeJs application meant to be connected with a substrate based node through a web socket.
It can then monitor the status of the node, leveraging on mechanisms such as the builtin heartbeat.

Monitoring Features

  • An Active validator has been detected offline
  • An Active validator is risking to be caught offline, please act ASAP
  • A validator is not seleceted by Phragmen alorithm to be part of the active set
  • A validator has changed his payout address destination
  • A validator has an unexpected payout address destination
  • A validator has changed his commission rate
  • A validator has an unexpected commission rate

Unexpected payout address destination

Possible Payout Destination Types are 'Staked' | 'Stash' | 'Controller' | 'Account' | 'None'.
If an expected destination address is specified in the config file, it is implicit that you are expecting a type 'Account' to be matched.

Resources

Configuration

A sample config file is provided here

Validators from Git

The list of your addresses can be dynamically retrieved (app startup/restart) from a Git file. Check the GitConfigLoader implementation.

Prometheus

A Prometheus instance can be attached to this application thanks to the endpoint exposed at /metrics.
An Alerting system can be then built on top of that, see here

Deployment

The Dockerfile can be deployed into a Kubernetes cluster thanks to the polkadot-watcher chart.