2015-02-05 20:36:30 +00:00
## Ethereum Go
2015-02-05 20:34:47 +00:00
2015-08-18 20:46:58 +00:00
Official golang implementation of the Ethereum protocol
2015-02-05 20:34:47 +00:00
2015-06-06 12:33:08 +00:00
| Linux | OSX | ARM | Windows | Tests
----------|---------|-----|-----|---------|------
2015-08-18 20:46:58 +00:00
develop | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch )](https://build.ethdev.com/builders/Linux%20Go%20develop%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch )](https://build.ethdev.com/builders/OSX%20Go%20develop%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=ARM%20Go%20develop%20branch )](https://build.ethdev.com/builders/ARM%20Go%20develop%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=Windows%20Go%20develop%20branch )](https://build.ethdev.com/builders/Windows%20Go%20develop%20branch/builds/-1) | [![Buildr+Status ](https://travis-ci.org/ethereum/go-ethereum.svg?branch=develop )](https://travis-ci.org/ethereum/go-ethereum) [![codecov.io ](http://codecov.io/github/ethereum/go-ethereum/coverage.svg?branch=develop )](http://codecov.io/github/ethereum/go-ethereum?branch=develop)
master | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch )](https://build.ethdev.com/builders/Linux%20Go%20master%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=OSX%20Go%20master%20branch )](https://build.ethdev.com/builders/OSX%20Go%20master%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=ARM%20Go%20master%20branch )](https://build.ethdev.com/builders/ARM%20Go%20master%20branch/builds/-1) | [![Build+Status ](https://build.ethdev.com/buildstatusimage?builder=Windows%20Go%20master%20branch )](https://build.ethdev.com/builders/Windows%20Go%20master%20branch/builds/-1) | [![Buildr+Status ](https://travis-ci.org/ethereum/go-ethereum.svg?branch=master )](https://travis-ci.org/ethereum/go-ethereum) [![codecov.io ](http://codecov.io/github/ethereum/go-ethereum/coverage.svg?branch=master )](http://codecov.io/github/ethereum/go-ethereum?branch=master)
2015-02-05 20:34:47 +00:00
2015-08-18 20:46:58 +00:00
[![API Reference](
https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
)](https://godoc.org/github.com/ethereum/go-ethereum)
2015-01-24 18:09:29 +00:00
[![Gitter ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/ethereum/go-ethereum?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2015-01-24 17:48:19 +00:00
2015-08-18 20:46:58 +00:00
## Automated development builds
2014-10-27 16:24:43 +00:00
2015-06-09 11:45:35 +00:00
The following builds are build automatically by our build servers after each push to the [develop ](https://github.com/ethereum/go-ethereum/tree/develop ) branch.
2015-03-15 11:19:26 +00:00
* [Docker ](https://registry.hub.docker.com/u/ethereum/client-go/ )
* [OS X ](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/Mist-OSX-latest.dmg )
* Ubuntu
2015-04-13 21:09:23 +00:00
[trusty ](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-trusty/latest/ ) |
[utopic ](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-utopic/latest/ )
2015-06-09 11:45:35 +00:00
* [Windows 64-bit ](https://build.ethdev.com/builds/Windows%20Go%20develop%20branch/Geth-Win64-latest.zip )
2015-06-19 16:49:15 +00:00
* [ARM ](https://build.ethdev.com/builds/ARM%20Go%20develop%20branch/geth-ARM-latest.tar.bz2 )
2014-10-27 16:22:29 +00:00
2015-08-18 20:46:58 +00:00
## Building the source
2015-04-28 10:13:42 +00:00
For prerequisites and detailed build instructions please read the
[Installation Instructions ](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum )
on the wiki.
Building geth requires two external dependencies, Go and GMP.
You can install them using your favourite package manager.
Once the dependencies are installed, run
make geth
2015-08-18 20:46:58 +00:00
## Executables
2014-02-14 23:04:46 +00:00
2015-03-02 18:44:29 +00:00
Go Ethereum comes with several wrappers/executables found in
[the `cmd` directory ](https://github.com/ethereum/go-ethereum/tree/develop/cmd ):
2014-11-18 19:23:17 +00:00
2015-08-18 20:46:58 +00:00
Command | |
----------|---------|
`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 ](https://github.com/ethereum/tests ) suite: `/path/to/test.json > ethtest --test BlockTests --stdin` .
`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` | prints RLP structures |
2014-02-15 12:27:23 +00:00
2015-08-18 20:46:58 +00:00
## Command line options
2013-12-26 12:29:45 +00:00
2015-06-25 14:46:54 +00:00
`geth` can be configured via command line options, environment variables and config files.
2015-03-02 18:44:29 +00:00
To get the options available:
2015-08-18 20:46:58 +00:00
geth help
2014-02-08 21:16:11 +00:00
2015-03-02 18:44:29 +00:00
For further details on options, see the [wiki ](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options )
2015-08-18 20:46:58 +00:00
## Contribution
2014-01-11 14:27:08 +00:00
2015-03-02 18:44:29 +00:00
If you'd like to contribute to go-ethereum please fork, fix, commit and
2014-02-14 23:04:46 +00:00
send a pull request. Commits who do not comply with the coding standards
2014-08-21 13:27:01 +00:00
are ignored (use gofmt!). If you send pull requests make absolute sure that you
2014-02-15 10:49:39 +00:00
commit on the `develop` branch and that you do not merge to master.
Commits that are directly based on master are simply ignored.
2014-02-15 10:49:29 +00:00
2015-04-28 10:13:42 +00:00
See [Developers' Guide ](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide )
for more details on configuring your environment, testing, and
dependency management.