Go to file
obscuren a9d89d1f59 Merge branch 'develop' 2014-02-28 13:08:55 +01:00
ui Fixed connection button spamming 2014-02-28 12:18:19 +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 license name and updated block output from the dev console 2014-02-18 01:34:33 +01:00
README.md Updated readme 2014-02-28 12:17:43 +01:00
config.go Added some ui elements to make it easier to connect to nodes 2014-02-22 23:19:38 +01:00
dev_console.go Changed to new get keys method on database interface 2014-02-28 12:17:26 +01:00
ethereum.go Exit after importing a key 2014-02-28 12:17:02 +01:00
facet.png fixed about window 2014-02-28 13:08:41 +01:00
net.png Improved overall UI design and added a bunch of icons 2014-02-28 12:16:46 +01:00
net.pxm Improved overall UI design and added a bunch of icons 2014-02-28 12:16:46 +01:00
network.png Peer amount update 2014-02-21 13:23:35 +01:00
new.png Improved overall UI design and added a bunch of icons 2014-02-28 12:16:46 +01:00
test_app.qml Added some ui elements to make it easier to connect to nodes 2014-02-22 23:19:38 +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
transactions.qml Added transactions window 2014-02-23 01:56:04 +01:00
tx.png Improved overall UI design and added a bunch of icons 2014-02-28 12:16:46 +01:00
tx.pxm Improved overall UI design and added a bunch of icons 2014-02-28 12:16:46 +01:00
wallet.qml fixed about window 2014-02-28 13:08:41 +01:00

README.md

Ethereum

Build Status

Ethereum Go Client (c) Jeffrey Wilcke

The current state is "Proof of Concept 3". For build instructions see the Wiki.

For the development Go Package please see eth-go package.

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
-gui     Launch with GUI (= true)
-dir     Data directory used to store configs and databases (=".ethereum")
-import  Import a private key (hex)

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. 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.

To make life easier try git flow it sets this all up and streamlines your work flow.

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