From bbf37bdad3ccc61a2fd1b50320461825675f19d7 Mon Sep 17 00:00:00 2001 From: Sam Hadi Date: Wed, 10 Nov 2021 11:44:02 -0800 Subject: [PATCH] added CLI docs --- docs/.vuepress/config.js | 203 +++++++++++------- docs/education/application_process.md | 3 + docs/education/hello_kava.md | 3 + docs/education/kava_dao_governance.md | 3 + docs/education/lite_paper.md | 3 + docs/education/mainnet_upgrade.md | 3 + docs/education/testnet.md | 3 + .../user_actions/Basics/quick_guide.md | 67 ++++++ docs/education/user_actions/CDP/cdp_create.md | 52 +++++ .../education/user_actions/CDP/cdp_deposit.md | 52 +++++ docs/education/user_actions/CDP/cdp_draw.md | 51 +++++ docs/education/user_actions/CDP/cdp_repay.md | 53 +++++ .../user_actions/CDP/cdp_withdraw.md | 52 +++++ .../user_actions/HARD/hard_borrow.md | 51 +++++ .../user_actions/HARD/hard_deposit.md | 54 +++++ .../education/user_actions/HARD/hard_repay.md | 57 +++++ .../user_actions/HARD/hard_withdraw.md | 54 +++++ .../user_actions/SWAP/swap_deposit.md | 57 +++++ .../user_actions/SWAP/swap_tokens.md | 57 +++++ .../user_actions/SWAP/swap_withdraw.md | 57 +++++ 20 files changed, 852 insertions(+), 83 deletions(-) create mode 100644 docs/education/application_process.md create mode 100644 docs/education/hello_kava.md create mode 100644 docs/education/kava_dao_governance.md create mode 100644 docs/education/lite_paper.md create mode 100644 docs/education/mainnet_upgrade.md create mode 100644 docs/education/testnet.md create mode 100644 docs/education/user_actions/Basics/quick_guide.md create mode 100644 docs/education/user_actions/CDP/cdp_create.md create mode 100644 docs/education/user_actions/CDP/cdp_deposit.md create mode 100644 docs/education/user_actions/CDP/cdp_draw.md create mode 100644 docs/education/user_actions/CDP/cdp_repay.md create mode 100644 docs/education/user_actions/CDP/cdp_withdraw.md create mode 100644 docs/education/user_actions/HARD/hard_borrow.md create mode 100644 docs/education/user_actions/HARD/hard_deposit.md create mode 100644 docs/education/user_actions/HARD/hard_repay.md create mode 100644 docs/education/user_actions/HARD/hard_withdraw.md create mode 100644 docs/education/user_actions/SWAP/swap_deposit.md create mode 100644 docs/education/user_actions/SWAP/swap_tokens.md create mode 100644 docs/education/user_actions/SWAP/swap_withdraw.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index c428cb14..1fff5db5 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,141 +1,178 @@ module.exports = { - theme: "cosmos", - title: "Kava Documentation", - themeConfig: { - logo: { - src: "/logo.svg", + "theme": "cosmos", + "title": "Kava Documentation", + "themeConfig": { + "logo": { + "src": "/logo.svg" }, - custom: true, - sidebar: { - auto: false, - nav: [ + "custom": true, + "sidebar": { + "auto": false, + "nav": [ { - title: "Reference", - children: [ + "title": "Intro to Kava Platform", + "children": [ { - title: "Modules", - path: "/Modules", - directory: true - }, - ] - }, - { - title: "Kava Tools", - children: [ - { - title: "Chainlink Price Oracle", - path: "/tools/oracle.html" + "title": "Application Process", + "path": "/education/application_process.html" }, { - title: "Community Tools", - path: "/tools/community.html", - }, - { - title: "Sentinel", - path: "/tools/sentinel.html", - }, - { - title: "Auction Bot", - path: "/tools/auction.html", + "title": "Development Process", + "children": [ + { + "title": "Kava DAO Governance", + "path": "/education/kava_dao_governance.html", + }, + { + "title": "Testnet", + "path": "/education/testnet.html", + }, + { + "title": "Mainnet upgrade", + "path": "/education/mainnet_upgrade.html", + } + ] } ] }, { - title: "Building on Kava", - children: [ + "title": "Getting Started - Developers", + "children": [ { - title: "JavaScript SDK", - path: "/building/javascript-sdk.html" + "title": "Hello Kava", + "path": "/education/hello_kava.html" + }, + { + "title": "Javascript SDK", + "path": "/building/javascript-sdk.html" + }, + { + "title": "Run Validator Node", + "path": "/validator_guide" + }, + { + "title": "Run Bots", + "children": [ + { + "title": "Sentinel Bot", + "path": "/tools/sentinel.html" + }, + { + "title": "Auction Bot", + "path": "/tools/auction.html" + } + ] + }, + { + "title": "Migration Guide", + "path": "/kava-8", + "directory": true } ] }, { - title: "Resources", - children: [ + "title": "Resources", + "children": [ { - title: "REST API Spec", - path: "https://swagger.kava.io/" + "title": "Lite Paper", + "path": "/education/lite_paper.html" }, { - title: "Protocol Reference", - path: "https://pkg.go.dev/github.com/kava-labs/kava?tab=subdirectories" + "title": "Community Tools", + "path": "/tools/community.html" + }, + { + "title": "Module Specs", + "path": "/Modules", + "directory": true, + }, + { + "title": "CLI Docs", + "path": "/education/user_actions/", + "directory": true, + }, + { + "title": "REST API Spec", + "path": "https://swagger.kava.io/" + }, + { + "title": "Protocol Reference", + "path": "https://pkg.go.dev/github.com/kava-labs/kava?tab=subdirectories" } ] } ] }, - footer: { - logo: "/logo.svg", - textLink: { - text: "kava.io", - url: "https://www.kava.io" + "footer": { + "logo": "/logo.svg", + "textLink": { + "text": "kava.io", + "url": "https://www.kava.io" }, - services: [ + "services": [ { - service: "twitter", - url: "https://twitter.com/kava_platform" + "service": "twitter", + "url": "https://twitter.com/kava_platform" }, { - service: "medium", - url: "https://medium.com/kava-labs" + "service": "medium", + "url": "https://medium.com/kava-labs" }, { - service: "telegram", - url: "https://t.me/kavalabs" + "service": "telegram", + "url": "https://t.me/kavalabs" }, { - service: "discord", - url: "https://discord.gg/JJYnuCx" + "service": "discord", + "url": "https://discord.gg/JJYnuCx" }, { - service: "github", - url: "https://github.com/kava-labs" + "service": "github", + "url": "https://github.com/kava-labs" } ], - smallprint: - `© ${new Date().getFullYear()} Kava Labs.`, - links: [ + "smallprint": "© 2021 Kava Labs.", + "links": [ { - title: "Community", - children: [ + "title": "Community", + "children": [ { - title: "Blog", - url: "https://medium.com/kava-labs" + "title": "Blog", + "url": "https://medium.com/kava-labs" }, { - title: "Chat", - url: "https://t.me/kavalabs" + "title": "Chat", + "url": "https://t.me/kavalabs" } ] }, { - title: "Contributing", - children: [ + "title": "Contributing", + "children": [ { - title: "Contributing to the docs", - url: - "https://github.com/Kava-Labs/kava/tree/master/docs" + "title": "Contributing to the docs", + "url": "https://github.com/Kava-Labs/kava/tree/master/docs" }, { - title: "Source code on GitHub", - url: "https://github.com/Kava-Labs/kava" + "title": "Source code on GitHub", + "url": "https://github.com/Kava-Labs/kava" } ] }, { - title: "Related Docs", - children: [ + "title": "Related Docs", + "children": [ { - title: "Cosmos SDK", - url: "https://cosmos.network/docs" + "title": "Cosmos SDK", + "url": "https://cosmos.network/docs" }, { - title: "Binance Chain", - url: "https://docs.binance.org" + "title": "Binance Chain", + "url": "https://docs.binance.org" } ] - }, + } ] } } -}; +} \ No newline at end of file diff --git a/docs/education/application_process.md b/docs/education/application_process.md new file mode 100644 index 00000000..e80e3a56 --- /dev/null +++ b/docs/education/application_process.md @@ -0,0 +1,3 @@ +# Application Process + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/hello_kava.md b/docs/education/hello_kava.md new file mode 100644 index 00000000..12e19b9b --- /dev/null +++ b/docs/education/hello_kava.md @@ -0,0 +1,3 @@ +# Hello Kava + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/kava_dao_governance.md b/docs/education/kava_dao_governance.md new file mode 100644 index 00000000..bff5d432 --- /dev/null +++ b/docs/education/kava_dao_governance.md @@ -0,0 +1,3 @@ +# Kava DAO Governance + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/lite_paper.md b/docs/education/lite_paper.md new file mode 100644 index 00000000..abe9a443 --- /dev/null +++ b/docs/education/lite_paper.md @@ -0,0 +1,3 @@ +# Lite Paper + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/mainnet_upgrade.md b/docs/education/mainnet_upgrade.md new file mode 100644 index 00000000..1baf571f --- /dev/null +++ b/docs/education/mainnet_upgrade.md @@ -0,0 +1,3 @@ +# Mainnet Upgrade + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/testnet.md b/docs/education/testnet.md new file mode 100644 index 00000000..9ecea8d4 --- /dev/null +++ b/docs/education/testnet.md @@ -0,0 +1,3 @@ +# Testnet + +We are working on updating our entire documentation to provide a better user experience, please check back later! \ No newline at end of file diff --git a/docs/education/user_actions/Basics/quick_guide.md b/docs/education/user_actions/Basics/quick_guide.md new file mode 100644 index 00000000..ee41d051 --- /dev/null +++ b/docs/education/user_actions/Basics/quick_guide.md @@ -0,0 +1,67 @@ +## Quick Overview +short on time? Read these and get a refresher of the most commont commands. + +### Get a list of all keys +``` +kvcli keys list +``` + +### Query Account Tokens +``` +kvcli q accounts +``` + +### View Staking Delegations +``` +kvcli q staking delegations +``` + +### Claim staking rewards +``` +kvcli tx distribution withdraw-all-rewards --gas 650000 --gas-prices 0.01ukava --from +``` + +### Querying outstanding staking rewards +``` +kvcli q distribution rewards +``` + +### Claim staking from individual validator +``` +kvcli tx distribution withdraw-rewards --gas 650000 --gas-prices 0.01ukava --from +``` + +### Claiming KAVA Delegator rewards (yielding HARD and SWP) +``` +kvcli tx incentive claim-delegator --multiplier hard=large,swp=large --from --gas 800000 --gas-prices 0.01ukava +``` + +### Querying outstanding HARD rewards +``` +kvcli q incentive rewards --type delegator --owner +``` + +### View HARD Incentives +``` +kvcli q incentive rewards --type hard --owner +``` + +### Claim HARD Incentives +``` +kvcli tx incentive claim-hard --multiplier hard=large --multiplier ukava=large --from --gas 800000 --gas-prices 0.01ukava +``` + +### Send Coins +``` +kvcli tx send --memo [memo] --gas-prices 0.01ukava +``` + +### Query Transaction Status Using TX Hash +``` +kvcli q tx +``` + +### Adding a Key to Ledger +``` +kvcli keys add --account --legacy-hd-path --ledger +``` \ No newline at end of file diff --git a/docs/education/user_actions/CDP/cdp_create.md b/docs/education/user_actions/CDP/cdp_create.md new file mode 100644 index 00000000..81e69678 --- /dev/null +++ b/docs/education/user_actions/CDP/cdp_create.md @@ -0,0 +1,52 @@ +# Create New CDP + +Create a new cdp, depositing some collateral and drawing some debt. + +## Command +``` +kvcli tx cdp create +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|collateral| amount & name (no spaces) +2|debt| amount & name (no spaces) +3|collateral-type| name + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx cdp create 10000000uatom 1000usdx atom-a --from myKeyName +``` + +### Options +``` +-a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for create + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation +``` + +### Options inherited from parent commands +``` +--chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/CDP/cdp_deposit.md b/docs/education/user_actions/CDP/cdp_deposit.md new file mode 100644 index 00000000..6fe68d75 --- /dev/null +++ b/docs/education/user_actions/CDP/cdp_deposit.md @@ -0,0 +1,52 @@ +# Add Collateral + +Add collateral to an existing cdp. + +## Command +``` +kvcli tx cdp deposit +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|owner-addr| kava address +2|collateral| amount & name (no spaces) +3|collateral-type| name + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx cdp deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName +``` + +### Options +``` +-a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for deposit + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation +``` + +### Options inherited from parent commands +``` + --chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/CDP/cdp_draw.md b/docs/education/user_actions/CDP/cdp_draw.md new file mode 100644 index 00000000..7452459c --- /dev/null +++ b/docs/education/user_actions/CDP/cdp_draw.md @@ -0,0 +1,51 @@ +# Draw Debt + +Create debt in an existing cdp and send the newly minted asset to your account. + +## Command +``` +kvcli tx cdp draw +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|collateral-type| name +2|debt| amount & name (no spaces) + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx cdp draw atom-a 1000usdx --from myKeyName +``` + +### Options +``` +-a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for draw + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation +``` + +### Options inherited from parent commands +``` + --chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/CDP/cdp_repay.md b/docs/education/user_actions/CDP/cdp_repay.md new file mode 100644 index 00000000..5f958a59 --- /dev/null +++ b/docs/education/user_actions/CDP/cdp_repay.md @@ -0,0 +1,53 @@ +# Repay Debt + +repay debt to an existing cdp + +## Command +``` +kvcli tx cdp repay +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|collateral-name| name +2|debt| amount & name (no spaces) + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx cdp repay atom-a 1000usdx --from myKeyName +``` + +### Options +``` +-a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for repay + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + + --chain-id string Chain ID of tendermint node + +``` + +### Options inherited from parent commands +``` +--chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/CDP/cdp_withdraw.md b/docs/education/user_actions/CDP/cdp_withdraw.md new file mode 100644 index 00000000..5ce961f9 --- /dev/null +++ b/docs/education/user_actions/CDP/cdp_withdraw.md @@ -0,0 +1,52 @@ +# Remove Collateral + +withdraw collateral from an existing cdp + +## Command +``` +kvcli tx cdp withdraw +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|owner-addr| kava address +2|collateral| amount & name (no spaces) +3|collateral-type| name + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx cdp withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName +``` + +### Options +``` +-a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for withdraw + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation +``` + +### Options inherited from parent commands +``` + --chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/HARD/hard_borrow.md b/docs/education/user_actions/HARD/hard_borrow.md new file mode 100644 index 00000000..bf445599 --- /dev/null +++ b/docs/education/user_actions/HARD/hard_borrow.md @@ -0,0 +1,51 @@ +# Borrow + +borrow tokens from the hard protocol + +## Command +``` +kvcli tx hard borrow +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|amount| amount & name (no spaces) + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx hard borrow 1000000000ukava --from +``` + +### Options +``` + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for borrow + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + --chain-id string Chain ID of tendermint node +``` \ No newline at end of file diff --git a/docs/education/user_actions/HARD/hard_deposit.md b/docs/education/user_actions/HARD/hard_deposit.md new file mode 100644 index 00000000..fa6968c1 --- /dev/null +++ b/docs/education/user_actions/HARD/hard_deposit.md @@ -0,0 +1,54 @@ +# Deposit + +deposit coins to hard + +## Command +``` +kvcli tx hard deposit +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|amount| amount & name (no spaces) + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx hard deposit 10000000bnb --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for deposit + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file diff --git a/docs/education/user_actions/HARD/hard_repay.md b/docs/education/user_actions/HARD/hard_repay.md new file mode 100644 index 00000000..737e2642 --- /dev/null +++ b/docs/education/user_actions/HARD/hard_repay.md @@ -0,0 +1,57 @@ +# Repay + +repay tokens to the hard protocol + +## Command +``` +kvcli tx hard repay +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|amount| amount & name (no spaces) + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx hard repay 1000000000ukava --from +kvcli tx hard repay 1000000000ukava,25000000000bnb --from +kvcli tx hard repay 1000000000ukava,25000000000bnb --owner --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for repay + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + --owner string original borrower's address whose loan will be repaid + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file diff --git a/docs/education/user_actions/HARD/hard_withdraw.md b/docs/education/user_actions/HARD/hard_withdraw.md new file mode 100644 index 00000000..5583cbd9 --- /dev/null +++ b/docs/education/user_actions/HARD/hard_withdraw.md @@ -0,0 +1,54 @@ +# Withdraw + +withdraw coins from hard + +## Command +``` +kvcli tx hard withdraw +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|amount| amount & name (no spaces) + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx hard withdraw 10000000bnb --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for withdraw + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file diff --git a/docs/education/user_actions/SWAP/swap_deposit.md b/docs/education/user_actions/SWAP/swap_deposit.md new file mode 100644 index 00000000..937dd47c --- /dev/null +++ b/docs/education/user_actions/SWAP/swap_deposit.md @@ -0,0 +1,57 @@ +# Deposit + +deposit coins to a swap liquidity pool + +## Command +``` +kvcli tx swap deposit +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|tokenA| amount & name (no spaces) +2|tokenB| amount & name (no spaces) +3|slippage| percentage float +4|deadline| timestamp + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx swap deposit 10000000ukava 10000000usdx 0.01 1624224736 --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for deposit + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file diff --git a/docs/education/user_actions/SWAP/swap_tokens.md b/docs/education/user_actions/SWAP/swap_tokens.md new file mode 100644 index 00000000..da359d42 --- /dev/null +++ b/docs/education/user_actions/SWAP/swap_tokens.md @@ -0,0 +1,57 @@ +# Swap Tokens + +swap an exact amount of token a for token b + +## Command +``` +kvcli tx swap swap-exact-for-tokens +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|exactCoinA| exact amount & name (no spaces) +2|coinB| amount & name (no spaces) +3|slippage| percentage float +4|deadline| timestamp + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx swap swap-exact-for-tokens 1000000ukava 5000000usdx 0.01 1624224736 --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for swap-exact-for-tokens + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file diff --git a/docs/education/user_actions/SWAP/swap_withdraw.md b/docs/education/user_actions/SWAP/swap_withdraw.md new file mode 100644 index 00000000..a811a861 --- /dev/null +++ b/docs/education/user_actions/SWAP/swap_withdraw.md @@ -0,0 +1,57 @@ +# Withdraw + +withdraw coins from a swap liquidity pool + +## Command +``` +kvcli tx swap withdraw +``` + +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. + +### Arguments +position|name|expects +|--|--|--| +1|shares| number of shares +2|minCoinA| amount & name (no spaces) +3|minCoinB| amount & name (no spaces) +4|deadline| timestamp + + +**Note**: the name is a placeholder for clarity and won't be needed when running the commands, see example below + +### Example +``` +kvcli tx swap withdraw 153000 10000000ukava 20000000usdx 176293740 --from +``` + +### Options +``` + + -a, --account-number uint The account number of the signing account (offline mode only) + -b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync") + --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it + --fees string Fees to pay along with transaction; eg: 10uatom + --from string Name or address of private key with which to sign + --gas string gas limit to set per-transaction; set to "auto" to calculate required gas automatically (default 200000) (default "200000") + --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) + --gas-prices string Gas prices to determine the transaction fee (e.g. 10uatom) + --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase is not accessible and the node operates offline) + -h, --help help for withdraw + --indent Add indent to JSON response + --keyring-backend string Select keyring's backend (os|file|test) (default "os") + --ledger Use a connected Ledger device + --memo string Memo to send along with transaction + --node string : to tendermint rpc interface for this chain (default "tcp://localhost:26657") + -s, --sequence uint The sequence number of the signing account (offline mode only) + --trust-node Trust connected full node (don't verify proofs for responses) (default true) + -y, --yes Skip tx broadcasting prompt confirmation + +``` + +### Options inherited from parent commands +``` + + --chain-id string Chain ID of tendermint node + +``` \ No newline at end of file