Skip to content

Commit

Permalink
fix: address feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
RodinGolodin committed Jun 4, 2024
1 parent 2b4e210 commit be08eac
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 29 deletions.
Binary file modified docs/apps/katana/assets/katana-farm-claim-success.png
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-farm-individual-claim.png
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-farm-positions-claim.png
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-farm-stake-amount.png
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-farm-stake-position.png
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-farm-stake-success.png
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-farm-unstake-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 0 additions & 15 deletions docs/apps/katana/guides/create-farm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,6 @@ slug: /apps/katana/create-farm
description: Create a farm on Katana to encourage users to contribute liquidity to your pool.
---

import katanaIncentivizePool from './../assets/katana-incentivize-pool.png'
import katanaCreateNewPool from './../assets/katana-create-new-pool.png'
import katanaCreatePoolSuccess from './../assets/katana-create-pool-success.png'
import katanaConfirmPoolCreation from './../assets/katana-confirm-pool-creation.png'
import katanaConfigureFarmRewards from './../assets/katana-configure-farm-rewards.png'
import katanaEditPublishedFarm from './../assets/katana-edit-published-farm.png'
import katanaEditPublishedFarmConfirm from './../assets/katana-edit-published-farm-confirm.png'
import katanaEditScheduledFarm from './../assets/katana-edit-scheduled-farm.png'
import katanaEditScheduledFarmConfirm from './../assets/katana-edit-scheduled-farm-confirm.png'
import katanaEditScheduledPool from './../assets/katana-edit-scheduled-pool.png'
import katanaConfirmPoolIncentive from './../assets/katana-confirm-pool-incentive.png'
import katanaIncentivizePoolSuccess from './../assets/katana-incentivize-pool-success.png'
import katanaIncentivizeSupply from './../assets/katana-incentivize-supply.png'
import katanaSelectTokenPair from './../assets/katana-select-token-pair.png'

## Overview

This guide is for token creators who want to create a farm on Katana to encourage users to contribute liquidity to their pool. A farm is a way for users to earn rewards by staking their liquidity pool (LP) tokens. When users see that your pool offers farm rewards, they're encouraged to provide more liquidity, which increases the trading volume of the pool and reduces slippage when users swap the pool's tokens.
Expand Down
36 changes: 22 additions & 14 deletions docs/apps/katana/guides/stake-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Stake LP tokens
toc_max_heading_level: 2
---

import katanaFarmClaimSuccess from '../assets/katana-farm-claim-success.png';

Check warning on line 8 in docs/apps/katana/guides/stake-tokens.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Semicolons] Use semicolons judiciously. Raw Output: {"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/apps/katana/guides/stake-tokens.mdx", "range": {"start": {"line": 8, "column": 77}}}, "severity": "INFO"}
import katanaFarmStakeSuccess from '../assets/katana-farm-stake-success.png';

Check warning on line 9 in docs/apps/katana/guides/stake-tokens.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Semicolons] Use semicolons judiciously. Raw Output: {"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/apps/katana/guides/stake-tokens.mdx", "range": {"start": {"line": 9, "column": 77}}}, "severity": "INFO"}
import katanaFarmUnstakeSuccess from '../assets/katana-farm-unstake-success.png';

Check warning on line 10 in docs/apps/katana/guides/stake-tokens.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Semicolons] Use semicolons judiciously. Raw Output: {"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/apps/katana/guides/stake-tokens.mdx", "range": {"start": {"line": 10, "column": 81}}}, "severity": "INFO"}

## Overview

When you provide liquidity to a pool on Katana, you receive liquidity pool (LP) tokens in return. You can stake these LP tokens in a farm to earn rewards in the form of another ERC20 token, which is chosen by the farm creator. A farm can offer more than one reward token to choose from. Generally, the more LP tokens you stake, the more reward tokens you earn. Farming is available for a limited number of pools at any given time.
Expand All @@ -24,13 +28,13 @@ To farm tokens on Katana, you need to have LP tokens that you can stake. To acqu

![Stake panel](../assets/katana-farm-stake-panel.png)

6. Enter the amount of LP tokens you want to stake. You can also click **Max** to stake the maximum amount of LP tokens you have in this pool. When you're ready, click **Stake** and confirm the transaction in your Ronin Wallet.
6. Select the reward token, then enter the amount of LP tokens you want to stake, and then click **Stake**.

![Enter stake amount](../assets/katana-farm-stake-amount.png)

Your transaction is now submitted to the blockchain. When it completes, Katana displays a confirmation pop-up. Close it or click **View on explorer** to see the detailed information about the transaction.
Confirm the transaction in your Ronin Wallet. When the transaction completes, Katana displays a confirmation pop-up.

![Successful staking](../assets/katana-farm-stake-success.png)
<img src={katanaFarmStakeSuccess} width={400} />

After staking, you can see an update in your total LP tokens staked and available in wallet.

Expand All @@ -40,23 +44,27 @@ Congratulations, you are now farming tokens on Katana.

## Claim reward tokens

### Claim from the My positions tab
You can claim rewards from the list of your positions or from the pool's details page.

### Claim from My positions

Check warning on line 49 in docs/apps/katana/guides/stake-tokens.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Headings] 'Claim from My positions' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Claim from My positions' should use sentence-style capitalization.", "location": {"path": "docs/apps/katana/guides/stake-tokens.mdx", "range": {"start": {"line": 49, "column": 5}}}, "severity": "WARNING"}

Open the **Liquidity pool** page, then select **My positions**, and then click **Claim** next to the pool you want to claim rewards from.

![Claim from My positions](../assets/katana-farm-positions-claim.png)

### Claim from the Farm rewards tab
Confirm the transaction in your Ronin Wallet. When the transaction completes, Katana displays a confirmation pop-up.

Select the pool to claim rewards from, then open the **Farm rewards** tab, and then click **Claim all**.
<img src={katanaFarmClaimSuccess} width={400} />

![Claim from individual pool](../assets/katana-farm-individual-claim.png)
### Claim from individual pool

After clicking either of the buttons, confirm the transaction in your Ronin Wallet.
Select the pool to claim rewards from, then in the **Farm Rewards** section, click **Claim**.

![Claim from individual pool](../assets/katana-farm-individual-claim.png)

When the transaction completes, Katana displays a confirmation pop-up. Close it or click **View on explorer** to see the detailed information about the transaction.
Confirm the transaction in your Ronin Wallet. When the transaction completes, Katana displays a confirmation pop-up.

![Successful claim](../assets/katana-farm-claim-success.png)
<img src={katanaFarmClaimSuccess} width={400} />

## Stop farming

Expand All @@ -66,16 +74,16 @@ To stop farming, you need to unstake the LP tokens from a farm pool. Unstaking m

![Unstake panel](../assets/katana-farm-unstake-panel.png)

2. Enter the amount of LP tokens you want to unstake. You can also click **Max** to unstake all your LP tokens. When you're ready, click **Unstake** and confirm the transaction in your Ronin Wallet.
2. Enter the amount of LP tokens you want to unstake, then click **Unstake**.

![Enter unstake amount](../assets/katana-farm-unstake-amount.png)

Your transaction is now submitted to the blockchain. When it completes, Katana displays a confirmation pop-up. Close it or click **View on explorer** to see the detailed information about the transaction.
Confirm the transaction in your Ronin Wallet. When the transaction completes, Katana displays a confirmation pop-up.

![Successful unstaking](../assets/katana-farm-unstake-success.png)
<img src={katanaFarmUnstakeSuccess} width={400} />

After unstaking, you can see an update in your total LP tokens staked and available in wallet reflective of the changes you made.

![Position after unstaking](../assets/katana-farm-unstake-position.png)

Congratulations, you have successfully stopped farming tokens on Katana.
Congratulations, you have successfully stopped farming tokens on Katana.

0 comments on commit be08eac

Please sign in to comment.