Skip to content

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

Merged
jcstein merged 2 commits intocelestiaorg:mainfrom
rootulp:rp/straggling-node-docs-2
Apr 26, 2024
Merged

docs: add FAQ question for wrong Block.Header.Version #1546
jcstein merged 2 commits intocelestiaorg:mainfrom
rootulp:rp/straggling-node-docs-2

Conversation

@rootulp
Copy link
Copy Markdown
Contributor

@rootulp rootulp commented Apr 26, 2024

The useful content got deleted from #1545 before merging.

Summary by CodeRabbit

  • Documentation
    • Updated instructions for handling consensus failures due to invalid block versions in the documentation for both full consensus nodes and validator nodes. Instructions include updating to the latest binary, restarting with specific flags, and performing a reset if necessary.

@rootulp rootulp requested a review from jcstein April 26, 2024 13:32
@rootulp rootulp self-assigned this Apr 26, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 26, 2024

Walkthrough

The recent updates focus on enhancing node stability during network upgrades by providing detailed instructions for handling consensus failures due to invalid block versions. These instructions include updating the node's binary, using specific startup flags, and performing a reset if necessary to ensure smooth operation and synchronization with the network.

Changes

File Path Change Summary
.../full-consensus-node.md Added instructions for handling invalid block versions during network upgrades.
.../validator-node.md Similar to full-consensus-node, added procedures for managing block version errors post-upgrade.

🐇📜✨
In the land of code and node,
A rabbit hopped down the upgrade road.
"Update and restart," it cheerily said,
With a binary fresh, no error to dread!
Sync the blocks, far and wide,
In smooth consensus, we shall abide. 🌟
🐾


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between fed2109 and 46b85f9.
Files selected for processing (2)
  • nodes/full-consensus-node.md (1 hunks)
  • nodes/validator-node.md (1 hunks)
Additional Context Used
LanguageTool (106)
nodes/full-consensus-node.md (68)

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


Near line 414: This sentence does not start with an uppercase letter.
Context: ...9/consensus/state.go:391 +0x110\n" ``` then it is likely that the network has upgra...


Near line 415: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...


Near line 415: Possible spelling mistake found.
Context: ...chain after the above steps, consider a celestia-appd tendermint unsafe-reset-all to reset y...

nodes/validator-node.md (38)

Near line 6: Possible spelling mistake found.
Context: ...node. outline: deep --- # Setting up a Celestia validator node <script setup> import c...


Near line 12: Possible spelling mistake found.
Context: ... through setting up a validator node on Celestia. Validator nodes allow you to participa...


Near line 13: Possible spelling mistake found.
Context: ... you to participate in consensus in the Celestia network. ![validator node](/img/nodes/...


Near line 25: Possible spelling mistake found.
Context: ...500 GB SSD Storage - Bandwidth: 1 Gbps for Download/1 Gbps for Upload ## Se...


Near line 25: Possible spelling mistake found.
Context: ...** - Bandwidth: 1 Gbps for Download/1 Gbps for Upload ## Setting up a validator...


Near line 47: Possible missing comma found.
Context: ... stake to any validator, including your own you will need the celesvaloper addres...


Near line 48: Possible spelling mistake found.
Context: ...r, including your own you will need the celesvaloper address of the validator in question. ...


Near line 49: Possible spelling mistake found.
Context: ...ou can run the command below to get the celesvaloper of your local validator wallet in case...


Near line 50: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...your local validator wallet in case you want to delegate more to it: ```bash celestia-...


Near line 56: Possible missing comma found.
Context: ...h val -a After entering the wallet passphrase you should see a similar output: ba...


Near line 63: Possible spelling mistake found.
Context: ...u43cv6hd ``` To delegate tokens to the celestiavaloper validator, as an example you can run: ...


Near line 91: Possible spelling mistake found.
Context: ...ing the block explorer by inputting the txhash ID that was returned. ## Optional: De...


Near line 93: Possible spelling mistake found.
Context: ... was returned. ## Optional: Deploy the celestia-node Running a bridge node is critical to t...


Near line 95: Possible spelling mistake found.
Context: ...unning a bridge node is critical to the Celestia network as it enables the data availabi...


Near line 95: Possible missing comma found.
Context: ...bridge node is critical to the Celestia network as it enables the data availability and...


Near line 98: Possible spelling mistake found.
Context: ...bility network, but is not required for celestia-app. If you are not running a bridge node...


Near line 103: Possible spelling mistake found.
Context: ...ode). This section describes part 2 of Celestia validator node setup: running a Celesti...


Near line 103: Possible spelling mistake found.
Context: ...elestia validator node setup: running a Celestia bridge node daemon. ### Install celest...


Near line 106: Possible spelling mistake found.
Context: ...lestia bridge node daemon. ### Install celestia-node You can [follow the tutorial for insta...


Near line 108: Unpaired symbol: ‘]’ seems to be missing
Context: ...on. ### Install celestia-node You can [follow the tutorial for installing `cele...


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


Near line 120: Possible spelling mistake found.
Context: ...f the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) for information on which ports ...


Near line 125: Possible spelling mistake found.
Context: ...to, you can find the list on the Mocha testnet page...


Near line 125: Possible spelling mistake found.
Context: ...find the list on the Mocha testnet page or [list on the Arabica devnet page](....


Near line 126: Possible spelling mistake found.
Context: ...#rpc-endpoints) or [list on the Arabica devnet page](./arabica-devnet.md#rpc-endpoints...


Near line 126: Possible spelling mistake found.
Context: ...nts) or list on the Arabica devnet page. ### Run the bridge node Run the fol...


Near line 136: Possible spelling mistake found.
Context: ...## Optional: start the bridge node with SystemD Follow [the tutorial on setting up the...


Near line 139: Possible spelling mistake found.
Context: ...ridge node as a background process with SystemD](../systemd). You have successfully se...


Near line 144: Consider a shorter alternative to avoid wordiness.
Context: ...he network. ## Run the validator node In order to start your validator node, run the foll...


Near line 151: Consider a shorter alternative to avoid wordiness.
Context: ..., you are now ready to run a validator! In order to create your validator onchain, follow t...


Near line 152: Possible spelling mistake found.
Context: ...ator! In order to create your validator onchain, follow the instructions below. Keep in...


Near line 158: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...


Near line 210: Unpaired symbol: ‘]’ seems to be missing
Context: ... now be able to see your validator from [a block explorer](./mocha-testnet.md#exp...


Near line 222: Possible spelling mistake found.
Context: ...onfiguration-options) to configure your config.toml file to select which transactions to i...


Near line 227: Possible spelling mistake found.
Context: ...r to [the extra resources for consensus nodessection of the full consensus node page](./full...


Near line 238: This sentence does not start with an uppercase letter.
Context: ...9/consensus/state.go:391 +0x110\n" ``` then it is likely that the network has upgra...


Near line 239: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...


Near line 239: Possible spelling mistake found.
Context: ...chain after the above steps, consider a celestia-appd tendermint unsafe-reset-all to reset y...


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

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: 2

Comment thread nodes/validator-node.md
Comment on lines +237 to +239
```

then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ensure the error message starts with a capital letter and consider adding a comma before 'but'.

- then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade.
+ Then it is likely that the network has upgraded to a new app version, but your consensus node was not prepared for the upgrade.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
```
then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.
Then it is likely that the network has upgraded to a new app version, but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.

Comment on lines +413 to +415
```

then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ensure the error message starts with a capital letter and consider adding a comma before 'but'.

- then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade.
+ Then it is likely that the network has upgraded to a new app version, but your consensus node was not prepared for the upgrade.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
```
then it is likely that the network has upgraded to a new app version but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.
Then it is likely that the network has upgraded to a new app version, but your consensus node was not prepared for the upgrade. To fix this, you'll need to update your binary to the latest version and restart your node with the relevant `--v2-upgrade-height` for the network you're running on. If your node still can't sync to the tip of the chain after the above steps, consider a `celestia-appd tendermint unsafe-reset-all` to reset your node and start syncing from the genesis block.

@jcstein
Copy link
Copy Markdown
Member

jcstein commented Apr 26, 2024

i knew i shouldn't have trusted coderabbit. thank you @rootulp

@jcstein jcstein merged commit 5024907 into celestiaorg:main Apr 26, 2024
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.

2 participants