Go to file
Taylor Gerring f89baa73e5 transactionRoot -> transactionsRoot 2015-04-02 12:30:22 +02:00
Godeps Update Godeps 2015-03-29 22:19:38 +02:00
_data Chain tests 2014-12-30 15:42:26 +01:00
accounts settable etherbase 2015-03-26 21:52:22 +00:00
blockpool blockpool: wrap intermittent status test in a loop 2015-03-26 19:00:18 +00:00
cmd Merge pull request #589 from tgerring/corssetting 2015-04-01 12:38:29 +02:00
common Fix block size output #613 2015-04-01 15:44:09 +02:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core check TxMsg 2015-04-01 12:32:42 +01:00
crypto Cleanup. 2015-03-29 15:02:49 +02:00
errs errs pkg for error code based errors 2015-02-25 19:21:59 +07:00
eth change StatusMsgData.TD back to pointer type *big.Int 2015-04-01 12:36:49 +01:00
ethdb common: drop accessors for Value.Val 2015-03-20 14:00:26 +01:00
event moved state and vm to core 2015-03-23 16:59:09 +01:00
generators Added gas generator defaults 2015-04-01 10:51:46 +02:00
jsre common: remove WriteFile and ReadAllFile (use ioutil instead) 2015-03-26 19:00:18 +00:00
logger fix ethtest logging 2015-03-23 17:08:49 +00:00
miner Fixed miner 2015-03-26 17:45:03 +01:00
p2p fix p2p/testlog_test 2015-03-23 16:41:41 +00:00
pow pow/ezp: use common.Hash 2015-03-17 12:01:21 +01:00
rlp rlp: encode nil array pointers as empty list or string 2015-03-25 16:46:29 +01:00
rpc transactionRoot -> transactionsRoot 2015-04-02 12:30:22 +02:00
tests Blocktest fixed, Execution fixed 2015-04-01 10:53:32 +02:00
trie Secure trie shakey / key matching 2015-03-24 15:14:03 +01:00
ui DRY up the use of toHex in the project and move it to common 2015-03-16 16:56:11 +01:00
whisper Move version to const and expose via Version() 2015-03-25 12:08:48 +01:00
xeth Make inner size before assinging. Closes #615 2015-04-01 14:15:20 +02:00
.gitignore General repo cleanup 2015-03-30 09:18:22 +02:00
.gitmodules General repo cleanup 2015-03-30 09:18:22 +02:00
.mailmap General repo cleanup 2015-03-30 09:18:22 +02:00
.travis.yml Remove old go cover location 2015-03-28 22:16:04 +01:00
Dockerfile Docker rename ethereum to geth 2015-03-28 22:17:08 +01:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Added Coveralls badges 2015-03-28 22:04:36 +01:00
gocoverage.sh Don't print per-function testing results 2015-02-21 13:48:09 +01:00
update-license.go General repo cleanup 2015-03-30 09:18:22 +02:00

README.md

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | Windows | Tests

----------|---------|-----|---------|------ develop | Build+Status | Build+Status | N/A | Buildr+Status Coverage Status master | Build+Status | Build+Status | N/A | Buildr+Status Coverage 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

Geth (CLI):

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

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

Geth (CLI):

godep go build -v ./cmd/geth

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)
  • geth 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 geth can be configured via command line options, environment variables and config files.

To get the options available:

geth -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