Skip to content

Orbit is a DeFi smart vault Optimizer that automates and rebalances your LP strategies effortlessly, starting with Uniswap V3.

License

Notifications You must be signed in to change notification settings

FiveElementsLabs/orbit-defi

Repository files navigation

Smart Vault Optimizer

Solidity NodeJS

Discord Twitter Website Docs

Orbit is a DeFi smart vault Optimizer that automates and rebalances your LP strategies effortlessly, starting with Uniswap V3.

We chose Uniswap v3 as the first protocol to automate. Our choice was driven by:

  • The fact that concentrated liquidity is a new paradigm which is increasingly sucking out volumes from older design AMMs
  • The fact that more protocols are providing concentrated liquidity, such as new Sushi Trident
  • The market size and volumes of concentrated liquidity protocols. We are speaking about 1 trillion annualized volume as we write these docs
  • The number of options and strategies allowed by these protocols and possible integrations to offer
  • The fact that there are several vaults out there that provide strategies on top of Uniswap v3. This strategies are very simple (indeed, replicable with Orbit), costly (fees take about 1-2% of TVL) and overall not effective with respect to just holding the asset. We take a strategy agnostic approach, our aim is increasing return for any liquidity provider in Uni v3, independently from the strategy of choice

Installation

git clone https://github.com/FiveElementsLabs/orbit-defi
cd orbit-defi
yarn install

Usage

Create an environment file .env with the following content:

INFURA_MAINNET=https://mainnet.infura.io/v3/your_infura_key
ALCHEMY_MUMBAI=https://polygon-mumbai.g.alchemy.com/v2/your_alchemy_key
ALCHEMY_POLYGON=https://polygon-mainnet.g.alchemy.com/v2/your_alchemy_key
TEST_PRIVATE_KEY=425....214
POLYGON_PRIVATE_KEY=425....214
ETHERSCAN_API_KEY=your_etherscan_api_key

Then you can compile the contracts:

npx hardhat compile

# you can compile specific files by selecting the path
npx hardhat compile ./contracts/PositionManager.sol

npx hardhat node --network localhost

This project uses hardhat, so you can find the compiler configurations in hardhat.config.ts.

Test

npx hardhat test

# you can test specific files by selecting the path
npx hardhat test ./test/actions/Mint.spec.tx

Basic Flowchart

contracts_flow

Security

If you find bugs, please contact us on Discord. Alternatively, you can open an issue here on GitHub or send an email to vincenzo@fiveelementslabs.com.

Documentation

You can read more about Orbit DeFi on our documentation website.

Licensing

The primary license for Orbit DeFi is the GNU General Public License v2.0 (GPLv2). You can read the full LICENSE here.

If you need to get in touch, please send an email to vincenzo@fiveelementslabs.com or Join our Discord server.

About

Orbit is a DeFi smart vault Optimizer that automates and rebalances your LP strategies effortlessly, starting with Uniswap V3.

Topics

Resources

License

Stars

Watchers

Forks