Go to file
zelig 5022a31889 add NewMinedBlockEvent 2014-12-14 20:27:06 +00:00
cmd states moved to chain 2014-12-10 19:59:12 +01:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core add NewMinedBlockEvent 2014-12-14 20:27:06 +00:00
crypto fixed tests 2014-12-12 22:38:54 +01:00
eth blockpool rewritten , tests broken FIXME 2014-12-14 20:27:06 +00:00
ethdb Added caching and database interface to trie 2014-11-19 16:21:28 +01:00
ethutil Removed mutan. Closes #183 2014-12-04 17:13:23 +01:00
event Moved filter to events 2014-12-12 22:19:39 +01:00
javascript adapt javascript pkg to new backend, use SuggestPeer 2014-12-14 20:27:06 +00:00
logger ethlog => logger 2014-10-31 12:56:05 +01:00
miner adapt miner to new backend. use events to broadcast new mined blocks 2014-12-14 20:27:06 +00:00
p2p Fixed tests 2014-12-10 10:57:19 +01:00
pow Moved pow 2014-12-10 16:45:16 +01:00
ptrie Fixed test 2014-11-21 10:48:07 -05:00
rlp rlp: display decoder target type in more error messages 2014-12-09 22:28:49 +01:00
rpc ethpipe => xeth (eXtended ETHereum) 2014-10-31 14:30:08 +01:00
state Fixed tests 2014-12-10 10:57:19 +01:00
tests updated tests 2014-12-12 22:25:29 +01:00
trie Fixed tests for 'types' 2014-11-18 19:52:45 +01:00
types Working on new (blocking) event machine. 2014-09-29 12:57:51 +02:00
ui fixed tests 2014-12-12 22:38:54 +01:00
vm Panic for "Vm" 2014-12-12 22:24:27 +01:00
websocket ethlog => logger 2014-10-31 12:56:05 +01:00
whisper Implemented watching using filter package 2014-12-12 22:23:42 +01:00
wire Added encryption for messages better API for sealing messages 2014-12-10 00:03:50 +01:00
xeth adapt xeth pkg to new backend. FIXME JSPeer peer info 2014-12-14 20:27:06 +00: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
.travis.yml chain coverage report & submission 2014-11-27 12:42:13 +01:00
Dockerfile Fix variable name 2014-12-12 10:54:32 -06:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Updated readme 2014-11-18 20:23:17 +01:00
block_pool.go upped proto version and modified block pool 2014-12-05 16:26:39 +01:00
ethereum.go Removed start/stop methods 2014-12-10 16:48:39 +01:00
events.go all: use (blocking) event package instead of ethreact 2014-10-16 18:50:48 +02:00
gocoverage.sh try to get full coverage report on travis 2014-11-14 20:58:09 -06:00
install.sh go get deps doesnt work with develop branch 2014-11-21 08:16:32 -05:00
install_deps.sh Reorg travis.yml 2014-11-15 19:36:30 -06:00
nat.go Implemented support for UPnP 2014-02-02 19:22:39 +01:00
natpmp.go Implemented POST 2014-08-25 11:29:42 +02:00
natupnp.go Fixed Upnp bug 2014-05-01 22:14:20 +02:00
peer.go PV49 2014-12-09 20:28:36 +01:00
profile.cov Added `chain` tests & minor fixes 2014-11-19 12:25:52 +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

Ethereum Go Client © 2014 Jeffrey Wilcke.

Current state: Proof of Concept 0.7

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