A distribution of go-ethereum supporting multiple blockchains.
Clone or download
#15 Compare This branch is 89 commits ahead, 211 commits behind ethereum:master.
Latest commit f0efabf Oct 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github swarm/storage/feed: Renamed package Oct 3, 2018
accounts accounts/abi/bind: stop using goimports in the binding generator (eth… Oct 5, 2018
build Merge tag 'v1.8.17' of https://github.com/ethereum/go-ethereum Oct 19, 2018
cmd flags and chain config Oct 23, 2018
common common, core, light: add block age into info logs Sep 20, 2018
consensus flags and chain config Oct 23, 2018
console all: remove the duplicate 'the' in annotations (ethereum#17509) Aug 27, 2018
containers/docker containers: drop vagrant support, noone's maintaining it Mar 14, 2018
contracts contracts/ens: expose Add and SetAddr in ENS (ethereum#17661) Sep 28, 2018
core flags and chain config Oct 23, 2018
crypto core/vm: faster create/create2 (ethereum#17806) Oct 4, 2018
dashboard dashboard: append to proper slice (ethereum#17266) Jul 30, 2018
eth eth/downloader: fix invalid hash chain error due to head mini reorg Oct 5, 2018
ethclient ethclient: fix RPC parse error of Parity response (ethereum#16924) Jun 11, 2018
ethdb consensus, ethdb, metrics: implement forced-meter (ethereum#17667) Sep 17, 2018
ethstats ethstats: comment minor correction (ethereum#17102) Jun 29, 2018
event event: document select case slice use and add edge case test (ethereu… May 10, 2018
internal core/vm: faster create/create2 (ethereum#17806) Oct 4, 2018
les les, light: reduce les testing stress (ethereum#17867) Oct 8, 2018
light les, light: reduce les testing stress (ethereum#17867) Oct 8, 2018
log internal/debug: support color terminal for cygwin/msys2 (ethereum#17740) Sep 29, 2018
metrics consensus, ethdb, metrics: implement forced-meter (ethereum#17667) Sep 17, 2018
miner miner: remove intermediate conversion to int in tests (ethereum#17853) Oct 8, 2018
mobile flags and chain config Oct 23, 2018
node all: new p2p node representation (ethereum#17643) Sep 24, 2018
p2p Fix retrieval tests and simulation backends (ethereum#17723) Oct 8, 2018
params flags and chain config Oct 23, 2018
rlp rlp: fix comment typo (ethereum#17640) Sep 11, 2018
rpc cmd/clef, signer: security fixes (ethereum#17554) Sep 25, 2018
signer Clef: USB hw wallet support (ethereum#17756) Sep 28, 2018
swarm params, swarm: release Geth v1.8.17 and Swar v0.3.5 Oct 9, 2018
tests tests: use non-constantinople ropsten for difficulty tests (ethereum#… Oct 5, 2018
trie trie: remove unused originalRoot field (ethereum#17862) Oct 8, 2018
vendor accounts/abi/bind: stop using goimports in the binding generator (eth… Oct 5, 2018
whisper all: new p2p node representation (ethereum#17643) Sep 24, 2018
.dockerignore dockerignore, internal/build: forward correct git folder Nov 12, 2017
.gitattributes .gitattributes: enable solidity highlighting on github (ethereum#16425) Apr 3, 2018
.gitignore cmd, dashboard: use webpack dev server, remove custom assets (ethereu… Mar 8, 2018
.gitmodules tests: update tests and implement general state tests (ethereum#14734) Jul 11, 2017
.mailmap all: update license information (ethereum#16089) Feb 14, 2018
.travis.yml Merge tag 'v1.8.17' of https://github.com/ethereum/go-ethereum Oct 19, 2018
AUTHORS all: switch out defunct set library to different one (ethereum#16873) Jul 16, 2018
COPYING all: update license information Jul 7, 2015
COPYING.LESSER all: update license information Jul 7, 2015
Dockerfile travis, Dockerfile, appveyor, build: bump to Go 1.11 Sep 19, 2018
Dockerfile.alltools travis, Dockerfile, appveyor, build: bump to Go 1.11 Sep 19, 2018
Makefile cmd/swarm, swarm: cross-platform Content-Type detection (ethereum#17782) Oct 1, 2018
README.md flags and chain config Oct 23, 2018
appveyor.yml Merge tag 'v1.8.17' of https://github.com/ethereum/go-ethereum Oct 19, 2018
circle.yml circleci: enable docker based hive testing Jul 15, 2016
interfaces.go eth/filters, ethereum: EIP-234 add blockHash param for eth_getLogs Jul 12, 2018

README.md

Go Ethereum

A distribution of go-ethereum with support of multiple Ethereum-like networks.

API Reference Go Report Card Travis Join the chat at https://gitter.im/ethoxy/multi-geth

Binary archives are published at https://github.com/ethoxy/multi-geth/releases.

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions on the wiki.

Building geth requires both a Go (version 1.10 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make geth

or, to build the full suite of utilities:

make all

Ellaism network

This is originally an Ellaism Project. However, A recent hard fork makes Ellaism not feasible to support go-ethereum any more. Existing Ellaism users are asked to switch to Parity.

Executables

The go-ethereum project comes with several wrappers/executables found in the cmd directory.

Command Description
geth Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. geth --help and the CLI Wiki page for command line options.
abigen Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Ethereum contract ABIs with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see our Native DApps wiki page for details.
bootnode Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.
evm Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. evm --code 60ff60ff --debug).
gethrpctest Developer utility tool to support our ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the test suite's readme for details.
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).
swarm Swarm daemon and tools. This is the entrypoint for the Swarm network. swarm --help for command line options and subcommands. See Swarm README for more information.
puppeth a CLI wizard that aids in creating a new Ethereum network.

Running geth

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

Full node on the main Ethereum network

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

$ geth console

This command will:

  • Start geth in fast sync mode (default, can be changed with the --syncmode flag), causing it to download more data in exchange for avoiding processing the entire history of the Ethereum network, which is very CPU intensive.
  • Start up Geth's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Geth's own management APIs. This tool is optional and if you leave it out you can always attach to an already running Geth instance with geth attach.

Full node on the main Ellaism network

To get on Ellaism network and take advantage of fast-sync:

$ geth --ellaism console

This command will:

  • Start geth in fast sync mode and start up geth's built-in interactive JavaScript console, connecting to Ellaism network.
  • Default data directory will be ~/.ethereum/ellaism.

Full node on the main Ethereum Classic network

To get on Ethereum Classic network and take advantage of fast-sync:

$ geth --classic console

This command will:

  • Start geth in fast sync mode and start up geth's built-in interactive JavaScript console, connecting to Ethereum Classic network.
  • Default data directory will be ~/.ethereum/classic.

All networks

For a full list of networks supported by multi-geth, take a look at the command-line help messages:

--testnet                            Ropsten network: pre-configured proof-of-work test network
--ellaism                            Ellaism network: pre-configured Ellaism mainnet
--classic                            Ethereum Classic network: pre-configured Ethereum Classic mainnet
--social                             Ethereum Social network: pre-configured Ethereum Social mainnet
--mix                                MIX network: pre-configured MIX mainnet
--ethersocial                        Ethersocial network: pre-configured Ethersocial mainnet
--rinkeby                            Rinkeby network: pre-configured proof-of-authority test network

Configuration

As an alternative to passing the numerous flags to the geth binary, you can also pass a configuration file via:

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

To get an idea how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ geth --your-favourite-flags dumpconfig

Note: This works only with geth v1.6.0 and above.

Docker quick start

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

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

This will start geth in fast-sync mode with a DB memory allowance of 1GB just as the above command does. It will also create a persistent volume in your home directory for saving your blockchain as well as map the default ports. There is also an alpine tag available for a slim version of the image.

Do not forget --rpcaddr 0.0.0.0, if you want to access RPC from other containers and/or hosts. By default, geth binds to the local interface and RPC endpoints is not accessible from the outside.

Programatically interfacing Geth nodes

As a developer, sooner rather than later you'll want to start interacting with Geth and the Ethereum network via your own programs and not manually through the console. To aid this, Geth has built-in support for a JSON-RPC based APIs (standard APIs and Geth specific APIs). These can be exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows).

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

HTTP based JSON-RPC API options:

  • --rpc Enable the HTTP-RPC server
  • --rpcaddr HTTP-RPC server listening interface (default: "localhost")
  • --rpcport HTTP-RPC server listening port (default: 8545)
  • --rpcapi API's offered over the HTTP-RPC interface (default: "eth,net,web3")
  • --rpccorsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
  • --ws Enable the WS-RPC server
  • --wsaddr WS-RPC server listening interface (default: "localhost")
  • --wsport WS-RPC server listening port (default: 8546)
  • --wsapi API's offered over the WS-RPC interface (default: "eth,net,web3")
  • --wsorigins Origins from which to accept websockets requests
  • --ipcdisable Disable the IPC-RPC server
  • --ipcapi API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3")
  • --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) to connect via HTTP, WS or IPC to a Geth node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!

Operating a private network

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

Defining the private genesis state

First, you'll need to create the genesis state of your networks, which all nodes need to be aware of and agree upon. This consists of a small JSON file (e.g. call it genesis.json):

{
  "config": {
        "chainId": 0,
        "homesteadBlock": 0,
        "eip155Block": 0,
        "eip158Block": 0
    },
  "alloc"      : {},
  "coinbase"   : "0x0000000000000000000000000000000000000000",
  "difficulty" : "0x20000",
  "extraData"  : "",
  "gasLimit"   : "0x2fefd8",
  "nonce"      : "0x0000000000000042",
  "mixhash"    : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "timestamp"  : "0x00"
}

The above fields should be fine for most purposes, although we'd recommend changing the nonce to some random value so you prevent unknown remote nodes from being able to connect to you. If you'd like to pre-fund some accounts for easier testing, you can populate the alloc field with account configs:

"alloc": {
  "0x0000000000000000000000000000000000000001": {"balance": "111111111"},
  "0x0000000000000000000000000000000000000002": {"balance": "222222222"}
}

With the genesis state defined in the above JSON file, you'll need to initialize every Geth node with it prior to starting it up to ensure all blockchain parameters are correctly set:

$ geth init path/to/genesis.json

Creating the rendezvous point

With all nodes that you want to run initialized to the desired genesis state, you'll need to start a bootstrap node that others can use to find each other in your network and/or over the internet. The clean way is to configure and run a dedicated bootnode:

$ bootnode --genkey=boot.key
$ bootnode --nodekey=boot.key

With the bootnode online, it will display an enode URL that other nodes can use to connect to it and exchange peer information. Make sure to replace the displayed IP address information (most probably [::]) with your externally accessible IP to get the actual enode URL.

Note: You could also use a full fledged Geth node as a bootnode, but it's the less recommended way.

Starting up your member nodes

With the bootnode operational and externally reachable (you can try telnet <ip> <port> to ensure it's indeed reachable), start every subsequent Geth node pointed to the bootnode for peer discovery via the --bootnodes flag. It will probably also be desirable to keep the data directory of your private network separated, so do also specify a custom --datadir flag.

$ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above>

Note: Since your network will be completely cut off from the main and test networks, you'll also need to configure a miner to process transactions and create new blocks for you.

Running a private miner

Mining on the public Ethereum network is a complex task as it's only feasible using GPUs, requiring an OpenCL or CUDA enabled ethminer instance. For information on such a setup, please consult the EtherMining subreddit and the Genoil miner repository.

In a private network setting however, a single CPU miner instance is more than enough for practical purposes as it can produce a stable stream of blocks at the correct intervals without needing heavy resources (consider running on a single thread, no need for multiple ones either). To start a Geth instance for mining, run it with all your usual flags, extended by:

$ geth <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000

Which will start mining blocks and transactions on a single CPU thread, crediting all proceedings to the account specified by --etherbase. You can further tune the mining by changing the default gas limit blocks converge to (--targetgaslimit) and the price transactions are accepted at (--gasprice).

Contribution

Thank you for considering to help out with the source code! We welcome contributions from 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 request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our gitter channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

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

Please see the Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

License

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

The go-ethereum binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.