interesting
/
go-ethereum
mirror of https://github.com/ethereum/go-ethereum.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
177 Commits 50 Branches 246 Tags 896 MiB
Go 89.2%
C 5.3%
JavaScript 3.5%
Assembly 0.5%
Shell 0.2%
Other 1%
Go to file
obscuren fe59a2b26d Updated to the great merge package 2014-02-15 00:05:04 +01:00
.gitignore added git ignore 2013-12-26 12:47:06 +01:00
.travis.yml sudo not udo 2014-01-10 10:59:57 +01:00
LICENSE Added MIT license #5 2014-01-25 16:45:51 +01:00
README.md Updated to the great merge package 2014-02-15 00:05:04 +01:00
config.go Use seed 2014-02-11 18:46:10 +01:00
dev_console.go Updated to the great merge package 2014-02-15 00:05:04 +01:00
ethereum.go Updated to the great merge package 2014-02-15 00:05:04 +01:00
test_runner.go gofmt no coding standards 2014-01-11 15:27:08 +01:00
test_runner_test.go Removed test 2014-02-06 23:47:04 +01:00
testing.go Removed dagger broadcasting to the net 2014-01-17 16:57:42 +01:00

README.md

Ethereum

Build Status

Ethereum Go developer client (c) Jeffrey Wilcke

Ethereum is currently in its testing phase. The current state is "Proof of Concept 2". For build instructions see the Wiki.

Ethereum Go is split up in several sub packages Please refer to each individual package for more information.

  1. eth
  2. ethchain
  3. ethwire
  4. ethdb
  5. ethutil

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 executable is the front-end (currently nothing but a dev console) for the Ethereum Go implementation.

Build

For build instruction please see the Wiki

Command line options

-c       Launch the developer console
-m       Start mining blocks
-genaddr Generates a new address and private key (destructive action)
-p       Port on which the server will accept incomming connections (= 30303)
-upnp    Enable UPnP (= false)
-x       Desired amount of peers (= 5)
-h       This help

Developer console commands

addp <host>:<port>     Connect to the given host
tx <addr> <amount>     Send <amount> Wei to the specified <addr>

See the "help" command for developer options.

Contribution

If you'd like to contribute to Ethereum Go please fork, fix, commit and send a pull request. Commits who do not comply with the coding standards are ignored.

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!)