go-ethereum

module

v1.0.1 Latest Latest Go to latest Published: Aug 5, 2015 License: GPL-3.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wolflo/go-ethereum

README ¶

Ethereum Go

Ethereum Go Client, by Jeffrey Wilcke (and some other people).

      | Linux   | OSX | ARM | Windows | Tests

----------|---------|-----|-----|---------|------ develop | | | | | master | | | | |

![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)

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:

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" | disasm
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 ¶

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

Path	Synopsis
Godeps
_workspace/src/code.google.com/p/go-uuid/uuid The uuid package generates and inspects UUIDs.	The uuid package generates and inspects UUIDs.
_workspace/src/github.com/codegangsta/cli Package cli provides a minimal framework for creating and organizing command line Go applications.	Package cli provides a minimal framework for creating and organizing command line Go applications.
_workspace/src/github.com/davecgh/go-spew/spew Package spew implements a deep pretty printer for Go data structures to aid in debugging.	Package spew implements a deep pretty printer for Go data structures to aid in debugging.
_workspace/src/github.com/ethereum/ethash
_workspace/src/github.com/gizak/termui Package termui is a library designed for creating command line UI.	Package termui is a library designed for creating command line UI.
_workspace/src/github.com/hashicorp/golang-lru This package provides a simple LRU cache.	This package provides a simple LRU cache.
_workspace/src/github.com/huin/goupnp goupnp is an implementation of a client for various UPnP services.	goupnp is an implementation of a client for various UPnP services.
_workspace/src/github.com/huin/goupnp/cmd/example_httpu_serving
_workspace/src/github.com/huin/goupnp/cmd/example_internetgateway1
_workspace/src/github.com/huin/goupnp/dcps/internetgateway1 Client for UPnP Device Control Protocol Internet Gateway Device v1.	Client for UPnP Device Control Protocol Internet Gateway Device v1.
_workspace/src/github.com/huin/goupnp/dcps/internetgateway2 Client for UPnP Device Control Protocol Internet Gateway Device v2.	Client for UPnP Device Control Protocol Internet Gateway Device v2.
_workspace/src/github.com/huin/goupnp/example Serves as examples of using the goupnp library.	Serves as examples of using the goupnp library.
_workspace/src/github.com/huin/goupnp/httpu
_workspace/src/github.com/huin/goupnp/scpd
_workspace/src/github.com/huin/goupnp/soap
_workspace/src/github.com/huin/goupnp/ssdp
_workspace/src/github.com/jackpal/go-nat-pmp
_workspace/src/github.com/kardianos/osext Extensions to the standard "os" package.	Extensions to the standard "os" package.
_workspace/src/github.com/mattn/go-colorable
_workspace/src/github.com/mattn/go-isatty Package isatty implements interface to isatty	Package isatty implements interface to isatty
_workspace/src/github.com/mattn/go-runewidth
_workspace/src/github.com/nsf/termbox-go termbox is a library for creating cross-platform text-based interfaces	termbox is a library for creating cross-platform text-based interfaces
_workspace/src/github.com/peterh/liner Package liner implements a simple command line editor, inspired by linenoise (https://github.com/antirez/linenoise/).	Package liner implements a simple command line editor, inspired by linenoise (https://github.com/antirez/linenoise/).
_workspace/src/github.com/rcrowley/go-metrics Go port of Coda Hale's Metrics library <https://github.com/rcrowley/go-metrics> Coda Hale's original work: <https://github.com/codahale/metrics>	Go port of Coda Hale's Metrics library <https://github.com/rcrowley/go-metrics> Coda Hale's original work: <https://github.com/codahale/metrics>
_workspace/src/github.com/rcrowley/go-metrics/cmd/metrics-bench
_workspace/src/github.com/rcrowley/go-metrics/cmd/metrics-example
_workspace/src/github.com/rcrowley/go-metrics/cmd/never-read
_workspace/src/github.com/rcrowley/go-metrics/influxdb
_workspace/src/github.com/rcrowley/go-metrics/librato
_workspace/src/github.com/rcrowley/go-metrics/stathat Metrics output to StatHat.	Metrics output to StatHat.
_workspace/src/github.com/robertkrimen/otto Package otto is a JavaScript parser and interpreter written natively in Go.	Package otto is a JavaScript parser and interpreter written natively in Go.
_workspace/src/github.com/robertkrimen/otto/ast Package ast declares types representing a JavaScript AST.	Package ast declares types representing a JavaScript AST.
_workspace/src/github.com/robertkrimen/otto/dbg Package dbg is a println/printf/log-debugging utility library.	Package dbg is a println/printf/log-debugging utility library.
_workspace/src/github.com/robertkrimen/otto/file Package file encapsulates the file abstractions used by the ast & parser.	Package file encapsulates the file abstractions used by the ast & parser.
_workspace/src/github.com/robertkrimen/otto/otto
_workspace/src/github.com/robertkrimen/otto/parser Package parser implements a parser for JavaScript.	Package parser implements a parser for JavaScript.
_workspace/src/github.com/robertkrimen/otto/registry Package registry is an expirmental package to facillitate altering the otto runtime via import.	Package registry is an expirmental package to facillitate altering the otto runtime via import.
_workspace/src/github.com/robertkrimen/otto/terst Package terst is a terse (terst = test + terse), easy-to-use testing library for Go.	Package terst is a terse (terst = test + terse), easy-to-use testing library for Go.
_workspace/src/github.com/robertkrimen/otto/test
_workspace/src/github.com/robertkrimen/otto/token Package token defines constants representing the lexical tokens of JavaScript (ECMA5).	Package token defines constants representing the lexical tokens of JavaScript (ECMA5).
_workspace/src/github.com/robertkrimen/otto/underscore Package underscore contains the source for the JavaScript utility-belt library.	Package underscore contains the source for the JavaScript utility-belt library.
_workspace/src/github.com/rs/cors Package cors is net/http handler to handle CORS related requests as defined by http://www.w3.org/TR/cors/ You can configure it by passing an option struct to cors.New: c := cors.New(cors.Options{ AllowedOrigins: []string{"foo.com"}, AllowedMethods: []string{"GET", "POST", "DELETE"}, AllowCredentials: true, }) Then insert the handler in the chain: handler = c.Handler(handler) See Options documentation for more options.	Package cors is net/http handler to handle CORS related requests as defined by http://www.w3.org/TR/cors/ You can configure it by passing an option struct to cors.New: c := cors.New(cors.Options{ AllowedOrigins: []string{"foo.com"}, AllowedMethods: []string{"GET", "POST", "DELETE"}, AllowCredentials: true, }) Then insert the handler in the chain: handler = c.Handler(handler) See Options documentation for more options.
_workspace/src/github.com/rs/cors/examples/alice
_workspace/src/github.com/rs/cors/examples/default
_workspace/src/github.com/rs/cors/examples/goji
_workspace/src/github.com/rs/cors/examples/martini
_workspace/src/github.com/rs/cors/examples/negroni
_workspace/src/github.com/rs/cors/examples/nethttp
_workspace/src/github.com/rs/cors/examples/openbar
_workspace/src/github.com/syndtr/goleveldb/leveldb Package leveldb provides implementation of LevelDB key/value database.	Package leveldb provides implementation of LevelDB key/value database.
_workspace/src/github.com/syndtr/goleveldb/leveldb/cache Package cache provides interface and implementation of a cache algorithms.	Package cache provides interface and implementation of a cache algorithms.
_workspace/src/github.com/syndtr/goleveldb/leveldb/comparer Package comparer provides interface and implementation for ordering sets of data.	Package comparer provides interface and implementation for ordering sets of data.
_workspace/src/github.com/syndtr/goleveldb/leveldb/errors Package errors provides common error types used throughout leveldb.	Package errors provides common error types used throughout leveldb.
_workspace/src/github.com/syndtr/goleveldb/leveldb/filter Package filter provides interface and implementation of probabilistic data structure.	Package filter provides interface and implementation of probabilistic data structure.
_workspace/src/github.com/syndtr/goleveldb/leveldb/iterator Package iterator provides interface and implementation to traverse over contents of a database.	Package iterator provides interface and implementation to traverse over contents of a database.
_workspace/src/github.com/syndtr/goleveldb/leveldb/journal Package journal reads and writes sequences of journals.	Package journal reads and writes sequences of journals.
_workspace/src/github.com/syndtr/goleveldb/leveldb/memdb Package memdb provides in-memory key/value database implementation.	Package memdb provides in-memory key/value database implementation.
_workspace/src/github.com/syndtr/goleveldb/leveldb/opt Package opt provides sets of options used by LevelDB.	Package opt provides sets of options used by LevelDB.
_workspace/src/github.com/syndtr/goleveldb/leveldb/storage Package storage provides storage abstraction for LevelDB.	Package storage provides storage abstraction for LevelDB.
_workspace/src/github.com/syndtr/goleveldb/leveldb/table Package table allows read and write sorted key/value.	Package table allows read and write sorted key/value.
_workspace/src/github.com/syndtr/goleveldb/leveldb/testutil
_workspace/src/github.com/syndtr/goleveldb/leveldb/util Package util provides utilities used throughout leveldb.	Package util provides utilities used throughout leveldb.
_workspace/src/github.com/syndtr/gosnappy/snappy Package snappy implements the snappy block-based compression format.	Package snappy implements the snappy block-based compression format.
_workspace/src/golang.org/x/crypto/pbkdf2 Package pbkdf2 implements the key derivation function PBKDF2 as defined in RFC 2898 / PKCS #5 v2.0.	Package pbkdf2 implements the key derivation function PBKDF2 as defined in RFC 2898 / PKCS #5 v2.0.
_workspace/src/golang.org/x/crypto/ripemd160 Package ripemd160 implements the RIPEMD-160 hash algorithm.	Package ripemd160 implements the RIPEMD-160 hash algorithm.
_workspace/src/golang.org/x/crypto/scrypt Package scrypt implements the scrypt key derivation function as defined in Colin Percival's paper "Stronger Key Derivation via Sequential Memory-Hard Functions" (http://www.tarsnap.com/scrypt/scrypt.pdf).	Package scrypt implements the scrypt key derivation function as defined in Colin Percival's paper "Stronger Key Derivation via Sequential Memory-Hard Functions" (http://www.tarsnap.com/scrypt/scrypt.pdf).
_workspace/src/golang.org/x/net/html Package html implements an HTML5-compliant tokenizer and parser.	Package html implements an HTML5-compliant tokenizer and parser.
_workspace/src/golang.org/x/net/html/atom Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".	Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".
_workspace/src/golang.org/x/net/html/charset Package charset provides common text encodings for HTML documents.	Package charset provides common text encodings for HTML documents.
_workspace/src/golang.org/x/text/encoding Package encoding defines an interface for character encodings, such as Shift JIS and Windows 1252, that can convert to and from UTF-8.	Package encoding defines an interface for character encodings, such as Shift JIS and Windows 1252, that can convert to and from UTF-8.
_workspace/src/golang.org/x/text/encoding/charmap Package charmap provides simple character encodings such as IBM Code Page 437 and Windows 1252.	Package charmap provides simple character encodings such as IBM Code Page 437 and Windows 1252.
_workspace/src/golang.org/x/text/encoding/htmlindex Package htmlindex maps character set encoding names to Encodings as recommended by the W3C for use in HTML 5.	Package htmlindex maps character set encoding names to Encodings as recommended by the W3C for use in HTML 5.
_workspace/src/golang.org/x/text/encoding/ianaindex Package ianaindex maps names to Encodings as specified by the IANA registry.	Package ianaindex maps names to Encodings as specified by the IANA registry.
_workspace/src/golang.org/x/text/encoding/internal Package internal contains code that is shared among encoding implementations.	Package internal contains code that is shared among encoding implementations.
_workspace/src/golang.org/x/text/encoding/internal/identifier Package identifier defines the contract between implementations of Encoding and Index by defining identifiers that uniquely identify standardized coded character sets (CCS) and character encoding schemes (CES), which we will together refer to as encodings, for which Encoding implementations provide converters to and from UTF-8.	Package identifier defines the contract between implementations of Encoding and Index by defining identifiers that uniquely identify standardized coded character sets (CCS) and character encoding schemes (CES), which we will together refer to as encodings, for which Encoding implementations provide converters to and from UTF-8.
_workspace/src/golang.org/x/text/encoding/japanese Package japanese provides Japanese encodings such as EUC-JP and Shift JIS.	Package japanese provides Japanese encodings such as EUC-JP and Shift JIS.
_workspace/src/golang.org/x/text/encoding/korean Package korean provides Korean encodings such as EUC-KR.	Package korean provides Korean encodings such as EUC-KR.
_workspace/src/golang.org/x/text/encoding/simplifiedchinese Package simplifiedchinese provides Simplified Chinese encodings such as GBK.	Package simplifiedchinese provides Simplified Chinese encodings such as GBK.
_workspace/src/golang.org/x/text/encoding/traditionalchinese Package traditionalchinese provides Traditional Chinese encodings such as Big5.	Package traditionalchinese provides Traditional Chinese encodings such as Big5.
_workspace/src/golang.org/x/text/encoding/unicode Package unicode provides Unicode encodings such as UTF-16.	Package unicode provides Unicode encodings such as UTF-16.
_workspace/src/golang.org/x/text/transform Package transform provides reader and writer wrappers that transform the bytes passing through as well as various transformations.	Package transform provides reader and writer wrappers that transform the bytes passing through as well as various transformations.
_workspace/src/gopkg.in/check.v1 Package check is a rich testing extension for Go's testing package.	Package check is a rich testing extension for Go's testing package.
_workspace/src/gopkg.in/fatih/set.v0 Package set provides both threadsafe and non-threadsafe implementations of a generic set data structure.	Package set provides both threadsafe and non-threadsafe implementations of a generic set data structure.
_workspace/src/gopkg.in/karalabe/cookiejar.v2/collections/prque Package prque implements a priority queue data structure supporting arbitrary value types and float priorities.	Package prque implements a priority queue data structure supporting arbitrary value types and float priorities.
accounts Package implements a private key management facility.	Package implements a private key management facility.
abi Package abi implements the Ethereum ABI (Application Binary Interface).	Package abi implements the Ethereum ABI (Application Binary Interface).
cmd
bootnode bootnode runs a bootstrap node for the Ethereum Discovery Protocol.	bootnode runs a bootstrap node for the Ethereum Discovery Protocol.
disasm disasm is a pretty-printer for EVM bytecode.	disasm is a pretty-printer for EVM bytecode.
ethtest ethtest executes Ethereum JSON tests.	ethtest executes Ethereum JSON tests.
evm evm executes EVM code snippets.	evm executes EVM code snippets.
geth geth is the official command-line client for Ethereum.	geth is the official command-line client for Ethereum.
rlpdump rlpdump is a pretty-printer for RLP data.	rlpdump is a pretty-printer for RLP data.
utils Package utils contains internal helper functions for go-ethereum commands.	Package utils contains internal helper functions for go-ethereum commands.
common Package common contains various helper functions.	Package common contains various helper functions.
compiler
docserver
math
natspec
number
registrar
registrar/ethreg
compression
rle Package rle implements the run-length encoding used for Ethereum data.	Package rle implements the run-length encoding used for Ethereum data.
core Package core implements the Ethereum consensus protocol.	Package core implements the Ethereum consensus protocol.
state Package state provides a caching layer atop the Ethereum state trie.	Package state provides a caching layer atop the Ethereum state trie.
types Package types contains data types related to Ethereum consensus.	Package types contains data types related to Ethereum consensus.
vm Package vm implements the Ethereum Virtual Machine.	Package vm implements the Ethereum Virtual Machine.
crypto
ecies
randentropy
secp256k1
sha3 Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012.	Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012.
errs
eth Package eth implements the Ethereum protocol.	Package eth implements the Ethereum protocol.
downloader Package downloader contains the manual full chain synchronisation.	Package downloader contains the manual full chain synchronisation.
fetcher Package fetcher contains the block announcement based synchonisation.	Package fetcher contains the block announcement based synchonisation.
ethdb
event Package event implements an event multiplexer.	Package event implements an event multiplexer.
filter Package filter implements event filters.	Package filter implements event filters.
fdtrack Package fdtrack logs statistics about open file descriptors.	Package fdtrack logs statistics about open file descriptors.
generators
jsre Package jsre provides execution environment for JavaScript.	Package jsre provides execution environment for JavaScript.
logger Package logger implements a multi-output leveled logger.	Package logger implements a multi-output leveled logger.
glog Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.	Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.
metrics Package metrics provides general system and process level metrics collection.	Package metrics provides general system and process level metrics collection.
miner 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.
discover Package discover implements the Node Discovery Protocol.	Package discover implements the Node Discovery Protocol.
nat Package nat provides access to common network port mapping protocols.	Package nat provides access to common network port mapping protocols.
params
pow
dagger
ezp
rlp 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.
api
codec
comms
shared
tests Package tests implements execution of Ethereum JSON tests.	Package tests implements execution of Ethereum JSON tests.
trie Package trie implements Merkle Patricia Tries.	Package trie implements Merkle Patricia Tries.
whisper Package whisper implements the Whisper PoC-1.	Package whisper implements the Whisper PoC-1.
xeth Package xeth is the interface to all Ethereum functionality.	Package xeth is the interface to all Ethereum functionality.