updates and fixes

Author: Bloxster

README.md

@@ -1,21 +1,5 @@
 # The Erigon 3 Book
 
-This is the official The Erigon 3 Book, soon online at <https://docs.erigon.tech/>.
+This is the official Erigon 3 documentation, hosted at <https://docs.erigon.tech/>.
 
-It is built on [mdbook](https://rust-lang.github.io/mdBook/). Please take a look at its install instructions first.
-
-## Build
-
-```shell
-mdbook build
-```
-
-The compiled book will be available in the `book` subdirectory.
-
-## Run it locally
-
-```shell
-mdbook serve
-```
-
-It will start a local HTTP server and serve the book contents at http://localhost:3000/.
+Development branch is hosted at <https://development.erigon-documentation-preview.pages.dev> and it is built on [mdbook](https://rust-lang.github.io/mdBook/). If you want to contribute please take a look at its install instructions first.

src/SUMMARY.md

@@ -23,14 +23,18 @@
     - [Default Ports and Firewalls](basic/ports.md)
     - [Web3 Wallet](basic/wallet)
 
+- [Quick nodes](quick_nodes.md)
+    - [How to run an Ethereum node](nodes/ethereum.md)
+    - [How to run a Gnosis Chain node](nodes/gnosis.md)
+    - [How to run a Polygon node](nodes/polygon.md)
+
 - [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)
@@ -39,14 +43,9 @@
     - [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)
-
- ---
+- [Staking](staking.md)
+    - [External CL](advanced/bp-ext.md)
+    - [Caplin](advanced/bp-caplin.md)
 
 - [Tools](tools.md)
     - [Dagnostic Tools](tools/introduction.md)

src/advanced/block-prod.md src/advanced/bp-caplin.mdsrc/advanced/block-prod.md renamed to src/advanced/bp-caplin.md

@@ -1,40 +1,7 @@
-# Block production
-
-*How to propose and validate blocks with Erigon*
-
-Both remote miners and Caplin are supported.
-
-# Using remote miners
-
-To enable remote miners , add the flags:
-
-```bash
---mine --miner.etherbase=...
-```
-or
-
-```bash
---mine --miner.miner.sigkey=...
-```
-
-Other supported options are:
-- `--miner.notify`: Comma separated HTTP URL list to notify of new work packages
-- `--miner.gaslimit`: Target gas limit for mined blocks (default: `36000000`)
-- `--miner.etherbase`: Public address for block mining rewards (default: "`0`")
-- `--miner.extradata`: Block extra data set by the miner (default: `client version`)
-- `--miner.noverify`: Disable remote sealing verification (default: `false`)
-- `--miner.noverify`: Disable remote sealing verification (default: `false`)
-- `--miner.sigfile`: Private key to sign blocks with
-- `--miner.recommit`: Time interval to recreate the block being mined (default: `3s`)
-- `--miner.gasprice`: This option sets the minimum gas price for mined transactions
-- `--miner.gastarget`: This option sets the maximum amount of gas that could be spent during a transaction.
-
-Erigon supports [standard JSON-RPC methods](https://ethereum.org/en/developers/docs/apis/json-rpc/).
-
 # Using Caplin as validator
-*Running Erigon with Caplin and Lighthouse Validator*
+*Running Erigon with Caplin as validator*
 
-Caplin is also suitable for staking, however, you will need to utilize either Lighthouse, Teku, or another validator client as your key manager, since Caplin does not offer a native key management solution.
+Caplin is also suitable for staking. However, it is required to pair it with a validator key manager, such as Lighthouse or Teku, since it doesn't have a native key management system.
 
 This guide explains how to use Erigon with its embedded Caplin consensus layer and Lighthouse as the validator client for staking on Ethereum.
 

src/advanced/bp-ext.md

@@ -0,0 +1,26 @@
+# Using an external consensus client as validator
+
+To enable external consensus clients, add the flags:
+
+```bash
+--mine --miner.etherbase=...
+```
+or
+
+```bash
+--mine --miner.miner.sigkey=...
+```
+
+Other supported options are:
+- `--miner.notify`: Comma separated HTTP URL list to notify of new work packages
+- `--miner.gaslimit`: Target gas limit for mined blocks (default: `36000000`)
+- `--miner.etherbase`: Public address for block mining rewards (default: "`0`")
+- `--miner.extradata`: Block extra data set by the miner (default: `client version`)
+- `--miner.noverify`: Disable remote sealing verification (default: `false`)
+- `--miner.noverify`: Disable remote sealing verification (default: `false`)
+- `--miner.sigfile`: Private key to sign blocks with
+- `--miner.recommit`: Time interval to recreate the block being mined (default: `3s`)
+- `--miner.gasprice`: This option sets the minimum gas price for mined transactions
+- `--miner.gastarget`: This option sets the maximum amount of gas that could be spent during a transaction.
+
+Erigon supports [standard JSON-RPC methods](https://ethereum.org/en/developers/docs/apis/json-rpc/).

src/advanced/configuring.md

@@ -4,8 +4,8 @@ The Erigon 3 CLI has a wide range of flags that can be used to customize its beh
 
 ## Data Storage
 
-* `--datadir`: Set the data directory for the databases (default: `/home/admin/.local/share/erigon`)
-* `--ethash.dagdir`: Set the directory to store the ethash mining DAGs (default: `/home/admin/.local/share/erigon-ethash`)
+* `--datadir`: Set the data directory for the databases (default: `/home/usr/.local/share/erigon`)
+* `--ethash.dagdir`: Set the directory to store the ethash mining DAGs (default: `/home/usr/.local/share/erigon-ethash`)
 * `--database.verbosity` Enabling internal db logs. Very high verbosity levels may require recompile db. Default: 2, means warning. (default: `2`)
 
 ## Logging

src/advanced/downloader.md

@@ -159,7 +159,7 @@ To display available options for downloader digit:
 
 The `--help` flag listing is reproduced below for your convenience.
 
-```
+```bash
 snapshot downloader
 
 Usage:
@@ -182,7 +182,7 @@ Available Commands:
 
 Flags:
       --chain string                       name of the network to join (default "mainnet")
-      --datadir string                     Data directory for the databases (default "/home/admin/.local/share/erigon")
+      --datadir string                     Data directory for the databases (default "/home/usr/.local/share/erigon")
       --db.writemap                        Enable WRITE_MAP feature for fast database writes and fast commit times (default true)
       --diagnostics.disabled               Disable diagnostics
       --diagnostics.endpoint.addr string   Diagnostics HTTP server listening interface (default "127.0.0.1")

src/advanced/lighthouse.md

@@ -1,9 +1,33 @@
 # Lighthouse
 
-Lighthouse is another popular client that combined with Erigon can be used for block building.
+Lighthouse is another popular client that combined with Erigon can be used for block building. The necessary steps to run Erigon with Lightouse are listed here following:
+
+1. Start Erigon with the flag `--externalcl` to allow a external Consesus Layer: 
+
+    ```bash
+    ./build/bin/erigon --externalcl
+    ```
+
+2. Install Lighthouse by following the [official instructions](https://lighthouse-book.sigmaprime.io).
+
+3. Lighthouse must fully synchronize before Erigon can start syncing, since Erigon requires an existing target head to sync to. The quickest way to get Lighthouse synced is to use a public checkpoint synchronization endpoint from the list at <https://eth-clients.github.io/checkpoint-sync-endpoints>.
+
+    In order to communicate with Erigon the execution endpoint `<erigon address>:8551` must be specified, where `<erigon address>` is either `//localhost` or the IP address of the device running Erigon. 
+
+    Lighthouse must point to the [JWT secret](/advanced/jwt.md) automatically created by Erigon in the datadir directory (in the below example the default data directory is used).
+
+    ```bash
+    lighthouse bn \
+    --network mainnet \
+    --execution-endpoint http://localhost:8551 \
+    --execution-jwt /home/usr/.local/share/erigon/jwt.hex \
+    --checkpoint-sync-url https://mainnet.checkpoint.sigp.io \
+    ```
+
+    If your Lighthouse is on a different device, add `--authrpc.addr 0.0.0.0` (Engine API listens on localhost by default) as well as `--authrpc.vhosts <CL host>`.
+
+
+
+
 
-Documentation can be found here: <https://lighthouse-book.sigmaprime.io>
 
-The basic steps to run Erigon together with Lighthouse are:
-1. Install and run Erigon. Erigon will automatically create a JWT secret.
-2. Install and run Lighthouse, pointing to JWT secret created by Erigon.

src/advanced/prysm.md

@@ -1,4 +1,23 @@
 # Prysm
 
+Prysm is a popular client that combined with Erigon can be used for staking. The necessary steps to run Erigon with Prysm are listed here following:
 
-<img src="/images/WIP.png" alt="" style="display: block; margin: 0 auto;">
+1. Start Erigon with the flag `--externalcl` to allow a external Consesus Layer:
+
+    ```bash
+    ./build/bin/erigon --externalcl
+    ```
+
+2. Install Prysm by following the [official instructions](https://docs.prylabs.network/docs/install/install-with-script).
+
+3. Prysm must fully synchronize before Erigon can start syncing, since Erigon requires an existing target head to sync to. The quickest way to get Prysm synced is to use a public checkpoint synchronization endpoint from the list at <https://eth-clients.github.io/checkpoint-sync-endpoints>.
+
+    In order to communicate with Erigon the execution endpoint `<erigon address>:8551` must be specified, where `<erigon address>` is either `//localhost` or the IP address of the device running Erigon. 
+
+    Prysm must point to the [JWT secret](/advanced/jwt.md) automatically created by Erigon in the datadir directory (in the below example the default data directory is used).
+
+    ```bash
+    ./prysm.sh beacon-chain --execution-endpoint=http://localhost:8551 --mainnet --jwt-secret=/home/usr/.local/share/erigon/jwt.hex --checkpoint-sync-url=https://beaconstate.info --genesis-beacon-api-url=https://beaconstate.info
+    ```
+
+    If your Prysm is on a different device, add `--authrpc.addr 0.0.0.0` (Engine API listens on localhost by default) as well as `--authrpc.vhosts <CL host>`.

src/advanced/rpc_daemon.md

@@ -49,7 +49,7 @@ For example:
 
 ```bash
 ./build/bin/erigon  --internalcl --private.api.addr=localhost:9090 --http=false
-./build/bin/rpcdaemon --private.api.addr=localhost:9090 --http.vhosts="*" --http.addr="0.0.0.0" --http.api=eth,erigon,web3,net,debug,trace,txpool —-datadir=/home/admin/.local/share/erigon
+./build/bin/rpcdaemon --private.api.addr=localhost:9090 --http.vhosts="*" --http.addr="0.0.0.0" --http.api=eth,erigon,web3,net,debug,trace,txpool —-datadir=/home/usr/.local/share/erigon
 ```
 
 With the above command it has also been specified which RPC namespaces to enable by `--http.api` flag.

src/advanced/txpool.md

@@ -46,7 +46,7 @@ Usage:
   txpool [flags]
 
 Flags:
---datadir string                  Data directory for the databases (default "/home/admin/.local/share/erigon")
+--datadir string                  Data directory for the databases (default "/home/usr/.local/share/erigon")
 -h, --help                            help for txpool
 --log.console.json                Format console logs with JSON
 --log.console.verbosity string    Set the log level for console logs (default "info")