# Welcome to FlatQube Learn about FlatQube - a decentralized AMM exchange powered by the Everscale blockchain that combines all the best of popular DeFi applications in one platform. FlatQube DEX, developed by [Broxus](https://broxus.com), is a decentralized digital asset exchange providing users with a convenient means of exchanging their cryptocurrency. The DEX also provides users with plenty of passive income options through its farming and staking mechanisms. Its underlying network, Everscale, is making decentralized finance (DeFi) an affordable yet inclusive space for all. [Farming ](/use/farming)and [vesting ](/use/farming/concepts/vesting)mechanisms on FlatQube include a wide variety of [pools ](/use/pools)with some of the highest APY rates in DeFi. # Getting started In this section, you will find explanations of the main concepts, terms, and mechanisms of FlatQube, necessary for understanding the principles of the platform. If you have never used FlatQube or other DEXes, we highly recommend devoting some time to reading the tips inside. # How it works Learn the basics of FlatQube to better understand the underlying processes. ## Basics FlatQube is an automated liquidity protocol inspired by the leading market solutions. It is based on a constant product formula and offers a non-custodial, decentralized, censorship-resistant and secure way to provide liquidity and exchange pairs of tokens. Unlike Uniswap or other Ethereum-based DEXes, FlatQube works on the [Everscale network](https://everscale.network) and benefits from its asynchronous execution, high throughput, and fast finality. FlatQube is open-source software licensed under [Apache 2.0](https://github.com/broxus/ton-dex/blob/master/LICENSE). ## Liquidity pools FlatQube operates through a collection of smart contracts, the principal of which, [*the pair*](https://github.com/broxus/ton-dex/blob/master/contracts/DexPair.sol), manages a liquidity pool made up of reserves of two [TIP-3.1 tokens](/use/tokens/concepts/tokens-we-use#tokens-standard). Anyone can become a liquidity provider (LP) for a pool by depositing an equivalent value of each underlying token in return for pool tokens (LP-tokens). These tokens track pro-rata LP shares of the total reserves and can be redeemed for the underlying assets at any time. {% hint style="info" %} See also: [How to calculate the amount of LP tokens](/use/pools/how-to/calculate-the-amount-of-lp-tokens) {% endhint %} Unlike other DEXes, due to the peculiarities of Everscale, FlatQube uses an intermediate contract, [*the DEX account*](https://github.com/broxus/ton-dex/blob/master/contracts/DexAccount.sol), to accumulate the position before provision. An LP should deposit both underlying assets to their DEX account to supply liquidity to the pool. {% hint style="info" %} FlatQube supports one-sided liquidity provision by automatically exchanging the required part of the provided asset in the pool. [Read more](/use/pools/how-to/add-liquidity#one-sided-liquidity-provision) {% endhint %} ## The math behind the curtains Pairs act as automated market makers, standing ready to accept one token for the other as long as the “constant product” formula is preserved. This formula, most simply expressed as `x * y = k`, states that trades must not change the product (`k`) of a pair’s reserve balances (`x` and `y`). Because `k` remains unchanged from the reference frame of a trade, it is often referred to as the *invariant*. This formula has the desirable property that larger trades (relative to reserves) execute at exponentially worse rates than smaller ones. In practice, FlatQube applies a 0.30% fee to trades, which increases the reserves and, consequently, the invariant. It serves as a deferred profit to LPs, which they get when they burn pool tokens to withdraw their portion of the total reserves. By design, the relative price of assets changes only through trading, leading to arbitrage opportunities. This mechanism ensures that DEX prices always trend toward a market-clearing price. # Roles Different kinds of FlatQube users ## Users Users of FlatQube are people who have [connected ](/use/getting-started/how-to-connect-a-wallet)their wallet to the platform.\ Any user can take advantage of all available functionality without restrictions: they can [swap tokens](/use/swap), provide liquidity to [pools](/use/pools), [farm ](/use/farming)and [build tokens](/use/token-builder). ## Liquidity providers Liquidity providers are users who lock their tokens in [liquidity pools](/use/pools). A liquidity provider that locks his liquidity in any pool receives a corresponding LP token, which stores information about the locked liquidity and is proof of ownership of the pool share. ## Farm admins Any FlatQube user can create their own Farming pool. In this case, they will be the pool admin. The pool admin has the right to choose the start and end date of farming, set the vesting period, choose tokens for rewarding farmers and farming speed. ## Farmers Users who have locked their liquidity in a particular pool can use their LP tokens for yield farming (liquidity farming) using the corresponding FlatQube interface.\ In exchange for locking their LP tokens in a specific farming pool, farmers receive a reward. ## Token builders FlatQube has a token builder interface.\ Users who create their own tokens using this interface are called token builders. # How to connect a wallet Wallet connection guide To start working with FlatQube, you need to connect a wallet. At the moment, the only wallet available for connection is [EVER Wallet](https://l1.broxus.com/everscale/wallet). If you do not have EVER Wallet yet, we recommend that you go to the [installation instructions](https://docs.tonbridge.io/ever-wallet/getting-started-with-ton-crystal-wallet) or go directly to the [download page](https://l1.broxus.com/everscale/wallet). ## Steps to connect your wallet on desktop As soon as you enter FlatQube, you will see the **Connect Wallet** button. Click on it to connect your Ever Wallet. If your device does not have EVER Wallet installed, you will see a window with a download link.
If EVER Wallet is installed, you will see a window for selecting an account to connect to. {% hint style="info" %} Sometimes other browser extensions block the EVER Wallet window. In such a situation, just click on its icon on your toolbar to display the pending authorizations. {% endhint %} Choose one of them (FlatQube will work with the address of this account only) and click **Next**. Select all **permissions** and click **Connect**.
If the connection was successful, you will see the wallet address and the amount of EVER in the right upper corner. By clicking on the "Door" icon you can disconnect this wallet from FlatQube. ![FlatQube menu with connected wallet](/files/lATHSw0HqKn4UHQmVlzy) ## Steps to connect your wallet on mobile To connect your EVER Wallet on mobile, open the EVER Wallet app and go to the **Browser section** at the bottom of the screen. Go to [FlatQube.io ](https://flatqube.io)and click **Connect Wallet** and then confirm this action by clicking **Allow**.
Well done! # Glossary This page explains the terminology used in the FlatQube pages. ## **Swap** Exchange operation. ## **Token** A type of crypto asset. There are two main types of tokens on FlatQube: * **Native tokens** are presented in the [**Tokens** section](/use/tokens). All of them have a certain price. You can buy, sell and exchange them, as well as provide liquidity to pools through them. * **LP tokens** are a confirmation of the liquidity locked by the user in a certain [pool ](/use/pools)and they can be used for [liquidity farming](/use/farming). ## **Farming** Yield farming or liquidity mining is a way of earning through rewards by **providing liquidity** (as **LP tokens**) to **farming pools**. ## **Farming pool** A special smart contract that distributes the provided amount proportionally to everyone who staked a specific LP token on this contract. ## **Liquidity pool** A collection of funds locked in a smart contract. Users called "**liquidity providers"** add two tokens in a certain proportion to a pool to create a market. As a confirmation of the provided liquidity, providers receive **LP tokens** that they can use in **Farming pools**. ## **Pair** A pair of tokens that form a liquidity pool. ## **Vesting** Essentially, vesting on FlatQube is a formula for progressively unlocking farming rewards over time. ## **Volume** The trading volume (total number of exchanges) in USD for a certain period of time. ## **TVL** The total value locked - is the value of assets locked by liquidity providers in a particular pool. ## **Account** The personal smart contract of the liquidity provider, which they use to deposit tokens into the pool. ## **Vault** A dedicated smart contract that stores all tokens deposited to the DEX. ## **Builder** FlatQube interface that allows users to create their own tokens. ## **Explorer** A [graphic user interface](https://tonscan.io) designed to allow users to analyze the Everscale blockchain. A blockchain explorer is like a search engine that reveals information about the past and current state of a blockchain. Through its interface, a user can browse information about blocks that have been added to the blockchain, transactions and messages that have occurred, account balances, and information about tokens. ## **Slippage tolerance** The difference between the expected price of the token and its price at the time of the transaction. By changing this parameter, you can set the maximum slippage when making a transaction. The transaction will not go through if the price of the token at the time of its completion changes by more than the specified percentage. # Everscale A little about the network we use Everscale is the most scalable blockchain network in existence. The network’s incomparable scalability is due to its dynamic sharding mechanism which enables it to process millions of transactions per second and charge infinitesimal transaction fees. The network was started in the aftermath of the Telegram Open Network project. Once development was halted on TON and the technology behind it became open source, a team of developers decided that the potential the technology had was too good to let go to waste. Since the start, Everscale developers like Broxus have reimagined the network’s capabilities and offerings, building one of the most formidable ecosystems in all of DeFi, replete with a native DEX, cross-chain bridge platform, wallet, grant program and more. The advancements spurred the community to change the name of the network to Everscale. Under the hood, the changes that were introduced have increased the scaling capacity of the network and the transaction processing speed, which is why Everscale was chosen as the new name. The result is a new and unique blockchain design that proposes a scalable decentralized world computer, paired with a distributed operating system. Everscale is based on a platform called Ever OS, capable of processing millions of transactions per second, with Turing-complete smart contracts and decentralized user interfaces. Everscale presents some new and unique properties, such as dynamic multithreading, soft majority consensus and distributed programming, which enable it to be scalable, fast and secure at the same time. It is governed by a decentralized community founded upon meritocratic principles via the Soft Majority Voting protocol. Everscale has powerful developer tools, such as compilers for Solidity and C++, SDK and API, client libraries ported to more than 20 languages and platforms, a range of decentralized browsers and wallets empowering many applications in DeFi, NFT, tokenization and governance domains. # How to get EVER Here are 4 ways to get EVER on your wallet. * You can purchase EVER on exchanges where it is available and then withdraw them to your EVER Wallet address: {% embed url="" %} * The second way is to [transfer your tokens from another network](https://docs.octusbridge.io/use/bridge/cross-chain-transfer/how-to/transferring-from-another-network-to-everscale) (Ethereum, BNB, Fantom Opera and Polygon) to Everscale using the Octus Bridge cross-chain transfer interface.\ At the stage of choosing a token and amount to transfer you can convert a part of sent tokens into a EVER to pay a commission for this transfer and subsequent wallet deployment. * Profitably exchange your ERC-20 tokens for EVER with [Getever.io](https://getever.io/) * The last way is to buy EVER or WEVER [directly on FlatQube](https://flatqube.io/swap/0:a519f99bb5d6d51ef958ed24d337ad75a1c770885dcd42d51d6663f9fcdacfb2/0:a49cd4e158a9a15555e624759e2e4e766d22600b7800d891e46f9291f044a93d).​ {% hint style="info" %} To make a swap on FlatQube you need a [deployed wallet](https://docs.everwallet.net/getting-started/install-and-singing-in/deploy)! {% endhint %} # Swap Token swaps are the heart and the essence of the DEX. Read the articles in this section to learn everything about swaps on FlatQube. # Interface # Basic swap Overview of the Swap interface So, we've come to the Swap section. Let's examine each element of the interface in detail. ![](/files/gnfqrsNkVHYIv8ekRiQ4) In the upper right part of the swap window, you can see a gear⚙️. This is a link to **Transaction Settings.**\ Here you can set the [**slippage tolerance**](/use/swap/how-to/configure-slippage-tolerance). **From** - is the amount of tokens that will be converted into a certain amount of other tokens - **To.**\ Click on **Max** to select all exchangeable tokens.
After selecting a certain amount of tokens in **From** or **To**, a few more informative lines will appear: * [**Slippage tolerance**](/use/swap/how-to/configure-slippage-tolerance) - it is the difference between the expected price of the token and its price at the time of the transaction. By changing this parameter, you can set the maximum slippage when making a transaction. That is, the transaction will not go through if the price of the token at the time of its completion changes by more than the specified percentage. * **Minimum receive -** the minimum amount of tokens you will receive, taking into account Slippage tolerance * **Price impact** - the change in the price of the underlying asset caused by this swap. * **Liquidity Provider Fee** - the amount of tokens that will be distributed in the form of a commission among all users (Liquidity providers) who provided liquidity to the pool of the pair you are exchanging. * **Optimal price** is the ratio of the price of the tokens you are going to exchange.\ By clicking on the 🔁, you can choose the ratio of which token to another will be displayed.
# How to Find the answers to the most frequently asked questions about swaps at FlatQube. # Make a basic swap Instructions for making a basic swap Let's make a basic swap! **1.** Connect to a wallet First, [connect your wallet](/use/getting-started/how-to-connect-a-wallet) by clicking **Connect to a wallet**. **2.** Select tokens After that, we will select **WEVER** as the token we want to exchange in the **From** column.\ Let's say we want **USDC** in exchange for **WEVER**. To do this, select the appropriate token in the **To** column.
**3.** Select an amount Now we will enter the amount of **WEVER** that we want to exchange for **USDC** in the **From** column. You can also enter the amount of **USDC** we want to receive in the **To** column. **4.** Make a swap Now, if you are ready to make a **Swap**, click on the appropriate button.\ Check out the [details ](https://docs.flatqube.io/use/swap/interface)about the upcoming swap and if everything is fine, click Confirm.
**5.** Confirm a transaction After that, a transaction confirmation window will open in **EVER Wallet**.\ Here you'll find the amount of tokens that will be deducted from your wallet, as well as information about the fee:\ **The attached amount** is the amount that will be deducted from your wallet to cover the blockchain fee. As you can see, the Attached amount significantly exceeds the Blockchain fee – the exact fee amount is not known, so the blockchain fee amount will be deducted from the Attached Amount and the change will be returned to your wallet after the transaction is completed.\ \ Click **Send.** Enter the password for the wallet account and click **Confirm the transaction**, considering that it is at this stage that the **Swap** will begin (this action is irreversible).
As soon as the transaction is completed, you will see a notification about it on FlatQube.\ You can go to the page of the Token contract, by clicking **Token Root Contract**, or to the transaction page by clicking **Transaction result.** Both of these actions will take you to pages of the Blockchain Explorer ([Tonscan.io](https://tonscan.io)). ![](/files/hmrAIKSZaOzzVgnBOfPC) # Use limit trading This page provides a step-by-step guide on how to utilize Limit Trading on FlatQube. Follow these instructions to make the most of this feature: ## Creating a Limit Order 1. Navigate to the `Swap` section of FlatQube. 2. In the swap window on the right-hand side, select the `Limit` option. 3. Choose the tokens you wish to trade, specifying the token pair for your limit order. 4. Now, you have two options to determine your trade: by `amount` or by `price`. If you click the lock icon and set the amount for both tokens, the DEX will automatically calculate the price based on the entered amounts. Alternatively, if you close the lock icon and set a specific price for the trade, the DEX will calculate the second token amount automatically based on the price you've set. You can also use the `Market Price` button to set the price according to the current market value. 5. Once you have completed the above steps, click the `Make an Order` button and confirm the transaction. Your order will be placed on the blockchain and will appear in the `My Orders` section. 6. Click `Make an Order`, then `Confirm`, and approve the transaction in the opened Ever Wallet window. After placing your limit order, you will need to wait for its execution. To learn more about how orders are executed and the concepts behind it, please refer to the [`Concept page`](/use/swap/concepts/limit-orders).
## Closing an Order 1. Go to the `Swap` section of FlatQube. 2. In the interface on the right side, select the tokens you are interested in. 3. Scroll down to the `Orders` block, which represents the order book. 4. Choose either `Buy` or `Sell` to filter the relevant orders. 5. Select the desired order from the list and click `Accept`. 6. Confirm the transaction by clicking `Confirm` and approve it in the opened Ever Wallet window.
# Configure slippage tolerance How to change the slippage percentage? When making a swap, FlatQube users have the option to change the **Slippage tolerance**. Recall that **slippage tolerance** is the difference between the expected price of the token and its price at the time of the transaction. By changing this parameter, you can set the maximum slippage when making a transaction. That is, the transaction will not go through if the price of the token at the time of its completion changes by more than the specified percentage. So how do you manage slippage tolerance? It's very simple. Go to the Swap section and [connect your wallet](/use/getting-started/how-to-connect-a-wallet) to FlatQube if you haven't already. ![](/files/7MJCE4eGiyhzuy0ykH5f) In the upper-right part of the swap window (1), you can see a gear⚙️. This is a link to **Transaction Settings.**\ Here you can set **slippage tolerance.** You can choose one of the offered percentages, or enter it manually (2).\ When making a swap, you will see that the **Slippage tolerance** will change (3).
# Use cross-exchange When you choose tokens to exchange, if there is not enough liquidity in the pool corresponding to these pairs, FlatQube will automatically offer to make a cross exchange.\ Keep in mind that since you are dealing with two pools at once, your [**slippage tolerance**](/use/swap/concepts/slippage-tolerance), as well as [**liquidity provider fees**](/use/swap/concepts/fees), will double. The process of conducting a transaction does not differ from a[ **regular swap** ](/use/swap/how-to/make-a-basic-swap)- Click **Swap**, then **Confirm** and **confirm your transaction** in EVER Wallet.
{% content-ref url="/pages/7VYAk6APDtADM2BcoE4n" %} [Cross-exchange](/use/swap/concepts/cross-exchange) {% endcontent-ref %} # Concepts Better understand the concepts used in FlatQube swaps. # Limit orders One of its key features on the FlatQube is the implementation of Limit orders, which provides traders with increased control and flexibility over their trades. ### **Understanding Swaps** In the context of a decentralized exchange (DEX), a "swap" refers to the process of exchanging one token for another. Traditionally, through FlatQube's standard Swap interface, this is done at the current market price, which is determined by the balance of supply and demand in the token pair's liquidity pool. Essentially, you are "swapping" one token for another. Automated Market Makers (AMMs) facilitate these swaps. AMMs are smart contracts that create a liquidity pool of two tokens. They determine the price of tokens based on the ratio of the tokens in the pool. However, these swaps only happen at the prevailing market price, providing less control over your trades. ### **Limit Orders: A Step Beyond Traditional Swaps** A Limit order represents a significant enhancement to standard swaps. This type of order enables you to stipulate the price at which you aim to buy or sell a specific quantity of a token. You're no longer tied to the prevailing market price. Instead, you can place an order that executes only when the token's price matches your predetermined value. This feature is particularly useful in volatile markets, where token prices can fluctuate rapidly. By setting a limit order, you can manage risk as the order will only be executed when the token reaches your specified price. In practice, as a user, you simply set a price for your order and wait. Once the market price matches your specified price, the order can be executed. It's important to note that while your order can be fulfilled by another user's actions, other traders do not have the ability to intentionally choose and fulfill your specific order. The fulfillment of your order is dictated by the market activities and mechanisms within the DEX, which decide whether an AMM or another user's order matches your specified price. ### **How Limit Orders Work** When you place a limit order on FlatQube, there are three mechanisms through which the order can be executed: 1. **P2P Execution:** Another trader can manually accept your order and execute it, either fully or partially. 2. **Order Matching:** If there is an existing order that matches yours in terms of price and quantity, the DEX automatically executes both orders, either fully or partially. 3. **AMM Execution:** When the market price reaches your set price, the DEX automatically executes your order by initiating a swap in the pair you have selected. The automatic execution methods (Order Matching and AMM Execution) come with two modes provided in smart contracts: * The backend triggers the match * Another trader triggers a match for the difference as a reward. This acts as a fallback to ensure decentralization in case the backend is unavailable. ### **Monitoring Your Orders** Once created, your order is added to the order table located at the bottom of the Swap page. The order remains there until it is either fully executed or cancelled by you, the creator. This allows for a full audit trail of all placed orders. Limit orders enhance your trading experience on FlatQube by providing greater control and flexibility in your Web3 trading decisions. They also facilitate increased interaction with other traders on the Everscale blockchain. Dive into the world of decentralized trading with FlatQube limit orders! # Slippage tolerance Slippage tolerance is the difference between the expected price of a token and its price at the time of the transaction.\ You can change this parameter by setting the maximum slippage when making a swap.\ Slippage tolerance will not allow a transaction to be completed if the price of the token at the time of its completion changes by more than the specified percentage. {% content-ref url="/pages/gADd9yihUOOFu95L2wRy" %} [Configure slippage tolerance](/use/swap/how-to/configure-slippage-tolerance) {% endcontent-ref %} # Fees When making any swap, you need to pay some commissions: * First, there is the Everscale **blockchain fee** that you pay when interacting with the contracts of the network.\ Fees are one of the ways in which validators are rewarded for their work: fees from all transactions that have been included in newly created blocks are distributed among all participating validators.\ Everscale network fees are negligible and are limited to a few cents when making swaps. * Also, you pay a commission of 0.3% of the transaction amount to [providers ](/use/getting-started/roles#liquidity-providers)that [provide liquidity](/use/pools/how-to/add-liquidity) to the [pool ](/use/pools)of tokens that you exchange (**Liquidity Provider Fee**).\ The amount of the commission is evenly distributed among all liquidity providers depending on their share in this pool, and they can take this reward by [removing their liquidity](broken://pages/Yj8654hOeX31PgX7Dayb) (burning LP tokens). # Price impact **Price impact** is an expression used to describe the correlation between an incoming order and the price change of the underlying asset caused by the trade. Buy trades push the price of the asset up, while sell trades do the opposite. The degree of price change as a result of trading largely depends on the liquidity of the affected trading pair. More liquid trading pairs will have less of an impact on price than pairs with lower trading volumes. Traders, especially those who trade in markets with limited liquidity or make large trades, should be aware of the impact their trading has on the price of an asset. Their second buy will be more expensive on average than their first because of their market power. During each of your swaps, you can see the impact of the loss on the price of the token. In order to avoid a sudden change in the price of the current when making your swap, there is a [slippage tolerance](/use/swap/concepts/slippage-tolerance) parameter that allows you to set the maximum possible change in price and does not allow a transaction to be executed if this percentage is exceeded. # Cross-exchange As you know, the ability to exchange one token for another on FlatQube is provided by the [liquidity in pools](/use/pools).\ In the event that there is not enough liquidity in the corresponding pool, or the required pool does not exist at all, **Cross-exchange** will help you.\ The essence of Cross-exchange is to interact with several liquidity pools at once:\ Let's say you need to exchange token A for token B, but the corresponding pool does not exist. In this case, FlatQube will suggest performing a cross-exchange swap, in which token A will be exchanged for token C (interacting with the A/C pool), and then token C will be exchanged for token B (interacting with the C/B pool). You should bear in mind that since you are interacting with two pools at once, your [**slippage tolerance**](/use/swap/concepts/slippage-tolerance), as well as [**Liquidity providers fee**](/use/swap/concepts/fees), doubles. {% content-ref url="/pages/vyhPP2h5Xugjw7NQsvrt" %} [Use cross-exchange](/use/swap/how-to/use-cross-exchange) {% endcontent-ref %} # Tokens # Interface Details about the interface of the Tokens section. # All tokens About the main page of the Tokens section. By going to the Tokens section, you will see a list of tokens used on FlatQube.
Here you have the following options: * **Sort tokens by TVL** - click on *TVL* in the upper right corner of the token sheet to sort them by [TVL](/use/tokens/interface/token-page/tvl). * **Switch between pages** - in the lower right corner, by clicking on the arrows, you can switch between token pages. * **Go to a token page** - click on one of the tokens to go to that [token page](/use/tokens/interface/token-page) with detailed information about it. # Token page Select one of the tokens in the Tokens section to go to that token's page. Below you will find a description of all blocks on this page. The page of any token is divided into several blocks, let's consider each of them. ### Upper block
The following functions are available in this block * [**Token price**](/use/tokens/interface/token-page/price) chart * [**Volume** ](/use/tokens/interface/token-page/trading-volume)chart * [**TVL** ](broken://pages/O5ExJrTq4t35dX1GPAFl)chart * [**Add liquidity**](/use/pools/how-to/add-liquidity) - click to go to the page for adding liquidity paired with this token * [**Trade** ](/use/swap)- swap this token * [**Open in explorer**](/use/tokens/interface/token-page/open-in-explorer) - click on the arrow in the upper right corner of the top block to go to the token page in the explorer Also on the right side of this block you can see information about: * [**TVL**](/use/tokens/interface/token-page/tvl) * [**Trading volume**](/use/tokens/interface/token-page/trading-volume) for the last 24 hours * [**Trading volume**](/use/tokens/interface/token-page/trading-volume) for the last 7 days * **Number of transactions** in the last 24 hours ### [Pairs block](/use/tokens/interface/token-page/pairs)
### [Transactions block](/use/tokens/interface/token-page/transactions)
### # Price First, on a token's page, you can view the token's **price** chart. This is the price at which this token is traded on FlatQube. You can switch between chart display modes: by hours (**H**) and by days (**D**) for more convenient tracking of price changes.
# TVL **TVL** (Total Value Locked) displays the dollar value of all tokens locked in all relevant FlatQube pairs. To switch the graph to TVL, click the corresponding button on the graph.\ You can switch between chart display modes: by hours (**H**) and by days (**D**) for more convenient tracking of TVL changes.
# Trading volume **Trading volume** - the number of tokens by dollar value that have participated in exchanges during a certain period of time. To switch the graph to **Volume**, click the corresponding button on the graph.\ You can switch between chart display modes: by hours (**H**) and by days (**D**) for more convenient tracking of trading volume changes.
# Pairs The **Pairs** block contains all pairs with this token that are available for adding liquidity. Here you have the following options: * **Sort tokens by TVL** - click on *TVL* in the upper right corner of the pairs sheet to sort them by [**TVL**](/use/tokens/interface/token-page/tvl). * **Switch between pages** - in the lower right corner, by clicking on the arrows, you can switch between token pages. * **Go to pair page** - click on one of the pairs to go to the [**pair page**](broken://pages/t75xfSCuA9R3swii4uFP) with detailed information about it. * **Add to favorites** - click on the "star" next to a pair to add them to your favorites. These pairs will be displayed on the main page of the [**Pools** ](/use/pools)section.
# Transactions This block displays all transactions in which this token has participated. Here you will see several columns with information: **Transaction** - is the type of transaction: * **Swap** - exchange of one token for another * **Add** - adding liquidity to one of the pairs * **Removes** - taking out liquidity from the corresponding pair. ![You can switch between the types of transactions that will be displayed](/files/o5IF87bYdOCzrEO3r3n6) * **Total value** - the total amount of the transaction in dollar terms. * **Left and Right token** - the number of corresponding tokens involved in the transaction. * **Account** - address of the account that made this transaction.
At the bottom of this block, you can switch between pages or go directly to a specific one. ![](/files/L3vFTTYOqGXdDc4FesK2) # Open in explorer Click on the arrow in the upper right part of the first block of the page to go to the page of this token in the explorer.
# How to # Upgrade token(s) If you have obsolete tokens in your EVER wallet (for example, TIP-3), then when you [connect your wallet](/use/getting-started/how-to-connect-a-wallet) to FlatQube (or just open FlatQube if the wallet was connected earlier), you will automatically receive an offer to update them. Let's go through all the steps to upgrade tokens: Click **Upgrade** to start the token upgrade process.
At this point, an EVER Wallet window will open, where you will need to confirm the transaction.\ \ Click **Send**, and in the next step, enter the password for the wallet account and click **Confirm transaction**.
Upon completion of the upgrade, you will receive a notification from EVER Wallet about the crediting of the corresponding updated token.\ The transaction itself can be found in the list of transactions in the wallet:
# Add custom token In order to add a custom token to the list of tokens, in the [Swap section](/use/swap), go to the token selection menu and insert the custom token root address into the field, then select the displayed token.
Now this token will be displayed in the list of tokens in the [Swap ](/use/swap)and [Pools ](/use/pools)sections. # Concepts Beter understanding of FlatQube tokens. # Tokens we use ## Token standard FlatQube uses a common standard for Everscale network tokens - TIP-3.1. The need to use TIP-3.1 tokens is due to the technical features of the Everscale blockchain, aimed at reducing transaction fees, increasing reliability and speed through dynamic sharding and P2P architecture. See TIP-3.1 for details. Here are some useful links: {% embed url="" %} {% embed url="" %} ## Root contract The token root contract stores general information about the token, e.g. name, symbol, decimals, token wallet code and so on. ## User contract Each token holder has its own instance of a token wallet contract. Transfers happen in a decentralized fashion - a sender token wallet SHOULD send a specific message to a receiver token wallet. Since token wallets have the same code, it's easy for receiver token wallets to check the correctness of sender token wallets. \\ # EVER and wEVER **EVER** is Everscale's blockchain native token. This token is used when interacting with any contract on the network. It is with EVER that you pay the commission for any transaction. The **Wrapped EVER** project allows Everscale's EVER token to be used as a TIP-3.1 compliant token. Wrapped EVER works pretty much the same as Wrapped Ether.\ Minting and burning takes place on the Everscale network. Anyone can mint wEVER by locking EVER in the Vault contract. Also, wEVER can be burned to get EVER. Use the [Wrappedever.io](https://wrappedever.io) interface to convert EVER to wEVER and vice versa. {% hint style="info" %} Now EVER can be used on FlatQube. Your default balance will now be your cumulative balance of wEVER and EVER. These tokens can be swapped for any other TIP-3.1 tokens and you can also use them individually on the DEX if you wish. {% endhint %} {% embed url="" %} {% embed url="" %} # Token lists As the Everscale ecosystem continues to evolve, we continue to see an exponential increase in the number of TIP-3.1 tokens issued. As the rate of issuance of tokens increases, it becomes increasingly difficult for users to filter high-quality legitimate tokens from fraud, fakes, and duplicates. To solve this problem, there are Token Lists - standards for creating a list of tokens. Without a listing, the utility of an asset is greatly reduced. Unlisted assets often cannot be transferred, sold or used in any other way. For all intents and purposes, "unregistered assets" do not exist. Lists of tokens will allow you to immediately recognize and interact with new TIP-3.1 tokens as soon as they are deployed. Token lists leverage the strengths of decentralized blockchains like Everscale—the many high-quality projects and communities, their ability to share public infrastructure, and the ease of interoperability between them. The idea is simple: any project that maintains a list of tokens makes that list public. Thus, these projects tie their reputation to published lists. Another important benefit of lists is the speed with which new assets can be discovered and used. If a new resource is released by an authoritative project, the project can simply update its own list, and any interface (or maintainer of the aggregate list) that subscribes to that list can automatically import it in real-time. {% hint style="info" %} At the moment, lists of tokens have not yet been implemented and you can only [add custom tokens](/use/tokens/how-to/add-custom-token) manually through the token selection interface. {% endhint %} # Pools # Interface # All pools By navigating to the **Pools** section, you will find yourself on this page. Let's take a closer look at it. In the upper part you will see **Favorite Pools** section. To the right of it there are two buttons: **New position** and **Remove liquidity**, which allow you to [lock or unlock](/use/pools/how-to/add-liquidity) tokens in the pools of your interest. Lower there is the **All pools** section. It includes the whitelisted pools or those added by yourself. (link to How to - Create/Add custom pair). The information displayed: * **The number and the name of the pool** - the name is a set of tokens that make up this pool. * **TVL** - it is the dollar equivalent of all tokens locked in the respective pool. * **Volume 24H/7D** - the trading volume of the pool for the last day and a week, respectively. * **Your share** - your share in this pool. It reflects the percentage of tokens locked by you out of the total number of tokens in this pool.
# Pool page By clicking on any pool on the `Pools` section, you will be taken to its page. Pay attention to the buttons to the right of the pool name. \ Via clicking on the corresponding buttons, you can [add or withdraw liquidity](/use/pools/how-to/add-liquidity), or [exchange](/use/swap) one of the tokens of the pair for another. ## **Statistics** There is a `statistics` section at the top of the page. The left part of the section displays various information about the pool: * **Total Value Locked** - dollar equivalent of all tokens locked in this pool * **24H/7D Trading Volume** - the trading volume of this pool for the last day and seven days, respectively. It reflects the dollar equivalent of all transactions in the pool. * **24H fees** - dollar equivalent of the tokens evenly distributed in the form of commissions to liquidity providers in the last 24 hours. On the right, there is a graph showing various pool statistics.\ You can switch between graph display modes: token exchange price, transaction volume and liquidity.
## Your balance Lower, there is `Your balance` section. It provides the information about your tokens belonging to this pool. The **Total balance** contains general information about the balance, namely: * The dollar equivalent of your tokens in the pool * The total number of your tokens in the pool * Total number of your LP tokens in the pair * Your `share` in the pool. That is, the percentage of your LP tokens from the total number of LP tokens of this pool `Wallet balance` and `Locked in the farming pools` contain information about the tokens belonging to this pool that are on the balance of your wallet and locked in farming pools, respectively. In the right part of the section there is the button for depositing tokens into this pool. Click the appropriate button to go to the page for adding liquidity.
## **Farming pools** This section displays all farming pools using LP tokens of this pool as farming tokens. Clicking on the name of the farming pool will take you to its page. The information displayed: * **The name of the farming pool** * **Reward** - tokens paid as reward for farming * **TVL** - dollar equivalent of all tokens locked in this farming pool * **ARP min/max** - is a measure of the annual yield of the pool * **Your share** - that is, the percentage of your LP tokens from the total number of LP tokens of this pool **Min. APR** is the minimum profit that a user receives for locking their LP tokens for the shortest period possible **Max. APR** is the profitability for the maximum boost coefficient for LP tokens and the boost for locking QUBE tokens. **(link to concept/Boosted-farming)** * **Your total reward** - the number of reward tokens that are in Vesting **(link to Vesting)** or available for withdrawal. * **Entitled reward** - the number of reward tokens that are in the Vesting. **(link to Vesting)**
## **Transactions** There is the **`Transaction`** section at the bottom of the page. The information about all transactions related to a pool is displayed here, namely: * **Transaction -** transaction type \ **Swap** - exchange of one token of a pair for another \ **Deposit/Remove** - add/remove liquidity to/from this pool. * **Tokens** - the number of tokens exchanged **(link to Swap)**, added or withdrawn **(link to Add/Remove liquidity)** by the transaction * **Total Value** - dollar equivalent of the tokens exchanged \*\* (link to Swap)\*\*, added or withdrawn **(link to Add/Remove liquidity)** by the transaction. * **Account** - the address of the account that initiated the transaction. By clicking on the address, you will open the page of this account in the Everscan blockchain explorer * **Time** - date and time of completion of the transaction. Please note that you can switch the type of transactions displayed in the upper left part of the section.
# How to # Connect DEX account When you [add liquidity](/use/pools/how-to/add-liquidity) to a particular pool for the first time, you will need to connect your DEX account to that pool. To do this, click **Connect pool** and confirm the transaction to your EVER Wallet.\ After the transaction is completed, you will be able to interact with the liquidity of this pool.
# Add liquidity (Get LP tokens) / Withdraw liquidity ## Add liquidity There are several ways to get to the liquidity deposit interface of a specific pool: 1. Go to the `Pools`section and click on the `New position` in the upper right part of the page. 2. Go to the `Pools` section and then to the page of the pool you are interested in. Then click `Add liquidity` on the upper right side of the page. Now, let's go directly to the process of adding liquidity: Learn more about this in the fourth step of the following instructions. 1. Go to the interface for adding liquidity using one of the methods described above. 2. Select the tokens that form the pair of this pool. \ Note that you can also use tokens not included in the whitelist, thus creating a custom liquidity pool. 3. If you are adding liquidity to this pool for the first time, click on `Connect Pool` and confirm the transaction in the Ever Wallet window that opens.
4. If you are interested in unilateral provision of liquidity, click on `Enable auto-exchange` and enter in the top line the amount of tokens that you want to deposit into the pool. In this case, the equivalent of half of these tokens will be automatically exchanged for the second token of the pair during the deposit process. \ Otherwise, ignore the auto-exchange and enter the amount of the first and second tokens that you want to deposit into the pool. The equivalent of half of the second token of the pair will be added automatically. 5. Click `Deposit Token 1` and confirm the transaction in the Ever Wallet window that opens.\ After the transaction is completed, if you have not used auto-exchange, do the same action for the second token. 6. Wait for the token deposit transaction to complete and click Supply. Confirm the transaction in the Ever Wallet window that opens and wait for it to complete. {% hint style="success" %} Congratulations! You have successfully deposited your tokens into the pool. In exchange for the provided liquidity, you will receive LP tokens, which you can then use in the corresponding [farming pool](/use/farming/new-farming/interface/farming-pools). {% endhint %}
## Withdraw liquidity There are several ways to get to the interface for withdrawing liquidity from a specific pool: 1. Go to the `Pools` section and click on `Remove liquidity` in the upper right part of the page. 2. Go to the `Pools` section and then to the page (link to the Pool page) of the pool you are interested in. Then click `Remove liquidity` on the upper right side of the page. So, let's go directly to the process of withdrawing liquidity: 1. Select the tokens that form a pair of the pool you are interested in. 2. Enter the amount of LP tokens you want to burn and convert them into “regular” tokens. You will see the number of tokens that will be returned to your balance after the process is completed. Your updated share in the pool and the number of tokens that will remain locked will be displayed at the bottom. 3. Click `Confirm` and confirm the transaction in the Ever Wallet window that opens. 4. After confirming the transaction, just wait for its completion. Once it is completed, you will see the Transaction submitted window. {% hint style="success" %} Congratulations! The tokens have been added to your balance. {% endhint %}
# Create a new pool {% hint style="info" %} You can create your own pool consisting of one or more tokens that are not included in the FlatQube whitelist {% endhint %} 1. Go to the `Pools` section 2. Click on the `New position` button in the upper right part of the page 3. If your pool will include a token available in the FlatQube whitelist, select it from the list by clicking on `Select a token`. Otherwise, you first need to add a custom token to the list, as described in step `4`. 4. Let's add a token that is not on the list.\ \ To do this, click `Select a token` and enter the *Root address* of the required token in the field at the top of the list. If you created it using the in-built [FlatQube builder](/use/token-builder), you can find the address on the [page of the token](/use/token-builder/interface/token-page). Also, the root address of any token is displayed on the page of the token in the [EVER Scan](https://everscan.io/) blockchain explorer.\ \ Click `Import` and confirm your action. 5. After that, if such a pool has not yet been created on FlatQube, click on the `Create pool` button and confirm the transaction in Ever Wallet.
{% hint style="success" %} Congratulations! Your pool is created.\ The [process of adding liquidity](/use/pools/how-to/add-liquidity) to the newly created pool does not differ from the pools located in the FlatQube whitelist.\ You can add it there by placing it in your favorites. \ For this, we need to get to the page of the created pool in the `Pools` section. {% endhint %} Please note that at this stage the created pool will not appear on the list of pools! To do this: 1. Copy the *address of the pool* (it is displayed at the bottom of the page for adding liquidity), and paste it into the address bar of the `Pools` section (for example, in our case, this is ) 2. Add this pool to your favorites by clicking on the *star* . 3. Now this pool will be displayed on the main page of the Pools section. # Calculate the amount of LP tokens Learn how LP tokens are minted against the provided liquidity ## Initial supply When you create a new liquidity pool and deposit liquidity in it, you get the initial amount of LP tokens used as a benchmark for all consequent supplies. Let's look at an example to understand the initial minting process better. Imagine you are creating a pool of 1,000,000 APPLE and 200 CUCUMBER tokens, which have the following precision (number of digital places after the comma): * APPLE - 6 digits (0.000 000) * CUCUMBER - 12 digits (0.000 000 000 000) As Everscale smart contracts operate in integer numbers, they perceive the number of tokens as one big number joining together the integer part and the fraction up to the precision. In other words, 1 APPLE is saved as 1,000,000 in the smart contract, whereas 1 CUCUMBER token is 1,000,000,000,000. So in our example, 1,000,000 APPLE tokens turn into 1,000,000,000,000 in smart contract memory, and 200 CUCUMBERs into 200,000,000,000,000. Next, the contract takes the biggest number of those two (i.e., 200,000,000,000,000) and divides it by LP-token precision (9 digits) to issue LP tokens. It means that at the end of the pool creation, you will get 200,000 FLATQUBE-LP-APPLE-CUCUMBER tokens. ## Subsequent supplies All subsequent supplies operate on the proportion of newly provided liquidity compared to (a) the current liquidity level in the pool and (b) the total supply of LP tokens. Let's imagine we decided to add 200,000 APPLE and 40 CUCUMBER tokens. In such a case, the contract will calculate the amount of LP tokens to mint following this formula: $$ LP\_{issue}=LP\_{current} × max(\frac{SupplyLeft\_{new}}{SupplyLeft\_{old}},\frac{SupplyRight\_{new}}{SupplyRight\_{old}}) $$ So in our case, it will be: $$ LP\_{issue}=200,000\times max\big(\frac{200,000,000,000}{1,000,000,000,000},\frac{40,000,000,000,000}{200,000,000,000,000}\big)=50,000 $$ The total LP-token supply in our example will result in: $$ LP\_{new}=LP\_{old}+LP\_{issue}=200,000+50,000=250,000 $$ {% hint style="warning" %} Please note that the balance between tokens in the pool will change after each swap. So you will need to provide a different number of pool tokens to get the same number of LP-tokens. {% endhint %} # Pool economics Each FlatQube liquidity pool is a trading venue for a pairof TIP-3.1 tokens. Besides the typical two token pools, FlatQube also provides N-pools. They can include three or even four tokens, allowing you to collect all the liquidity into one pool. This makes the choice of a pool for investment easier, and, at the same time, reduces the slippage rate. For the development of N-pools, we focused on Curve’s 3Pool approach. It served as a good foundation upon which we built our own solution. Currently, we are preparing the information explaining the complex formulas behind it. In case you want to learn more about this topic, [Curve documentation](https://classic.curve.fi/files/stableswap-paper.pdf) is a good place to start. When a [pool contract is created](broken://pages/Ox6o8i1WYlGWj6Ji4Wio), its balances for each token are 0; in order for the pool to begin facilitating trades, someone must seed it with an initial deposit for each token.\ This first liquidity provider is the one who sets the initial price of the pool. They are incentivized to deposit an equal *value* of both tokens into the pool. To understand why, consider a case where the first liquidity provider deposits tokens at a ratio different from the current market rate. This immediately creates a profitable arbitrage opportunity, which is likely to be exploited by an external party. When other liquidity providers add to an existing pool, they must deposit pair tokens proportional to the current price. If they don’t, the liquidity they added is at risk of being arbitraged as well. If they believe the current price is not correct, they may arbitrage it to the level they desire, and add liquidity at that price. As we’ve mentioned, a liquidity pool is a bunch of funds deposited into a smart contract by liquidity providers. When you’re executing a trade on FlatQube you’re executing a trade against the liquidity in the liquidity pool. For the buyer to buy, there doesn’t need to be a seller at that particular moment, only sufficient liquidity in the pool. When you’re buying a coin on FlatQube, there isn’t a seller on the other side in the traditional sense. Instead, your activity is managed by the algorithm that governs what happens in the pool. In addition, pricing is also determined by this algorithm based on the trades that happen in the pool. ### LP tokens Whenever liquidity is [deposited ](/use/pools/how-to/add-liquidity)into a pool, unique tokens known as **LP tokens** are minted and sent to the provider's address. These tokens represent a given liquidity provider's contribution to a pool. The proportion of the pool's liquidity provided determines the number of liquidity tokens the provider receives.\ \ Whenever a trade occurs, a 0.3% [liquidity provider fee](/use/swap/concepts/fees) is charged to the transaction sender. This fee is distributed *pro-rata* to all LPs in the pool upon completion of the swap.\ Additionally, for pools participating in QUBE farming rewards voting, the fee is redirected towards QUBE buyback. In contrast, for all other pools, the fee remains within, amplifying the stakes of the liquidity providers. To retrieve the underlying liquidity, plus any fees accrued, liquidity providers must ["burn" their liquidity tokens](broken://pages/Yj8654hOeX31PgX7Dayb), effectively exchanging them for their portion of the liquidity pool, plus the proportional fee allocation. As liquidity tokens are themselves tradable assets, liquidity providers may sell, transfer, or otherwise use their liquidity tokens in any way they see fit. Since liquidity is very important, FlatQube has a special interface to encourage liquidity providers - [**Farming**](/use/farming). You can lock your **LP tokens** in the appropriate farming pools for rewards. # Farming Learn all about the FlatQube yield farming program, a tool that allows you to earn by providing liquidity. # New farming Welcome to the updated farming section. The [old farming](/use/farming/old-farming) will continue to work, however, only those pools that do not participate in the FlatQube DAO voting will work. You can use the old farming by visiting the appropriate section: {% embed url="" %} What is new in the updated farming and what aspects have been changed? 1. [Boosted farming](/use/farming/concepts/boosted-farming) - the ability to increase the speed of farming by locking QUBE and LP tokens. 2. Gauges (new farming pools) 3. [Reward distribution speed change](/use/farming/concepts/reward-distribution) 4. Updated [farming pool creation form](https://github.com/babowsk1/flatqube-docs/blob/main/use/farming/new-farming/broken-reference/README.md) # Interface # Farming pools By going to the [**Farming** ](/use/farming/concepts/yield-farming)section, you will find yourself on a page with a list of currently available Farming pools.\ If you previously [added liquidity](/use/farming/old-farming/how-to/deposit-farm-tokens) to one of the farming pools, then this pool will be displayed in the Favorite pools block. This page also displays various columns with farm pool information: * **Farm pool** - the [LP tokens](/use/pools/how-to/add-liquidity) of this particular liquidity pool must be locked in the Farming pool in order to start receiving a reward. * **Reward** is the tokens that are awarded as a [reward for farming](/use/farming/concepts/reward-token) in this pool. * **TVL** is the total dollar amount of tokens locked in this farming pool. * **APR, min./APR, max.** is a measure of the annual yield of that pool.\ **Min. APR** is the minimum profit that a user receives for locking their LP tokens for the shortest period possible. **Max. APR** is the profitability for the maximum boost coefficient for LP tokens and the boost for locking QUBE tokens. You can find out more about the boosting mechanism via following [this page.](/use/farming/concepts/boosted-farming) * **Share** is your share in the farming pool. This is the percentage of the TVL that your locked liquidity constitutes.\ At the same time, Share also means the percentage of the reward that you will receive for every unit of time. * **Your reward** is the reward available for the [claim](/use/farming/old-farming/how-to/claim-reward). * **Entitled reward** is a reward that is in the [vesting](/use/farming/concepts/vesting) protocol. * Notice the **Filters** button at the top right of the page.
# Farming page (user) In order to go to the Farming pool page, you need to click on one of the pools in the [Farming section.](/use/farming)​ The farming pool page displays detailed information about that pool. Let's take a closer look at each block of this page using the QUBE/WEVER farming pool as an example.​ ## [My farming performance and deposits](/use/farming/new-farming/interface/farming-page-user/farming-performance-and-deposits) This blocks displays information about your balances in this farming pool.​​​
## [Farming pool statistics​](/use/farming/new-farming/interface/farming-page-user/statistics) This block displays the statistics of this Farming pool, as well as a graph of its TVL and APR.​​​
## [Farming speed](/use/farming/new-farming/interface/farming-pools) This block displays the current farming speed, the history of its changes, as well as information about vesting.
## ​[Transactions​](/use/farming/new-farming/interface/farming-page-user/transactions) This block displays information about the latest [transactions ](/use/farming/new-farming/interface/farming-page-user/transactions)in this farming pool.​
# Farming performance and deposits ### Your farming performance This block displays information about your locked funds in the pool: Balance displays: * The dollar equivalent of your stake (current and past). * Amount of tokens that make up your LP at the moment.\ This number changes depending on the ratio of the prices of these tokens to each other. * Number of locked LP tokens. * Share in the farming pool reflects the percentage of your farming LPs from the total number locked in this farming pool.\ At the same time, it is a percentage of the total reward that you will receive at any given time.
* **Available reward** - the amount of earned reward, which you can withdraw at the moment. * **Locked reward** - the amount of reward locked in the [vesting](/use/farming/concepts/vesting).\ Part of this reward is permanently unlocked and goes to Available reward.
The right side contains APR information and a balance management window: * **Current APR** is the current annual return from your stake. * **Default APR** is the annual yield of the pool without taking into account the boosts. * **Boost with LP lock** - the percentage of APR that is given by locking LP tokens for a certain period of time. * **Boost with QUBE** - the percentage of APR which is given by locking QUBE. Read more on the page at [this link](/use/farming/new-farming/how-to/get-a-boost). Clicking on **Deposit LP** tokens will open a window for [depositing ](/use/farming/new-farming/how-to/deposit-withdraw-farm-tokens)LP tokens into the pool. Clicking on **Withdraw LP token** will open a window for [withdrawing ](/use/farming/new-farming/how-to/deposit-withdraw-farm-tokens)funds from the pool.
## Deposits Below is the My deposits block, which contains information about your deposits into this pool: * **Amount, LP-tokens** - the amount of LP tokens deposited by this transaction * **Deposit status** - the status of this deposit (in our case, the funds are still blocked and, accordingly, the boost is activated) * **Deposit date** * **APR boos**t - APR coefficient, applied to this deposit. * **Lock period** * **End lock date**
# Statistics This block displays the total statistics of the farming pool: * **TVL** - the total number of tokens blocked in the pool and their dollar equivalent. * **APR, min./APR, max.** is a measure of the annual yield of that pool.\ **Min. APR** is the minimum profit that a user receives for locking their LP tokens for the shortest period possible.\ **Max. APR** is the profitability for the maximum boost coefficient for LP tokens and the boost for locking QUBE tokens. * **Reward balance** - the number of tokens, distributed as a reward throughout the farming period. * **Farming speed, sec** - the number of tokens per second, evenly distributed among the stakeholders as a reward. Next to it is a graph reflecting the pool statistics.\ Note that you can change the display options between TVL, Min. and Max. APR, and between days and hours.
# Farming speed and vesting These three blocks display information about the farming rate in that farming pool. The **Vesting block** displays information about the vesting applied in this pool: * **Reward token** - the token distributed as a reward * **Ratio vesting** - the percentage of the reward unlocked for the specified period * **Vesting period** - the period after which the reward will be unlocked * **Vesting end date** - the date by which all currently available tokens in the Locked reward will be unlocked. As long as you continue farming, this date will shift as new reward tokens are constantly being vested. **Farming speed** block displays information about the award distribution: * **Epoch reward budget** - the amount of reward received by this pool as a result of voting in the DAO. For two weeks from the end of an epoch, this reward will be evenly distributed among all the stakeholders. * **Farming speed, sec** - the number of tokens distributed between all stakeholders every second. * **Start and End** - the moment of start and end of this epoch's reward distribution.
# Transactions The bottom block of the Farming pool page is the transaction block. **The transaction block** displays all transactions associated with this Farming Pool.\ The types of these operations are divided into Claims, Deposits, Withdrawals and Reward deposits. * \*\*\*\*[**Claims**](/use/farming/new-farming/how-to/claim-reward) - withdrawals of Unclaimed reward to the DEX account balance. * \*\*\*\*[**Deposits** ](/use/farming/new-farming/how-to/deposit-withdraw-farm-tokens)- locking LP (faming) tokens in the pool. * \*\*\*\*[**Withdrawals** ](/use/farming/new-farming/how-to/deposit-withdraw-farm-tokens)- withdrawals of LP (farming) tokens from the pool. * [**Reward deposits**](/use/farming/concepts/reward-token) - the addition of reward tokens by the pool administrator to the reward balance. You can switch between filters for displaying transactions at the top of the block, as well as enable the display mode of only those transactions that are linked to your DEX account. In addition to transaction types, this block displays related information: * **Total value** - the dollar equivalent of the amount of tokens that were added or withdrawn by this transaction. * **Token**/**Left** and **Right Token** - the amount of left and right tokens added or withdrawn by this transaction. * **LP token** - the amount of LP (farming) tokens added or withdrawn by this transaction. * **Account** - the address of the account from which the transaction was made. * **Time** - the time that has elapsed since the completion of the transaction.
# Farm page (administrator) This page will show you how to create and manage your own farming pool. ## Create farming pool Thanks to the FlatQube functionality, you can create your own pools: choose a farming token, a reward, its distribution rate, etc.\ You can also create a farming pool with a [custom liquidity pool](broken://pages/7HAg7EKBIKixqbVFGkGQ). To create a farming pool, go to the **Farming** section and select **Create farming pool** at the top right of the page.
In the page that opens, you need to fill in some fields: 1. First, copy the root address of the token that will be used for farming (LP token) and paste this address into the **Farm token root** line. 2. If necessary, check the box next to **Active** [**token boost**](/use/farming/concepts/boosted-farming).\ Enter the maximum token lock period as well as the maximum boost ratio. 3. The standard reward token is QUBE, but you can add any other token as a reward.\ To do this, click **Add reward token** at the bottom left of the page, enter the root address of the token, the [vesting ](/use/farming/concepts/vesting)period and the [vesting ](/use/farming/concepts/vesting)ratio. 4. Click **Create pool** and confirm the transaction in the Ever Wallet window that opens.
Congratulations, you have created your own farming pool! ## Find my farming pool After you create a farming pool, it will automatically be added to your favorites list.\ However, if you go to the main page of the Farming section you probably won't find it there. The thing is that by default, pools with zero balance are not displayed in the general list. To find your pool, click the "Filters" button in the upper right corner and select With low balance. Then you will see your pool in the general list or in the list of favorites. ## Farming pool Management ### Deposit reward tokens If you add any token other than QUBE as a reward for the farming pool, then, you have the opportunity to manually replenish the reward balance with this token. Recall that QUBE rewards [are added](/use/farming/concepts/reward-distribution) to the gauge by DAO voting. 1. Go to your farming pool page from the Farming section. 2. At the top of the Pool management block is the Deposit reward tokens block. Enter the number of tokens you want to deposit into the pool and click Deposit. 3. Confirm the transaction in the Ever Wallet window that opens and wait for it to close. 4. Then you will see this transaction in the transaction list at the bottom of the pool page and its Reward balance will change.
### Change farming speed You can change the reward distribution speed for an award token that is not a QUBE. Recall that for QUBEs, the reward distribution speed is [determined](/use/farming/concepts/reward-distribution) by voting in the DAO. 1. Go to your pool page from Farming 2. Click on the [⚙️](https://emojipedia.org/gear/) next to the Pool management block. 3. Enter the desired distribution speed, and the date and time when you want the speed to be changed. 4. Click Save changes and confirm the transaction in the Ever Wallet window that opens.
### Close farming pool You have the ability to manually stop the farming in your pool.\ \ **Note that this action is irreversible!** 1. Go to the farming pool page from the Farming section 2. Click on the gear next to the Pool management block 3. Click on the Danger zone at the top of the window that opens 4. Enter the date and time when the farming ends. At this point, farming will stop and you can collect the remaining Reward tokens.
*** # How to # Claim reward Passing through the vesting, your locked reward is gradually unlocked and becomes available for withdrawal to your wallet balance. 1. To collect your reward go to the desired farming pool page from the Farming section. 2. In the block Your farming performance click on Claim reward 3. Confirm the transaction in the opened Ever Wallet window.
# Deposit/Withdraw farm tokens ## Deposit LP tokens In order to take part in farming, you need to invest any number of LP tokens in the farming pool you are interested in: 1. Go to the Farming section and select the farming pool that interests you 2. If you have not done this before you can get LP tokens by clicking on the appropriate button 3. Go back to the farming pool page and click on Deposit LP tokens in the block Your farming performance 4. Enter the amount of LP tokens that you want to block in the farming pool, as well as the lock period. The lock period will affect the [farming boost](/use/farming/concepts/boosted-farming). 5. Confirm the transaction in the Ever Wallet window that opens and wait for it to complete
## Withdraw LP tokens In order to withdraw LP tokens from the farming pool do the following: 1. Go to the page of the pool you are interested in from the Farming section. 2. In the block Your farming performance click on Withdraw LP tokens. 3. Enter the number of LP tokens you want to withdraw. If you want you can withdraw them together with the reward. To do this, put a check mark next to the corresponding line. 4. Click Withdraw and confirm the transaction in the opened Ever Wallet window.
# Get a boost You can increase the amount of rewards for farming using **Boosted Farming:** 1. Go to the Farming pools section and select the remote control you need. 2. Pay attention to the section on the right side of this pool - there you can replenish the pool with liquidity. 3. Enter the number of LP tokens that you want to deposit into this pool and select the token locking period. The longer the tokens remain locked, the greater the multiplier your farming speed. 4. Click Deposit to start farming and confirm the transaction in the Ever Wallet window that opens.
# Old farming # Interface # Farming pools By going to the [**Farming** ](/use/farming/concepts/yield-farming)section, you will find yourself on a page with a list of currently available Farming pools.\ If you previously [added liquidity](/use/farming/old-farming/how-to/deposit-farm-tokens) to one of the farming pools, then this pool will be displayed in the Favorite pools block. This page also displays various columns with farm pool information: * **Farm pool** - the [LP tokens](/use/pools/how-to/add-liquidity) of this particular pair must be locked in the Farming pool in order to start receiving a reward. * **Reward** is the tokens that are awarded as a [reward for farming](/use/farming/concepts/reward-token) in this pool. * **TVL** is the total dollar amount of tokens locked in this farming pool. * **APR** is the annual profit that this pool brings. * **Share** is your share in the farming pool. This is the percentage of the TVL that your locked liquidity constitutes.\ At the same time, Share also means the percentage of the reward that you will receive for every unit of time. * **Your reward** is the reward available for the [claim](/use/farming/old-farming/how-to/claim-reward). * **Entitled reward** is a reward that is in the [vesting](/use/farming/concepts/vesting) protocol.
Clicking on one of these pools will take you to the [Farming pool page](/use/farming/old-farming/interface/farm-page-user). # Farm page (user) In order to go to the Farming pool page, you need to click on one of the pools in the [Farming section.](/use/farming) The farming pool page displays detailed information about that pool.\ Let's take a closer look at each block of this page using the wEVER/BRIDGE farming pool as an example. ### [My farming performance and Farming balances](/use/farming/old-farming/interface/farm-page-user/farming-perfomance-and-balances) This blocks displays information about your [**balances** ](/use/farming/old-farming/interface/farm-page-user/farming-perfomance-and-balances)in this farming pool.
### [Farming pool statistics](/use/farming/old-farming/interface/farm-page-user/statistics) This block displays the [statistics ](/use/farming/old-farming/interface/farm-page-user/statistics)of this Farming pool, as well as a graph of its TVL and APR.
### [Farming speed changes](https://github.com/babowsk1/flatqube-docs/blob/main/use/farming/old-farming/interface/farm-page-user/broken-reference/README.md) This block displays the current [Farming Speed](https://github.com/babowsk1/flatqube-docs/blob/main/use/farming/old-farming/interface/farm-page-user/broken-reference/README.md), as well as the history of its changes.
### [Details](/use/farming/old-farming/interface/farm-page-user/farm-information) This block displays information about the [vesting ](/use/farming/concepts/vesting)of this farming pool, as well as the addresses of contracts.
### [Transactions](/use/farming/old-farming/interface/farm-page-user/transactions) This block displays information about the latest [transactions ](/use/farming/old-farming/interface/farm-page-user/transactions)in this farming pool.
# Farming perfomance and balances ### My farming perfomance This block displays information about your funds locked in this farm pool: * **Farming balance** displays the price of all your [locked ](/use/farming/old-farming/how-to/deposit-farm-tokens)farming tokens in this pool at the moment in dollar terms. * **The breakdown of LP** tokens displays the amount of tokens that make up your LP at the moment. This number changes depending on the ratio of the prices of these tokens to each other. * **LP token** is the amount of locked LP tokens you are using to farm[ ](/use/farming/old-farming/how-to/deposit-farm-tokens)in this farming pool. * **Share in farming pool** displays the percentage of your farming LPs from the total number locked in this farming pool. At the same time, it is a percentage of the total reward that you will receive at any given time.\ Let's say the **farming speed** of pool is 0.1$ per second and your Share in the farming pool is 10%. In this case, every second, 10% of $0.1 is transferred to [vesting ](/use/farming/concepts/vesting)and, accordingly, your **Entitled reward**, and your profitability is $0.01 per second or $36 per hour.
**History balance** displays the price of the tokens that make up your LP at the time of the last [Withdraw ](/use/farming/old-farming/how-to/withdraw-farm-tokens)or [Deposit ](/use/farming/old-farming/how-to/deposit-farm-tokens)of LP tokens in dollars. **History LP breakdown** displays the exact number of tokens that were [locked ](/use/farming/old-farming/how-to/deposit-farm-tokens)in the form of LP at the time of the last [Withdraw ](/use/farming/old-farming/how-to/withdraw-farm-tokens)or [Deposit ](/use/farming/old-farming/how-to/deposit-farm-tokens)of LP tokens.
**Reward Balance** displays the amount of tokens earned at the moment that are [available for claim](/use/farming/old-farming/how-to/claim-reward) or are still in [vesting ](/use/farming/concepts/vesting)in USD equivalent. **Unclaimed reward** displays the number of tokens available for [claiming ](/use/farming/old-farming/how-to/claim-reward)at the moment\*\*.\*\* **Entitle reward** displays the number of [vested ](/use/farming/concepts/vesting)tokens you have earned. **Vesting end date** displays the date and time when all tokens currently in [vesting ](/use/farming/concepts/vesting)will be available for [Claim](/use/farming/old-farming/how-to/claim-reward). Obviously, as long as you keep farming, this date will shift.
### Farming balance This block contains the functionality of interaction with your LP tokens and rewards. **Deposit** allows you to[ lock LP tokens in this farming pool](/use/farming/old-farming/how-to/deposit-farm-tokens), allowing you to increase your Share and thus your percentage of the reward received. **Withdraw** allows you to [claim ](/use/farming/old-farming/how-to/claim-reward)the earned tokens available for this (Claim Reward), as well as [withdraw your LP tokens](/use/farming/old-farming/how-to/withdraw-farm-tokens) from this farming pool (Withdraw LP tokens).
# Statistics ### Farming pool statistics This block displays the current statistics of this farming pool. On the left you can see the following values: * **TVL** (Tota value locked) - the total amount of tokens [locked](/use/farming/old-farming/how-to/deposit-farm-tokens) in this farming pool in dollar terms. * **LP token and LP breakdown** express the TVL in terms of LP tokens and tokens of the pool, respectively. * **APR** - the annual return of the pool at the moment. * **Remain reward balance** - the number of tokens available to reward farmers. * **Farming speed, sec** - the reward that is distributed to all farmers of this pool every\*\*.\*\* * Your **Share** means the percentage you get of that number every second.
The graph on the right shows the change in **TVL** or **APR**, depending on the display mode.\ You can also change the display mode to easily track changes: **By hour (1H) or by day (1D)**.
# Farming speed This block displays the current **Farming speed**.\ Recall that farming pool administrators can change the speed, so the history of changes to this parameter is also displayed here. **Farming speed** is the number of tokens that are distributed to all [farmers ](/use/getting-started/roles#farmers)every second, in proportion to their [pool share](/use/farming/old-farming/interface/farm-page-user/farming-perfomance-and-balances).\ **Share** percentage means the percentage of the Reward that the farmer receives per second.
# Farm information ## Details This block contains information about the vesting rules, as well as addresses of contracts related to this pool. ### [Vesting](/use/farming/concepts/vesting) * [**Vesting ratio**](/use/farming/concepts/vesting) is the percentage of the reward that will be sent to vesting.vesting. Vesting * [**Vesting period**](/use/farming/concepts/vesting) - the period for which the received reward is unlocked. * [**Vesting end date**](/use/farming/concepts/vesting) - the date by which all currently available tokens in the Entitled reward will be unlocked. As long as you continue farming, this date will shift as new reward tokens are constantly being vested. ### Addresses Clicking on any of these addresses will take you to its blockchain explorer (EverScan) page. * **Farming pool contract address** - the contract on which all LP farm tokens and Reward balances are stored. * **Owner address** - address of the administrator of this pool. * **My farming address** - the contract with which interactions take place when you perform operations in this pool. * **Farming token root** - the root contract asdress of LP farm token of this farming pool. * **Reward token root** - the reward token address.
# Transactions The bottom block of the Farming pool page is the **transaction block**. **The transaction block** displays all transactions associated with this Farming Pool.\ The types of these operations are divided into **Claims**, **Deposits**, **Withdrawals** and **Reward deposits**. * [**Claims** ](/use/farming/old-farming/how-to/claim-reward)- withdrawals of Unclaimed reward to the DEX account balance. * [**Deposits** ](/use/farming/old-farming/how-to/deposit-farm-tokens)- locking LP (faming) tokens in the pool. * [**Withdrawals** ](/use/farming/old-farming/how-to/withdraw-farm-tokens)- withdrawals of LP (farming) tokens from the pool. * [**Reward deposits**](/use/farming/concepts/reward-token) - the addition of reward tokens by the pool administrator to the reward balance. You can switch between filters for displaying transactions at the top of the block, as well as enable the display mode of only those transactions that are linked to your DEX account. In addition to transaction types, this block displays related information: * **Total value** - the dollar equivalent of the amount of tokens that were added or withdrawn by this transaction. * **Token**/**Left** and **Right Token** - the amount of left and right tokens added or withdrawn by this transaction. * **LP token** - the amount of LP (farming) tokens added or withdrawn by this transaction. * **Account** - the address of the account from which the transaction was made. * **Time** - the time that has elapsed since the completion of the transaction.
# Farm page (administrator) Anyone can create and manage their own farming pool. ## How to create a farming pool Go to the Farming section and click Create farming pool in the upper right corner and fill in the required fields: * Farm token root - the address of the token that users deposit to participate in farming. It can be the address of the LP token of the liqidity pool. * Farm start - the date when farming starts. * Vesting ratio - percentage of the award that goes to vesting. * Vesting period - vesting period in seconds. * Reward token root - the address of the token that users farm. There may be several tokens like this one in a farming pool. Use the Add reward token button. * Reward per second - ​​farming speed, measured in tokens per second. Click Create farming pool, confirm the transaction in your EVER Wallet and wait for the pool creation process to complete.
## How to go to the page of the created Farming pool? 1. Go to the [farming section](/use/farming). 2. In the upper-right part of the **All pools** block, open the filter menu by clicking on the appropriate button and turn on the **With low balance** filter. 3. Find your pool in the list and go to its page by clicking on it.\ Here you can immediately add it to your [favorites ](broken://pages/xsy6NtlUkuDcJNdyqnM0)so that it appears on the main Farming section page.
## Farming pool management The page of the farming pool for administrators looks exactly like the page of any other [farming pool](/use/farming/old-farming/interface/farm-page-user), but with the addition of some management features: ### Deposit rewards The administrator of the farming pool can at any time deposit tokens into the pool that will be used to pay rewards. The administrator has to monitor the balance of the farming pool. If there are not enough tokens on the balance to pay all the rewards, the pool will be automatically marked with a danger icon in the general list.
### Changing the farming speed The administrator can increase or decrease the farming speed. To do that, one needs to indicate the start of a new farming period and a new farming speed.
### Closing the pool The administrator can at any time specify the date when the farming pool closes. At this point, the last unit of the reward will be distributed. Attention! You can only set the closing date once. After establishing an end date, you can neither change the date nor add another farming period.
### Withdrawal of unclaimed tokens If the administrator has deposited more reward tokens than necessary, these tokens can be withdrawn. To do so, you need to set the end date for farming, and then wait for the end of vesting + lockdown period (30 days).
# How to Learn how to interact with FlatQube farming pools. # Claim reward As you go through [**vesting**](/use/farming/concepts/vesting), your **Entitled reward** is gradually unlocked from the **Unclaimed reward**, from where it can be withdrawn from your Dex account balance at any time. The amount of Unclaimed tokens can be seen in the [**Reward balance block**](/use/farming/old-farming/interface/farm-page-user/farming-perfomance-and-balances) on the [**farming pool page.**](/use/farming/old-farming/interface/farm-page-user)\ You can withdraw these tokens to your Dex account balance on the same page in the **Farming balance block**.
### How to claim your reward Сlick **Claim** and confirm the transaction in your EVER Wallet.\ In this case, all Unclaimed tokens will be withdrawn.
Upon completion of the transaction, you will see that the **Unclaimed reward balance** will be reset, and the reward will be credited to the Dex account balance. # Deposit farm tokens ### Choose farming pool In order to start farming, you need to select one of the pools from the list in the Farming section. {% content-ref url="/pages/m7WWWNIdvqGNmwgZlGHE" %} [Farming pools](/use/farming/old-farming/interface/farming-pools) {% endcontent-ref %} ### Get LP tokens After you have decided on the choice of the pool, you need to get LP tokens of the corresponding pool.\ To do this, you need to add liquidity to this pool. {% content-ref url="/pages/AQj9i8KnxORevyqQGarj" %} [Add liquidity (Get LP tokens) / Withdraw liquidity](/use/pools/how-to/add-liquidity) {% endcontent-ref %} ### Deposit LP tokens Let's assume that we already have the corresponding tokens on the balance.\ In this case, we can start yield farming. 1. Go to the [page of the desired Farming pool](/use/farming/old-farming/interface/farm-page-user). 2. In the Farming balance block, enter the amount of LP tokens that you want to lock in farming. 3. Click **Deposit** and confirm the transaction in EVER Wallet. 4. After the transaction is completed, the pool page will change and you will see a new block - [My farming performance](/use/farming/old-farming/interface/farm-page-user#my-farming-performance-and-farming-balances).
# Withdraw farm tokens In order to withdraw your farming LP tokens from the farming pool, go to the [**farming page**](/use/farming/old-farming/interface/farm-page-user) of the required [**pool**](/use/farming/old-farming/interface/farming-pools)**.**\ The total number of your locked farming tokens in this pool and their dollar equivalent are displayed in the **Farming balance block**.
## How to withdraw farming tokens In the **Withdraw block**, select **Withdraw LP tokens**. Enter the amount of farming tokens you want to withdraw and click **Withdraw**. After **confirming** the transaction in your EVER Wallet, please wait a bit. After completing the transaction, you will see that your Farming balance has changed - LP tokens have been successfully withdrawn and are stored on your DEX account balance.
# See farming performance In order to see your Farming performance, go to the [**Farming section**](/use/farming), and then to the page of the required pool.\ Information about [**Farming performance and balances**](/use/farming/old-farming/interface/farm-page-user/farming-perfomance-and-balances) is located in the top block of the page.
# Find my transactions In order to find your transactions associated with a specific [**Farming Pool**](/use/farming/old-farming/interface/farming-pools), go to the [page of that Farming Pool](/use/farming/old-farming/interface/farm-page-user) and navigate to the bottom of the page to the [**Transactions block**](/use/farming/old-farming/interface/farm-page-user/transactions). In the upper-right corner of the block, check the box next to **Only my transactions** to display only transactions associated with your [DEX account](/use/pools/how-to/connect-dex-account).\ For the convenience of finding the transaction you need, you can [filter them](/use/farming/old-farming/interface/farm-page-user/transactions) by type at the top of the block.
# Concepts Better understand FlatQube farming concepts . # Yield farming {% embed url="" %} ## What is Yield Farming? **Yield farming**, or liquidity mining, is a method of earning rewards as a result of providing tokens for liquidity.\ For simplicity’s sake, farming can be likened to staking, but there are a few key differences between the two practices.\ Farming is done by **Liquidity Providers**, who are users that lock their tokens in liquidity pools.\ In turn, **Liquidity Pools** are smart contracts (**Vaults**), in which a certain number of tokens are located.\ In exchange for locking in liquidity to a certain pool, providers receive [rewards](/use/farming/concepts/reward-token). ### Risks One of the most important distinctions between farming and staking is the heightened risk inherent.\ First and foremost, we are referring to the risk of Impermanent loss. Impermanent loss can occur as a result of price volatility for one or both of the tokens in a farming pool.\ The higher the volatility is for one token relative to the other, the higher the chances will be of impermanent loss occurring.\ From this, it stands to reason that the most stable form of earning in Farming Pools comes from the stablecoin pools.\ We highly recommend that anyone looking to become a liquidity provider familiarize themselves with the risks of Impermanent loss. This will help you make the most out of farming and prevent you from running into any unpleasant surprises.\ There are also IL calculators that you can use to help in the decision-making process, like this [one](https://dailydefi.org/tools/impermanent-loss-calculator/). # Reward distribution Reward tokens are those issued to stakeholders who have locked their funds in the farming pool. The main indicator of reward distribution is farming speed. The farming speed is the number of tokens evenly distributed among all stakeholders per second. Every second, a part of your reward gets into the Locked reward section.\ Afterwards, the rewards are unlocked with the help of [vesting](/use/farming/concepts/vesting). In [old farming pools](/use/farming/old-farming), the speed is set manually by the [pool administrator](/use/farming/old-farming/interface/farm-page-administrator) - it is needed just to enter the amount of tokens that will be distributed every second. However, in [new farming pools](/use/farming/new-farming) (gauges), this process is quite different. You can still manually add reward tokens (not QUBEs) and set a certain speed of their distribution. However, the main reward token in the new farming pools is QUBE.\ Manually adding it as a reward is no longer impossible. Determination of the number of QUBE rewards is accomplished by the [FlatQube DAO](/use/dao). Every Epoch (two weeks) there is a vote for the distribution of all QUBEs in proportion to the votes cast for a certain farming pool (virtual veQUBE tokens). Within the next two weeks after the end of the voting, all QUBEs allocated to the farming pool will be evenly distributed among all stakeholders. Example: As a result of voting in Epoch No. 2, 8,105 veQUBEs were cast as votes for the USDT/USDC farming pool, which is 11.09% of all votes cast in this Epoch.\ In this Epoch, the number of distributed QUBEs is 42350. Accordingly, from the end of voting in this Epoch until the end of voting in the next one, 11.09% of 42350 QUBEs, which is equal to 4694 QUBE, will be distributed in the USDT/USDC farming pool. The speed of farming in this case is 0.00388139 QUBEs per second. # Vesting ## Vesting As previously mentioned, rewards for farming are accrued constantly, but they do not immediately become available for withdrawal. The distribution of rewards on [**FlatQube**](https://flatqube.io) is done in accordance with a **Vesting** mechanism. **Vesting** is a market oversupply management tool that was created as a result of increased TVL and farming speed. The essence of vesting is to reduce the pressure on the price of tokens and encourage more long-term investors. Essentially, vesting on [**FlatQube**](https://flatqube.io) is a formula for progressively unlocking a liquidity provider’s rewards over time. Each farming pool has several parameters related directly to vesting (the values ​​of these parameters can be found on the page of each pool):\ **Vesting Ratio, Vesting Period, Vesting end date.** And the rewards themselves are indicated as **Unclaimed reward** and **Entitled reward**. We are going to break down what each of these terms means. **Vesting ratio** is the percentage of the reward that will be sent to vesting, and **Vesting period** is the time frame during which vesting will take place. **Vesting end date** is the date at which all rewards that have accumulated in vesting will be unlocked. **Entitled reward** is a parameter that shows the number of tokens that are in vesting and not available for withdrawal (Claim) at the moment. These tokens are gradually unlocked, and when they become available to withdraw they will be shown in the **Unclaimed reward** column. The accumulation of **Unclaimed rewards** from the amount locked in vesting (**Entitled reward**), begins immediately once they are received and ends once the **Vesting period** has expired. For example, if the **Vesting ratio** is 100% and the **Vesting period** is 120 days, it means that 50% of all tokens received as rewards will be sent to the user over the course of 110 days (these tokens will be displayed in the **Unclaimed reward** section). The remaining tokens will be sent over the course of the next 130 days. The rewards that are not yet available and that will be unlocked over the course of 120 days will be displayed in the **Entitled reward** section. Below we are going to take a look at how this works. In layman’s terms, every day 1/120th of the rewards that have accumulated in Entitled reward are sent to Unclaimed reward. Accordingly, every second 1/(60\*60\*24\*120) of the **Entitled reward** is unlocked. It is important to note that the share of unlocked funds is calculated from the current Entitled reward balance while your liquidity is locked in the farming pool, but once you decide to withdraw your LP tokens, the remaining Entitled reward balance will be unlocked in even shares every second. Put simply, the balance of the **Entitled reward** will be transferred to the **Unclaimed reward** in equal shares within 120 days from the moment the LP tokens are withdrawn from the farming pool. We highlight that the **Vesting end date** will constantly change until you withdraw your liquidity from a farming pool.\ This happens because rewards are received every second and instantly blocked and then sent to vesting in the form of **Entitled rewards** for future unlocking evenly over the next 120 days. When LP tokens are withdrawn from a farming pool, the **Entitled reward** will continue to be unblocked and sent to your **Unclaimed reward** over the course of 120 days and the number of your **Entitled Reward** will not increase. Example 1: you have LP tokens in farming and you receive 1 wEVER every second. Your total reward after the first second is 1 wEVER, after the 2nd second is 2 wEVER, after the 3rd second is 3 wEVER, and so on. Accordingly, your **Unclaimed reward**, which gets unlocked progressively, after the 2nd second is equal to the following: ![(1) after the 2nd second](https://miro.medium.com/max/394/0*nvkSZbnX8UQGpz7G) ![(2) after the 3rd second](https://miro.medium.com/max/362/0*dkVWQ5aWeWAVLUVB) ![(3) after the 4th second](https://miro.medium.com/max/392/0*C4yDdi8gRQm0OlUF) and the total **Unclaimed reward**, after the 4th second is equal to (1) + (2) + (3) Example 2: Let’s stay you have withdrawn your tokens from a farming pool and at that moment you had an **Entitled reward** of 10 wEVER. From the moment you withdrew your funds, your **Entitled reward** will no longer increase. This means that every second you will receive 10/(60\*60\*24\*120) wEVER and you will receive the remaining reward over the course of 120 days. Here is a graph to illustrate: ![](https://miro.medium.com/max/1400/0*PFBNKSshe6ypwe5f) Vesting graph displaying a **Vesting ratio** of 100% and a **Vesting period** of 120 days This is a vesting graph with a **Vesting ratio** of 100% and a **Vesting period** of 120 days. The graph displays a **Vesting Period** of 120 days — after 120 days, your LP tokens are withdrawn, and the **Entitled reward** earned during this time continues to be unlocked and transferred to the **Unclaimed reward**. At all times we have the following 2 parameters: 1\. **Entitled reward** — total of locked rewards 2\. **Unclaimed reward** — total of unlocked rewards To calculate the Unclaimed we have a few additional parameters: * now (the current time) * lCT — lastClaimTime (time of the last claim) * vP- vestingPeriod * pVI — partlyVestedInterval (partial vesting period) * fVI — fullVestedInterval (entire vesting period) Depending on how much time has passed since the last **Claim**, there are 2 scenarios for when more or less than the vesting period has passed. If less has passed, the calculations must be made according to F1. If more has passed, you need to calculate the required value using the F2 system. In fact, all you have to do is simply cut off part of the amount that was completely unlocked, and for the remaining, use the function from F1. ![](https://miro.medium.com/max/1344/0*H2hu9nxnyjBiJYI0) \\ # Farming token In order to become a farmer in a certain pool, you need to store a certain amount of **Farm tokens** in this pool or **Liquidity Provider** **(LP) tokens** of the corresponding [liquidity pool](/use/pools). LP tokens represent a liquidity provider’s share of a pool.\ For example, if you contribute $10 USD worth of assets to a liquidity pool that has a total worth of $100, you would receive 10% of that pool’s LP tokens. You receive 10% of the LP tokens because you own 10% of the crypto liquidity pool. The LP tokens become your claim to your share of the pool’s assets. Holding these LP tokens gives you total control over when you withdraw your share of the pool without interference from anyone — even the FlatQube platform. In exchange for locking liquidity in the form of LP tokens in a farming pool, farmers receive a [reward](/use/farming/concepts/reward-token), depending on their **share** in the pool. # Boosted farming ## What’s this? Boosted farming is a virtual increase in your balance. In other words, this virtual increase in the balance increases the farming speed. Your virtual balance can be increased through either locked QUBE (veQUBE) or locked LP tokens sent for farming. When you create a pool in the new farm, boosted farming from veQUBE takes place automatically, while the boost from locking LP is configured when you add a pool to the new farm and can range from zero to four years. In order to clearly demonstrate how Boosted Farming works, the FlatQube team has developed the Farming Boost Calculator. [Farming Boost Calculator](https://app.flatqube.io/gauges/calc) is an in-built interface on FlatQube that allows you to assess the potential profit from farming in an understandable way. It takes into account such indicators as the number of LP tokens and their locking time, as well as the number of QUBEs locked in DAO and the time of their locking. Since the amount of the reward, as well as the speed of its distribution in QUBEs is dynamic (changes with every epoch), the calculator will not allow you to estimate your earnings in the long term. That is because there is no guarantee that the previous APY will not change. Nevertheless, it is a very useful and convenient tool that allows you to understand how various aspects of Boosted Farming affect your potential income. It will also permit you to evaluate the possible income in the current Epoch. Below you can find a mathematical explanation of Boosted Farming working principles: ## Increasing your balance through veQUBE: Total deposits (TD) — is just the total amount of the user’s deposits in a specific gauge. We need this new entity when measuring locked deposits. ![](/files/TsAY3D6VM43rALfbFEBv) Where: * **d** — user’s deposit. * **n** — number of deposits. veQUBE — vote escrowed tokens, which can be obtained by locking QUBE.\ The amount of veQUBE remains static for the whole duration of the lock.
Were: * **QUBE lock time** – lock time in days. Ve-boosted deposit (veBD) – part of the virtual balance which is calculated from the user’s veQUBE amount:
Where: * **GB** – gauge balance, sum of user balances in a specific gauge (e.g. EVER/USDT). * **veQUBE** – number of veQUBE that the user has. * **TveQUBE** – total circulating supply of veQUBE. ## Increasing your balance through locking LP LP-locked boosted deposit (BD) – part of the virtual balance which is calculated from the time the deposit is locked. ![](/files/pPrMXleCaqJBtCIswLiI) Where: * **Deposit lock time** – the time that the user has blocked their LP tokens for. * **Max. lock time** – maximum possible LP lock time. * **d** – user deposit. ## Summation of boosts from veQube and LP Ve-boosted deposit multiplier (veBD multiplier) – boost we get for veQUBE\ ![](/files/zCJZl7ldzPtKcksYjCCD) LP-locked boosted deposit multiplier (lBD multiplier) – boost we get for locked LP
Finally, virtual balance — the balance to which the user’s weight in the farming pool will be applied
### **Conclusion** Farming is credited to the user’s virtual balance, so anyone who does not have a locked deposit or locked QUBE will get less rewards than previously. The average farming speed is almost unchanged, but the (virtual) balance to which the reward will be credited will increase; therefore, the real balance that was there before will give less. ## Examples User A $1\ 10 veQUBE;\ \ user B $1,000\ 10,000 veQUBE;\ \ EVER/USDT\ TVL – $10,000;\ veQUBE supply – 100,000
**User A pool weight:** ***before*** 1/10,000 = 0.01% ***after*** 2.5/11,501.5 = 0.02174% **User B pool weight:** ***before*** 1,000/10,000 = 10% ***after*** 2,500/11,501.5 = 21.74% **Other users pool weight:** ***before*** 8,999/10,000 = 89.99% ***after*** 8,999/11,501.5 = 78.24% # Pool share Rewards are paid out in the form of one or more tokens that can then also be deposited in other liquidity pools for users to get further rewards. The total number of locked-in assets is displayed as the TVL (Total Value Locked), and the number of assets locked into a pool by a single provider is displayed as a Pool Share, which is expressed as a percentage of the TVL of a given pool. Accordingly, the larger the Pool Share, the more lucrative farming will be for the user. Liquidity pools in which providers deposit their tokens support the market. Thanks to them, token swaps and other operations are made possible. Liquidity providers earn a commission on all transactions (usually a .3% commission on the total transaction price, but the exact commission depends on the pool). Commissions are added to pools in real-time and distributed to providers proportionally to their Pool Shares. They can be claimed at any time and withdrawn along with the original liquidity provided. In order to stimulate the provision of liquidity on FlatQube, a number of farming programs have been launched. Liquidity providers can deposit their LP tokens in the Farming Pool that corresponds to their liquidity pool and receive additional rewards every second already as a farmer. The remuneration is distributed among all Farming Pool members in proportion to their share. Each Farming Pool on FlatQube has its own \*\*\*\* Farming Speed, which is the number of tokens that get constantly distributed to liquidity providers in proportion to their Pool Shares. Essentially, a Pool Share is the percentage you will receive of this number at any moment in time. Rewards are constantly being calculated, and the \*\*\*\* Farming Speed \*\*\*\* for a pool can change. To calculate the profitability of farming on FlatQube, the APR (annual percentage rate) is used. # DAO # Interface # DAO page Welcome to the [FlatQube DAO homepage](https://app.flatqube.io/dao). Here you can find the main statistics, current and past epochs, as well as a list of farming pools, so-called **candidates**. Also, this is the starting point for navigating to other pages of the Flatqube DAO, such as [**Epochs** ](/use/dao/interface/epoch)or [**Balance**](/use/dao/interface/dao-balance). Let's take a closer look at all the elements here. At the top of the page, general statistics is provided: * **Total QUBEs locked** - displays the number of QUBEs locked in the QUBE DAO contract. * **Total veQUBE** - the total number of veQUBEs. * **Average locktime** - the average time for which QUBE tokens are locked. * **Percentage of total QUBE supply** - the percentage of the total QUBEs issued. You can see the total supply issued here.

Statistics block

Below you can see the **Epochs** block. It displays the following information: * The current **date** and **status** of the epoch, as well as subsequent statuses and the time of their beginning and end. * **Distribution** - the total number of QUBE tokens for distribution. * **Voted of total veQube** - the number of veQUBE tokens that voted. * **Total pools number** - the number of pools participating in the voting. * **Min weight** - the minimum number of votes required to get into the distribution of awards. * **Max weight** - the maximum number of votes for one pool. In the center of the block, you can see a graphical representation of the distribution of votes by currency pool.

Epoch block

Below is the list of **previous Epochs:** * **Epoch number**. Clicking on it will take you to the page of the respective Epoch. * **Distribution** - the number of QUBEs distributed by voting. * **Total votes** - the amount of veQUBEs used as votes in the voting of an Epoch. * **Your vote** - the number of your veQUBEs used as votes in the voting of an Epoch. * **Period** - the period of the beginning and end of an Epoch

Previoust Epochs block

At the bottom of the page you can see the list of **candidates**. The Information about each candidate is displayed here: * **Name** of the farming pool * Current **Status** of the pool * **TVL** - the total number of dollars locked in the pool. * **Average voting rate** - the average percentage of tokens used by participants to vote for a candidate out of the total number of veQUBE used in the voting. * **Last epoch voting rate** - the percentage of veQUBE cast by voting participants to vote for a candidate out of the total number of veQUBE used for voting in the previous epoch. * **Active epochs**

Candidates block

# DAO balance To get to this page, please click on the **Balance management** or **Increase farming speed**.\ You can find it on the right side of the upper part of [DAO homepage](/use/dao/interface/dao-page).

Click on Boost farming speed to go to the DAO Balance page

**DAO balance** block displays the general statistics: * **Your weight, veQUBE** - the power of your vote. * **Your deposited QUBE** - the total number of QUBEs blocked by you. **Your deposits** block displays the information about your deposits: * **Amount, veQUBE** - the total number of veQUBEs received as a result of the QUBE deposit. * **Amount, QUBE** - the number of QUBEs deposited. * **Status** - the current status of the deposit. * **Lock period** - the period for which QUBEs were blocked. * **Ends in** - after this amount of time, your QUBEs will be unlocked. **Transactions history** block displays the list of your transactions related to the QUBE token deposit: * **Type** - transaction type * **Amount, QUBE** - the number of blocked QUBEs * **Amount, veQUBE** - the amount of veQUBE received as a result of the deposit * **Date** - the date of the transaction or the time that has passed since its completion.

DAO balance page

# Epoch To go to this page, click on **See epoch details** on the right side of the [DAO homepage](/use/dao/interface/dao-page).

Click on Epoch details to go to the Epoch page

This page displays statistics of the selected Epoch, information about your vote, and information about candidates: **Total information** displays the statistics of the selected epoch: * The current **date** and **status** of the epoch, as well as subsequent statuses and the time of their beginning and end. * **Distribution** - the total number of QUBE tokens for distribution. * **Voted of total veQUBE** - the number of veQUBE tokens voted. * **Total pools number** - the number of pools participating in the voting. * **Min weight** - the minimum amount of votes required to get into the distribution of awards. * **Max weight** - the maximum amount of votes for one pool. Also in the center of this page you can see a graphical representation of the distribution of votes by currency pool.

Total information block

**Your vote** displays the statistics of your votes: * **Candidate** - the name of the candidate pool. * **Your vote** - the percentage of veQUBEs you gave for a candidate out of the total number of veQUBE used by you in the voting. * **Current vote** - the current number and percentage of veQUBEs cast by the voting participants to vote for a particular candidate out of the total number of veQUBEs used for voting. * **Normal distribution** - the current number of tokens used for distribution as a reward in the pool of the respective candidate. * **Normal farm speed** - the current farming speed in the pool of a candidate.

Your vote block

**Epoch voting state** displays the statistics of candidates participating in the voting of the respective Epoch: * **Candidate** - the name of the candidate pool * **Your vote** - the percentage of veQUBEs you gave for a candidate out of the total number of veQUBE used by you in the voting. * **Current vote** - the current number and percentage of veQUBEs cast by the voting participants to vote for a particular candidate out of the total number of veQUBEs used for voting. * **Normalal distribution** - the current number of tokens used for distribution as a reward in the pool of a candidate. * **Normal farm speed** - the current farming speed in the pool of a candidate.

Epoch voting state block

# How to # Lock tokens In order to participate in the voting, you need to get veQUBE tokens. The only way to do this is to lock your QUBEs for a certain period. To do this, go to the [**DAO Balance** section](/use/dao/interface/dao-balance) from the DAO homepage. On the right side of the page you will see **Deposit QUBE tokens:**
1. Enter the amount of QUBE tokens you want to deposit or press **Max** to select the maximum possible amount. 2. Enter the number of days you want to look your QUBE tokens. The longer the tokens are locked, the more veQUBEs you will receive. The maximum locking period is 4 years 3. At the bottom you will see the number of veQUBE tokens that you will receive as a result of the deposit. If everything is correct, click Deposit tokens. 4. Confirm the transaction in the Ever Wallet window that opens and wait for it to complete. 5. After the transaction is completed, you will see the completed transaction in transactions history and the information about the deposit in the deposits section. 6. The number of your veQUBE tokens will be reflected on your balance\*\*.\*\*
# Vote in Epoch In order to participate in the voting of the current Epoch, first of all, you need to get veQUBEs by [locking QUBEs](/use/dao/how-to/lock-tokens). Once you have received the veQUBEs, you can use them for voting: 1. Go to the main page of the DAO and go down to the **Epoch section**. 2. Click on **Start voting.** 3. Select the candidate pools that you want to vote for. You can add candidates by clicking **Add candidate** on the left side of the section. 4. Enter a percentage of the strength of your vote (a fraction of your portfolio), or the exact amount of veQUBEs that you want to use as a vote. 5. After completing the previous steps, click **Vote** and then **Confirm voting** in the window that opens. 6. Confirm the transaction in the Ever Wallet window that opens. 7. Upon completion of the transaction, you will see the information about your vote in the\ Your vote of the[ corresponding Epoch](/use/dao/interface/epoch).
# Become a candidate In the [old custom farming pools](/use/farming/old-farming), the reward continues to be paid in reward tokens, which the administrator of that pool adds himself. However, since the appearance of gauges (new farming pools) and DAO, you have the opportunity to create a farming pool whose QUBE reward balance will be added with tokens, the distribution of which is the result of voting in the Epoch, in which this candidate was included. More information about this on the [Reward distribution page](/use/farming/concepts/reward-distribution). In addition to QUBE, you can also add any custom token as a reward. The addition of this token to the Reward balance will be handled manually by the pool administrator. Let's move on to the terms and conditions. Adding a candidate costs 1000 QUBE. The QUBE given to create an application will be burned. At the same time you can add a candidate only during the "Awaiting" period of the Epoch. Once a candidate is added (paying 1000 QUBE), he or she will be on the ballot for the next epoch. However, if within four epochs (8 weeks) that candidate does not reach the minimum number of votes (1%), that candidate will be removed from voting in subsequent epochs. However, immediately after that, you will be able to reapply to add that candidate and the whole process will repeat. So, let's look at how to add your own candidate: 1. Go to the DAO section and go down to the Candidates block. 2. Click on Become a candidate at the top right of the block to open the add candidate interface.
3\. Enter the address of the farming pool you want to add as a candidate in the corresponding field and click Become a candidate. Confirm the transaction in the Ever Wallet window that opens. 4\. Congratulations! This candidate will be on the voting in the next epoch.
# Concept # DAO ## What is DAO? The DEX is getting bigger, with more liquidity, users, and responsibilities. The time has come to move further: to make operations even more transparent, increase our technological capabilities, and provide users with the ability to earn even more. We launched the DAO so that the management of earning mechanisms on the platform would be in the hands of our users, liquidity providers, and QUBE holders! ## Main functionality * Voting for token distribution * Voting for changes to the DEX itself, including new token listings Voting takes place using veQUBE tokens. # veQUBE ## What’s this? veQUBE (vote-escrowed QUBE) is a virtual asset that only exists on FlatQube. veQUBE cannot be transferred. The only way to obtain veQUBE is by locking QUBE. The maximum lock time is four years. A user’s veQUBE balance will remain constant until the QUBE is unlocked. ## Everscan To see a transaction on Everscan, all you need to do is go to the [DAO Balance page](/use/dao/interface/dao-balance) and click on any transaction in the deposits or history. ## What’s it for? QUBE has several key utility tasks: 1. Voting in the DAO 2. Boosting rewards in farming To participate in the utility and get the respective benefits, you need to wrap QUBE into veQUBE. ## How is the number of veQube calculated in relation to the amount and period? `veQUBE = QUBE * (lock time/max lock time)` With this kind of token distribution, an investor gets 1:1 from a lock time of four years. You can lock tokens [here](https://app.flatqube.io/dao/balance). ## How much do you get after unlocking? When the lock time ends, the investor gets their QUBE tokens returned to their wallet. Put simply, the investor gets as many tokens back as they invested. Needless to say, gas has to be paid in EVER for the transaction. `QUBE = veQUBE * (max lock time/lock time)` ## **Increasing your balance through veQUBE:** We have used the curve approach\*\*:\*\* Where: * **Td** – total deposits. * **d** – deposit of the user.
* **veBd** – ve-boosted balance. * **Gd** – total gauge deposits (TVL of a specific pool in the gauge). * **veQUBE** – number of veQUBE that the user has. * **TveQUBE** – total circulating supply of veQUBE. You can read about the formula for boosted farming from LP locking, summation of locks, and examples in the [boosted farming section](/use/farming/concepts/boosted-farming). ## How often can you vote? You can only vote once during the voting period. ## Contracts {% hint style="warning" %} As soon as these are public, we’ll post them here. {% endhint %} # Epoch ## What's this? An epoch is a period of time when voting for reward distribution takes place. ## **Stages** At the DAO’s launch, one epoch consists of three stages: 1. Awaiting – 2 days 2. Voting – 11 days 3. Queued – 1 day The stages, their number, and their length may change according to the decision of the DAO. ## Which QUBE tokens get distributed? In the QUBE tokenomics, 70% of tokens are allocated for farming. Initially, the Broxus team managed the farming speed itself. Now, this is done by QUBE token holders. ## What happens to veQUBE after voting ends? After voting ends, when the “Queued” stage finishes, your veQUBE are returned to your virtual balance. # FAQ #### Is the boost given only in the pool l voted for or in all of them? Boost are given regardless of which pool/pools you voted for. The voting itself is needed to distribute the rewards between the pools. #### If I farm in four pools or just one, what percentage of profit will I have from them? In simple terms, this is a dynamic system with many variables. Thus, profitability will change all the time. All possible variations can be calculated using the formulas from [this article](https://broxus.medium.com/flatqube-boosting-mechanism-40a6f48c1082). #### What does my income depend on? In simple terms, profitability is affected by the number of locked QUBEs, the locking period of LP tokens and the percentage of votes for each specific pool. For more detailed information please consult [this article.](https://broxus.medium.com/flatqube-boosting-mechanism-40a6f48c1082) #### How many tokens will I receive if l decide to get out of the DAO? You will receive the same amount of QUBEs that you initially invested. For instance, if you lock 100 QUBEs, regardless of the locking period, be it 2 weeks or 4 years, you will get your 100 QUBEs back. #### Does my boost depend on the total number of locked QUBEs for all pools, or only the number given as a vote for a particular pool? The boost is given regardless of which pool/pools you voted for. Even if you didn't vote, you'll still get a boost. However, if you vote, then the pool with your LP tokens will receive more votes, and, accordingly, more rewards. #### Does voting only affect the farming speed distributions or will it also affect my bonus? Voting affects the amount of reward for a particular pool that will be distributed during the next epoch. #### Will I get any rewards if I just lock QUBEs and don't participate in voting? The rewards are given for participation in farming. veQUBEs do not bring any income without farming. Voting is not taken into account in the rewards formula. #### Will the boost be offered only in the pool l voted for or in all of them? The boost will be in all pool that received from 1 to 35% of the votes. #### How do I vote for the distribution of QUBEs by farming pools? 1. you need to lock the QUBEs [here](https://app.flatqube.io/dao/balance) 2. scroll to the Your vote section [here](https://app.flatqube.io/dao/epochs/1) 3. in the Your vote section, select a pool, specify the number of veQUBEs for voting and click Vote. #### Can I vote again if I later lock some more QUBEs? No. Such a mechanic is not provided. #### The WEVER/BRIDGE pool has rewards in both QUBEs and BRIDGEs. How are the rewards distributed in BRIDGEs? Locked veQUBEs do not increase the reward in BRIDGEs in this pool. On the other hand, the LP tokens locked affect the rewards in both QUBEs as well as other tokens. #### What does the veQube locking period affect? The longer the locking period, the less QUBEs are needed to get the right amount of veQUBEs. --- [Next Page](/llms-full.txt/1)