Skip to content

Commit

Permalink
docs: Katana capitalize V{2, 3}, update swap screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
@thaixuandang
thaixuandang committed Nov 29, 2024
1 parent 969f6e7 commit 62b983a
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
Binary file modified docs/apps/katana/assets/katana-routing-path.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/apps/katana/assets/katana-transactions-settings.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/apps/katana/guides/add-liquidity.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: Add your tokens to liquidity pools or remove them to get your token

## Overview

You can add more liquidity to an existing pool on Katana to earn fees from trades. When you contribute liquidity to a pool, you receive liquidity pool (LP) tokens as proof of your contribution. In Katana v2, you receive fungible LP tokens that represent a fixed share of the entire pool. In v3, instead, you receive a position tokens which are represented by non-fungible tokens (NFTs) that tied to the specific price range of your liquidity. The pool's fees are also distributed in different ways, depending on the pool is v2 or v3. In v2, fees are distributed based on the amount of LP tokens held. In v3, fees are allocated to positions where the swap price is active in the range they cover, and are also proportional to the liquidity those positions provide.
You can also remove your liquidity from a pool at any time. Removing pool tokens converts your position back into underlying tokens at the current rate. Accrued fees are included in the amounts you receive. Note that fees in v3 are not automatically reinvested like in v2, so you need to claim them separately.
You can add more liquidity to an existing pool on Katana to earn fees from trades. When you contribute liquidity to a pool, you receive liquidity pool (LP) tokens as proof of your contribution. In Katana V2, you receive fungible LP tokens that represent a fixed share of the entire pool. In V3, instead, you receive a position tokens which are represented by non-fungible tokens (NFTs) that tied to the specific price range of your liquidity. The pool's fees are also distributed in different ways, depending on the pool is V2 or V3. In V2, fees are distributed based on the amount of LP tokens held. In V3, fees are allocated to positions where the swap price is active in the range they cover, and are also proportional to the liquidity those positions provide.
You can also remove your liquidity from a pool at any time. Removing pool tokens converts your position back into underlying tokens at the current rate. Accrued fees are included in the amounts you receive. Note that fees in V3 are not automatically reinvested like in V2, so you need to claim them separately.

## Add liquidity to a pool
Open the [Liquidity pool](https://app.roninchain.com/liquidity) page and connect your Ronin Wallet.

### For Katana v2 pools
### For Katana V2 pools

Check warning on line 15 in docs/apps/katana/guides/add-liquidity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Headings] 'For Katana V2 pools' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'For Katana V2 pools' should use sentence-style capitalization.", "location": {"path": "docs/apps/katana/guides/add-liquidity.mdx", "range": {"start": {"line": 15, "column": 5}}}, "severity": "WARNING"}
1. Select the **V2 Pools** tab, then open the pool you want to contribute to.
![Liquidity pool](../assets/katana-pool-v2-list.png)

Expand Down Expand Up @@ -40,12 +40,12 @@ The **My position** panel is now updated with your latest contribution:

![My position](../assets/katana-pool-add-position.png)

### For Katana v3 pools
### For Katana V3 pools

Check warning on line 43 in docs/apps/katana/guides/add-liquidity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Headings] 'For Katana V3 pools' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'For Katana V3 pools' should use sentence-style capitalization.", "location": {"path": "docs/apps/katana/guides/add-liquidity.mdx", "range": {"start": {"line": 43, "column": 5}}}, "severity": "WARNING"}
1. Select the **V3 Pools** tabs, then open the pool you want to contribute to.
![Liquidity pool](../assets/katana-pool-v3-list.png)

2. Select the fee tier for your position. If the pool with the selected fee tier does not exist, your position will create a new pool with the fee tier.

Check warning on line 47 in docs/apps/katana/guides/add-liquidity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/apps/katana/guides/add-liquidity.mdx", "range": {"start": {"line": 47, "column": 112}}}, "severity": "WARNING"}
![Create new v3 position](../assets/katana-pool-v3-new-position.png)
![Create new V3 position](../assets/katana-pool-v3-new-position.png)

3. Enter or adjust the price range your position will provide liquidity for. Note that the minimum and maximum price values are rounded to the nearest tick price. You also see the capital efficiency of your position, which is the amount of liquidity your position provides compared to the liquidity when you provide for the full price range.

Check warning on line 50 in docs/apps/katana/guides/add-liquidity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/apps/katana/guides/add-liquidity.mdx", "range": {"start": {"line": 50, "column": 50}}}, "severity": "WARNING"}

Expand Down Expand Up @@ -97,7 +97,7 @@ To view more details, such as the amount of LP tokens and the pool's performance

![Remove liquidity panel](../assets/katana-pool-remove-liquidity-panel.png)

3. Select the portion of your liquidity you want to remove, or enter the amount manually (v2), or adjust the percentage (v3). Then, click **Remove**.
3. Select the portion of your liquidity you want to remove, or enter the amount manually (V2), or adjust the percentage (v3). Then, click **Remove**.

4. Review how much you're getting when removing liquidity, then click **Remove liquidity** and confirm the transaction in your Ronin Wallet.

Expand Down
16 changes: 8 additions & 8 deletions docs/apps/katana/guides/create-pool.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ Be aware that earning a profit through providing liquidity isn't guaranteed.
You may face what's known as _impermanent loss_, a risk that arises from
fluctuations in the value of the deposited tokens.

### Katana v2 vs Katana v3
### Katana V2 vs Katana V3

Katana v2 is a previous version of the Katana smart contract, which is still operational. Katana v3 is the latest version, which introduces concentrated liquidity, fee tiers, and improved oracles. When creating a liquidity pool, you can [choose to use](../overview.mdx#switch-between-v2-and-v3) either Katana v2 or Katana v3.
Katana V2 is a previous version of the Katana smart contract, which is still operational. Katana V3 is the latest version, which introduces concentrated liquidity, fee tiers, and improved oracles. When creating a liquidity pool, you can [choose to use](../overview.mdx#switch-between-v2-and-v3) either Katana V2 or Katana V3.

#### Fee tiers

Expand All @@ -36,7 +36,7 @@ Katana v2 is a previous version of the Katana smart contract, which is still ope

**What are fee tiers**

Fee tiers in Katana v3 are different fee structures that accommodate different types of trading pairs. When you create a liquidity pool, you can choose the fee structure that best match your risk/reward preferences and market conditions.
Fee tiers in Katana V3 are different fee structures that accommodate different types of trading pairs. When you create a liquidity pool, you can choose the fee structure that best match your risk/reward preferences and market conditions.

**How to choose the right fee tier**

Expand Down Expand Up @@ -146,12 +146,12 @@ Sky Mavis reviews your ERC-20 token contract to ensure it meets the requirements

## Create a liquidity pool

### Create a pool in Katana v3
### Create a pool in Katana V3

1. Go to [Katana](https://app.roninchain.com/liquidity) and connect your Ronin Wallet.
2. Select the **Liquidity pool** page, then click **Create new pool**.
3. Select the version of Katana you want to use: **Position V3**.
![Create a new v3 pool](../assets/katana-create-new-v3-pool.png)
![Create a new V3 pool](../assets/katana-create-new-v3-pool.png)
4. Select the tokens you want to pool, then choose the fee tier. For more information, see [Fee tiers](#fee-tiers).
5. Enter the start price and set the price range for your liquidity pool by entering the minimum and maximum prices. For more information, see [Concentrated liquidity](#concentrated-liquidity).
6. Enter the amount of tokens you want to contribute to the pool. You may need to approve both tokens in your Ronin Wallet if you interact with them for the first time.
Expand All @@ -161,7 +161,7 @@ Sky Mavis reviews your ERC-20 token contract to ensure it meets the requirements

Your pool is now created.

### Create a pool in Katana v2
### Create a pool in Katana V2

1. Go to [Katana](https://app.roninchain.com/liquidity) and connect your Ronin Wallet.
2. Select the **Liquidity pool** page, then click **Create new pool**.
Expand Down Expand Up @@ -203,9 +203,9 @@ You can change the initial amount of tokens in a pool as long as the pool is in
2. Add or remove tokens from the pool. For more information, see [Add liquidity to a pool](add-liquidity.mdx).
3. Click **Confirm**, review the details, then confirm the transaction in your Ronin Wallet.

## Migrate liquidity from v2 to v3
## Migrate liquidity from V2 to V3

To achieve better capital efficiency, you can consider migrating your liquidity from Katana v2 to Katana v3.
To achieve better capital efficiency, you can consider migrating your liquidity from Katana V2 to Katana V3.

1. On the **Liquidity pool** page, select Migrate.
2. Next to the pool you want to migrate, click **Migrate**.
Expand Down
4 changes: 2 additions & 2 deletions docs/apps/katana/guides/swap-tokens.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can trade one token for another on Katana in a process known as swapping. Wh

There are two ways to swap on Ronin: the [Swap](https://app.roninchain.com/swap) page in the Ronin web app and the Wallet Swap feature in the [Ronin Wallet](https://wallet.roninchain.com) mobile app and browser extension. The process is similar in both, but the interface differs slightly.

### Swap fees in Katana v2 vs v3
### Swap fees in Katana V2 vs V3

The fees for swapping tokens will be applied in each pool that the swap path passes through. Depending on whether the pool is Katana V2 or Katana V3, there will be different corresponding fee rates. This swap fee is always paid in the *input token*.

Expand Down Expand Up @@ -124,6 +124,6 @@ The new algorithm, combined with the updated router smart contract, enables you

![Routing path](../assets/katana-routing-path.png)

This feature will be enabled by default. If you prefer to use the old router, navigate to **Transaction Settings** and set the **Default trade options** to **V2**.
This feature will be enabled by default. If you prefer to use the old router, navigate to **Transaction Settings** and set the **Default trade options** to **Legacy**.

![Transaction Settings](../assets/katana-transactions-settings.png)
18 changes: 9 additions & 9 deletions docs/apps/katana/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ import walletOptions from './assets/katana-wallet-options.png'

Katana ([app.roninchain.com/swap](https://app.roninchain.com/swap)) is a decentralized exchange (DEX) for trading tokens within the Ronin ecosystem. The AMM (automated market maker) protocol that powers Katana allows users to swap tokens, create liquidity pools, and stake LP tokens to earn rewards.

### Katana v2 vs v3
### Katana V2 vs V3

Check warning on line 21 in docs/apps/katana/overview.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Katana V2 vs V3' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Katana V2 vs V3' should use sentence-style capitalization.", "location": {"path": "docs/apps/katana/overview.mdx", "range": {"start": {"line": 21, "column": 5}}}, "severity": "WARNING"}

Katana v2 is a previous version of the Katana smart contract, which is still operational. Katana v3 is the latest version, which introduces concentrated liquidity, fee tiers, and improved oracles. When creating a liquidity pool, you can [choose to use](#switch-between-v2-and-v3) either Katana v2 or Katana v3.
Katana V2 is a previous version of the Katana smart contract, which is still operational. Katana V3 is the latest version, which introduces concentrated liquidity, fee tiers, and improved oracles. When creating a liquidity pool, you can [choose to use](#switch-between-v2-and-v3) either Katana V2 or Katana V3.

## Features

* **Concentrated liquidity**: Katana v3 allows liquidity providers (LPs) to allocate their liquidity within a specific price range, significantly improving capital efficiency. LPs can now earn higher returns on their assets by concentrating their liquidity where it's most needed.
* **Fee tiers**: Katana v3 introduces multiple fee tiers to accommodate different types of trading pairs. This flexibility enables LPs to choose fee structures that best suit their risk/reward preferences and market conditions.
* **Improved oracles**: Katana v3 brings enhanced smart contract-based oracles that provide more accurate and reliable price feeds. These oracles help reduce the reliance on external data sources and increase the overall robustness of the system, ensuring better price feeds for on-chain transactions.
* **Lower swap fees**: thanks to the multiple fee tiers in Katana v3, users can enjoy lower swap fees for high-volume stablecoin pairs, making it more cost-effective to trade stablecoins on the platform.
* **Concentrated liquidity**: Katana V3 allows liquidity providers (LPs) to allocate their liquidity within a specific price range, significantly improving capital efficiency. LPs can now earn higher returns on their assets by concentrating their liquidity where it's most needed.
* **Fee tiers**: Katana V3 introduces multiple fee tiers to accommodate different types of trading pairs. This flexibility enables LPs to choose fee structures that best suit their risk/reward preferences and market conditions.
* **Improved oracles**: Katana V3 brings enhanced smart contract-based oracles that provide more accurate and reliable price feeds. These oracles help reduce the reliance on external data sources and increase the overall robustness of the system, ensuring better price feeds for on-chain transactions.
* **Lower swap fees**: thanks to the multiple fee tiers in Katana V3, users can enjoy lower swap fees for high-volume stablecoin pairs, making it more cost-effective to trade stablecoins on the platform.
* **Lower slippage**: concentrating liquidity within specific price ranges helps execute trades closer to the market price with less price impact, especially valuable during high volatility.

## Get started
Expand Down Expand Up @@ -55,15 +55,15 @@ For example, to stake an SLP/WRON token pair, you need to approve it first. Clic

<img src={approveTokens} width={1000} />

### Switch between v2 and v3
### Switch between V2 and V3

Check warning on line 58 in docs/apps/katana/overview.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Switch between V2 and V3' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Switch between V2 and V3' should use sentence-style capitalization.", "location": {"path": "docs/apps/katana/overview.mdx", "range": {"start": {"line": 58, "column": 5}}}, "severity": "WARNING"}

To switch between Katana v2 and v3, you can select the version you want to interact with.
To switch between Katana V2 and V3, you can select the version you want to interact with.

On the **Liquidity** page, click the **V2 Pools** or **V3 Pools** switch in the top left-hand corner of the pool list.

<img src={switchPools} width={1000} />

On the **Swap** page, go to **Transaction Settings** and select the version you want to use under **Default trade options**. The default setting is Katana v3.
On the **Swap** page, go to **Transaction Settings** and select the version you want to use under **Default trade options**. The default setting is Katana V3.

<img src={switchSwap} width={1000} />

Expand Down

0 comments on commit 62b983a

Please sign in to comment.