Go to file
Felix Lange 64490897f3 crypto: add Sha3Hash 2015-03-16 17:27:24 +01:00
Godeps Moved ethutil => common 2015-03-16 11:27:38 +01:00
_data Chain tests 2014-12-30 15:42:26 +01:00
accounts Moved ethutil => common 2015-03-16 11:27:38 +01:00
blockpool Moved ethutil => common 2015-03-16 11:27:38 +01:00
cmd Moved ethutil => common 2015-03-16 11:27:38 +01:00
common conversion state 2015-03-16 17:09:08 +01:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core new type + additional methods 2015-03-16 11:59:52 +01:00
crypto crypto: add Sha3Hash 2015-03-16 17:27:24 +01:00
errs errs pkg for error code based errors 2015-02-25 19:21:59 +07:00
eth Moved ethutil => common 2015-03-16 11:27:38 +01:00
ethdb Moved ethutil => common 2015-03-16 11:27:38 +01:00
event skipping test 2015-02-23 20:27:00 +01:00
javascript Moved ethutil => common 2015-03-16 11:27:38 +01:00
logger Moved ethutil => common 2015-03-16 11:27:38 +01:00
miner Moved ethutil => common 2015-03-16 11:27:38 +01:00
p2p Moved ethutil => common 2015-03-16 11:27:38 +01:00
pow Moved ethutil => common 2015-03-16 11:27:38 +01:00
rlp wip 2015-02-13 15:35:54 +01:00
rpc Moved ethutil => common 2015-03-16 11:27:38 +01:00
state conversion state 2015-03-16 17:09:08 +01:00
tests Moved ethutil => common 2015-03-16 11:27:38 +01:00
trie undo 2015-03-16 16:36:58 +01:00
ui Moved ethutil => common 2015-03-16 11:27:38 +01:00
vm Moved ethutil => common 2015-03-16 11:27:38 +01:00
whisper Moved ethutil => common 2015-03-16 11:27:38 +01:00
xeth Moved ethutil => common 2015-03-16 11:27:38 +01:00
.gitignore ignore 2015-03-08 15:29:23 +01:00
.gitmodules Update ethereum.js 2015-03-12 10:03:35 -05:00
.mailmap add license tool and initial mailmap 2015-01-07 12:56:46 +01:00
.travis.yml Update Go and Qt versions 2015-02-25 11:40:52 +01:00
Dockerfile Bump to latest versions for Docker 2015-02-27 00:52:01 +01:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop 2015-03-15 12:20:58 +01:00
gocoverage.sh Don't print per-function testing results 2015-02-21 13:48:09 +01:00
update-license.go update-license.go: add blank line after build tag 2015-02-20 11:40:20 +01:00

README.md

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | Windows | Tests

----------|---------|-----|---------|------ develop | Build+Status | Build+Status | N/A | Buildr+Status master | Build+Status | Build+Status | N/A | Buildr+Status

Bugs Stories in Ready ![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress) Gitter

Build

Mist (GUI):

go get github.com/ethereum/go-ethereum/cmd/mist

Ethereum (CLI):

go get github.com/ethereum/go-ethereum/cmd/ethereum

As of POC-8, go-ethereum uses Godep to manage dependencies. Assuming you have your environment all set up, switch to the go-ethereum repository root folder, and build/install the executable you need:

Mist (GUI):

godep go build -v ./cmd/mist

Ethereum (CLI):

godep go build -v ./cmd/ethereum

Instead of build, you can use install which will also install the resulting binary.

For prerequisites and detailed build instructions please see the Wiki

If you intend to develop on go-ethereum, check the Developers' Guide

Automated (dev) builds

Executables

Go Ethereum comes with several wrappers/executables found in the cmd directory:

  • mist Official Ethereum Browser (ethereum GUI client)
  • ethereum Ethereum CLI (ethereum command line interface client)
  • bootnode runs a bootstrap node for the Discovery Protocol
  • ethtest test tool which runs with the tests suite: cat file | ethtest.
  • evm is a generic Ethereum Virtual Machine: evm -code 60ff60ff -gas 10000 -price 0 -dump. See -h for a detailed description.
  • disasm disassembles EVM code: echo "6001" | disasm
  • rlpdump converts a rlp stream to interface{}.

Command line options

Both mist and ethereum can be configured via command line options, environment variables and config files.

To get the options available:

ethereum -help

For further details on options, see the wiki

Contribution

If you'd like to contribute to go-ethereum please fork, fix, commit and send a pull request. Commits who do not comply with the coding standards are ignored (use gofmt!). If you send pull requests make absolute sure that you commit on the develop branch and that you do not merge to master. Commits that are directly based on master are simply ignored.

For dependency management, we use godep. After installing with go get github.com/tools/godep, run godep restore to ensure that changes to other repositories do not break the build. To update a dependency version (for example, to include a new upstream fix), run go get -u <foo/bar> then godep update <foo/...>. To track a new dependency, add it to the project as normal than run godep save ./.... Changes to the Godeps folder: should be manually verified then commited.

To make life easier try git flow it sets this all up and streamlines your work flow.

See Developers' Guide