Go to file
obscuren 75ee3b3f08 debugging code 2014-11-11 12:16:36 +01:00
chain debugging code 2014-11-11 12:16:36 +01:00
cmd Moved ethtest to cmd 2014-11-10 13:31:18 +01:00
compression/rle method change 2014-11-03 23:45:32 +01:00
crypto ethcrypto => crypto 2014-10-31 12:37:43 +01:00
ethdb Added storage root to dump 2014-11-03 23:45:44 +01:00
ethutil Updated to ethereum serpent 2014-11-05 00:32:51 +01:00
event event: panic for duplicate type 2014-10-16 18:59:28 +02:00
javascript StateManager => BlockManager 2014-11-04 10:57:02 +01:00
logger ethlog => logger 2014-10-31 12:56:05 +01:00
miner Fixed bloom, updated mining & block processing 2014-11-10 01:17:31 +01:00
p2p Implemented new miner w/ ui interface for merged mining. Closes #177 2014-11-07 12:18:48 +01:00
pow/ar all: fix rename breakage 2014-10-31 18:52:58 +01:00
rpc ethpipe => xeth (eXtended ETHereum) 2014-10-31 14:30:08 +01:00
state debugging code 2014-11-11 12:16:36 +01:00
tests Moved ethtest to cmd 2014-11-10 13:31:18 +01:00
trie Added storage root to dump 2014-11-03 23:45:44 +01:00
types Working on new (blocking) event machine. 2014-09-29 12:57:51 +02:00
ui Moved ethchain to chain 2014-10-31 10:59:17 +01:00
vm Added VM testing tool 2014-11-10 11:47:37 +01:00
websocket ethlog => logger 2014-10-31 12:56:05 +01:00
wire ethwire => wire 2014-10-31 14:53:42 +01:00
xeth Fixed bloom, updated mining & block processing 2014-11-10 01:17:31 +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
.travis.yml Travis bumped to 1.3 2014-10-18 14:20:51 +02:00
LICENSE MIT -> LGPL 2014-08-21 15:43:14 +02:00
README.md Updated readme 2014-11-10 13:36:53 +01:00
block_pool.go debugging code 2014-11-11 12:16:36 +01:00
ethereum.go Fixed bloom, updated mining & block processing 2014-11-10 01:17:31 +01:00
events.go all: use (blocking) event package instead of ethreact 2014-10-16 18:50:48 +02:00
install.sh Proper packages 2014-11-05 00:34:59 +01: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 Fixed bloom, updated mining & block processing 2014-11-10 01:17:31 +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™

Packages

Ethereum Go is split up in several sub packages Please refer to each individual package for more information.

  1. eth
  2. ethchain
  3. ethwire
  4. ethdb
  5. ethutil
  6. ethpipe
  7. ethvm
  8. ethtrie
  9. ethreact
  10. ethlog

The eth is the top-level package of the Ethereum protocol. It functions as the Ethereum bootstrapping and peer communication layer. The ethchain contains the Ethereum blockchain, block manager, transaction and transaction handlers. The ethwire contains the Ethereum wire protocol which can be used to hook in to the Ethereum network. ethutil contains utility functions which are not Ethereum specific. The utility package contains the patricia trie, RLP Encoding and hex encoding helpers. The ethdb package contains the LevelDB interface and memory DB interface.

General command line options

Shared between ethereum and Mist
-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
-import  Import a private key
-genaddr Generates a new address and private key (destructive action)
-h       This

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

Tools

Go Ethereum comes with several binaries:

  • 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.

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