Go to file
obscuren 00348756bc updated tests 2015-01-12 13:49:47 +01:00
_data Chain tests 2014-12-30 15:42:26 +01:00
cmd removed accidental qt dep 2015-01-10 18:09:57 +01:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core pre-pow 2015-01-12 10:19:27 +01:00
crypto pre-pow 2015-01-12 10:19:27 +01:00
eth Limit hashes. Closes #249 2015-01-09 16:44:09 +01:00
ethdb Decode from stream directly 2014-12-23 15:18:48 +01:00
ethutil Minor fixed and additions for block proc 2015-01-08 16:37:06 +01:00
event pre-pow 2015-01-12 10:19:27 +01:00
javascript Refactored ethutil.Config.Db out 2015-01-07 13:17:48 +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 p2p: improve test for peers message 2015-01-06 12:23:38 +01:00
pow pre-pow 2015-01-12 10:19:27 +01:00
rlp Merge 2015-01-05 17:10:42 +01:00
rpc ethpipe => xeth (eXtended ETHereum) 2014-10-31 14:30:08 +01:00
state Moved ptrie => trie. Removed old trie 2015-01-08 11:47:04 +01:00
tests updated tests 2015-01-12 13:49:47 +01:00
trie Moved ptrie => trie. Removed old trie 2015-01-08 11:47:04 +01:00
ui Implemented filter for ws + fixes 2015-01-10 00:51:56 +01:00
vm updated tests 2015-01-12 13:49:47 +01:00
websocket Implemented filter for ws + fixes 2015-01-10 00:51:56 +01:00
whisper merged 2015-01-09 13:28:48 +01:00
xeth Implemented filter for ws + fixes 2015-01-10 00:51:56 +01:00
.gitignore .gitignore: ignore .ethtest 2014-10-31 18:55:39 +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 Move goveralls call to script 2014-12-21 14:46:32 -06:00
Dockerfile Use repo default branches 2014-12-21 14:31:19 -06:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Version bump 2015-01-04 14:34:04 +01:00
gocoverage.sh Move goveralls call to script 2014-12-21 14:46:32 -06: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)

Ethereum

BuildStatus master BuildStatus develop Coverage Status tests

Ethereum Go Client © 2014 Jeffrey Wilcke.

Current state: Proof of Concept 0.8

Ethereum is currently in its testing phase.

Build

To build Mist (GUI):

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

To build the node (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: ethtest "cat myfile.json".
  • evm is a generic Ethereum Virtual Machine: evm -code 60ff60ff -gas 10000 -price 0 -dump. See -h for a detailed description.

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 meaningfull 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!)