-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
bloxster
committed
Oct 10, 2024
1 parent
fa72860
commit 9590f75
Showing
6 changed files
with
120 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # Basic Usage | ||
|
|
||
| # All-in-One Client | ||
|
|
||
| The all-in-one client is the preferred option for most users: | ||
|
|
||
| ```bash | ||
| ./build/bin/erigon | ||
| ``` | ||
|
|
||
| This CLI command allows you to run an Ethereum archive node where every process is integrated and no special configuration is needed. | ||
|
|
||
| The default Consensus Layer utilized is [Caplin](./advanced/caplin.md), the Erigon flagship embedded CL. | ||
|
|
||
| # Basic Configuration | ||
|
|
||
| * Default data directory is `/home/admin/.local/share/erigon`. If you want to store Erigon files in a non-default location, add flag: | ||
| ```bash | ||
| --datadir=<your_data_dir> | ||
| ``` | ||
|
|
||
| * Based on the [type of node](basic/node.md) you want to run you can add ```--prune.mode=full``` to run a full node or ```--prune.mode=minimal``` to run a minimal node. | ||
| The default node is archive node. | ||
|
|
||
| * ```--chain=mainnet```, add the flag --chain=goerli for Goerli testnet, --chain=sepolia for Sepolia testnet or --chain=holesky for Holesky testnet. | ||
|
|
||
| * --http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool to use RPC and e.g. be able to connect your [wallet](basic/wallet.md). | ||
|
|
||
| * To increase download speed add ```--torrent.download.rate=512mb``` (default is 16mb) | ||
|
|
||
| To stop the Erigon node you can use the ```CTRL+C``` command. | ||
|
|
||
| Additional flags can be added to configure the node with several [options](/advanced/options.md). | ||
|
|
||
|
|
||
| # Testnets | ||
|
|
||
| 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](basic/networks.md#testnets), Holesky, adding the option `--chain=holesky` and using the default Consensus Layer, Caplin. You can also had the flag `--prune.mode=minimal` to have a node that is syncing fast while taking not so much disk space: | ||
|
|
||
| ```bash | ||
| ./build/bin/erigon --chain=holesky --prune.mode=minimal | ||
| ``` | ||
|
|
||
| # Help | ||
|
|
||
| To learn about the available commands, open your terminal in your Erigon 3 installation directory and run: | ||
|
|
||
| ```bash | ||
| 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: | ||
|
|
||
| ```bash | ||
| make clean | ||
| ``` | ||
|
|
||
| This will execute the clean target in the Makefile, which cleans the ```go cache```, ```build``` directory, and ```libmdbx``` db directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,100 +1 @@ | ||
| # Usage | ||
|
|
||
| # All-in-One Client | ||
|
|
||
| The all-in-one client is the preferred option for most users: | ||
|
|
||
| ```bash | ||
| ./build/bin/erigon | ||
| ``` | ||
|
|
||
| This CLI command allows you to run an Ethereum archive node where every process is integrated and no special configuration is needed. | ||
|
|
||
| The default Consensus Layer utilized is [Caplin](.caplin.md), the Erigon flagship embedded CL. | ||
|
|
||
| # Basic Configuration | ||
|
|
||
| If you want to store Erigon files in a non-default location, add flag | ||
| ```bash | ||
| --datadir=<your_data_dir> | ||
| ``` | ||
|
|
||
| Default data directory is /home/admin/.local/share/erigon. | ||
|
|
||
| * Based on the [type of node](/node.md) you want to run you can add ```--prune.mode=full``` to run a full node or ```--prune.mode=minimal``` to run a minimal node. | ||
| The default node is archive node. | ||
|
|
||
| * ```--chain=mainnet```, add the flag --chain=goerli for Goerli testnet, --chain=sepolia for Sepolia testnet or --chain=holesky for Holesky testnet. | ||
|
|
||
| * --http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool to use RPC and e.g. be able to connect your [wallet](/wallet.md). | ||
|
|
||
| * To increase download speed add ```--torrent.download.rate=512mb``` (default is 16mb) | ||
|
|
||
| To stop the Erigon node you can use the ```CTRL+C``` command. | ||
|
|
||
| Additional flags can be added to configure the node with several [options](/advanced/options.md). | ||
|
|
||
|
|
||
| # Testnets | ||
|
|
||
| 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](/networks.md), Holesky, adding the option `--chain=holesky` and using the default Consensus Layer, Caplin. You can also had the flag `--prune.mode=minimal` to have a node that is syncing fast while taking not so much disk space: | ||
|
|
||
| ```bash | ||
| ./build/bin/erigon --chain=holesky --prune.mode=minimal | ||
| ``` | ||
|
|
||
| # Help | ||
|
|
||
| To learn about the available commands, open your terminal in your Erigon 3 installation directory and run: | ||
|
|
||
| ```bash | ||
| 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: | ||
|
|
||
| ```bash | ||
| make clean | ||
| ``` | ||
|
|
||
| This will execute the clean target in the Makefile, which cleans the ```go cache```, ```build``` directory, and ```libmdbx``` db directory. | ||
| # Basic Usage |