-
Notifications
You must be signed in to change notification settings - Fork 359
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
base: main
Are you sure you want to change the base?
Changes from all commits
2e939c5
8d93e5d
d7a3f78
79b3854
a06e3a0
cd4a136
add2e79
9466e31
29ec0e8
ddf0dc9
838739e
192f096
4f59964
069cab7
31c94da
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. This directory is present in the datastore for bridge and full nodes but not light nodes, as light nodes do not store blocks. | ||||||
|
||||||
- `/data`: This directory contains block headers and various files belonging to node log-structured merge (LSM) storage system such as `DISCARD`, `KEYREGISTRY`, and `MANIFEST`. | ||||||
|
||||||
- `/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. | ||||||
|
||||||
- `/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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Remove redundant LSM file listing The LSM files are already mentioned in the -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.
+This directory stores the inverted index files used for mapping queries to the corresponding data location, along with associated LSM storage system files. The light node's datastore does not contain this directory. 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool
|
||||||
|
||||||
- `/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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Clarify config.toml location and purpose Based on the PR discussion, there was some confusion about configuration files. Let's be more specific about the location and purpose of config.toml. -`config.toml`: This is the node's primary configuration file. It defines the node's core settings, such as the network parameters.
+`config.toml`: Located in the node's root directory, this is the primary configuration file that defines core settings such as network parameters, P2P configuration, and API endpoints. This file is generated during node initialization. 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Clarify LSM storage system files
Based on the discussion with @distractedm1nd, we should keep the LSM storage system description general.
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool