Merge branch 'main' into feature/dotnet9

NethermindEth · Oct 14, 2024 · c7117c8 · c7117c8
2 parents 07b3494 + 4b624b7
commit c7117c8
Show file tree

Hide file tree

Showing 4 changed files with 124 additions and 96 deletions.
diff --git a/docs/developers/building-from-source.md b/docs/developers/building-from-source.md
@@ -70,10 +70,37 @@ dotnet test EthereumTests.sln -c release
 
 ## Bulding Docker image
 
-To build Nethermind Docker image, run the following command from the project's root directory:
+Currently, there are three Docker images available in the project's root directory:
+
+- `Dockerfile`: the default Nethermind Docker image.
+- `Dockerfile.chiseled`: the rootless and [chiseled](https://ubuntu.com/engage/chiselled-ubuntu-images-for-containers) version of the Nethermind Docker image.
+- `Dockerfile.diag`: the diagnostics image with pre-installed .NET diagnostic and tracing tools. This image is intended for internal use and is not distributed via public channels.
+
+All Docker images have the following optional arguments:
+
+- `BUILD_CONFIG`: the build configuration that is either `release` or `debug`. Defaults to `release`.
+- `BUILD_TIMESTAMP`: the build timestamp as a Unix timestamp.
+- `CI`: this is mostly used for CI builds determining whether the build is deterministic. Must be either `true` or `false`. Defaults to `false`.
+- `COMMIT_HASH`: the Git commit hash to use for the build as a part of the version string.
+
+Given the above, the following command builds the Nethermind chiseled Docker image from the project's root directory:
+
+```bash
+build_timestamp=$(date '+%s')
+commit_hash=$(git rev-parse HEAD)
+
+docker build . \
+  -f Dockerfile.chiseled \
+  -t nethermind-chiseled \
+  --build-arg BUILD_TIMESTAMP=$build_timestamp \
+  --build-arg CI=true \
+  --build-arg COMMIT_HASH=$commit_hash
+```
+
+For quick testing images, the above arguments can be omitted if not needed:
 
 ```bash
-docker build -t nethermind .
+docker build . -t nethermind
 ```
 
 For more info about running Docker containers,

diff --git a/docs/fundamentals/database.md b/docs/fundamentals/database.md
@@ -38,93 +38,93 @@ Below is a comprehensive list of the supported chains, along with a detailed bre
 <Tabs>
 <TabItem value="mainnet" label="Mainnet">
 
-- `state`: 158 GB
-- `receipts`: 209 GB
-- `blocks`: 595 GB
-- `bloom`: 6.4 GB
-- `headers`: 8.9 GB
-- `code`: 4.7 GB
-- `blobTransactions`: 1.7 GB
+- `state`: 159 GB
+- `receipts`: 213 GB
+- `blocks`: 601 GB
+- `bloom`: 6.5 GB
+- `headers`: 9.0 GB
+- `code`: 4.8 GB
+- `blobTransactions`: 631 MB
 - ...
-- **Total: 985 GB**
+- **Total: 995 GB**
 
 </TabItem>
 <TabItem value="sepolia" label="Sepolia">
 
-- `state`: 42 GB
-- `receipts`: 39 GB
-- `blocks`: 293 GB
-- `bloom`: 2.1 GB
-- `headers`: 2.3 GB
-- `code`: 6.5 GB
-- `blobTransactions`: 1.3 GB
+- `state`: 44 GB
+- `receipts`: 41 GB
+- `blocks`: 304 GB
+- `bloom`: 2.2 GB
+- `headers`: 2.4 GB
+- `code`: 6.7 GB
+- `blobTransactions`: 184 MB
 - ...
-- **Total: 386 GB**
+- **Total: 400 GB**
 
 </TabItem>
 <TabItem value="holesky" label="Holesky">
 
-- `state`: 18 GB
-- `receipts`: 14 GB
-- `blocks`: 55 GB
-- `bloom`: 738 MB
-- `headers`: 967 MB
-- `code`: 506 MB
-- `blobTransactions`: 737 MB
+- `state`: 20 GB
+- `receipts`: 15 GB
+- `blocks`: 58 GB
+- `bloom`: 795 MB
+- `headers`: 1.1 GB
+- `code`: 673 MB
+- `blobTransactions`: 57 MB
 - ...
-- **Total: 90 GB**
+- **Total: 94 GB**
 
 </TabItem>
 <TabItem value="gnosis" label="Gnosis">
 
 - `state`: 66 GB
 - `receipts`: 216 GB
-- `blocks`: 199 GB
-- `bloom`: 9.2 GB
+- `blocks`: 200 GB
+- `bloom`: 9.3 GB
 - `headers`: 11 GB
-- `code`: 668 MB
+- `code`: 675 MB
 - `blobTransactions`: 75 MB
 - ...
-- **Total: 503 GB**
+- **Total: 505 GB**
 
 </TabItem>
 <TabItem value="chiado" label="Chiado">
 
 - `state`: 2.6 GB
 - `receipts`: 1.4 GB
-- `blocks`: 9.0 GB
-- `bloom`: 3.1 GB
-- `headers`: 2.3 GB
-- `code`: 67 MB
-- `blobTransactions`: 656 MB
+- `blocks`: 9.3 GB
+- `bloom`: 3.2 GB
+- `headers`: 2.4 GB
+- `code`: 70 MB
+- `blobTransactions`: 1.5 GB
 - ...
-- **Total: 20 GB**
+- **Total: 22 GB**
 
 </TabItem>
 <TabItem value="energyweb" label="Energyweb">
 
 - `state`: 27 GB
 - `receipts`: 4.5 GB
 - `blocks`: 25 GB
-- `bloom`: 9.8 GB
-- `headers`: 7.0 GB
+- `bloom`: 10 GB
+- `headers`: 7.1 GB
 - `code`: 14 MB
-- `blobTransactions`:
+- `blobTransactions`: 
 - ...
-- **Total: 75 GB**
+- **Total: 76 GB**
 
 </TabItem>
 <TabItem value="volta" label="Volta">
 
 - `state`: 34 GB
-- `receipts`: 8.3 GB
+- `receipts`: 8.4 GB
 - `blocks`: 33 GB
-- `bloom`: 9.0 GB
-- `headers`: 6.9 GB
+- `bloom`: 9.1 GB
+- `headers`: 7.0 GB
 - `code`: 95 MB
-- `blobTransactions`:
+- `blobTransactions`: 
 - ...
-- **Total: 93 GB**
+- **Total: 94 GB**
 
 </TabItem>
 </Tabs>

diff --git a/docs/get-started/installing-nethermind.md b/docs/get-started/installing-nethermind.md
@@ -184,23 +184,24 @@ For further instructions, see [Running a node](running-node/running-node.md).
 
 The Docker images of Nethermind are available on [Docker Hub](https://hub.docker.com/r/nethermind/nethermind).
 
-This registry provides production versions of Nethermind with 3 types of tags:
+The Docker images are based on Ubuntu 24.04 and support x64 and AArch64 (ARM64) CPU architectures. They are tagged as follows:
 
-- `nethermind/nethermind:latest` is the latest version of Nethermind (the default tag)
-- `nethermind/nethermind:<version>` is the specific version of Nethermind where `<version>` is the actual version of Nethermind.
-- `nethermind/nethermind:<version>-chiseled` is a _rootless_ and [chiseled](https://ubuntu.com/engage/chiselled-ubuntu-images-for-containers) image with the specific version of Nethermind where `<version>` is either `latest` or the actual version of Nethermind.\
+- `latest`: the latest version of Nethermind (the default tag).
+- `latest-chiseled`: a _rootless_ and [chiseled](https://ubuntu.com/engage/chiselled-ubuntu-images-for-containers) image of the latest version of Nethermind.\
   For security reasons, this image contains only the absolutely necessary components and is intended to run as a non-root `app` user with UID/GID of `64198`.
+- `x.x.x`: a specific version of Nethermind. For instance, `1.27.0`.
+- `x.x.x-chiseled`: a rootless and chiseled image of the specific version of Nethermind. For instance, `1.27.0-chiseled`.
 
-To download the image from the registry, run:
+For example, to download the latest chiseled image from the registry, run:
 
 ```bash
-docker pull nethermind/nethermind
+docker pull nethermind/nethermind:latest-chiseled
 ```
 
-Starting a node is achieved by:
+Starting the container is achieved by:
 
 ```bash
-docker run -it nethermind/nethermind
+docker run -it nethermind/nethermind:latest-chiseled
 ```
 
 The following ports are exposed by default:

diff --git a/versioned_docs/version-1.29.0/fundamentals/database.md b/versioned_docs/version-1.29.0/fundamentals/database.md
@@ -38,93 +38,93 @@ Below is a comprehensive list of the supported chains, along with a detailed bre
 <Tabs>
 <TabItem value="mainnet" label="Mainnet">
 
-- `state`: 158 GB
-- `receipts`: 209 GB
-- `blocks`: 595 GB
-- `bloom`: 6.4 GB
-- `headers`: 8.9 GB
-- `code`: 4.7 GB
-- `blobTransactions`: 1.7 GB
+- `state`: 159 GB
+- `receipts`: 213 GB
+- `blocks`: 601 GB
+- `bloom`: 6.5 GB
+- `headers`: 9.0 GB
+- `code`: 4.8 GB
+- `blobTransactions`: 631 MB
 - ...
-- **Total: 985 GB**
+- **Total: 995 GB**
 
 </TabItem>
 <TabItem value="sepolia" label="Sepolia">
 
-- `state`: 42 GB
-- `receipts`: 39 GB
-- `blocks`: 293 GB
-- `bloom`: 2.1 GB
-- `headers`: 2.3 GB
-- `code`: 6.5 GB
-- `blobTransactions`: 1.3 GB
+- `state`: 44 GB
+- `receipts`: 41 GB
+- `blocks`: 304 GB
+- `bloom`: 2.2 GB
+- `headers`: 2.4 GB
+- `code`: 6.7 GB
+- `blobTransactions`: 184 MB
 - ...
-- **Total: 386 GB**
+- **Total: 400 GB**
 
 </TabItem>
 <TabItem value="holesky" label="Holesky">
 
-- `state`: 18 GB
-- `receipts`: 14 GB
-- `blocks`: 55 GB
-- `bloom`: 738 MB
-- `headers`: 967 MB
-- `code`: 506 MB
-- `blobTransactions`: 737 MB
+- `state`: 20 GB
+- `receipts`: 15 GB
+- `blocks`: 58 GB
+- `bloom`: 795 MB
+- `headers`: 1.1 GB
+- `code`: 673 MB
+- `blobTransactions`: 57 MB
 - ...
-- **Total: 90 GB**
+- **Total: 94 GB**
 
 </TabItem>
 <TabItem value="gnosis" label="Gnosis">
 
 - `state`: 66 GB
 - `receipts`: 216 GB
-- `blocks`: 199 GB
-- `bloom`: 9.2 GB
+- `blocks`: 200 GB
+- `bloom`: 9.3 GB
 - `headers`: 11 GB
-- `code`: 668 MB
+- `code`: 675 MB
 - `blobTransactions`: 75 MB
 - ...
-- **Total: 503 GB**
+- **Total: 505 GB**
 
 </TabItem>
 <TabItem value="chiado" label="Chiado">
 
 - `state`: 2.6 GB
 - `receipts`: 1.4 GB
-- `blocks`: 9.0 GB
-- `bloom`: 3.1 GB
-- `headers`: 2.3 GB
-- `code`: 67 MB
-- `blobTransactions`: 656 MB
+- `blocks`: 9.3 GB
+- `bloom`: 3.2 GB
+- `headers`: 2.4 GB
+- `code`: 70 MB
+- `blobTransactions`: 1.5 GB
 - ...
-- **Total: 20 GB**
+- **Total: 22 GB**
 
 </TabItem>
 <TabItem value="energyweb" label="Energyweb">
 
 - `state`: 27 GB
 - `receipts`: 4.5 GB
 - `blocks`: 25 GB
-- `bloom`: 9.8 GB
-- `headers`: 7.0 GB
+- `bloom`: 10 GB
+- `headers`: 7.1 GB
 - `code`: 14 MB
-- `blobTransactions`:
+- `blobTransactions`: 
 - ...
-- **Total: 75 GB**
+- **Total: 76 GB**
 
 </TabItem>
 <TabItem value="volta" label="Volta">
 
 - `state`: 34 GB
-- `receipts`: 8.3 GB
+- `receipts`: 8.4 GB
 - `blocks`: 33 GB
-- `bloom`: 9.0 GB
-- `headers`: 6.9 GB
+- `bloom`: 9.1 GB
+- `headers`: 7.0 GB
 - `code`: 95 MB
-- `blobTransactions`:
+- `blobTransactions`: 
 - ...
-- **Total: 93 GB**
+- **Total: 94 GB**
 
 </TabItem>
 </Tabs>