Merge branch 'main' into development

Author: bloxster

src/about/contributing.md

@@ -1,4 +1,5 @@
 # Contributing to Erigon 3
+# Contributing to Erigon 3
 
 ## Development
 
@@ -14,11 +15,16 @@ For those interested in gaining a deeper understanding of Erigon's underlying ar
 - **[DB Walk-through](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_walkthrough.MD)**: This document provides a detailed walk-through of Erigon's database structure. It explains how Erigon organizes persistent data into tables like PlainState for accounts and storage, History Of Accounts for tracking account changes, and Change Sets for optimized binary searches on changes. It contrasts Erigon's approach with go-ethereum's use of the Merkle Patricia Trie.
 - **[Database FAQ](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_faq.md)**: The Database FAQ addresses common questions and concerns related to Erigon's database design. It covers how to directly read the database via gRPC or while Erigon is running, details on the MDBX storage engine and RAM usage model, and points to further resources on the database interface rationale and architecture.
 
+- **[DB Walk-through](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_walkthrough.MD)**: This document provides a detailed walk-through of Erigon's database structure. It explains how Erigon organizes persistent data into tables like PlainState for accounts and storage, History Of Accounts for tracking account changes, and Change Sets for optimized binary searches on changes. It contrasts Erigon's approach with go-ethereum's use of the Merkle Patricia Trie.
+- **[Database FAQ](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_faq.md)**: The Database FAQ addresses common questions and concerns related to Erigon's database design. It covers how to directly read the database via gRPC or while Erigon is running, details on the MDBX storage engine and RAM usage model, and points to further resources on the database interface rationale and architecture.
+
 
 ### Feature Exploration
 Erigon introduces several innovative features that contributors may find interesting to explore and contribute to:
 - **[DupSort Feature Explanation](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/dupsort.md)**: Erigon's DupSort feature optimizes storage and retrieval of duplicate data by utilizing prefixes for keys in databases without the concept of "Buckets/Tables/Collections" or by creating tables for efficient storage with named "Buckets/Tables/Collections."
 - **[EVM without Opcodes](https://github.com/erigontech/erigon/blob/release/2.60/docs/evm_semantics.md)** (Ether Transfers Only): Erigon explores a simplified version of the Ethereum Virtual Machine (EVM) focusing solely on ether transfers, offering an efficient execution environment for specific use cases.
+- **[DupSort Feature Explanation](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/dupsort.md)**: Erigon's DupSort feature optimizes storage and retrieval of duplicate data by utilizing prefixes for keys in databases without the concept of "Buckets/Tables/Collections" or by creating tables for efficient storage with named "Buckets/Tables/Collections."
+- **[EVM without Opcodes](https://github.com/erigontech/erigon/blob/release/2.60/docs/evm_semantics.md)** (Ether Transfers Only): Erigon explores a simplified version of the Ethereum Virtual Machine (EVM) focusing solely on ether transfers, offering an efficient execution environment for specific use cases.
 
 ## Wiki
 

src/advanced/options.md

@@ -29,6 +29,11 @@ COMMANDS:
    seg, snapshots, segments  Managing historical data segments (partitions)
    support                   Connect Erigon instance to a diagnostics system for support
    help, h                   Shows a list of commands or help for one command
+   init                      Bootstrap and initialize a new genesis block
+   import                    Import a blockchain file
+   seg, snapshots, segments  Managing historical data segments (partitions)
+   support                   Connect Erigon instance to a diagnostics system for support
+   help, h                   Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
    --datadir value                                                                  Data directory for the databases (default: /home/bloxster/.local/share/erigon)
@@ -48,6 +53,10 @@ GLOBAL OPTIONS:
    --txpool.commit.every value                                                      How often transactions should be committed to the storage (default: 15s)
    --prune.distance value                                                           Keep state history for the latest N blocks (default: everything) (default: 0)
    --prune.distance.blocks value                                                    Keep block history for the latest N blocks (default: everything) (default: 0)
+   --prune.mode value                                                               Choose a pruning preset to run onto. Available values: "full", "archive", "minimal".
+                                                                                          Full: Keep only blocks and latest state,
+                                                                                          Archive: Keep the entire indexed database, aka. no pruning,
+                                                                                          Minimal: Keep only latest state (default: "full")
    --prune.mode value                                                               Choose a pruning preset to run onto. Available values: "full", "archive", "minimal".
                                                                                           Full: Keep only blocks and latest state,
                                                                                           Archive: Keep the entire indexed database, aka. no pruning,
@@ -87,6 +96,7 @@ GLOBAL OPTIONS:
    --rpc.batch.concurrency value                                                    Does limit amount of goroutines to process 1 batch request. Means 1 bach request can't overload server. 1 batch still can have unlimited amount of request (default: 2)
    --rpc.streaming.disable                                                          Erigon has enabled json streaming for some heavy endpoints (like trace_*). It's a trade-off: greatly reduce amount of RAM (in some cases from 30GB to 30mb), but it produce invalid json format if error happened in the middle of streaming (because json is not streaming-friendly format) (default: false)
    --db.read.concurrency value                                                      Does limit amount of parallel db reads. Default: equal to GOMAXPROCS (or number of CPU) (default: 1408)
+   --db.read.concurrency value                                                      Does limit amount of parallel db reads. Default: equal to GOMAXPROCS (or number of CPU) (default: 1408)
    --rpc.accessList value                                                           Specify granular (method-by-method) API allowlist
    --trace.compat                                                                   Bug for bug compatibility with OE for trace_ routines (default: false)
    --rpc.gascap value                                                               Sets a cap on gas that can be used in eth_call/estimateGas (default: 50000000)
@@ -147,6 +157,7 @@ GLOBAL OPTIONS:
    --staticpeers value                                                              Comma separated enode URLs to connect to
    --trustedpeers value                                                             Comma separated enode URLs which are always allowed to connect, even above the peer limit
    --maxpeers value                                                                 Maximum number of network peers (network disabled if set to 0) (default: 32)
+   --maxpeers value                                                                 Maximum number of network peers (network disabled if set to 0) (default: 32)
    --chain value                                                                    name of the network to join (default: "mainnet")
    --dev.period value                                                               Block period to use in developer mode (0 = mine only if transaction pending) (default: 0)
    --vmdebug                                                                        Record information useful for VM and contract debugging (default: false)
@@ -164,6 +175,7 @@ GLOBAL OPTIONS:
    --proposer.disable                                                               Disables PoS proposer (default: false)
    --miner.notify value                                                             Comma separated HTTP URL list to notify of new work packages
    --miner.gaslimit value                                                           Target gas limit for mined blocks (default: 36000000)
+   --miner.gaslimit value                                                           Target gas limit for mined blocks (default: 36000000)
    --miner.etherbase value                                                          Public address for block mining rewards (default: "0")
    --miner.extradata value                                                          Block extra data set by the miner (default = client version)
    --miner.noverify                                                                 Disable remote sealing verification (default: false)
@@ -198,6 +210,12 @@ GLOBAL OPTIONS:
    --caplin.max-inbound-traffic-per-peer value                                      Max inbound traffic per second per peer (default: "256KB")
    --caplin.max-outbound-traffic-per-peer value                                     Max outbound traffic per second per peer (default: "256KB")
    --caplin.adaptable-maximum-traffic-requirements                                  Make the node adaptable to the maximum traffic requirement based on how many validators are being ran (default: true)
+   --caplin.subscribe-all-topics                                                    Subscribe to all gossip topics (default: false)
+   --caplin.max-peer-count value                                                    Max number of peers to connect (default: 80)
+   --caplin.enable-upnp                                                             Enable NAT porting for Caplin (default: false)
+   --caplin.max-inbound-traffic-per-peer value                                      Max inbound traffic per second per peer (default: "256KB")
+   --caplin.max-outbound-traffic-per-peer value                                     Max outbound traffic per second per peer (default: "256KB")
+   --caplin.adaptable-maximum-traffic-requirements                                  Make the node adaptable to the maximum traffic requirement based on how many validators are being ran (default: true)
    --sentinel.addr value                                                            Address for sentinel (default: "localhost")
    --sentinel.port value                                                            Port for sentinel (default: 7777)
    --sentinel.bootnodes value [ --sentinel.bootnodes value ]                        Comma separated enode URLs for P2P discovery bootstrap
@@ -214,6 +232,7 @@ GLOBAL OPTIONS:
    --silkworm.rpc.workers value                                                     Number of worker threads used in embedded Silkworm RPC service (zero means use default in Silkworm) (default: 0)
    --silkworm.rpc.compatibility                                                     Preserve JSON-RPC compatibility using embedded Silkworm RPC service (default: true)
    --beacon.api value [ --beacon.api value ]                                        Enable beacon API (available endpoints: beacon, builder, config, debug, events, node, validator, lighthouse)
+   --beacon.api value [ --beacon.api value ]                                        Enable beacon API (available endpoints: beacon, builder, config, debug, events, node, validator, lighthouse)
    --beacon.api.addr value                                                          sets the host to listen for beacon api requests (default: "localhost")
    --beacon.api.cors.allow-methods value [ --beacon.api.cors.allow-methods value ]  set the cors' allow methods (default: "GET", "POST", "PUT", "DELETE", "OPTIONS")
    --beacon.api.cors.allow-origins value [ --beacon.api.cors.allow-origins value ]  set the cors' allow origins
@@ -229,6 +248,7 @@ GLOBAL OPTIONS:
    --caplin.checkpoint-sync.disable                                                 disable checkpoint sync in caplin (default: false)
    --caplin.archive                                                                 enables archival node in caplin (default: false)
    --caplin.snapgen                                                                 enables snapshot generation in caplin (default: false)
+   --caplin.snapgen                                                                 enables snapshot generation in caplin (default: false)
    --caplin.mev-relay-url value                                                     MEV relay endpoint. Caplin runs in builder mode if this is set
    --caplin.validator-monitor                                                       Enable caplin validator monitoring metrics (default: false)
    --caplin.custom-config value                                                     set the custom config for caplin

src/basic-usage.md

@@ -8,6 +8,7 @@ The all-in-one client is the preferred option for most users:
 ./build/bin/erigon
 ```
 
+This CLI command allows you to run an Ethereum **full node ** where every process is integrated and no special configuration is needed.
 This CLI command allows you to run an Ethereum **full node ** where every process is integrated and no special configuration is needed.
 
 The default Consensus Layer utilized is [Caplin](./advanced/caplin.md), the Erigon flagship embedded CL.
@@ -20,11 +21,14 @@ The default Consensus Layer utilized is [Caplin](./advanced/caplin.md), the Erig
     --datadir=<your_data_dir>
     ```
 
+* Based on the [type of node](basic/node.md) you want to run you can add ```--prune.mode=archive``` to run a archive node or ```--prune.mode=minimal``` for a minimal node.
 * Based on the [type of node](basic/node.md) you want to run you can add ```--prune.mode=archive``` to run a archive node or ```--prune.mode=minimal``` for a minimal node.
 The default node is archive node.
 * ```--chain=mainnet```, add the flag `--chain=sepolia` for Sepolia testnet or `--chain=holesky` for Holesky testnet.
+* ```--chain=mainnet```, add the flag `--chain=sepolia` for Sepolia testnet or `--chain=holesky` for Holesky testnet.
 * ```--http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool``` to use RPC and e.g. be able to connect your [wallet](basic/wallet.md).
 * To increase download speed add ```--torrent.download.rate=512mb``` (default is 16mb).
+* To increase download speed add ```--torrent.download.rate=512mb``` (default is 16mb).
 
 To stop the Erigon node you can use the ```CTRL+C``` command.
 

src/basic/disk-space.md

@@ -1,5 +1,6 @@
 # Disk Space Required
 *How much space your Erigon node will take*
+*How much space your Erigon node will take*
 
 
 # Mainnets
@@ -11,6 +12,7 @@
 | Gnosis   |    535 GB    |    365 GB |  210 GB      |
 | Polygon  |    4.3 TB    |    2 TB   |  873 GB      |
 
+<div class="hidden">
 <div class="hidden">
 ## Erigon with an external Consensus Layer client
 
@@ -24,10 +26,12 @@
 | Chiado   |    ... GB    |    ... GB |  ... GB      |
 | Amoy     |    ... GB    |    ... GB |  ... GB      |
 
+</div>
 </div>
 
 # Testnets
 ## Erigon with Caplin
+## Erigon with Caplin
 
 | Network  | Archive Node | Full Node | Minimal Node |
 |----------|--------------|-----------|--------------|

src/basic/node.md

@@ -6,11 +6,14 @@ Erigon 3 introduces a flexible approach to node configuration, offering three di
 |--------------|--------------|-----------|--------------|
 | Privacy, RPC |    **Yes**   |   **Yes** |    **Yes**   |
 | Contribute to network | No  |   **Yes** |    **Yes**   |
+| Contribute to network | No  |   **Yes** |    **Yes**   |
 | Research     |    No        |    No     |    **Yes**   |
 | Staking      |    **Yes**   |  **Yes**  |    **Yes**   |
+| Staking      |    **Yes**   |  **Yes**  |    **Yes**   |
 
 ## Minimal node
 
+
 Erigon 3 implements support for [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444) through its *Minimal Node configuration*, enabled by the flag `--prune.mode=minimal`. For example:
 
 ```bash

src/basic/optimizing-storage.md

@@ -1,5 +1,6 @@
 # Optimizing Storage
 *Using fast disks and cheap disks*
+*Using fast disks and cheap disks*
 
 For optimal performance, it's recommended to store the datadir on a fast NVMe-RAID disk. However, if this is not feasible, you can store the history on a cheaper disk and still achieve good performance.
 

src/installation.md

@@ -2,6 +2,9 @@
 
 In order to use Erigon, the software has to be installed first. There are several ways to install Erigon, depending on the operating system and the user's choice of installation method, e.g. using a package manager, container or building from source.
 
+The current version documented in these pages is Erigon 3. 
+
+> Always check the [list of releases](https://github.com/erigontech/erigon/releases) for release notes.
 > Always check the [list of releases](https://github.com/erigontech/erigon/releases) for release notes.
 
 _____________________________

src/installation/docker.md

@@ -19,8 +19,12 @@ Here are the steps to download and start Erigon 3 in Docker:
 
 1. Install the latest version of Docker Engine, see instructions [here](https://docs.docker.com/engine/install/).
 
+2. Visit the Erigon Docker Hub page to view the available releases. For Erigon 3, search for the [latest available release](https://hub.docker.com/r/erigontech/erigon/tags?name=v3).
+1. Install the latest version of Docker Engine, see instructions [here](https://docs.docker.com/engine/install/).
+
 2. Visit the Erigon Docker Hub page to view the available releases. For Erigon 3, search for the [latest available release](https://hub.docker.com/r/erigontech/erigon/tags?name=v3).
 
+3. Download the latest version:
 3. Download the latest version:
 
 ```bash
@@ -36,8 +40,11 @@ docker run -it <image_id> --v
 ```
 * If you want to start Erigon add the options according to the [basic usage](/basic-usage.md) page or the advanced customization page. For example:
 
+* If you want to start Erigon add the options according to the [basic usage](/basic-usage.md) page or the advanced customization page. For example:
+
 ```bash
 docker run -it 50bef1b5d0f9 --chain=holesky --prune.mode=minimal
+docker run -it 50bef1b5d0f9 --chain=holesky --prune.mode=minimal
 ```
 * When done, exit the container or press `Ctrl+C`. The container will stop.