Document node's store structure

[Mackenzie-OO7]

Overview

closes #1341

Summary by CodeRabbit

• New Features
  • Added "Datastore structure" link to the sidebar for improved navigation in the documentation.
  • Introduced a comprehensive document outlining the storage structure of the Celestia node, detailing key directories and files essential for data management and configuration.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the documentation for the Celestia node by adding a sidebar link titled "Datastore structure" for improved navigation. This entry links to the path "how-to-guides/celestia-node-store-structure," providing users with a reference to the datastore structure related to the Celestia node.

Changes

Files	Change Summary
.vitepress/config.ts	Added a new sidebar link for "Datastore structure" under the "Resources" section.
how-to-guides/celestia-node-store-structure.md	Added a new section detailing the Celestia node's datastore structure and its contents.

Assessment against linked issues

Objective	Addressed	Explanation
Document the node's datastore and its contents (#1341)	✅

Possibly related PRs

• #1603: This PR directly relates to the main PR as it also adds a new sidebar item titled "Datastore structure" linking to the same documentation section about the Celestia node's datastore structure.

Suggested labels

unreleased-node

Poem

In data stores, where bytes do rest,
A node's structure, we now attest.
With directories neat, and files so fine,
Celestia's secrets in clear design.
A change within our docs we see,
Clarity and structure, as it should be.

[!WARNING]

Rate limit exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between fde8c1ebf320bac5970469c9b32eb9a56cecf40d and bb4b2a3be5e7e5ed47cf85b09a92f8a22aeefe65.

---

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>, 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 resolve resolve all the CodeRabbit review comments.
• @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.

[jcstein]

@coderabbitai review

[coderabbitai[bot]]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[Mackenzie-OO7]

Hey, thanks for this PR, but there are some confusing errors...

There is no app.toml or client.toml, or /config. Was this PR AI generated?

Hi, I followed the draft in the linked issue as a guide. Is there somewhere else I could reference?

[jcstein]

draft in the linked issue as a guide

yeah, I remember writing this but don't know where the extra directories and files are from. Are there more with full and bridge nodes? @Mackenzie-OO7 you can figure out the node store structure by initializing each node type celestia bridge init etc. and looking at the node store created. here's celestia light for example:

$ tree .celestia-light
.celestia-light
├── config.toml
├── data
│   ├── 000002.vlog
│   ├── 00022.mem
│   ├── 001174.sst
│   ├── DISCARD
│   ├── KEYREGISTRY
│   ├── LOCK
│   └── MANIFEST
└── keys
    ├── NJ3XILLTMVRXEZLUFZVHO5A
    ├── OAZHALLLMV4Q
    └── keyring-test
        ├── 968218...32d7c.address
        └── my_celes_key.info

4 directories, 129 files

[Mackenzie-OO7]

yeah, I remember writing this but don't know where the extra directories and files are from. Are there more with full and bridge nodes? @Mackenzie-OO7 you can figure out the node store structure by initializing each node type celestia bridge init etc. and looking at the node store created. here's celestia light for example:

Ohh. Thanks!😅

[Mackenzie-OO7]

Hi @jcstein could you explain what DISCARD, KEYREGISTRY, and MANIFEST store? I haven't been able to figure those out. Thanks!

[jcstein]

hey, @distractedm1nd could you please help summarize what these are? thanks!

[distractedm1nd]

Belongs to badger, I have a general idea of what LOCK does but not the others - but i don't recommend describing these any further than "Various files belonging to Node LSM storage system"

[jcstein]

Awesome, thanks @distractedm1nd. let's use "Various files belonging to Node LSM storage system" for all of those @Mackenzie-OO7

[jcstein]

Kind bump here @Mackenzie-OO7 !

Awesome, thanks @distractedm1nd. let's use "Various files belonging to Node LSM storage system" for all of those @Mackenzie-OO7

[jcstein]

let's close this and rework it into the new structure. wdyt? also after reviewing, I think a lot of what is maybe AI generated here needs to go. many of these aren't in my node store...

[Mackenzie-OO7]

let's close this and rework it into the new structure. wdyt? also after reviewing, I think a lot of what is maybe AI generated here needs to go. many of these aren't in my node store...

so initially I kinda mixed up the files & directories that I listed with the ones in celestia-app. but I changed that already, and now the directories listed here are all in the celestia-node store.

here's celestia light for example:

$ tree .celestia-light
.celestia-light
├── config.toml
├── data
│   ├── 000002.vlog
│   ├── 00022.mem
│   ├── 001174.sst
│   ├── DISCARD
│   ├── KEYREGISTRY
│   ├── LOCK
│   └── MANIFEST
└── keys
    ├── NJ3XILLTMVRXEZLUFZVHO5A
    ├── OAZHALLLMV4Q
    └── keyring-test
        ├── 968218...32d7c.address
        └── my_celes_key.info

4 directories, 129 files

The directories you don't have here are in the bridge and full nodes

[jcstein]

makes sense! thank you for clarifying

[jcstein]

didn't fully resolve in that PR! :sweat_smile: