Add Validator Setup Guide #683
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA new documentation file has been introduced, providing a detailed, step-by-step guide for setting up a validator node on the Axone testnet. The guide covers prerequisites, key management, acquiring testnet tokens, preparing configuration files, understanding commission parameters, submitting the validator creation transaction, backing up critical files, and verifying validator status. The document includes warnings, tips, and references to assist users throughout the process. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (6)
docs/nodes/validator.md (6)
1-3: Enhance frontmatter metadata for better sidebar display.Consider adding a
sidebar_label(e.g.,"Create a Validator") to the frontmatter so the sidebar entry uses a descriptive title. This helps readers navigate the docs more easily.Example diff:
--- -sidebar_position: 1 +sidebar_position: 1 +sidebar_label: "Create a Validator" ---
21-23: Normalize admonition block indentation.The
:::warningblock is indented by two spaces, which may prevent it from rendering correctly. Flush it to the left margin:- :::warning - After generating a new key, you’ll receive... - ::: +:::warning +After generating a new key, you’ll receive... +:::
41-43: Add the missing article in the faucet sentence.For grammatical accuracy, insert “the” before “faucet”:
-You can get testnet $AXONE tokens from faucet: +You can get testnet $AXONE tokens from the faucet:🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: You might be missing the article “the” here.
Context: ... You can get testnet $AXONE tokens from faucet: - [Axone testnet faucet](https://fauc...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
92-96: Normalize the second admonition block indentation.Remove leading spaces so that the
:::warningrenders correctly:- :::warning - When setting commission parameters... - ::: +:::warning +When setting commission parameters... +:::
97-99: Remove excessive blank lines before code block.Markdownlint flags multiple consecutive blank lines. Reduce them to a single blank line:
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
98-98: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
100-110: Ensure fenced code blocks and tips are surrounded by single blank lines.Add or remove blank lines to satisfy markdownlint’s
blanks-around-fencesrule. For example:-3. You're now ready to submit the transaction and create your validator ```bash axoned tx staking create-validator ...+3. You're now ready to submit the transaction and create your validator
axoned tx staking create-validator ...:::tip
This is just a sample transaction...
:::<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 100-100: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) --- 107-107: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between f9c631d287d62c6de32bb9d5d9fab76098820b47 and f9137d08322a8b33710f0ce612688c2dea71f0da. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/nodes/validator.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/nodes/validator.md</summary> [uncategorized] ~41-~41: You might be missing the article “the” here. Context: ... You can get testnet $AXONE tokens from faucet: - [Axone testnet faucet](https://fauc... (AI_EN_LECTOR_MISSING_DETERMINER_THE) --- [uncategorized] ~53-~53: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). Context: ...or Once your node is fully synchronized and you've acquired the necessary $AXONE to... (COMMA_COMPOUND_SENTENCE) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>docs/nodes/validator.md</summary> 98-98: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 100-100: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) --- 107-107: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>docs/nodes/validator.md (2)</summary> `11-11`: **Verify the relative path for the Node Installation Guide link.** The link `(installation)` may not resolve correctly depending on your docs structure. Please confirm and adjust it to a valid relative path or include the file extension (e.g., `../installation.md` or `installation.md`) to avoid broken links. --- `112-119`: _🛠️ Refactor suggestion_ **Fix duplicated heading numbers.** After renumbering the creation steps, update the subsequent section headings to maintain sequential order: ```diff -## 3. Make sure to create backups of all important files before proceeding +## 4. Make sure to create backups of all important files before proceeding -## 4. Check your validator +## 5. Check your validatorLikely an incorrect or invalid review comment.
|
@coderabbitai resolve |
✅ Actions performedComments resolved. |
Co-authored-by: Chris <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/nodes/validator.md (2)
98-99: 🛠️ Refactor suggestionFix the numbered list gap.
The steps jump from “2.” to “4.”, which can confuse readers. Renumber the final step to “3.”:
-4. You're now ready to submit the transaction and create your validator +3. You're now ready to submit the transaction and create your validator🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
98-98: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
90-91: 🛠️ Refactor suggestionRephrase the commission instruction for clarity.
The sentence is grammatically awkward and may confuse readers. Consider rewriting it to clearly separate actions and reference the correct field names.
For example:-Max-change-rate, set the initial self-delegation `amount`, and must replace the key field with your own validator `key` from earlier. +Set the `commission-max-change-rate`, specify the initial self-delegation `amount`, and replace the `pubkey` field with your validator’s key obtained earlier.
🧹 Nitpick comments (1)
docs/nodes/validator.md (1)
98-108: Enforce proper blank lines around code fences.Markdownlint flags missing blank lines and excess blank lines around fenced code blocks. Please ensure:
- A single blank line before and after each triple backtick fence.
- Only one blank line between paragraphs.
For example:
-...previous content -```bash -axoned tx staking create-validator ... -``` -:::tip +...previous content +```bash +axoned tx staking create-validator ... +``` +:::tip🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
98-98: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
100-100: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
107-107: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/nodes/validator.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/nodes/validator.md
[uncategorized] ~53-~53: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...or Once your node is fully synchronized and you've acquired the necessary $AXONE to...
(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
docs/nodes/validator.md
98-98: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
100-100: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
107-107: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/nodes/validator.md (4)
41-44: Add missing article for clarity in faucet link
The phrase “from faucet” should read “from the faucet” for grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: You might be missing the article “the” here.
Context: ... You can get testnet $AXONE tokens from faucet: - [Axone testnet faucet](https://fauc...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
53-53: Add comma for compound clause
Insert a comma before “and” to separate the independent clauses for better readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...or Once your node is fully synchronized and you've acquired the necessary $AXONE to...(COMMA_COMPOUND_SENTENCE)
90-91: Clarify and rephrase commission and pubkey instruction
The sentence is unclear and grammatically awkward. Consider rewriting it to clearly instruct the user to set the appropriate fields.Proposed diff:
@@ -90,2 +90,2 - Max-change-rate, set the initial self-delegation `amount`, and must replace the key field with your own validator `key` from earlier. + Set the `commission-max-change-rate`, specify the initial self-delegation `amount`, and replace the `pubkey` field with your validator’s key obtained earlier in step 1.
100-100: Ensure fenced code blocks have surrounding blank lines
Markdown lint rule MD031 requires at least one blank line before and after fenced code blocks for improved readability.Example diff:
@@ -99,3 +99,5 - ```bash + + ```bash axoned tx staking create-validator validator.json \ @@ -106,3 +108,5 - ``` + ``` +Also applies to: 107-107
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
100-100: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/nodes/validator.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/nodes/validator.md
[uncategorized] ~41-~41: You might be missing the article “the” here.
Context: ... You can get testnet $AXONE tokens from faucet: - [Axone testnet faucet](https://fauc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~53-~53: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...or Once your node is fully synchronized and you've acquired the necessary $AXONE to...
(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
docs/nodes/validator.md
98-98: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
100-100: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
107-107: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
🔇 Additional comments (1)
docs/nodes/validator.md (1)
123-124: Verify CLI command for checking validator status
The commandaxoned query consensus comet validator-setmay not be valid in the Axone CLI. Typically, validator status is queried viaaxoned query staking validatorsor a similar endpoint. Please confirm and update this command to the correct one.
Summary by CodeRabbit