diff --git a/Makefile b/Makefile index bec40ee6d..261316ecc 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,7 @@ docker: docker build -t turbo-geth:latest --build-arg git_commit='${GIT_COMMIT}' --build-arg git_branch='${GIT_BRANCH}' --build-arg git_tag='${GIT_TAG}' . docker-compose: + # Uses host's PID,UID,GID. It required to open Erigon's DB from another process (RPCDaemon local-mode) UID_GID=$(shell id -u):$(shell id -g) docker-compose up # debug build allows see C stack traces, run it with GOTRACEBACK=crash. You don't need debug build for C pit for profiling. To profile C code use SETCGOTRCKEBACK=1 diff --git a/README.md b/README.md index da613653c..d90e0d959 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Erigon Erigon is an implementation of Ethereum (aka "Ethereum client"), on the efficiency frontier, written in Go. @@ -6,43 +5,43 @@ Erigon is an implementation of Ethereum (aka "Ethereum client"), on the efficien ![Build status](https://github.com/ledgerwatch/erigon/actions/workflows/ci.yml/badge.svg) + - [System Requirements](#system-requirements) - [Usage](#usage) - + [Getting Started](#getting-started) - + [Testnets](#testnets) - + [Mining](#mining) - + [Windows](#windows) - + [GoDoc](https://godoc.org/github.com/ledgerwatch/erigon) + + [Getting Started](#getting-started) + + [Testnets](#testnets) + + [Mining](#mining) + + [Windows](#windows) + + [GoDoc](https://godoc.org/github.com/ledgerwatch/erigon) - [Key features](#key-features) - + [More Efficient State Storage](#more-efficient-state-storage) - + [Faster Initial Sync](#faster-initial-sync) - + [JSON-RPC daemon](#json-rpc-daemon) - + [Run all components by docker-compose](#run-all-components-by-docker-compose) - + [Grafana dashboard](#grafana-dashboard) + + [More Efficient State Storage](#more-efficient-state-storage) + + [Faster Initial Sync](#faster-initial-sync) + + [JSON-RPC daemon](#json-rpc-daemon) + + [Run all components by docker-compose](#run-all-components-by-docker-compose) + + [Grafana dashboard](#grafana-dashboard) - [FAQ](#faq) - [Getting in touch](#getting-in-touch) - + [Erigon Discord Server](#erigon-discord-server) - + [Reporting security issues/concerns](#reporting-security-issues-concerns) - + [Team](#team) + + [Erigon Discord Server](#erigon-discord-server) + + [Reporting security issues/concerns](#reporting-security-issues-concerns) + + [Team](#team) - [Known issues](#known-issues) - + [`htop` shows incorrect memory usage](#htop-shows-incorrect-memory-usage) + + [`htop` shows incorrect memory usage](#htop-shows-incorrect-memory-usage) + NB! In-depth links are marked by the microscope sign (🔬) -**Disclaimer: this software is currenly 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.** - - +**Disclaimer: this software is currenly 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.** The current version is currently based on Go-Ethereum 1.10.1 System Requirements =================== -Recommend 2Tb storage space on a single partition: 1Tb state, 200GB temp files (can symlink or mount folder `/etl-tmp` to another disk). +Recommend 2Tb storage space on a single partition: 1Tb state, 200GB temp files (can symlink or mount +folder `/etl-tmp` to another disk). RAM: 16GB, 64-bit architecture, [Golang version >= 1.16](https://golang.org/doc/install) @@ -62,7 +61,9 @@ Usage ### Testnets -If you would like to give Erigon a try, but do not have spare 2Tb on your driver, 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: +If you would like to give Erigon a try, but do not have spare 2Tb on your driver, 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: + ```sh > git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon.git > cd erigon @@ -70,7 +71,9 @@ If you would like to give Erigon a try, but do not have spare 2Tb on your driver > ./build/bin/erigon --datadir goerli --chain goerli ``` -Please 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 if the chain in `--chain`. +Please 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 if +the chain in `--chain`. ### Mining @@ -82,11 +85,12 @@ Support only remote-miners. * RPCDaemon supports methods: eth_coinbase , eth_hashrate, eth_mining, eth_getWork, eth_submitWork, eth_submitHashrate * RPCDaemon supports websocket methods: newPendingTransaction * TODO: - + we don't broadcast mined blocks to p2p-network yet, [but it's easy to accomplish](https://github.com/ledgerwatch/erigon/blob/9b8cdc0f2289a7cef78218a15043de5bdff4465e/eth/downloader/downloader.go#L673) - + eth_newPendingTransactionFilter - + eth_newBlockFilter - + eth_newFilter - + websocket Logs + + we don't broadcast mined blocks to p2p-network + yet, [but it's easy to accomplish](https://github.com/ledgerwatch/erigon/blob/9b8cdc0f2289a7cef78218a15043de5bdff4465e/eth/downloader/downloader.go#L673) + + eth_newPendingTransactionFilter + + eth_newBlockFilter + + eth_newFilter + + websocket Logs 🔬 Detailed mining explanation is [here](/docs/mining.md). @@ -94,41 +98,54 @@ Support only remote-miners. Windows users may run erigon in 3 possible ways: -* Build executable binaries natively for Windows using provided `wmake.ps1` PowerShell script. - Usage syntax is the same as `make` command so you have to run `.\wmake.ps1 [-target] `. Example: `.\wmake.ps1 erigon` builds erigon executable. - All binaries are placed in `.\build\bin\` subfolder. - There are some requirements for a successful native build on windows : - * [Git](https://git-scm.com/downloads) for Windows must be installed. If you're cloning this repository is very likely you already have it - * [GO Programming Language](https://golang.org/dl/) must be installed. Minimum required version is 1.16 - * If you need to build MDBX tools (i.e. `.\wmake.ps1 db-tools`) then [Chocolatey package manager](https://chocolatey.org/) for Windows must be installed. By Chocolatey you need to install the following components : `cmake`, `make`, `mingw` by `choco install cmake make mingw`. +* Build executable binaries natively for Windows using provided `wmake.ps1` PowerShell script. Usage syntax is the same + as `make` command so you have to run `.\wmake.ps1 [-target] `. Example: `.\wmake.ps1 erigon` builds erigon + executable. All binaries are placed in `.\build\bin\` subfolder. There are some requirements for a successful native + build on windows : + * [Git](https://git-scm.com/downloads) for Windows must be installed. If you're cloning this repository is very + likely you already have it + * [GO Programming Language](https://golang.org/dl/) must be installed. Minimum required version is 1.16 + * If you need to build MDBX tools (i.e. `.\wmake.ps1 db-tools`) + then [Chocolatey package manager](https://chocolatey.org/) for Windows must be installed. By Chocolatey you need + to install the following components : `cmake`, `make`, `mingw` by `choco 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.CIS` trojan 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 exlusions for your antivirus specifically for `build\bin\mdbx\CMakeFiles` sub-folder of the cloned repo or you can run erigon using the following other two options + 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.CIS` trojan 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 exlusions for your antivirus specifically + for `build\bin\mdbx\CMakeFiles` sub-folder of the cloned repo or you can run erigon using the following other two + options * Use Docker : see [docker-compose.yml](./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 use `DrvFS` which is a [network file system](#blocks-execution-is-slow-on-cloud-network-drives) 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 of `rpcdaemon` which has to be configured as [Remote DB](#for-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.** +* 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 use `DrvFS` which is a [network file system](#blocks-execution-is-slow-on-cloud-network-drives) + 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 of `rpcdaemon` which has to be configured as [Remote DB](#for-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.** Key features ============ -🔬 See more detailed [overview of functionality and current limitations](https://ledgerwatch.github.io/turbo_geth_release.html). It is being updated on recurring basis. +🔬 See more +detailed [overview of functionality and current limitations](https://ledgerwatch.github.io/turbo_geth_release.html). It +is being updated on recurring basis. ### More Efficient State Storage -**Flat KV storage.** Erigon uses a key-value database and storing accounts and storage in -a simple way. +**Flat KV storage.** Erigon uses a key-value database and storing accounts and storage in a simple way. 🔬 See our detailed DB walkthrough [here](./docs/programmers_guide/db_walkthrough.MD). -**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. +**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](/common/etl/README.md). @@ -144,13 +161,11 @@ Erigon uses a rearchitected full sync algorithm from 🔬 See more detailed explanation in the [Staged Sync Readme](/eth/stagedsync/README.md) -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. +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, we focused 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. +When reimagining the full sync, we focused 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: @@ -168,16 +183,18 @@ Examples of stages are: ### JSON-RPC daemon -In Erigon RPC calls are extracted out of the main binary into a separate daemon. -This daemon can use both local or remote DBs. That means, that this RPC daemon -doesn't have to be running on the same machine as the main Erigon binary or +In Erigon RPC calls are extracted out of the main binary into a separate daemon. This daemon can use both local or +remote DBs. That means, that this RPC daemon doesn't have to be running on the same machine as the main Erigon binary or it can run from a snapshot of a database for read-only calls. 🔬 See [RPC-Daemon docs](./cmd/rpcdaemon/README.md) #### **For local DB** -This is only possible if RPC daemon runs on the same computer as Erigon. This mode uses shared memory access to the database of Erigon, which has better performance than accessing via TPC socket (see "For remote DB" section below). Provide both `--datadir` and `--private.api.addr` options: +This is only possible if RPC daemon runs on the same computer as Erigon. This mode uses shared memory access to the +database of Erigon, which has better performance than accessing via TPC socket (see "For remote DB" section below). +Provide both `--datadir` and `--private.api.addr` options: + ``` > make erigon > ./build/bin/erigon --private.api.addr=localhost:9090 @@ -187,7 +204,8 @@ This is only possible if RPC daemon runs on the same computer as Erigon. This mo #### **For remote DB** -This works regardless of whether RPC daemon is on the same computer with Erigon, or on a different one. They use TPC socket connection to pass data between them. To use this mode, run Erigon in one terminal window +This works regardless of whether RPC daemon is on the same computer with Erigon, or on a different one. They use TPC +socket connection to pass data between them. To use this mode, run Erigon in one terminal window ``` > make erigon @@ -198,19 +216,27 @@ This works regardless of whether RPC daemon is on the same computer with Erigon, **gRPC ports**: `9090` erigon, `9091` sentry, `9092` consensus engine, `9093` snapshot downloader, `9094` TxPool -Supported JSON-RPC calls ([eth](./cmd/rpcdaemon/commands/eth_api.go), [debug](./cmd/rpcdaemon/commands/debug_api.go), [net](./cmd/rpcdaemon/commands/net_api.go), [web3](./cmd/rpcdaemon/commands/web3_api.go)): +Supported JSON-RPC calls ([eth](./cmd/rpcdaemon/commands/eth_api.go), [debug](./cmd/rpcdaemon/commands/debug_api.go) +, [net](./cmd/rpcdaemon/commands/net_api.go), [web3](./cmd/rpcdaemon/commands/web3_api.go)): -For a details on the implementation status of each command, [see this table](./cmd/rpcdaemon/README.md#rpc-implementation-status). +For a details on the implementation status of each +command, [see this table](./cmd/rpcdaemon/README.md#rpc-implementation-status). ### Run all components by docker-compose Next command starts: Erigon on port 30303, rpcdaemon 8545, prometheus 9090, grafana 3000 ``` -docker-compose build -XDG_DATA_HOME=/preferred/data/folder docker-compose up +make docker-compose +or +XDG_DATA_HOME=/preferred/data/folder make docker-compose ``` +Makefile uses host's PID,UID,GID. It required to open Erigon's DB from another process (RPCDaemon local-mode). +See: https://github.com/ledgerwatch/erigon/pull/2392/files + +Windows support for docker-compose is not ready yet. Please help us with .ps1 port + ### Grafana dashboard `docker-compose up prometheus grafana`, [detailed docs](./cmd/prometheus/Readme.md). @@ -222,7 +248,7 @@ FAQ - Baseline (ext4 SSD): 16Gb RAM sync takes 5 days, 32Gb - 4 days, 64Gb - 3 days - +1 day on "zfs compression=off". +2 days on "zfs compression=on" (2x compression ratio). +3 days on btrfs. -- -1 day on NVMe +- -1 day on NVMe Detailed explanation: [./docs/programmers_guide/db_faq.md](./docs/programmers_guide/db_faq.md) @@ -231,9 +257,8 @@ Getting in touch ### Erigon Discord Server -The main discussions are happening on our Discord server. -To get an invite, send an email to `tg [at] torquem.ch` with your name, occupation, -a brief explanation of why you want to join the Discord, and how you heard about Erigon. +The main discussions are happening on our Discord server. To get an invite, send an email to `tg [at] torquem.ch` with +your name, occupation, a brief explanation of why you want to join the Discord, and how you heard about Erigon. ### Reporting security issues/concerns @@ -269,7 +294,8 @@ Thanks to: * All contributors of Go-Ethereum -* Our special respect and graditude is to the core team of [Go-Ethereum](https://github.com/ethereum/go-ethereum). Keep up the great job! +* Our special respect and graditude is to the core team of [Go-Ethereum](https://github.com/ethereum/go-ethereum). Keep + up the great job! Happy testing! 🥤 @@ -278,38 +304,36 @@ Known issues ### `htop` shows incorrect memory usage -Erigon's internal DB (MDBX) using `MemoryMap` - when OS does manage all `read, write, cache` operations instead of Application -([linux](https://linux-kernel-labs.github.io/refs/heads/master/labs/memory_mapping.html), [windows](https://docs.microsoft.com/en-us/windows/win32/memory/file-mapping)) +Erigon's internal DB (MDBX) using `MemoryMap` - when OS does manage all `read, write, cache` operations instead of +Application +([linux](https://linux-kernel-labs.github.io/refs/heads/master/labs/memory_mapping.html) +, [windows](https://docs.microsoft.com/en-us/windows/win32/memory/file-mapping)) -`htop` on column `res` shows memory of "App + OS used to hold page cache for given App", -but it's not informative, because if `htop` says that app using 90% of memory you still -can run 3 more instances of app on the same machine - because most of that `90%` is "OS pages cache". -OS automatically free this cache any time it needs memory. -Smaller "page cache size" may not impact performance of Erigon at all. +`htop` on column `res` shows memory of "App + OS used to hold page cache for given App", but it's not informative, +because if `htop` says that app using 90% of memory you still can run 3 more instances of app on the same machine - +because most of that `90%` is "OS pages cache". +OS automatically free this cache any time it needs memory. Smaller "page cache size" may not impact performance of +Erigon at all. Next tools show correct memory usage of Erigon: -- `vmmap -summary PID | grep -i "Physical footprint"`. - Without `grep` you can see details - `section MALLOC ZONE column Resident Size` shows App memory usage, `section REGION TYPE column Resident Size` shows OS pages cache size. -- `Prometheus` dashboard shows memory of Go app without OS pages cache (`make prometheus`, open in browser `localhost:3000`, credentials `admin/admin`) + +- `vmmap -summary PID | grep -i "Physical footprint"`. Without `grep` you can see details + - `section MALLOC ZONE column Resident Size` shows App memory usage, `section REGION TYPE column Resident Size` + shows OS pages cache size. +- `Prometheus` dashboard shows memory of Go app without OS pages cache (`make prometheus`, open in + browser `localhost:3000`, credentials `admin/admin`) - `cat /proc//smaps` -Erigon uses ~4Gb of RAM during genesis sync and ~1Gb during normal work. OS pages cache can utilize unlimited amount of memory. +Erigon uses ~4Gb of RAM during genesis sync and ~1Gb during normal work. OS pages cache can utilize unlimited amount of +memory. -**Warning:** Multiple instances of Erigon on same machine will touch Disk concurrently, -it impacts performance - one of main Erigon optimisations: "reduce Disk random access". -"Blocks Execution stage" still does much random reads - this is reason why it's slowest stage. -We do not recommend run multiple genesis syncs on same Disk. -If genesis sync passed, then it's fine to run multiple Erigon on same Disk. +**Warning:** Multiple instances of Erigon on same machine will touch Disk concurrently, it impacts performance - one of +main Erigon optimisations: "reduce Disk random access". +"Blocks Execution stage" still does much random reads - this is reason why it's slowest stage. We do not recommend run +multiple genesis syncs on same Disk. If genesis sync passed, then it's fine to run multiple Erigon on same Disk. ### Blocks Execution is slow on cloud-network-drives Please read https://github.com/ledgerwatch/erigon/issues/1516#issuecomment-811958891 -In short: network-disks are bad for blocks execution - because blocks execution reading data from db non-parallel non-batched way. - -### rpcdaemon "Local-Mode" experimentally working with docker-compose - -Running rpcdaemon in "Local-Mode" (including the `--datadir` flag) generally results in better performance for -RPC calls. By sharing the PID namespace for both containers, it's possible now to run erigon and rpcdaemon in separate containers and datadir as volume. -You can start up the whole stack with the following command: `make docker-compose` -For the absolute best performance bare metal is recommended at this time. -Please, help us configure Docker volume driver to support MMAP files with POSIX file-locks (MDBX). +In short: network-disks are bad for blocks execution - because blocks execution reading data from db non-parallel +non-batched way. diff --git a/docker-compose.yml b/docker-compose.yml index 4027d50f4..ec2d98560 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,9 +4,9 @@ services: erigon: image: thorax/erigon:latest - user: ${UID_GID:-1000:1000} build: . command: erigon --datadir=/var/lib/erigon --metrics --metrics.addr=0.0.0.0 --metrics.port=6060 --private.api.addr=0.0.0.0:9090 --pprof --pprof.addr=0.0.0.0 --pprof.port=6061 + user: ${UID_GID:-1000:1000} # Uses host's PID,UID,GID. It required to open Erigon's DB from another process (RPCDaemon local-mode) pid: host volumes: - ${XDG_DATA_HOME:-~/.local/share}/erigon:/var/lib/erigon @@ -42,8 +42,8 @@ services: rpcdaemon: image: thorax/erigon:latest - user: ${UID_GID:-1000:1000} command: rpcdaemon --datadir /var/lib/erigon --private.api.addr=erigon:9090 --http.addr=0.0.0.0 --http.vhosts=* --http.corsdomain=* --http.api=eth,debug,net + user: ${UID_GID:-1000:1000} # Uses host's PID,UID,GID. It required to open Erigon's DB from another process (RPCDaemon local-mode) pid: host volumes: - ${XDG_DATA_HOME:-~/.local/share}/erigon:/var/lib/erigon