go-pulse/README.md

132 lines
5.2 KiB
Markdown
Raw Normal View History

2014-10-27 16:22:29 +00:00
[![Bugs](https://badge.waffle.io/ethereum/go-ethereum.png?label=bug&title=Bugs)](https://waffle.io/ethereum/go-ethereum)
2014-10-22 21:56:40 +00:00
[![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum)
2014-10-27 16:14:37 +00:00
[![Stories in
2014-10-27 16:22:29 +00:00
Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum)
2014-10-27 16:14:37 +00:00
2014-01-08 22:42:23 +00:00
Ethereum
========
2014-01-05 19:45:32 +00:00
2014-10-12 06:15:15 +00:00
[![Build
Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master [![Build
Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop
2014-07-30 13:33:42 +00:00
Ethereum Go Client © 2014 Jeffrey Wilcke.
2014-01-11 14:53:27 +00:00
2014-10-27 16:22:29 +00:00
Current state: Proof of Concept 0.7
2014-01-11 14:53:27 +00:00
Ethereum is currently in its testing phase.
2014-10-27 16:22:29 +00:00
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](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go))
Automated (dev) builds: [OS X (Windows, Linux are Coming
Soon™)](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/latest/app/)
Packages
========
2014-02-14 23:04:46 +00:00
Ethereum Go is split up in several sub packages Please refer to each
individual package for more information.
1. [eth](https://github.com/ethereum/go-ethereum)
2. [ethchain](https://github.com/ethereum/go-ethereum/tree/master/ethchain)
3. [ethwire](https://github.com/ethereum/go-ethereum/tree/master/ethwire)
4. [ethdb](https://github.com/ethereum/go-ethereum/tree/master/ethdb)
5. [ethutil](https://github.com/ethereum/go-ethereum/tree/master/ethutil)
6. [ethpipe](https://github.com/ethereum/go-ethereum/tree/master/ethpipe)
7. [ethvm](https://github.com/ethereum/go-ethereum/tree/master/ethvm)
8. [ethtrie](https://github.com/ethereum/go-ethereum/tree/master/ethtrie)
9. [ethreact](https://github.com/ethereum/go-ethereum/tree/master/ethreact)
10. [ethlog](https://github.com/ethereum/go-ethereum/tree/master/ethlog)
The [eth](https://github.com/ethereum/go-ethereum) is the top-level package
2014-02-14 23:04:46 +00:00
of the Ethereum protocol. It functions as the Ethereum bootstrapping and
peer communication layer. The [ethchain](https://github.com/ethereum/go-ethereum/tree/master/ethchain)
2014-02-14 23:04:46 +00:00
contains the Ethereum blockchain, block manager, transaction and
transaction handlers. The [ethwire](https://github.com/ethereum/go-ethereum/tree/master/ethwire) contains
2014-02-14 23:04:46 +00:00
the Ethereum [wire protocol](http://wiki.ethereum.org/index.php/Wire_Protocol) which can be used
to hook in to the Ethereum network. [ethutil](https://github.com/ethereum/go-ethereum/tree/master/ethutil) contains
2014-02-14 23:04:46 +00:00
utility functions which are not Ethereum specific. The utility package
contains the [patricia trie](http://wiki.ethereum.org/index.php/Patricia_Tree),
[RLP Encoding](http://wiki.ethereum.org/index.php/RLP) and hex encoding
helpers. The [ethdb](https://github.com/ethereum/go-ethereum/tree/master/ethdb) package
2014-02-14 23:04:46 +00:00
contains the LevelDB interface and memory DB interface.
2014-02-15 12:27:23 +00:00
2014-03-30 20:03:29 +00:00
General command line options
2014-10-27 16:22:29 +00:00
============================
2013-12-26 12:29:45 +00:00
2014-01-16 10:00:56 +00:00
```
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
2014-05-20 20:13:39 +00:00
-upnp Enable UPnP
-maxpeer Desired amount of peers
-rpc Start JSON RPC
2014-05-20 20:13:39 +00:00
-dir Data directory used to store configs and databases
-import Import a private key
-genaddr Generates a new address and private key (destructive action)
2014-05-20 20:13:39 +00:00
-h This
2014-01-11 14:27:08 +00:00
2014-05-20 20:13:39 +00:00
Ethereum only
ethereum [options] [filename]
2014-05-21 12:04:11 +00:00
-js Start the JavaScript REPL
filename Load the given file and interpret as JavaScript
-m Start mining blocks
2014-02-08 21:16:11 +00:00
Mist only
2014-05-20 20:13:39 +00:00
-asset_path absolute path to GUI assets directory
2014-02-08 21:16:11 +00:00
```
2014-01-11 14:27:08 +00:00
Contribution
============
If you'd like to contribute to Ethereum please fork, fix, commit and
2014-02-14 23:04:46 +00:00
send a pull request. Commits who do not comply with the coding standards
2014-08-21 13:27:01 +00:00
are ignored (use gofmt!). If you send pull requests make absolute sure that you
2014-02-15 10:49:39 +00:00
commit on the `develop` branch and that you do not merge to master.
Commits that are directly based on master are simply ignored.
2014-02-15 10:49:29 +00:00
2014-02-15 10:49:39 +00:00
To make life easier try [git flow](http://nvie.com/posts/a-successful-git-branching-model/) it sets
this all up and streamlines your work flow.
2014-01-11 14:41:05 +00:00
Coding standards
================
2014-02-14 23:04:46 +00:00
Sources should be formatted according to the [Go Formatting
2014-01-11 14:41:05 +00:00
Style](http://golang.org/doc/effective_go.html#formatting).
2014-02-14 23:04:46 +00:00
Unless structs fields are supposed to be directly accesible, provide
Getters and hide the fields through Go's exporting facility.
2014-01-11 14:41:05 +00:00
2014-02-14 23:04:46 +00:00
When you comment put meaningfull comments. Describe in detail what you
want to achieve.
2014-01-11 14:41:05 +00:00
*wrong*
```go
// Check if the value at x is greater than y
if x > y {
// It's greater!
}
```
2014-01-11 14:53:27 +00:00
2014-02-14 23:04:46 +00:00
Everyone reading the source probably know what you wanted to achieve
with above code. Those are **not** meaningful comments.
2014-01-16 10:00:56 +00:00
2014-02-14 23:04:46 +00:00
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!)
2014-01-16 10:00:56 +00:00