docs: update validator docs

[robert-zaremba]

Description

closes: #XXXX

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• added ! to the type prefix if API or client breaking change
• added appropriate labels to the PR
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• updated the relevant documentation or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage
• manually tested (if applicable)

Summary by CodeRabbit

• Documentation
  • Updated the README.md to correct a link for Validator Instructions.
  • Enhanced Validator Instructions in the documentation with:
    • Reminder to run the correct binary for testnet or mainnet.
    • Updated build instructions for different operating systems.
    • Added references for chain upgrades on both mainnet and testnet.
    • Revised download instructions for binary builds and container images.
    • Clarified the verification step for libwasm linkage.
    • Emphasized setting non-zero min gas prices in app.toml.
    • Improved clarity in running umeed and price-feeder locally for the testnet.
    • Enhanced instructions for joining the testnet, including Discord server participation and delegation process.

[coderabbitai]

Walkthrough

This update focuses on enhancing the documentation for validators, ensuring they have the most accurate and helpful instructions. It includes updating a README.md link for better accessibility and enriching the VALIDATOR.md with crucial reminders, improved instructions for binary building across operating systems, chain upgrade references, and guidance for verifying libwasm linkage. This comprehensive refresh aims to streamline the setup process for validators, whether they're on testnet or mainnet.

Changes

File(s)	Summary
README.md	Updated a link to point to the correct Validator Instructions location.
docs/VALIDATOR.md	Enhanced with binary run reminders, OS-specific build instructions, chain upgrade references, updated binary and container download instructions, and a libwasm linkage check step.

🐇✨
In the realm of code, where changes take flight,
A rabbit hopped in, to make things just right.
Links and instructions, now gleaming and new,
For validators far and wide, a guide true and true.
So hop along, dear friends, with joy in your quest,
With docs now refreshed, to build your nest best.
🌟📚

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1300a9a and 41181ef.

Files selected for processing (2)

• README.md (1 hunks)
• docs/VALIDATOR.md (1 hunks)

Additional comments: 6

docs/VALIDATOR.md (5)

• 17-17: In the section about obtaining the umeed binary, you've added a reminder to ensure validators run the correct binary for either the testnet or the mainnet and consult chain upgrades. This is a crucial addition for operational clarity and helps prevent validators from running outdated or incorrect versions of the binary. However, it would be beneficial to also include a brief explanation or link on how to identify the correct binary version for new validators who might not be familiar with the process.
• 19-19: The instructions for copying libwasmvm when building the binary on a different OS than the validator OS are clear and concise. However, it's important to ensure that the command provided is universally applicable and that the destination path (running_os:/<lib/path>) is explained or exemplified for less experienced users. Additionally, consider adding a note about potential security implications of using scp and ensuring a secure connection.
• 27-27: The update to the download instructions for the binary build and container image is comprehensive, catering to different user preferences and technical requirements. However, it's essential to clarify the statement "The binary build is compatible with the latest Ubuntu LTS x86-64" by specifying the exact Ubuntu version it refers to, as "latest" can become outdated quickly. Also, ensure that the instructions for copying libwasmvm are clear and include any necessary steps for verification after copying.
• 35-35: Clarifying the step for checking if libwasm is linked correctly is a valuable addition. It would be helpful to include an expected output or success indicator for the umeed version command to assist validators in verifying the linkage. This small enhancement can significantly improve the user experience by providing immediate feedback on whether the setup was successful.
• 14-36: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]

The terms "testnet" and "mainnet" are correctly used in the context of blockchain networks and do not require correction to "test net" or "main net." However, it's essential to maintain consistency in terminology throughout the document to avoid confusion.

README.md (1)

• 198-198: The link to Validator Instructions has been updated to point to the correct location. This is a crucial update for ensuring users have access to accurate and relevant information efficiently.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 41181ef and 4cb79df.

Files selected for processing (1)

• docs/VALIDATOR.md (4 hunks)

Additional comments: 8

docs/VALIDATOR.md (8)

• 17-17: The instructions for ensuring the correct binary version is run for either testnet or mainnet are clear and helpful. However, it might be beneficial to provide a brief example or command snippet that demonstrates how to identify the correct binary version for each environment. This could further assist validators in making the right choice without needing to navigate through external links immediately.
• 19-19: The instructions for copying libwasmvm when building the binary on a different OS are clear. However, it's important to ensure that users understand the implications of copying libraries between different operating systems and architectures. A brief note on compatibility issues or additional steps required for cross-OS compatibility might be helpful here.
• 27-27: The download instructions for the binary build and container image are updated to include compatibility information and the necessity of copying libwasmvm. This is a valuable update for users. To enhance clarity, consider specifying the steps or conditions under which a user would choose the binary build over the container image or vice versa. This could help users make more informed decisions based on their setup and preferences.
• 33-33: The addition of using the released docker umeed container as an option for obtaining the binary is a good update. It might be beneficial to include a brief example of how to run the container for those unfamiliar with Docker. This could improve accessibility for users new to container technology.
• 35-35: The step to test if libwasm is linked correctly by running umeed version is a crucial addition for troubleshooting. It might be helpful to specify what output or result validators should expect to see if the linkage is successful, providing a clearer indication of success.
• 47-47: The emphasis on setting non-zero minimum gas prices in app.toml is an important update for validators to ensure their nodes operate effectively. It's recommended to also mention the implications of not setting a non-zero minimum gas price, such as the potential for spam transactions, to underscore the importance of this configuration.
• 60-60: The improved clarity in running umeed and price-feeder locally for the testnet, including participation in the Discord server and the delegation process, is a valuable update. It might be beneficial to include a brief troubleshooting section or common issues and their solutions to assist users encountering difficulties during this process.
• 70-70: The enhanced instructions for joining the testnet, including the delegation process, are clear and concise. It's recommended to provide a link or reference to a guide on self-delegation for users who may be unfamiliar with the process, ensuring they have all the necessary information to complete this step successfully.