Skip to content

Commit

Permalink
Merge pull request #29 from ronin-chain/fix/RDOC-56
Browse files Browse the repository at this point in the history
fix: FAQ link
  • Loading branch information
RodinGolodin authored Jul 18, 2024
2 parents 0368da9 + e68e76b commit be86e98
Show file tree
Hide file tree
Showing 12 changed files with 41 additions and 30 deletions.
3 changes: 1 addition & 2 deletions docs/basics/acquire-ron.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ There are several ways to purchase RON and other tokens on Ronin. You can purcha

## Set up Ronin Wallet

To store, trade, and receive the RON token you need a cryptocurrency wallet that supports the Ronin blockchain — Ronin Wallet.
For setup instructions, see [Get started with the Ronin Wallet mobile app](https://support.roninchain.com/hc/en-us/articles/14037076528283-Getting-Started-on-Ronin-Mobile-Wallet).
To store, trade, and receive the RON token, you need Ronin Wallet. For setup instructions, see [Get started with the Ronin Wallet mobile app](https://support.roninchain.com/hc/en-us/articles/14037076528283-Getting-Started-on-Ronin-Mobile-Wallet).

## Acquire RON from a CEX

Expand Down
2 changes: 1 addition & 1 deletion docs/bridge-operators/setup/run-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Generate a private key for operating the bridge node. For instructions, see [Gen

This command pulls the bridge image and a Postgres database, and starts the services you defined.

5. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
5. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
6. Review the log for the bridge.

```bash
Expand Down
20 changes: 13 additions & 7 deletions docs/delegators/delegator-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,37 @@ description: List of frequently asked questions for delegators.
title: Delegator FAQ
---

## 1. What if my delegated validator is slashed? {#1}
## Overview

Frequently asked questions for those who stake RON as delegators.

## FAQ

### 1. What if my delegated validator is slashed? {#1}

While your validator is punished through [slashing](./../validators/slashing.mdx), you don't receive staking rewards, but your stake is not affected in any way.

## 2. Will my staking rewards automatically re-stake to my validator? {#2}
### 2. Will my staking rewards automatically re-stake to my validator? {#2}

You can manually [restake](./manage/claim-rewards.mdx#restake-your-rewards) the rewards to your favorite validator.

## 3. Can I withdraw my stake whenever I want without any penalties? {#3}
### 3. Can I withdraw my stake whenever I want without any penalties? {#3}

You can [withdraw your stake](./manage/stake.mdx#withdraw-stake) from one of your validators at any time without penalties, as long as it's been three or more days since you last staked with this validator.

## 4. If I stake RON with a validator today, when will I receive the rewards? {#4}
### 4. If I stake RON with a validator today, when will I receive the rewards? {#4}

The pool of validators for each day is finalized a few minutes past 00:00 UTC. If you stake your RON tokens today, then your stake will take effect around 00:00 UTC the next day. From then on, you'll start earning staking rewards.

## 5. If I move my RON stake from one validator to another, when will I start earning rewards again? {#5}
### 5. If I move my RON stake from one validator to another, when will I start earning rewards again? {#5}

Your RON stake with new validator will start producing rewards from around 00:00 UTC the next day. As for the validator that you moved your stake from, there will be no rewards for the current day because the stake is removed.

## 6. How do I know if my validator is renouncing? {#6}
### 6. How do I know if my validator is renouncing? {#6}

You will receive a notification seven days before the validator's renunciation date. For more ways to keep track of your validators, see [Track validators](./manage/validators.mdx).

## 7. How can I know if a validator is well-performing? {#7}
### 7. How can I know if a validator is well-performing? {#7}

When choosing a validator to stake with, consider the following factors to maximize your RON rewards:

Expand Down
Binary file modified docs/validators/assets/multisig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/validators/setup/mainnet/run-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ Install Docker Engine and the Docker Compose plugin:
```

This command pulls a Ronin node image and starts the service you defined.
5. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
5. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
2 changes: 1 addition & 1 deletion docs/validators/setup/mainnet/run-combined.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ For more information, see [Generate keys](../generate-keys.md).
```

This command pulls a Ronin node image, a bridge image, a Postgres database, and starts the services you defined.
7. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
7. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.

8. Review the log for the validator and the bridge (the node should sync to the latest block for making the bridge work).

Expand Down
2 changes: 1 addition & 1 deletion docs/validators/setup/mainnet/run-non-validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ Install Docker Engine and the Docker Compose plugin:
docker logs node -f --tail 100
```

7. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
7. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
2 changes: 1 addition & 1 deletion docs/validators/setup/mainnet/run-validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Generate a private key for your validator node. For more information, see [Gener
docker logs node -f --tail 100
```

7. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.
7. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page. If it's green, the node is connected and up to date with the network.

## Verify the node is working

Expand Down
2 changes: 1 addition & 1 deletion docs/validators/setup/testnet/run-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ Install Docker Engine and the Docker Compose plugin:

This command pulls a Ronin node image and starts the service you defined.

5. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.
5. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.
2 changes: 1 addition & 1 deletion docs/validators/setup/testnet/run-combined.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ For more information, see [Generate keys](../generate-keys.md).
```

This command pulls a Ronin node image, a bridge image, a Postgres database, and starts the services you defined.
6. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.
6. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.

7. Review the log for the validator and the bridge (the node should sync to the latest block for making the bridge work).

Expand Down
2 changes: 1 addition & 1 deletion docs/validators/setup/testnet/run-non-validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,4 @@ Install Docker Engine and the Docker Compose plugin:
docker logs node -f --tail 100
```

7. After a few minutes, check the status of your node on the [Ronin Network Status](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.
7. After a few minutes, check the status of your node on the [Ronin Analytics](https://ronin-stats.roninchain.com/) page, the **Testnet** section. If it's green, the node is connected and up to date with the network.
32 changes: 19 additions & 13 deletions docs/validators/validator-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,45 @@ title: Validator FAQ

import multisig from './assets/multisig.png';

## 1. How to increase the chance of getting selected as a Standard Validator? {#1}
## Overview

Frequently asked questions for existing and prospect Ronin validators.

## FAQ

### 1. How to increase the chance of getting selected as a Standard Validator? {#1}

The higher your total stake, the stronger your chance of becoming a Standard Validator because Ronin uses a Delegated Proof of Stake (DPoS) consensus mechanism. You can attract more delegators by promoting your validator and maintaining good performance.

## 2. If my self-stake exceeds the minimum staking amount, can I withdraw the extra amount? {#2}
### 2. If my self-stake exceeds the minimum staking amount, can I withdraw the extra amount? {#2}

Yes, you can withdraw as long as three days have passed since you last staked in. Make sure that the remaining amount after withdrawal is at least 250,000 RON.

## 3. What if my stake balance falls below the minimum staking amount? {#3}
### 3. What if my stake balance falls below the minimum staking amount? {#3}

You have *seven* days to deposit more RON to meet the minimum staking amount (250,000 RON), otherwise you will be renounced automatically.

## 4. What are the most important performance metrics for a validator? {#4}
### 4. What are the most important performance metrics for a validator? {#4}

Your uptime, total staking amount, and APR (annual percentage rate).

## 5. What are the rewards for a validator? {#5}
### 5. What are my rewards as a validator? {#5}

Validators receive fixed block rewards and transaction fees for producing blocks on Ronin.

## 6. How can I become a Governing Validator? {#6}
### 6. How can I become a Governing Validator? {#6}

This is done by [submitting](./governance/proposals.mdx) a proposal. Any existing Governing Validator can propose to add another Governing Validator. If the proposal receives enough votes, the proposed validator becomes a Governing Validator.

## 7. How can I get support? {#7}
### 7. How can I get support? {#7}

Join our [Discord](https://discord.gg/roninnetwork) after registering as a Validator Candidate, and look for "validator-" and "node-operators-" channels.

## 8. Should chain governor address be different from admin address? {#8}
### 8. Should chain governor address be different from admin address? {#8}

We recommend using different governor and admin addresses to reduce the impact of leaks or losses to either account.

## 9. How to use a multisig wallet as a validator? {#9}
### 9. How do I use a multisig wallet as a validator? {#9}

Using a multi-signature wallet can provide an additional layer of security when running your validator node.

Expand All @@ -47,19 +53,19 @@ After creating a safe, use your safe's address as an admin or governor address.
Each action with this safe's address requires multiple confirmations depending
on your safe's settings.

<img src={multisig} width={1280} />
<img src={multisig} width={1000} />

## 10. Any recommendation for monitoring node's health? {#10}
### 10. How should I monitor my node's health? {#10}

Consider the following:

* Integrate with the [Ronin Network Status](https://stats.roninchain.com/) page
* Integrate with the [Ronin Analytics](https://ronin-stats.roninchain.com) page
for the overall status of the chain's node.
* For each node, the system publishes metrics on port `6060` for Prometheus
collection. Integrate a Prometheus-Grafana stack for more granular monitoring
of your node's health.

## 11. What ports (if any) have to be open to the outside world? {#11}
### 11. What ports do I need to open to the outside world? {#11}

Keep public ports only for peering and discovery, otherwise keep it internal. Our `docker-compose` configuration already binds RPC port `8545` to `localhost`.

Expand Down

0 comments on commit be86e98

Please sign in to comment.