Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

feat: REP-4 #273

Merged
merged 5 commits into from
Mar 7, 2024
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
2 changes: 1 addition & 1 deletion docs/validators/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Take the steps to set up your validator account:
## Manage your account

<DocCardList items={[
findSidebarItem('/validators/manage/add-finality-vote-key'),
findSidebarItem('/validators/manage/finality-vote-key'),
findSidebarItem('/validators/manage/change-commission'),
findSidebarItem('/validators/manage/claim-rewards'),
findSidebarItem('/validators/manage/increase-withdraw-stake'),
Expand Down
32 changes: 0 additions & 32 deletions docs/validators/manage/add-finality-vote-key.mdx

This file was deleted.

41 changes: 41 additions & 0 deletions docs/validators/manage/address.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
description: Change the addresses in your validator profile.
title: Change addresses
---

import profile from './assets/profile.png';
import changeStepOne from './assets/change-admin-address-1.png';
import changeStepTwo from './assets/change-admin-address-2.png';

## Overview

This guide describes how to change the addresses in your validator profile.

## Change admin address {#admin}

You can change your admin address, used for managing your profile, staking activities, and claiming rewards.

Key points:

* You will not receive staking rewards on the day when you change the admin address, but you will still earn your commission as normal.
* Staking rewards will be sent to your new admin address starting the next day.
* Your current stake amount will be automatically transferred to the new admin address.
* Any unclaimed rewards from your old admin address will remain there, and you can claim them at any time by logging in with the old admin address.

To change your admin address:

1. Open the [Validator Dashboard](https://validator.roninchain.com), then go to your account, and then click **My profile**.
<img src={profile} width={280} />

2. In the **Admin Address** field, click the edit icon.
<img src={changeStepOne} width={400} />

3. Paste your new admin address and save the change.
<img src={changeStepTwo} width={400} />

4. Confirm the transaction.
5. Log in to your profile using the new admin address.

:::info[Cooldown period]
After changing your admin address or fast finality vote key, there's a 24-hour cooldown period. During this time, you won't be able to modify either value until 24 hours after the last change.
:::
Binary file modified docs/validators/manage/assets/activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/analytics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/change-commission-step-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/change-commission-step-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/emergency-exit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/validators/manage/assets/finality-key-1.png
Binary file not shown.
Binary file removed docs/validators/manage/assets/finality-key-2.png
Binary file not shown.
Binary file removed docs/validators/manage/assets/finality-key-3.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/maintenance-ongoing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/maintenance-upcoming.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/renounce-step-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/schedule-maintenance-step-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/validators/manage/assets/schedule-maintenance-step-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 11 additions & 14 deletions docs/validators/manage/change-commission.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
---
title: Change commission rate
description: Set a different commission rate.
title: Change commission
description: Increase or decrease your commission rate.
---

import stepOne from './assets/change-commission-step-1.png';
import stepTwo from './assets/change-commission-step-2.png';
import stepThree from './assets/change-commission-step-3.png';

When [registering](./../onboarding/become-validator.mdx) to become
a validator, you set a commission rate—the percentage of the block reward
When signing up as a validator on Ronin, you were asked to set a commission rate, which is the percentage of the block reward
you receive before distributing the rest to your delegators.

You can change this commission rate in your profile.
You can change the commission rate in your profile:

1. Go to [Validator Dashboard](https://validator.roninchain.com) >
your account > **Commission rate**.
<img src={stepOne} width={280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then go to your account, and then click **Commission rate**.
<img src={stepOne} width={280} />

2. Enter the new commission rate in the range of 0-20%,
and set the date it takes effect.
This date must be at least seven days from today.
<img src={stepTwo} width={416} />
2. Enter the new commission rate in the range of 0-20%, and set the date when it takes effect. This date must be at least seven days from now.
<img src={stepTwo} width={400} />

After you save the new rate, a clock icon is displayed next to the
current rate to indicate the upcoming change.
3. Confirm the change.

After you confirm the new rate, users will see a clock icon next to your current rate, indicating that a change is pending.

<img src={stepThree} width={280} />
21 changes: 10 additions & 11 deletions docs/validators/manage/claim-rewards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,23 @@ Staking reward is calculated each period (approximately one day)
and displayed as “claimable rewards”.
You need to claim this reward manually.

1. Go to [Validator Dashboard](https://validator.roninchain.com) >
**My Staking** > **Claim all**.
<img src={stepOne} width={1280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select
**My Staking**, and then click **Claim all**.
<img src={stepOne} width={1280} />

2. Select **Claim now**.
<img src={stepTwo} width={400} />
2. Click **Claim now**.
<img src={stepTwo} width={400} />

3. Confirm the transaction.
<img src={confirmTransaction} width={400} />
<img src={confirmTransaction} width={400} />

After the transaction is confirmed, the reward is credited to your wallet.

## Claim commission and fast finality rewards

You don't need to claim commission and fast finality reward
You don't need to claim commission and fast finality rewards
because they are transferred to you automatically
in the end of each period (approximately one day).
at the end of each period (approximately one day).

You can, however, keep track of these rewards in
[Validator Dashboard](https://validator.roninchain.com) >
**My Staking** > **Activities**.
You can, however, keep track of these rewards in **Validator Dashboard >
My Staking > Activities**.
101 changes: 101 additions & 0 deletions docs/validators/manage/finality-vote-key.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
description: Add a fast finality vote key to your profile.
title: Add or change finality vote key
---

import profile from './assets/profile.png';
import addStepOne from './assets/add-finality-key-1.png';
import addStepTwo from './assets/add-finality-key-2.png';
import editStepOne from './assets/edit-finality-key-1.png';
import editStepTwo from './assets/edit-finality-key-2.png';

## Overview

This guide demonstrates how to add a *finality vote key* to your profile. The finality vote key is used to vote for blocks in the [fast finality mechanism](https://github.com/axieinfinity/REPs/blob/main/REP-0003.md#rewards). If you're an active Ronin validator, you need to have this key added in order to have the Fast Finality Reward transferred to your admin address by the end of the day.

## Prerequisites

### Generate a BLS key pair

Before you add a finality vote key, you need to generate a BLS key pair. The BLS key pair consists of a private key and a public key. The public BLS key is your finality vote key. For more information, see the [Generate BLS key pair](./../setup/generate-keys.md) guide.

### Generate proof of possession

To prove that you own the finality vote key, you need to generate a proof of possession. The proof of possession is a signature of the public key using the private key.
There are two ways to generate the proof of posession: using the Ronin CLI or using the Docker image.

#### Generate using Ronin CLI

1. Ensure you have the encrypted BLS private key and password in your current directory:
```bash
> tree
.
├── bls_keystore
│ └── all-accounts.keystore.json
└── bls_password
```

2. Run the following command to generate the proof of possession:
```bash
ronin account generate-bls-proof
```

The command will return the BLS public key and the corresponding proof:
```bash
BLS public key #0: {redacted}
BLS proof #0: {redacted}
```

#### Generate using Docker image

1. In the `.env` file of your node's Docker image, add the following line:
```text
GENERATE_BLS_PROOF=true
```

2. Run the following command to start the node:
```bash
docker-compose up -d
```

3. Run the following command to view the logs:
```bash
docker-compose logs node
```

The logs will return the BLS public key and the corresponding proof:

```bash
BLS public key #0: {redacted}
BLS proof #0: {redacted}
```

## Add a finality vote key {#add}

1. Open the [Validator Dashboard](https://validator.roninchain.com), then go to your account, and then click **My profile**.
<img src={profile} width={280} />

2. In the **Finality Vote Key** field, click **Add key**.
<img src={addStepOne} width={400} />

3. Paste your BLS public key and the proof of posession.
<img src={addStepTwo} width={400} />

4. Save the change and confirm the transaction.

## Change your finality vote key {#change}

1. Open the Validator Dashboard, then go to your account, and then click **My profile**.
<img src={profile} width={280} />

2. In the **Finality Vote Key** field, click the edit icon.
<img src={editStepOne} width={400} />

3. Paste your new BLS public key and the proof of posession.
<img src={editStepTwo} width={400} />

4. Save the change and confirm the transaction.

:::info[Cooldown period]
After changing your admin address or fast finality vote key, there's a 24-hour cooldown period. During this time, you won't be able to modify either value until 24 hours after the last change.
:::
20 changes: 9 additions & 11 deletions docs/validators/manage/increase-withdraw-stake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,23 @@ import withdrawStepOne from './assets/withdraw-stake-step-1.png';
import withdrawStepTwo from './assets/withdraw-stake-step-2.png';
import withdrawConfirmTransaction from './assets/confirm-transaction.png';

## Introduction
## Overview

This page demonstrates how to increase or withdraw your self-stake after becoming a validator.

## Stake more

1. Go to [Validator Dashboard](https://validator.roninchain.com/) >
**My Staking** > **Stake more**.
<img src={increaseStepOne} width={1280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, and then click **Stake more**.
<img src={increaseStepOne} width={1280} />

2. Enter the amount manually or choose **Max** to stake all available RON,
and then select **Stake**. The estimated reward is
calculated based on your estimated APR (annual percentage rate),
so you can see how much RON returns from this stake.
<img src={increaseStepTwo} width={400} />
<img src={increaseStepTwo} width={400} />

3. Confirm the transaction.
<img src={increaseConfirmTransaction} width={400} />
<img src={increaseConfirmTransaction} width={400} />

After the transaction is confirmed, you can review its details
on the **Activities** tab or check the status in
Expand All @@ -45,16 +44,15 @@ as a validator in the days after, depending on how much others
have staked.
:::

1. Go to [Validator Dashboard](https://validator.roninchain.com/) >
**My Staking** > expand the options > **Withdraw**.
<img src={withdrawStepOne} width={1280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, expand the options, and then click **Withdraw**.
<img src={withdrawStepOne} width={1280} />

2. Enter the amount manually or choose **Max** to withdraw the
entire stake, and then select **Withdraw**.
<img src={withdrawStepTwo} width={400} />
<img src={withdrawStepTwo} width={400} />

3. Confirm the transaction.
<img src={withdrawConfirmTransaction} width={400} />
<img src={withdrawConfirmTransaction} width={400} />

After the transaction is confirmed, you can review its details on the
**Activities** tab or check the status in
Expand Down
25 changes: 9 additions & 16 deletions docs/validators/manage/renounce-role.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,21 @@ description: Renounce your validator role.
title: Renounce your role
---

import StepOne from './assets/renounce-step-1.png';
import StepTwo from './assets/renounce-step-2.png';
import renounceStepOne from './assets/renounce-step-1.png';
import renounceStepTwo from './assets/renounce-step-2.png';

If you're a Standard Validator or Validator Candidate,
follow this guide to renounce your validator role. If you’re a Governing Validator, contact
the Sky Mavis team.
follow this guide to renounce your validator role. If you’re a Governing Validator, contact Sky Mavis for instructions.

1. Go to [Validator Dashboard](https://validator.roninchain.com) >
your account > **Renounce**.
<img src={StepOne} width={280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Renounce**.
<img src={renounceStepOne} width={280} />

2. Confirm your decision. Keep in mind that renunciation
is permanent and cannot be undone.
<img src={StepTwo} width={500} />
<img src={renounceStepTwo} width={500} />

3. Click **Renounce** to submit the request.

:::caution
After sumbitting the request, you need to wait seven days for
renunciation to take effect. To avoid slashing, keep your node
online and up to date during this period.
:::

Your commission, bridge reward, staking reward, and the remaining
self-stake is transferred to you on the date of renunciation.
After submitting the request, wait seven days for the renunciation to take effect. To avoid slashing, keep your node online and up to date during this period.
Your commission, bridge rewards, staking rewards, and the remaining
self-stake will be transferred to you on the date of renunciation.
13 changes: 6 additions & 7 deletions docs/validators/manage/schedule-maintenance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,16 @@ Maintenance can be scheduled by up to three validators at the same time.
If you are having trouble scheduling maintenance, ask the other validators about their maintenance schedules.
After your current maintenance ends, you need to wait at least three days before scheduling another one.

1. Go to [Validator Dashboard](https://validator.roninchain.com) >
your account > **Maintenance mode**.
<img src={stepOne} width={280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Maintenance mode**.
<img src={stepOne} width={280} />

2. Specify the maintenance duration in epochs.
The valid duration is 3-144 epochs (from about 30 minutes to 24 hours), where 1 epoch equals 200 blocks.
You can choose from the valid start epoch, then decide on the end epoch.
<img src={stepTwo} width={416} />
<img src={stepTwo} width={416} />

3. After you submit the request, the system displays the status
and duration of the maintenance period.
<img src={upcomingMaintenance} width={280} />
<p> </p>
<img src={ongoingMaintenance} width={280} />
<img src={upcomingMaintenance} width={280} />
<p> </p>
<img src={ongoingMaintenance} width={280} />
10 changes: 5 additions & 5 deletions docs/validators/manage/take-emergency-exit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ If you find that your node is compromised, such as when your private keys are st

## Submit your request

1. Go to [Validator Dashboard](https://validator.roninchain.com) > your account > **Emergency exit**.
<img src={exit} width={280} />
1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Emergency exit**.
<img src={exit} width={280} />

2. Read through the terms and then click **Submit request**.
<img src={stepOne} width={500} />
<img src={stepOne} width={500} />

3. After your request is submitted, provide evidence of the attack to the Governing Validators in the [validator-chat](https://discord.com/channels/930892666705694800/1090764739858153553) channel on Ronin Discord.
<img src={stepTwo} width={500} />
3. After your request is submitted, provide evidence of the attack to the Governing Validators in the [#validator-chat](https://discord.com/channels/930892666705694800/1090764739858153553) channel on Ronin Discord.
<img src={stepTwo} width={500} />

## Result

Expand Down
Loading
Loading