Erigon is an implementation of Ethereum (aka "Ethereum client"), on the efficiency frontier, written in Go.
NB! In-depth links are marked by the microscope sign (🔬)
Disclaimer: this software is currently a tech preview. We will do our best to keep it stable and make no breaking changes but we don't guarantee anything. Things can and will break.
-
For an Archive node of Ethereum Mainnet we recommend >=3TB storage space: 1.8TB state (as of March 2022), 200GB temp files (can symlink or mount folder
<datadir>/etl-tmpto another disk). Ethereum Mainnet Full node (see--prune*flags): 400Gb (April 2022). -
Goerli Full node (see
--prune*flags): 189GB on Beta, 114GB on Alpha (April 2022). -
BSC Archive: 7TB. BSC Full: 1TB.
-
Polygon Mainnet Archive: 5TB. Polygon Mumbai Archive: 1TB.
SSD or NVMe. Do not recommend HDD - on HDD Erigon will always stay N blocks behind chain tip, but not fall behind. Bear in mind that SSD performance deteriorates when close to capacity.
RAM: >=16GB, 64-bit architecture, Golang version >= 1.18, GCC 10+
🔬 more info on disk storage is here.
git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon.git
cd erigon
make erigon
./build/bin/erigonDefault --syncmode=snap for mainnet, goerli, bsc. Other networks now have default --syncmode=full. Increase download speed by flag --torrent.download.rate=20mb. 🔬 See Downloader docs
Use --datadir to choose where to store data.
Use --chain=bor-mainnet for Polygon Mainnet and --chain=mumbai for Polygon Mumbai.
There is an optional stage that can be enabled through flags:
--watch-the-burn, Enable WatchTheBurn stage which keeps track of ETH issuance and is required to useerigon_watchTheBurn.
If you would like to give Erigon a try, but do not have spare 2TB on your drive, a good option is to start syncing one of the public testnets, Görli. It syncs much quicker, and does not take so much disk space:
git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon.git
cd erigon
make erigon
./build/bin/erigon --datadir goerli --chain goerliPlease note the --datadir option that allows you to store Erigon files in a non-default location, in this example,
in goerli subdirectory of the current directory. Name of the directory --datadir does not have to match the name of
the chain in --chain.
Disclaimer: Not supported/tested for Polygon Network (In Progress)
Support only remote-miners.
- To enable, add
--mine --miner.etherbase=...or--mine --miner.miner.sigkey=...flags. - Other supported options:
--miner.extradata,--miner.notify,--miner.gaslimit,--miner.gasprice,--miner.gastarget - JSON-RPC supports methods: eth_coinbase , eth_hashrate, eth_mining, eth_getWork, eth_submitWork, eth_submitHashrate
- JSON-RPC supports websocket methods: newPendingTransaction
- TODO:
- we don't broadcast mined blocks to p2p-network yet, but it's easy to accomplish
- eth_newPendingTransactionFilter
- eth_newBlockFilter
- eth_newFilter
- websocket Logs
🔬 Detailed mining explanation is here.
Windows users may run erigon in 3 possible ways:
-
Build executable binaries natively for Windows using provided
wmake.ps1PowerShell script. Usage syntax is the same asmakecommand so you have to run.\wmake.ps1 [-target] <targetname>. Example:.\wmake.ps1 erigonbuilds erigon executable. All binaries are placed in.\build\bin\subfolder. There are some requirements for a successful native build on windows :- Git for Windows must be installed. If you're cloning this repository is very likely you already have it
- GO Programming Language must be installed. Minimum required version is 1.18
- GNU CC Compiler at least version 10 (is highly suggested that you install
chocolateypackage manager - see following point) - If you need to build MDBX tools (i.e.
.\wmake.ps1 db-tools) then Chocolatey package manager for Windows must be installed. By Chocolatey you need to install the following components :cmake,make,mingwbychoco install cmake make mingw.
Important note about Anti-Viruses During MinGW's compiler detection phase some temporary executables are generated to test compiler capabilities. It's been reported some anti-virus programs detect those files as possibly infected by
Win64/Kryptic.CIStrojan horse (or a variant of it). Although those are false positives we have no control over 100+ vendors of security products for Windows and their respective detection algorythms and we understand this might make your experience with Windows builds uncomfortable. To workaround the issue you might either set exclusions for your antivirus specifically forbuild\bin\mdbx\CMakeFilessub-folder of the cloned repo or you can run erigon using the following other two options -
Use Docker : see docker-compose.yml
-
Use WSL (Windows Subsystem for Linux) strictly on version 2. Under this option you can build Erigon just as you would on a regular Linux distribution. You can point your data also to any of the mounted Windows partitions ( eg.
/mnt/c/[...],/mnt/d/[...]etc) but in such case be advised performance is impacted: this is due to the fact those mount points useDrvFSwhich is a network file system and, additionally, MDBX locks the db for exclusive access which implies only one process at a time can access data. This has consequences on the running ofrpcdaemonwhich has to be configured as Remote DB even if it is executed on the very same computer. If instead your data is hosted on the native Linux filesystem non limitations apply. Please also note the default WSL2 environment has its own IP address which does not match the one of the network interface of Windows host: take this into account when configuring NAT for port 30303 on your router.
Erigon can be used as an execution-layer for beacon chain consensus clients (Eth2). Default configuration is ok. Eth2
relies on availability of receipts - don't prune them: don't add character r to --prune flag. However, old receipts
are not needed for Eth2 and you can safely prune them with --prune.r.before=11184524 in combination with --prune htc.
You must enable JSON-RPC by --http and add engine to --http.api list. (Or run the JSON-RPC daemon in addition to the Erigon)
If beacon chain client on a different device: add --http.addr 0.0.0.0 (JSON-RPC listen on localhost by default)
.
Once the JSON-RPC is running, all you need to do is point your beacon chain client to <ip address>:8545,
where <ip address> is either localhost or the IP address of the device running the JSON-RPC.
Erigon has been tested with Lighthouse however all other clients that support JSON-RPC should also work.
In order to establish a secure connection between the Consensus Layer and the Execution Layer, a JWT secret key is automatically generated.
The JWT secret key will be present in the datadir by default under the name of jwt.hex and its path can be specified with the flag --authrpc.jwtsecret.
This piece of info needs to be specified in the Consensus Layer as well in order to establish connection successfully. More information can be found here
Define 5 flags to avoid conflicts: --datadir --port --http.port --torrent.port --private.api.addr. Example of multiple chains on the same machine:
# mainnet
./build/bin/erigon --datadir="<your_mainnet_data_path>" --chain=mainnet --port=30303 --http.port=8545 --torrent.port=42069 --private.api.addr=127.0.0.1:9090 --http --ws --http.api=eth,debug,net,trace,web3,erigon
# rinkeby
./build/bin/erigon --datadir="<your_rinkeby_data_path>" --chain=rinkeby --port=30304 --http.port=8546 --torrent.port=42068 --private.api.addr=127.0.0.1:9091 --http --ws --http.api=eth,debug,net,trace,web3,erigon
Quote your path if it has spaces.
🔬 Detailed explanation is DEV_CHAIN.
🔬 See more
detailed overview of functionality and current limitations. It
is being updated on recurring basis.
Flat KV storage. Erigon uses a key-value database and storing accounts and storage in a simple way.
🔬 See our detailed DB walkthrough here.
Preprocessing. For some operations, Erigon uses temporary files to preprocess data before inserting it into the main DB. That reduces write amplification and DB inserts are orders of magnitude quicker.
🔬 See our detailed ETL explanation here.
Plain state.
Single accounts/state trie. Erigon uses a single Merkle trie for both accounts and the storage.
Erigon uses a rearchitected full sync algorithm from Go-Ethereum that is split into "stages".
🔬 See more detailed explanation in the Staged Sync Readme
It uses the same network primitives and is compatible with regular go-ethereum nodes that are using full sync, you do not need any special sync capabilities for Erigon to sync.
When reimagining the full sync, with focus on batching data together and minimize DB overwrites. That makes it possible to sync Ethereum mainnet in under 2 days if you have a fast enough network connection and an SSD drive.
Examples of stages are:
-
Downloading headers;
-
Downloading block bodies;
-
Recovering senders' addresses;
-
Executing blocks;
-
Validating root hashes and building intermediate hashes for the state Merkle trie;
-
[...]