Official Go implementation of the Ethereum protocol
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Taylor Gerring ed7d7b405e Split file cleanup 10 years ago
_data Chain tests 10 years ago
cmd Add LogFormat flag 10 years ago
compression/rle update imports order per goimports 10 years ago
core StdVm by default 10 years ago
crypto Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop 10 years ago
eth Add LogFormat flag 10 years ago
ethdb Decode from stream directly 10 years ago
ethutil updated tests 10 years ago
event Added manual triggering of filters 10 years ago
javascript Refactored ethutil.Config.Db out 10 years ago
logger Split file cleanup 10 years ago
miner Refactored ethutil.Config.Db out 10 years ago
p2p Moved connection errors to DebugDetail level 10 years ago
pow pre-pow 10 years ago
rlp rlp: allow encoding non-empty interface values 10 years ago
rpc ethpipe => xeth (eXtended ETHereum) 10 years ago
state Moved ptrie => trie. Removed old trie 10 years ago
tests updated tests 10 years ago
trie Moved ptrie => trie. Removed old trie 10 years ago
ui Changed public whisper api not to reveal temporary private keys 10 years ago
vm StdVm by default 10 years ago
websocket Implemented filter for ws + fixes 10 years ago
whisper fixed url bug in browser 10 years ago
xeth Implemented filter for ws + fixes 10 years ago
.gitignore Add new key_store interface and two new key stores 10 years ago
.gitmodules Added sample coin as a submodule 11 years ago
.mailmap add license tool and initial mailmap 10 years ago
.travis.yml Move goveralls call to script 10 years ago
Dockerfile Use repo default branches 10 years ago
LICENSE MIT -> LGPL 10 years ago
README.md Version bump 10 years ago
gocoverage.sh Move goveralls call to script 10 years ago
install.sh go get deps doesnt work with develop branch 10 years ago
update-license.go a few fixes for the license tool 10 years ago

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