-
Notifications
You must be signed in to change notification settings - Fork 383
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
jcstein
merged 18 commits into
celestiaorg:main
from
Mackenzie-OO7:document-node-structure
Nov 28, 2024
Merged
Changes from 2 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
2e939c5
docs: document the node's store structure
Mackenzie-OO7 8d93e5d
Merge branch 'document-node-structure' of https://github.com/Mackenzi…
Mackenzie-OO7 d7a3f78
Apply suggestions from code review
jcstein 79b3854
Update nodes/celestia-node-store-structure.md
jcstein a06e3a0
Merge branch 'celestiaorg:main' into document-node-structure
Mackenzie-OO7 cd4a136
Merge branch 'celestiaorg:main' into document-node-structure
Mackenzie-OO7 add2e79
docs: update celestia-node datastore structure
Mackenzie-OO7 9466e31
docs: update celestia-node datastore structure
Mackenzie-OO7 29ec0e8
fix broken link
Mackenzie-OO7 ddf0dc9
remove last commit
Mackenzie-OO7 838739e
apply suggestions from review
Mackenzie-OO7 192f096
apply suggestions from review
Mackenzie-OO7 4f59964
apply suggestions from review
Mackenzie-OO7 069cab7
Merge branch 'main' into document-node-structure
jcstein 31c94da
move into how-to guides
Mackenzie-OO7 398d9a2
docs: rearrange menu order
jcstein fde8c1e
Merge branch 'main' into pr/1603
jcstein bb4b2a3
Apply suggestions from code review
jcstein File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
description: This section contains information on the celestia-node datastore and it's contents. | ||
jcstein marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
|
||
# celestia-node store | ||
|
||
The node's store 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. | ||
|
||
Below are the directories contained in the node's store: | ||
|
||
- `/blocks`: This directory stores blocks. Each file contained in this directory | ||
represents a block on Celestia and contains it's associated data. | ||
jcstein marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `/data`: This directory contains the block header files. | ||
|
||
- `/config`: This directory stores the files used to set the node's operational parameters. | ||
It contains the following configuration files: | ||
|
||
- `app.toml`: The configuration file to define application settings such as logging levels and performance tuning. | ||
|
||
- `client.toml`: used to configure parameters for client interactions like API endpoints or timeouts. | ||
|
||
- `config.toml`: This is the node's primary configuration file. | ||
It defines the node's core settings such as the network parameters and the node's identity. | ||
jcstein marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `inverted_index`: This file stores indexed data that can be used make blockchain queries. | ||
jcstein marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `/keys`: This directory stores the cryptographic key pair that is used to operate the node. | ||
jcstein marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `/transients`: This directory stores temporary data such as cache files | ||
that are used while the node is operating, but are not a part of the permanent blockchain state. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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:
📝 Committable suggestion