3.1 Release (#32)

* 3.1 updates

* fixed disk size for mainnet

* updated disk sizes and upgrading

* updated upgrading, compiling, ver., sizes

* updated shutter and persist.receipts in nodes

* updated size for gno and eth minimal node

* cleared instructions

* updated with port flags

* updated formatting

* save

* save

* HW requirements, downloader and RPC, upgrading

* removed duplicate info

* updated data managing

---------

Co-authored-by: Bloxster <[email protected]>
Co-authored-by: alex <[email protected]>

Author: 3 people

.gitignore

@@ -1 +1,8 @@
 book
+/tools/installation.md
+/tools/introduction.md
+/tools/options.md
+/tools/setup.md
+/tools/user_interface.md
+
+

src/SUMMARY.md

@@ -18,8 +18,6 @@
 
 - [Basic Usage](basic-usage.md)
     - [Type of Node](basic/node.md)
-        - [Disk Space Required](basic/disk-space.md)
-        - [Optimizing Storage](basic/optimizing-storage.md)
     - [Supported Networks](basic/networks.md)
     - [Default Ports and Firewalls](basic/ports.md)
     - [YAML/TOML Config](basic/yaml.md)
@@ -38,26 +36,21 @@
         - [Caplin](advanced/caplin.md)
         - [JWT secret](advanced/jwt.md)
     - [Options](advanced/options.md)
+    - [Optimizing Storage](advanced/optimizing-storage.md)
     - [RPC Daemon](advanced/JSONRPC-daemon.md)
         - [The trace Module](advanced/JSONRPC-trace-module.md)
     - [TxPool](advanced/txpool.md)
     - [Sentry](advanced/sentry.md)
     - [Downloader](advanced/downloader.md)
-    - [Running an Op-node](advanced/op-node.md)
     - [TLS Authentication](advanced/tls-authentication.md)
+    - [Running an Op-node](advanced/op-node.md)
+    - [Otterscan](tools/otterscan.md)
     - [Performance Tricks](advanced/performance.md)
 
 - [Staking](staking.md)
     - [External CL](advanced/bp-ext.md)
     - [Caplin](advanced/bp-caplin.md)
-
-- [Tools](tools.md)
-    - [Diagnostics Tool](tools/introduction.md)
-        - [Installation](tools/installation.md)
-        - [Setup](tools/setup.md)
-        - [Options](tools/options.md)
-        - [Browser Interface](tools/user_interface.md)
-    - [Otterscan](tools/otterscan.md)
+    - [Shutter Network](advanced/shutter.md)
 
 - [About](about.md)
     - [License](about/license.md)

src/_introduction.md

@@ -8,13 +8,12 @@ With Erigon 3 the default configuration shifts from archive node to full node, e
 
 # Topics
 
-- Review the hardware and software requirements [get started](getting_started.md).
+- Review the hardware and software requirements to [get started](getting_started.md).
 - Follow the [installation guide](installation.md) to set up Erigon.
 - Learn the [basic usage](basic-usage.md) of Erigon.
 - Quickly deploy your own Ethereum, Gnosis, or Polygon [node](quick_nodes.md).
 - Explore Erigon's [advanced features](advanced.md).
 - Discover the capabilities of the [RPC Daemon](advanced/JSONRPC-daemon.md).
-- Utilize integrated [tools](tools.md) like Diagnostic Tools and Otterscan.
 
 # Additional Resources and Information
 

src/advanced.md

@@ -2,10 +2,10 @@
 
 Erigon is by default an "all-in-one" binary solution, but it's possible start any internal component as a separated processes:
 
-- [RPCDaemon](./advanced/JSONRPC-daemon.md), the JSON RPC layer
+- [RPCDaemon](./advanced/JSONRPC-daemon.md), the JSON RPC layer. (Most battle-tested external component) 
 - [TxPool](./advanced/txpool.md), the transaction pool
 - [Sentry](./advanced/sentry.md), the p2p layer
-- [Downloader](./advanced/downloader.md), the history download layer
+- [Downloader](./advanced/downloader.md), the history download layer (we don't recommend run it externally)
 - [Caplin](./advanced/caplin.md), the novel Consensus Layer
 
 This may be for security, scalability, decentralisation, resource limitation, custom implementation, or any other reason you/your team deems appropriate. See the appropriate section to understand how to start each service separately.

src/advanced/JSONRPC-daemon.md

@@ -2,7 +2,7 @@
 # RPC Daemon
 *Remote Procedure Call*
 
-The RPC daemon is a crucial component of Erigon, enabling JSON remote procedure calls and providing access to various APIs. 
+The RPC daemon is a crucial component of Erigon, enabling JSON remote procedure calls and providing access to various APIs. It is designed to operate effectively both as an internal or as an external component. For detailed instructions on running it remotely, refer to the documentation [here](https://github.com/erigontech/erigon/blob/main/cmd/rpcdaemon/README.md#running-remotely).
 
 ## Erigon RPC Method Guidelines
 

src/advanced/configuring.md

@@ -3,13 +3,7 @@
 
 The Downloader is a service responsible for seeding and downloading historical data using the BitTorrent protocol. Data is stored in the form of immutable `.seg` files, known as **snapshots**. The Ethereum core instructs the Downloader to download specific files, identified by their unique info hashes, which include both block headers and block bodies. The Downloader then communicates with the BitTorrent network to retrieve the necessary files, as specified by the Ethereum core.
 
-<div class="warning">
-
-**Information**:
-
-While all Erigon components are separable and can be run on different machines, the Downloader must run on the same machine as Erigon to be able to share downloaded and seeded files.
-
-</div>
+> **Warning**: While all Erigon components are separable and can be run on different machines, the Downloader must run on the same machine as Erigon to be able to share downloaded and seeded files.
 
 For a comprehensive understanding of the Downloader's functionality, configuration, and usage, please refer to [./cmd/downloader/README.md](https://github.com/erigontech/erigon/blob/main/cmd/downloader/readme.md) with the following key topics:
 

src/advanced/downloader.md

@@ -0,0 +1,33 @@
+# Optimizing Storage
+*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.
+
+## Step 1: Store datadir on the slow disk
+
+Place the `datadir` on the slower disk. Then, create symbolic links (using `ln -s`) to the **fast disk** for the following sub-folders:
+
+- `chaindata`
+- `snapshots/domain`
+
+This will speed up the execution of E3.
+
+On the **slow disk** place `datadir` folder with the following structure:
+ - `chaindata` (linked to fast disk)
+ - `snapshots`
+    - `domain` (linked to fast disk)
+    - `history`
+    - `idx`
+    - `accessor`
+ - `temp`
+
+
+## Step 2: Speed Up History Access (Optional)
+
+If you need to further improve performance try the following improvements step by step:
+
+1. Store the `snapshots/accessor` folder on the fast disk. This should provide a noticeable speed boost.
+2. If the speed is still not satisfactory, move the `snapshots/idx` folder to the fast disk.
+3. If performance is still an issue, consider moving the entire `snapshots/history` folder to the fast disk.
+
+By following these steps, you can optimize your Erigon 3 storage setup to achieve a good balance between performance and cost.