update cli docs for launch (#1144)

Co-authored-by: Sam Hadi <worker@Sams-MacBook-Pro.local>
This commit is contained in:
samcode206 2022-01-19 10:58:15 -08:00 committed by GitHub
parent 535dc7d470
commit 31b8ed2276
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 66 additions and 60 deletions

View File

@ -1,7 +1,7 @@
<!-- <!--
title: vote title: vote
--> -->
## kvcli tx committee vote ## kava tx committee vote
Vote for an active proposal Vote for an active proposal
@ -10,13 +10,13 @@ Vote for an active proposal
Submit a ```[yes/no/abstain]``` vote for the proposal with id ```[proposal-id]```. Submit a ```[yes/no/abstain]``` vote for the proposal with id ```[proposal-id]```.
``` ```
kvcli tx committee vote [proposal-id] [vote] [flags] kava tx committee vote [proposal-id] [vote] [flags]
``` ```
### Examples ### Examples
``` ```
kvcli tx committee vote 2 yes kava tx committee vote 2 yes
``` ```
### Options ### Options

View File

@ -1,7 +1,7 @@
<!-- <!--
title: committee title: committee
--> -->
## kvcli tx gov submit-proposal committee ## kava tx gov submit-proposal committee
Submit a governance proposal to change a committee. Submit a governance proposal to change a committee.
@ -61,7 +61,7 @@ and to delete a committee:
``` ```
``` ```
kvcli tx gov submit-proposal committee [proposal-file] [deposit] [flags] kava tx gov submit-proposal committee [proposal-file] [deposit] [flags]
``` ```
### Options ### Options

View File

@ -1,7 +1,7 @@
<!-- <!--
title: param-change title: param-change
--> -->
## kvcli tx gov submit-proposal param-change ## kava tx gov submit-proposal param-change
Submit a parameter change proposal Submit a parameter change proposal
@ -22,7 +22,7 @@ regardless.
Example: Example:
``` ```
$ kvcli tx gov submit-proposal param-change <path/to/proposal.json> --from=<key_or_address> $ kava tx gov submit-proposal param-change <path/to/proposal.json> --from=<key_or_address>
``` ```
Where proposal.json contains: Where proposal.json contains:
@ -46,7 +46,7 @@ Where proposal.json contains:
} }
``` ```
``` ```
kvcli tx gov submit-proposal param-change [proposal-file] [flags] kava tx gov submit-proposal param-change [proposal-file] [flags]
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Borrow tokens from the hard protocol
## Command ## Command
``` ```
kvcli tx hard borrow <amount> <flags> kava tx hard borrow <amount> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```borrow``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```borrow``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -18,7 +18,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx hard borrow 1000000000ukava --from <key> kava tx hard borrow 1000000000ukava --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Deposit coins to hard
## Command ## Command
``` ```
kvcli tx hard deposit <amount> <flags> kava tx hard deposit <amount> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```deposit``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```deposit``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -18,7 +18,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx hard deposit 10000000bnb --from <key> kava tx hard deposit 10000000bnb --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Repay tokens to the hard protocol
## Command ## Command
``` ```
kvcli tx hard repay <amount> <flags> kava tx hard repay <amount> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```repay``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```repay``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -18,9 +18,9 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx hard repay 1000000000ukava --from <key> kava tx hard repay 1000000000ukava --from <key>
kvcli tx hard repay 1000000000ukava,25000000000bnb --from <key> kava tx hard repay 1000000000ukava,25000000000bnb --from <key>
kvcli tx hard repay 1000000000ukava,25000000000bnb --owner <owner-address> --from <key> kava tx hard repay 1000000000ukava,25000000000bnb --owner <owner-address> --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Withdraw coins from hard
## Command ## Command
``` ```
kvcli tx hard withdraw <amount> <flags> kava tx hard withdraw <amount> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```hard```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -18,7 +18,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx hard withdraw 10000000bnb --from <key> kava tx hard withdraw 10000000bnb --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Create a new cdp, depositing some collateral and drawing some debt.
## Command ## Command
``` ```
kvcli tx cdp create <collateral> <debt> <collateral-type> <flags> kava tx cdp create <collateral> <debt> <collateral-type> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```create``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```create``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -20,7 +20,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx cdp create 10000000uatom 1000usdx atom-a --from myKeyName kava tx cdp create 10000000uatom 1000usdx atom-a --from myKeyName
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Add collateral to an existing cdp.
## Command ## Command
``` ```
kvcli tx cdp deposit <owner-addr> <collateral> <collateral-type> <flags> kava tx cdp deposit <owner-addr> <collateral> <collateral-type> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```deposit``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```deposit``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -20,7 +20,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx cdp deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName kava tx cdp deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Create debt in an existing cdp and send the newly minted asset to your account.
## Command ## Command
``` ```
kvcli tx cdp draw <collateral-type> <debt> <flags> kava tx cdp draw <collateral-type> <debt> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```draw``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```draw``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -20,7 +20,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx cdp draw atom-a 1000usdx --from myKeyName kava tx cdp draw atom-a 1000usdx --from myKeyName
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Repay debt to an existing cdp
## Command ## Command
``` ```
kvcli tx cdp repay <collateral-name> <debt> <flags> kava tx cdp repay <collateral-name> <debt> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```repay``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```repay``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -19,7 +19,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx cdp repay atom-a 1000usdx --from myKeyName kava tx cdp repay atom-a 1000usdx --from myKeyName
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Withdraw collateral from an existing cdp
## Command ## Command
``` ```
kvcli tx cdp withdraw <owner-addr> <collateral> <collateral-type> <flags> kava tx cdp withdraw <owner-addr> <collateral> <collateral-type> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```cdp```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -20,7 +20,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx cdp withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName kava tx cdp withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Deposit coins to a swap liquidity pool
## Command ## Command
``` ```
kvcli tx swap deposit <tokenA> <tokenB> <slippage> <deadline> <flags> kava tx swap deposit <tokenA> <tokenB> <slippage> <deadline> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```deposit``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```deposit``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -22,7 +22,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx swap deposit 10000000ukava 10000000usdx 0.01 1624224736 --from <key> kava tx swap deposit 10000000ukava 10000000usdx 0.01 1624224736 --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Swap an exact amount of token a for token b
## Command ## Command
``` ```
kvcli tx swap swap-exact-for-tokens <exactCoinA> <coinB> <slippage> <deadline> <flags> kava tx swap swap-exact-for-tokens <exactCoinA> <coinB> <slippage> <deadline> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```swap-exact-for-tokens``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```swap-exact-for-tokens``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -21,7 +21,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx swap swap-exact-for-tokens 1000000ukava 5000000usdx 0.01 1624224736 --from <key> kava tx swap swap-exact-for-tokens 1000000ukava 5000000usdx 0.01 1624224736 --from <key>
``` ```
### Options ### Options

View File

@ -4,10 +4,10 @@ Withdraw coins from a swap liquidity pool
## Command ## Command
``` ```
kvcli tx swap withdraw <shares> <minCoinA> <minCoinB> <deadline> <flags> kava tx swap withdraw <shares> <minCoinA> <minCoinB> <deadline> <flags>
``` ```
Using ```kvcli``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags. Using ```kava``` call the ```tx``` subcommand followed by the module name which is```swap```, then define the action which is ```withdraw``` and finally follow up with required arguments or flags.
### Arguments ### Arguments
position|name|expects position|name|expects
@ -22,7 +22,7 @@ position|name|expects
### Example ### Example
``` ```
kvcli tx swap withdraw 153000 10000000ukava 20000000usdx 176293740 --from <key> kava tx swap withdraw 153000 10000000ukava 20000000usdx 176293740 --from <key>
``` ```
### Options ### Options

View File

@ -6,65 +6,71 @@ order: 1
### Get a list of all keys ### Get a list of all keys
``` ```
kvcli keys list kava keys list
``` ```
### Query Account Tokens ### Query Account
``` ```
kvcli q accounts <kava-addr> kava q account <kava-addr>
``` ```
### View Staking Delegations ### View Staking Delegations
``` ```
kvcli q staking delegations <kava-addr> kava q staking delegations <kava-addr>
``` ```
### Claim staking rewards ### Claim staking rewards
``` ```
kvcli tx distribution withdraw-all-rewards --gas 650000 --gas-prices 0.01ukava --from <kava-addr or key name> kava tx distribution withdraw-all-rewards --gas 650000 --gas-prices 0.01ukava --from <kava-addr or key name>
``` ```
### Querying outstanding staking rewards ### Querying outstanding staking rewards
``` ```
kvcli q distribution rewards <kava-addr> kava q distribution rewards <kava-addr>
``` ```
### Claim staking from individual validator ### Claim staking from individual validator
``` ```
kvcli tx distribution withdraw-rewards <kava-validator-addre (starts with kavavaloper)> --gas 650000 --gas-prices 0.01ukava --from <kava-addr or key name> kava tx distribution withdraw-rewards <kava-validator-addre (starts with kavavaloper)> --gas 650000 --gas-prices 0.01ukava --from <kava-addr or key name>
``` ```
### Claiming KAVA Delegator rewards (yielding HARD and SWP) ### Claiming KAVA Delegator rewards (yielding HARD and SWP)
``` ```
kvcli tx incentive claim-delegator --multiplier hard=large,swp=large --from <kava-addr or key name> --gas 800000 --gas-prices 0.01ukava kava tx incentive claim-delegator --multiplier hard=large,swp=large --from <kava-addr or key name> --gas 800000 --gas-prices 0.01ukava
``` ```
### Querying outstanding HARD rewards ### Querying outstanding HARD rewards
``` ```
kvcli q incentive rewards --type delegator --owner <kava-address> kava q incentive rewards --type delegator --owner <kava-address>
``` ```
### View HARD Incentives ### View HARD Incentives
``` ```
kvcli q incentive rewards --type hard --owner <kava-address> kava q incentive rewards --type hard --owner <kava-address>
``` ```
### Claim HARD Incentives ### Claim HARD Incentives
``` ```
kvcli tx incentive claim-hard --multiplier hard=large --multiplier ukava=large --from <kava-addr or key name> --gas 800000 --gas-prices 0.01ukava kava tx incentive claim-hard --multiplier hard=large --multiplier ukava=large --from <kava-addr or key name> --gas 800000 --gas-prices 0.01ukava
``` ```
### Send Coins ### Send Coins
``` ```
kvcli tx send <key_name> <kava-account> <amount (100ukava for example)> --memo [memo] --gas-prices 0.01ukava kava tx bank send <from> <to> <amount (100ukava for example)> --memo [memo] --gas-prices 0.01ukava
``` ```
### Query Transaction Status Using TX Hash ### Query Transaction Status Using TX Hash
``` ```
kvcli q tx <tx_hash> kava q tx <tx_hash>
``` ```
### Query Transactions Using events
```
kava q txs --events message.actions=swap_deposit
```
### Adding a Key to Ledger ### Adding a Key to Ledger
``` ```
kvcli keys add <key-name> --account <account-index> --legacy-hd-path --ledger kava keys add <key-name> --account <account-index> --legacy-hd-path --ledger
``` ```