https://github.com/jpcodes44/holis
A Solana liquidity management tsx webapp focused on removing, minting, swapping, and adding liquidity on DEFI tokens on the Solana blockchain (AMMs).
https://github.com/jpcodes44/holis
Last synced: 8 months ago
JSON representation
A Solana liquidity management tsx webapp focused on removing, minting, swapping, and adding liquidity on DEFI tokens on the Solana blockchain (AMMs).
- Host: GitHub
- URL: https://github.com/jpcodes44/holis
- Owner: JPCodes44
- License: mpl-2.0
- Created: 2024-09-15T07:27:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T03:16:01.000Z (over 1 year ago)
- Last Synced: 2025-01-31T13:43:14.546Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 408 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 **Holis**: Liquidity Management for Solana DEX
**Holis** is a powerful decentralized liquidity management platform on the Solana blockchain. With Holis, users can seamlessly add and remove liquidity from decentralized exchanges (DEXs) while enjoying a smooth and intuitive user experience. Built on the **TokenSwap** program from Solana's SPL library, Holis makes liquidity management efficient and simple for everyone.
---
## 🎯 **Features**
- **Add Liquidity:** Effortlessly deposit liquidity into decentralized exchanges (DEXs).
- **Remove Liquidity:** Seamlessly withdraw your liquidity from pools.
- **Real-Time Balance Updates:** Get live updates of your wallet balances and pool reserves.
- **Cross-Token Support:** Holis supports multiple token pairs, including **Holis** and **Opsy**.
- **Responsive UI:** Built with **Chakra UI**, Holis offers a visually appealing and intuitive interface.
---
## 💻 **Technologies Used**
- **Solana**: High-performance blockchain for decentralized applications.
- **TokenSwap (SPL)**: Solana's token swap program for liquidity pools.
- **Typescript**: Framework for building Solana liquidity programs.
- **Web3.js (Solana)**: JavaScript SDK for interacting with the Solana blockchain.
- **Chakra UI**: Modern React UI library for building responsive UIs.
- **React.js**: JavaScript library for building frontend interfaces.
---
## 🚀 **Getting Started**
Follow the steps below to set up Holis on your local machine.
### 🔧 **Prerequisites**
Ensure that you have the following tools installed:
- [Node.js](https://nodejs.org/en/) (v14.x or higher)
- [Yarn](https://yarnpkg.com/getting-started/install) (Package manager)
- [Solana CLI](https://docs.solana.com/cli/install-solana-cli-tools)
- A wallet like [Phantom](https://phantom.app/) to interact with Solana
# 🛠️ **Installation**
1. **You must download the source code from the releases section, prototype v1.00**:
https://github.com/JPCodes44/holis/archive/refs/tags/%23liquiditypool.zip
unzip holis-source-code.zip
2. **Navigate into the project directory:**
cd holis
3. **Install the dependencies:**
Use --force if necessary.
yarn install
4. **Or if using npm:**
npm install --force
## 🚀 **Running Locally**
4. **Set up your environment variables:**
Create an .env file in the root directory with the following content:
```bash
REACT_APP_SOLANA_NETWORK=devnet # or mainnet
REACT_APP_PUBLIC_KEY=
4. **Start the local development server:**
```yarn start
Your application will be live at http://localhost:3000.
### 📖 **Usage**
---
### 📥 **Deposit Liquidity**
---
1. Select the token pair you want to add liquidity for (e.g., Holis and Opsy).
2. Enter the amount of liquidity you'd like to deposit.
3. Confirm the transaction, and the liquidity will be added to the pool.
---
### 📤 **Remove Liquidity**
1. Go to the liquidity section of your chosen pool.
2. Enter the amount of liquidity tokens you want to withdraw.
3. Confirm the transaction to remove liquidity.
---
### 📜 **License**
This project is licensed under the MIT License. See the LICENSE file for more details.
---
### 🤝 **Contributing**
We welcome contributions! If you'd like to help improve Holis, follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/amazing-feature`).
3. Commit your changes (`git commit -m 'Add amazing feature'`).
4. Push to the branch (`git push origin feature/amazing-feature`).
5. Open a pull request.
---
### 📞 **Contact**
**Maintainer:** JP Mak
**Email:** [jp.mak44@gmail.com](mailto:jp.mak44@gmail.com)
**GitHub:** [@JPCodes44](https://github.com/JPCodes44)