From 058047919cce270067ed390bd8d5b1ad1097327e Mon Sep 17 00:00:00 2001 From: rhuairahrighairigh Date: Thu, 20 Sep 2018 16:10:37 -0400 Subject: [PATCH] update docs --- docs/paychans.md | 8 ++++---- docs/setup.md | 12 +++++++----- docs/usage.md | 3 +-- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/paychans.md b/docs/paychans.md index aa5f19ec..9036dd56 100644 --- a/docs/paychans.md +++ b/docs/paychans.md @@ -10,12 +10,12 @@ This initial implementation is for unidirectional channels. Channels can be open ## Create a channel - kvcli paychan create --from --to --amount 100KVA --chain-id + kvcli paychan create --from --to --amount 100KVA ## Send an off-chain payment Send a payment for 10 KVA. - kvcli paychan pay --from --sen-amt 90KVA --rec-amt 10KVA --chan-id --filename payment.json --chain-id + kvcli paychan pay --from --sen-amt 90KVA --rec-amt 10KVA --chan-id --filename payment.json Send the file `payment.json` to your receiver. Then they run the following to verify. @@ -24,11 +24,11 @@ Send the file `payment.json` to your receiver. Then they run the following to ve ## Close a channel The receiver can close immediately at any time. - kvcli paychan submit --from --payment payment.json --chain-id + kvcli paychan submit --from --payment payment.json The sender can submit a close request, causing the channel will close automatically after a dispute period. During this period a receiver can still close immediately, overruling the sender's request. - kvcli paychan submit --from --payment payment.json --chain-id + kvcli paychan submit --from --payment payment.json >Note: The dispute period on the testnet is 30 seconds for ease of testing. diff --git a/docs/setup.md b/docs/setup.md index f015ba07..ca7f6a85 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -54,13 +54,17 @@ Requirements: go installed and set up (version 1.10+). 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'. +Enter a new password for your validator key. This will generate config and keys in `$HOME/.kvd` and `$HOME/.kvcli`. > 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. +Copy the testnet genesis file into `$HOME/.kvd/config/` and `$HOME/.kvcli/config/`, replacing the existing one: -Add the kava node address, `5c2bc5a95b014e4b2897791565398ee6bfd0a04a@validator.connector.kava.io:26656`, to `seeds` in `$HOME/.kvd/config/config.toml` + curl https://raw.githubusercontent.com/Kava-Labs/kava/master/testnets/kava-test-2/genesis.json > tee $HOME/.kvd/config/ $HOME/.kvcli/config/ + +Add the kava node to the list of seed nodes in the config: + + sed -i '' 's/seeds = ""/seeds = "5c2bc5a95b014e4b2897791565398ee6bfd0a04a@validator.connector.kava.io:26656"/g' $HOME/.kvd/config/config.toml Start your full node @@ -92,7 +96,6 @@ Then, your full running in the background or separate window, run: --pubkey \ --address-validator \ --moniker "" \ - --chain-id kava-test-2 \ --from \ --gas 1000000 @@ -106,7 +109,6 @@ In order to stop validating, first remove yourself as validator, then you can st 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 index a24287fd..83addf57 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -13,7 +13,6 @@ List locally stored account addresses and their names. The name is used in other kvcli send --from \ --to
\ - --amount 100KVA \ - --chain-id kava-test- + --amount 100KVA