-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Overview and Integrate sections, gov module docs update (#195)
* Incentives Update + reorder Rewrite of Incentives guide Removed LBP page - should be pushing to Streamswap instead, will include in Liquidity page Ordered sidebar according to onboarding flow Added SetSuperfluidAssets guide * Layout Change Change folder/sidebar layout + routing Change overall index page layout to be new user friendly Add index page for overview section Merge governance and OSMO into new page about the OSMO token usage - to be reviewed Removed section on self-governing liquidity pools All new pages to be reviewed * Update Airdrop Snapshot Grammar and layout fixes plus some clarifications * Update Initial Liquidity Complete rewrite Removed reference to pool creation (will be dealt with on earlier page) Changed LBP process to StreamSwap Updated Loan Swap process Added Token Swap process * Update Frontend page Trim down to just "How to list on Main" Move Frontend details to the registration section next * Update Create pool Add page to explain how to create a pool Fix ordering/layout on others * Add transfer page Page contains information on how to connect a new chain to Osmosis and have it recognised by explorers. * Add non-IBC connection * Tidy Registration Moved frontend and price oracle registration here * Osmo Token * Update gov Module * Format Incentives module * Remove assets * re-add assets * Update since incentive changes * Update OSMO token info * Arrange sidebar
- Loading branch information
1 parent
92a1c13
commit ecdb18d
Showing
25 changed files
with
941 additions
and
1,178 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"position": 4, | ||
"label": "Overview", | ||
"collapsible": true, | ||
"collapsed": true, | ||
"className": "red", | ||
"link": { | ||
|
||
"title": "Overview" | ||
}, | ||
"customProps": { | ||
"description": "The guides on this page will give a grounding on Osmosis functionality." | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
# Getting Started | ||
## Set up a Wallet | ||
Before opening the Osmosis AMM App, make sure to install the [Keplr Wallet](wallets/keplr/README.md). | ||
|
||
## Open the App | ||
Go to [https://app.osmosis.zone/](https://app.osmosis.zone/) | ||
|
||
![](../../assets/started-trade-page.png) | ||
|
||
## Connect Wallet | ||
![](../../assets/connect-wallet.png) | ||
|
||
Click Approve. This confirms that you are connecting to the app.osmosis.zone and the chain osmosis-1. | ||
|
||
![](../../assets/keplr-connect.png) | ||
|
||
|
||
Always make sure you are connected to app.osmosis.zone name and network (osmosis-1) | ||
|
||
|
||
## Deposit Funds | ||
|
||
![](../../assets/started-assets-page.png) | ||
|
||
Click Assets. Then click on the deposit link next to the asset name. For this example we are clicking the ATOM deposit link. | ||
|
||
Accept connection to cosmoshub-4 | ||
|
||
![](../../assets/connect-cosmoshub.png) | ||
|
||
|
||
Once connected, select how much you would like to deposit, then click the deposit button | ||
|
||
[](../../assets/deposit-dialog.png) | ||
|
||
Approve the transaction | ||
|
||
![](../../assets/approve-tramsaction.png) | ||
|
||
Once the transaction is completed a series if confirmations notifications will be displayed including the IBC confirmation. | ||
|
||
![](../../assets/confirm-2.png) | ||
|
||
## Swapping Tokens | ||
|
||
Trading tokens is as easy as clicking on the Trade link and then selecting the pair you would like to trade. Check out the [glossary](terminology.md) to learn about terms such as [slipage](terminology.md#slippage). | ||
![](../../assets/swap.png) | ||
|
||
|
||
## Adding Liquidity to a Pool | ||
Select a pool from the [Pools](https://app.osmosis.zone/pools) page. | ||
![](../../assets/add-liquidity.png) | ||
|
||
Then click Add/Remove Liquidity | ||
![](../../assets/add-remove-liquidity.png) | ||
|
||
Input a quantity of one of the assets. The quantity of the other asset(s) will auto-complete. (Pools require assets to be deposited in pre-determined weights.) | ||
|
||
:::warning Warning | ||
Please note that simply adding liquidity will not give you rewards. In order to get rewards you must bond LP tokens. | ||
::: | ||
|
||
![](../../assets/add-liquidity.png) | ||
|
||
To remove liquidity, input the percentage amount to withdraw. | ||
|
||
![](../../assets/remove-liquidity.png) | ||
|
||
Incentivized pools receive OSMO liquidity mining rewards. Rewards are distributed to bonded LP tokens in these pools that meeting the bonding length criteria. | ||
|
||
Swap fees are fees charged for making a swap in an LP pool. The fee is paid by the trader in the form of the input asset. Pool creators specify the swap fee when establishing the pool. The total fee for a particular trade is calculated as percentage of swap size. Fees are added to the pool, effectively resulting in pro-rata distribution to LPs proportional to their share of the total pool. | ||
|
||
## Bonding LP Tokens | ||
Start Earning! Users can choose to bond their LP tokens after depositing liquidity. LP tokens remain bonded for a length of their time of their choosing. Bonded LP tokens are eligible for liquidity mining rewards if they meet the minimum bonding length requirement. | ||
|
||
Click Start Earning and choose a bonding length. | ||
|
||
![](../../assets/start-earning.png) | ||
|
||
|
||
|
||
### Internal Incentives | ||
|
||
### External Incentives | ||
|
||
Osmosis not only allows the community to add incentives to gauges. Anyone can deposit tokens into a gauge to be distributed. This feature allows outside parties to augment Osmosis’ own liquidity incentive program. | ||
|
||
For example, there may be an ATOM< >FOOCOIN pool that has a one-day gauge incentivized by governance OSMO rewards. However, the Foo Foundation may also choose to add additional incentives to the one-day gauge or even add incentives to a new gauge (such as one-week gauge). | ||
|
||
These external incentive providers can also set up long-lasting incentive programs that distribute rewards over an extended time period. For example, the Foo Foundation can deposit 30,000 Foocoins to be distributed over a one-month liquidity program. The program will automatically distribute 1000 Foocoins per day to the gauge. | ||
|
||
## Go Superfluid! | ||
|
||
## Unbonding LP Tokens | ||
When a user wants to stop bonding an LP token, they submit a transaction that begins the unbonding period. After the end of the timer, they can submit another transaction to withdraw the tokens. | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Overview | ||
sidebar_position: 0 | ||
--- | ||
import DocCardList from '@theme/DocCardList'; | ||
|
||
# Introduction | ||
|
||
The guides on this page will explain background information on Osmosis. | ||
|
||
<DocCardList /> | ||
|
Oops, something went wrong.
ecdb18d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
docs – ./
docs-osmo-labs.vercel.app
docs-git-main-osmo-labs.vercel.app
docs-beta-olive.vercel.app
docs.osmosis.zone