Skip to content

Latest commit

 

History

History
107 lines (62 loc) · 4.16 KB

README.md

File metadata and controls

107 lines (62 loc) · 4.16 KB
Raw

bleu's Monorepo

This repo serves as a hub for open-source projects, applications, and packages aimed at empowering DeFi users with enhanced functionalities, analytics, and ease of use. This repository encompasses tools and utilities to augment experiences across different protocols, including Balancer, CoW, and other integrated platforms.

Avaliable tools

Pool Metadata 🔗

Enhance Balancer pools with metadata like pool name, symbol, description, and more, improving discoverability and user comprehension. The Balancer Pool Metadata tool provides a user-friendly interface for pool owners and a public Subgraph for developers to access this metadata.

Internal Vault Balances Manager 🔗

Empower users with a streamlined application to manage their internal balances. Deposit, withdraw, and transfer assets effortlessly, ensuring full control over digital assets.

Pool Simulator (former Stable Swap Simulator) 🔗

A comprehensive tool for analyzing pool behaviors where you can compare different pool types. Set and modify pool parameters to evaluate key metrics like Swap, Price Impact, and Depth Cost. Simulate swaps and compare results with established data for Stable, Gyro and FX pools.

APR 🔗

👷👷👷 Under development 👷👷👷

A visual guide to Balancer pools' historical APR.

MilkmApp

👷👷👷 Under development 👷👷👷

A Safe App to interact to create milkman orders on CoW Protocol.

Repository Structure

The project uses a monorepo structure. See the repo's wiki to find more detail about each project structure.

Pre-requisites

This project required Node. We suggest installing it using asdf if you don't use a Node version manager yet.

git clone https://github.com/asdf-vm/asdf.git ~/.asdf

and add binginds to your shell config file.

asdf plugin add nodejs

and run install node in the repo. This will pick up the current Node version from the .tool-versions file.

asdf install nodejs

We use pnpm for package management. To install pnpm, run:

npm install -g pnpm

Install dependencies

pnpm i

If you need to build the Smart Contracts under the metadata app, you must first install Foundry to your system:

curl -L https://foundry.paradigm.xyz | bash
source ~/.bashrc
foundryup

Problems?

If you encounter any issues or need assistance:

  1. Review our wiki
  2. Check open issues or create a new one.
  3. Reach out to us at [email protected].

Contributors

A heartfelt thanks to all who've contributed:

  • Nichollas Rennah and Marcos Tullyo: Initial designs and development of for the metadata app.

Wish to be listed? Make a contribution and open an issue or send a pull request.

Contributing

Contributions are warmly welcomed. Raise issues, propose PRs, or reach out directly to [email protected] for discussions.

License

The predominant license is the GNU General Public License Version 3 (GPL v3), referenced in LICENSE, barring explicit exceptions listed in this README or within the source files.

Exceptions

Authors

@ribeirojose, @mendesfabio, @devjoaov, @luizakp, @yvesfracari

Heartily crafted by Bleu, with immense gratitude to the Balancer and CoW Grants committees for their financial endorsement.