Repository files navigation

Golang execution layer implementation of the Ethereum protocol.

Automated builds are available for stable releases and the unstable master branch. Binaryarchives are published athttps://geth.ethereum.org/downloads/.

For prerequisites and detailed build instructions please read theInstallation Instructions.

Buildinggeth requires both a Go (version 1.23 or later) and a C compiler. You can installthem using your favourite package manager. Once the dependencies are installed, run

make geth

or, to build the full suite of utilities:

make all

The go-ethereum project comes with several wrappers/executables found in thecmddirectory.

Going through all the possible command line flags is out of scope here (please consult ourCLI Wiki page),but we've enumerated a few common parameter combos to get you up to speed quicklyon how you can run your owngeth instance.

Minimum:

• CPU with 4+ cores
• 8GB RAM
• 1TB free storage space to sync the Mainnet
• 8 MBit/sec download Internet service

Recommended:

• Fast CPU with 8+ cores
• 16GB+ RAM
• High-performance SSD with at least 1TB of free space
• 25+ MBit/sec download Internet service

By far the most common scenario is people wanting to simply interact with the Ethereumnetwork: create accounts; transfer funds; deploy and interact with contracts. For thisparticular use case, the user doesn't care about years-old historical data, so we cansync quickly to the current state of the network. To do so:

$ geth console

This command will:

• Startgeth in snap sync mode (default, can be changed with the--syncmode flag),causing it to download more data in exchange for avoiding processing the entire historyof the Ethereum network, which is very CPU intensive.
• Start the built-in interactiveJavaScript console,(via the trailingconsole subcommand) through which you can interact usingweb3 methods(note: theweb3 version bundled withingeth is very old, and not up to date with official docs),as well asgeth's ownmanagement APIs.This tool is optional and if you leave it out you can always attach it to an already runninggeth instance withgeth attach.

Transitioning towards developers, if you'd like to play around with creating Ethereumcontracts, you almost certainly would like to do that without any real money involved untilyou get the hang of the entire system. In other words, instead of attaching to the mainnetwork, you want to join thetest network with your node, which is fully equivalent tothe main network, but with play-Ether only.

$ geth --holesky console

Theconsole subcommand has the same meaning as above and is equallyuseful on the testnet too.

Specifying the--holesky flag, however, will reconfigure yourgeth instance a bit:

• Instead of connecting to the main Ethereum network, the client will connect to the Holeskytest network, which uses different P2P bootnodes, different network IDs and genesisstates.
• Instead of using the default data directory (~/.ethereum on Linux for example),gethwill nest itself one level deeper into aholesky subfolder (~/.ethereum/holesky onLinux). Note, on OSX and Linux this also means that attaching to a running testnet noderequires the use of a custom endpoint sincegeth attach will try to attach to aproduction node endpoint by default, e.g.,geth attach <datadir>/holesky/geth.ipc. Windows users are not affected bythis.

Note: Although some internal protective measures prevent transactions fromcrossing over between the main network and test network, you should alwaysuse separate accounts for play and real money. Unless you manually moveaccounts,geth will by default correctly separate the two networks and will not make anyaccounts available between them.

As an alternative to passing the numerous flags to thegeth binary, you can also pass aconfiguration file via:

$ geth --config /path/to/your_config.toml

To get an idea of how the file should look like you can use thedumpconfig subcommand toexport your existing configuration:

$ geth --your-favourite-flags dumpconfig

One of the quickest ways to get Ethereum up and running on your machine is by usingDocker:

docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \           -p 8545:8545 -p 30303:30303 \           ethereum/client-go

This will startgeth in snap-sync mode with a DB memory allowance of 1GB, as theabove command does. It will also create a persistent volume in your home directory forsaving your blockchain as well as map the default ports. There is also analpine tagavailable for a slim version of the image.

Do not forget--http.addr 0.0.0.0, if you want to access RPC from other containersand/or hosts. By default,geth binds to the local interface and RPC endpoints are notaccessible from the outside.

As a developer, sooner rather than later you'll want to start interacting withgeth and theEthereum network via your own programs and not manually through the console. To aidthis,geth has built-in support for a JSON-RPC based APIs (standard APIsandgeth specific APIs).These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX basedplatforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported bygeth,whereas the HTTP and WS interfaces need to manually be enabled and only expose asubset of APIs due to security reasons. These can be turned on/off and configured asyou'd expect.

HTTP based JSON-RPC API options:

• --http Enable the HTTP-RPC server
• --http.addr HTTP-RPC server listening interface (default:localhost)
• --http.port HTTP-RPC server listening port (default:8545)
• --http.api API's offered over the HTTP-RPC interface (default:eth,net,web3)
• --http.corsdomain Comma separated list of domains from which to accept cross-origin requests (browser enforced)
• --ws Enable the WS-RPC server
• --ws.addr WS-RPC server listening interface (default:localhost)
• --ws.port WS-RPC server listening port (default:8546)
• --ws.api API's offered over the WS-RPC interface (default:eth,net,web3)
• --ws.origins Origins from which to accept WebSocket requests
• --ipcdisable Disable the IPC-RPC server
• --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) toconnect via HTTP, WS or IPC to ageth node configured with the above flags and you'llneed to speakJSON-RPC on all transports. Youcan reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS basedtransport before doing so! Hackers on the internet are actively trying to subvertEthereum nodes with exposed APIs! Further, all browser tabs can access locallyrunning web servers, so malicious web pages could try to subvert locally availableAPIs!

Maintaining your own private network is more involved as a lot of configurations taken forgranted in the official networks need to be manually set up.

Unfortunately sincethe Merge it is no longer possibleto easily set up a network of geth nodes without also setting up a corresponding beacon chain.

There are three different solutions depending on your use case:

• If you are looking for a simple way to test smart contracts from go in your CI, you can use theSimulated Backend.
• If you want a convenient single node environment for testing, you can use ourDev Mode.
• If you are looking for a multiple node test network, you can set one up quite easily withKurtosis.

Thank you for considering helping out with the source code! We welcome contributionsfrom anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull requestfor the maintainers to review and merge into the main code base. If you wish to submitmore complex changes though, please check up with the core devs first onour Discord Serverto ensure those changes are in line with the general philosophy of the project and/or getsome early feedback which can make both your efforts much lighter as well as our reviewand merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

• Code must adhere to the official Goformattingguidelines (i.e. usesgofmt).
• Code must be documented adhering to the official Gocommentaryguidelines.
• Pull requests need to be based on and opened against themaster branch.
• Commit messages should be prefixed with the package(s) they modify.
  • E.g. "eth, rpc: make trace configs optional"

Please see theDevelopers' Guidefor more details on configuring your environment, managing project dependencies, andtesting procedures.

For contributions to thego-ethereum website, please checkout and raise pull requests against thewebsite branch.For more detailed instructions please see thewebsite branchREADME or thecontributing page of the website.

The go-ethereum library (i.e. all code outside of thecmd directory) is licensed under theGNU Lesser General Public License v3.0,also included in our repository in theCOPYING.LESSER file.

The go-ethereum binaries (i.e. all code inside of thecmd directory) are licensed under theGNU General Public License v3.0, alsoincluded in our repository in theCOPYING file.