Skip to content

Commit

Permalink
docs: added recommendations for validator info
Browse files Browse the repository at this point in the history
  • Loading branch information
onmax committed Nov 18, 2024
1 parent dd189a9 commit a104105
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 42 deletions.
63 changes: 44 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,57 @@ Details of validators in the Nimiq Blockchain and their scores, calculated using

[![Fetch Missing Epochs](https://github.com/nimiq/validators-api/actions/workflows/fetch-epochs.yml/badge.svg)](https://github.com/nimiq/validators-api/actions/workflows/fetch-epochs.yml)

> [!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 [example.json](./public/validators/main-albatross/.example.json) in the `./public/validators/main-albatross` directory.
## Add your validator information

If you run your own validator and want it to be recognized, you can add a name, logo and other publicly available fields. For example, the Nimiq Wallet will use this information to display your validator to users.

In order to do so, follow these steps:

1. [Fork this repository](https://github.com/nimiq/validators-api/fork).
2. Create a new file in the [validators folder](./public/validators/main-albatross) with the structure explained below:
2. Create a new file in the [validators folder](./public/validators/main-albatross).
2.1 Read the [Recommendations for Writing Your Validator Information](#recommendations-for-writing-your-validator-information)
2.2 Learn about the [JSON schema](#validator-json-schema)
3. Submit a PR to this repo. Someone in the team will review it.
4. Once the PR is submitted, check that the [API endpoint](https://validators-api-mainnet.nuxt.dev/api/v1) is returning your information. It can take a few minutes.

> [!WARNING]
> Nimiq reserves the right to make minor adjustments to the content submitted by validator owners, if deemed necessary.
### Recommendations for Writing Your Validator Information

This information will be displayed in mainly the wallet to help stakers decide which pool they want to stake in. Use this opportunity to make a great impression:

- **Length**: Keep it short and to the point - 1-2 sentences, ideally 20-40 words.
- **Be concise and clear**: Highlight what makes your pool stand out. Focus on stakeholder values such as reliability, transparency or low fees.
- **Play to your strengths**: Mention features such as high uptime, low fees, strong community support or environmentally friendly practices.
- **Avoid financial advice**: Refrain from promising potential returns or financial outcomes.
- **Use a Friendly Tone**: Make your message approachable and welcoming, while maintaining professionalism.

#### Description

##### Good Example

> "Our pool offers 99.9% uptime, low fees, and strong security, ensuring a seamless staking experience. Join us for a reliable, transparent, and staker-focused service."
##### Bad Example

> "Stake with us for unmatched rewards and the highest profits! Don’t miss your chance to earn big — this is the ultimate opportunity for stakers!"
#### Payout Schedule

<details>
<summary>Validator JSON fields</summary>
##### Good Example

> "Every 12 hours"
> "Every Monday"
##### Bad Example

> "Every 2 epochs"
### Validator JSON schema

You can use the [example JSON](./public/validators/main-albatross/.example.json) as a template.

When you add your validator information, you'll need to include certain keys in your JSON file. Below is an explanation of each key and its possible values:

Expand All @@ -34,7 +71,7 @@ When you add your validator information, you'll need to include certain keys in
- `restake`: Rewards are automatically restaked.
- `direct`: Rewards are paid directly into the staker's wallet and are not automatically restaked.
- `none`: No rewards will be paid out.
- `payoutSchedule` (optional): A string to indicate the payout schedule. This could be helpful for users to know when to expect rewards. Any string is valid. e.g: 'Daily', 'Twice a day', 'Once per trimester'...
- `payoutSchedule` (optional): A string to indicate the payout schedule. This could be helpful for users to know when to expect rewards. Any string is valid. e.g: 'Daily', 'Every 12 hours'...
- `name` (optional): The name of the validator. If not specified, the address of the validator is used by default.
- `description` (optional): A short description of your validator.
- `website` (optional): The URL of your validator's website.
Expand All @@ -52,18 +89,6 @@ When you add your validator information, you'll need to include certain keys in
- `instagram` (optional). e.g. `@nimiq`
- `youtube` (optional). e.g. `nimiq`

You can also checkout [JSON example](./public/validators/main-albatross/.example.json).

</details>

3. Submit a PR to this repo. Someone in the team will review it.
4. Once the PR is submitted, check that the [API endpoint](https://validators-api-mainnet.nuxt.dev/api/v1) is returning your information. It can take a few minutes.

> By submitting this information, various Nimiq applications, such as the Nimiq Wallet, will show users the fields you have submitted and the Validator Score associated with your validator in the future. You can read more about the Validator Score in the [Developer's Center (Preview)](https://deploy-preview-21--developer-center.netlify.app/learn/validator-trust-score).
> [!WARNING]
> Nimiq reserves the right to make minor adjustments to the content submitted by validator owners, if deemed necessary.
## Validators Dashboard

https://validators-api-mainnet.pages.dev/
Expand Down
File renamed without changes.
23 changes: 0 additions & 23 deletions public/validators/test-albatross/.example.json

This file was deleted.

0 comments on commit a104105

Please sign in to comment.