75ee3b3f08
|
||
|---|---|---|
| chain | ||
| cmd | ||
| compression/rle | ||
| crypto | ||
| ethdb | ||
| ethutil | ||
| event | ||
| javascript | ||
| logger | ||
| miner | ||
| p2p | ||
| pow/ar | ||
| rpc | ||
| state | ||
| tests | ||
| trie | ||
| types | ||
| ui | ||
| vm | ||
| websocket | ||
| wire | ||
| xeth | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| LICENSE | ||
| README.md | ||
| block_pool.go | ||
| ethereum.go | ||
| events.go | ||
| install.sh | ||
| nat.go | ||
| natpmp.go | ||
| natupnp.go | ||
| peer.go | ||
README.md
Ethereum
master
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.
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:
mistOfficial Ethereum BrowserethereumEthereum CLIethtesttest tool which runs with the tests suit:ethtest "cat myfile.json".evmis a generic Ethereum Virtual Machine:evm -code 60ff60ff -gas 10000 -price 0 -dump. See-hfor 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!)