go-ethereum

module

v0.9.26 Latest Latest Go to latest Published: May 28, 2015 License: LGPL-2.1-or-later

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

README ¶

Ethereum Go

      | Linux   | OSX | Windows | Tests

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

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

Automated (dev) builds

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:

mist Official Ethereum Browser (ethereum GUI client)
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: cat file | ethtest.
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

Both mist and 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
_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/howeyc/fsnotify Package fsnotify implements file system notification.	Package fsnotify implements file system notification.
_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/obscuren/qml Package qml offers graphical QML application support for the Go language.	Package qml offers graphical QML application support for the Go language.
_workspace/src/github.com/obscuren/qml/cdata Package cdata supports the implementation of the qml package.	Package cdata supports the implementation of the qml package.
_workspace/src/github.com/obscuren/qml/cmd/genqrc Command genqrc packs resource files into the Go binary.	Command genqrc packs resource files into the Go binary.
_workspace/src/github.com/obscuren/qml/cpptest Package cpptest is an internal test helper.	Package cpptest is an internal test helper.
_workspace/src/github.com/obscuren/qml/examples/controls/basiclayouts
_workspace/src/github.com/obscuren/qml/examples/controls/gallery
_workspace/src/github.com/obscuren/qml/examples/controls/splitview
_workspace/src/github.com/obscuren/qml/examples/controls/tableview
_workspace/src/github.com/obscuren/qml/examples/controls/touch
_workspace/src/github.com/obscuren/qml/examples/customtype
_workspace/src/github.com/obscuren/qml/examples/gopher
_workspace/src/github.com/obscuren/qml/examples/imgprovider
_workspace/src/github.com/obscuren/qml/examples/modelview/delegate
_workspace/src/github.com/obscuren/qml/examples/painting
_workspace/src/github.com/obscuren/qml/examples/painting-es2
_workspace/src/github.com/obscuren/qml/examples/particle
_workspace/src/github.com/obscuren/qml/examples/qmlscene
_workspace/src/github.com/obscuren/qml/examples/qrcpacking
_workspace/src/github.com/obscuren/qml/examples/reparent
_workspace/src/github.com/obscuren/qml/examples/snapweb
_workspace/src/github.com/obscuren/qml/gl/1.0
_workspace/src/github.com/obscuren/qml/gl/1.1
_workspace/src/github.com/obscuren/qml/gl/1.2
_workspace/src/github.com/obscuren/qml/gl/1.3
_workspace/src/github.com/obscuren/qml/gl/1.4
_workspace/src/github.com/obscuren/qml/gl/1.5
_workspace/src/github.com/obscuren/qml/gl/2.0
_workspace/src/github.com/obscuren/qml/gl/2.1
_workspace/src/github.com/obscuren/qml/gl/3.0
_workspace/src/github.com/obscuren/qml/gl/3.1
_workspace/src/github.com/obscuren/qml/gl/3.2compat
_workspace/src/github.com/obscuren/qml/gl/3.2core
_workspace/src/github.com/obscuren/qml/gl/3.3compat
_workspace/src/github.com/obscuren/qml/gl/3.3core
_workspace/src/github.com/obscuren/qml/gl/4.0compat
_workspace/src/github.com/obscuren/qml/gl/4.0core
_workspace/src/github.com/obscuren/qml/gl/4.1compat
_workspace/src/github.com/obscuren/qml/gl/4.1core
_workspace/src/github.com/obscuren/qml/gl/4.2compat
_workspace/src/github.com/obscuren/qml/gl/4.2core
_workspace/src/github.com/obscuren/qml/gl/4.3compat
_workspace/src/github.com/obscuren/qml/gl/4.3core
_workspace/src/github.com/obscuren/qml/gl/es2
_workspace/src/github.com/obscuren/qml/gl/gengl
_workspace/src/github.com/obscuren/qml/gl/glbase
_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/rakyll/globalconf
_workspace/src/github.com/rakyll/goini
_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.
_workspace/src/gopkg.in/qml.v1/cdata Package cdata supports the implementation of the qml package.	Package cdata supports the implementation of the qml package.
_workspace/src/gopkg.in/qml.v1/gl/glbase
accounts This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.	This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
abi Package abi implements the Ethereum ABI (Application Binary Interface).	Package abi implements the Ethereum ABI (Application Binary Interface).
cmd
bootnode Command bootnode runs a bootstrap node for the Discovery Protocol.	Command bootnode runs a bootstrap node for the Discovery Protocol.
disasm
ethtest
evm
geth This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.	This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
mist This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.	This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
rlpdump rlpdump is a pretty-printer for RLP data.	rlpdump is a pretty-printer for RLP data.
utils This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.	This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
common
compiler
docserver
math
natspec
number
resolver
compression
rle
core
state
types
vm
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
downloader
ethdb
event Package event implements an event multiplexer.	Package event implements an event multiplexer.
filter
generators
jsre
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.
miner
p2p
discover Package discover implements the Node Discovery Protocol.	Package discover implements the Node Discovery Protocol.
nat Package nat provides access to common port mapping protocols.	Package nat provides access to common port mapping protocols.
params
pow
dagger
ezp
rlp Package rlp implements the RLP serialization format.	Package rlp implements the RLP serialization format.
rpc This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.	This file is part of go-ethereum go-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
tests
helper
vm
trie
ui
qt
qt/qwhisper QWhisper package.	QWhisper package.
qt/webengine
whisper Package whisper implements the Whisper PoC-1.	Package whisper implements the Whisper PoC-1.
xeth eXtended ETHereum	eXtended ETHereum

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