docs: add FAQ question for wrong Block.Header.Version

[rootulp]

Closes celestiaorg/celestia-app#3297

This question is targeted at node operators who fail to supply the v2-upgrade-height CLI flag before the network upgrades to app version 2.

Summary by CodeRabbit

• Documentation
  • Enhanced FAQ sections in the documentation for full consensus nodes and validator nodes, addressing errors related to block version mismatches during the consensus process and providing detailed troubleshooting steps.
  • Moved an FAQ section from full-consensus-node.md to validator-node.md to streamline information on resolving errors related to block version mismatches.
  • Added detailed steps for users to resolve issues related to committing invalid blocks due to version mismatches in the Block Header during the consensus process.

[coderabbitai]

Walkthrough

The recent updates enhance the FAQ sections of both the full consensus node and validator node documentation, addressing version mismatches in Block Headers during the consensus process. Clear steps are provided to update node software and restart procedures, improving user support in troubleshooting these specific issues.

Changes

File Path

Change Summary

nodes/full-consensus-node.md nodes/validator-node.md

Added FAQ sections addressing errors related to committing invalid blocks due to version mismatches in the Block Header during the consensus process. Provided steps to resolve the issues by updating the binary and restarting the nodes with the appropriate upgrade height and specific parameters, enhancing troubleshooting information for users. Moved the FAQ section addressing an error related to committing an invalid block due to a version mismatch in the Block Header from full-consensus-node.md to validator-node.md, providing steps to resolve the issue by updating the binary and restarting the node with the appropriate upgrade height parameter.

Assessment against linked issues

Objective	Addressed	Explanation
Straggling node test (Issue #3297)	✅

🐰🌟
In the land of code and node,
A tiny update took abode.
To fix the mismatch, off it hopped,
With binaries refreshed, errors stopped.
Cheers to smooth runs, hip hip hooray,
On blocks we trust, by night and day!
🌟🐰

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6c996a4 and e1e76e8.

Files selected for processing (1)

• nodes/full-consensus-node.md (1 hunks)

Files not reviewed due to errors (1)

• nodes/full-consensus-node.md (no review received)

Additional Context Used

LanguageTool (65)

nodes/full-consensus-node.md (65)

Near line 6: Possible spelling mistake found.
Context: ...node. outline: deep --- # Setting up a Celestia full consensus node <!-- markdownlint-...

---

Near line 14: Possible spelling mistake found.
Context: ... how to set up a full consensus node on Celestia. Full consensus nodes allow you to sync...

---

Near line 15: Possible spelling mistake found.
Context: ...w you to sync blockchain history in the Celestia consensus layer. ![full consensus node...

---

Near line 28: Possible spelling mistake found.
Context: ...250 GB SSD Storage - Bandwidth: 1 Gbps for Download/1 Gbps for Upload Runni...

---

Near line 28: Possible spelling mistake found.
Context: ...** - Bandwidth: 1 Gbps for Download/1 Gbps for Upload Running a full consensus ...

---

Near line 32: Possible spelling mistake found.
Context: ...ve at least 250 GB of SSD storage for a Celestia full consensus node if you are using pr...

---

Near line 47: Possible spelling mistake found.
Context: ...encies](./environment.md). ### Install celestia-app Follow the tutorial on [installing `ce...

---

Near line 49: Possible spelling mistake found.
Context: ...app Follow the tutorial on installing celestia-app. ### Set up the P...

---

Near line 53: An apostrophe may be missing.
Context: ... set up the P2P Networks by cloning the networks repository: ```sh cd $HOME rm -rf netw...

---

Near line 62: Possible spelling mistake found.
Context: ...in mind that this might change if a new testnet is deployed. ::: code-group ```bash-v...

---

Near line 80: Possible spelling mistake found.
Context: ...arabicaChainId}} ::: Download the `genesis.json` file: ::: code-group bash-vue [Ma...

---

Near line 98: Possible spelling mistake found.
Context: ...icaChainId}} ``` ::: Set seeds in the $HOME/.celestia-app/config/config.toml file: ::: code-gro...

---

Near line 123: Possible spelling mistake found.
Context: ...*, you can set persistent peers in your config.toml file. You can get the persistent peers...

---

Near line 124: An apostrophe may be missing.
Context: ...u can get the persistent peers from the networks repository with the following commands:...

---

Near line 155: Possible spelling mistake found.
Context: ... consensus node is being connected to a celestia-node bridge node, you will need to enable tr...

---

Near line 157: Possible spelling mistake found.
Context: ...ved with the following settings in your config.toml. #### Enable transaction indexing ``...

---

Near line 167: Possible spelling mistake found.
Context: ...#### Retain all block data And in your app.toml, min-retain-blocks should remain as ...

---

Near line 177: Possible spelling mistake found.
Context: ...must be turned on. Set the indexer to "kv" in your config.toml: ```toml index...

---

Near line 177: Possible spelling mistake found.
Context: ...on. Set the indexer to "kv" in your config.toml: toml indexer = "kv" ### Acce...

---

Near line 186: Possible spelling mistake found.
Context: ...you might want to know the balance of a Celestia wallet at a given height in the past — ...

---

Near line 187: Possible spelling mistake found.
Context: ...node with pruning = "nothing" in your app.toml. Note that this configuration is resou...

---

Near line 198: Possible spelling mistake found.
Context: ... using pruning = "everything" in your app.toml to prune everything. If you select `"e...

---

Near line 201: Possible spelling mistake found.
Context: ...alue of min-retain-blocks = 0 in your app.toml. A value of 0 for `min-retain-blocks...

---

Near line 212: Possible missing comma found.
Context: ...s node will sync using block sync; that is request, validate and execute every blo...

---

Near line 227: Possible spelling mistake found.
Context: .../github.com/cosmos/chain-registry). In $HOME/.celestia-app/config/config.toml, set ```toml rpc_s...

---

Near line 235: Possible spelling mistake found.
Context: ...spective fields. At least two different rpc endpoints should be provided. The more,...

---

Near line 285: Consider a shorter alternative to avoid wordiness.
Context: ... ``` ::: ## Start the consensus node In order to start your full consensus node, run the...

---

Near line 292: Possible spelling mistake found.
Context: ... start ``` Optional: If you would like celestia-app to run as a background process, you can...

---

Near line 292: Possible spelling mistake found.
Context: ...background process, you can follow the SystemD tutorial. :::tip Refer ...

---

Near line 296: Possible spelling mistake found.
Context: ...:tip Refer to [the ports section of the celestia-node troubleshooting page](../nodes/celestia...

---

Near line 323: Possible spelling mistake found.
Context: ... You can do this by editing the config.toml file: ```sh sed -i 's#"tcp://127.0.0.1...

---

Near line 347: Possible spelling mistake found.
Context: ...de After making these changes, restart celestia-appd to load the new configurations. ### O...

---

Near line 352: Possible spelling mistake found.
Context: ...ion guides you on how to configure your config.toml file in celestia-app to select which...

---

Near line 353: Possible spelling mistake found.
Context: ...to configure your config.toml file in celestia-app to select which transactions to index....

---

Near line 359: Loose punctuation mark.
Context: .... The available options are: 1. null: This option disables indexing. If you d...

---

Near line 362: Possible spelling mistake found.
Context: ...ed by key-value storage (defaults to levelDB; see DBBackend). When kv is chosen...

---

Near line 362: Possible spelling mistake found.
Context: ...value storage (defaults to levelDB; see DBBackend). When kv is chosen, tx.height a...

---

Near line 362: Possible typo: you repeated a whitespace
Context: ...e (defaults to levelDB; see DBBackend). When kv is chosen, tx.height and `tx...

---

Near line 363: Possible spelling mistake found.
Context: ...lts to levelDB; see DBBackend). When kv is chosen, tx.height and tx.hash w...

---

Near line 363: Possible spelling mistake found.
Context: ...see DBBackend). When kv is chosen, tx.height and tx.hash will always be ...

---

Near line 363: Possible spelling mistake found.
Context: ... When kv is chosen, tx.height and tx.hash will always be indexed. This o...

---

Near line 365: Loose punctuation mark.
Context: ...basic queries on transactions. 3. psql: This indexer is backed by PostgreSQL. W...

---

Near line 365: Possible spelling mistake found.
Context: ...s indexer is backed by PostgreSQL. When psql is chosen, tx.height and tx.hash...

---

Near line 365: Possible spelling mistake found.
Context: ...ked by PostgreSQL. When psql is chosen, tx.height and tx.hash will always be in...

---

Near line 366: Possible spelling mistake found.
Context: ...When psql is chosen, tx.height and tx.hash will always be indexed. This opti...

---

Near line 369: Possible spelling mistake found.
Context: ...ctions. An example to set the value to kv in config.toml is: ```toml indexer ...

---

Near line 369: Possible spelling mistake found.
Context: ... An example to set the value to kv in config.toml is: toml indexer = "kv" Remem...

---

Near line 375: Possible spelling mistake found.
Context: ...indexer = "kv" ``` Remember to restart celestia-appd after making changes to the configurat...

---

Near line 375: Consider shortening or rephrasing this to strengthen your wording.
Context: ...member to restart celestia-appd after making changes to the configuration to load the new setti...

---

Near line 378: Possible spelling mistake found.
Context: ...he new settings. ### Optional: Discard ABCI responses configuration This section w...

---

Near line 380: Possible spelling mistake found.
Context: ...will guide you on how to configure your config.toml file in celestia-app to manage the s...

---

Near line 380: Possible spelling mistake found.
Context: ...to configure your config.toml file in celestia-app to manage the storage of ABCI response...

---

Near line 381: Possible spelling mistake found.
Context: ...celestia-app to manage the storage of ABCI responses. ABCI responses are the resul...

---

Near line 381: Possible spelling mistake found.
Context: ...o manage the storage of ABCI responses. ABCI responses are the results of executing ...

---

Near line 383: Possible spelling mistake found.
Context: ...for /block_results RPC queries and to reindex events in the command-line tool. The `...

---

Near line 385: Possible spelling mistake found.
Context: ...x events in the command-line tool. The discard_abci_responses option allows you to control...

---

Near line 388: Possible spelling mistake found.
Context: ... the state store: - false (default): ABCI responses are stored in the state store...

---

Near line 389: Possible spelling mistake found.
Context: ...in the state store. This ensures that ABCI responses are available for `/block_res...

---

Near line 390: Possible spelling mistake found.
Context: ... /block_results RPC queries and for reindexing events. However, it can consume a signi...

---

Near line 392: Loose punctuation mark.
Context: ...ificant amount of disk space. - true: ABCI responses are not stored in the st...

---

Near line 392: Possible spelling mistake found.
Context: ...icant amount of disk space. - true: ABCI responses are not stored in the state s...

---

Near line 394: Possible spelling mistake found.
Context: .../block_results` RPC queries and event reindexing will not be available. An example to s...

---

Near line 396: Possible spelling mistake found.
Context: ...An example to set the value to false in config.toml is: ```toml discard_abci_responses = ...

---

Near line 402: Possible spelling mistake found.
Context: ...ponses = false ``` Remember to restart celestia-appd after making changes to the configurat...

---

Near line 402: Consider shortening or rephrasing this to strengthen your wording.
Context: ...member to restart celestia-appd after making changes to the configuration to load the new setti...

---

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 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 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 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.

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.
• 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.

[coderabbitai]

Actionable comments posted: 4

[coderabbitai]

Actionable comments posted: 2

[rootulp]

I think all the useful content after the code block got accidentally deleted.