Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Validators section #89

Merged
merged 3 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions .vitepress/navigation.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export const navigation = {
{
key: 'Migration',
main: {
classes: 'bg-gradient-gold hocus:bg-gradient-gold-darkened',
iconClasses: 'i-nimiq:icons-lg-sparkling-swap text-white/20 rotate-y-180 rotate-z-180',
classes: 'bg-gradient-orange hocus:bg-gradient-orange-darkened',
iconClasses: 'i-nimiq:icons-lg-sparkling-swap text-white/20',
label: 'Migration',
title: 'PoW to PoS',
description: 'Everything about the migration.',
Expand Down Expand Up @@ -99,10 +99,38 @@ export const navigation = {
],
},
{
key: 'Learn',
key: 'Validators',
main: {
classes: 'bg-gradient-green hocus:bg-gradient-green-darkened',
iconClasses: 'i-nimiq:icons-lg-cubes text-[#1DA186] rotate-y-180 rotate-z-180',
iconClasses: 'i-nimiq:icons-lg-verified text-white/20',
label: 'Validators',
title: 'Your Staking and Pools Hub',
description: 'Find all the resources needed for stakers and staking pools in the Nimiq ecosystem.',
href: '/validators/',
},
items: [
{
title: 'Add Your Pool to the Wallet',
href: 'https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators',
description: 'Follow this guide to make your pool available in the Nimiq Wallet.',
},
{
title: 'Validator Trustscore',
href: '/validators/validator-trustscore/',
description: 'Understand the scoring system.',
},
{
title: 'FAQs for Stakers and Pools',
href: '/validators/staking-faq/',
description: 'Get answers to common questions about staking and pools.',
},
],
},
{
key: 'Learn',
main: {
classes: 'bg-gradient-gold hocus:bg-gradient-gold-darkened',
iconClasses: 'i-nimiq:icons-lg-cubes text-white/20',
label: 'Learn',
title: 'The technology',
description: 'What makes Nimiq a truly unique blockchain.',
Expand Down
14 changes: 13 additions & 1 deletion .vitepress/sidebar.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,19 @@ export const sidebar: DefaultTheme.Sidebar = {
],
},
],

'/validators/': [
{
text: 'Validators',
icon: 'i-nimiq:icons-lg-three-hands-hexagon text-white/20 rotate-y-180 rotate-z-180',
link: '/validators/',
items: [
{ text: 'Home', link: '/validators/' },
{ text: 'Staking Pools Handbook', link: '/validators/staking-handbook' },
{ text: 'Validator Trustscore', link: '/validators/validator-trustscore' },
{ text: 'Staking FAQ', link: '/validators/staking-faq' },
],
},
],
'/migration/': [
{
text: 'Migration',
Expand Down
36 changes: 36 additions & 0 deletions validators/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
links:
- bgColor: gold
icon: i-nimiq:icons-lg-three-hands-hexagon
label: Staking Pool Guide
title: Guide for Staking Pools
description: Learn how to set up and integrate your pool in the Nimiq ecosystem.
href: https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators
layout: lg
span: 6
- label: Pool Handbook
title: Staking Pools Handbook
description: Explore guidelines and best practices for pool operators.
href: staking-handbook
- label: Trustscore
title: Validator Trustscore
description: Understand how trust scores are calculated and maintained.
href: validator-trustscore
- label: FAQ
ines-toupeira marked this conversation as resolved.
Show resolved Hide resolved
title: Any Question?
href: staking-faq
description: Check our most frequent questions.
---

# Validators Hub

Welcome to the Validators Hub, the go-to resource for stakers and pool operators in the Nimiq ecosystem. Whether you’re setting up a new staking pool, managing an existing one, or looking for key resources to support your efforts, this section offers comprehensive guidance and tools.

<Grid class="nq-raw" :items="$frontmatter.links" mt-64 />

### What You'll Find Here

- **Staking Pool Guide**: Step-by-step instructions for setting up and integrating your pool with the Nimiq ecosystem.
- **Staking Pool Handbook**: Detailed guidelines for pool operators, focusing on best practices, transparency, and ethical operations.
- **Validator Trustscore**: Insights into the trust score system, its calculation, and maintaining a good reputation.
- **Most Asked Questions**: Find answers to common questions from stakers and pool operators to help you navigate the staking process.
123 changes: 123 additions & 0 deletions validators/staking-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Comprehensive Staking FAQ

Staking allows you to delegate your NIM to a validator, helping secure the network while earning rewards. Whether you're new to staking or looking for details about validators, rewards, or the Proof-of-Stake protocol, **this FAQ covers everything you need to know**. Explore topics such as unstaking periods, selecting a staking pool, and contributing to decentralization.

## General Staking Information

### What is Staking?

Staking is the process of delegating tokens to a validator. The validator then uses these tokens to validate transactions and produce blocks on your behalf.

### What is a validator?

A validator is the block producer of Proof-of-Stake blockchains, like a miner in Proof-of-Work blockchains. Validators produce blocks according to a consensus algorithm.

### What is a staking pool?

While a validator is an individual entity, a staking pool combines the tokens of multiple participants into a single large entity, increasing their collective stake and chances of winning rewards.

### How does staking help the Nimiq network?

Staking enhances the security and decentralization of the Nimiq network. Validators, backed by staked NIM, verify transactions and create new blocks. The network relies on this process to remain operational. Distributing stakes evenly across many validators reduces the risk of centralization, ensuring no single entity can control the network. This balance supports the network's reliability, resilience, and long-term sustainability.

### What happens if I don’t stake?

You can choose not to stake and not earn any rewards. By not staking, you miss the opportunity to help maintain the network secure and decentralized.

How long does it take to have my funds available after I un-stake?

Once you un-stake your funds, it usually takes between 12 hours to 4 days for them to become available. The exact time frame depends on your validator's status. In rare cases, validators can be "jailed" for up to 4 days, which may delay access to your funds.

## Rewards

### How much can I earn by staking?

The amount of NIM you will receive depends on multiple factors, such as the amount of NIM you have delegated to your validator or staking pool and the time you have been staking. You can use our [Staking Calculator](https://www.nimiq.com/staking-calculator/) to estimate the potential rewards you can earn.

### How do staking rewards work?

When you delegate your NIM, your validator uses it to help secure the network. In return, it earns rewards, which are shared with its stakers. You don’t need any technical knowledge to start staking.

### How long does it take to start earning rewards after staking?

The periodicity of reward distribution depends on your validator policies. These rewards are paid off-chain. Check your validator to understand the specific distribution schedules and earnings.

### Can I re-stake my rewards?

Yes. If you are staking to a validator, you can manually re-stake your rewards. If you are staking with a staking pool, you can automatically set to re-stake once you earn rewards.

### I haven’t received my rewards in a while; what can I do?

If you haven’t received your rewards when you were supposed to, you can contact your validator or staking pool. According to the Nimiq PoS protocol, validators who get jailed get their funds locked for a 4 day period, which may coincide with the day of the reward distribution.

## Staking Pool Selection

### How do I pick a Staking Pool?

When selecting a Staking Pool, consider the following factors to make an informed decision:

- **Pool Fee**: Pools charge a fee for maintaining and operating the validator infrastructure. Compare the fees of different pools to find one that aligns with your preferences.

- **Decentralization**: A well-distributed stake ensures a healthy and secure Proof of Stake network. Each pool is assigned a score, indicating how staking with them contributes to the overall balance of the network.

- **Pool-Specific Features**: Explore the unique features offered by each pool. Some pools may provide benefits like automatic re-staking, dynamic fees, or additional services. Check their websites or connect with their community on [Nimiq’s Discord](https://discord.gg/nimiq) to learn more.

### Can I switch the Staking Pool / Validator to which I have staked my NIM?

Yes, you can change the Staking Pool or Validator to which you've staked your NIM at any time. To do this, you'll need to unstake your NIM from the current validator and then stake it with a new one. Please note that there is an unstaking period before your NIM becomes available again for staking with a different validator. This process involves two transactions: one to signal that you no longer want to stake and a second one to retrieve your funds once they are unstaked, which happens after the next macro block, a maximum of twelve hours later.

### Can I stake to multiple validators?

You can only stake with one validator per wallet address. To stake with multiple validators, you’ll need to create additional wallet addresses. Simply create a new wallet, transfer funds to it, and stake with your chosen validator under that new wallet address.

What happens if the validator I’m staking with goes offline?

If the validator you're staking with goes offline, it will be deactivated and will not receive rewards during its inactivity. As a staker, this means you won't earn rewards from that validator while it's offline. However, you retain full control over your NIM and can choose to unstake and delegate to a different validator at any time. Keep in mind that unstaking involves a lock-up period before your funds become available for redelegation.

## Staking Requirements

### What is the minimum amount required to stake?

To participate in staking Nimiq (NIM), a minimum of 100 NIM is required.

### I want to increase the amount I’m staking. Can I do that?

You can always increase or decrease the amount of stake you have delegated to your validator; however, you must keep at least the minimum deposit at all times.

### Do I need to have a Nimiq Wallet?

The Nimiq Wallet provides an easy, intuitive, and fully self-custodial staking experience. While third-party wallets may support NIM staking in the future, currently, the Nimiq Wallet is the primary platform for staking your NIM.

### Which wallets support staking?

Currently, the Nimiq Wallet is the primary platform supporting NIM staking. It offers an intuitive, self-custodial experience, allowing you to stake your NIM directly. While third-party wallets may support NIM staking in the future, currently, the Nimiq Wallet is the main option for staking.

### Can I stake directly from an exchange?

Currently, exchanges that support NIM do not offer direct staking functionality. However, they are participating in the migration to Proof-of-Stake, which lays the groundwork for potential future support.

## Proof-of-Stake Protocol

### How does the Nimiq Proof of Stake protocol ensure that all validators follow the rules?

There is a system of rewards and punishments for validators. Validators are rewarded for validating transactions and producing blocks according to the consensus protocol, incentivizing good behavior. If a validator fails to follow the rules, they may face a punishment such as losing rewards or being temporarily “jailed” for up to 4 days, during which they cannot participate or earn rewards. This combination of rewards and punishments motivates validators to follow the rules. If you would like to learn more about validators, rewards, and punishments, you can refer to the [protocol documentation](https://www.nimiq.com/developers/learn/).

### Can I lose my funds when staking?

You cannot lose your skated funds in Nimiq under normal circumstances, as they remain under your ownership. However, if your validator misbehaves or performs poorly, it may lose rewards or be jailed temporarily, impacting your earnings but not your staked funds.

## Miscellaneous

### Is staking taxable?

The tax treatment of crypto staking rewards depends on your local regulations. We recommend consulting a local tax professional and reviewing the crypto tax guidelines in your jurisdiction to ensure compliance.

Please note: Depositing and withdrawing your cryptocurrency from a staking pool is typically not considered a taxable event, similar to other wallet-to-wallet transfers. However, it is still important to confirm this with your local crypto tax guidelines.

Another great way to find answers is by asking the Nimiq community. Try [Telegram](https://t.me/joinchat/AAAAAEJW-ozFwo7Er9jpHw) for general questions and [Discord](https://discord.gg/cMHemg8) for tech-related inquiries.

### Do I have to pay fees for staking?

Staking with Nimiq is simple and cost-effective, with no fees for staking directly through Nimiq. However, you must select a third-party validator to stake with. Validators run staking pools that secure the network, similar to miners in a Proof of Work blockchain, and charge a small fee for their services, which varies by validator. Most validators provide details about their fees and services on their website or staking pool information page.

Be sure to review these details and the terms of the staking provider before staking.
46 changes: 46 additions & 0 deletions validators/staking-handbook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Staking Pools Handbook

This handbook provides guidelines for the staking pools on the Nimiq network. It covers best practices, a code of conduct, and general standards required to ensure a fair and transparent experience for the stakers. The document outlines the requirements for staking pools, which are based on single validators, to integrate with the Nimiq Wallet. This integration helps stakers make informed decisions when choosing where to stake their funds.

Pool operators are **fully responsible for setting up and maintaining their pools**, including creating the payout system and ensuring compliance with these guidelines. While validators can operate independently, staking pools allow multiple users to stake their funds with a single validator.

This page is intended for those operating a staking pool who wish to be listed on the [Nimiq Wallet](https://wallet.nimiq.com/). The [validators-API repository](https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators) provides the tools and JSON schema for integrating staking pools with the wallet. By following these guidelines and submitting a complete JSON file via PR (pull request), pool operators can ensure their pool is displayed correctly in the wallet.

## General Rules

To maintain trust and integrity for the stakers, pool operators must follow some basic rules.

- **Transparency**: Communicate pool terms, including fees, reward timelines, and operational details. Pool operators are advised to maintain a website or any other accessible point of contact where their rules and terms are clearly outlined.
- **Honesty**: Do not make misleading claims, such as advertising 0% fees while charging hidden fees.
- **Compliance**: Submit a PR with your pool’s data in a JSON file following the guidelines outlined in the [README](https://github.com/nimiq/validators-api?tab=readme-ov-file#README).
- **Payout Commitments**: Ensure timely and accurate payouts to stakers. Clearly define and communicate any fees to stakers. Avoid ambiguous language in your terms.

## Code of Conduct

All pool operators must comply with the following ethical and behavioral standards:

- Do not engage in discriminatory behavior or harassment based on race, gender, sexual orientation, religion, or other personal characteristics. No hate speech, political messaging, pornography, child abuse, etc.
- Avoid sharing or promoting illegal content.
- Ensure all claims about the pool, such as fees and performance metrics, are accurate and verifiable.

Failure to comply with this will result in immediate actions, including potential suspension or removal from the wallet.

## **Submitting your Pool via PR**

Pool operators are required to submit a JSON file containing key details about their pool. Ensure the JSON file is complete and adheres to the guide to avoid delays in the review process. The JSON file includes fields such as:

- Pool name and description
- Address
- Fee structure (fixed or dynamic)
- Payout type and schedule
- Contact information

The review process consists of two steps:

1. **PR Review**: When a pool submits a PR with a JSON file describing its information, someone from the Nimiq team will review it within 3 business days. This step ensures the JSON file is complete, adheres to the guidelines, and accurately describes the pool's setup. If any required information is missing, the pool operator will be contacted to provide the details. The PR will be rejected if there is any misconduct or lack of transparency. Monitoring is currently manual, with plans to automate in the future.
2. **Fee Verification**: After the initial review and approval, the pool will undergo continuous monitoring to verify its fee structure and payout distributions. This is an ongoing process to ensure transparency and compliance with the stated terms.

### **Links and References**

- [Validator Staking Pools README](https://github.com/nimiq/validators-api?tab=readme-ov-file#nimiq-validators)
- [Become a Validator Guide](https://www.nimiq.com/developers/build/set-up-your-own-node/becoming-a-validator)
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Where:

<figure mb-16>

<iframe src="https://www.desmos.com/calculator/xynm6uphlq" aspect-video frameborder="0" allowfullscreen></iframe>
<iframe src="https://www.desmos.com/calculator/xynm6uphlq?embed" aspect-video frameborder="0" allowfullscreen></iframe>

<figcaption>

Expand Down