# Welcome to Ellipsis Finance
The most flexible and capital-efficient DEX on BNB Chain
Ellipsis is a decentralized exchange, and an authorized fork of [Curve Finance](https://curve.fi) on BNB chain that generally solves 3 problems:
1. It offers efficient, well priced swaps.
2. It offers yield to token holders in a safe, well tested environment.
3. It offers a solution for protocols to build deep liquidity for their tokens.
**Who should use Ellipsis?**
1. People who need to swap tokens.
2. People with tokens looking for yield.
3. Protocols looking for liquidity for their pools.
## More about Ellipsis
Ellipsis is an Automated Market Maker (AMM) or exchange that lets users and other decentralised protocols exchange tokens (BUSD to USDC, for example) with low fees and low slippage.
Unlike exchanges that match a buyer and a seller, Ellipsis uses liquidity pools. To achieve successful exchange volume and low slippage, Ellipsis needs a high amount of liquidity (tokens) in the pools. To incentivize liquidity to deposit in Ellipsis pools, Ellipsis offers rewards in EPX tokens to liquidity providers.
### What are liquidity pools?
Liquidity pools are pools of tokens that sit in smart contracts and can be exchanged or withdrawn at rates set by the parameters of the smart contract. Adding liquidity to a liquidity pool gives you the opportunity to earn trading fees and possibly rewards.
### What are liquidity providers and LP tokens?
Liquidity providers (LPs) refers to the people who provide liquidity in Ellipsis' pools. For example, if you deposit USDC + BUSD into the 3EPS pool, you are a liquidity provider in the 3EPS pool.
When you deposit, in return you receive LP tokens representing your deposit in the pool.
### What does it mean to *stake LP tokens*?
Staking LP tokens refers to staking your LP tokens in Ellipsis to receive the EPX rewards from a pool.
### What is the EPX token?
Ellipsis (EPX) is the native token for Ellipsis. It has four main uses:
1. As a reward for Liquidity Providers.
2. For voting on pool incentives.
3. Locking for platform fees.
4. Locking to boost Liquidity Provider rewards.
### Trading Fees
Ellipsis trading fees are 0.04% for stable or like-kind pools, and range from 0.04% to 0.4% for crypto pools like BUSD <> BNB.
50% of the trading fees are distributed to liquidity providers in the pools where the trades happen. The other 50% is distributed to EPX lockers.
### What is a Week or Epoch on Ellipsis
A week on Ellipsis refers to the 7-day period between Thursdays, 00:00:00 UTC and Wednesdays, 23:59:59 UTC.
Locks expire at the end of the weeks, and voting periods run from the start to the end of a week.
# Understanding Crypto Pools
Crypto pools are Ellipsis pools holding assets with different prices. Ellipsis' core originally was pegged assets but a new type of AMM allows for extremely efficient trading and low risks of non-pegged assets. \
\
Crypto pools use liquidity more effectively by concentrating it at current prices. As trades happen, the pool readjusts its internal price to the highest liquidity region without creating losses for the pool. Crypto pools also have variable fees which can range between 0.04% and 0.45%.\
\
Our first pool using this new design has the following coins: BUSD/BNB on the BNB chain.
## Whitepaper
Read the [Curve whitepaper](https://curve.fi/files/crypto-pools-paper.pdf) on which Ellipsis crypto pools is based off.
## Liquidity Providers
Becoming a liquidity provider in an Ellipsis Crypto pool is in all ways similar to stable pools. Unlike stable pools, however, you will gain exposure and risks to all assets in the pools, also known as [impermanent loss](https://academy.binance.com/en/articles/impermanent-loss-explained). \
\
To provide liquidity to the pool you can choose to add a single asset to the pool or add multiple depending on the pool. \
\
For example: LPs can add either BUSD, BNB or both to the BUSD-BNB pool.
## Fees
Fees on those pools range from 0.04% to 0.4%. The current fee varies based on how close the price is to the internal oracle. You can check a pool's current fee which changes every trade at the bottom of a pool page.
## Risks
As with any liquidity providing in blockchain, there are some smart contract risks involved. Curves' crypto pools have been audited by MixBytes and ChainSecurity but audits never eliminate risks completely.
\
# Understanding $EPX
Ellipsis (EPX) is the native token for Ellipsis.
The main purposes of the EPX token are to incentivise liquidity providers on Ellipsis.finance and to allow users to participate in the incentive distribution.
Currently EPX has three main uses: voting, locking and boosting. Those three things will require you to vote lock your EPX and acquire vlEPX.
{% hint style="info" %}
vlEPX stands for vote-locked EPX, it is simply EPX locked for a period of time. The longer you lock EPX for, the more vlEPX you receive. vlEPX is non-transferrable.
{% endhint %}
EPX can be locked for up to one year, allowing users to:
* vote on EPX pool incentives for liquidity providers,
* receive boosted yields as an LP,
* receive platform fees,
* vote on eligibility of pools to receive incentives.
## Locking and Trading Fees
EPX can be locked to receive trading fees from the Ellipsis protocol.
These fees will be paid out in the tokens as they are collected; so fees in renBTC will be available as renBTC, BUSD will be available as BUSD etc.
Fees are collected over one week, and then paid out the following week. For example, fees collected from day 1 to day 7 (Week 1) will be paid out between day 7 and day 14 (Week 2).
vlEPX weights used for distributing the fees are from the corresponding week. So the vlEPX weights at the end of week 1 will determine how the fees from week 1 are credited.
**For example:**
Alice has 50% of the vlEPX at the end of week 1, Bob has 30% and Charlie has 20%. When the fees for week 1 are streamed out in week 2, Alice will receive 50% of the fees, Bob 30% and Charlie 20%.
{% content-ref url="/pages/Sr7RMcry2EDNETbQypWA" %}
[Locking](/the-epx-token/locking)
{% endcontent-ref %}
## Boosting
One of the main incentives for EPX is the ability to boost your rewards on provided liquidity. Vote locking EPX allows you to acquire voting power and earn a boost of up to 2.5x on the liquidity you are providing on Ellipsis.
## Voting
EPX holders with locked EPX (vlEPX), can participate in some limited governance on Ellipsis, namely pool incentive votes and vote to enable incentives on pools.
{% content-ref url="/pages/KxlAUIUo6biX8oQVoEQn" %}
[Incentive Voting](/the-epx-token/incentive-voting)
{% endcontent-ref %}
# $EPX Tokenomics
Ellipsis (EPX) is the native token for Ellipsis.
The main purposes of the EPX token are to incentivise liquidity providers on Ellipsis.finance and to allow users to participate in the incentive distribution.
## Supply
The total supply of EPX is 132B tokens. The entire supply will be used to incentivise liquidity providers on Ellipsis.finance.
During the first 4 week period, `616,000,000` EPX were provided as rewards to be distributed equally over those 4 weeks. Subsequent 4 week blocks will decay this value by 1% and spread the rewards evenly over 4 weeks. As such, the emissions tail off indefinitely until reaching the limit of 132B tokens.
{% hint style="info" %}
A week in Ellipsis begins on Thursdays at 00:00:00 UTC, and ends on Wednesday at 23:59:59 UTC.
{% endhint %}
## EPX distribution
Each week EPX lockers will be able to vote on which approved pool they would like to direct EPX rewards to. When voting closes, 1/4 of that month’s EPX rewards is split according to the vote and supplied to the pools.
Votes are reset to zero each week and the voting cycle starts again.
# Locking
EPX holders can lock their EPX to receive vlEPX. The longer you lock EPX, the more vlEPX you'll receive. vlEPX allows users on Ellipsis 2.0 to:
* Vote on incentive distribution between pools;
* Receive platform fees;
* Boosting EPX rewards;
* And nominate new pools for a vote towards receiving EPX rewards.
Some things to note:
* Users can have multiple locks per account.
* Lockers *do not* have to vote. Lockers can claim platform fees even if they do not vote.
* Ellipsis 2.0 works in a week long epoch, starting at 00:00 Thursday, UTC, every week. This means that every week your lock declines by one week and voting starts anew.
* Locker rewards are paid out from the previous week's fees. Every Thursday a new balance of fees streams out to users who were locked during that previous week.
### Locking EPX
Locks can last from 1 to 52 weeks; longer locks mean more vote weight and a higher share of fees.
Important things to know about locks:
1. Locks that are less than 52 weeks can be extended to the 52-week maximum.
2. Expired EPX locks must be claimed before you can withdraw your EPX. Released EPX is then streamed out over a period of 7 days. During those 7 days released EPX can be claimed at any time.
# Incentive Voting
Incentive Voting is where users vote to determine the distribution of the weekly EPX incentives across the different pools.
Users with locked EPX, or vlEPX, can participate in these votes which begin on Thursdays at 00:00:00 UTC and end the following Wednesday at 23:59:59 UTC.
When voting closes, 1/4 of that month’s EPX rewards is split according to the vote and supplied to the pools.
Votes are reset to zero each week and the voting cycle starts again.
In the image above, the dai3EPS pool has 41.24% of the votes and would receive 41.24% of the EPX emissions as a reward for providing liquidity to that pool.
## How to vote
Users with vlEPX vote on by clicking vote on the vote table for the pool they wish to support, filling in the amount they wish to vote and then clicking the "Submit Vote" button:
Accept the transaction and your vote will be submitted.
# Pool Votes
Holders of vlEPX can participate in *Incentive Voting,* where users vote to determine the distribution of the weekly EPX incentives across the different pools.
They can also participate in Pool Votes.
### What are Pool votes?
If you are familiar with Curve, Pool votes are like Gauge votes.
When a pool is created on Ellipsis it is not eligible to receive EPX emissions, it first has to be nominated for a vote. Users can then vote on allowing the pool to become eligible for the Incentive votes.
### How to participate in Pool votes
Pool votes are special for two reasons:
1. The amount of vlEPX for pool votes corresponds to a user's vlEPX from the previous week.
2. vlEPX used in a pool vote applies to only that vote; it does not affect a user's vlEPX balance for incentive voting, and
# Migrating EPS to EPX
Migrate EPS to the EPX, the Ellipsis 2.0 protocol token.
The EPS token will be migrating to a new token, EPX. Migration to this new Ellipsis token has no deadline.
The EPX token will have some changes from EPS:
* Relative total supply will increase 1.5x (from 1B to 1.5B).
* Absolute total supply will increase 88x, to 132B tokens (88x the new relative total supply, or 1.5B \* 88).
Users will receive 88 EPX tokens for each EPS token they migrate. Tokens can be migrated in the [migration portal](https://ellipsis.finance/migration).
{% hint style="info" %}
There is no hurry to migrate EPS to EPX. \
The migration contract will never close.\
It is a one way migration.
{% endhint %}
### Migration
1. Enter the balance of `EPS` you wish to swap to `EPX` in the migration tool on the website.
2. Approve the migration contract to use your `EPS`. This only needs to be done once per wallet.
3. Click "Migrate your `EPS` to `EPX`" and accept the transaction.
Now your `EPX` will be in your wallet.
# Understanding Ellipsis Pools
Ellipsis Finance is an Automated Market Maker (AMM) or exchange that lets users and other decentralized protocols exchange tokens (BUSD to USDC, for example) with low fees and low slippage. Unlike exchanges that match a buyer and a seller, Ellipsis uses liquidity pools. Let's review some terminology before going into more details.
## Terminology
**Liquidity pool:** a smart contract that holds tokens deposited by liquidity providers. When a swap is made on Ellipsis, it will use these tokens to fulfill the swap.
**Liquidity provider (LP):** any user that provides liquidity (tokens) in a liquidity pool.
**LP Tokens:** tokens that an LP receives for depositing liquidity (tokens) into a liquidity pool. These tokens represent your share of the liquidity pool.
**Liquidity Incentives:** Ellipsis offers EPX rewards on most pools, and some pools have extra rewards available. These rewards are given to incentivize people to deposit their tokens to Ellipsis. On Ellipsis, liquidity providers must stake their LP tokens in order to receive these rewards.
{% hint style="info" %}
A liquidity provider deposits their tokens into a liquidity pool and in return they receive LP tokens. Then these LP tokens can be staked to receive LP incentives.
When they want to leave the pool, liquidity providers must unstake their LP tokens, and then exchange the LP tokens for the tokens in the pool.
For example an LP can deposit BUSD + USDC into the 3EPS pool and will receive 3EPS LP tokens in return. When they want to leave the pool, they return the 3EPS LP tokens in exchange for BUSD + USDC.
{% endhint %}
## Using Ellipsis Pools
### Choosing a pool
Ellipsis has pools for a wide variety of tokens. When you provide liquidity to a pool, no matter what coin you deposit, you gain exposure to all the coins in the pool which means you want to find a pool with coins you are comfortable holding.
### Does the coin you deposit matter?
Apart from the deposit bonus explained below, it doesn’t matter. Your tokens will get split into the pool and it doesn’t affect your returns; so you can deposit one, some or all the coins into the pool without worrying about it affecting your returns.
### Understanding deposit bonuses
On the screenshot above, you can see that USDC and BUSD are lower in the pool; so if your plan was to join the this pool, you would ideally deposit USDC or BUSD into it. As you can see on the screenshot below, you would get an instant 0.0571% bonus for depositing BUSD into the pool.
The main reason for this is that BUSD-T are is slightly less expensive than the other tokens when the image was taken. The deposit bonus reflects that.
The pools are always trying to balance themselves and go back to equal parts, so depositing the coin(s) with the lowest share will get you a deposit bonus.
# Base, Meta and Factory Pools
Ellipsis has three types of pools:
1. Base pools: `3EPS` (`BUSD-USDC-USDT`), `btcEPS` (`BTCB/renBTC`)
2. Meta pools: for example `[fUSDT, [3EPS]]`, `[DAI, [3EPS]]` or `[TUSD, [3EPS]]`
3. Factory pools: permissionless pools that can be created by anyone. These pools can be meta pools or plain pools, and can contain stablecoins, pegged `BTC` or `BNB` and can contain anywhere from two to four tokens.
{% hint style="info" %}
Factory pools, being permissionless, can be created by anyone or any team. Please be sure to understand the assets in a factory pool if you are going to provide liquidity or trade in the pool.
{% endhint %}
Meta pools allow for one token to trade with another underlying Base pool. In this example users could seamlessly trade `fUSDT` between the three coins in the `3EPS` pool (`BUSD-USDC-USDT`). This is helpful in multiple ways, including:
* preventing dilution of existing pools,
* allowing Elipsis to list less liquid assets,
* providing more volume and more trading fees for liquidity providers.
A Meta pool consisting of `[fUSDT, [3EPS]]` would contain `fUSDT` and `3EPS` LP tokens. This means that liquidity providers of the 3EPS pool who do not provide liquidity in the `[fUSDT, [3EPS]]` Meta pool are shielded from systemic risks from the Meta pool.
# Depositing into a Base Pool
Ellipsis has two base pools, the `3EPS` pool consisting of `BUSD`, `USDC` and `BUST-T` (USDT), and the `btcEPS` pool, consisting of `renBTC` and `wBTC`.
## Depositing into a base pool
Stake any combination of the three coins in the Ellipsis 3pool: BUSD, USDC or USDT. Enter the number of coins you wish to deposit and click "Add Liquidity". You may have to approve Ellipsis to use your tokens before you can add liquidity.
After depositing in the pool, you receive liquidity provider (LP) tokens. They represent your share of ownership in the pool and these can be staked for EPS.
{% hint style="info" %}
Depositing the coin with the smallest share will result in a small bonus.
{% endhint %}
{% hint style="info" %}
Once you deposit one stable coin, it gets split over the three different coins in the pool which means you now have exposure to all of them.
{% endhint %}
{% content-ref url="/pages/-MX\_JLk2g8vJ4IX0V7aI" %}
[Broken mention](broken://pages/-MX_JLk2g8vJ4IX0V7aI)
{% endcontent-ref %}
# Depositing into a Metapool
Metapools allow a single coin to be pooled with the coins from a Base pool without diluting its liquidity. Currently, the most common Base pool is the [3EPS pool](https://ellipsis.finance/3pool). It uses the three most liquid stable coins (`BUSD`-`USDC`-`USDT`) on the Binance Smart Chain (BSC).
{% hint style="info" %}
[Learn more about our pools](/liquidity-providers/base-and-metapools)
{% endhint %}
## Depositing to a Metapool
Metapools offer several options for deposits. For example, in the \[DAI, \[3EPS]] Metapool you can deposit the following:
* DAI
* any of the 3Pool coins (BUSD-USDC-USDT)
To provide liquidity you can deposit one or several of the coins in the pool. Depositing the coin with the smallest share in the pool will result in a small deposit bonus. The distribution of the coins you deposit has no effect on the amount of fees you will receive.
Enter the number of coins you wish to deposit and click "Add Liquidity". You may have to approve Ellipsis to use your tokens before you can add liquidity.
{% hint style="warning" %}
Always make sure to check the slippage warnings.
{% endhint %}
When you deposit one stable coin, **it gets split over the four different coins in the pool which means you now have exposure to all of them**.
# Staking for EPX rewards
Many pools offer EPX incentives as rewards for providing liquidity. Pools with these rewards will have a *Stake LP* tab along with the other actions for a pool:
In order to receive the EPX rewards, LP token holders must approve the contract to use them, and then deposit the tokens. EPX rewards will begin to accrue once the LP tokens are deposited.
To withdraw the LP tokens, simply fill out the balance to withdraw and click the *Withdraw* button.
# Why Would a Project Use Ellipsis?
There are some obvious use cases for projects and protocols to use Ellipsis, such as the examples provided in cases 1 and 2 below. Then there are some less obvious and creative possibilities for protocols to use Ellipsis as provided in case 3 below.
Ellipsis is a Curve fork; the so called "Curve wars" have shown us that there are many creative ways to use Curve, and projects built on top of Curve, to bolster a project's treasury or simply provide more returns to a project's holdings.
### Use Cases
1. Stablecoin projects would benefit from using Ellipsis' pools as they use the StableSwap protocol for swapping, which is a more efficient swap protocol for pegged tokens. Meaning that the underlying tokens in a pool are more likely to keep their peg by using Ellipsis over DEXes like PancakeSwap.
2. A project that has a synthetic token, for example ANKR's aBNBb, are better off using Ellipsis pools for the same reason outlined in #1: Ellipsis pools make it easier to stay on peg over DEXes like PancakeSwap.
3. A protocol with Protocol Owned Liquidity or a treasury with stablecoins could use Ellipsis pools to grow their treasury by depositing into Ellipsis and using one of many strategies that involve Ellipsis' EPX token to grow their EPX token holdings, fee rewards, or bribe+fee+third party tokens on other platforms like dotdot.finance.
If you have a project that fits any of those use cases, feel free to get in touch with us via our [Telegram channel](https://t.me/ellipsisfinance).
# List your token on Ellipsis
Ellipsis allows anyone to permissionlessly add their token in a few clicks. The user must add the liquidity required for the trading pair they are adding. For example, to add your token paired with BUSD, you will need to provide the initial liquidity to launch the pair.
Instructions can be found in the Pool Factory documentation:
{% content-ref url="/pages/wrPxXIfojqmYZT69SXnk" %}
[List a Token with the Pool Factory](/dev/list-a-token-with-the-pool-factory)
{% endcontent-ref %}
### EPX Incentives
Newly created pools are not eligible for EPX incentives. The pool must first pass a vote to be enabled for EPX incentives. Once the vote is passed, then the pool will participate in the weekly voting process and will receive incentives based on its proportion of the overall vote.
# What is APR and vAPR?
These terms are mentioned all over in decentralized finance: APR, APY, vAPR etc.
**What do they mean?**
In decentralized finance, the term APR means "Annual Percentage Rate" and refers to the interest earned on a deposit made for one year.
### How to calculate your returns using the APR value
Let's look at an example: Alice has $1000 deposited in the val3EPS pool and the APR of the pool is 50%, how much money would she have after 1 year?
$$
$1000 \* 0.50 = $500
$$
Alice makes a return of $500 for liquidity providing over one year. How much would Alice make per day?
$$
$1000 \* 0.50 / 365 = $1.37
$$
{% hint style="info" %}
These calculations can vary between days or even hours for various reasons discussed below in the next section.
{% endhint %}
### What is vAPR
vAPR refers to *Variable Annual Percentage Rate. I*t is the interest you would earn on your deposits over a year. It is called *variable* because it changes often, as it depends on the trading activity over the last 24 hours in the pool, the price of the assets you deposit, the price of the assets you are rewarded with, and the current rewards rates.
## Risks of liquidity providing
While some of the APRs on Ellipsis and other DEXes can look very enticing, it is important to know the risks of LPing. Smart contract risks aside, a deposit in a pool exposes the liquidity provider to all of the underlying tokens.
Read more about liquidity providing:
{% content-ref url="/pages/cdBEX0eaFG0lAJyMGIQs" %}
[Understanding Ellipsis Pools](/liquidity-providers/understanding-ellipsis-pools)
{% endcontent-ref %}
# Using the Multichain Permissionless Bridge
[fUSDT](https://frapped.io/) is the only official cross-chain USDT wrapper. Use [multichain.xyz](https://multichain.xyz/) to bridge USDT into fUSDT on a number of chains like Ethereum, Fantom or Binance Smart Chain (BSC) without using the Binance bridge.
Ellipsis Finance offers an fUSDT Metapool. This pool is incentivized with ICE and EPS, the native token of the Popsicle protocol:
## Bridging USDT into fUSDT on BSC
Make permissionless transfers of USDT from Ethereum to BSC on . Multichain transfers your USDT onto BSC for fUSDT:
# Deployment Links
| | |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------- |
| Ellipsis X token (EPX) | [0xaf41054c1487b0e5e2b9250c0332ecbce6ce9d71](https://bscscan.com/address/0xaf41054c1487b0e5e2b9250c0332ecbce6ce9d71) |
| IncentiveVoting | [0x4695e50A38E33Ea09D1F623ba8A8dB24219bb06a](https://bscscan.com/address/0x4695e50A38E33Ea09D1F623ba8A8dB24219bb06a) |
| TokenLocker | [0x22A93F53A0A3E6847D05Dd504283e8E296a49aAE](https://bscscan.com/address/0x22a93f53a0a3e6847d05dd504283e8e296a49aae) |
| EllipsisLpStaking | [0x5B74C99AA2356B4eAa7B85dC486843eDff8Dfdbe](https://bscscan.com/address/0x5B74C99AA2356B4eAa7B85dC486843eDff8Dfdbe) |
| FeeDistributor | [0x3670c10C6a4994EC8926eDCf54bF53092217EE1b](https://bscscan.com/address/0x3670c10C6a4994EC8926eDCf54bF53092217EE1b) |
# Code Audits
The Ellipsis codebase is based on code from Curve Finance; [their audits can be found here](https://curve.fi/audits).
Peckshield has completed an audit of the Ellipsis 2.0 contracts; this was delivered on March 28th, 2022. No critical issues were found; all flagged issues have been resolved. The audit report is public and has been published [here](https://github.com/ellipsis-finance/ellipsis-audits/blob/master/PeckShield-Audit-Report-EllipsisV2Staking-v1.0.pdf).
We thank the [Peckshield team](https://peckshield.com/) for auditing Ellipsis.
# Admin Multisig
All Ellipsis contracts are controlled by a 3-of-5 Gnosis Safe multisig. The multisig has been deployed at:
* [`0x93E004080Fe6D967Eb01Bd294C8da12F970FeAb5`](https://gnosis-safe.binance.org/#/safes/0x93E004080Fe6D967Eb01Bd294C8da12F970FeAb5/balances)
Multisig membership includes two Ellipsis founders, two members of Curve Finance and one of Yearn. Requiring three signers ensures no single entity can perform a malicious action or otherwise abuse the admin powers within the protocol.
{% hint style="info" %}
Day to day protocol operations are handled exclusively by the Ellipsis team. The membership of Curve and Yearn team members on the multisig does not imply that they are active participants within Ellipsis.
{% endhint %}
### Multisig members
| Name | Team | Address |
| -------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------- |
| Alex | Ellipsis Finance | [0xABc00210a691cE0F3D7D0602d7d84aEa4D91cdfd](https://bscscan.com/address/0xabc00210a691ce0f3d7d0602d7d84aea4d91cdfd) |
| James | Ellipsis Finance | [0xBBCF44D219d57FD81771Ec5053FAEa5fC8642193](https://bscscan.com/address/0xbbcf44d219d57fd81771ec5053faea5fc8642193) |
| Michael Egorov | Curve Finance | [0x425d16B0e08a28A3Ff9e4404AE99D78C0a076C5A](https://bscscan.com/address/0x425d16B0e08a28A3Ff9e4404AE99D78C0a076C5A) |
| Ben Hauser | Curve Finance | [0x7EeAC6CDdbd1D0B8aF061742D41877D7F707289a](https://bscscan.com/address/0x7EeAC6CDdbd1D0B8aF061742D41877D7F707289a) |
| Banteg | Yearn | [0x7A1057E6e9093DA9C1D4C1D049609B6889fC4c67](https://bscscan.com/address/0x7A1057E6e9093DA9C1D4C1D049609B6889fC4c67) |
# Ellipsis Registry
Ellipsis pool registry. Based on the [Curve registry](https://github.com/curvefi/curve-pool-registry).
### Deployment Addresses
Contracts are deployed to the BSC mainnet at the following addresses:
* `AddressProvider`: [`0x31D236483A15F9B9dD60b36D4013D75e9dbF852b`](https://bscscan.com/address/0x31D236483A15F9B9dD60b36D4013D75e9dbF852b#code)
* `Registry`: [`0x266Bb386252347b03C7B6eB37F950f476D7c3E63`](https://bscscan.com/address/0x266Bb386252347b03C7B6eB37F950f476D7c3E63#code)
* `Exchanger`: [`0xdd9227B12596e6F91f31ECD2502856A5df5F6E25`](https://bscscan.com/address/0xdd9227B12596e6F91f31ECD2502856A5df5F6E25#code)
The `AddressProvider` deployment will never change. Integrators should always query the other contract addresses from the address provider.
# List a Token with the Pool Factory
Ellipsis allows anyone to permissionlessly add their token in a few clicks. The user must add the liquidity required for the trading pair they are adding. For example, to add your token paired with BUSD, you will need to provide the initial liquidity to launch the pair.
### Stable versus Crypto pools
Ellipsis offers two types of pools or listings. Listings between tokens that should have the same price between them (a.k.a stable pools), such as BUSD <> USDC <> USDT, and listings for tokens with different prices (a.k.a crypto pools), such as BUSD <> BNB.
Details to note:
* After deploying a pool, initial liquidity **must** be seeded. $50,000 is a recommended balance for initial liquidity, however if you expect a larger volume of swaps the pool will perform better with more.
* 50% of fees regardless of chosen fee will go to the EPX lockers.
* Destroying pools once deployed is not possible.
* Ellipsis is not responsible for any of the assets in the pools, so you must do your own research when trading in the pool factory. This is a permissionless factory, therefore the Ellipsis team has no control over the tokens added in the factory which means you must verify the token addresses traded in a pool.
* Tokens with more than 18 decimals are not supported.
# Deploying a Stable Pool
Ellipsis offers two types of pools or listings. Listings between tokens that should have the same price between them (a.k.a stable pools), such as BUSD <> USDC <> USDT, and listings for tokens with different prices (a.k.a crypto pools), such as BUSD <> BNB. \
\
Deploy a stable pool on Ellipsis by filling out the [factory form on the website](https://ellipsis.finance/thefactory). Upon submission of the form you will be prompted to complete the transaction. When the transaction is complete, the new pool will be available for seeding the initial liquidity. Once liquidity has been seeded, the pool will appear in the [pools area of the website](https://ellipsis.finance/pool). \
\
Below are instructions for filling out the form. For assistance with the parameters in the form, please get in touch via our [Telegram channel](https://t.me/ellipsisfinance).
Pool assets such as going logos for coins that are new to Ellipsis can be submitted as outlined in [Pool Assets](broken://pages/uNgTG25RccdqS2YEBfNu).
### Pool Name and Symbol
The name of the pool is what you will see on the [pool listing page](http://ellipsis.finance/pool):
The symbol will be the symbol for your LP token. Typically, metapools use a `{token}3EPS` naming pattern for pools that use the `3EPS` base pool, and `{token}btcEPS` for pools that use the `btcEPS` base pool.
### Pool Type
Pool type options include `USD` or `BTC` metapools where a token is paired with an Ellipsis base pool, `BNB` native pools for pairing with `BNB` pegged tokens, and plain pools that can accommodate between two to four pegged tokens.
### Pool Tokens
### Pool Implementation
### Fees and Amplification Parameter
#### Choosing an Amplification Parameter
The amplification co-efficient (“A”) determines a pool’s tolerance for imbalance between the assets within it. A higher value means that trades will incur slippage sooner as the assets within the pool become imbalanced.
The appropriate value for A is dependent upon the type of coin being used within the pool. We recommend the following values:
* Uncollateralized algorithmic stablecoins: 10
* Non-redeemable, collateralized assets: 100
* Redeemable assets: 200
#### Trade fees
EPS pools charge a fee for token exchanges and when adding or removing liquidity in an imbalanced manner. 50% of the fees are given to liquidity providers, 50% are distributed to EPS lockers.
For factory pools, the size of the fee is set at deployment. The minimum fee is 0.04% (represented as `4000000`). The maximum fee is 1% (`100000000`). The fee cannot be changed after a pool has been deployed.
# Seeding a Stable Pool
Once your pool is created, you will need to seed the initial liquidity before the pool can be used. Ellipsis recommends about $500,000 of liquidity for stablecoin pools.
After your pool form has been submitted and the transaction completed, [visit the seed page](https://ellipsis.finance/seed) and choose your pool from the available pools to be seeded. If your pool does not appear, please refresh the page after a few minutes to give our API time to pick up the new pool. The seeding UI (see image below) will handle the required token and contract approvals before allowing you to send in the liquidity.
The pool should be seeded with equivalent amounts of each asset:
Once your pool is seeded it will become available on the Ellipsis [main pool interface](https://ellipsis.finance/pool) and can be used for swapping, adding and removing liquidity.
# Deploying a Crypto Pool
tba.
# Seeding a Crypto Pool
...
# Pool Incentives and Rewards
Ellipsis pools can disperse EPX rewards and non-EPX rewards to LP providers.
### Non-EPX rewards
Teams who wish to provide their own incentives for liquidity providing should get in touch with Ellipsis via our [Telegram channel](https://t.me/ellipsisfinance).
The process requires the approval of a reward providing address and a reward token address. Once approved, the reward supplying address can supply reward tokens to the LP contract. The reward duration is seven days, and teams can top up the rewards at any time. Be aware that rewards provided before the seven days are over will reset the seven day timer and distribute any remaining rewards along with any new rewards over the new seven day period.
### EPX Incentives
Newly created pools are not eligible for EPX incentives. The pool must first pass a vote to be enabled for EPX incentives. Once the vote is passed, then the pool will participate in the weekly voting process and will receive incentives based on its proportion of the overall vote.
# Pool Assets
Please visit this Github repository and follow the directions there to submit your token assets for the Factory pools: