-
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.
Merge master into develop
- Loading branch information
Showing
322 changed files
with
1,626 additions
and
1,472 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
--- | ||
title: General | ||
sidebar_position: 0 | ||
--- | ||
|
||
# Overview | ||
|
||
<div class="text--justify"> | ||
|
||
Mangrove is an on-chain order book DEX that allows liquidity providers to post arbitrary smart contracts as offers. | ||
|
||
</div> | ||
|
||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
||
<img src={useBaseUrl('img/assets/home_page.png')} width="100%"/> | ||
|
||
## Total control over your offers | ||
|
||
<div class="text--justify"> | ||
|
||
Mangrove's order book-based DEX [lists promises instead of locked commitments](./general/high-level/concepts/makers-takers-keepers/README.md). Liquidity can be shared, borrowed, lent somewhere and at the same time displayed on Mangrove, ready to be sourced when (and only when) an offer is taken. | ||
|
||
</div> | ||
|
||
|
||
## Smart offers | ||
|
||
<div class="text--justify"> | ||
|
||
Smart contracts [can be attached to offers](./general/high-level/concepts/smart-offers.md), which gives the Maker total freedom in setting his sourcing trade parameters. | ||
|
||
</div> | ||
|
||
#### Powerful applications of smart offers | ||
|
||
<div class="text--justify"> | ||
|
||
* [**Reactive liquidity:**](./developers/terms/reactive-liquidity.md) liquidity on offer is not locked on the Mangrove order book. As long as an offer posted on Mangrove is not taken, it can generate yield elsewhere on the chain. | ||
|
||
* [**Last look:**](./developers/terms/last-look.md) smart offers allow you to code defensive mechanisms that adjust for market condition changes between offer posting and execution. | ||
|
||
* [**Bounty:**](./general/high-level/concepts/bounty.md) every single failed offer is compensated with a bounty; Keeper bots can make money, and Takers don't lose any. | ||
|
||
* **<font color="#47d77d">Permissionless:</font>** everyone can interact with the core protocol without having to ask permission nor risking to be censored. | ||
|
||
* **<font color="#47d77d">Non-custodial:</font>** Mangrove users retain full control over their funds - the exchange does not hold custody of their assets. | ||
|
||
</div> | ||
|
||
<div> | ||
<a class="button button--primary" href="../developers/strat-lib/getting-started/smart-offer">Post a smart offer</a> | ||
</div> | ||
|
||
## Deploy your own composable strategy | ||
|
||
<div class="text--justify"> | ||
|
||
Mangrove enables liquidity providers to incorporate defensive code, post unprovisioned offers, and redisplay liquidity after their offers are taken. | ||
</div> | ||
|
||
|
||
#### Full control over your strategy parameters | ||
|
||
<div class="text--justify"> | ||
|
||
* [**Amplified liquidity:**](./developers/terms/amplified-liquidity.md) optimize your trading potential by leveraging your liquidity across multiple pairs. For instance, you can create offers on WETH/USDC, WMATIC/USDC and WBTC/USDC pairs with an equal amount of USDC liquidity. | ||
|
||
* [**Multi-liquidity sourcing:**](./developers/terms/reactive-liquidity.md) your smart offer on Mangrove can take advantage of liquidity sourcing from other sources and offering it to the taker, allowing for profitable arbitrage opportunities. | ||
|
||
* [**Run AMMs strategies:**](./developers/strat-lib/README.md) provide liquidity on Mangroveβs order book in order to maximize your liquidity potential. | ||
|
||
</div> | ||
|
||
<div> | ||
<a class="button button--primary" href="./developers/strat-lib">Create your strategy</a> | ||
</div> | ||
|
||
## Kandel strategy | ||
|
||
<div class="text--justify"> | ||
|
||
|
||
[Kandel](./general/kandel/README.md) is an on-chain Automated Market Making strategy that focuses on order flow rather than price. It automatically posts Bids and Asks within your chosen market and price range to buy low and sell high, making a profit through the spread. | ||
|
||
</div> | ||
|
||
#### Features | ||
|
||
<div class="text--justify"> | ||
|
||
* **<font color="#47d77d">On-chain market making bot</font>** Kandel is a market-making bot equivalent that operates solely on the blockchain. Unlike off-chain market making bots that experience delays, Kandel uses on-chain order flow to repost offers instantly, without any latency. | ||
|
||
* **<font color="#47d77d">Profit from the spread:</font>** Kandel follows your configuration parameters to populate Bids and Asks offers. When those are taken, the profits are generated from the difference between the two, known as the spread.β | ||
|
||
* **<font color="#47d77d">Compounding:</font>** you have the opportunity to accumulate profits generated from spreads and reinvest them back into your offers, a process commonly known as compounding. On Kandel strategy, you can set the compounding rate. | ||
|
||
* **<font color="#47d77d">Price range:</font>** since Kandel is an automated market-making strategy, the price range needs to be set. It consists of the lowest and highest prices in the price grid at which the market maker is willing to post its bids and asks on Mangrove DEX. | ||
|
||
* **<font color="#47d77d">Earn extra yield on AAVE:</font>** since the liquidity on offer is not locked on the Mangrove order book, it can generate yield elsewhere on the chain. With Kandel, when an offer is taken, your liquidity can be sourced and redeposited on AAVE. | ||
|
||
</div> | ||
|
||
<div> | ||
<a class="button button--primary" href="./general/kandel">Deploy your Kandel</a> | ||
</div> | ||
|
||
## Mangrove is a secure protocol | ||
|
||
<div class="text--justify"> | ||
|
||
Mangrove is an open-source protocol that has been rigorously [audited](./general/high-level/audits.md) by the highly reputable and expert firm, ChainSec, ensuring the utmost security and reliability. | ||
|
||
</div> |
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 @@ | ||
--- | ||
title: Developers | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Welcome to the Developers doc | ||
|
||
The purpose of the Mangrove Developers doc is to: | ||
|
||
* learn about Mangrove [core protocol](./contracts/README.md), | ||
* understand how trading [strategies](./strat-lib/README.md) can be created and plugged in, | ||
* use and integrate our [SDK](./SDK/README.md), | ||
* set up [Keeper and Cleaning bots](./keeper-bots/README.md). | ||
|
||
|
||
We suggest you start by reading [this introduction](./contracts/README.md). | ||
If there's anything that is missing, or if you have questions, feel free to reach out via [Discord](https://discord.gg/rk9Qthz5YE). |
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/keeper-bots/background/_category_.json β ...developers/SDK/background/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Background", | ||
"position": 5, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
2 changes: 1 addition & 1 deletion
2
...contracts/getting-started/_category_.json β ...opers/SDK/getting-started/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Getting Started", | ||
"position": 2, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
2 changes: 1 addition & 1 deletion
2
docs/SDK/guides/_category_.json β docs/developers/SDK/guides/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Guides", | ||
"position": 3, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...acts/technical-references/_category_.json β .../SDK/technical-references/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Technical Reference", | ||
"position": 4, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 6 additions & 9 deletions
15
docs/contracts/README.md β docs/developers/contracts/README.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 |
---|---|---|
@@ -1,28 +1,25 @@ | ||
--- | ||
description: The Mangrove DEX is an on-chain, order book-based exchange where offers are code. | ||
title: Introduction | ||
sidebar_position: 1 | ||
--- | ||
|
||
|
||
# Introduction | ||
|
||
The Mangrove is an [EVM-compatible](https://ethereum.org/en/developers/docs/scaling/sidechains/#evm-compatibility) order book-based exchange protocol (a [DEX](https://ethereum.org/en/defi/)), in which offers can be bound to a [smart contract](https://ethereum.org/en/smart-contracts/). | ||
|
||
The order book of Mangrove lists promises to trade, instead of locked commitments. | ||
|
||
* Offer makers add [liquidity promises](./background/offer-maker.md) to Mangrove. They own offers in %%offer lists|offer-list%% and manage contracts that react to [offer execution](technical-references/taking-and-making-offers/reactive-offer/executing-offers.md). | ||
* Takers go to Mangrove to [find liquidity](background/offer-taker.md) by executing offers already in Mangrove. | ||
* [Governance](technical-references/governance-parameters/README.md) adjusts Mangrove parameters, sets fees, and opens and closes new markets. | ||
* Offer makers add [liquidity promises](./background/offer-maker.md) to Mangrove. They own offers in %%offer lists|offer-list%% and manage contracts that react to [offer execution](./technical-references/taking-and-making-offers/reactive-offer/executing-offers.md). | ||
* Takers go to Mangrove to [find liquidity](./background/offer-maker.md) by executing offers already in Mangrove. | ||
* [Governance](./technical-references/governance-parameters/README.md) adjusts Mangrove parameters, sets fees, and opens and closes new markets. | ||
|
||
> π‘ | ||
> For non technical information about Mangrove, check out the [Concepts](../high-level/README.md) section. | ||
> For non technical information about Mangrove, check out the [Concepts](../) section. | ||
## Where do I start? | ||
|
||
A good entry-point to the developer documentation for Mangrove protocol is the [Overview of Mangrove](./technical-references/overview.md) in the Technical Reference section. | ||
|
||
## Where can I join the community? | ||
|
||
The Mangrove project is open source. Follow and contribute on [GitHub](https://github.com/mangrovedao/), and join the [Mangrove Discord](https://discord.gg/rk9Qthz5YE). | ||
|
||
|
||
The Mangrove project is open source. Follow and contribute on [GitHub](https://github.com/mangrovedao/), and join the [Mangrove Discord](https://discord.gg/rk9Qthz5YE). |
2 changes: 1 addition & 1 deletion
2
docs/SDK/background/_category_.json β ...pers/contracts/background/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Background", | ||
"position": 5, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
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
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...strat-lib/getting-started/_category_.json β ...contracts/getting-started/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Getting Started", | ||
"position": 2, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
2 changes: 1 addition & 1 deletion
2
docs/strat-lib/guides/_category_.json β ...velopers/contracts/guides/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Guides", | ||
"position": 3, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
2 changes: 1 addition & 1 deletion
2
...-lib/technical-references/_category_.json β ...acts/technical-references/_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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Technical Reference", | ||
"position": 4, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.