diff --git a/docs/validators/index.mdx b/docs/validators/index.mdx index 6f047832..d01d21c5 100644 --- a/docs/validators/index.mdx +++ b/docs/validators/index.mdx @@ -36,7 +36,7 @@ Take the steps to set up your validator account: ## Manage your account -your account > **My profile**. - - -2. Find **Finality Vote Key** and then click **Add key**. - - -3. Enter your *BLS public key* in the **Finality Vote Key** field. - - -4. Ensure that the key is saved. - diff --git a/docs/validators/manage/address.mdx b/docs/validators/manage/address.mdx new file mode 100644 index 00000000..72f39e6a --- /dev/null +++ b/docs/validators/manage/address.mdx @@ -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**. + + +2. In the **Admin Address** field, click the edit icon. + + +3. Paste your new admin address and save the change. + + +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. +::: diff --git a/docs/validators/manage/assets/activity.png b/docs/validators/manage/assets/activity.png index 4381c004..4f0af669 100644 Binary files a/docs/validators/manage/assets/activity.png and b/docs/validators/manage/assets/activity.png differ diff --git a/docs/validators/manage/assets/add-finality-key-1.png b/docs/validators/manage/assets/add-finality-key-1.png new file mode 100644 index 00000000..0f19a456 Binary files /dev/null and b/docs/validators/manage/assets/add-finality-key-1.png differ diff --git a/docs/validators/manage/assets/add-finality-key-2.png b/docs/validators/manage/assets/add-finality-key-2.png new file mode 100644 index 00000000..3f9d8dbc Binary files /dev/null and b/docs/validators/manage/assets/add-finality-key-2.png differ diff --git a/docs/validators/manage/assets/analytics.png b/docs/validators/manage/assets/analytics.png index e47a0985..3490f915 100644 Binary files a/docs/validators/manage/assets/analytics.png and b/docs/validators/manage/assets/analytics.png differ diff --git a/docs/validators/manage/assets/change-admin-address-1.png b/docs/validators/manage/assets/change-admin-address-1.png new file mode 100644 index 00000000..f8d18632 Binary files /dev/null and b/docs/validators/manage/assets/change-admin-address-1.png differ diff --git a/docs/validators/manage/assets/change-admin-address-2.png b/docs/validators/manage/assets/change-admin-address-2.png new file mode 100644 index 00000000..faa7f6a1 Binary files /dev/null and b/docs/validators/manage/assets/change-admin-address-2.png differ diff --git a/docs/validators/manage/assets/change-commission-step-1.png b/docs/validators/manage/assets/change-commission-step-1.png index f57d20bf..799bf7e0 100644 Binary files a/docs/validators/manage/assets/change-commission-step-1.png and b/docs/validators/manage/assets/change-commission-step-1.png differ diff --git a/docs/validators/manage/assets/change-commission-step-3.png b/docs/validators/manage/assets/change-commission-step-3.png index 9cbb6336..f004c59e 100644 Binary files a/docs/validators/manage/assets/change-commission-step-3.png and b/docs/validators/manage/assets/change-commission-step-3.png differ diff --git a/docs/validators/manage/assets/edit-finality-key-1.png b/docs/validators/manage/assets/edit-finality-key-1.png new file mode 100644 index 00000000..cb71ff90 Binary files /dev/null and b/docs/validators/manage/assets/edit-finality-key-1.png differ diff --git a/docs/validators/manage/assets/edit-finality-key-2.png b/docs/validators/manage/assets/edit-finality-key-2.png new file mode 100644 index 00000000..04291f15 Binary files /dev/null and b/docs/validators/manage/assets/edit-finality-key-2.png differ diff --git a/docs/validators/manage/assets/emergency-exit.png b/docs/validators/manage/assets/emergency-exit.png index e0c8cfdc..29d3fd7f 100644 Binary files a/docs/validators/manage/assets/emergency-exit.png and b/docs/validators/manage/assets/emergency-exit.png differ diff --git a/docs/validators/manage/assets/finality-key-1.png b/docs/validators/manage/assets/finality-key-1.png deleted file mode 100644 index 47c43919..00000000 Binary files a/docs/validators/manage/assets/finality-key-1.png and /dev/null differ diff --git a/docs/validators/manage/assets/finality-key-2.png b/docs/validators/manage/assets/finality-key-2.png deleted file mode 100644 index 9a854868..00000000 Binary files a/docs/validators/manage/assets/finality-key-2.png and /dev/null differ diff --git a/docs/validators/manage/assets/finality-key-3.png b/docs/validators/manage/assets/finality-key-3.png deleted file mode 100644 index aed2fd44..00000000 Binary files a/docs/validators/manage/assets/finality-key-3.png and /dev/null differ diff --git a/docs/validators/manage/assets/governing-validator-profile.png b/docs/validators/manage/assets/governing-validator-profile.png new file mode 100644 index 00000000..f2709bd7 Binary files /dev/null and b/docs/validators/manage/assets/governing-validator-profile.png differ diff --git a/docs/validators/manage/assets/maintenance-ongoing.png b/docs/validators/manage/assets/maintenance-ongoing.png index 53a442f8..f7213c80 100644 Binary files a/docs/validators/manage/assets/maintenance-ongoing.png and b/docs/validators/manage/assets/maintenance-ongoing.png differ diff --git a/docs/validators/manage/assets/maintenance-upcoming.png b/docs/validators/manage/assets/maintenance-upcoming.png index 93d86079..e5722b1d 100644 Binary files a/docs/validators/manage/assets/maintenance-upcoming.png and b/docs/validators/manage/assets/maintenance-upcoming.png differ diff --git a/docs/validators/manage/assets/profile.png b/docs/validators/manage/assets/profile.png index 8dd0935b..a33b7c93 100644 Binary files a/docs/validators/manage/assets/profile.png and b/docs/validators/manage/assets/profile.png differ diff --git a/docs/validators/manage/assets/renounce-step-1.png b/docs/validators/manage/assets/renounce-step-1.png index 02648709..411dd3a4 100644 Binary files a/docs/validators/manage/assets/renounce-step-1.png and b/docs/validators/manage/assets/renounce-step-1.png differ diff --git a/docs/validators/manage/assets/schedule-maintenance-step-1.png b/docs/validators/manage/assets/schedule-maintenance-step-1.png index e1f45de1..8f503e53 100644 Binary files a/docs/validators/manage/assets/schedule-maintenance-step-1.png and b/docs/validators/manage/assets/schedule-maintenance-step-1.png differ diff --git a/docs/validators/manage/assets/schedule-maintenance-step-2.png b/docs/validators/manage/assets/schedule-maintenance-step-2.png index d53264b0..8dd1e665 100644 Binary files a/docs/validators/manage/assets/schedule-maintenance-step-2.png and b/docs/validators/manage/assets/schedule-maintenance-step-2.png differ diff --git a/docs/validators/manage/assets/standard-validator-profile.png b/docs/validators/manage/assets/standard-validator-profile.png new file mode 100644 index 00000000..ded5a59b Binary files /dev/null and b/docs/validators/manage/assets/standard-validator-profile.png differ diff --git a/docs/validators/manage/change-commission.mdx b/docs/validators/manage/change-commission.mdx index d911ff41..133b5bb7 100644 --- a/docs/validators/manage/change-commission.mdx +++ b/docs/validators/manage/change-commission.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then go to your account, and then click **Commission rate**. + -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. - +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. + -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. diff --git a/docs/validators/manage/claim-rewards.mdx b/docs/validators/manage/claim-rewards.mdx index 50529da2..e9f84004 100644 --- a/docs/validators/manage/claim-rewards.mdx +++ b/docs/validators/manage/claim-rewards.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select +**My Staking**, and then click **Claim all**. + -2. Select **Claim now**. - +2. Click **Claim now**. + 3. Confirm the transaction. - + 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**. diff --git a/docs/validators/manage/finality-vote-key.mdx b/docs/validators/manage/finality-vote-key.mdx new file mode 100644 index 00000000..b923c7b6 --- /dev/null +++ b/docs/validators/manage/finality-vote-key.mdx @@ -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**. + + +2. In the **Finality Vote Key** field, click **Add key**. + + +3. Paste your BLS public key and the proof of posession. + + +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**. + + +2. In the **Finality Vote Key** field, click the edit icon. + + +3. Paste your new BLS public key and the proof of posession. + + +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. +::: \ No newline at end of file diff --git a/docs/validators/manage/increase-withdraw-stake.mdx b/docs/validators/manage/increase-withdraw-stake.mdx index 9c4eba08..3cfc4bc6 100644 --- a/docs/validators/manage/increase-withdraw-stake.mdx +++ b/docs/validators/manage/increase-withdraw-stake.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, and then click **Stake more**. + 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. - + 3. Confirm the transaction. - + After the transaction is confirmed, you can review its details on the **Activities** tab or check the status in @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, expand the options, and then click **Withdraw**. + 2. Enter the amount manually or choose **Max** to withdraw the entire stake, and then select **Withdraw**. - + 3. Confirm the transaction. - + After the transaction is confirmed, you can review its details on the **Activities** tab or check the status in diff --git a/docs/validators/manage/renounce-role.mdx b/docs/validators/manage/renounce-role.mdx index 9edddb79..afb6fbd7 100644 --- a/docs/validators/manage/renounce-role.mdx +++ b/docs/validators/manage/renounce-role.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Renounce**. + 2. Confirm your decision. Keep in mind that renunciation is permanent and cannot be undone. - + 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. diff --git a/docs/validators/manage/schedule-maintenance.mdx b/docs/validators/manage/schedule-maintenance.mdx index 3851774c..2258052f 100644 --- a/docs/validators/manage/schedule-maintenance.mdx +++ b/docs/validators/manage/schedule-maintenance.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Maintenance mode**. + 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. - + 3. After you submit the request, the system displays the status and duration of the maintenance period. - -

- + +

+ diff --git a/docs/validators/manage/take-emergency-exit.mdx b/docs/validators/manage/take-emergency-exit.mdx index 6a05db25..327b7d35 100644 --- a/docs/validators/manage/take-emergency-exit.mdx +++ b/docs/validators/manage/take-emergency-exit.mdx @@ -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**. - +1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Emergency exit**. + 2. Read through the terms and then click **Submit request**. - + -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. - +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. + ## Result diff --git a/docs/validators/manage/view-activity.mdx b/docs/validators/manage/view-activity.mdx index 7ecc44b8..2f0f512b 100644 --- a/docs/validators/manage/view-activity.mdx +++ b/docs/validators/manage/view-activity.mdx @@ -5,9 +5,7 @@ title: View activity import activity from './assets/activity.png'; -View your activity, such as staking operations, -reward claims, and reward distributions, on -[Validator Dashboard](https://validator.roninchain.com/) > -**My Staking** > **Activities**. +To view your activity, such as staking operations, +reward claims, and reward distributions, open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, then open the **Activities** tab. diff --git a/docs/validators/manage/view-analytics.mdx b/docs/validators/manage/view-analytics.mdx index 865e11ff..a9ec9425 100644 --- a/docs/validators/manage/view-analytics.mdx +++ b/docs/validators/manage/view-analytics.mdx @@ -5,8 +5,7 @@ title: View analytics import analytics from './assets/analytics.png'; -View analytics about the rewards you earned and the blocks you -produced over different periods on [Validator Dashboard](https://validator.roninchain.com/) > -**My Staking** > **Analytics**. +To view analytics about the rewards you earned and the blocks you +produced over different periods, open the [Validator Dashboard](https://validator.roninchain.com), then select **My Staking**, then open the **Analytics** tab. diff --git a/docs/validators/manage/view-profile.mdx b/docs/validators/manage/view-profile.mdx index 105442e2..2b90b57a 100644 --- a/docs/validators/manage/view-profile.mdx +++ b/docs/validators/manage/view-profile.mdx @@ -4,30 +4,32 @@ title: View profile --- import profile from './assets/profile.png'; -import governingAddresses from './assets/governing-addresses.png'; +import standardProfile from './assets/standard-validator-profile.png'; +import governorProfile from './assets/governing-validator-profile.png'; -View the list of addresses linked to your validator account on -[Validator Dashboard](https://validator.roninchain.com) > -your account > **My profile**. +Your validator profile is where you can view and modify the addresses linked to your validator account. + +To access your profile, open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **My profile**. If you’re a Standard Validator or a Validator Candidate, -your profile has a set of the following addresses and details: +your profile contains the following addresses: + + -* **Admin address.** The address used to manage your profile, -staking activities, and claiming rewards. +* **Admin address.** The address used to manage your profile and +staking activities, and to claim rewards. You can change this address. For more information, see [Change your admin address](address.mdx#admin). * **Validator address.** The address used for producing blocks. This address is displayed to delegators and also called “consensus address”. * **Bridge operator address.** The address used for operating [Ronin Bridge](https://bridge.roninchain.com/). * **Bridge governor address.** The address used to vote on changes to the bridge, such as pausing the bridge or adding bridge operators. -* **Finality vote key.** This is the [cryptographic key](add-finality-vote-key.mdx) used to vote -for blocks in the fast finality mechanism. +* **Finality vote key.** This is the [cryptographic key](finality-vote-key.mdx) used to vote +for blocks in the fast finality mechanism. You can change this key. For more information, see [Change your finality vote key](finality-vote-key.mdx#change). -If you’re a Governing Validator, your profile has an additional address: -**Chain governor address.** This address is used to +If you’re a Governing Validator, your profile has an additional **Governing validator address,** used to [create proposals](./../governance/create-proposal.mdx) and [vote](./../governance/vote-on-proposal.mdx) on changes to the validator set. - + diff --git a/docs/validators/onboarding/become-validator.mdx b/docs/validators/onboarding/become-validator.mdx index 2ba99b38..94fd0f7b 100644 --- a/docs/validators/onboarding/become-validator.mdx +++ b/docs/validators/onboarding/become-validator.mdx @@ -56,7 +56,7 @@ It's also highly recommended that you read the 5. Provide the initial stake of RON. -6. Enter your fast finality vote key—see [Add finality vote key](./../manage/add-finality-vote-key.mdx) for details. +6. Enter your fast finality vote key—see [Add or change finality vote key](../manage/finality-vote-key.mdx) for details. Congratulations, you're now a Validator Candidate. diff --git a/sidebars.js b/sidebars.js index 687dde08..953b8022 100644 --- a/sidebars.js +++ b/sidebars.js @@ -242,10 +242,12 @@ const sidebars = { slug: '/validators/manage', }, items: [ - // Add finality vote key - 'validators/manage/add-finality-vote-key', + // Add or change finality vote key + 'validators/manage/finality-vote-key', // Change commission rate 'validators/manage/change-commission', + // Change admin address + 'validators/manage/address', // Claim rewards 'validators/manage/claim-rewards', // Increase or move stake