Go implementation of the Ethereum protocol

Go to file

obscuren 54558dd8ae Removed log		2014-09-24 19:54:51 +02:00
ethchain	Info => Debug	2014-09-24 19:54:14 +02:00
ethcrypto	Changed back to FIPS 180	2014-09-07 22:34:24 +02:00
ethdb	Removed old code	2014-08-23 11:00:33 +02:00
ethlog	merge upstream	2014-07-21 13:26:29 +01:00
ethminer	Mine without txs	2014-09-24 19:54:37 +02:00
ethpipe	Re-wrote Call and Execute to use the new vm messages	2014-09-22 14:51:21 +02:00
ethreact	Changed level	2014-08-23 19:00:52 +02:00
ethrpc	add pushtx to api	2014-09-09 21:27:34 -07:00
ethstate	Improved catching up and refactored	2014-09-15 15:42:12 +02:00
ethtrie	Fixed race condition	2014-09-24 17:47:01 +02:00
ethutil	Added TD for each block	2014-09-24 11:39:17 +02:00
ethvm	Removed log	2014-09-24 19:54:51 +02:00
ethwire	Remove log	2014-09-22 18:15:32 +02:00
.gitignore	Merge branch 'feature/keys' of https://github.com/ethersphere/go-ethereum into ethersphere-feature/keys	2014-07-01 13:45:39 +02:00
.travis.yml	sudo not udo	2014-01-10 10:59:57 +01:00
block_pool.go	Changed the block fetching code and hash distribution	2014-09-24 19:54:30 +02:00
ethereum.go	tmp	2014-09-24 11:41:57 +02:00
install.sh	Merge branch 'master' into develop	2014-06-29 10:44:03 +02:00
LICENSE	MIT -> LGPL	2014-08-21 15:43:14 +02: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	tmp	2014-09-24 11:41:57 +02:00
README.md	Storage at changed to return bytes	2014-08-21 21:06:42 +02:00

README.md

Ethereum

Ethereum Go Development package (C) Jeffrey Wilcke

Ethereum is currently in its testing phase. The current state is "Proof of Concept 0.6.5". For build instructions see the Wiki.

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.

This is the bootstrap package. Eth-go contains all the necessary code to get a node and connectivity going.

Build

This is the Developer package. For the Ethereal client please see Ethereum(G).

go get -u github.com/ethereum/eth-go

Contribution

If you'd like to contribute to Eth 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!)