Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document node's store structure #1603

Merged
merged 18 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,10 @@ function sidebarHome() {
text: "Troubleshooting",
link: "/nodes/celestia-node-troubleshooting",
},
{
text: "Datastore structure",
link: "nodes/celestia-node-store-structure",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Update the link path to follow documentation conventions.

The link path nodes/celestia-node-store-structure doesn't follow the established pattern used throughout the documentation (which typically starts with /how-to-guides/). This could lead to broken links.

Apply this diff to align with the documentation structure:

                {
                  text: "Datastore structure",
-                  link: "nodes/celestia-node-store-structure",
+                  link: "/how-to-guides/celestia-node-store-structure",
                },
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{
text: "Datastore structure",
link: "nodes/celestia-node-store-structure",
},
{
text: "Datastore structure",
link: "/how-to-guides/celestia-node-store-structure",
},

],
},
{
Expand Down
28 changes: 28 additions & 0 deletions nodes/celestia-node-store-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
description: This section contains information on the celestia-node datastore and its contents.
---

# celestia-node datastore

The node's datastore refers to the storage structure
used to manage the data that supports the node's operation.
It consists of directories and files that contain the node's state,
configuration, and other information relevant to the node.

The following are the directories and files found in the datastore:

- `/blocks`: This directory stores blocks. Each file contained in this directory
represents a block on Celestia and contains its associated data. However, the light node's datastore does not contain this directory as light nodes do not store blocks.
Mackenzie-OO7 marked this conversation as resolved.
Show resolved Hide resolved

- `/data`: This directory contains block headers and various files belonging to node LSM storage system such as `DISCARD`, `KEYREGISTRY`, and`MANIFEST`.
Mackenzie-OO7 marked this conversation as resolved.
Show resolved Hide resolved

- `/index`: This directory stores the index files that handle mapping specific keys such as block heights, to the corresponding data. Similar to `/blocks`, the light node's datastore does not include this directory as they do not perform indexing.
Mackenzie-OO7 marked this conversation as resolved.
Show resolved Hide resolved

- `/inverted_index`: This directory stores the inverted index files used for mapping queries to the corresponding data location, and various files belonging to node LSM storage system such as `DISCARD`, `KEYREGISTRY`, `LOCK`, and `MANIFEST`. The light node's datastore does not contain this directory.
Mackenzie-OO7 marked this conversation as resolved.
Show resolved Hide resolved

- `/keys`: This directory stores the cryptographic key pairs that are used to operate the node.

- `/transients`: This directory contains temporary data such as cache files
that are used while the node is operating, but are not a part of the permanent blockchain state.

- `config.toml`: This is the node's primary configuration file. It defines the node's core settings such as the network parameters.
Mackenzie-OO7 marked this conversation as resolved.
Show resolved Hide resolved
Loading