docs: Update consensus-node.md
Overview
updated the mainnet persistent peers script to include the id and address. Found this when setting up a mainnet consensus node.
Summary by CodeRabbit
-
New Features
- Improved peer connection configuration for consensus nodes. Peer settings now use a combined identifier and address format, which may enhance connectivity and reliability during node operations.
-
Documentation
- Updated setup guidelines to reflect the revised peer configuration format, ensuring users follow the latest instructions for robust node connectivity.
Walkthrough
The changes update the command in the persistent peers setup for a Celestia consensus node configuration. The command now fetches a JSON file from a Celestia chain source and extracts both the peer ID and address in the format id@address. The updated output is then used to update the configuration file (config.toml). No changes were made to public entities.
Changes
| File(s) | Change Summary |
|---|---|
| how-to-guides/.../consensus-node.md | Modified the command to set PERSISTENT_PEERS: now fetching from a Celestia chain JSON file and extracting peer details in id@address format. |
Sequence Diagram(s)
sequenceDiagram
participant User as Node Operator
participant Shell as Shell Command
participant JSON as CelestiaChainJSON
participant Config as config.toml
User->>Shell: Execute persistent peers setup command
Shell->>JSON: Request Celestia chain JSON file
JSON-->>Shell: Return peer information
Shell->>Shell: Extract peer id and address ("id@address" format)
Shell->>Config: Update persistent peers setting in config.toml
Suggested reviewers
- mindstyle85
Poem
I'm a little rabbit with a coding flair,
Hopping on changes floating in the air.
Peer IDs and addresses, now side-by-side,
In a neat command where they now reside.
Celebrating the updates with a joyful stride!
🐇✨
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 7095f2ebefc3847bced75a57c29823988f875469 and 1aff49963dbd5d060a4ed68f3e4c7a4996915b57.
📒 Files selected for processing (1)
how-to-guides/consensus-node.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- how-to-guides/consensus-node.md
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?
🪧 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>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- 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/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
requesting review from @rootulp for a second set of eyes
did you hit the same issue on Mocha?
updated the mainnet persistent peers script to include the id and address. Found this when setting up a mainnet consensus node.
- What did you find?
- What happens if the ID isn't included? I.e. the current behavior?
- Why is the diff only applied to Mainnet and not Mocha or Arabica?
Note: it would be easier to review this PR if you created a GitHub issue with the exact problem you faced so that we can reproduce it. Then this PR can close that issue by writing "Closes #issue-number" in the PR description.
closing as stale. please feel free to answer and re-open 🫡