2014-01-08 16:42:23 -06:00
|
|
|
Ethereum
|
|
|
|
|
========
|
2014-01-05 13:45:32 -06:00
|
|
|
|
2014-01-08 16:42:23 -06:00
|
|
|
[](https://travis-ci.org/ethereum/go-ethereum)
|
|
|
|
|
|
2014-02-08 15:07:17 -06:00
|
|
|
Ethereum Go developer client (c) Jeffrey Wilcke
|
2014-01-11 08:53:27 -06:00
|
|
|
|
2014-01-16 04:01:59 -06:00
|
|
|
A fair warning; Ethereum is not yet to be used in production. There's no
|
2014-01-16 04:02:41 -06:00
|
|
|
test-net and you aren't mining real blocks (just one which is the genesis block).
|
2014-01-16 04:01:59 -06:00
|
|
|
|
2014-01-11 08:53:27 -06:00
|
|
|
|
2014-01-23 14:14:44 -06:00
|
|
|
Ethereum Go is split up in several sub packages Please refer to each
|
2014-01-11 08:53:27 -06:00
|
|
|
individual package for more information.
|
2014-01-23 14:14:44 -06:00
|
|
|
1. [eth](https://github.com/ethereum/eth-go)
|
|
|
|
|
2. [ethchain](https://github.com/ethereum/ethchain-go)
|
2014-01-11 08:53:27 -06:00
|
|
|
3. [ethwire](https://github.com/ethereum/ethwire-go)
|
2014-01-23 14:14:44 -06:00
|
|
|
4. [ethdb](https://github.com/ethereum/ethdb-go)
|
|
|
|
|
5. [ethutil](https://github.com/ethereum/ethutil-go)
|
|
|
|
|
|
|
|
|
|
The [eth](https://github.com/ethereum/eth-go) is the top-level package
|
|
|
|
|
of the Ethereum protocol. It functions as the Ethereum bootstrapping and
|
|
|
|
|
peer communication layer. The [ethchain](https://github.com/ethereum/ethchain-go)
|
|
|
|
|
contains the Ethereum blockchain, block manager, transaction and
|
|
|
|
|
transaction handlers. The [ethwire](https://github.com/ethereum/ethwire-go) contains
|
|
|
|
|
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/ethutil-go) contains
|
|
|
|
|
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/ethdb-go) package
|
|
|
|
|
contains the LevelDB interface and memory DB interface.
|
|
|
|
|
|
|
|
|
|
This executable is the front-end (currently nothing but a dev console) for
|
|
|
|
|
the Ethereum Go implementation.
|
2014-01-08 16:42:23 -06:00
|
|
|
|
|
|
|
|
Deps
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
Ethereum Go makes use of a modified `secp256k1-go` and therefor GMP.
|
|
|
|
|
|
2014-01-31 21:10:18 -06:00
|
|
|
Ubuntu 12+
|
2014-01-31 21:20:29 -06:00
|
|
|
* `apt-get install gmp-dev`
|
2014-01-31 21:10:18 -06:00
|
|
|
|
|
|
|
|
OS X 10.9+:
|
2014-01-31 21:20:29 -06:00
|
|
|
* `brew install gmp`
|
2014-01-31 21:10:18 -06:00
|
|
|
|
|
|
|
|
Build
|
2014-01-08 16:42:23 -06:00
|
|
|
=======
|
2013-12-26 06:29:45 -06:00
|
|
|
|
2014-02-06 06:28:30 -06:00
|
|
|
`go get -u -t github.com/ethereum/go-ethereum`
|
2013-12-26 06:35:04 -06:00
|
|
|
|
2013-12-26 06:29:45 -06:00
|
|
|
|
2014-01-08 16:42:23 -06:00
|
|
|
Command line options
|
|
|
|
|
====================
|
2013-12-26 06:29:45 -06:00
|
|
|
|
2014-01-16 04:00:56 -06:00
|
|
|
```
|
2014-01-10 04:05:28 -06:00
|
|
|
-c launch the developer console
|
|
|
|
|
-m start mining fake blocks and broadcast fake messages to the net
|
2014-01-16 04:00:56 -06:00
|
|
|
```
|
2014-01-11 08:27:08 -06:00
|
|
|
|
|
|
|
|
Contribution
|
|
|
|
|
============
|
|
|
|
|
|
2014-01-11 08:41:05 -06:00
|
|
|
If you'd like to contribute to Ethereum Go please fork, fix, commit and
|
|
|
|
|
send a pull request. Commits who do not comply with the coding standards
|
|
|
|
|
are ignored.
|
|
|
|
|
|
|
|
|
|
Coding standards
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
Sources should be formatted according to the [Go Formatting
|
|
|
|
|
Style](http://golang.org/doc/effective_go.html#formatting).
|
|
|
|
|
|
|
|
|
|
Unless structs fields are supposed to be directly accesible, provide
|
|
|
|
|
Getters and hide the fields through Go's exporting facility.
|
|
|
|
|
|
2014-01-16 04:00:56 -06:00
|
|
|
When you comment put meaningfull comments. Describe in detail what you
|
|
|
|
|
want to achieve.
|
2014-01-11 08:41:05 -06:00
|
|
|
|
|
|
|
|
*wrong*
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
// Check if the value at x is greater than y
|
|
|
|
|
if x > y {
|
|
|
|
|
// It's greater!
|
|
|
|
|
}
|
|
|
|
|
```
|
2014-01-11 08:53:27 -06:00
|
|
|
|
2014-01-16 04:00:56 -06:00
|
|
|
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!)
|
|
|
|
|
|
