Official Go implementation of the Ethereum protocol

obscuren 8de099ae75 Added paranoia check		11 years ago
ethchain	Changed CREATE	11 years ago
ethcrypto	Fixed key import for empty entries	11 years ago
ethdb	Moved keyring to ethutil & removed old methods. Implements #20	11 years ago
ethlog	go fmt	11 years ago
ethminer	Close pow chat. Fixes #95	11 years ago
ethpub	Removed old method	11 years ago
ethrpc	change all modified calls to ethtrie, ethutil and ethcrypto functions	11 years ago
ethtrie	Added paranoia check	11 years ago
ethutil	Suicide is deferred to update	11 years ago
ethwire	Reworking messaging interface	11 years ago
.gitignore	Merge branch 'feature/keys' of https://github.com/ethersphere/go-ethereum into ethersphere-feature/keys	11 years ago
.travis.yml	sudo not udo	11 years ago
LICENSE	Added license name and updated block output from the dev console	11 years ago
README.md	bump	11 years ago
ethereum.go	change all modified calls to ethtrie, ethutil and ethcrypto functions	11 years ago
install.sh	Merge branch 'master' into develop	11 years ago
nat.go	Implemented support for UPnP	11 years ago
natpmp.go	Implemented support for UPnP	11 years ago
natupnp.go	Fixed Upnp bug	11 years ago
peer.go	Added quitting reason	11 years ago

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.5.16". 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. 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!)