Go to file
obscuren c934222a80 Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop 2015-02-17 12:25:25 +01:00
Godeps Update obscuren/qml revision 2015-02-16 19:43:27 +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 "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
compression/rle update imports order per goimports 2014-11-15 20:21:55 -06:00
core "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
crypto Added invalid sec key test 2015-02-16 13:19:57 +01:00
eth "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
ethdb removed messages 2015-02-12 17:06:15 +01:00
ethutil updated tests 2015-01-13 00:25:45 +01:00
event Renamed filter 2015-02-07 17:03:12 +01:00
javascript cmd/mist, eth, javascript, p2p: use Node URLs for peer suggestions 2015-02-07 00:46:56 +01:00
logger Move standard fields to LogEvent 2015-02-11 18:49:00 +01:00
miner "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
p2p Use a mutex write-lock for a write operation 2015-02-15 02:13:24 +01:00
pow Fixed mining & limited hash power 2015-02-14 16:52:14 +01:00
rlp wip 2015-02-13 15:35:54 +01:00
rpc HTTP RPC only listen on localhost 2015-02-15 02:26:30 +01:00
state Documented methods & removed old manifest 2015-02-11 23:46:45 +01:00
tests disabled test 2015-02-13 23:26:41 +01:00
trie Fixed iterator 2015-02-07 17:03:22 +01:00
ui "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
vm Documented methods & removed old manifest 2015-02-11 23:46:45 +01:00
whisper Moved ECIES to repo & added secondary title for webview 2015-02-14 00:25:47 +01:00
xeth "centralised" mining to backend. Closes #323 2015-02-17 12:24:58 +01:00
.gitignore Ignore locally built binaries 2015-02-16 11:42:33 +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 Update Travis to use godep 2015-02-16 14:34:50 +01:00
Dockerfile Use explicit branch and godep 2015-02-16 17:00:57 +01:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Add godep usage information 2015-02-16 17:59:54 +01:00
gocoverage.sh Don't reference by $GOROOT 2015-02-05 16:02:15 -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

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | Windows

----------|---------|-----|-------- develop | Build+Status | Build+Status | N/A master | Build+Status | Build+Status | N/A

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

Ethereum (CLI):

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

For further, detailed, build instruction please see the Wiki

Automated (dev) builds

  • [Docker]
  • [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.

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.

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