Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.33 KB

README.md

File metadata and controls

60 lines (38 loc) · 2.33 KB
Raw

DeFi Tools

DeFi Tools is an essential web-based tool designed for liquidity providers and yield farmers in the decentralized finance (DeFi) space. This tool helps users calculate the required amounts of tokens (Token A and Token B) to add to a liquidity pool, simulate positions, and analyze the impact when market prices move outside a chosen range.

Features

  • Liquidity Position Simulation: Calculate the amount of tokens needed to create a liquidity position within a specified price range.
  • Price Range Analysis: Assess how your liquidity will be affected when market prices go outside the predefined range.
  • User-Friendly Interface: Simple and intuitive UI for DeFi users.

Installation

To set up and run DeFi Tools locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/defi-tools.git

  2. Navigate to the project directory:

    cd defi-tools

  3. Open index.html in your browser: Simply double-click the index.html file, or use a local server like Live Server (VS Code extension) to run it.

Usage

  1. Enter the Token Symbols: Input the symbols for Token A and Token B (e.g., ETH, USDC).
  2. Select the Base Token: Choose the base token from the dropdown.
  3. Enter Investment and Prices: Fill in the total investment, current price, minimum price, and maximum price.
  4. Simulate Position: Click on the "Simulate Position" button to calculate the required token amounts and view the impact on your liquidity.

Deployment

This project can be easily deployed using GitHub Pages:

  1. Push your code to a GitHub repository.
  2. Enable GitHub Pages in the repository settings.
  3. Access your deployed project via the GitHub Pages URL provided.

Contributing

Contributions are welcome! If you'd like to contribute to DeFi Tools, please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you like DeFi Tools, consider supporting us by sending ETH on any blockchain to:

0x2170bc5E5eeb2bbF3172AbF2716D8BBB729D2ab6

Acknowledgements

  • Built with ♥ by @camilosaka
  • Inspired by the DeFi community and the need for better liquidity management tools.