go-ethereum

module
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 2, 2015 License: GPL-3.0

README

Ethereum Go

Official golang implementation of the Ethereum protocol

      | Linux   | OSX | ARM | Windows | Tests

----------|---------|-----|-----|---------|------ develop | | | | | codecov.io master | | | | | codecov.io

API Reference Gitter

Automated development builds

The following builds are build automatically by our build servers after each push to the develop branch.

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions on the wiki.

Building geth requires two external dependencies, Go and GMP. You can install them using your favourite package manager. Once the dependencies are installed, run

make geth

Executables

Go Ethereum comes with several wrappers/executables found in the cmd directory:

Command
geth Ethereum CLI (ethereum command line interface client)
bootnode runs a bootstrap node for the Discovery Protocol
ethtest test tool which runs with the tests suite: /path/to/test.json > ethtest --test BlockTests --stdin.
evm is a generic Ethereum Virtual Machine: evm -code 60ff60ff -gas 10000 -price 0 -dump. See -h for a detailed description.
disasm disassembles EVM code: `echo "6001"
rlpdump prints RLP structures

Command line options

geth can be configured via command line options, environment variables and config files.

To get the options available:

geth help

For further details on options, see the wiki

Contribution

If you'd like to contribute to go-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.

See Developers' Guide for more details on configuring your environment, testing, and dependency management.

Directories

Path Synopsis
Godeps
Package implements a private key management facility.
Package implements a private key management facility.
cmd
Package common contains various helper functions.
Package common contains various helper functions.
compression
Package core implements the Ethereum consensus protocol.
Package core implements the Ethereum consensus protocol.
eth
Package eth implements the Ethereum protocol.
Package eth implements the Ethereum protocol.
Package event implements an event multiplexer.
Package event implements an event multiplexer.
Package jsre provides execution environment for JavaScript.
Package jsre provides execution environment for JavaScript.
Package logger implements a multi-output leveled logger.
Package logger implements a multi-output leveled logger.
Package metrics provides general system and process level metrics collection.
Package metrics provides general system and process level metrics collection.
Package miner implements Ethereum block creation and mining.
Package miner implements Ethereum block creation and mining.
p2p
Package p2p implements the Ethereum p2p network protocols.
Package p2p implements the Ethereum p2p network protocols.
pow
Package rlp implements the RLP serialization format.
Package rlp implements the RLP serialization format.
rpc
Package rpc implements the Ethereum JSON-RPC API.
Package rpc implements the Ethereum JSON-RPC API.
Package tests implements execution of Ethereum JSON tests.
Package tests implements execution of Ethereum JSON tests.
Package trie implements Merkle Patricia Tries.
Package trie implements Merkle Patricia Tries.
Package whisper implements the Whisper PoC-1.
Package whisper implements the Whisper PoC-1.
Package xeth is the interface to all Ethereum functionality.
Package xeth is the interface to all Ethereum functionality.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL