go-dappley

README

go-dappley

Official Go implementation of the dappley protocol.

Building from source

Prerequisites

Components	Version	Description
Golang	>= 1.9.1	The Go Programming Language
Dep	>= 0.5.0	Dep is a dependency management tool for Go.

Please ensure GOPATH and GOROOT are set up correctly for dep to install all required dependencies. You may find this guide helpful.

For detailed instructions about the environment setup for go-dappley, please check out the wiki page.

Build

1. Checkout repo.

cd $GOPATH/src
go get -u -v github.com/dappley/go-dappley

1. Import dependencies and build.

cd github.com/dappley/go-dappley
make

Running Dapp

The executable is located in the dapp folder. Run the following command to bring up a full node in the network.

cd dapp
./dapp

Running Multiple Nodes On A Machine

Start a seed node

cd $GOPATH/src/github.com/dappley/go-dappley/dapp
./dapp -f conf/seed.conf

Start a peer node

./dapp -f conf/node.conf

Running Mutiple Nodes On Multiple Machines

Start a seed node

1. On your first machine, run ifconfig to find your ip address.

ifconfig

1. Run the following command to start your seed node.

cd $GOPATH/src/github.com/dappley/go-dappley/dapp
./dapp -f conf/seed.conf

Start a peer node

1. On your second machine, first go to your node.conf file

cd $GOPATH/src/github.com/dappley/go-dappley/dapp/conf
vim node.conf

1. Modify the ip address of your seed node. Replace <seed node ip address> with your seed node's ip address that you have found in the previous step

consensusConfig{
    minerAddr: "1ArH9WoB9F7i6qoJiAi7McZMFVQSsBKXZR"
    privKey: "bb23d2ff19f5b16955e8a24dca34dd520980fe3bddca2b3e1b56663f0ec1aa7e"
}

nodeConfig{
    port:   12346
    seed:   "/ip4/<seed node ip address>/tcp/12345/ipfs/QmNzA9rsEcM5nAzX9PzTrabJsGiifzaUU85Qe78HSDzSSE"
    dbPath: "../bin/node.db"
    rpcPort: 50052
}

1. Start your peer node

cd ../
./dapp -f conf/node.conf

Contribution

Thank you for considering helping with go-dappley project. Any contributions or suggestions are welcome. Please read the following instructions to get started.

Before you make any contribution, identify if it's a bug-fix or implementation of a complex idea. Please file an issue for bugs, then fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. For complex ideas, you'll need to discuss with maintainers in our Gitter or Telegram chanel first. This helps to prevent duplicated efforts and save other contributors time.

See Installation Instruction to configure your environment and follow Go formatting to keep the coding style consistent in the project. All pull requests should be based on the master branch. Please refer to Contribution Guideline for development practices in Dappley.

License

The go-dappley project is licensed under the GNU Lesser General Public License Version 3.0 (“LGPL v3”).