diff --git a/.vitepress/config.ts b/.vitepress/config.ts index d0e7aface00..4beadff90c1 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -477,6 +477,10 @@ function sidebarHome() { text: "Syncing a light node from a trusted hash", link: "/how-to-guides/celestia-node-trusted-hash", }, + { + text: "Datastore structure", + link: "how-to-guides/celestia-node-store-structure", + }, { text: "Troubleshooting", link: "/how-to-guides/celestia-node-troubleshooting", diff --git a/how-to-guides/celestia-node-store-structure.md b/how-to-guides/celestia-node-store-structure.md new file mode 100644 index 00000000000..3deccfe5d81 --- /dev/null +++ b/how-to-guides/celestia-node-store-structure.md @@ -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 the node's log-structured merge (LSM) storage system. The LSM files (such as `DISCARD`, `KEYREGISTRY`, and `MANIFEST`) manage the efficient storage and retrieval of data. + +- `/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, along with associated LSM storage system files. The light node's datastore does not contain this directory. + +- `/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`: 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. \ No newline at end of file