https://github.com/0xtekgrinder/autoswap
ALM project on top of gnoswap
https://github.com/0xtekgrinder/autoswap
alm gno gnoswap go tick
Last synced: about 1 month ago
JSON representation
ALM project on top of gnoswap
- Host: GitHub
- URL: https://github.com/0xtekgrinder/autoswap
- Owner: 0xtekgrinder
- License: mit
- Created: 2024-10-02T12:50:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-27T11:16:44.000Z (over 1 year ago)
- Last Synced: 2025-06-03T11:16:50.003Z (about 1 year ago)
- Topics: alm, gno, gnoswap, go, tick
- Language: TypeScript
- Homepage:
- Size: 5.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AutoSwap
## Description
AutoSwap is a DeFi protocol built on top of [gnoswap](https://github.com/gnoswap-labs/gnoswap) that allows users to enter in a gnoswap's pool and automatically reposition their fund to stay in the active tick range of the pool.
This is called Automated Liquidity Management (ALM).
## How it works
1. Admin deploy a new vault with the desired pool by specifying token0, token1 and fee.
2. User deposit token0 and token1 into the vault.
3. Keeper will monitor the vault and reposition the fund to stay in the active tick range of the pool.
4. User can claim the fees accrued by his position inside the vault at any time.
5. User can withdraw their fund at any time.
## Get Started
### Realms
To tests the realms, you first need to clone the gnoswap repository and add it to the gno root directory in the `examples` folder with the corresponding path between /p and /r.
You also need to do the same for foo and bar located at `realms/mock/foo` and `realms/mock/bar`
Then you can run the following commands:
```bash
gno test ./realms
```
### Frontend
To run the frontend, you first need `pnpm` installed. You can install it by running the following command:
```bash
npm install -g pnpm
```
And then you can run the following commands to install the dependencies:
```bash
cd frontend
pnpm install
```
Finaly, you can run the frontend by running the following command:
```bash
pnpm build
pnpm start
```
Or when you are developing, you can run the following command:
```bash
pnpm dev
```