Skip to content
This repository was archived by the owner on Dec 22, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
f7ee4b0
add development branch for preview releases
Oct 29, 2024
9961ba5
Merge branch 'main' of https://github.com/erigontech/docs into develo…
Oct 30, 2024
b216062
updated tls
Oct 30, 2024
b13b3a8
Merge branch 'development' of https://github.com/erigontech/docs into…
Oct 30, 2024
c2197dc
updates
Oct 31, 2024
90d3916
update
Oct 31, 2024
9013f20
updates and corrections
Nov 6, 2024
46c6d21
added staking to minimal node
Nov 6, 2024
b0bcdfe
updated Polygon quicknode page
Nov 6, 2024
c092d6b
updated Gnosis Chain quick node
Nov 6, 2024
87cdf93
Gnosis quicknode formatting error correction
Nov 6, 2024
704ff94
updated disclaimer on welcome page
Nov 6, 2024
4acd835
updated disclaimer on welcome page
Nov 6, 2024
b228165
updated disclaimer on welcome page
Nov 6, 2024
ee56b8a
typo correction
Nov 6, 2024
66ee793
typo correction on welcome page
Nov 6, 2024
8225c3a
typo correction on welcome page
Nov 6, 2024
d85fd00
updates and corrections
Nov 6, 2024
acb12cb
updates and correction
Nov 6, 2024
e8a5215
updates
Nov 10, 2024
2e05c01
updates
Nov 13, 2024
b7da325
updates
Nov 20, 2024
934c71b
update
Nov 20, 2024
fc8fa2d
updated
Nov 21, 2024
5c76c26
restructured and improved Windows
Nov 27, 2024
3af2c7a
updated sentry and rpc_daemon
Nov 27, 2024
deee31a
updated full node by default, staking, alpha6 etc.
Dec 12, 2024
cb9ce75
fix conflict on src/getting-started/sw-requirements.md
Dec 12, 2024
afb2509
updates and fixes
Dec 20, 2024
964f2d3
updated staking, caplin, RPC, disk space, ports
Jan 3, 2025
e2f165d
added op-node
Jan 4, 2025
c2bedb9
updates
Jan 4, 2025
4d4bb9f
correction
Jan 4, 2025
5d8e94d
updated JSON-RPC, welcome, README
Jan 6, 2025
8fab0d5
updated intro page
Jan 6, 2025
7884a89
small syntax modification
Jan 6, 2025
8780462
punctuation
Jan 6, 2025
ed55c2b
int chapter more info
Jan 6, 2025
f49b240
Merge branch 'main' into development
Jan 8, 2025
046c302
duplicate title
Jan 8, 2025
f7448ee
syntax correction
Jan 8, 2025
044a41a
minor markdown issues
Jan 8, 2025
f6b4c66
small fixes and duplicates removal
Jan 8, 2025
431c297
corrected heimdall API
Jan 9, 2025
38c7cef
removed duplicate options
Jan 9, 2025
8a89aa9
duplicate removal
Jan 13, 2025
6f51ace
introduced link to sync times.
Jan 15, 2025
aa4b8c1
updated link
Jan 18, 2025
9bf5ebc
updated to v3.00.0-beta1
Jan 23, 2025
498d2a6
broken link, duplicate removal
Jan 23, 2025
00b022d
typo
Jan 25, 2025
55dd5bb
Merge branch 'main' into development
bloxster Jan 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/advanced/downloader.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The Downloader is a service responsible for seeding and downloading historical d

**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.
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>

For a comprehensive understanding of the Downloader's functionality, configuration, and usage, please refer to the embedded file you can find in your compiled Erigon folder at `./cmd/downloader/README.md`. This file covers the following key topics:
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:

1. **Snapshots overview**: An introduction to snapshots, their benefits, and how they are created and used in Erigon.
2. **Starting Erigon with snapshots support**: Instructions on how to start Erigon with snapshots support, either by default or as a separate process.
Expand Down
18 changes: 11 additions & 7 deletions src/advanced/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ USAGE:
erigon [command] [flags]

VERSION:
3.00.0-alpha7-34714c0c
3.00.0-beta1-0b94461f

COMMANDS:
init Bootstrap and initialize a new genesis block
Expand Down Expand Up @@ -124,6 +124,7 @@ GLOBAL OPTIONS:
--snap.keepblocks Keep ancient blocks in db (useful for debug) (default: false)
--snap.stop Workaround to stop producing new snapshots, if you meet some snapshots-related critical bug. It will stop move historical data from DB to new immutable snapshots. DB will grow and may slightly slow-down - and removing this flag in future will not fix this effect (db size will not greatly reduce). (default: false)
--snap.state.stop Workaround to stop producing new state files, if you meet some state-related critical bug. It will stop aggregate DB history in a state files. DB will grow and may slightly slow-down - and removing this flag in future will not fix this effect (db size will not greatly reduce). (default: false)
--snap.skip-state-snapshot-download Skip state download and start from genesis block (default: false)
--db.pagesize value DB is splitted to 'pages' of fixed size. Can't change DB creation. Must be power of 2 and '256b <= pagesize <= 64kb'. Default: equal to OperationSystem's pageSize. Bigger pageSize causing: 1. More writes to disk during commit 2. Smaller b-tree high 3. Less fragmentation 4. Less overhead on 'free-pages list' maintainance (a bit faster Put/Commit) 5. If expecting DB-size > 8Tb then set pageSize >= 8Kb (default: "4KB")
--db.size.limit value Runtime limit of chaindata db size (can change at any time) (default: "200GB")
--db.writemap Enable WRITE_MAP feature for fast database writes and fast commit times (default: true)
Expand Down Expand Up @@ -196,7 +197,7 @@ GLOBAL OPTIONS:
--bor.minblocksize Ignore the bor block period and wait for 'blocksize' transactions (for testing purposes) (default: false)
--bor.milestone Enabling bor milestone processing (default: true)
--bor.waypoints Enabling bor waypont recording (default: false)
--polygon.sync Enabling syncing using the new polygon sync component (default: false)
--polygon.sync Enabling syncing using the new polygon sync component (default: true)
--polygon.sync.stage Enabling syncing with a stage that uses the polygon sync component (default: false)
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
--override.prague value Manually specify the Prague fork time, overriding the bundled setting (default: 0)
Expand All @@ -219,6 +220,7 @@ GLOBAL OPTIONS:
--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
--sentinel.staticpeers value [ --sentinel.staticpeers value ] connect to comma-separated Consensus static peers
--ots.search.max.pagesize value Max allowed page size for search methods (default: 25)
--silkworm.exec Enable Silkworm block execution (default: false)
--silkworm.rpc Enable embedded Silkworm RPC service (default: false)
Expand All @@ -242,11 +244,12 @@ GLOBAL OPTIONS:
--beacon.api.write.timeout value Sets the seconds for a write time out in the beacon api (default: 31536000)
--beacon.api.protocol value Protocol for beacon API (default: "tcp")
--beacon.api.ide.timeout value Sets the seconds for a write time out in the beacon api (default: 25)
--caplin.backfilling sets whether backfilling is enabled for caplin (default: false)
--caplin.backfilling.blob sets whether backfilling is enabled for caplin (default: false)
--caplin.backfilling.blob.no-pruning disable blob pruning in caplin (default: false)
--caplin.blocks-archive sets whether backfilling is enabled for caplin (default: false)
--caplin.blobs-archive sets whether backfilling is enabled for caplin (default: false)
--caplin.states-archive enables archival node for historical states in caplin (it will enable block archival as well) (default: false)
--caplin.blobs-immediate-backfill sets whether caplin should immediatelly backfill blobs (4096 epochs) (default: false)
--caplin.blobs-no-pruning disable blob pruning in caplin (default: false)
--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
Expand All @@ -261,7 +264,8 @@ GLOBAL OPTIONS:
--sync.parallel-state-flushing Enables parallel state flushing (default: true)
--chaos.monkey Enable 'chaos monkey' to generate spontaneous network/consensus/etc failures. Use ONLY for testing (default: false)
--shutter Enable the Shutter encrypted transactions mempool (defaults to false) (default: false)
--shutter.keyper.bootnodes value [ --shutter.keyper.bootnodes value ] Use to override the default keyper bootnodes (defaults to using the bootnodes from the embedded config)
--shutter.p2p.bootstrap.nodes value [ --shutter.p2p.bootstrap.nodes value ] Use to override the default p2p bootstrap nodes (defaults to using the values in the embedded config)
--shutter.p2p.listen.port value Use to override the default p2p listen port (defaults to 23102) (default: 0)
--pprof Enable the pprof HTTP server (default: false)
--pprof.addr value pprof HTTP server listening interface (default: "127.0.0.1")
--pprof.port value pprof HTTP server listening port (default: 6060)
Expand Down
11 changes: 1 addition & 10 deletions src/advanced/sentry.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,25 +59,16 @@ Where `value` is comma separated sentry addresses '<host>:<port>,<host>:<port>'.

For other information regarding Sentry functionality, configuration, and usage, please refer to the embedded file you can find in your compiled Erigon folder at `./cmd/sentry/README.md`.

## Options

The --help flag listing is reproduced below for your convenience.

```bash
./build/bin/sentry --help
```

### Command Line Options

To display available options for Sentry digit:

```bash
./build/bin/sentry -h
./build/bin/sentry --help
```

The `--help` flag listing is reproduced below for your convenience.


```
Run p2p sentry

Expand Down
2 changes: 2 additions & 0 deletions src/basic/disk-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
| Gnosis | 535 GB | 365 GB | 210 GB |
| Polygon | 4.3 TB | 2 TB | 873 GB |

See also [sync times](https://github.com/erigontech/erigon?tab=readme-ov-file#sync-times).

<div class="hidden">

## Erigon with an external Consensus Layer client
Expand Down
2 changes: 1 addition & 1 deletion src/getting-started/sw-requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Software Requirements

Before we start, please note that building software from source can be complex. If you're not comfortable with technical tasks, you might want to check the [Docker](./docker.md) installation.
Before we start, please note that building software from source can be complex. If you're not comfortable with technical tasks, you might want to check the [Docker](/installation/docker.md) installation.

Erigon works only from command line interface (CLI), so it is advisable to have a good confidence with basic commands.

Expand Down
3 changes: 2 additions & 1 deletion src/installation/build_exec_win.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ Then click on the "**New**" button and paste the following path:
Open the Command Prompt and type the following:

```bash
git clone --branch v3.0.0-alpha7 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-beta1 --single-branch https://github.com/erigontech/erigon.git
```

You might need to change the `ExecutionPolicy` to allow scripts created locally or signed by a trusted publisher to run:

```powershell
Expand Down
13 changes: 6 additions & 7 deletions src/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,32 @@ 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
docker pull erigontech/erigon:v3.0.0-alpha7
docker pull erigontech/erigon:v3.0.0-beta1
```

* List the downloaded images to get the IMAGE ID:

```bash
docker images
```

* Check which Erigon version has been downloaded:

```bash
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.

## Optional: Setup dedicated user
Expand Down
2 changes: 1 addition & 1 deletion src/installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The basic Erigon configuration is suitable for most users just wanting to run a node. For building the latest stable release use the following command:

```bash
git clone --branch v3.0.0-alpha7 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-beta1 --single-branch https://github.com/erigontech/erigon.git
cd erigon
make erigon
```
Expand Down
50 changes: 13 additions & 37 deletions src/installation/upgrading-md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,32 @@
To upgrade Erigon to a newer version when you've originally installed it via Git and manual compilation, you should follow these steps without needing to delete the entire folder:

* **Terminate your Erigon** session by pressing CTRL+C
* *Navigate to your Erigon directory*

* **Navigate to your Erigon directory**

* **Fetch the latest changes from the repository**: You need to make sure your local repository is up-to-date with the main GitHub repository. Run:

```bash
git fetch --tags
```
```bash
git fetch --tags
```

* **Check out** the [latest version](https://github.com/ledgerwatch/erigon/releases) and switch to it using:

```bash
git checkout <new_version_tag>
```
Replace `<new_version_tag>` with the version tag of the new release, for example:
```bash
git checkout <new_version_tag>
```

Replace `<new_version_tag>` with the version tag of the new release, for example:

```bash
git checkout v3.0.0-alpha7
git checkout v3.0.0-beta1
```

* **Rebuild Erigon**: Since the codebase has changed, you need to compile the new version. Run:

```bash
make erigon
```
```bash
make erigon
```

This process updates your installation to the latest version you specify, while maintaining your existing data and configuration settings in the Erigon folder. You're essentially just replacing the executable with a newer version.

Expand All @@ -44,64 +40,44 @@ If you're using Docker to run Erigon, the process to upgrade to a newer version
```bash
docker pull erigontech/erigon:<new_version_tag>
```

Replace `<new_version_tag>` with the actual version tag you wish to use. For example:

```bash
docker pull erigontech/erigon:<new_version_tag>
docker pull erigontech/erigon:v3.0.0-beta1
```
Replace `<new_version_tag>` with the actual version tag you wish to use. For example:

```bash
docker pull erigontech/erigon:3.0.0
```
```bash
docker pull erigontech/erigon:3.0.0
```
* **List Your Docker Images**: Check your downloaded images to confirm the new image is there and get the new image ID:

```bash
docker images
```
```bash
docker images
```

* **Stop the Running Erigon Container**: If you have a currently running Erigon container, you'll need to stop it before you can start the new version. First, find the container ID by listing the running containers:

```bash
docker ps
```
Then stop the container using:
```bash
docker ps
```

Then stop the container using:

```bash
docker stop <container_id>
```
```bash
docker stop <container_id>
```

Replace `<container_id>` with the actual ID of the container running Erigon.
Replace `<container_id>` with the actual ID of the container running Erigon.

* **Remove the Old Container**: (Optional) If you want to clean up, you can remove the old container after stopping it:

```bash
docker rm <container_id>
```
```bash
docker rm <container_id>
```

* **Run the New Image**: Now you can start a new container with the new Erigon version using the new image ID:

```bash
docker run -it <new_image_id>
```
```bash
docker run -it <new_image_id>
```

* **Verify Operation**: Ensure that Erigon starts correctly and connects to the desired network, verifying the logs for any initial errors.

Expand Down
2 changes: 1 addition & 1 deletion src/nodes/ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Check which [type of node](/basic/node.md) you might want to run and the [disk s
For MacOS and Linux, run the following commands to build from source the latest Erigon version:

```bash
git clone --branch v3.0.0-alpha6 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-beta1 --single-branch https://github.com/erigontech/erigon.git
cd erigon
make erigon
```
Expand Down
2 changes: 1 addition & 1 deletion src/nodes/gnosis.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Check which [type of node](/basic/node.md) you might want to run and the [disk s
For MacOS and Linux, run the following commands to build from source the latest Erigon version:

```bash
git clone --branch v3.0.0-alpha6 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-beta1 --single-branch https://github.com/erigontech/erigon.git
cd erigon
make erigon
```
Expand Down
2 changes: 1 addition & 1 deletion src/nodes/polygon.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Check which [type of node](/basic/node.md) you might want to run and the [disk s
For MacOS and Linux, run the following commands to build from source the latest Erigon version:

```bash
git clone --branch v3.0.0-alpha6 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-beta1 --single-branch https://github.com/erigontech/erigon.git
cd erigon
make erigon
```
Expand Down