Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheqd/validator-status
Network-wide validator status alerting API for cheqd mainnet. Designed to work for any Cosmos SDK network
https://github.com/cheqd/validator-status
bigdipper cheqd cloudflare-workers cosmos-sdk hacktoberfest zapier
Last synced: about 1 month ago
JSON representation
Network-wide validator status alerting API for cheqd mainnet. Designed to work for any Cosmos SDK network
- Host: GitHub
- URL: https://github.com/cheqd/validator-status
- Owner: cheqd
- License: apache-2.0
- Created: 2022-05-12T19:42:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T07:52:42.000Z (5 months ago)
- Last Synced: 2024-08-01T13:37:06.035Z (4 months ago)
- Topics: bigdipper, cheqd, cloudflare-workers, cosmos-sdk, hacktoberfest, zapier
- Language: TypeScript
- Homepage: https://validator-status.cheqd.net/
- Size: 448 KB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - cheqd/validator-status - Network-wide validator status alerting API for cheqd mainnet. Designed to work for any Cosmos SDK network (TypeScript)
README
# Cosmos SDK: Validator Status Alerts API
[](https://github.com/cheqd/validator-status/blob/main/LICENSE)
[](https://github.com/cheqd/validator-status/graphs/contributors)
[](https://github.com/cheqd/validator-status/actions/workflows/dispatch.yml) 
## âšī¸ Overview
Most validator status reporting software in [Cosmos SDK](https://cosmos.network/) is designed to be run *directly* by a node operator to monitor their own nodes. This typically pulls data from [the Tendermint Prometheus metrics sink](https://docs.tendermint.com/v0.34/tendermint-core/metrics.html) exposed on a node.
We wanted to build a way to monitor the status of validator nodes *globally* across the cheqd mainnet, and raise alerts in case validator nodes were losing blocks. (Validator nodes [can get jailed if they miss too many blocks](https://docs.cosmos.network/main/modules/slashing/) and their stake slashed.)
This custom API pulls data for all validator nodes from [a BigDipper block explorer](https://explorer.cheqd.io/) (e.g., [explorer.cheqd.io](https://explorer.cheqd.io/)) and repurposes/wraps [the validator condition results](https://explorer.cheqd.io/validators) into a JSON array.
The API itself can be deployed using [Cloudflare Workers](https://workers.cloudflare.com/) or compatible serverless platforms. Alerting is then achieved using Zapier (a low-code/no-code automation platform) to pipe these alerts to Slack, Discord, etc.
## đ¨ Alerting via Zapier
To simplify the task of alerting via various channels (and to keep it extensible to other channels), we take the output of our validator status API and parse it via [Zapier](https://zapier.com/). This is done as a two-stage process via two separate "Zaps".
Right now, our setup sends these details to the [cheqd Community Slack](http://cheqd.link/join-cheqd-slack) and the [cheqd Community Discord](http://cheqd.link/discord-github).
1. Our validator status API sends [a webhook call to a Zapier "Zap"](https://zapier.com/shared/d407b10516f89da18e35b97ce3ef226bca2ad741) that listens for newly-degraded validators every hour.
2. Lists of degraded validators are compiled using a Zapier "Sub-Zap" to process the data from the API into a usable format and stored in a "digest".
```javascript
const body = JSON.parse(inputData.VALIDATOR_CONDITION);
var degraded = [];
for (let k=0; k