mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-25 07:45:18 +00:00
added CLI docs
This commit is contained in:
parent
fe393048f9
commit
bbf37bdad3
@ -1,141 +1,178 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
theme: "cosmos",
|
"theme": "cosmos",
|
||||||
title: "Kava Documentation",
|
"title": "Kava Documentation",
|
||||||
themeConfig: {
|
"themeConfig": {
|
||||||
logo: {
|
"logo": {
|
||||||
src: "/logo.svg",
|
"src": "/logo.svg"
|
||||||
},
|
},
|
||||||
custom: true,
|
"custom": true,
|
||||||
sidebar: {
|
"sidebar": {
|
||||||
auto: false,
|
"auto": false,
|
||||||
nav: [
|
"nav": [
|
||||||
{
|
{
|
||||||
title: "Reference",
|
"title": "Intro to Kava Platform",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "Modules",
|
"title": "Application Process",
|
||||||
path: "/Modules",
|
"path": "/education/application_process.html"
|
||||||
directory: true
|
|
||||||
},
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: "Kava Tools",
|
|
||||||
children: [
|
|
||||||
{
|
|
||||||
title: "Chainlink Price Oracle",
|
|
||||||
path: "/tools/oracle.html"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Community Tools",
|
"title": "Development Process",
|
||||||
path: "/tools/community.html",
|
"children": [
|
||||||
},
|
{
|
||||||
{
|
"title": "Kava DAO Governance",
|
||||||
title: "Sentinel",
|
"path": "/education/kava_dao_governance.html",
|
||||||
path: "/tools/sentinel.html",
|
},
|
||||||
},
|
{
|
||||||
{
|
"title": "Testnet",
|
||||||
title: "Auction Bot",
|
"path": "/education/testnet.html",
|
||||||
path: "/tools/auction.html",
|
},
|
||||||
|
{
|
||||||
|
"title": "Mainnet upgrade",
|
||||||
|
"path": "/education/mainnet_upgrade.html",
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Building on Kava",
|
"title": "Getting Started - Developers",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "JavaScript SDK",
|
"title": "Hello Kava",
|
||||||
path: "/building/javascript-sdk.html"
|
"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",
|
"title": "Resources",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "REST API Spec",
|
"title": "Lite Paper",
|
||||||
path: "https://swagger.kava.io/"
|
"path": "/education/lite_paper.html"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Protocol Reference",
|
"title": "Community Tools",
|
||||||
path: "https://pkg.go.dev/github.com/kava-labs/kava?tab=subdirectories"
|
"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: {
|
"footer": {
|
||||||
logo: "/logo.svg",
|
"logo": "/logo.svg",
|
||||||
textLink: {
|
"textLink": {
|
||||||
text: "kava.io",
|
"text": "kava.io",
|
||||||
url: "https://www.kava.io"
|
"url": "https://www.kava.io"
|
||||||
},
|
},
|
||||||
services: [
|
"services": [
|
||||||
{
|
{
|
||||||
service: "twitter",
|
"service": "twitter",
|
||||||
url: "https://twitter.com/kava_platform"
|
"url": "https://twitter.com/kava_platform"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
service: "medium",
|
"service": "medium",
|
||||||
url: "https://medium.com/kava-labs"
|
"url": "https://medium.com/kava-labs"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
service: "telegram",
|
"service": "telegram",
|
||||||
url: "https://t.me/kavalabs"
|
"url": "https://t.me/kavalabs"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
service: "discord",
|
"service": "discord",
|
||||||
url: "https://discord.gg/JJYnuCx"
|
"url": "https://discord.gg/JJYnuCx"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
service: "github",
|
"service": "github",
|
||||||
url: "https://github.com/kava-labs"
|
"url": "https://github.com/kava-labs"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
smallprint:
|
"smallprint": "© 2021 Kava Labs.",
|
||||||
`© ${new Date().getFullYear()} Kava Labs.`,
|
"links": [
|
||||||
links: [
|
|
||||||
{
|
{
|
||||||
title: "Community",
|
"title": "Community",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "Blog",
|
"title": "Blog",
|
||||||
url: "https://medium.com/kava-labs"
|
"url": "https://medium.com/kava-labs"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Chat",
|
"title": "Chat",
|
||||||
url: "https://t.me/kavalabs"
|
"url": "https://t.me/kavalabs"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Contributing",
|
"title": "Contributing",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "Contributing to the docs",
|
"title": "Contributing to the docs",
|
||||||
url:
|
"url": "https://github.com/Kava-Labs/kava/tree/master/docs"
|
||||||
"https://github.com/Kava-Labs/kava/tree/master/docs"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Source code on GitHub",
|
"title": "Source code on GitHub",
|
||||||
url: "https://github.com/Kava-Labs/kava"
|
"url": "https://github.com/Kava-Labs/kava"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Related Docs",
|
"title": "Related Docs",
|
||||||
children: [
|
"children": [
|
||||||
{
|
{
|
||||||
title: "Cosmos SDK",
|
"title": "Cosmos SDK",
|
||||||
url: "https://cosmos.network/docs"
|
"url": "https://cosmos.network/docs"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Binance Chain",
|
"title": "Binance Chain",
|
||||||
url: "https://docs.binance.org"
|
"url": "https://docs.binance.org"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
}
|
3
docs/education/application_process.md
Normal file
3
docs/education/application_process.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Application Process
|
||||||
|
|
||||||
|
We are working on updating our entire documentation to provide a better user experience, please check back later!
|
3
docs/education/hello_kava.md
Normal file
3
docs/education/hello_kava.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Hello Kava
|
||||||
|
|
||||||
|
We are working on updating our entire documentation to provide a better user experience, please check back later!
|
3
docs/education/kava_dao_governance.md
Normal file
3
docs/education/kava_dao_governance.md
Normal file
@ -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!
|
3
docs/education/lite_paper.md
Normal file
3
docs/education/lite_paper.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Lite Paper
|
||||||
|
|
||||||
|
We are working on updating our entire documentation to provide a better user experience, please check back later!
|
3
docs/education/mainnet_upgrade.md
Normal file
3
docs/education/mainnet_upgrade.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Mainnet Upgrade
|
||||||
|
|
||||||
|
We are working on updating our entire documentation to provide a better user experience, please check back later!
|
3
docs/education/testnet.md
Normal file
3
docs/education/testnet.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Testnet
|
||||||
|
|
||||||
|
We are working on updating our entire documentation to provide a better user experience, please check back later!
|
67
docs/education/user_actions/Basics/quick_guide.md
Normal file
67
docs/education/user_actions/Basics/quick_guide.md
Normal file
@ -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 <kava-addr>
|
||||||
|
```
|
||||||
|
|
||||||
|
### View Staking Delegations
|
||||||
|
```
|
||||||
|
kvcli q staking delegations <kava-addr>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Claim staking rewards
|
||||||
|
```
|
||||||
|
kvcli tx distribution withdraw-all-rewards --gas 650000 --gas-prices 0.01ukava --from <kava-addr or key name>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Querying outstanding staking rewards
|
||||||
|
```
|
||||||
|
kvcli q distribution rewards <kava-addr>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
### Querying outstanding HARD rewards
|
||||||
|
```
|
||||||
|
kvcli q incentive rewards --type delegator --owner <kava-address>
|
||||||
|
```
|
||||||
|
|
||||||
|
### View HARD Incentives
|
||||||
|
```
|
||||||
|
kvcli q incentive rewards --type hard --owner <kava-address>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
### Send Coins
|
||||||
|
```
|
||||||
|
kvcli tx send <key_name> <kava-account> <amount (100ukava for example)> --memo [memo] --gas-prices 0.01ukava
|
||||||
|
```
|
||||||
|
|
||||||
|
### Query Transaction Status Using TX Hash
|
||||||
|
```
|
||||||
|
kvcli q tx <tx_hash>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Adding a Key to Ledger
|
||||||
|
```
|
||||||
|
kvcli keys add <key-name> --account <account-index> --legacy-hd-path --ledger
|
||||||
|
```
|
52
docs/education/user_actions/CDP/cdp_create.md
Normal file
52
docs/education/user_actions/CDP/cdp_create.md
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
# Create New CDP
|
||||||
|
|
||||||
|
Create a new cdp, depositing some collateral and drawing some debt.
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
52
docs/education/user_actions/CDP/cdp_deposit.md
Normal file
52
docs/education/user_actions/CDP/cdp_deposit.md
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
# Add Collateral
|
||||||
|
|
||||||
|
Add collateral to an existing cdp.
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
51
docs/education/user_actions/CDP/cdp_draw.md
Normal file
51
docs/education/user_actions/CDP/cdp_draw.md
Normal file
@ -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 <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.
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
53
docs/education/user_actions/CDP/cdp_repay.md
Normal file
53
docs/education/user_actions/CDP/cdp_repay.md
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
# Repay Debt
|
||||||
|
|
||||||
|
repay debt to an existing cdp
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
52
docs/education/user_actions/CDP/cdp_withdraw.md
Normal file
52
docs/education/user_actions/CDP/cdp_withdraw.md
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
# Remove Collateral
|
||||||
|
|
||||||
|
withdraw collateral from an existing cdp
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
51
docs/education/user_actions/HARD/hard_borrow.md
Normal file
51
docs/education/user_actions/HARD/hard_borrow.md
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
# Borrow
|
||||||
|
|
||||||
|
borrow tokens from the hard protocol
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
```
|
54
docs/education/user_actions/HARD/hard_deposit.md
Normal file
54
docs/education/user_actions/HARD/hard_deposit.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Deposit
|
||||||
|
|
||||||
|
deposit coins to hard
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
57
docs/education/user_actions/HARD/hard_repay.md
Normal file
57
docs/education/user_actions/HARD/hard_repay.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
# Repay
|
||||||
|
|
||||||
|
repay tokens to the hard protocol
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
kvcli tx hard repay 1000000000ukava,25000000000bnb --from <key>
|
||||||
|
kvcli tx hard repay 1000000000ukava,25000000000bnb --owner <owner-address> --from <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
54
docs/education/user_actions/HARD/hard_withdraw.md
Normal file
54
docs/education/user_actions/HARD/hard_withdraw.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Withdraw
|
||||||
|
|
||||||
|
withdraw coins from hard
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
57
docs/education/user_actions/SWAP/swap_deposit.md
Normal file
57
docs/education/user_actions/SWAP/swap_deposit.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
# Deposit
|
||||||
|
|
||||||
|
deposit coins to a swap liquidity pool
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
57
docs/education/user_actions/SWAP/swap_tokens.md
Normal file
57
docs/education/user_actions/SWAP/swap_tokens.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
# Swap Tokens
|
||||||
|
|
||||||
|
swap an exact amount of token a for token b
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
57
docs/education/user_actions/SWAP/swap_withdraw.md
Normal file
57
docs/education/user_actions/SWAP/swap_withdraw.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
# Withdraw
|
||||||
|
|
||||||
|
withdraw coins from a swap liquidity pool
|
||||||
|
|
||||||
|
## Command
|
||||||
|
```
|
||||||
|
kvcli 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.
|
||||||
|
|
||||||
|
### 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 <key>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <host>:<port> 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
|
||||||
|
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user