Go-Ethereum (Geth)

https://geth.ethereum.org/docs
Admin
Go-Ethereum is an Ethereum client built in Go that enables users to download, install, and interact...
Tokens:247,196
Snippets:1,638
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install devp2p and ethkey utilities

Source: https://geth.ethereum.org/docs/developers/geth-developer/dns-discovery-setup

Install the devp2p developer tool and the ethkey utility using go get. These commands are not included in the Geth distribution and must be installed separately.

```bash
go get github.com/ethereum/go-ethereum/cmd/devp2p

```

```bash
go get github.com/ethereum/go-ethereum/cmd/ethkey

```

--------------------------------

### Build Geth on Windows from source

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Creates a Go workspace directory, clones the go-ethereum repository, and builds Geth using 'go get' and 'go install'. Run after installing the build tools and opening a new command prompt.

```powershell
C:\Users\xxx> mkdir src\github.com\ethereum
C:\Users\xxx> git clone https://github.com/ethereum/go-ethereum src\github.com\ethereum\go-ethereum
C:\Users\xxx> cd src\github.com\ethereum\go-ethereum
C:\Users\xxx\src\github.com\ethereum\go-ethereum> go get -u -v golang.org/x/net/context
C:\Users\xxx\src\github.com\ethereum\go-ethereum> go install -v ./cmd/...

```

--------------------------------

### Install stable Geth via apt

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Install the stable version of go-ethereum on Ubuntu using the launchpad PPA. This installs Geth and developer tools (clef, devp2p, abigen, bootnode, evm, rlpdump) to /usr/local/bin/.

```bash
sudo apt-get update
sudo apt-get install ethereum
```

--------------------------------

### Install development Geth via apt

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Install the development (unstable) version of go-ethereum on Ubuntu using the launchpad PPA.

```bash
sudo apt-get update
sudo apt-get install ethereum-unstable
```

--------------------------------

### Install abigen with go install

Source: https://geth.ethereum.org/docs/developers/dapp-developer/native-bindings-v2

Installs the abigen tool from the go-ethereum repository. Requires a valid Go development environment and the go-ethereum repository checked out correctly.

```bash
go install github.com/ethereum/go-ethereum/cmd/abigen@latest

```

--------------------------------

### Geth startup logs on Sepolia testnet

Source: https://geth.ethereum.org/docs/getting-started

Example of the log output that appears when Geth starts on the Sepolia testnet. It shows the node configuration, peer count, and the HTTP server endpoint at 127.0.0.1:8545.

```text
INFO [02-10|13:59:06.649] Starting Geth on sepolia testnet... INFO [02-10|13:59:06.652] Maximum peer count                       ETH=50 LES=0 total=50 INFO [02-10|13:59:06.655] Using external signer                    url=geth-tutorial/clef/clef.ipc INFO [02-10|13:59:06.660] Set global gas cap                       cap=50,000,000 INFO [02-10|13:59:06.661] Allocated cache and file handles         database=/.../geth-tutorial/geth/chaindata cache=64.00MiB handles=5120 INFO [02-10|13:59:06.855] Persisted trie from memory database      nodes=361 size=51.17KiB time="643.54µs" gcnodes=0 gcsize=0.00B gctime=0s livenodes=1 livesize=0.00B INFO [02-10|13:59:06.855] Initialised chain configuration          config="{ChainID: 11155111 Homestead: 0 DAO: nil DAOSupport: true EIP150: 0 EIP155: 0 EIP158: 0 Byzantium: 0 Constantinople: 0 Petersburg: 0 Istanbul: 1561651, Muir Glacier: nil, Berlin: 4460644, London: 5062605, Arrow Glacier: nil, MergeFork: nil, Engine: clique}" INFO [02-10|13:59:06.862] Added trusted checkpoint                 block=5,799,935 hash=2de018..c32427 INFO [02-10|13:59:06.863] Loaded most recent local header          number=6,340,934 hash=483cf5..858315 td=9,321,576 age=2d9h29m INFO [02-10|13:59:06.867] Configured checkpoint oracle             address=0x18CA0E045F0D772a851BC7e48357Bcaab0a0795D signers=5 threshold=2 INFO [02-10|13:59:06.867] Gasprice oracle is ignoring threshold set threshold=2 WARN [02-10|13:59:06.869] Unclean shutdown detected                booted=2022-02-08T04:25:08+0100 age=2d9h33m INFO [02-10|13:59:06.870] Starting peer-to-peer node               instance=Geth/v1.10.15-stable/darwin-amd64/go1.17.5 INFO [02-10|13:59:06.995] New local node record                    seq=1,644,272,735,880 id=d4ffcd252d322a89 ip=127.0.0.1 udp=30303 tcp=30303 INFO [02-10|13:59:06.996] Started P2P networking                   self=enode://4b80ebd341b5308f7a6b61d91aa0ea31bd5fc9e0a6a5483e59fd4ea84e0646b13ecd289e31e00821ccedece0bf4b9189c474371af7393093138f546ac23ef93e@127.0.0.1:30303 INFO [02-10|13:59:06.997] IPC endpoint opened                      url=/.../geth-tutorial/geth.ipc INFO [02-10|13:59:06.998] HTTP server started                      endpoint=127.0.0.1:8545 prefix= cors= vhosts=localhost
```

--------------------------------

### Install Geth on FreeBSD using ports

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Installs Geth from the FreeBSD ports tree by navigating to the net-p2p/go-ethereum directory and running make install as root.

```bash
cd /usr/ports/net-p2p/go-ethereum
make install
```

--------------------------------

### Start Geth node on FreeBSD

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Starts the Geth node using the built executable.

```bash
build/bin/geth

```

--------------------------------

### admin_startHTTP: Go, Console, RPC, and example

Source: https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-admin

Starts an HTTP-based JSON-RPC API webserver. All parameters are optional: host defaults to "localhost", port to 8545, cors to "", and apis to "eth,net,web3". Returns a boolean indicating whether the listener was opened; only one HTTP endpoint can be active at a time.

```go
admin.StartHTTP(host *string, port *rpc.HexNumber, cors *string, apis *string) (bool, error)
```

```console
admin.startHTTP(host, port, cors, apis)
```

```json
{"method": "admin_startHTTP", "params": [host, port, cors, apis]}
```

```console
> admin.startHTTP("127.0.0.1", 8545)
true

```

--------------------------------

### Install Geth on Gentoo using Portage

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Installs Geth from the Gentoo repository using emerge.

```bash
emerge --ask net-p2p/go-ethereum
```

--------------------------------

### Install Geth on Arch Linux using pacman

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Installs Geth from the Arch Linux community repository using pacman.

```bash
pacman -S geth
```

--------------------------------

### Install Go compiler on FreeBSD

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Installs the Go compiler using the FreeBSD package manager.

```bash
pkg install go

```

--------------------------------

### Install InfluxDB on Debian-based Linux

Source: https://geth.ethereum.org/docs/monitoring/dashboards

Downloads and installs InfluxDB on a Debian-based Linux system using the InfluxData repository. Enables and starts the InfluxDB service and installs the influxdb-client package.

```bash
curl -tlsv1.3 --proto =https -sL https://repos.influxdata.com/influxdb.key | sudo apt-key add
source /etc/lsb-release
echo "deb https://repos.influxdata.com/${DISTRIB_ID,,} ${DISTRIB_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/influxdb.list
sudo apt update
sudo apt install influxdb -y
sudo systemctl enable influxdb
sudo systemctl start influxdb
sudo apt install influxdb-client
```

--------------------------------

### Install and run Grafana on Debian-based Linux

Source: https://geth.ethereum.org/docs/monitoring/dashboards

Downloads, installs, and starts Grafana on a Debian-based Linux system. After running these commands, Grafana should be reachable at localhost:3000, and the default login credentials are user: admin and password: admin.

```bash
curl -tlsv1.3 --proto =https -sL https://packages.grafana.com/gpg.key | sudo apt-key add -
echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
sudo apt update
sudo apt install grafana
sudo systemctl enable grafana-server
sudo systemctl start grafana-server
```

--------------------------------

### Retrieve checkpoint automatically and start Geth

Source: https://geth.ethereum.org/docs/fundamentals/blsync

Retrieves the finalized checkpoint automatically from the trusted light sync provider and starts Geth with the integrated blsync in one command. Requires jq to be installed and replaces <endpoint> with the chosen provider.

```bash
BEACON=<endpoint> geth --beacon.api=$BEACON --beacon.checkpoint=$(curl -s $BEACON/eth/v1/beacon/headers/finalized | jq -r ".data.root") 
```

--------------------------------

### Build all go-ethereum executables

Source: https://geth.ethereum.org/docs/developers/geth-developer/dev-guide

Run from the go-ethereum repository root. Installs all executables, placing binaries in $GOPATH/bin.

```bash
go install -v ./...

```

--------------------------------

### Download go-ethereum packages with go get

Source: https://geth.ethereum.org/docs/developers/dapp-developer/native

Downloads all Go packages in the go-ethereum repository. The -d flag prevents installation of the packages, only fetching them.

```bash
$ go get -d github.com/ethereum/go-ethereum/...

```

--------------------------------

### Show Geth command-line help

Source: https://geth.ethereum.org/docs/fundamentals/command-line-options

Displays the full command-line help listing for Geth, including commands, global options, and environment variable references. Run this to see the same information reproduced in the documentation.

```bash
geth --help

```

--------------------------------

### StaticNodes field in config.toml

Source: https://geth.ethereum.org/docs/fundamentals/peer-to-peer

Example line in config.toml that defines static nodes. Ensure other lines in the file are set correctly before starting Geth with --config config.toml.

```toml
StaticNodes = ["enode://f4642fa65af50cfdea8fa7414a5def7bb7991478b768e296f5e4a54e8b995de102e0ceae2e826f293c481b5325f89be6d207b003382e18a8ecba66fbaf6416c0@33.4.2.1:30303"]

```

--------------------------------

### Geth 1.15.11 help output (commands and global options)

Source: https://geth.ethereum.org/docs/fundamentals/command-line-options

Reproduces the Geth 1.15.11 command-line help output, listing subcommands and global options. It shows the account-related flags (keystore, lightkdf, password, pcscdpath, signer, usb) and marks the ALIASED section as deprecated.

```text
NAME:
   geth - the go-ethereum command line interface

USAGE:
   geth [global options] command [command options]

VERSION:
   1.15.11-stable-36b2371c

COMMANDS:
   account                Manage accounts
   attach                 Start an interactive JavaScript environment (connect to node)
   console                Start an interactive JavaScript environment
   db                     Low level database operations
   dump                   Dump a specific block from storage
   dumpconfig             Export configuration values in a TOML format
   dumpgenesis            Dumps genesis block JSON configuration to stdout
   export                 Export blockchain into file
   export-history         Export blockchain history to Era archives
   import                 Import a blockchain file
   import-history         Import an Era archive
   import-preimages       Import the preimage database from an RLP stream
   init                   Bootstrap and initialize a new genesis block
   js                     (DEPRECATED) Execute the specified JavaScript files
   license                Display license information
   prune-history          Prune blockchain history (block bodies and receipts) up to the merge block
   removedb               Remove blockchain and state databases
   show-deprecated-flags  Show flags that have been deprecated
   snapshot               A set of commands based on the snapshot
   verkle                 A set of experimental verkle tree management commands
   version                Print version numbers
   version-check          Checks (online) for known Geth security vulnerabilities
   wallet                 Manage Ethereum presale wallets
   help, h                Shows a list of commands or help for one command

GLOBAL OPTIONS:
   ACCOUNT

   
    --keystore value                                                       ($GETH_KEYSTORE)
          Directory for the keystore (default = inside the datadir)
   
    --lightkdf                          (default: false)                   ($GETH_LIGHTKDF)
          Reduce key-derivation RAM & CPU usage at some expense of KDF strength
   
    --password value                                                       ($GETH_PASSWORD)
          Password file to use for non-interactive password input
   
    --pcscdpath value                   (default: "/run/pcscd/pcscd.comm") ($GETH_PCSCDPATH)
          Path to the smartcard daemon (pcscd) socket file
   
    --signer value                                                         ($GETH_SIGNER)
          External signer (url or path to ipc file)
   
    --usb                               (default: false)                   ($GETH_USB)
          Enable monitoring and management of USB hardware wallets

   ALIASED (deprecated)

```

--------------------------------

### prestateTracer with diffMode config

Source: https://geth.ethereum.org/docs/developers/evm-tracing/custom-tracer

Example of using the prestateTracer with the diffMode option set to true via tracerConfig. The config is passed to the setup method and defaults to "{}" if not provided.

```javascript
debug.traceTransaction('<txhash>, { tracer: 'prestateTracer': tracerConfig: { diffMode: true } })
```

--------------------------------

### Geth startup logs on mainnet

Source: https://geth.ethereum.org/docs/fundamentals/logs

Example of typical startup log messages when Geth connects to Ethereum mainnet. Includes cache bumping, peer count, and genesis block initialization.

```text
INFO [10-04|10:20:52.028] Starting Geth on Ethereum mainnet... INFO [10-04|10:20:52.028] Bumping default cache on mainnet         provided=1024 updated=4096 INFO [10-04|10:20:52.030] Maximum peer count                       ETH=50 LES=0 total=50 INFO [10-04|10:20:52.031] Smartcard socket not found, disabling    err="stat /run/pcscd/pcscd.comm: no such file or directory" INFO [10-04|10:20:52.034] Set global gas cap                       cap=50,000,000 INFO [10-04|10:20:52.035] Allocated trie memory caches             clean=614.00MiB dirty=1024.00MiB INFO [10-04|10:20:52.035] Allocated cache and file handles         database=/home/go-ethereum/devnet/geth/chaindata cache=2.00GiB handles=524,288 INFO [10-04|10:20:52.128] Opened ancient database                  database=/home/go-ethereum/devnet/geth/chaindata/ancient/chain readonly=false INFO [10-04|10:20:52.129] Disk storage enabled for ethash caches   dir=/home/go-ethereum/devnet/geth/ethash count=3 INFO [10-04|10:20:52.129] Disk storage enabled for ethash DAGs     dir=/home/.ethash                        count=2 INFO [10-04|10:20:52.129] Initialising Ethereum protocol           network=1 dbversion=<nil> INFO [10-04|10:20:52.129] Writing default main-net genesis block INFO [10-04|10:20:52.372] Persisted trie from memory database      nodes=12356 size=1.78MiB time=21.535537ms gcnodes=0 gcsize=0.00B gctime=0s livenodes=1 livesize=0.00B
```

--------------------------------

### callTracer with onlyTopCall config

Source: https://geth.ethereum.org/docs/developers/evm-tracing/custom-tracer

Example of using the callTracer with the onlyTopCall option set to true via tracerConfig. The config is passed to the setup method and defaults to "{}" if not provided.

```javascript
debug.traceTransaction('<txhash>, { tracer: 'callTracer', tracerConfig: { onlyTopCall: true } })
```

--------------------------------

### les.serverInfo - Get server connection capacity info

Source: https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-les

Retrieves information about currently connected and total/individual allowed connection capacity. The example shows the console output with fields like freeClientCapacity, maximumCapacity, minimumCapacity, priorityConnectedCapacity, totalCapacity, and totalConnectedCapacity.

```console
> les.serverInfo
{
  freeClientCapacity: 16000,
  maximumCapacity: 1600000,
  minimumCapacity: 16000,
  priorityConnectedCapacity: 180000,
  totalCapacity: 1600000,
  totalConnectedCapacity: 180000
}
```

--------------------------------

### Run Geth with --config

Source: https://geth.ethereum.org/docs/fundamentals/config-files

Starts Geth with the configuration defined in geth-config.toml. The network_id is not persisted from the config file, so it must be explicitly defined on the command line at startup.

```bash
geth --sepolia --config geth-config.toml

```

--------------------------------

### Start bootstrap node with --nat flag

Source: https://geth.ethereum.org/docs/fundamentals/private-network

Configure the bootstrap node by setting its public IP address using the --nat flag. Replace the example address with the correct one. Ensure UDP and TCP traffic is allowed on port 30303.

```bash
geth --datadir data --networkid 15 --nat extip:172.16.254.4

```

--------------------------------

### Account creation output

Source: https://geth.ethereum.org/docs/fundamentals/private-network

Example output from the account creation command, showing the password prompts, public address, and keyfile path.

```text
Your new account is locked with a password. Please give a password. Do not forget this password. Password: Repeat password:  Your new key was generated  Public address of the key: 0xC1B2c0dFD381e6aC08f34816172d6343Decbb12b Path of the secret key file: node1/keystore/UTC--2022-05-13T14-25-49.229126160Z--c1b2c0dfd381e6ac08f34816172d6343decbb12b  - You can share your public address with anyone. Others need it to interact with you. - You must NEVER share the secret key with anyone! The key controls access to your funds! - You must BACKUP your key file! Without the key, it's impossible to access account funds! - You must remember your password! Without the password, it's impossible to decrypt the key! 
```

--------------------------------

### les.clientInfo - Get individual client information

Source: https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-les

Retrieves individual client information (connection, balance, pricing) for the specified list of clients or all connected clients if the ID list is empty. The example shows the console output with detailed per-client data including capacity, connectionTime, isConnected, pricing/balance, pricing/balanceMeta, pricing/negBalance, and priority.

```console
> les.clientInfo([])
{
  37078bf8ea160a2b3d129bb4f3a930ce002356f83b820f467a07c1fe291531ea: {
    capacity: 16000,
    connectionTime: 11225.335901136,
    isConnected: true,
    pricing/balance: 998266395881,
    pricing/balanceMeta: "",
    pricing/negBalance: 501657912857,
    priority: true
  },
  6a47fe7bb23fd335df52ef1690f37ab44265a537b1d18eb616a3e77f898d9e77: {
    capacity: 100000,
    connectionTime: 9874.839293082,
    isConnected: true,
    pricing/balance: 2908840710198,
    pricing/balanceMeta: "qwerty",
    pricing/negBalance: 206242704507,
    priority: true
  },
  740c78f7d914e5c763731bc751b513fc2388ffa0b47db080ded3e8b305e68c75: {
    capacity: 16000,
    connectionTime: 3089.286712188,
    isConnected: true,
    pricing/balance: 998266400174,
    pricing/balanceMeta: "",
    pricing/negBalance: 55135348863,
    priority: true
  },
  9985ade55b515f79f64274bf2ae440ca8c433cfb0f283fb6010bf46f796b2a3b: {
    capacity: 16000,
    connectionTime: 11479.335479545,
    isConnected: true,
    pricing/balance: 998266452203,
    pricing/balanceMeta: "",
    pricing/negBalance: 564116425655,
    priority: true
  },
  ce65c2ada3c17d6da00cec0b3cc4c8ed5e74428b60f42b287eaaec8cca62544: {
    capacity: 16000,
    connectionTime: 7095.794385419,
    isConnected: true,
    pricing/balance: 998266448492,
    pricing/balanceMeta: "",
    pricing/negBalance: 214617753229,
    priority: true
  },
  e1495ceb6db842f3ee66428d4bb7f4a124b2b17111dae35d141c3d568b869ef1: {
    capacity: 16000,
    connectionTime: 8614.018237937,
    isConnected: true,
    pricing/balance: 998266391796,
    pricing/balanceMeta: "",
    pricing/negBalance: 185964891797,
    priority: true
  }
}
```

--------------------------------

### Check Homebrew installation

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Check that Homebrew is installed before using the Geth Homebrew tap. A version number should be returned if Homebrew is installed.

```bash
brew -v
```

--------------------------------

### Install Geth via Homebrew

Source: https://geth.ethereum.org/docs/getting-started/installing-geth

Add the Geth Homebrew tap and install the latest stable release of Geth along with developer tools (clef, devp2p, abigen, bootnode, evm, rlpdump). Binaries are saved to /usr/local/bin/.

```bash
brew tap ethereum/ethereum
brew install ethereum
```

--------------------------------

### Build and initialize Clef with make all, make clef, and clef init

Source: https://geth.ethereum.org/docs/tools

Build Clef with Geth using 'make all', build it standalone with 'make clef', then initialize it with 'clef init'. Initialization encrypts sensitive data (passwords, account data, signing rules) with a user-defined password and generates a master seed file.

```bash
make all
```

```bash
make clef
```

```bash
clef init
```

--------------------------------

### Start Geth dev mode with --password for existing accounts

Source: https://geth.ethereum.org/docs/developers/dapp-developer

Start Geth dev mode with a persistent data directory and an account password file. Geth fails to start in dev mode if keys exist in the keystore unless the --password flag provides the password used when the account was created.

```bash
geth --datadir dev-chain --dev --http --http.api web3,eth,net --http.corsdomain "https://remix.ethereum.org" --password password.txt

```

--------------------------------

### Start member node with --bootnodes

Source: https://geth.ethereum.org/docs/fundamentals/private-network

Start a member node on the same machine as the bootnode, using a separate data directory and listening port, and provide the bootstrap node record. The member node must be initialized with the same genesis file.

```bash
geth --datadir data2 --networkid 12345 --port 30305 --bootnodes <bootstrap-node-record>

```

--------------------------------

### prestateTracer example in prestate mode

Source: https://geth.ethereum.org/docs/developers/evm-tracing/built-in-tracers

Example of using the prestateTracer in prestate mode via debug.traceCall. The tracer is configured with the tracer option set to 'prestateTracer'. This example shows the call parameters including from, to, and data fields.

```javascript
debug.traceCall(
  {
    from: '0x35a9f94af726f07b5162df7e828cc9dc8439e7d0',
    to: '0xc8ba32cab1757528daf49033e3673fae77dcf05d',
    data: '0xd1a2eab2000000000000000000000000000000000000000000000000000000000024aea100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000050000000204895cd480cc8412691a880028a25aec86786f1ed2aa5562bc400000000000000c6403c14f35be1da6f433eadbb6e9178a47fbc7c6c1d568d2f2b876e929089c8d8db646304fd001a187dc8a600000000000000000000000000000000'
  },
  'latest',
  { tracer: 'prestateTracer' }
);
```

--------------------------------

### Shell script to start Geth with Sepolia flags

Source: https://geth.ethereum.org/docs/fundamentals/config-files

Save this content as start-geth.sh. It starts Geth on Sepolia with a custom datadir, HTTP API, metrics, and JWT secret. Make it executable with chmod +x start-geth.sh.

```bash
#!/bin/bash
./geth --sepolia --datadir sepoliadata --authrpc.addr localhost --authrpc.port 8551, 8545 --authrpc.vhosts localhost --authrpc.jwtsecret sepoliadata/jwtsecret --http --http.api eth,net --metrics --metric.addr 127.0.0.1 --metrics.port 6060

```

--------------------------------

### Start Clef with keystore, configdir, and chainid 11155111

Source: https://geth.ethereum.org/docs/getting-started

Starts Clef with the keystore and config directories from the geth-tutorial folder, using chain ID 11155111 (Sepolia testnet). The chain ID must be correct because Clef uses it to sign messages. After running, Clef asks the user to type "ok" and then prints signer information to the terminal.

```bash
clef --keystore geth-tutorial/keystore --configdir geth-tutorial/clef --chainid 11155111
```

--------------------------------

### 4byteTracer example output

Source: https://geth.ethereum.org/docs/developers/evm-tracing/built-in-tracers

Example output of the 4byteTracer, showing the map of SELECTOR-CALLDATASIZE keys to occurrence counts.

```json
{   "0x27dc297e-128": 1,   "0x38cc4831-0": 2,   "0x524f3889-96": 1,   "0xadf59f99-288": 1,   "0xc281d19e-0": 1 }
```
Tokens:
Raw