Go to file
obscuren bb2e847363 Merge branch 'bounty' into develop 2015-01-31 17:44:42 +01:00
_data Chain tests 2014-12-30 15:42:26 +01:00
accounts Merge branch 'key_store_and_accounts_integration' of https://github.com/Gustav-Simonsson/go-ethereum into Gustav-Simonsson-key_store_and_accounts_integration 2015-01-28 20:55:55 +01:00
cmd added new default favicon 2015-01-30 15:54:43 +01:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core Merge branch 'bounty' into develop 2015-01-31 17:23:50 +01:00
crypto Merge branch 'bounty' into develop 2015-01-31 17:44:42 +01:00
eth Merge branch 'develop' into qt5.4 2015-01-28 21:36:53 +01:00
ethdb Decode from stream directly 2014-12-23 15:18:48 +01:00
ethutil updated tests 2015-01-13 00:25:45 +01:00
event reworking messages => log 2015-01-28 10:23:18 +01:00
javascript Added RPC "Call" for JS calls to contracts 2015-01-29 13:10:34 +01:00
logger Cleaned up some of that util 2015-01-04 14:20:16 +01:00
miner Refactored ethutil.Config.Db out 2015-01-07 13:17:48 +01:00
p2p Moved `obscuren` secp256k1-go 2015-01-22 00:35:00 +01:00
pow Moved sha3 from `obscuren` 2015-01-22 00:25:00 +01:00
rlp rlp: allow encoding non-empty interface values 2015-01-15 23:35:26 +01:00
rpc Added whisper messages 2015-01-30 13:47:18 +01:00
state removed old code 2015-01-31 17:23:46 +01:00
tests JitVM: the EVM JIT bridge 2015-01-22 18:00:15 +01:00
trie debug err removed 2015-01-29 23:18:46 +01:00
ui Added whisper interface for xeth, added examples, updated RPC 2015-01-30 13:25:12 +01:00
vm Added RPC "Call" for JS calls to contracts 2015-01-29 13:10:34 +01:00
whisper Fixed whisper pub key bug 2015-01-30 13:24:20 +01:00
xeth Removed debug log 2015-01-30 17:00:33 +01:00
.gitignore JitVM: the EVM JIT bridge 2015-01-22 18:00:15 +01:00
.gitmodules Added sample coin as a submodule 2014-07-04 15:49:51 +02:00
.mailmap add license tool and initial mailmap 2015-01-07 12:56:46 +01:00
.travis.yml Travis fixes for Qt5.4 2015-01-30 17:24:51 -06:00
Dockerfile Updated for Qt5.4 2015-01-30 11:49:52 -06:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Update coveralls badge to develop branch 2015-01-30 18:47:25 -06:00
gocoverage.sh Implemented contract ABI 2015-01-27 16:19:21 +01:00
install.sh go get deps doesnt work with develop branch 2014-11-21 08:16:32 -05:00
update-license.go a few fixes for the license tool 2015-01-07 13:17:50 +01:00

README.md

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

Ethereum PoC-8

  • Build Status master
  • Build Status develop
  • Travis-ci travis-ci
  • Coverage Status

Ethereum Go Client © 2014 Jeffrey Wilcke.

Build

Mist (GUI):

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

Ethereum (CLI):

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

For further, detailed, build instruction please see the Wiki

Automated (dev) builds

  • [OS X]
  • [Windows] Coming soon™
  • [Linux] Coming soon™

Binaries

Go Ethereum comes with several binaries found in cmd:

  • mist Official Ethereum Browser
  • ethereum Ethereum CLI
  • ethtest test tool which runs with the tests suit: cat file | ethtest.
  • evm is a generic Ethereum Virtual Machine: evm -code 60ff60ff -gas 10000 -price 0 -dump. See -h for a detailed description.
  • rlpdump converts a rlp stream to interface{}.
  • peerserver simple P2P (noi-ethereum) peer server.
  • disasm disassembles EVM code: echo "6001" | disasm

General command line options

== Shared between ethereum and Mist ==

= Settings
-id      Set the custom identifier of the client (shows up on other clients)
-port    Port on which the server will accept incomming connections
-upnp    Enable UPnP
-maxpeer Desired amount of peers
-rpc     Start JSON RPC
-dir     Data directory used to store configs and databases

= Utility 
-h         This
-import    Import a private key
-genaddr   Generates a new address and private key (destructive action)
-dump      Dump a specific state of a block to stdout given the -number or -hash
-difftool  Supress all output and prints VM output to stdout
-diff      vm=only vm output, all=all output including state storage

Ethereum only
ethereum [options] [filename]
-js        Start the JavaScript REPL
filename   Load the given file and interpret as JavaScript
-m       Start mining blocks

== Mist only ==

-asset_path    absolute path to GUI assets directory

Contribution

If you'd like to contribute to 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.

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

Coding standards

Sources should be formatted according to the Go Formatting Style.

Unless structs fields are supposed to be directly accesible, provide Getters and hide the fields through Go's exporting facility.

When you comment put meaningful comments. Describe in detail what you want to achieve.

wrong

// Check if the value at x is greater than y
if x > y {
    // It's greater!
}

Everyone reading the source probably know what you wanted to achieve with above code. Those are not meaningful comments.

While the project isn't 100% tested I want you to write tests non the less. I haven't got time to evaluate everyone's code in detail so I expect you to write tests for me so I don't have to test your code manually. (If you want to contribute by just writing tests that's fine too!)