Go to file
Jeffrey Wilcke a1c201a5ac Merge pull request #2517 from fjl/debug-go-trace
internal/debug: rename debug_trace to debug_goTrace
2016-05-06 11:09:15 +02:00
.github templates: added issue template 2016-03-14 23:39:21 +01:00
Godeps Godeps: add github.com/rjeczalik/notify 2016-04-12 15:58:07 +02:00
_data Chain tests 2014-12-30 15:42:26 +01:00
accounts release, all: integrate the release service into geth 2016-05-02 16:20:21 +03:00
build build: tweak update-license.go 2016-04-15 09:46:54 +02:00
cmd cmd/geth: fixed to use proper version string for output 2016-05-03 14:01:37 +02:00
common common/releases: rewrite release version contract + use native dapps 2016-05-02 16:20:04 +03:00
compression/rle all: Rename crypto.Sha3{,Hash}() to crypto.Keccak256{,Hash}() 2016-02-21 22:34:34 +00:00
containers Added Vagrantfile so that developers can spin up a VM to build geth 2016-02-14 21:48:35 -05:00
core core: Provide a public accessor for ChainConfig 2016-04-29 12:42:03 +01:00
crypto all: fix go vet warnings 2016-04-15 11:17:27 +02:00
errs all: fix license headers one more time 2015-07-23 18:35:11 +02:00
eth release, all: integrate the release service into geth 2016-05-02 16:20:21 +03:00
ethdb cmd, eth, ethdb, node: prioritise chaindata for resources, bump cache 2016-03-09 10:33:39 +02:00
event event/filter: fix data race in the test 2015-11-05 16:55:53 +02:00
generators all: fix go vet warnings 2016-04-15 11:17:27 +02:00
internal internal/debug: rename debug_trace to debug_goTrace 2016-05-06 10:27:24 +02:00
jsre cmd/geth, jsre: improve the js command 2016-04-20 23:33:43 +02:00
light all: update license information 2016-04-15 09:48:05 +02:00
logger logger/glog: fix go vet issues 2016-04-15 10:58:41 +02:00
metrics all: fix go vet warnings 2016-04-15 11:17:27 +02:00
miner all: fix go vet warnings 2016-04-15 11:17:27 +02:00
node release, all: integrate the release service into geth 2016-05-02 16:20:21 +03:00
p2p p2p/discover: prevent bonding self 2016-05-02 18:50:16 +02:00
params core: added basic chain configuration 2016-04-01 01:01:10 +02:00
pow all: fix go vet warnings 2016-04-15 11:17:27 +02:00
release cmd/geth, release: polish and deploy live release contract 2016-05-02 16:20:58 +03:00
rlp all: fix go vet warnings 2016-04-15 11:17:27 +02:00
rpc Merge pull request #2463 from fjl/rpc-context-key 2016-04-19 10:22:48 +03:00
tests all: fix go vet warnings 2016-04-15 11:17:27 +02:00
trie all: fix go vet warnings 2016-04-15 11:17:27 +02:00
whisper Merge pull request #2458 from fjl/go-vet 2016-04-15 13:45:15 +02:00
.gitattributes .gitattributes: add 2015-08-06 17:18:59 +02:00
.gitignore Added Vagrantfile so that developers can spin up a VM to build geth 2016-02-14 21:48:35 -05:00
.gitmodules cmd/geth, jsre: updated ethereum.js => web3.js 2015-04-24 11:37:58 +02:00
.mailmap all: update license information 2016-04-15 09:48:05 +02:00
.travis.yml crypto/secp256k1: remove dependency on libgmp 2015-12-03 21:12:13 +01:00
AUTHORS all: update license information 2016-04-15 09:48:05 +02:00
COPYING all: update license information 2015-07-07 14:12:44 +02:00
COPYING.LESSER all: update license information 2015-07-07 14:12:44 +02:00
Makefile Makefile: enable go vet on Travis CI 2016-04-15 11:17:27 +02:00
README.md README: Polish up exec section, rewrite contrib and add license. 2016-05-03 14:26:55 +03:00
VERSION VERSION, cmd/geth: bumped version 2016-04-19 18:17:44 +02:00

README.md

Ethereum Go

Official golang implementation of the Ethereum protocol

      | Linux   | OSX | ARM | Windows | Tests

----------|---------|-----|-----|---------|------ develop | Build+Status | Build+Status | Build+Status | Build+Status | Buildr+Status codecov.io master | Build+Status | Build+Status | Build+Status | Build+Status | Buildr+Status 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 both a Go and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make geth

Executables

The go-ethereum project comes with several wrappers/executables found in the cmd directory.

Command Description
geth Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default) archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as an gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. Please see our Command Line Options wiki page for details.
abigen Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Ethereum contract ABIs with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see our Native DApps wiki page for details.
bootnode Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.
disasm Bytecode disassembler to convert EVM (Ethereum Virtual Machine) bytecode into more user friendly assembly-like opcodes (e.g. `echo "6001"
evm Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow insolated, fine graned debugging of EVM opcodes (e.g. evm --code 60ff60ff --debug).
gethrpctest Developer utility tool to support our ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the test suite's readme for details.
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our gitter channel to ensure those changes are in line with the general philosopy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidlines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adherign to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the develop branch.
  • Commit messages should be prefixed with the package(s) they modify.
    • E.g. "eth, rpc: make trace configs optional"

Please see the Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

License

The go-ethereum library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The go-ethereum binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.