Skip to content

undefinedorgcr/lumos-frontend

Repository files navigation

Lumos - Advanced DeFi Tool for Liquidity Management

alt text

Lumos is an advanced tool designed to empower users in the DeFi ecosystem. It provides essential features such as:

  • Impermanent Loss (IL) Calculator: Accurately calculate potential IL for your liquidity positions.
  • Simulations for Full-Range and CLMM Pools: Visualize outcomes for different liquidity strategies.
  • Automated Liquidity Management for CLMM: Optimize your positions with AI-driven insights and automation.

Built on Starknet, Lumos leverages cutting-edge blockchain technology to deliver fast and efficient data processing, empowering users with actionable insights into their liquidity strategies.


Features

  1. Impermanent Loss Calculator: Understand the risks and performance of your liquidity pools with real-time calculations.
  2. Simulations: Experiment with different strategies and pool configurations to maximize your returns.
  3. AI-Powered Liquidity Management: Let Lumos optimize your CLMM pools, reducing manual effort and improving profitability.

Tech Stack

  • Frontend: Next.js (React-based framework)
  • Backend: Node.js (v20.15.1)
  • Blockchain: Starknet and Ekubo Contracts
  • Data Sources: Oracles like Empiric Network for price feeds

Prerequisites

Before setting up Lumos, ensure you have the following:

  • Node.js v20.15.1
  • npm or yarn package manager
  • Git installed
  • Access to a Starknet-compatible wallet (e.g., ArgentX or Braavos)

Setup Guide

Follow these steps to set up and run Lumos locally:

1. Clone the Repository

git clone https://github.com/undefined-org/lumos.git
cd lumos

2. Install Dependencies

Run the following command to install required packages:

Using npm:

npm install

Using yarn:

yarn install

Replace <oracle_contract_address> with the actual address of the Empiric oracle or another compatible data source.

3. Run the Development Server

Start the Next.js development server:

Using npm:

npm run dev

Using yarn:

yarn dev

The app will be available at http://localhost:3000.

4. Build for Production

To create an optimized build for production:

Using npm:

npm run build
npm start

Using yarn:

yarn build
yarn start

Usage

  1. Connect your Starknet wallet.
  2. Navigate to the desired tool (IL Calculator, Simulations, or Automated Management).
  3. Input the necessary data (e.g., token pairs, ranges, etc.) and get insights instantly.

Contribution

We welcome contributions to Lumos! Follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature/new-feature
  3. Commit your changes and push to your fork.
  4. Open a pull request to the main repository.

License

Lumos is licensed under the MIT License.


For further assistance or inquiries, contact us at [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published