# Introduction **Welcome to Minimax.finance — a Web3 SuperApp!** **With Minimax you can explore thousands of Swap, Earn, and Bridge opportunities across web3 and use them through a unified interface without having to switch between different apps and blockchains. Explore opportunities and interact with decentralized web — all in one place!** Our mission is to make it easier for users to interact with Web3 space, putting together a wide range of opportunities. Minimax.finance users can see their portfolio like in DeBank, explore new opportunities like in DeFiLama, and interact with the other apps like in Zapper – all of this without switching between various Web3 dApps. **App Structure** **‘Portfolio’** **section** gives you a detailed overview of the tokens you own regardless of the blockchain on which they are allocated. You can easily monitor the price of each token and the whole balance of your assets, denominated in dollars, and adjust it in accordance with the market changes. There we have also placed information about all deposits, made via our platform, and old Minimax positions.

The view of the page when user's wallet isn't connected

The view of the page when the wallet is connected

On the **‘Discover’** **page** you can find the up to date information about various popular Web3 protocols, including information about networks, token price, Mcap, TVL, Mcap/TVL (if these figures can be collected).
Minimax **‘Earn’ page** enables you to choose the best from multiple offers and make your tokens work. All the vaults displayed at the platform are sourced from third-party DeFi applications. Currently you can stake single assets and LP tokens on Minimax. Our platform lets you enjoy the great benefits of DeFi like high APYs and ease of asset manipulation, storing multiple Web3 apps in one place.
On Minimax you can enter any vault with any liquid token without having to use a DEX with the help of our unique feature — **conversion depositing**. Let’s assume that you found a vault with an attractive APY/APR, e.g. CAKE-BUSD LP token vault. In the old days you needed to buy CAKE and BUSD at a DEX. After that you had to go to Pancakeswap and bundle them into the CAKE-BUSD LP tokens. And only after that you were able to deposit the LP tokens to the vault. Now you can use any liquid token (like BNB, DOT, BSW and hundreds of others) to enter any vault. Our platform will seamlessly do all the necessary conversion and bundling operations for you. Now you need to do just one operation on our dApp instead of 4 or 5 operations on various dApps. Save yourself a lot of time and hassle. We’ve integrated our platform with 1inch DEX aggregator which defines the optimal routes for token swaps, providing you with the best exchange rates. In addition to this our smart contracts bundle the single tokens into LP tokens when necessary. **‘Swap’ section** allows you to do exchanges both within one blockchain and between chains directly on Minimax.finance. Minimax uses 1inch Router v4 for swaps within the same network and deBridge v1 for multichain swaps.
**Full ownership** Minimax.finance smart contracts don't have control over the positions opened via the ‘Earn’ section. All transactions made via Minimax are controlled by your wallet. We use our auxiliary smart contracts only to help make necessary swaps with the conversion depositing feature. If you don’t need to use the conversion depositing, you won’t interact with our smart contracts at all. **It minimizes your risks** while using Minimax — even if our platform gets hacked, you won’t lose your money. **Security Partnerships and Integrations** We have already integrated 9 blockchains, including BSC, Polygon, Fantom, Avalanche, Arbitrum, Aurora, Moonbeam, Ethereum, Meter, and 15 web3 apps with more apps and chains up next. In the future we will add more exciting features, which will help us in our mission to provide our users a high-level overview of the web3 space and the ability to interact with multiple web3 apps directly via Minimax.
# FAQ ### **Why should I use Minimax?** **We help you to save some time and avoid unnecessary headaches.** Minimax.finance provides you **a full range of tools** to form and manage your crypto portfolio, receive a high-level overview of the web3 space, and explore different investment opportunities, sourced from third-party DeFi applications. On a one single platform we have put together a wide range of extremely useful features, chief among which: * Portfolio with the detailed overview of your assets. It helps to see a big picture and simplifies the process of decision-making in managing your assets. * Analytics charts with APY (Annual Percentage Yield), TVL (total value locked), price of invested assets and much more. * ‘Discover’ page with up to date information about various popular Web3 protocols. * Major opportunities across 9 blockchains to invest your tokens and generate some rewards. * Ability to manage positions on multiple platforms in one place, no need to switch between various dApps. It will be much more difficult for you to forget where all your deposits are. * Zap (i.e. conversion) deposits and withdrawals with any token as in Zapper.fi * Excellent performance of application on any device. * Embedded production ready cross-chain swaps. ### **Why can I trust Minimax? Would my money be safe?** #### Minimax.finance has different opportunities: Portfolio, Discover, Earn and Swap. Except the ‘Discover’ section, most opportunities can be used only with the connection of your wallet. Despite this, **we don’t get any control of your assets, when you connect your wallet to Minimax.finance**. E.g. The ‘Portfolio' section just stores the information and makes analysis of your assets. No operation will be done without your approval. The ‘Earn’ section enables you to deposit tokens to different vaults sourced from various DeFi applications directly on Minimax. However, all transactions are still controlled by your wallet, no operation will be done without your approval. We use our smart contracts only to enable conversion depositing. Therefore, when you have a necessary vault token/LP and you don’t need to use the conversion depositing feature, you won’t interact with our smart contracts at all. When using conversion depositing, you interact with our auxiliary smart contracts. Anyway, the final result of the operation will be as if you are interacting with the apps directly. It minimizes your risks while using Minimax — **even if our platform gets hacked, you won’t lose your money**. If something happens, you’ll still be able to see and manage your positions on native applications. For example, if you use our platform to open a position at Aave, you will be able to see the position on Aave and portfolio tracker like Debank. Minimax auxiliary smart contracts for conversion deposits (which don't hold user tokens) are verified on all blockchain scans and can be found in the Docs section. Also, we use 1inch for robust conversions between different assets. ### What is the difference between depositing on Binance/Centralized exchange and earning options, offered by Minimax? In the case of Binance there are limited options for making deposits and you need to trust a centralized party, such as an exchange (in addition there are requirements for KYC). Minimax Finance requires only a wallet (such as Metamask), and you can flexibly choose any investment options, get historical analytics with charts and enjoy all the benefits offered by minimax (conversion depositing, the wide choice of DeFi applications, performance and usability etc.). ### How does Minimax differ from DeBank/Zapper/Zerion? Minimax.finance, unlike DeBank/Zapper/Zerion, not only provides tools for tracking your DeFi portfolio, but also aggregates investment opportunities from third-party DeFi applications on multiple blockchains, enables to make token swaps by ‘Swap’ section and advanced swaps with the help of conversion depositing feature while depositing via Minimax.finance. Beside that, we have advanced features like excellent performance and usability, protection from risks in case our platform gets hacked, ability to manage your deposits in native applications, etc. ### What are the risks? Minimax.finance usage doesn't bear risks. When you make a deposit via Minimax, the platform interacts directly with external apps smart contracts. So, the risk may be decomposed as: **Risk = Risk of external protocol being hacked** Only when you use conversion depositing, you interact with our auxiliary smart contracts, but they don’t have control over your deposits. ### Do you charge any fees for Minimax usage? No. ### How to choose a vault to invest in? **We do not provide any financial advice. Please do your own research.** You need to consider the risks for each vault and decide on your own. However, we try to save your time during vault evaluation, providing you with all the necessary information, such as price fluctuations, comparison to BTC price changes and other analytics. There are three main categories: * **Stablecoins** — price of asset to invest is pegged to 1$, this vaults can be considered as low-risk options. * **Single assets** — when you invest in this kind of vault, you buy a single token, which will generate rewards during investment in other protocols. Price of assets will fluctuate during the time, usually in an unpredictable manner. * **Liquidity pools** (advanced) — underlying assets are bundled from many assets. During this process your tokens are provided as a liquidity in some DEX liquidity pool. Usually, after that, you get LP tokens as proof of possession of some part of liquidity in a certain pool. These LP tokens are being staked in DEX to farm platform tokens. ### **What is 'Approve' button for, what do I need to approve?** This is a web3 feature, each dApp, presented on Minimax.finance, needs to receive an approval before getting access to any of the tokens in your wallet. Pressing the ‘approve’ button in the Minimax vault means that you trust smart contracts of the project, in which vault you invest, to use your tokens during the deposit process. This action is required to correctly process deposit action. # Portfolio The **‘Portfolio’ page** shows structured data on all crypto assets that are held in a single wallet. You can check the portfolio of any wallet which address you know:
It’s also possible to search addresses by human-readable names, created by [ENS domains](https://ens.domains/) and [Unstoppable Domains](https://unstoppabledomains.com/).
Moreover, in the ‘Portfolio' page you can see the information about the opened deposits. You’ll have more opportunities when you connect your wallet to the platform. Thus, all deposits that are shown on the ‘Deposits’ section, can be withdrawn or edited via Minimax, even if you made them directly on third-party dApps. These options are provided by the action menu on the right side of each deposit cell.
# Discover This page makes a broad overview of the Popular Web 3 protocols. You can sort projects by area and blockchain, rank them by token price, Mcap, TVL, Mcap/TVL. Some tokens are available for purchase directly on the platform. If you look for a definite project, you can use the special search bar.
​​If you want your project to be presented on Minimax, please fill in [the Listing form](https://docs.google.com/forms/d/e/1FAIpQLSelHsPG0Jr9VUm-FIIVZMzZ9Q52VmuKeB3ANxRIqo_CnRbf8w/viewform). # Earn Our ‘Earn’ page gives you various opportunities to make your tokens work. We have integrated depositing options from multiple third-party DeFi applications on 9 chains (at the mime of writing — 24.02.2022).
You can look for necessary vaults by choosing definite platforms, blockchains and vault types or just typing the token to the search bar.
It occurs quite often that one token can be invested in multiple vaults which differ from each other by chain, platform and such parameters as TVL and APY/APR. Therefore, you can easily find the vault with the highest APY.
#### Conversion Depositing If you don’t have the necessary token to invest in the vault, which has attracted your attention, we have a decision — **conversion depositing** feature. With this tool you can enter any vault with any liquid token without having to use a DEX. With conversion depositing our platform does all the necessary conversion and bundling operations for you behind the scenes. Conversion depositing works both for single assets and for LP token vaults which makes it much easier to enter any vault, especially for vaults with LP tokens. For example, you want to deposit tokens to the CAKE-BNB LP2 vault, however you don’t have this LP pair in your wallet. Firstly, you should tap on the necessary vault. Here you see a form, where you can choose the token from your wallet you want to invest in this vault: just open a dropdown under the sign ‘From Wallet’ and choose necessary token:
Then you choose the amount of tokens you want to stake to the vault. Above the deposit button you will see the amount of LP tokens you will be getting according to the swap estimate:
Once you click the ‘Deposit’ button, your token is converted into two tokens, gets bundled into LP tokens and deposited to the vault in just one click. #### Conversion Withdrawal Conversion withdrawal allows you to receive any token you want when withdrawing a position. You can find ‘Withdraw’ page by tapping on the action menu from ‘Deposits’ section on the ‘Portfolio’ page or by tapping to the vault and choosing ‘Withdraw’ tab. The process is the same as with the ‘Deposit’ form: firstly you enter the amount of tokens you want to withdraw and then you choose the token in which you’d like to convert your deposit.
#### Risks As we have written in [FAQ](https://docs.minimax.finance/minimax.finance/faq), Minimax.finance usage doesn't bear risks. All deposits are made directly via third-party dApps and **only with your consent**. We are working hard to carefully check the project before its integration. However, the DeFi world is still unpredictable and no one is safe from unforeseen circumstances. Therefore, we still recommend **doing your own research** before making some investment decisions. # Swap The ‘Swap’ page allows you to do exchanges both within one blockchain and between chains, in such cases acting as a bridge. To accomplish a swap please do these steps: * Choose the tokens you want to sell and buy * Choose the blockchains for the initial and the resulting token * Specify the token amount * Click the ‘Swap’ button and you’re done.
Minimax uses 1inch Router v4 for swaps within the same network and deBridge v1 for cross-chain swaps. Please be aware that **cross-chain swaps aren’t available on** the Fantom, Aurora, Meter and Moonbeam networks yet. # Old positions Please note that if you have used the previous version of Minimax, you may still have not closed old positions. To check it, please, complete a few steps below: 1. Connect your wallet on Minimax. 2. Go to the ‘[Portfolio](https://www.minimax.finance/portfolio)’ page and scroll this page to the tab ‘Minimax positions (old)’. (near this tab you can see a warning sign). 3. Click on the tab and check, if you still have some open positions. 4. When yes, please click on each position and withdraw your assets as soon as possible. # Supported blockchains To use Minimax, you'll need a wallet that supports any or all of the blockchains: * Binance Smart Chain (BNB) * Polygon (MATIC) * Fantom (FTM) * Avalanche (AVAX) * Arbitrum (ETH) * Aurora (ETH) * Moonbeam (GLMR) * Ethereum (ETH) * Meter (MTR) Most popular wallets support all of these blockchains. You'll need some BNB to pay for the transactions on BNB network, MATIC on Polygon, FTM on Fantom, AVAX on Avalanche, ETH on Ethereum, Arbitrum and Aurora, GLMR on Moonbeam and MTR on Meter. If you haven't got any of that yet, please don't worry, we'll help you to sort this out. If you already have a wallet and some tokens in the wallet, you can skip the 'How to get a wallet' and "How to get BNB, MATIC, FTM, AVAX and other tokens” sections and proceed to [How to Connect to Minimax](broken://pages/7ofFfNF3q3xEVhK0WTrB). # How to Get a Wallet You can install a crypto wallets both on a desktop computer and on a smartphone. When choosing a wallet, please make sure that you: * ✅ Download and install the wallet app only from an official wallet developer website. Always use the latest version. * ✅ Back up the recovery phrases and store them in a safe place. * ❌ NEVER share the recovery phrases, under any circumstances. * ❌ NEVER input your recovery phrases anywhere except your wallet app. ### Smartphone or Desktop wallet? Smartphone wallets are usually more user-friendly and more accessible while desktop wallets are more secure and theft resistant. So please choose based on your personal priorities. ## **Smartphone wallets** With a smartphone wallet you can access your crypto almost anywhere, both Android and iOS devices support them. ### Popular mobile wallets ### MetaMask MetaMask is a one of the most popular wallets, which has both mobile and desktop version. #### Major ​**Pros:** * Open source * Widely considered to be very secure and reliable * Many how-to guides and resources online * Supports a very large number of languages #### **Major Cons:** * Longer setup time than other options * Additional steps needed to use with Binance Smart Chain, Polygon and Fantom [**Download MetaMask**](https://metamask.io/download.html) \ [**MetaMask Setup Guide**](https://academy.binance.com/en/articles/connecting-metamask-to-binance-smart-chain) **- Please see how to add Binance Smart Chain to your MetaMask wallet** ### Trust Wallet It supports DApps, NFT collectibles (with Opensea.io support), and in-wallet staking. **Major Pros:** * Open source * It's backed by Binance * Easy to switch between crypto networks * Includes in-wallet staking options **Major Cons:** * Limited dApps * Transaction notifications can be delayed ​[**Download Trust Wallet**](https://trustwallet.com/) [**Trust Wallet Setup Guide**](https://www.binance.com/en/blog/421499824684901157/How-to-Set-Up-and-Use-Trust-Wallet-for-Binance-Smart-Chain) ### SafePal SafePal is available as both a software and hardware wallet. It supports Binance Smart Chain out of the box. **Major Pros:** * Offers 25% fee discount paying with BNB (requires login) * Has the option for Google Authenticator built in * Supports a large number of languages * It's available as both a software and hardware wallet (work together) * Supports NFTs on both the BSC and ETH networks **Cons:** * Isn't fully open source * Does not give user notifications * Does not enforce strong security during initial setup and wallet creation ​[**Download SafePal**](https://safepal.io/download) \ [**SafePal Setup Guide**](https://blog.safepal.io/binance-smart-chain-x-safepal/) ## **Desktop/Web Browser wallets** Desktop wallets are available on your home computer or laptop computer. Wallets on your computer can run as standalone applications, or as web browser plugins for popular browsers like Chrome and Firefox. ### MetaMask MetaMask is a very popular desktop wallet, which can be installed as a browser extension. It supports Ethereum network out of the box and Binance Smart Chain network can be added quite easily. ​**Pros:** * Open source * Widely considered to be very secure and reliable * Many how-to guides and resources online * Supports a very large number of languages * Available on mobile devices **Cons:** * Longer setup time than other options * Additional steps needed to add support of Binance Smart Chain, Polygon and Fantom [**Download MetaMask**](https://metamask.io/download.html) [**MetaMask Setup Guide**](https://academy.binance.com/en/articles/connecting-metamask-to-binance-smart-chain) In this guide we mentioned just a few very popular wallets. There are many more options available, so please free to do some research and find the wallet which suits you best. ​**IMPORTANT NOTICE.** NEVER give anyone your private key or recovery phrase ("seed phrase"). Recovery phrase gives complete access to your crypto! # How to get BNB, MATIC, FTM, AVAX and other tokens The native tokens of Binance Smart Chain (BNB), including BNB, are **BEP-20**. When using DeFi platforms on BSC network, you will need BNB to pay the gas fees. Such a fee occurs each time you perform an exchange on a DEX, deposit your crypto into staking or lending pools, etc. Our platform supports staking of all top crypto on BNB network - BTC, ETH, BNB, XRP, DOGE, DOT and many others. At Minimax you'll need BEP-20 versions of these tokens to create a position in a vault and BNB to pay for the gas fees associated with opening and managing the positions. You can buy BNB and other tokens at a centralized exchange (e.g. [Binance](https://www.binance.com/en), [Kucoin](https://www.kucoin.com/), etc) and then transfer the tokens to your smartphone or desktop wallet. Make sure to use BEP-20 type of transfer otherwise your funds may get lost. Please refer to the exchange tutorials on how to make BEP-20 transfers (don't worry, the process is quite easy). Once you complete the transfer, the tokens will become available in your wallet. If you are using MetaMask, you may need to import tokens to the wallet to make them visible. Please find below an example with CAKE token. To import a token please open the wallet and scroll down till you see the 'Import tokens' link: ![](/files/VRY2Smhfv2S7LyfvZKpq) #### Click the link and the following form will open: ![](/files/58wiGYyuPa7DhJBAM9Tv) For CAKE token please enter the following in the Token Contract Address field: 0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82 After that the other fields will auto fill. Click the 'Add Custom Token' button and now CAKE should be visible in your MetaMask. You can add other tokens to your wallet in the same way. You can find the Token Contract Address for most tokens on coinmarketcap or by googling. Please make sure to use the Token Contract Address for Binance Smart Chain (tokens have separate Token Contract Addresses for each blockchain). If you need to transfer BNB and other tokens to Binance Smart Chain from other blockchains, please use a bridge, for example this one: Similarly to BNB, you can buy MATIC, FTM, AVAX, ETH and other tokens for Polygon, Fantom, Avalanche and Arbitrum networks and transfer the tokens to your wallet which supports Polygon, Fantom, Avalanche and Arbitrum networks. There are a number of bridges for transferring crypto between networks. We use , however please be aware that this is just a mention and not a recommendation. Please do your own research before using a bridge. If you will have difficulty with getting the tokens or transferring them to your crypto wallet, please get in touch with us in our telegram chat at and will do our best to help you as soon as we can. # Smart contracts We have several smart contracts backing Minimax app. For ease of access and management, we have a small contract `Deployments`, which stores all most current contracts addresses by keys. Moreover, we use `Proxy` contracts, and all transaction go through them. To see the code of any Minimax contract, one should get proxy address by a [specific key](#deployment-keys) from `Deployments` contract. This can be done by opening `Deployments` contract trhough scan, opening `Contract` section and choosing `deployments` button from `Read Contract`.

Deployments example

### Deployment keys Here is a list of Minimax contracts keys for `Deployments` contract * `Base` - main contract, that stores positions and handles deposits and withdraws * `Advanced` - contract, that provides advanced operations, such as conversion deposits and withdraws, liquidation * `MinimaxMarket` - contract for Minimax Swap and converstion deposits and withdraws ### Contract addresses #### **BNB Chain** ProxyAdmin – [0x48376979c2aDB31EE0e574084a8843B1112525d9](https://bscscan.com/address/0x48376979c2aDB31EE0e574084a8843B1112525d9) Deployments - [0x5D6397a2aC36762d1A8F96b0cA915c49c2958D84](https://bscscan.com/address/0x5D6397a2aC36762d1A8F96b0cA915c49c2958D84) #### **Polygon** ProxyAdmin – [0xA205c55FdCD98A64AbE3B2cF3DE01DC8509D02b5](https://polygonscan.com/address/0xA205c55FdCD98A64AbE3B2cF3DE01DC8509D02b5) Deployments - [0x8f441e875C67e908Bb0e407d48D002E8a7BDcDD4](https://polygonscan.com/address/0x8f441e875C67e908Bb0e407d48D002E8a7BDcDD4) #### **Fantom** ProxyAdmin – [0x2e34168Bf6532523AD01A73394Ce7Fb634898F26](https://ftmscan.com/address/0x2e34168Bf6532523AD01A73394Ce7Fb634898F26) Deployments - [0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b](https://ftmscan.com/address/0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b) #### **Avalanche** ProxyAdmin – [0x2e34168Bf6532523AD01A73394Ce7Fb634898F26](https://snowtrace.io/address/0x2e34168Bf6532523AD01A73394Ce7Fb634898F26) Deployments - [0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b](https://snowtrace.io/address/0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b) #### **Arbitrum** ProxyAdmin – [0x2e34168Bf6532523AD01A73394Ce7Fb634898F26](https://arbiscan.io/address/0x2e34168Bf6532523AD01A73394Ce7Fb634898F26) Deployments - [0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b](https://arbiscan.io/address/0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b) #### **Aurora** ProxyAdmin – [0x2e34168Bf6532523AD01A73394Ce7Fb634898F26](https://aurorascan.dev/address/0x2e34168Bf6532523AD01A73394Ce7Fb634898F26) Deployments - [0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b](https://aurorascan.dev/address/0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b) #### **Moonbeam** ProxyAdmin – [0x495430C075a1670D1810C9c2c3745f7D0B09937a](https://moonscan.io/address/0x495430C075a1670D1810C9c2c3745f7D0B09937a) Deployments - [0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b](https://moonscan.io/address/0x2274Fb44b7eBbB49E764B28B0A31F5ed2Ef1833b) #### Ethereum ProxyAdmin - [0x1193320eA26E043A75033a5ad839236a30De8218](https://etherscan.io/address/0x1193320eA26E043A75033a5ad839236a30De8218) Deployments - [0x17b92cc90425090E706E3d602068dD58b99B8f1f](https://etherscan.io/address/0x17b92cc90425090E706E3d602068dD58b99B8f1f) #### **Meter** ProxyAdmin – [0x8319b78cB30528c96c6102DA9D1e14B4eBD26B7a](https://scan.meter.io/address/0x8319b78cb30528c96c6102da9d1e14b4ebd26b7a) Deployments - [0x46302D86973cd300cACD35eA738032c597EdBB07](https://scan.meter.io/address/0x46302d86973cd300cacd35ea738032c597edbb07) # Integration for protocols If your protocol is deployed on one of the blockchains supported by our platform, we can integrate your protocol with Minimax. This will help you to **attract more liquidity** into your protocol, as our smart contracts act as smart proxies and reinvest users' funds into destination protocols. So the TVL will be all yours. Your protocol is good fit for integration with ours, if you provide one or more of the following services: * Lending (benefits for your users: stop-loss and other automation features for deposits) * Staking (automation features for your staking pools/vaults, embedding of automation features on your native platform, etc.) * Farming (stop-loss and take profit for Uniswap-V2-type AMM DEX for liquidity providers, simplified liquidity provision and management) * Portfolio management (automation actions for your DAO fund or other assets) * If your protocol provides a service not listed above, however you see potential in our cooperation, please feel free to get in touch. You can contract us through [Telegram Chat](https://t.me/MinimaxFinanceChat) or # Integration for blockchains If you represent a blockchain and would like Minimax to get deployed on your blockchain, here are the possible scenarios: **EVM-compatible blockchains**: \ \ It's great if your blockchain is supported by these platforms and components (but **not mandatory**): * **Gelato** **network** (for automation of stop-loss, take-profit and other events). If there is no Gelato support on your network, then we will use our in-house centralized bots for automation. * **1inch** **network** (for better exchange rates for conversion depositing and withdrawals). If there is no 1inch, we will use MinimaxMarket (on-chain uniswap v2/v3 DEX aggregator), which is pretty good, but not as efficient as 1inch, due to decentralized nature. * **DeBridge** **Finance** (for cross-chain swaps and cross-chain deposits). If there is no DeBridge support, then users won't be able to use cross-chain swaps where source or target blockchain is yours. * **Chainlink** price feeds (we use Chainlink price feeds to ensure correct execution of our automation actions). If there is no Chainlink in your blockchain, then we will use estimation from our MinimaxMarket contracts (which is still good, but less reliable). * **Metamask** / Other wallet supported by our app (this is needed to connect your blockchain to our application. For example, there is no TRON support yet in Metamask, however TRON is EVM-compatible) On average EVM-compatible blockchains may be added in **1-1.5 weeks** due to flexible smart contracts architecture . **Non EVM-compatible** (e. g. Solana): Can be considered on request. Consumes much more time to add. # ZapFarm - integrate conversion depositing into your app ZapFarm is a plugin, which enables you to integrate conversion depositing into your centralized or decentralized application. Briefly, ZapFarm allows your users to provide liquidity in a single transaction using any funds on any chain. Check the feature [description](https://docs.minimax.finance/minimax/conversion-depositing-and-withdrawal) and ZapFarm [presentation](https://docsend.com/view/34xvnaep28rnpywy). You can integrate ZapFarm within minutes using ZapFarm SDK, which is described below. ## ZapFarm SDK `@minimax/zap-farm-sdk` is a library that allows you to easily integrate ZapFarm widget into your application and communicate with it. ZapFarm SDK is developed using TypeScript, ensuring strict typings. ### Example usage To start ZapFarm widget, all you need to do is provide a basic configuration to ZapFarm SDK constructor: ```typescript import { ZapFarmSDK } from '@minimax/zap-farm-sdk'; const zapFarm = new ZapFarmSDK({ userAddress: '', pool: { blockchainID: , address: '', }, ...otherOptions, }); zapFarm.show(); ``` That's it! Create ZapFarm SDK instance with a configuration object and call the `.show()` method when you want to show ZapFarm widget to your users. {% hint style="info" %} For now, if you want to close ZapFarm widget and open it again, you'll need to create new ZapFarm SDK instance, meaning you can't reuse the existing instance. While it may sound limiting, practice shows that you'll rarely need to reopen previously closed ZapFarm widget. {% endhint %} ### Installation You can find the package [here](https://npmjs.com). Install via Yarn: ```shell yarn add @minimax/zap-farm-sdk ``` Install via npm: ```shell npm install @minimax/zap-farm-sdk ``` In the future, you will be able to use a `script` tag. ### Initialization Just call `new ZapFarmSDK(config)` - this will do the necessary prep work for the widget, but won't display it yet. In order to display the widget, run `.show()` on the instance of the `ZapFarmSDK` class. `.show()` adds the widget to the DOM - specifically, to the `body` element - starting from that moment, the semi-transparent overlay with a loader appears and the widget starts booting up. ### Subscribing to events In order to subscribe to an event, use the `.on(eventType, callback)` method on the SDK instance. The `.on(eventType, callback)` method accepts either a string with the event's `type` when you want to subscribe to a specific kind of an event or `'*'` for subscribing to any event. `callback` is called each time a given event occurs. In order to unsubscribe, call the `.unsubscribe(eventType, callback)` method with the event type and handler you want to stop receiving updates for. {% hint style="info" %} `.on(eventType, callback)` and `.unsubscribe(eventType, callback)`are chainable: ```typescript new ZapFarmSDK({ ... }) .on(...) .unsubscribe(...) .show(); ``` {% endhint %} ## Configuration We provide three options for using the SDK: 1. [Event mode](#event-mode) (you will need to process SDK events on your side). 2. [Provider mode](#provider-mode) (requires an [ethers-compatible provider](https://docs.ethers.io/v5/api/providers/provider/)). 3. WIP: [Delegation mode](#delegation-mode). ### Event Mode In event mode, ZapFarm will generate events of certain types, which you can handle on your side in any way you want. The list of available event types will be published later in the corresponding documentation section. Example: ```typescript const zapFarm = new ZapFarmSDK({ mode: 'events', userAddress: 'vitalik.eth', // Required in event mode. ...otherOptions, }); zapFarm .on('*', (event) => console.log(event)) .on('TRANSACTION_READY', async (event) => { const signer = provider.getSigner(); const tx = await signer.sendTransaction(event.payload) const receipt = await tx.wait() }) .on('WIDGET_CLOSE', (event) => console.log(event)); zapFarm.show(); ``` {% hint style="info" %} When using other types of integration, all events will also be broadcast to the SDK entity and you can use them to display any interface effects. {% endhint %} ### Provider Mode Provider mode allows you to easily integrate ZapFarm SDK into your dApp. In this case you need to pass your configuration to a provider: ```typescript new ZapFarmSDK({ mode: 'provider', provider: provider, ...otherOptions, }).show(); ``` ZapFarm will generate, send and process approve, deposit (and others, if needed in the future) transactions on its own. You will be able to get information about all the events inside your SDK (e.g. for your app UI changes, or for analytics) using the [event system](#event-mode). ### WIP: Delegation Mode In delegate mode, the user's path is completely transferred to ZapFarm. We will offer users to login (via all modern wallets, including MetaMask, WalletConnect etc.), necessary approves and the deposit itself, and then close the widget. At this time, you will be able to handle all actions through the SDK and have the access to all events that happen on our side. {% hint style="warning" %} Currently, MetaMask's mobile application [doesn't support iframe](https://github.com/MetaMask/metamask-mobile/issues/3417) and therefore is not working with ZapFarm. {% endhint %} ## Integration variants ZapFarm allows you to integrate it in multiple ways depending on your app's UI and needs. #### Overlay mode If you want ZapFarm to open as an overlay over your app, you should go with this mode. It uses our SDK, so all you need to do is to provide a basic configuration and display ZapFarm widget when you need it. #### Embedded mode This is the mode you want to use if you want to put ZapFarm widget in some DOM element on your page so that you can have a more customized way of displaying our widget. It uses ZapFarm SDK just like the overlay mode - the only difference is that you need to provide a `containerNode` alongside your configuration: ```typescript new ZapFarmSDK({ containerNode: document.getElementById('zap-farm-container'), ...otherOptions, }); ```