Skip to content

docs: describe block sync workaround#1967

Merged
jcstein merged 1 commit intocelestiaorg:mainfrom
rootulp:rp/block-sync-hack
Apr 2, 2025
Merged

docs: describe block sync workaround#1967
jcstein merged 1 commit intocelestiaorg:mainfrom
rootulp:rp/block-sync-hack

Conversation

@rootulp
Copy link
Copy Markdown
Contributor

@rootulp rootulp commented Apr 2, 2025

Closes #1961

Summary by CodeRabbit

  • Documentation
    • Revised the guide to inform users about a syncing issue on Mainnet Beta due to recent binaries.
    • Included a temporary workaround by recommending a specific release version to enable block syncing.
    • Advised users to update to the latest release after syncing for improved security and stability.

@rootulp rootulp requested review from adlerjohn and jcstein April 2, 2025 19:48
@rootulp rootulp self-assigned this Apr 2, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

This pull request updates the consensus node guide by adding an additional note regarding an issue with recent celestia-app binaries. It advises users to temporarily use celestia-app v3.0.2 for block syncing on Mainnet Beta due to a known issue, and to upgrade to the latest version post-sync for essential security fixes. No changes were made to public or exported entities.

Changes

File Change Summary
how-to-guides/consensus-node.md Added a note detailing a temporary workaround for block sync issues with recent celestia-app binaries.

Assessment against linked issues

Objective Addressed Explanation
Document how to block sync from genesis [#1961]

Suggested reviewers

  • jcstein

Poem

I'm a bunny with a hop and a pen,
Documenting fixes time and again.
A workaround note added with glee,
Helping nodes sync ever so easily.
Keep on hopping, tech friends, with plenty of cheer! 🐇✨


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.

❤️ Share
🪧 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 @coderabbitai in 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 @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 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 pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
how-to-guides/consensus-node.md (1)

210-211: Clarify and Emphasize the Temporary Workaround

The newly added note clearly explains the block syncing issue with recent celestia-app binaries and provides a useful workaround by suggesting the use of celestia-app v3.0.2. To enhance clarity, consider highlighting version numbers or commands using backticks (e.g., v3.0.2) for consistency with technical documentation standards.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9079ecd and ac01a86.

📒 Files selected for processing (1)
  • how-to-guides/consensus-node.md (1 hunks)

@jcstein jcstein merged commit ce3aafa into celestiaorg:main Apr 2, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to block sync from genesis

2 participants