-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update of Kandel and WebApp doc * Other update of Kandel doc * Fixing issue * Fixing issue #2 * Strat, Swap and Kandel doc edits * Adding Revoke tuto + edit of Bounty in Kandel/param table * Adding Taker fee section in Web App * Adding example for Taker fee * adding protocol fee img + Ratio/Nb price points description * typos, add-ons and tweaks to Kandel param. and Web App strat
- Loading branch information
Showing
53 changed files
with
663 additions
and
40 deletions.
There are no files selected for viewing
This file was deleted.
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
description: How does Kandel work | ||
sidebar_position: 6 | ||
sidebar_position: 5 | ||
--- | ||
|
||
|
||
|
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
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
description: How does Kandel work | ||
sidebar_position: 5 | ||
sidebar_position: 4 | ||
--- | ||
|
||
|
||
|
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
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,15 @@ | ||
--- | ||
description: Strategies | ||
sidebar_position: 1 | ||
--- | ||
|
||
|
||
# Strategies | ||
|
||
Mangrove allows liquidity providers, traders and strategists to deploy their own composable strategies. Strategies leverage Mangrove's core principles to incorporate defensive code, post unprovisioned offers, and redisplay liquidity after their offers are taken. | ||
|
||
Currently, Mangrove has one available strategy for users: [Kandel](../../kandel/README.md). | ||
|
||
* If you would like more information regarding Kandel strategy, head over the [dedicated documentation section](../../kandel/README.md). | ||
|
||
* If you would like to create and manage your own Kandel strategy, check out [Create a Strategy](./create-strat.md). |
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,5 @@ | ||
{ | ||
"label": "Strategies", | ||
"position": 5, | ||
"collapsed": false | ||
} |
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,84 @@ | ||
--- | ||
description: Create a strategy | ||
sidebar_position: 2 | ||
--- | ||
|
||
|
||
# Create a strategy | ||
|
||
|
||
## Step 1/3 - Create strategy | ||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
||
1. Click on the "New Strategy" button on the "Your Strategies" tab and accept the Terms and Conditions after reading them. | ||
|
||
<img src={useBaseUrl('img/assets/create_strat.png')} width="70%"/> | ||
|
||
2. Choose a strategy type between "Kandel" and "Kandel on AAVE". | ||
* [Kandel](../../kandel/README.md) is an automated market-making strategy that utilizes a reserve to place buy and sell orders on Mangrove DEX | ||
* [Kandel on AAVE](../../kandel/details-on-strats/#kandel-on-aave) is essentially the same as the Kandel strategy, but it also earns extra yield by depositing the reserve on the AAVE platform until the liquidity is needed to fulfill a trade. | ||
|
||
3. Choose a market and click on "Next." | ||
|
||
## Step 2/3 - Strategy parameters | ||
|
||
:::info | ||
Average return: the average monthly return of kandels for this market | ||
::: | ||
:::info | ||
Risk appetite: | ||
* Low: corresponds to a low volatily pair (ex: stable/stable, such as USDC/USDT) | ||
* Medium: corresponds to a medium volatily pair (ex: volatile/stable, such as WBTC/USDT) | ||
* High: corresponds to a high volatily pair (ex: volatile/volatile, such as WBTC/WMATIC) | ||
::: | ||
<br /> | ||
|
||
4. Determine your desired price range by dragging the limits on the market depth chart, setting the minimum and maximum price values, or using the percentage inputs. The market depth chart displayed on the strategy page allows you to see the real-time buy (<font color="#5cd19b">Bids</font>) and sell (<font color="#eb525a">Asks</font>) offers on the Mangrove DEX for a given market. | ||
|
||
<img src={useBaseUrl('img/assets/strat_parameters_1.png')} width="70%"/> | ||
<br /><br /> | ||
|
||
5. Choose the settings of your new Kandel strategy: | ||
* Number of price points | ||
* Ratio | ||
* Step size | ||
|
||
> 💡 | ||
> More information in the [Kandel documentation](../../kandel/how-does-kandel-work/parameters.md). | ||
<img src={useBaseUrl('img/assets/strat_parameters_2.png')} width="70%"/> | ||
<br /><br /> | ||
|
||
6. Choose your initial inventory for both tokens. | ||
|
||
> 💡 | ||
> Use the "Update amount" button to automatically set the minimum recommended amounts. | ||
<img src={useBaseUrl('img/assets/strat_parameters_3.png')} width="70%"/> | ||
<br /> | ||
|
||
7. Choose a bounty amount. | ||
|
||
8. Click on "Review Strategy". | ||
|
||
|
||
## Step 3/3 - Review strategy | ||
|
||
9. Check your strategy parameters carefully: | ||
* If you want to edit them, click on "Back" | ||
* If you're ready to launch, click on "Launch strategy" | ||
|
||
<br /> | ||
<img src={useBaseUrl('img/assets/strat_parameters_4.png')} width="70%"/> | ||
<br /> | ||
|
||
10. "Waiting for confirmation": you will be asked to sign 4 transactions in a row, including the deployment of your Kandel contract, the spending approvals of your pair's tokens, and the native token amount to be deposited for [bounty](../../glossary.md#bounty). | ||
> 💡 | ||
> when signing on Metmamask, select "Use default" to set the appropriate amount of Approval. | ||
11. Select on 'View strategy' to manage your strategy, or click 'Done' to go back to the Strategies page. | ||
|
||
<br /> | ||
Congratulations!<br /> | ||
Your Kandel strategy is now live and ready to start publishing buy and sell orders on the Mangrove order book. |
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,25 @@ | ||
--- | ||
description: Key Actions/Questions | ||
sidebar_position: 1 | ||
--- | ||
|
||
|
||
# Key Actions/Questions | ||
|
||
|
||
1. [How to edit your strategy price range?](./how-to-edit-price-range.md) | ||
|
||
2. [How to deposit inventory?](./how-to-deposit-inventory.md) | ||
|
||
3. [How to withdraw inventory?](./how-to-withdraw-inventory.md) | ||
|
||
4. [How to publish inventory?](./how-to-publish-inventory.md) | ||
|
||
5. [How to unpublish inventory?](./how-to-unpublish-inventory.md) | ||
|
||
6. [How to add additional bounty?](./how-to-add-bounty.md) | ||
|
||
7. [How to close your strategy?](./how-to-close-strat.md) | ||
|
||
8. [How to reopen your strategy?](./how-to-reopen-strat.md) | ||
|
5 changes: 5 additions & 0 deletions
5
docs/web-app/strategies/key-actions-questions/_category_.json
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,5 @@ | ||
{ | ||
"label": "Key Actions/Questions", | ||
"position": 6, | ||
"collapsed": false | ||
} |
19 changes: 19 additions & 0 deletions
19
docs/web-app/strategies/key-actions-questions/how-to-add-bounty.md
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,19 @@ | ||
--- | ||
description: How to add additional bounty? | ||
sidebar_position: 7 | ||
--- | ||
|
||
|
||
# How to add additional bounty? | ||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Select "Manage" for the strategy that you would like to add bounty to | ||
|
||
3. Choose the "Parameters" tab | ||
|
||
4. Click "Add Bounty" | ||
|
||
5. On the card that appears, input the amount of native tokens you want to deposit and click on "Review" | ||
|
||
6. Review the information provided on the card, click "Add bounty" and sign the transaction |
20 changes: 20 additions & 0 deletions
20
docs/web-app/strategies/key-actions-questions/how-to-close-strat.md
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,20 @@ | ||
--- | ||
description: How to close a strategy? | ||
sidebar_position: 8 | ||
--- | ||
|
||
|
||
# How to close a strategy? | ||
|
||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Select "Manage" for the strategy that you would like to close | ||
|
||
3. Click on the "Close strategy" button in the top right corner | ||
|
||
4. You will be asked to confirm if you want to close the strategy - select "Yes, close strategy" | ||
> 💡 | ||
> You can [reopen a closed strategy](./how-to-reopen-strat.md) at any time | ||
5. After processing, you can view your strategies list by clicking "View strategies" - you will be brought back to the main Mangrove Strategies tab |
27 changes: 27 additions & 0 deletions
27
docs/web-app/strategies/key-actions-questions/how-to-deposit-inventory.md
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,27 @@ | ||
--- | ||
description: How to deposit inventory? | ||
sidebar_position: 3 | ||
--- | ||
|
||
|
||
# How to deposit inventory? | ||
|
||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Select "Manage" for the strategy that you would like to deposit inventory into | ||
|
||
3. Choose the "Parameters" tab | ||
|
||
4. Click on "Deposit" | ||
|
||
5. On the card that appears, input the amounts of Token A and Token B you want to deposit and click on "Review" | ||
|
||
6. Review the information provided on the card, click on "Deposit" and confirm the transaction(s) on your wallet | ||
|
||
7. If you want to publish your liquidity later, click on "Done" | ||
|
||
8. If you want to publish your liquidity now: | ||
* Click on "Publish now" | ||
* Review the information provided on the card, click on "Publish" and confirm the transaction on your wallet provider | ||
* Sign the transaction, wait for confirmation and choose between clicking on "View strategy" to manage your strategy or selecting "Done" to go back to the Strategies page |
17 changes: 17 additions & 0 deletions
17
docs/web-app/strategies/key-actions-questions/how-to-edit-price-range.md
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,17 @@ | ||
--- | ||
description: How to edit your strategy price range? | ||
sidebar_position: 2 | ||
--- | ||
|
||
|
||
# How to edit your strategy price range? | ||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Select "Manage" for the strategy that you would like to modify the [price range](../../../kandel/how-does-kandel-work/step-by-step-visual-explanation.md#price-distribution) of | ||
|
||
3. Choose the "Parameters" tab | ||
|
||
4. On the Price range container, click on the "Edit" button | ||
|
||
5. [Determine your desired price range](../../../kandel/how-does-kandel-work/parameters.md) by dragging the limits on the market depth chart, setting the minimum and maximum price values, or using the percentage inputs. The market depth chart displayed on the strategy page allows you to see the real-time buy (Bids) and sell (Asks) offers on the Mangrove DEX for a given market. |
23 changes: 23 additions & 0 deletions
23
docs/web-app/strategies/key-actions-questions/how-to-publish-inventory.md
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,23 @@ | ||
--- | ||
description: How to publish inventory? | ||
|
||
sidebar_position: 5 | ||
--- | ||
|
||
|
||
# How to publish inventory? | ||
|
||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Select "Manage" for the strategy that you would like to publish inventory to | ||
|
||
3. Choose the "Parameters" tab | ||
|
||
4. Click on "Publish" | ||
|
||
5. On the card that appears, input the amounts of Token A and Token B you want to publish and click on "Review" | ||
|
||
6. Review the information provided on the card, click on "Publish" and confirm the transaction on your wallet provider | ||
|
||
7. Sign the transaction, wait for confirmation and choose between clicking on "View strategy" to manage your strategy or selecting "Done" to go back to the Strategies page |
30 changes: 30 additions & 0 deletions
30
docs/web-app/strategies/key-actions-questions/how-to-reopen-strat.md
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,30 @@ | ||
--- | ||
description: How to reopen a strategy? | ||
sidebar_position: 9 | ||
--- | ||
|
||
|
||
# How to reopen a strategy? | ||
|
||
|
||
You can reopen a strategy that has been closed previously: | ||
|
||
1. Go to the [Mangrove dApp](https://app.mangrove.exchange/) and click on the Strategies tab | ||
|
||
2. Click the "Re-open" button of one of your closed strategy | ||
|
||
3. On the card that appears, click on "Yes, continue" | ||
|
||
4. [Determine your desired price range](../../../kandel/how-does-kandel-work/parameters.md) by dragging the limits on the market depth chart, setting the minimum and maximum price values, or using the percentage inputs. The market depth chart displayed on the strategy page allows you to see the real-time buy (Bids) and sell (Asks) offers on the Mangrove DEX for a given market | ||
|
||
5. Set the Number of price points, Ratio and Step size. | ||
|
||
6. Choose your [initial inventory](../../../kandel/how-does-kandel-work/parameters.md) for both tokens | ||
|
||
7. Choose a [bounty amount](../../../kandel/how-does-kandel-work/parameters.md),then then click on "Review Strategy" | ||
|
||
8. Check your strategy parameters carefully. If you want to edit them, click on "Back". If you agree with them, click on "Launch strategy" | ||
|
||
9. Sign the various confirmations, then choose between clicking on "View strategy" to manage your strategy or selecting "Done" to go back to the Strategies page | ||
|
||
|
Oops, something went wrong.