Smart contract architecture

^Architecture

^Descriptions

1. ^{MagicRouter.sol is the router contract. Users will only need to approve this contract to spend their ERC20 tokens. Similar to Uniswap, approval is required to interact with any trading pair on this contract. Router contract will interact with the lower layer MagicPP.sol to execute the sell logic and send back users the desired amount of tokens.}

2. ^{MagicPP.sol is the basic contract that handles the logic operation of the DEX, including setting the token info, calculating slippage, calculating the exchange amount and so on. This contract stores all tokens that are supported by trading on the Magic Swap. In this contract, it defines quote token and base token. Quote token is the reference token in the contract and there is only one quote token. The contract can have multiple base tokens and they can be added by the strategist.}

3. ^{Magicoracle.sol is an oracle contract managed and developed by Magic Network team. It uploads the latest trading price, middle price and market spread information from Magic Network to the oracle contract.}

4. ^{MagicGuardian.sol is the smart contract that is used to perform final checkup on the trade execution. The smart contract does not process funds. It provides the tolerance threshold of prices by comparing multiple oracles. For the swap amounts and quoted prices, the functions (i.e., checkSwapAmount() and checkSwapPrice()) in this smart contract are used to check if the swapping amounts and prices are within the thresholds or not.}

5. ^{MagicFeeManager.sol collects swap fees of transactions processed in Magic-Fi's oPMM liquidity pool and distribute to various pools}

6. ^{MagicRebateManager.sol collects and distributes rebates to broker addresses (if any)}

7. ^{MagicVaultManager.sol collects the fee allocated to vaults and executes MARBLE buy back before distributing to vaults}

8. ^{MagicStakingVault.sol is the smart contract to allow users to stake MARBLE token and receive xMARBLE token. It also manages the unstaking period and penalty}

9. ^{MagicAccessManager.sol manages the access of Magic-Fi smart contracts}

10. ^{SuperChargerVault.sol is the Magic-Fi Earn Supercharger smart contract that users deposit assets into}

11. ^{LendingManager.sol is the smart contract that the Magic-Fi LP interacts with to borrow, repay loans and set borrowing interests}

12. ^{WithdrawManager.sol stores the funds that users request for withdrawal after the settlement process}

13. ^{YieldFarmingVault.sol is the vault that stores assets deployed for external yield farming}

14. ^{YieldFarmingStrategy.sol manages the external yield farming auto-compounding strategy}