fix: add 0x notice

ronin-chain · Nov 7, 2024 · 440957d · 440957d
1 parent d0025e2
commit 440957d
Show file tree

Hide file tree

Showing 15 changed files with 35 additions and 46 deletions.
diff --git a/docs/basics/key-concepts.md → docs/basics/key-concepts.mdx b/docs/basics/key-concepts.md → docs/basics/key-concepts.mdx
@@ -41,7 +41,7 @@ Boneh-Lynn-Shacham (BLS) is a digital signature method used for verifying the au
 
 The BLS key is what the validator uses to produce finality votes. Validators who produce finality vote receive a reward. If a validator fails to produce a finality vote, no slashing penalty applies.
 
-To attach a BLS key to a validator, either a new validator must be created or an existing validator must be [updated](./../validators/setup/generate-keys.md) with this key.
+To attach a BLS key to a validator, either a new validator must be created or an existing validator must be [updated](./../validators/setup/generate-keys.mdx) with this key.
 
 ### Bridge
 
@@ -103,6 +103,10 @@ A delegator is a RON token holder—an individual or institution—who contribut
 
 ## E
 
+### ECDSA key
+
+An Elliptic Curve Digital Signature Algorithm (ECDSA) key is a cryptographic key used to secure transactions on the blockchain and are generated by the validator to sign blocks. You need this key to run a validator node on Ronin.
+
 ### Epoch
 
 While this varies depending on the blockchain protocol, an epoch generally refers to a specific number of blocks—or a specific or approximate period of time. Generally found on blockchains that utilize Proof of Stake (PoS), different PoS protocols have different ways of defining an epoch (if they use them). Epochs are used to reach security checkpoints, distribute the staking reward, or assign a new group of blockchain validators. For example, an epoch on Ronin lasts 200 blocks, which is roughly equal to 10 minutes.

diff --git a/docs/bridge-operators/setup/run-bridge.mdx b/docs/bridge-operators/setup/run-bridge.mdx
@@ -30,7 +30,7 @@ Have two RPC endpoints ready:
 
 ### Private key
 
-Generate a private key for operating the bridge node. For instructions, see [Generate keys](./../../validators/setup/generate-keys.md).
+Generate a private key for operating the bridge node. For instructions, see [Generate keys](./../../validators/setup/generate-keys.mdx).
 
 ## Steps
 

diff --git a/docs/validators/manage/assets/add-finality-key-1.png b/docs/validators/manage/assets/add-finality-key-1.png
diff --git a/docs/validators/manage/assets/add-finality-key-2.png b/docs/validators/manage/assets/add-finality-key-2.png
diff --git a/docs/validators/manage/assets/edit-finality-key-1.png b/docs/validators/manage/assets/edit-finality-key-1.png
diff --git a/docs/validators/manage/assets/edit-finality-key-2.png b/docs/validators/manage/assets/edit-finality-key-2.png
diff --git a/docs/validators/manage/assets/profile.png b/docs/validators/manage/assets/profile.png
diff --git a/docs/validators/manage/finality.mdx b/docs/validators/manage/finality.mdx
@@ -6,20 +6,20 @@ 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 rewards transferred to your admin address by the end of the day.
+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 to have the fast finality rewards 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.
+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.mdx) guide.
 
-### Generate proof of possession
+## Steps
+
+### Step 1. 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 possession: using the Ronin CLI or using the Docker image.
@@ -70,32 +70,21 @@ BLS public key #0: {redacted}
 BLS proof #0: {redacted}
 ```
 
-## Add a finality vote key {#add}
+### Step 2. Add or change your finality vote key
+
+**Note**: The keys you generated do not have the `0x` prefix. Before submitting the form, make sure to add the `0x` prefix to the keys.
 
 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**.
+2. In the **Finality Vote Key** field, click **Add key** or the edit icon.
    <img src={addStepOne} width={400} />
 
 3. Paste your BLS public key and the proof of possession.
    <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 possession.
-   <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.
-:::
+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.
+:::
diff --git a/docs/validators/onboarding/become-validator.mdx b/docs/validators/onboarding/become-validator.mdx
@@ -46,7 +46,8 @@ It's also highly recommended that you read the <a href="/basics/white-paper" tar
 3. Set up your validator node following the instructions in the [Validator Node Setup](/validators/setup/mainnet) guide.
     <img src={stepTwo} width={1000} />
 
-4. Fill in your addresses, the commission rate, the fast finality vote key, and the proof of possession. For more information, see [Add or change finality vote key](../manage/finality.mdx).
+4. Fill in your addresses, the commission rate, the fast finality vote key, and the proof of possession. For more information, see [Add or change finality vote key](../manage/finality.mdx). **Note:** The tool generating the keys produces them without the `0x` prefix. Before submitting the form, make sure to add the `0x` prefix to the keys.
+
     <img src={stepThree} width={1000} />
 
 5. Provide the initial stake of 250,000 RON from your connected Ronin Wallet.

diff --git a/docs/validators/setup/assets/extension.png b/docs/validators/setup/assets/extension.png
diff --git a/docs/validators/setup/assets/mobile.png b/docs/validators/setup/assets/mobile.png
diff --git a/docs/validators/setup/generate-keys.md → docs/validators/setup/generate-keys.mdx b/docs/validators/setup/generate-keys.md → docs/validators/setup/generate-keys.mdx
@@ -3,9 +3,6 @@ description: Securely generate private keys for your validator node.
 title: Generate private keys
 ---
 
-import extension from './assets/extension.png';
-import mobile from './assets/mobile.png';
-
 ## Overview
 
 Each validator node requires private keys for signing blocks and consensus messages sent to the other validators in the network.
@@ -17,9 +14,7 @@ The required private keys include a BLS key and an ECDSA key. The keys are named
 
 ## Prerequisites
 
-Go (version 1.20 or later). Follow the
-[installation instructions](https://go.dev/doc/install)
-on the official website.
+Go (version 1.20 or later). Follow the [installation instructions](https://go.dev/doc/install) on the official website.
 
 ## Generate a BLS key
 
@@ -142,15 +137,15 @@ You can generate an ECDSA key pair using the Ronin command-line tool (CLI) or th
 
 ### Generate using Ronin Wallet
 
-ECDSA keys can also be generated using [Ronin Wallet](https://wallet.roninchain.com/), both the browser extension and the mobile app. Follow the steps in the flow diagrams provided in the following sections.
+ECDSA keys can also be generated using [Ronin Wallet](https://wallet.roninchain.com/), both the browser extension and the mobile app.
 
 #### Browser extension
 
-<img src={extension} width={1200} />
+In the browser extension, go to **Settings > your account > Show Private Key > Proceed**.
 
 #### Mobile app
 
-<img src={mobile} width={1200} />
+In the mobile app, go to **Settings > Account > Show Private Key > Proceed**.
 
 ## See also
 

diff --git a/docs/validators/setup/mainnet/run-combined.mdx b/docs/validators/setup/mainnet/run-combined.mdx
@@ -32,7 +32,7 @@ Generate private keys for operating the nodes:
 * One key for the validator node
 * One key for the bridge operator
 
-For more information, see [Generate keys](../generate-keys.md).
+For more information, see [Generate keys](../generate-keys.mdx).
 
 ## Steps
 
@@ -156,14 +156,14 @@ For more information, see [Generate keys](../generate-keys.md).
    # Your bridge operator private key without the 0x prefix
    LISTENERS__RONIN__SECRET__BRIDGEOPERATOR__PLAINPRIVATEKEY=<BRIDGE_OPERATOR_PRIVATE_KEY>
  
-   # Your validator private key without the 0x prefix
-   VALIDATOR_PRIVATE_KEY=<VALIDATOR_PRIVATE_KEY>
+   # Your ECDSA private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-an-ecdsa-key
+   VALIDATOR_PRIVATE_KEY=<ECDSA_PRIVATE_KEY>
  
    # The password used to encrypt the node's private key file
    PASSWORD=<PASSWORD>
  
    # BLS Wallet features
-   # Your BLS private key without the 0x prefix
+   # Your BLS private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-a-bls-key
    BLS_PRIVATE_KEY=<BLS_PRIVATE_KEY>
  
    # The password used to encrypt the BLS private key file

diff --git a/docs/validators/setup/mainnet/run-validator.mdx b/docs/validators/setup/mainnet/run-validator.mdx
@@ -20,7 +20,7 @@ Install Docker Engine and the Docker Compose plugin:
 
 ### Private key
 
-Generate a private key for your validator node. For more information, see [Generate keys](../generate-keys.md).
+Generate a private key for your validator node. For more information, see [Generate keys](../generate-keys.mdx).
 
 ## Steps
 
@@ -85,14 +85,14 @@ Generate a private key for your validator node. For more information, see [Gener
    # The latest version of the node's image as listed in https://docs.roninchain.com/validators/setup/upgrade-validator
    NODE_IMAGE=<NODE_IMAGE>
  
-   # Your validator private key without the 0x prefix
-   VALIDATOR_PRIVATE_KEY=<VALIDATOR_PRIVATE_KEY>
+   # Your ECDSA private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-an-ecdsa-key
+   VALIDATOR_PRIVATE_KEY=<ECDSA_PRIVATE_KEY>
  
    # The password used to encrypt the node's private key file
    PASSWORD=<PASSWORD>
  
    # BLS Wallet features
-   # Your BLS private key without the 0x prefix
+   # Your BLS private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-a-bls-key
    BLS_PRIVATE_KEY=<BLS_PRIVATE_KEY>
  
    # The password used to encrypt the BLS private key file

diff --git a/docs/validators/setup/testnet/run-combined.mdx b/docs/validators/setup/testnet/run-combined.mdx
@@ -32,7 +32,7 @@ Generate private keys for operating the nodes:
 * One key for the validator
 * One key for the bridge
 
-For more information, see [Generate keys](../generate-keys.md).
+For more information, see [Generate keys](../generate-keys.mdx).
 
 ## Steps
 
@@ -152,14 +152,14 @@ For more information, see [Generate keys](../generate-keys.md).
    # Your bridge operator private key without the 0x prefix
    BRIDGE_OPERATOR_PRIVATE_KEY=<BRIDGE_OPERATOR_PRIVATE_KEY>
    
-   # Your validator private key without the 0x prefix
-   VALIDATOR_PRIVATE_KEY=<VALIDATOR_PRIVATE_KEY>
+   # Your ECDSA private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-an-ecdsa-key
+   VALIDATOR_PRIVATE_KEY=<ECDSA_PRIVATE_KEY>
  
    # The password used to encrypt the node's private key file
    PASSWORD=<PASSWORD>
  
    # BLS Wallet features
-   # Your BLS private key without the 0x prefix
+   # Your BLS private key without the 0x prefix, see https://docs.roninchain.com/validators/setup/generate-keys#generate-a-bls-key
    BLS_PRIVATE_KEY=<BLS_PRIVATE_KEY>
  
    # The password used to encrypt the BLS private key file