Details of validators in the Nimiq Blockchain and their scores, calculated using Nimiq's VTS algorithm.
Note
If you're a validator and would like to add your data to the API, please open a pull request (PR) with your JSON file, following the structure of ./public/validators/.example in the ./public/validators directory.
https://validators-api.pages.dev/
The dashboard is a simple Nuxt application that displays all validators and their scores.
| Endpoint | Description |
|---|---|
| /api/v1/scores | An endpoint that returns the list of validators and their scores. |
| /api/v1/scores/health | An endpoint that returns the state of the database. |
This is a npm package that calculates the Trust Score of a validator. You can read more about the Score here.
The validator details are hardcoded into the server/database/seed.ts file. If you are responsible for a validator and want to update the information, please open a PR with your information. This process may change in the future.
pnpm install
pnpm devNote
We use Nuxt Hub which uses Cloudflare Pages + Cloudflare D1 databases. The database is a sqlite instance and currently the database is remote for both development and production. You can change this behaviour in nuxt.config.ts.
We use Drizzle to access the database.
To calculate the score, we need to run two processes: the fetcher and the score calculator. We do this using a Nitro Task, which is currently an experimental feature of Nitro. Nitro Task is a feature that allows you to trigger an action in the server programmatically or manually from the Nuxt Dev Center(go to tasks page).
Read more about the process of computing the score in the nimiq-validators-score package.
As well as storing the Validator Details, we also store the data produced by the fetcher in a sqlite database. This data is then used in the score calculator to compute the score. You can see the file schema.ts.
Once it is cloned and installed the dependencies, you must run:
pnpm db:generate
pnpm dev # or pnpm dev:remote to use the remote database