From 2e939c554cb3e77e6a3cf53c28585e334d79a5bc Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Mon, 10 Jun 2024 14:03:34 +0100 Subject: [PATCH 01/11] docs: document the node's store structure --- .vitepress/config.ts | 4 +++ nodes/celestia-node-store-structure.md | 34 ++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 nodes/celestia-node-store-structure.md diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 3e2c1c49352..fb1c914c3b5 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -452,6 +452,10 @@ function sidebarHome() { text: "Troubleshooting", link: "/nodes/celestia-node-troubleshooting", }, + { + text: "Datastore structure", + link: "nodes/celestia-node-store-structure", + }, ], }, { diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md new file mode 100644 index 00000000000..9eaeec13010 --- /dev/null +++ b/nodes/celestia-node-store-structure.md @@ -0,0 +1,34 @@ +--- +description: This section contains information on the celestia-node datastore and it's contents. +--- + +# 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. + +- `/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. + +- `inverted_index`: This file stores indexed data that can be used make blockchain queries. + +- `/keys`: This directory stores the cryptographic key pair that is used to operate the node. + +- `/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. \ No newline at end of file From d7a3f78d81356bac5d53df9d7bf6ae973621dd53 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Mon, 17 Jun 2024 15:47:10 -0400 Subject: [PATCH 02/11] Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- nodes/celestia-node-store-structure.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index 9eaeec13010..24c27f33755 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -1,5 +1,5 @@ --- -description: This section contains information on the celestia-node datastore and it's contents. +description: This section contains information on the celestia-node datastore and its contents. --- # celestia-node store @@ -12,7 +12,7 @@ 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. +represents a block on Celestia and contains its associated data. - `/data`: This directory contains the block header files. @@ -26,7 +26,7 @@ It contains the following configuration files: - `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. -- `inverted_index`: This file stores indexed data that can be used make blockchain queries. +- `inverted_index`: This file stores indexed data that can be used to make blockchain queries. - `/keys`: This directory stores the cryptographic key pair that is used to operate the node. From 79b385452a9771f99c160c3db5b8536c3f08cccd Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Tue, 18 Jun 2024 11:59:35 -0400 Subject: [PATCH 03/11] Update nodes/celestia-node-store-structure.md --- nodes/celestia-node-store-structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index 24c27f33755..f908701b6ff 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -28,7 +28,7 @@ It defines the node's core settings such as the network parameters and the node' - `inverted_index`: This file stores indexed data that can be used to make blockchain queries. -- `/keys`: This directory stores the cryptographic key pair that is used to operate the node. +- `/keys`: This directory stores the cryptographic key pairs that are used to operate the node. - `/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. \ No newline at end of file From add2e796c6a8ebb399ad624f4ea2e488b160115a Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Fri, 9 Aug 2024 14:41:52 +0100 Subject: [PATCH 04/11] docs: update celestia-node datastore structure --- nodes/celestia-node-store-structure.md | 30 +++++++++++--------------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index f908701b6ff..1e6c767d5ca 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -2,33 +2,27 @@ description: This section contains information on the celestia-node datastore and its contents. --- -# celestia-node store +# celestia-node datastore -The node's store refers to the storage structure +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. -Below are the directories contained in the node's store: +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. +represents a block on Celestia and contains its associated data. The light node datastore does not contain this directory as light nodes do not store blocks. -- `/data`: This directory contains the block header files. +- `/data`: This directory contains block headers and various files belonging to node LSM storage system such as `DISCARD`, `KEYREGISTRY`, and`MANIFEST`. -- `/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. - -- `inverted_index`: This file stores indexed data that can be used to make blockchain queries. +- `/index`: This directory stores the index files that handle mapping specific keys such as block heights, to the corresponding data. +- `/inverted_index`: This directory stores 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`. + - `/keys`: This directory stores the cryptographic key pairs that are used to operate the node. -- `/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. \ No newline at end of file +- `/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. \ No newline at end of file From 9466e31e419631b1cda278e45600fbd381b81e12 Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Fri, 9 Aug 2024 14:48:40 +0100 Subject: [PATCH 05/11] docs: update celestia-node datastore structure --- nodes/celestia-node-store-structure.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index 1e6c767d5ca..43e28e4e9ca 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -12,13 +12,13 @@ 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. The light node datastore does not contain this directory as light nodes do not store blocks. +represents a block on Celestia and contains its associated data. The light node's datastore does not contain this directory as light nodes do not store blocks. - `/data`: This directory contains block headers and various files belonging to node 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. +- `/index`: This directory stores the index files that handle mapping specific keys such as block heights, to the corresponding data. The light node's datstore does not contain this directory. -- `/inverted_index`: This directory stores 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`. +- `/inverted_index`: This directory stores 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. - `/keys`: This directory stores the cryptographic key pairs that are used to operate the node. From 29ec0e8be6102c95aa498db80d4831839702297b Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Fri, 9 Aug 2024 15:27:32 +0100 Subject: [PATCH 06/11] fix broken link --- nodes/validator-node.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nodes/validator-node.md b/nodes/validator-node.md index 7542409923d..85089a4d194 100644 --- a/nodes/validator-node.md +++ b/nodes/validator-node.md @@ -30,7 +30,7 @@ The following tutorial is done on an Ubuntu Linux 20.04 (LTS) x64 instance machine. First, follow the instructions on -[setting up a consensus node](/nodes/full-consensus-node#set-up-a-full-consensus-node). +[setting up a consensus node](/nodes/consensus-node#set-up-a-consensus-node). ### Wallet From ddf0dc943fb19b120b3d4ddb9479c118fee26823 Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Fri, 9 Aug 2024 15:30:12 +0100 Subject: [PATCH 07/11] remove last commit --- nodes/validator-node.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nodes/validator-node.md b/nodes/validator-node.md index 85089a4d194..7542409923d 100644 --- a/nodes/validator-node.md +++ b/nodes/validator-node.md @@ -30,7 +30,7 @@ The following tutorial is done on an Ubuntu Linux 20.04 (LTS) x64 instance machine. First, follow the instructions on -[setting up a consensus node](/nodes/consensus-node#set-up-a-consensus-node). +[setting up a consensus node](/nodes/full-consensus-node#set-up-a-full-consensus-node). ### Wallet From 838739e1257c4639514567df943c4fe6df11f372 Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Wed, 14 Aug 2024 10:36:07 +0100 Subject: [PATCH 08/11] apply suggestions from review --- nodes/celestia-node-store-structure.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index 43e28e4e9ca..64b8ef1d020 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -12,13 +12,13 @@ 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. The light node's datastore does not contain this directory as light nodes do not store blocks. +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. - `/data`: This directory contains block headers and various files belonging to node 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. The light node's datstore does not contain this directory. +- `/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 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. +- `/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. - `/keys`: This directory stores the cryptographic key pairs that are used to operate the node. From 192f096dc64744fff0f8b2efd53f700725418dbb Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Wed, 14 Aug 2024 14:33:58 +0100 Subject: [PATCH 09/11] apply suggestions from review --- nodes/celestia-node-store-structure.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index 64b8ef1d020..da2ffed6b4b 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -12,17 +12,17 @@ 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. +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. -- `/data`: This directory contains block headers and various files belonging to node LSM storage system such as `DISCARD`, `KEYREGISTRY`, and`MANIFEST`. +- `/data`: This directory contains block headers and various files belonging to node 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. +- `/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. +- `/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. - `/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. \ No newline at end of file +- `config.toml`: This is the node's primary configuration file. It defines the node's core settings, such as the network parameters. \ No newline at end of file From 4f599644a4b612cc43bf65c3e124fefac33d71f1 Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Mon, 16 Sep 2024 16:51:49 +0100 Subject: [PATCH 10/11] apply suggestions from review --- nodes/celestia-node-store-structure.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nodes/celestia-node-store-structure.md b/nodes/celestia-node-store-structure.md index da2ffed6b4b..504b1af3066 100644 --- a/nodes/celestia-node-store-structure.md +++ b/nodes/celestia-node-store-structure.md @@ -12,9 +12,9 @@ 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. +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 LSM storage system such as `DISCARD`, `KEYREGISTRY`, and `MANIFEST`. +- `/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. From 31c94da06aec4ec564432793f4f49ccda5fa7621 Mon Sep 17 00:00:00 2001 From: Mackenzie-OO7 Date: Thu, 24 Oct 2024 08:28:40 +0100 Subject: [PATCH 11/11] move into how-to guides --- .vitepress/config.ts | 2 +- {nodes => how-to-guides}/celestia-node-store-structure.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {nodes => how-to-guides}/celestia-node-store-structure.md (100%) diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 5a01798e981..8de7184deec 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -469,7 +469,7 @@ function sidebarHome() { }, { text: "Datastore structure", - link: "nodes/celestia-node-store-structure", + link: "how-to-guides/celestia-node-store-structure", }, ], }, diff --git a/nodes/celestia-node-store-structure.md b/how-to-guides/celestia-node-store-structure.md similarity index 100% rename from nodes/celestia-node-store-structure.md rename to how-to-guides/celestia-node-store-structure.md