diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index ad38b46a..8fee331b 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -14,11 +14,11 @@ module.exports = { children: [ { title: "Get Started", - path: "/education/getting_started.html" + path: "/Education/getting_started.html" }, { title: "Building Modules", - path: "/education/hello_kava.html" + path: "/Education/hello_kava.html" }, { title: "Javascript SDK", @@ -62,7 +62,7 @@ module.exports = { }, { title: "CLI Docs", - path: "/education/user_actions/", + path: "/Education/user_actions/", directory: true, }, { @@ -72,6 +72,11 @@ module.exports = { { title: "Protocol Reference", path: "https://pkg.go.dev/github.com/kava-labs/kava?tab=subdirectories" + }, + { + title: "FAQ", + path: "/Education/FAQ/", + directory: true, } ] } diff --git a/docs/Education/FAQ/basics.md b/docs/Education/FAQ/basics.md new file mode 100644 index 00000000..f3c3c981 --- /dev/null +++ b/docs/Education/FAQ/basics.md @@ -0,0 +1,61 @@ +## The Basics + +### What is Kava Protocol? +Kava Chain is a decentralized, permissionless, censorship-resistant blockchain built with the Cosmos SDK. This means it operates much like other Cosmos ecosystem blockchains, and is designed to be interoperable between chains. + +[Learn more about Cosmos](https://cosmos.network/). + +[Learn more about Kava](https://medium.com/kava-labs/kava-protocol-101-ce3beb0fa8b8) +‍ +Kava Protocol is the set of rules and behaviors built into the Kava Chain that enables advanced Decentralized Finance (DeFi) functionality like permissionless borrowing and lending. +‍ +The KAVA token is an asset on the Kava Chain. Kava Chain is secured by its token KAVA and it is used across the full chain as a transport and a store of value. + +### What is Kava Lend? +Kava Lend is an application that runs on Kava blockchain. It builds upon the Kava Protocol and adds new functionality, expanding the Kava Ecosystem to include an autonomous money market protocol. + +The HARD token is an asset on the Kava Chain. It is given as a reward for supplying and borrowing on Kava Lend. + +### What tokens and assets can be use on the Kava Blockchain? +**Native assets** +Native assets are tokens that originate on the Kava Chain. These currently include KAVA, HARD, SWP and USDX. + +KAVA and HARD are governance tokens, meaning holders can vote on the rules of the protocols. KAVA is also used as a Proof of Stake staking asset, which ensures the finality and safety of loans on the protocol and also acts as the ‘lender of last resort’ in certain situations. USDX is a stable coin loosely pegged to the US Dollar. It is minted when a Kava CDP is opened. The exact value of USDX is determined by market forces. [Read more](https://medium.com/kava-labs/usdx-stability-mechanics-12bf23ed957b.com/kava-labs/usdx-stability-mechanics-12bf23ed957b) + +**Non-native assets** +Other tokens can also be issued on the Kava Chain. These non-native asset tokens are often used to “wrap”, “tokenize,” or represent assets on other chains. For example: + +Binance Coin (BNB) can be represented as a token on Kava Chain. During a cross-chain swap, BNB(Kava) coins are created or destroyed (burned) on Kava Chain, and frozen/unfrozen on Binance Chain. + +Assets from other blockchains are considered non-native assets. This includes coins from other Cosmos ecosystem blockchains, which can connect to the Kava Chain through protocols like [Cosmos IBC](https://cosmos.network/ibc). + +Be aware that KAVA (native) has been tokenized on other blockchains, namely Binance Chain. KAVA (BEP-2) is a token that exists solely on Binance Chain. Do not send KAVA (BEP2) directly to the Kava Chain. + +**BTCB** +represents BTC which has been tokenized on Binance Chain. This BNB token has also been tokenized on KAVA, making BTCB (Kava) a doubly tokenized representation of BTC. +### How do I access Kava? +The Kava Platform or Kava Web App, which is live at [app.kava.io](https://app.kava.io/), is a user-friendly hub for interacting with the protocol. + +Similarly, Kava Lend can be found at [app.kava.io/lend](https://app.kava.io/lend). + +### Where can I learn more? +Here are great introductory readings: + +[Mint](https://medium.com/kava-labs/kava-protocol-101-ce3beb0fa8b8) + +[Lend](https://medium.com/kava-labs/introducing-harvest-io-the-worlds-first-cross-chain-money-market-a27535a5d91a). + +Check out our other articles on [Medium](https://medium.com/kava-labs). +### Does Kava have smart contracts? +Like most Cosmos ecosystem blockchains, the automated transaction behaviors known as smart contracts are hardcoded into the protocol. They are referred to as “modules” in the Cosmos Ecosystem. The Kava App uses a special kind of module called a CDP. +### What is a CDP? How do I mint USDX? +A CDP or Collateralized Debt Position is a new kind of automated loan contract, used to create “stablecoins” that are pegged to a fiat currency like the US Dollar. The lender puts up a crypto asset as collateral to ‘mint’, or create new stablecoins. + +For example, on Kava, users can stake BNB as collateral to mint USDX. The collateral is locked while the position is open. The lender unlocks their collateral once they repay the loan amount plus accumulated interest. + +Minting USDX is as simple as supplying your asset to Kava and clicking “Borrow.” The lender can only take out 2/3rds of the collateral amount. [Read more here](https://medium.com/kava-labs/borrow-usdx-on-kavas-web-app-using-trust-wallet-8540ba61f7a4) + +Lenders should keep in mind that if the price of the collateral asset drops below the liquidation price, their CDP will be liquidated. Therefore, it is advised not to mint more than 1/2 of the value of the collateral. The “Safe Max” button included in the app goes by this recommendation. + +### What is Kava planning for the future? + Check out our [roadmap](https://medium.com/kava-labs/kava-2021-roadmap-91f839a0907b). Follow us on [Twitter](https://twitter.com/kava_labs) to receive the latest announcements. diff --git a/docs/Education/FAQ/earn.md b/docs/Education/FAQ/earn.md new file mode 100644 index 00000000..0314675c --- /dev/null +++ b/docs/Education/FAQ/earn.md @@ -0,0 +1,64 @@ +## Earn With Kava + +### Why use Mint/Lend? +**Borrowing** +Mint and Lend let users take out loans in a decentralized fashion. This democratizes finance by removing the barrier to entry, lowering friction, and removing gatekeepers. + +**Lending** +Mint, Lend, and Swap let users turn their idle cryptocurrencies into interest-producing assets safely and transparently. + +**Rewards** +As the protocols scale, numerous rewards are available to early adopters.DeFi applications - developers are encouraged to build new apps, integrations, and protocols in the Kava ecosystem for new business use cases. + +### How can I earn money on Kava? +**Staking** +Like most Proof of Stake (PoS) blockchains, KAVA holders can ‘stake’ their KAVA by either running a validator node themselves or by ‘bonding’ their tokens to a third party that is running a node. Bonding temporarily locks in your coins for a 21-day. [Learn more.](https://medium.com/kava-labs/kava-staking-guide-4894b8452ab3) A list of validators can be found [here.](https://kava.bigdipper.live/validators) + +**Borrowing** +Use your assets as collateral to borrow other assets, then using those to earn returns by trading or with other DeFi pursuits. Users can borrow USDX on Kava and other assets on Lend. + +**Lending** +Supply assets to Kava Lend and automatically earn rewards in HARD tokens. + +**Rewards** +Kava Mint + +[Trust wallet guide](https://medium.com/kava-labs/borrow-usdx-on-kavas-web-app-using-trust-wallet-8540ba61f7a4). + +[Minting rewards](https://medium.com/kava-labs/usdx-minting-rewards-explained-82d0b74897a2#Reward%20Calculation). + +Available assets include: BNB, BTCB, BUSD-A, BUSD-B, XRPB, KAVA, UST, and HARD. + +Kava Lend +Supply assets to Kava Lend to earn KAVA and HARD rewards. [Guide](https://medium.com/kava-labs/supply-and-earn-on-hard-money-market-from-binance-com-e3f54acf4b19). + +Available assets include: USDX, KAVA, HARD, BNB, BUSD, BTCB, SWP, ATOM, and XRPB. + +KAVA, HARD, and SWP rewards have a vesting period of either 1 month or 12 months. If you choose 12 months, the reward amount increases. + +Users can earn rewards by: +- Supplying an asset to Lend. +- Borrowing against that asset. +- Supplying the borrowed asset to Mint. +- Minting USDX. +- Supplying that minted USDX to Lend. +- Supplying a pair of assets to a Swap Liquidity pool. + +**Tips** +Keep a small amount of KAVA in your wallet in case you want to include a fee. + +Avoid having a CDP liquidated by monitoring the collateral value, debt value, and liquidation price. If the collateral value drops below the liquidation price, your position will be liquidated. Assets from liquidated CDP’s are put up for auction. If that happens, the auction typically takes 8-24 hours and you can expect ~⅓ of the collateral back (not guaranteed). + +Some exchanges (like Binance) require a memo field for cross-chain transfers. If a memo is not included, those funds can be lost. +### How can I send assets to Kava? +To use assets on Kava, first move those assets to the Binance Chain (not Binance Smart Chain) and then to the Kava Chain. + +This [guide](https://medium.com/kava-labs/borrow-usdx-on-kavas-web-app-using-trust-wallet-8540ba61f7a4) walks you through the process. +### Do Kava transactions require fees? +Fees are optional. They can be included if the network becomes busy, and can be added to prioritize a transaction to complete faster. +### Do Kava transactions require gas? +All transactions on the Kava blockchain consume gas. + +The amount of gas consumed is proportional to the amount of computation and state access that the transaction requires. + +For large and/or complex transactions, users may have to increase the amount of gas that the transaction requests above the default value. diff --git a/docs/Education/FAQ/support.md b/docs/Education/FAQ/support.md new file mode 100644 index 00000000..5098ad84 --- /dev/null +++ b/docs/Education/FAQ/support.md @@ -0,0 +1,55 @@ +## Support + +### Where did my coins go? What is the deal with the hot wallet balance? +Check the status of the transaction by searching for your kava address on [Mintscan](https://www.mintscan.io/kava). + +If you don’t see your funds as expected, these are the most likely reasons: +- The deputy is running slowly and the transaction is still in progress +- Check to be sure that asset is visible in the Tokens tab in Trust Wallet. If the asset is not visible, search for it in the Manage tab and toggle it on. + +Every cross-chain swap has an auditable record. In times of high network traffic, the deputy might not complete transactions immediately. If you encounter this issue, please wait patiently. If your transaction has not completed or refunded after 24 hours, please contact the Kava team and send us the transaction ID. + +To operate cross-chain swaps, Binance must allocate a certain amount of funds for transfers into a hot wallet. As a security measure, the Binance team needs to manually refill the hot wallet from time to time. Otherwise, the rest of the cross-chain swap is completely automated. +### I have unstaked my coins, why are they still pending? +After unstaking KAVA, those coins are locked for 21 days. After that, they are released and can be used. +### Why can't I repay my CDP? +The total amount to close the position is the original loan amount plus accrued interest. + +When repaying a CDP, the remaining debt balance cannot be below 10 USDX. +If you try to repay your original principal only, the transaction will fail if the remaining interest would leave a debt balance of less than 10 USDX. + +If you need to purchase additional USDX to fully close out a position: +- Swap an asset for USDX on Kava Swap +- Purchase USDX on AscendEx +- Peer-to-peer transaction through [Kava TipBot](https://kavatipbot.com/) + +### I have enough balance, but it says I can't transfer because my balance is too low +Check if your balance contains vested (“locked”) coins or not. If so, you need to wait for the vesting period to complete. +### I got an error during a transaction +"Error during Broadcasting - could not broadcast transaction" +This error can result from: +- closing the app +- a problem with the connection +- attempting to repeatedly send the same transaction. + +Check for the transaction on the balances tab in the Kava app or the tokens tab (if you're using Cosmostation wallet) and see if it was successfully completed. If not, your tokens will still be there. + +“Error during Confirming - out of gas” +- This transaction requires more than the default amount of gas. +- Note the amount of “gasUsed” +- Attempt the transaction again, and select click “Advanced” below the fee slider to be able to manually set the gas amount. If you enter an amount greater than “gasUsed,” the transaction should complete. + +### Why are my transactions for 10 KAVA and 10 BNB showing up as 10,000,000 ukava and 1,000,000,000, bnb in Trust Wallet? +This is how the coins are represented in the source code. They represent the smallest indivisible unit of the currency. +‍ +- ukava is one -millionth (or 10^-6) of a KAVA coin +- bnb is one hundred-millionth (or 10^-8) of a BNB coin + +### My validator node is having problems +Please contact our team through [Discord](https://discord.com/invite/kQzh3Uv), [Telegram](https://t.me/kavalabs), or Slack. Describe the problem in full with steps to reproduce. + +Check the #validator-announcements channel in Discord for information regarding the potential need for an update. + +Feel free to message us and we will set up a private channel on Telegram or Slack. +### Somebody from Kava support messaged me in Telegram. Are they legitimate team members? +Kava team members never message first. Please report at @notoscam and block the account. The scammer might also imitate the account of a team member changing the letters in the username. If you need assistance, find the team member in the chat user list and send them a direct message. \ No newline at end of file diff --git a/docs/education/application_process.md b/docs/Education/application_process.md similarity index 100% rename from docs/education/application_process.md rename to docs/Education/application_process.md diff --git a/docs/education/dev_process/kava_dao_governance.md b/docs/Education/dev_process/kava_dao_governance.md similarity index 100% rename from docs/education/dev_process/kava_dao_governance.md rename to docs/Education/dev_process/kava_dao_governance.md diff --git a/docs/education/dev_process/mainnet_upgrade.md b/docs/Education/dev_process/mainnet_upgrade.md similarity index 100% rename from docs/education/dev_process/mainnet_upgrade.md rename to docs/Education/dev_process/mainnet_upgrade.md diff --git a/docs/education/dev_process/testnet.md b/docs/Education/dev_process/testnet.md similarity index 100% rename from docs/education/dev_process/testnet.md rename to docs/Education/dev_process/testnet.md diff --git a/docs/education/getting_started.md b/docs/Education/getting_started.md similarity index 100% rename from docs/education/getting_started.md rename to docs/Education/getting_started.md diff --git a/docs/education/hello_kava.md b/docs/Education/hello_kava.md similarity index 100% rename from docs/education/hello_kava.md rename to docs/Education/hello_kava.md diff --git a/docs/education/lite_paper.md b/docs/Education/lite_paper.md similarity index 100% rename from docs/education/lite_paper.md rename to docs/Education/lite_paper.md diff --git a/docs/education/user_actions/Governance/Vote.md b/docs/Education/user_actions/Governance/Vote.md similarity index 100% rename from docs/education/user_actions/Governance/Vote.md rename to docs/Education/user_actions/Governance/Vote.md diff --git a/docs/education/user_actions/Governance/committee.md b/docs/Education/user_actions/Governance/committee.md similarity index 100% rename from docs/education/user_actions/Governance/committee.md rename to docs/Education/user_actions/Governance/committee.md diff --git a/docs/education/user_actions/Governance/param-change.md b/docs/Education/user_actions/Governance/param-change.md similarity index 100% rename from docs/education/user_actions/Governance/param-change.md rename to docs/Education/user_actions/Governance/param-change.md diff --git a/docs/education/user_actions/Lend/hard_borrow.md b/docs/Education/user_actions/Lend/hard_borrow.md similarity index 100% rename from docs/education/user_actions/Lend/hard_borrow.md rename to docs/Education/user_actions/Lend/hard_borrow.md diff --git a/docs/education/user_actions/Lend/hard_deposit.md b/docs/Education/user_actions/Lend/hard_deposit.md similarity index 100% rename from docs/education/user_actions/Lend/hard_deposit.md rename to docs/Education/user_actions/Lend/hard_deposit.md diff --git a/docs/education/user_actions/Lend/hard_repay.md b/docs/Education/user_actions/Lend/hard_repay.md similarity index 100% rename from docs/education/user_actions/Lend/hard_repay.md rename to docs/Education/user_actions/Lend/hard_repay.md diff --git a/docs/education/user_actions/Lend/hard_withdraw.md b/docs/Education/user_actions/Lend/hard_withdraw.md similarity index 100% rename from docs/education/user_actions/Lend/hard_withdraw.md rename to docs/Education/user_actions/Lend/hard_withdraw.md diff --git a/docs/education/user_actions/Mint/cdp_create.md b/docs/Education/user_actions/Mint/cdp_create.md similarity index 100% rename from docs/education/user_actions/Mint/cdp_create.md rename to docs/Education/user_actions/Mint/cdp_create.md diff --git a/docs/education/user_actions/Mint/cdp_deposit.md b/docs/Education/user_actions/Mint/cdp_deposit.md similarity index 100% rename from docs/education/user_actions/Mint/cdp_deposit.md rename to docs/Education/user_actions/Mint/cdp_deposit.md diff --git a/docs/education/user_actions/Mint/cdp_draw.md b/docs/Education/user_actions/Mint/cdp_draw.md similarity index 100% rename from docs/education/user_actions/Mint/cdp_draw.md rename to docs/Education/user_actions/Mint/cdp_draw.md diff --git a/docs/education/user_actions/Mint/cdp_repay.md b/docs/Education/user_actions/Mint/cdp_repay.md similarity index 100% rename from docs/education/user_actions/Mint/cdp_repay.md rename to docs/Education/user_actions/Mint/cdp_repay.md diff --git a/docs/education/user_actions/Mint/cdp_withdraw.md b/docs/Education/user_actions/Mint/cdp_withdraw.md similarity index 100% rename from docs/education/user_actions/Mint/cdp_withdraw.md rename to docs/Education/user_actions/Mint/cdp_withdraw.md diff --git a/docs/education/user_actions/Swap/swap_deposit.md b/docs/Education/user_actions/Swap/swap_deposit.md similarity index 100% rename from docs/education/user_actions/Swap/swap_deposit.md rename to docs/Education/user_actions/Swap/swap_deposit.md diff --git a/docs/education/user_actions/Swap/swap_tokens.md b/docs/Education/user_actions/Swap/swap_tokens.md similarity index 100% rename from docs/education/user_actions/Swap/swap_tokens.md rename to docs/Education/user_actions/Swap/swap_tokens.md diff --git a/docs/education/user_actions/Swap/swap_withdraw.md b/docs/Education/user_actions/Swap/swap_withdraw.md similarity index 100% rename from docs/education/user_actions/Swap/swap_withdraw.md rename to docs/Education/user_actions/Swap/swap_withdraw.md diff --git a/docs/education/user_actions/quick_guide.md b/docs/Education/user_actions/quick_guide.md similarity index 100% rename from docs/education/user_actions/quick_guide.md rename to docs/Education/user_actions/quick_guide.md