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 5da3d911cf Initial args tests 10 years ago
Godeps Update godeps 10 years ago
_data Chain tests 10 years ago
accounts Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop 10 years ago
cmd Move p2p.MakeName to ethutil.MakeVersion 10 years ago
compression/rle update imports order per goimports 10 years ago
core Removed some methods from the JS REPL 10 years ago
crypto Fix key store address hex decoding and accounts test 10 years ago
eth Add client_version RPC message 10 years ago
ethdb removed messages 10 years ago
ethutil Move p2p.MakeName to ethutil.MakeVersion 10 years ago
event skipping test 10 years ago
javascript Refactor & cleanup 10 years ago
logger logger: add P2P disconnected event 10 years ago
miner Report debug hash rate 10 years ago
p2p Move p2p.MakeName to ethutil.MakeVersion 10 years ago
pow Turbo off 10 years ago
rlp wip 10 years ago
rpc Initial args tests 10 years ago
state Removed some methods from the JS REPL 10 years ago
tests Removed exported fields from state object and added proper set/getters 10 years ago
trie Fixed iterator 10 years ago
ui Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop 10 years ago
vm Simple effective VM optimisation 10 years ago
whisper Properly uninstall filters. Mining issue fixed #closes #365 10 years ago
xeth Refactor & cleanup 10 years ago
.gitignore Ignore locally built binaries 10 years ago
.gitmodules Added sample coin as a submodule 10 years ago
.mailmap add license tool and initial mailmap 10 years ago
.travis.yml Update Go and Qt versions 10 years ago
Dockerfile Bump to latest versions for Docker 10 years ago
LICENSE MIT -> LGPL 10 years ago
README.md Update build status links to https 10 years ago
gocoverage.sh Don't print per-function testing results 10 years ago
install.sh go get deps doesnt work with develop branch 10 years ago
update-license.go update-license.go: add blank line after build tag 10 years ago

README.md

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | Windows | Tests

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

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