0g-chain/docs/setup.md

113 lines
4.1 KiB
Markdown
Raw Normal View History

2018-09-18 21:05:47 +00:00
2018-09-18 23:14:46 +00:00
# Installation and Setup
#### Who this guide is for
The blockchain code currently consists of a full node daemon (`kvd`) and it's command line interface (`kvcli`).
Full nodes are fairly resource intensive and are designed to be run continuously on servers, primarily by people validating the network. While it is possible to run locally it is not recommended unless for development purposes. In the future light clients will enable secure transactions for clients.
A **full node** syncs with the blockchain and processes transactions. A **validator** is a full node that has declared itself to be a "validator" on chain. This obligates it to participate in consensus by proposing and signing blocks and maintaining uptime. By not following the protocol, the validator's stake will be slashed.
Use the following instructions to set up a full node, and to optionally declare yourself as a validator.
2018-09-18 21:05:47 +00:00
## Install
Requirements: go installed and set up (version 1.10+).
0. If installing from a new Ubuntu server (16.04 or 18.04), here's how to setup go:
sudo apt update
sudo apt upgrade -y
sudo apt install git gcc make wget -y
wget https://dl.google.com/go/go1.10.3.linux-amd64.tar.gz
sudo tar -xvf go1.10.3.linux-amd64.tar.gz
sudo mv go /usr/local
cat >> ~/.profile <<EOF
export GOROOT=/usr/local/go
export GOPATH=\$HOME/go
export PATH=\$GOPATH/bin:\$GOROOT/bin:\$PATH
EOF
source ~/.profile
1. Get the code.
mkdir -p $GOPATH/src/github.com/kava-labs
cd $GOPATH/src/github.com/kava-labs
git clone https://github.com/kava-labs/kava
cd kava
git checkout 8c9406c
2. Install the dependencies.
mkdir $GOPATH/bin
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
2018-09-18 23:14:46 +00:00
dep ensure -vendor-only
2018-09-18 21:05:47 +00:00
3. Install the code
go install ./cmd/kvd
go install ./cmd/kvcli
## Run a Full Node
kvd init --name <your-name> --chain-id kava-test-2
This will generate config and keys in `$HOME/.kvd` and `$HOME/.kvcli`. The default password is 'password'.
> Note: Make sure `GOBIN` is set and added to your path if you want to be able to run installed go programs from any folder.
Copy the testnet genesis file (from https://raw.githubusercontent.com/Kava-Labs/kava/master/testnets/kava-test-2/genesis.json) into `$HOME/.kvd/config/`, replacing the existing one.
Add the kava node address, `5c2bc5a95b014e4b2897791565398ee6bfd0a04a@validator.connector.kava.io:26656`, to `seeds` in `$HOME/.kvd/config/config.toml`
Start your full node
kvd start
2018-09-18 23:14:46 +00:00
Or, to start in background and capture output in a log file:
2018-09-18 21:05:47 +00:00
kvd start &> kvd.log &
To see the output of the log:
tail -f kvd.log
> Note: It might take a while to fully sync. Check the latest block height [here](http://validator.connector.kava.io:26657/abci_info).
2018-09-18 23:14:46 +00:00
## Become a Validator
2018-09-18 21:05:47 +00:00
Join the [validator chat](https://riot.im/app/#/room/#kava-validators:matrix.org). Follow setup for a full node above.
2018-09-18 23:14:46 +00:00
Get you address with `kvcli keys list`.
2018-09-18 21:05:47 +00:00
Ask @rhuairahrighairidh in the chat to give you some coins.
Get your validator pubkey with `kvd tendermint show_validator`
Then, your full running in the background or separate window, run:
kvcli stake create-validator \
--amount 900KVA \
--pubkey <you validator pubkey from above> \
--address-validator <your address from above> \
--moniker "<your name>" \
--chain-id kava-test-2 \
--from <your name> \
--gas 1000000
> Note You'll need to type in the default password "password"
Now your full node should be participating in consensus and validating blocks!
Running a validator requires that you keep validating blocks. If you stop, your stake will be slashed.
In order to stop validating, first remove yourself as validator, then you can stop your node.
kvcli stake unbond begin \
--address-delegator <your address> \
--address-validator <your address> \
--chain-id kava-test-2 \
--shares-percent 1 \
--from <your name> \
--gas 1000000