From c9777e163248e4fbf73de122acc7deb2301f12c3 Mon Sep 17 00:00:00 2001 From: rhuairahrighairigh Date: Tue, 18 Sep 2018 17:05:47 -0400 Subject: [PATCH] redo readme --- README.md | 150 +++--------------- .../x/paychan/README.md => docs/paychans.md | 0 docs/setup.md | 126 +++++++++++++++ docs/usage.md | 0 4 files changed, 147 insertions(+), 129 deletions(-) rename internal/x/paychan/README.md => docs/paychans.md (100%) create mode 100644 docs/setup.md create mode 100644 docs/usage.md diff --git a/README.md b/README.md index 12d1deb7..3a447074 100644 --- a/README.md +++ b/README.md @@ -3,137 +3,29 @@ A decentralized fast-finality blockchain for interoperable payment channel networks. -Building on the work of Tendermint and Interledger. -Project status: We're currently in a very early public testnet. With future features being implemented. +Providing a base layer currency to settle interoperable payments at high throughput. Leveraging fast finality to allow short cross currency channel timeouts. Proof of stake to provide performance and effective light clients. Payment channels to enable high volume low value transfers at realistic throughput. Streaming credit payments for effective routing and interoperability across chains. -Try it out - run a full node to sync to the testnet, [send some off chain payments](internal/x/paychan/README.md), or set up as a validator. +Proudly building on the work of [Cosmos](https://github.com/cosmos/cosmos-sdk) and [Interledger](https://github.com/interledger/rfcs). + +# Project Status +[![Testnet](https://img.shields.io/badge/testnet-live-brightgreen.svg)](http://validator.connector.kava.io:26657/abci_info) +[![Go Report Card](https://goreportcard.com/badge/github.com/kava-labs/kava)](https://goreportcard.com/report/github.com/kava-labs/kava) +![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg) + +We're currently in a very early public testnet, with future features being implemented. + +If you're interested in being a validator join the chat and checkout the setup instructions below. + +## Community + + - [Telegram](https://t.me/kavalabs) + - [Medium](https://medium.com/kava-labs) + - [Validator Chat](https://riot.im/app/#/room/#kava-validators:matrix.org) -## Install +# Find Out More - - -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 < - - - - -## Run a Full Node - - kvd init --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 - -Or, to start in background and send to log: - - 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). - - -## Run a Validator -Join the [validator chat](https://riot.im/app/#/room/#kava-validators:matrix.org). Follow setup for a full node above. - -Get you address with `kvcli keys list`. Should look something like `cosmosaccaddr10jpp289accvkhsvrpz4tlj9zhqdaey2tl9m4rg`. - -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 \ - --address-validator \ - --moniker "" \ - --chain-id kava-test-2 \ - --from \ - --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 \ - --address-validator \ - --chain-id kava-test-2 \ - --shares-percent 1 \ - --from \ - --gas 1000000 + - [Installation and Setup](docs/setup.md) + - [Basic Usage](docs/usage.md) + - [Payment Channels](docs/paychans.md) diff --git a/internal/x/paychan/README.md b/docs/paychans.md similarity index 100% rename from internal/x/paychan/README.md rename to docs/paychans.md diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 00000000..eea7d206 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1,126 @@ + +## 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 < + + + + +## Run a Full Node + + kvd init --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 + +Or, to start in background and send to log: + + 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). + + +## Run a Validator +Join the [validator chat](https://riot.im/app/#/room/#kava-validators:matrix.org). Follow setup for a full node above. + +Get you address with `kvcli keys list`. Should look something like `cosmosaccaddr10jpp289accvkhsvrpz4tlj9zhqdaey2tl9m4rg`. + +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 \ + --address-validator \ + --moniker "" \ + --chain-id kava-test-2 \ + --from \ + --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 \ + --address-validator \ + --chain-id kava-test-2 \ + --shares-percent 1 \ + --from \ + --gas 1000000 diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 00000000..e69de29b