smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-12-26 00:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
rhuairahrighairigh 2018-09-20 16:10:37 -04:00
parent 7a623ccea3
commit 058047919c
3 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/paychans.md
View File

@ -10,12 +10,12 @@ This initial implementation is for unidirectional channels. Channels can be open
## Create a channel ## Create a channel
kvcli paychan create --from <your account name> --to <receivers address> --amount 100KVA --chain-id <your chain ID> kvcli paychan create --from <your account name> --to <receivers address> --amount 100KVA
## Send an off-chain payment ## Send an off-chain payment
Send a payment for 10 KVA. Send a payment for 10 KVA.
kvcli paychan pay --from <your account name> --sen-amt 90KVA --rec-amt 10KVA --chan-id <ID of channel> --filename payment.json --chain-id <your chain ID> kvcli paychan pay --from <your account name> --sen-amt 90KVA --rec-amt 10KVA --chan-id <ID of channel> --filename payment.json
Send the file `payment.json` to your receiver. Then they run the following to verify. 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 ## Close a channel
The receiver can close immediately at any time. The receiver can close immediately at any time.
kvcli paychan submit --from <receiver's account name> --payment payment.json --chain-id <your chain ID> kvcli paychan submit --from <receiver's account name> --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. 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 <receiver's account name> --payment payment.json --chain-id <your chain ID> kvcli paychan submit --from <receiver's account name> --payment payment.json
>Note: The dispute period on the testnet is 30 seconds for ease of testing. >Note: The dispute period on the testnet is 30 seconds for ease of testing.

12
docs/setup.md
View File

@ -54,13 +54,17 @@ Requirements: go installed and set up (version 1.10+).
kvd init --name <your-name> --chain-id kava-test-2 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'. 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. > 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 Start your full node
@ -92,7 +96,6 @@ Then, your full running in the background or separate window, run:
--pubkey <you validator pubkey from above> \ --pubkey <you validator pubkey from above> \
--address-validator <your address from above> \ --address-validator <your address from above> \
--moniker "<your name>" \ --moniker "<your name>" \
--chain-id kava-test-2 \
--from <your name> \ --from <your name> \
--gas 1000000 --gas 1000000
@ -106,7 +109,6 @@ In order to stop validating, first remove yourself as validator, then you can st
kvcli stake unbond begin \ kvcli stake unbond begin \
--address-delegator <your address> \ --address-delegator <your address> \
--address-validator <your address> \ --address-validator <your address> \
--chain-id kava-test-2 \
--shares-percent 1 \ --shares-percent 1 \
--from <your name> \ --from <your name> \
--gas 1000000 --gas 1000000

3
docs/usage.md
View File

@ -13,7 +13,6 @@ List locally stored account addresses and their names. The name is used in other
kvcli send --from <your key name> \ kvcli send --from <your key name> \
--to <address> \ --to <address> \
--amount 100KVA \ --amount 100KVA
--chain-id kava-test-<current testnet #>