MANTRA DEX is a decentralized exchange (DEX) protocol that allows for permissionless pool and farm creation. The protocol is built around singleton contracts, which makes it easier to manage and integrate with other protocols.
To get started with MANTRA DEX, please go through the contributing guide to see the different ways to contribute to the project.
The following is the architecture of MANTRA DEX, and a general description of each contract:
---
title: MANTRA DEX
---
flowchart
P[Pool Manager] <--> I[Farm Manager]
P -.->|swap fees| P
P -->|protocol fees| F[Fee Collector]
I <-->|on_epoch_created| E[Epoch Manager]
I -->|protocol fees| F
click P "https://github.com/MANTRA-Finance/MANTRA-dex/tree/main/contracts/pool-manager" "Pool Manager"
click I "https://github.com/MANTRA-Finance/MANTRA-dex/tree/main/contracts/farm-manager" "Farm Manager"
click E "https://github.com/MANTRA-Finance/MANTRA-dex/tree/main/contracts/epoch-manager" "Epoch Manager"
click F "https://github.com/MANTRA-Finance/MANTRA-dex/tree/main/contracts/fee-collector" "Fee Collector"
The direction of the arrows represents the dependencies between the contracts.
The Pool Manager is the contract that manages the pools in the DEX. It is responsible for creating pool and handling swaps. Pool creation is permisionless, meaning anyone can create a pool if the fee is paid. The Pool Manager depends on the Farm Manager and the Fee Collector.
The Farm Manager is the contract that manages the farms in the protocol. It is responsible for creating and distributing rewards on pools. Farm creation is permissionless, meaning anyone can create a farm if the fee is paid. The Farm Manager depends on the Epoch Manager, as rewards are distributed based on epochs.
The Fee Collector collects the fees accrued by the protocol. Whenever a pool or a farm is created, a fee is sent to the Fee Collector. As of now, the Fee Collector does not have any other function.
The Epoch Manager is the contract that manages the epochs in the protocol. Its single responsibility is to create the epochs, which are used by the Farm Manager for distributing rewards.
Based on the dependencies between the contracts, the instantiation of the contracts is as follows:
- Epoch Manager
- Fee Collector
- Farm Manager
- Pool Manager
To build and deploy MANTRA DEX's smart contracts, there are a series of deployment scripts under scripts/. Alternatively,
there are a few just recipes you can take advantage of. You need at least Rust v1.65.0 to compile the contracts.
build_release.sh: builds the project artifacts, optimized for production.build_schemas.sh: generates schemas for the contracts.check_artifacts_size.sh: validates the size of the optimized artifacts. The default maximum size is 600 kB, though it is customizable by passing the number of kB to the script. For examplecheck_artifacts_size.sh 400verifies the artifacts are under 400 kB.
All recipes are found in the justfile. To see all available recipes, run just or just --list. Here are some of them:
build# Builds the whole project.optimize# Creates the optimized wasm files for deployment.fmt# Formats the rust, toml and sh files in the project.schemas# Generates the schemas for the contracts.
To run the tests, run cargo test. You can also run cargo tarpaulin -v to get test code coverage.
Use the contracts and the MANTRA DEX app at your own risk!
The MANTRA DEX contract's audit is currently in progress.
Security Policies and Procedures
This project is a fork of White Whale V2, which was originally licensed under the MIT License. You can find the original authors here.
Functionality wise, the code in the original project has been modified, but not limited to, the following:
- Epoch creation is now derived.
- Hooks have been removed.
- Pool, Farm and Positions ID derivation.
- Farm position emergency withdrawals.
- Emergency withdrawal fees distribution.
This project is now licensed under the Mozilla Public License 2.0.
Copyright (c) 2022-2024 White Whale Copyright (c) 2024-present MANTRA Chain