Skip to content

Update indexer field value - #1975

Merged
jcstein merged 3 commits into
mainfrom
adlerjohn-patch-1
Apr 10, 2025
Merged

Update indexer field value#1975
jcstein merged 3 commits into
mainfrom
adlerjohn-patch-1

Conversation

@adlerjohn

@adlerjohn adlerjohn commented Apr 10, 2025

Copy link
Copy Markdown
Contributor

The null indexer is sufficient since it actually does index transaction hashes to transaction statues (which is sufficient for a bridge node). kv indexes additional data that isn't needed by bridge nodes.

Related:

  1. fix: validator updates #1219 (comment)
  2. Fix incorrect default for indexer celestia-core#1720

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Updated the guide to reflect changes in transaction indexing configuration, highlighting the new default indexing option.
    • Clarified available indexing options and their roles.
  • Style
    • Refined FAQ formatting for enhanced consistency and readability.

@coderabbitai

coderabbitai Bot commented Apr 10, 2025

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates the consensus node guide by modifying the configuration setting in the config.toml file. The indexer value has been changed from "kv" to "null", indicating that indexing cannot be entirely disabled. The new configuration clarifies that the null indexer is a lightweight option suitable for bridge nodes. Additionally, the available indexing options have been reordered and described more clearly, with minor formatting adjustments made in the FAQ section for consistency.

Changes

File(s) Change Summary
how-to-guides/consensus-node.md Updated config.toml setting: indexer changed from "kv" to "null"; clarified description of indexing options; adjusted FAQ formatting.

Poem

I'm a hopping rabbit with a little cheer,
Changed the index from "kv" to "null" so clear,
No extra burden, just lightweight grace,
The guide now sparkles in its proper place,
Crunching carrots as I celebrate this code race!
🥕🐇


📜 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 83b4490 and a533709.

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

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

@adlerjohn adlerjohn self-assigned this Apr 10, 2025
@adlerjohn adlerjohn added bug Something isn't working documentation Improvements or additions to documentation labels Apr 10, 2025
@github-actions

github-actions Bot commented Apr 10, 2025

Copy link
Copy Markdown
Contributor
PR Preview Action v1.6.0

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1975/

Built to branch main at 2025-04-10 19:41 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 0

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

164-172: Update transaction indexer configuration explanation

The updated code now sets the indexer to "null", which is explained as a lightweight option that avoids redundant storage compared to "kv". Please double-check the accompanying explanation to ensure it clearly communicates that opting for "null" will disable transaction indexing—which is ideal when you do not require transaction query functionality—and that the trade-off is the loss of such queries. If users might need to run transaction queries, consider adding a brief note about potential implications.


518-518: Minor FAQ formatting update

The FAQ header now reads:

### `+2/3 committed an invalid block: wrong Block.Header.Version`

This formatting adjustment improves consistency. Ensure that all FAQ headers follow a similar style for a uniform user experience.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6633ff and e1eea70.

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

@jcstein jcstein left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, should we wait to smorge until celestiaorg/celestia-core#1720 is done?

@adlerjohn

adlerjohn commented Apr 10, 2025

Copy link
Copy Markdown
Contributor Author

No, no need to wait, they're orthogonal.

@adlerjohn
adlerjohn marked this pull request as draft April 10, 2025 19:08
@adlerjohn
adlerjohn marked this pull request as ready for review April 10, 2025 19:35

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 0

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

471-481: List Numbering & Punctuation Review in Indexer Options:
The available indexer options list uses a discontinuous numbering sequence (1, then 3, then 4). If the omission (i.e., no option "2") is intentional (for example, to indicate a deprecated option or reserved slot), a brief note might help avoid confusion. Additionally, minor static analysis hints flagged loose punctuation on lines ~474 and ~478; although these are subjective, consider a quick review to ensure the formatting aligns with your documentation style guidelines.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~474-~474: Loose punctuation mark.
Context: ...hoose this option to save space. 3. kv: This is the simplest indexer, backed by...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~478-~478: Loose punctuation mark.
Context: ...basic queries on transactions. 4. psql: This indexer is backed by PostgreSQL. W...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e1eea70 and 83b4490.

📒 Files selected for processing (1)
  • how-to-guides/consensus-node.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/consensus-node.md

[uncategorized] ~474-~474: Loose punctuation mark.
Context: ...hoose this option to save space. 3. kv: This is the simplest indexer, backed by...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~478-~478: Loose punctuation mark.
Context: ...basic queries on transactions. 4. psql: This indexer is backed by PostgreSQL. W...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (1)
how-to-guides/consensus-node.md (1)

164-173: Updated Indexer Configuration Instruction:
The instructions now correctly advise setting indexer = "null" in the config.toml file, aligning with the PR’s objectives to reduce redundant blob storage from the kv indexer. The explanation clearly states that while full indexing isn’t disabled, only transaction status indexing is enabled. Please confirm that users understand this nuance.

@jcstein
jcstein merged commit e9f8120 into main Apr 10, 2025
@jcstein
jcstein deleted the adlerjohn-patch-1 branch April 10, 2025 19:40
@adlerjohn adlerjohn mentioned this pull request Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants