updated and restructered

erigontech · Oct 20, 2024 · ce57210 · ce57210
1 parent b8a3e75
commit ce57210
Show file tree

Hide file tree

Showing 21 changed files with 138 additions and 65 deletions.
diff --git a/book.toml b/book.toml
@@ -1,7 +1,7 @@
 [book]
 title = "The Erigon 3 Book"
-authors = ["Gianni Morselli"]
+authors = ["Erigon"]
 description = "Erigon 3 documentation!"
 language = "en"
 multilingual = false
-src = "src"
+src = "src"
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,52 +1,62 @@
-# Summary
+# Erigon 3 docs summary
 
-- [Welcome to Erigon 3](./welcome.md)
+- [Welcome to Erigon 3](welcome.md)
 
-- [Getting Started](./getting_started.md)
-    - [Hardware Requirements](./getting-started/hw-requirements.md)
-        - [Tips for faster syncing](./getting-started/tips.md)
-    - [Software Requirements](./getting-started/sw-requirements.md)
+- [Getting Started](getting_started.md)
+    - [Hardware Requirements](getting-started/hw-requirements.md)
+        - [Tips for faster syncing](getting-started/tips.md)
+    - [Software Requirements](getting-started/sw-requirements.md)
 
 - [Installation](installation.md)
-    - [Linux and MacOS](./installation/linux.md)
-    - [Windows](./installation/windows.md)
-    - [Docker](./installation/docker.md)
-    - [Upgrading from a previous version](./installation/upgrading-md)
-
-- [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)
-    - [Web3 Wallet](./basic/wallet)
-
-- [Advanced Usage](./advanced.md)
-    - [Configuring Erigon](./advanced/configuring.md)
-    - [Consensus Layer](./advanced/consensus_layer.md)
-        - [Caplin](./advanced/caplin.md)
-        - [Prysm](./advanced/prysm.md)
-        - [Lighthouse](./advanced/lighthouse.md)
-        - [JWT secret](./advanced/jwt.md)
-        - [Block production](./advanced/block-prod.md)
-    - [Options](./advanced/options.md)
-    - [RPC Daemon](./advanced/rpc_daemon.md)
-    - [TxPool](./advanced/txpool.md)
-    - [Sentry](./advanced/sentry.md)
-    - [Downloader](./advanced/downloader.md)
-    - [TLS Authentication](./advanced/tls-authentication.md)
-    - [Perfomance Tricks](./advanced/performance.md)
-
-- [Diagnostic Tool](./diagnostic/introduction.md)
-    - [Installation](./diagnostic/installation.md)
-    - [Setup](./diagnostic/setup.md)
-    - [User Interface](./diagnostic/user_interface.md)
-
-- [Otterscan](./otterscan.md)
-
-- [Frequently Asked Questions](./faq.md)
+    - [Linux and MacOS](installation/linux.md)
+    - [Windows](installation/windows.md)
+    - [Docker](installation/docker.md)
+    - [Upgrading from a previous version](installation/upgrading-md)
+
+- [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)
+    - [Web3 Wallet](basic/wallet)
+
+- [Advanced Usage](advanced.md)
+    - [Configuring Erigon](advanced/configuring.md)
+    - [Consensus Layer](advanced/consensus_layer.md)
+        - [Caplin](advanced/caplin.md)
+        - [Prysm](advanced/prysm.md)
+        - [Lighthouse](advanced/lighthouse.md)
+        - [JWT secret](advanced/jwt.md)
+        - [Block production](advanced/block-prod.md)
+    - [Options](advanced/options.md)
+    - [RPC Daemon](advanced/rpc_daemon.md)
+    - [TxPool](advanced/txpool.md)
+    - [Sentry](advanced/sentry.md)
+    - [Downloader](advanced/downloader.md)
+    - [TLS Authentication](advanced/tls-authentication.md)
+    - [Perfomance Tricks](advanced/performance.md)
+
+ ---
+
+- [Quick nodes](quick_nodes.md)
+    - [Ethereum](nodes/ethereum.md)
+    - [Gnosis](nodes/gnosis.md)
+    - [Polygon](nodes/polygon.md)
+
+ ---
+
+- [Tools](tools.md)
+    - [Diagnostic Tool](tools/introduction.md)
+        - [Installation](tools/installation.md)
+        - [Setup](tools/setup.md)
+        - [User Interface](tools/user_interface.md)
+    - [Otterscan](tools/otterscan.md)
+
+- [Frequently Asked Questions](faq.md)
 
 - [About](about.md)
-    - [License](./about/license.md)
-    - [Contributing](./about/contributing.md)
-    - [How to reach us](./about/reachus.md)
+    - [License](about/license.md)
+    - [Contributing](about/contributing.md)
+    - [Donate](about/donate.md)
+    - [How to reach us](about/reachus.md)
diff --git a/src/about/donate.md b/src/about/donate.md
@@ -0,0 +1,3 @@
+# Donate
+
+To support our work you can donate to [0x8BFBB529A9E85fDC4b70A4FCdC0D68Bb298B8816](https://etherscan.io/address/0x8BFBB529A9E85fDC4b70A4FCdC0D68Bb298B8816#multichain-portfolio).
diff --git a/src/about/reachus.md b/src/about/reachus.md
@@ -1,2 +1,15 @@
 # How to reach us
 
+Erigon office is located in the CV Labs in Zug
+
+
+Erigon Ag / Damstrasse 16
+
+6300 Zug
+
+Switzerland
+
+## Erigon Discord Server
+
+The most important discussions take place on the Discord server where also some support is provided. To get an invite, send an email to bloxster [at] proton.me with your name, profession, a short explanation why you want to join the Discord server and how you heard about Erigon.
+
diff --git a/src/basic/disk-space.md b/src/basic/disk-space.md
@@ -3,12 +3,24 @@
 
 
 # Mainnets
+## Erigon with Caplin
 
 | Network  | Archive Node | Full Node | Minimal Node |
 |----------|--------------|-----------|--------------|
 | Ethereum |    1.7 TB    |    900 GB |  310 GB      |
 | Gnosis   |    511 GB    |    354 GB |  200 GB      |
-| Polygon  |    4.3 TB    |    2 TB |  873 GB      |
+| Polygon  |    4.3 TB    |    2 TB |  873 GB        |
+
+## Erigon with an external Consensus Layer client
+
+*(Values obtained with [Lighthouse](https://lighthouse-book.sigmaprime.io/))*
+
+| Network  | Archive Node | Full Node | Minimal Node |
+|----------|--------------|-----------|--------------|
+| Ethereum |    1.7 TB    |    900 GB |  310 GB      |
+| Gnosis   |    511 GB    |    354 GB |  200 GB      |
+| Polygon  |    4.3 TB    |    2 TB |  873 GB        |
+
 
 # Testnets
 

diff --git a/src/basic/node.md b/src/basic/node.md
@@ -9,11 +9,11 @@ If you want to do extensive **research**, like for example searching for old sta
 If you want to run a validator and produce blocks, **staking** is achievable already with a [full node](#full-node).
 
 
-| Usage    | Minimal Node | Full Node | Archive Node |
-|----------|--------------|-----------|--------------|
-| Privacy  |    **Yes**   |   **Yes** |    **Yes**   |
-| Research |    No        |    No     |    **Yes**   |
-| Staking  |    No        |  **Yes**  |    **Yes**   |
+| Usage        | Minimal Node | Full Node | Archive Node |
+|--------------|--------------|-----------|--------------|
+| Privacy, RPC |    **Yes**   |   **Yes** |    **Yes**   |
+| Research     |    No        |    No     |    **Yes**   |
+| Staking      |    No        |  **Yes**  |    **Yes**   |
 
 
 To switch type of node, you must first delete the ```/chaindata``` folder in the chosen ```--datadir``` directory.

diff --git a/src/diagnostic/introduction.md b/src/diagnostic/introduction.md
diff --git a/src/getting-started/hw-requirements.md b/src/getting-started/hw-requirements.md
@@ -2,15 +2,15 @@
 
 ## Disk type
 
-A locally mounted SSD (Solid-State Drive) or NVMe (Non-Volatile Memory Express) disk is recommended for storage. Hard Disk Drives (HDD) are not recommended, as they can cause Erigon to lag behind the blockchain tip, albeit not fall behind.
+A locally mounted **SSD** (Solid-State Drive) or **NVMe** (Non-Volatile Memory Express) disk is recommended for storage. Hard Disk Drives (HDD) are not recommended, as they can cause Erigon to lag behind the blockchain tip, albeit not fall behind.
 
 Additionally, SSDs may experience performance degradation when nearing full capacity.
 
 See here how you can [optimize storage](/basic/optimizing-storage.md).
 
 ## RAID Configuration
 
-When using multiple disks, consider implementing a RAID0 configuration to maximize performance and utilize space efficiently. Note that RAID ZFS is not recommended
+When using multiple disks, consider implementing a **RAID 0** configuration to maximize performance and utilize space efficiently. RAID ZFS is not recommended.
 
 ## Disk size
 
@@ -29,3 +29,6 @@ Please refer to [disk space required](/basic/disk-space.md) for details. To ensu
 
 * **Linux**: kernel version > v4
 
+## Bandwith
+
+A stable and reliable internet connection is crucial for running a node, especially if you intend to run a validator node, a downtime can result in missed rewards or penalties. A minimum download speed of 25Mbps is recommended, and it's best to use an ISP with an uncapped data allowance.
diff --git a/src/getting-started/tips.md b/src/getting-started/tips.md
@@ -1,4 +1,10 @@
 # Tips for faster syncing
 
-* **Optimize for Low Latency**: Use a machine with low latency (not throughput) disk and RAM for faster initial sync.
-* **Memory Optimized Nodes**: Consider using memory-optimized nodes for faster sync, such as *AWS EC2 r5* or *r6* series instances.
+
+## Optimize for Low Latency
+
+Use a machine with low latency (not throughput) disk and RAM for faster initial sync.
+
+## Memory Optimized Nodes
+
+Consider using memory-optimized nodes for faster sync, such as *AWS EC2 r5* or *r6* series instances.
diff --git a/src/nodes/ethereum.md b/src/nodes/ethereum.md
@@ -0,0 +1 @@
+# Ethereum
diff --git a/src/nodes/gnosis.md b/src/nodes/gnosis.md
@@ -0,0 +1 @@
+# Gnosis
diff --git a/src/nodes/polygon.md b/src/nodes/polygon.md
@@ -0,0 +1 @@
+# Polygon
diff --git a/src/otterscan.md b/src/otterscan.md
diff --git a/src/quick_nodes.md b/src/quick_nodes.md
@@ -0,0 +1,7 @@
+# Quick nodes
+
+These guides are recommended if you want to test Erigon and have your node up and running without reading all the documentation.
+
+- [Ethereum node](nodes/ethereum.md)
+- [Gnosis Chain node](nodes/gnosis.md)
+- [Polygon node](nodes/polygon.md)
diff --git a/src/tools.md b/src/tools.md
@@ -0,0 +1 @@
+# Tools
diff --git a/src/diagnostic/installation.md → src/tools/installation.md b/src/diagnostic/installation.md → src/tools/installation.md
diff --git a/src/tools/introduction.md b/src/tools/introduction.md
@@ -0,0 +1 @@
+# Diagnostic Tool
diff --git a/src/tools/otterscan.md b/src/tools/otterscan.md
@@ -0,0 +1,8 @@
+# Otterscan
+
+Otterscan is an Ethereum block explorer designed to be run locally along with Erigon.
+
+Entirely based on open source code, it is blazing fast and fully private since it works on your local machine. The user interface is intentionally very similar, but with many improvements, to the most popular Ethereum block explorer to make it easy to locate where the information is.
+Installation and usage instructions
+
+For the installation and usage follow the official documentation: <https://docs.otterscan.io/>
diff --git a/src/diagnostic/setup.md → src/tools/setup.md b/src/diagnostic/setup.md → src/tools/setup.md
diff --git a/src/diagnostic/user_interface.md → src/tools/user_interface.md b/src/diagnostic/user_interface.md → src/tools/user_interface.md
diff --git a/src/welcome.md b/src/welcome.md
@@ -12,6 +12,14 @@
 
 Erigon is an efficiency frontier implementation of Ethereum, designed to provide a faster, more modular and optimised experience. An archive node by default, Erigon uses edge technologies such as staged sync, efficient state storage and database compression, combined with high modularity.
 
+<div class="warning">
+
+If you wanto to test Erigon in minutes, go straight to the [quick nodes](quick_nodes.md) section.
+
+</div>
+
+# Features
+
 Erigon offers several features that make it a good option for a node application such as efficient state storage through the use of a key-value database and faster initial synchronisation.
 
 Built with modularity in mind, it also offers separate components such as the JSON RPC daemon, that can connect to both local and remote databases. For read-only calls, this RPC daemon does not need to run on the same system as the main Erigon binary, and can even run from a database snapshot.
@@ -33,21 +41,21 @@ Erigon 3 is a major update that introduces several significant changes, improvem
 
 **Node Configuration**
 
-* **Archive Node is default**. Full Node: ``--prune.mode=full``, Minimal Node (EIP-4444): ``--prune.mode=minimal``
+- Archive Node is default. For full node and minimal node see [type of node](/basic/node.md).
 
 **Other Features**
 
 * **New User Guide**: A dedicated user guide for Erigon 3 provides detailed information on how to set up and configure your node.
-* **Higher RAM Requirement**: Erigon 3 requires at least 64GB of RAM (which may be
+* **Higher RAM Requirement**: Erigon 3 requires at least 64GB of RAM.
 
-## Release Process
+# Release Process
 
 Erigon 3 also introduces changes to the release process, including:
 * New Docker Image Repository: Erigon images are now available on Dockerhub repository "erigontech/erigon".
 * Multi-Platform Support: The docker image is built for linux/amd64/v2 and linux/arm64 platforms using Alpine 3.20.2.
 * Release Workflow Changes: Build flags are now passed to the release workflow, allowing users to view previously missed build information in released binaries.
 
-## Known Issues
+# Known Issues
 
 While Erigon 3 offers many improvements over its predecessor, there are still some known issues and limitations:
-- don't [rm -rf] downloader - it will cause re-downloading of files: #10976
+- don't `rm -rf` downloader, it will cause re-downloading of files (#10976).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Donate

		To support our work you can donate to [0x8BFBB529A9E85fDC4b70A4FCdC0D68Bb298B8816](https://etherscan.io/address/0x8BFBB529A9E85fDC4b70A4FCdC0D68Bb298B8816#multichain-portfolio).