Skip to content

Commit

Permalink
Antoine/webapp doc no strategies page (#249)
Browse files Browse the repository at this point in the history
* first pass on the Trade page of App guide

* fixing some oversized images

* implementing Gabi feedback for App guide

* fixing broken links

* completing How To Amplified Orders page

* adding Amplified Order to the trade.md page

* separate branch to pushed to develop, removed Strategies section

* fixing broken links and ref. to Strat section
  • Loading branch information
frkralj authored Feb 27, 2024
1 parent 3c1daee commit 7055eb8
Show file tree
Hide file tree
Showing 75 changed files with 150 additions and 690 deletions.
12 changes: 1 addition & 11 deletions docs/developers/strat-lib/guides/howtoGasreq.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ It's worth mentioning as well that there is a slightly more expensive path going

The difference between the two is just above `3000`, hence we add that and round up to get an optimum `gasreq` of `82000` for MangroveOrder.



### Kandel

#### Standard Kandel
Expand All @@ -47,12 +45,4 @@ Similarly to [MangroveOrder](#mangroveorder), there is a more expensive path goi
Similarly for the primary offer:
* `19675` is the comparable case for core (see [here](https://github.com/mangrovedao/mangrove-strats/blob/a265abeb96a053e386d346c7c9e431878382749c/test/strategies/kandel/Kandel.gasreq.t.sol#L27))
* `22841` is the more expensive path, if an offer existed in the same bin as the reposted offer (see [here](https://github.com/mangrovedao/mangrove-strats/blob/a265abeb96a053e386d346c7c9e431878382749c/test/strategies/kandel/Kandel.gasreq.t.sol#L28))
* The difference is just above `3000`, so we add both (`4000`) and round it up to get `126000`.

#### Kandel-Aave

With [Kandel-Aave](/docs/general/kandel/kandel-aave/kandel-aave.md), the Strategy reserve (Unallocated and Published liquidity) is deposited on Aave:

* The most expensive case is `624677` (see [here](https://github.com/mangrovedao/mangrove-strats/blob/a265abeb96a053e386d346c7c9e431878382749c/test/strategies/kandel/Kandel.gasreq.t.sol#L33-L34))
* However, that is with a specific pair of tokens, so it's not an upper bound.
* With the additional `4000` previously calculated and some rounding up, we amount to `629000`.
* The difference is just above `3000`, so we add both (`4000`) and round it up to get `126000`.
13 changes: 1 addition & 12 deletions docs/general/FAQ/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,10 @@ Here are a few reasons as to why your transactions are failing on Mangrove excha
* The [density](../../developers/terms/density.md) for your Limit order is too low - if you're trying to place a Limit order with a small amount, your order will fail and will not be executed. Mangrove requires that you provide a token amount greater than the amount of gas the triggered offer requires to be executed (called density).
* You can check the minimum volume required to post a limit order [here](../web-app/trade/how-to-limit-order.md).

💡 Note: if you still want to place a limit order with a small amount (ex: 10 USDC), you can avoid the density check by using [IOC (Immediate Or Cancel)](../web-app/trade/more-on-order-types.md#immediate-or-cancel-ioc) orders.
💡 Note: if you still want to place a limit order with a small amount (ex: 10 USDC), you can avoid the density check by using [IOC (Immediate Or Cancel)](../web-app/trade/more-on-order-types.md#immediate-or-cancel-ioc) orders.

</details>


<details><summary>

### Who pays the fees on Mangrove?
</summary>
Fees on Mangrove are paid by the taker: The fee is taken from the tokens that the taker has bought.

Read more about fees [here](../web-app/trade/taker-fee.md), and also [here](../../developers/protocol/technical-references/governance-parameters/local-variables.md#taker-fees)
</details>


<details><summary>

### The approval amount for my limit orders seems odd - what is going on?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ sidebar_position: 2

# How does Kandel work?


This section is a detailed explanation of how Kandel works, introducing configuration parameters and key mechanics. For the sake of simplicity, we have clearly separated the startup steps and picked round numbers.

For a detailed explanation on how to create and manage a Kandel strategy on Mangrove's UI, you can view the [Create a strategy](../../web-app/strategies/create-strat.md) and [Manage a strategy](../../web-app/strategies/manage-strat/README.md) pages on our Web App documentation.

:::info Note
Kandel is not intended as a "set and forget" strategy, and needs ongoing maintenance and checks.
:::
Expand Down
5 changes: 0 additions & 5 deletions docs/general/kandel/kandel-aave/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/general/kandel/kandel-aave/kandel-aave.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/general/kandel/potential-risks/potential-risks.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,3 @@ You understands that even though the strategy has been implemented by an experie
* Lack of transparency in crypto asset management and markets;

That being said, please note that the **Kandel strategy has been thoroughly audited** by ChainSecurity.


## AAVE

Kandel on AAVE exposes users to potential risks associated with AAVE protocol. More details can be found on [AAVE documentation](https://docs.aave.com/risk/asset-risk/methodology).
5 changes: 0 additions & 5 deletions docs/general/table-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ An extensive guide on how to use our dApp to place orders as well as to create y
* [Who is the Mangrove DEX for?](./web-app/README.md)
* [How to connect your wallet](./web-app/how-to-connect-wallet/how-to-connect-wallet.md)
* [Trade](./web-app/trade/trade.md)
* [Strategies](./web-app/strategies/README.md)
* [Create a strategy](./web-app/strategies/create-strat.md)
* [Manage a strategy](./web-app/strategies/manage-strat/README.md)
* [Key Actions/Questions](./web-app/strategies/key-actions-questions/README.md)

### Terms and Conditions

Expand All @@ -56,7 +52,6 @@ An in-depth coverage of our Kandel strategy.
* [Choose the right parameters](./kandel/how-does-kandel-work/choosing-parameters.md)
* [Strategy reserve](./kandel/how-does-kandel-work/strategy-reserve.md)
* [More on failing offers](./kandel/how-does-kandel-work/more-on-failing-offers.md)
* [Kandel-Aave](./kandel/kandel-aave/kandel-aave.md)
* [Potential risks](./kandel/potential-risks/potential-risks.md)

### Quick links
Expand Down
4 changes: 2 additions & 2 deletions docs/general/web-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1

# Who is the Mangrove DEX for?

The Mangrove DEX offers a range of functionalities including swapping, limit orders, and the ability to deploy strategies, catering to different levels of DeFi users from beginners to experienced.<br /><br />
While swapping is accessible to all types of users, [limit orders](./trade/how-to-limit-order.md) may be a bit more complex, and strategies are more suitable for experienced DeFi users.
The Mangrove DEX offers a range of functionalities including market orders, limit orders, and the ability to deploy strategies, catering to different levels of DeFi users from beginners to experienced.<br /><br />
While market orders are accessible to all types of users, [limit orders](./trade/how-to-limit-order.md) may be a bit more complex, and strategies are more suitable for experienced DeFi users.

As of now, only the [trade](./trade/trade.md) page is available (more coming soon).
32 changes: 15 additions & 17 deletions docs/general/web-app/how-to-connect-wallet/how-to-connect-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@ sidebar_position: 2

# How to connect your wallet

We suggest using Metamask as it's currently considered a highly reliable and stable wallet option.
We suggest using Metamask as it's currently considered a highly reliable and stable wallet option. You're free to choose others if you wish.
Down below, you will find detailed steps to:

* [Connect to Mangrove mainnet](./how-to-connect-wallet.md#steps-to-connect-to-mangrove-mainnet-and-testnet) (and testnet)
* [Get some test tokens](./how-to-connect-wallet.md#steps-to-get-some-test-tokens-testnet) to spend on Mangrove testnet

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/assets/connect-metamask.gif')} width="70%"/>


## Steps to connect to Mangrove mainnet and testnet

1. Go to our [testnet app](https://testnet.mangrove.exchange/), and connect your wallet by clicking on "Connect my wallet" - choose Metamask.
1. Go to the Mangrove [app](https://app.mangrove.exchange/trade) (or [testnet app](https://testnet.mangrove.exchange/)), and connect your wallet by clicking on "Connect my wallet" - choose Metamask.

<img src={useBaseUrl('img/assets/connect-wallet-metamask.png')} width="500px"/><br /><br />
<img src={useBaseUrl('img/assets/connect-wallet-metamask.png')} width="100%"/><br /><br />

2. Select which account(s) you'd like to connect. Click "Next", and then "Connect".

<img src={useBaseUrl('img/assets/connect-wallet-account.png')} width="500px"/><br /><br />
<img src={useBaseUrl('img/assets/connect-wallet-account.png')} width="100%"/><br /><br />

3. Mangrove is live on both Polygon mainnet, and Polygon Mumbai testnet.
3. Mangrove app is live on both Arbitrum and Polygon mainnet.

* **Arbitrum**: you need to be connected to the Arbitrum network. If you see a "Unsupported Network" pop-up, click "Switch network".
* **Polygon mainnet**: you need to be connected to the Polygon mainnet. If you see a "Unsupported Network" pop-up, click "Switch network".
* **Polygon Mumbai testnet**: you need to be connected to the Polygon Mumbai test network.
* **Polygon Mumbai testnet**: you need to be connected to the Polygon Mumbai test network ([testnet app](https://testnet.mangrove.exchange/) only).

:::info Note
If you see a "Unsupported Network" pop-up, click "Switch network".
Expand Down Expand Up @@ -70,24 +70,22 @@ In case you do get a Chain ID error, you'll need to add the network manually. Re

* You're done! You can now head back to Mangrove app.


## Steps to get some test tokens (testnet)

1. Click on the three dots on the top right corner, and click 'Faucet".
<img src={useBaseUrl('img/assets/test-tokens-faucet-list.png')} width="500px"/>
1. Click on your connected account at the top right corner, and then choose 'Faucet".
<img src={useBaseUrl('img/assets/test-tokens-faucet-list.png')} width="100%"/>

2. A pop-up opens; you will need to get some natic tokens for gas fees (in MATIC), as well as one of the three available currencies available on Mangrove testnet at the moment (WETH, USDC, DAI).
2. A new page will open, giving you options to grab various tokens. Feel free to click them out on the right, and get test tokens for yourselve. Remember that you will also need to get some natic tokens for gas fees (in MATIC), as well as one of the three available currencies available on Mangrove testnet at the moment (WETH, USDC, DAI).

3. To add MATIC tokens:
* Click "Go to Mumbai MATIC faucet"
* A new tab opens - key in your account address to receive the tokens.
<img src={useBaseUrl('img/assets/test-tokens-matic.png')} width="500px"/>
* Head over this [page](https://faucet.polygon.technology/)
* Key in your account address to receive the tokens.
<img src={useBaseUrl('img/assets/test-tokens-matic.png')} width="100%"/>

* Make sure the "Mumbai" testnet is selected, as well as "MATIC" tokens
* Click "Submit", and "Confirm"
* Done - a message displays, telling you you should receive your MATIC tokens within 1-2min


4. To add WBTC, WMATIC or USDT:
* Click on "WBTC", "WMATIC", or "USDT" on the faucet pop-up
* A field appears - type in an amount (or hit "Max"), and click "Mint".
Expand Down
15 changes: 0 additions & 15 deletions docs/general/web-app/strategies/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/general/web-app/strategies/_category_.json

This file was deleted.

85 changes: 0 additions & 85 deletions docs/general/web-app/strategies/create-strat.md

This file was deleted.

25 changes: 0 additions & 25 deletions docs/general/web-app/strategies/key-actions-questions/README.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 7055eb8

Please sign in to comment.