Basic Usage

Command Line Usage and Basic Erigon Configuration

Erigon is mainly operated through the command line. The commands may vary based on your installation method.

Pre-Built Binaries

Open your terminal and simply start Erigon with the command:

erigon [options]

Docker

Built from Source

Windows

To gracefully stop Erigon simply press CTRL + C.

All-in-One Client

The all-in-one client is the preferred option for most users:

./build/bin/erigon [options]

This CLI command allows you to run an Ethereum full node where every process is integrated and no special configuration is needed.

The default Consensus Layer utilized is Caplin, the Erigon flagship embedded CL.

Example of configuration

To run Erigon with RPCDaemon, TxPool, and other components in a single process is the simplest way to get started. For better performance and load management, you might consider distributing these components across multiple machines.

./build/bin/erigon --datadir=/desired/path/to/datadir \
 --chain=mainnet \
 --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 \
 --log.dir.path=/desired/path/to/logs
 --torrent.download.rate=512mb

Flags of Interest

• Default data directory is /home/usr/.local/share/erigon. If you want to store Erigon files in a non-default location, use the flag:

  --datadir=/desired/path/to/datadir

• The --chain=mainnet flag is set by default for Erigon to sync with the Ethereum mainnet. To explore other network options, check the Supported Networks section. For quick testing, consider selecting a testnet.

• --log.dir.path dictates where logs will be output - useful for sending reports to the Erigon team when issues occur.

• Based on the sync mode you want to run you can add --prune.mode=archive to run a archive node, --prune.mode=full for a full node (default value) or --prune.mode=minimal for a minimal node.

• --http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool to use RPC Service and e.g. be able to connect your wallet.

• --torrent.download.rate=512mb to increase download speed. While the default downloading speed is 128mb, with this flag Erigon will use as much download speed as it can, up to a maximum of 512 megabytes per second. This means it will try to download data as quickly as possible, but it won't exceed the 512 MB/s limit you've set.

To stop the Erigon node you can use the CTRL+C command.

Additional flags can be added to configure the node with several options.

CLI Reference

Help

To learn about the available commands, open your terminal in your Erigon 3 installation directory and run:

make help

This command will display a list of convenience commands available in the Makefile, along with their descriptions.

 go-version:                        print and verify go version
 validate_docker_build_args:        ensure docker build args are valid
 docker:                            validate, update submodules and build with docker
 setup_xdg_data_home:               TODO
 docker-compose:                    validate build args, setup xdg data home, and run docker-compose up
 dbg                                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
 erigon:                            build erigon
 all:                               run erigon with all commands
 db-tools:                          build db tools
 test:                              run unit tests with a 100s timeout
 test-integration:                  run integration tests with a 30m timeout
 lint-deps:                         install lint dependencies
 lintci:                            run golangci-lint linters
 lint:                              run all linters
 clean:                             cleans the go cache, build dir, libmdbx db dir
 devtools:                          installs dev tools (and checks for npm installation etc.)
 mocks:                             generate test mocks
 mocks-clean:                       cleans all generated test mocks
 solc:                              generate all solidity contracts
 abigen:                            generate abis using abigen
 gencodec:                          generate marshalling code using gencodec
 graphql:                           generate graphql code
 gen:                               generate all auto-generated code in the codebase
 bindings:                          generate test contracts and core contracts
 prometheus:                        run prometheus and grafana with docker-compose
 escape:                            run escape path={path} to check for memory leaks e.g. run escape path=cmd/erigon
 git-submodules:                    update git submodules
 install:                           copies binaries and libraries to DIST
 user_linux:                        create "erigon" user (Linux)
 user_macos:                        create "erigon" user (MacOS)
 hive:                              run hive test suite locally using docker e.g. OUTPUT_DIR=~/results/hive SIM=ethereum/engine make hive
 automated-tests                    run automated tests (BUILD_ERIGON=0 to prevent erigon build with local image tag)
 help:                              print commands help

For example, from your Erigon 3 installation directory, run:

make clean

This will execute the clean target in the Makefile, which cleans the go cache, build directory, and libmdbx db directory.