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
76 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
3e7b94a
Merged main into development
Jan 29, 2025
706ad0c
Merge branch 'main' into development
bloxster Jan 29, 2025
e29ee04
updates
Oct 31, 2024
f5e542e
updates and corrections
Nov 6, 2024
6256a28
updated disclaimer on welcome page
Nov 6, 2024
6701c05
updates and corrections
Nov 6, 2024
c3cc21e
updates and correction
Nov 6, 2024
d1b0b00
updates
Nov 20, 2024
63fcc61
update
Nov 20, 2024
f015776
updated
Nov 21, 2024
93e4611
updated sentry and rpc_daemon
Nov 27, 2024
5f553fb
updated full node by default, staking, alpha6 etc.
Dec 12, 2024
9c2b3f7
updates and fixes
Dec 20, 2024
ea26757
updated staking, caplin, RPC, disk space, ports
Jan 3, 2025
c342fb8
added op-node
Jan 4, 2025
48e93ba
updates
Jan 4, 2025
3daf436
updated JSON-RPC, welcome, README
Jan 6, 2025
38ed521
updated intro page
Jan 6, 2025
6de73ec
minor markdown issues
Jan 8, 2025
336f6b7
small fixes and duplicates removal
Jan 8, 2025
2d5c4c9
broken link, duplicate removal
Jan 23, 2025
ed30499
Update to v3.00.0-beta1 (#7)
bloxster Jan 29, 2025
f7309f7
small updates and typos
Feb 6, 2025
929c8a7
conflict solving
Feb 6, 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
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
The Erigon 3 documentation © 2024 by Erigon contributors is licensed under CC BY 4.0.
The Erigon 3 documentation © 2025 by Erigon contributors is licensed under CC BY 4.0.

To view a copy of this license, visit https://creativecommons.org/licenses/by/4.0/
6 changes: 0 additions & 6 deletions src/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,12 @@ Begin by exploring the comprehensive **[Programmer's Guide](https://github.com/l
### Dive Deeper into the Architecture

For those interested in gaining a deeper understanding of Erigon's underlying architecture, visit the following resources:

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

Expand Down
2 changes: 1 addition & 1 deletion src/advanced/JSONRPC-daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The RPC daemon is a crucial component of Erigon, enabling JSON remote procedure
This document provides guidelines for understanding and using the various RPC methods available in Erigon.

1. **Compatibility with `eth` namespace**
- Erigon aims to be compatible with all standard Ethereum JSON-RPC API methods, as described [here](https://github.com/ethereum/execution-apis). See also [here](https://github.com/erigontech/erigon/blob/main/docs/readthedocs/source/rpc/index.rst) for examples.
- Erigon aims to be compatible with all standard Ethereum JSON-RPC API methods, as described [here](https://ethereum.org/en/developers/docs/apis/json-rpc/). See also [here](https://github.com/erigontech/erigon/blob/main/docs/readthedocs/source/rpc/index.rst) for examples.

1. **Compatibility with standard Geth methods**
- All methods featured by Geth including [WebSocket Server](https://geth.ethereum.org/docs/interacting-with-geth/rpc#websockets-server), [IPC Server](https://geth.ethereum.org/docs/interacting-with-geth/rpc#ipc-server), TLS, [GraphQL](https://geth.ethereum.org/docs/interacting-with-geth/rpc/graphql), etc..., are supported by Erigon.
Expand Down
2 changes: 0 additions & 2 deletions src/advanced/bp-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,3 @@ Other supported options are:
- `--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/).
2 changes: 1 addition & 1 deletion src/advanced/downloader.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Available Commands:

Flags:
--chain string name of the network to join (default "mainnet")
--datadir string Data directory for the databases (default "/home/bloxster/.local/share/erigon")
--datadir string Data directory for the databases (default "/home/admin/.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")
Expand Down
22 changes: 2 additions & 20 deletions src/advanced/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ The `--help` flag listing is reproduced below for your convenience.
./build/bin/erigon --help
```



## Commands

```
Expand All @@ -29,11 +31,6 @@ 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)
Expand All @@ -53,10 +50,6 @@ 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,
Expand Down Expand Up @@ -96,7 +89,6 @@ 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)
Expand Down Expand Up @@ -158,7 +150,6 @@ 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)
Expand All @@ -176,7 +167,6 @@ 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)
Expand Down Expand Up @@ -211,12 +201,6 @@ 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
Expand All @@ -234,7 +218,6 @@ 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
Expand All @@ -251,7 +234,6 @@ GLOBAL OPTIONS:
--caplin.blobs-no-pruning disable blob pruning in caplin (default: false)
--caplin.checkpoint-sync.disable disable checkpoint sync 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
Expand Down
3 changes: 2 additions & 1 deletion src/basic/disk-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

# Mainnets


## Erigon with Caplin

| Network | Archive Node | Full Node | Minimal Node |
Expand All @@ -15,6 +16,7 @@ See also [sync times](https://github.com/erigontech/erigon?tab=readme-ov-file#sy

<div class="hidden">


## Erigon with an external Consensus Layer client

*(Values obtained with [Lighthouse](https://lighthouse-book.sigmaprime.io/))*
Expand All @@ -30,7 +32,6 @@ See also [sync times](https://github.com/erigontech/erigon?tab=readme-ov-file#sy
</div>

# Testnets

## Erigon with Caplin


Expand Down
2 changes: 0 additions & 2 deletions src/basic/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ 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

Expand Down
6 changes: 3 additions & 3 deletions src/getting-started/sw-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ To install the latest Go version, visit the official documentation at [https://g

### C++ Compiler

This turns the C++ part of Erigon's code into a program your computer can run. You can use either **Clang** or **GCC**.
This turns the C++ part of Erigon's code into a program your computer can run. You can use either **Clang** or **GCC**:

- For **Clang** follow the instructions at [https://clang.llvm.org/get_started.html](https://clang.llvm.org/get_started.html). Only in Linux, place your terminal to directory where you want to install Clang and copy-paste this code:
- For **GCC** (version 10 or newer): [https://gcc.gnu.org/install/index.html](https://gcc.gnu.org/install/index.html)
- For **Clang** follow the instructions at [https://clang.llvm.org/get_started.html](https://clang.llvm.org/get_started.html);
- For **GCC** (version 10 or newer): [https://gcc.gnu.org/install/index.html](https://gcc.gnu.org/install/index.html).

You can now proceed with Erigon [installation](/installation.md).
2 changes: 0 additions & 2 deletions src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

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.

_____________________________
Expand Down
5 changes: 5 additions & 0 deletions src/installation/upgrading-md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ To upgrade Erigon to a newer version when you've originally installed it via Git

* **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
Expand Down Expand Up @@ -47,18 +49,21 @@ If you're using Docker to run Erigon, the process to upgrade to a newer version
docker pull erigontech/erigon:v3.0.0-beta1
```


* **List Your Docker Images**: Check your downloaded images to confirm the new image is there and get the new image ID:

```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
Expand Down
Loading