Home

Bleu's Balancer Tools Monorepo

Welcome to the Balancer Tools repository. At Bleu, we're committed to enhancing the Balancer user experience, presenting a comprehensive suite of functionalities, analytics, and utilities.

Repository Structure

Apps

Explore our deployable applications in the apps/ directory:

• Balancer Tools (apps/balancer-tools/): Crafted with Next.js, each subdirectory stands as a distinct module in our extensive application.

  • Pool Metadata (apps/balancer-tools/src/app/metadata/): Empowers pool owners to enhance their pools with metadata, enriching discoverability and clarity.

  • Internal Manager (apps/balancer-tools/src/app/internalmanager/): Streamlines management of your internal balances.

  • Stable Swap Simulator (apps/balancer-tools/src/app/stableswapsimulator/): Dive deep into stable pool behaviors.

  • Pools Simulator (apps/balancer-tools/src/app/poolsimulator/): An extension of the Stable Swap Simulator to analyze stable pools intricately.

  • DAO Admin (apps/balancer-tools/src/app/daoadmin/): Tool currently dropped from active development.

  • Historical APR (apps/balancer-tools/src/app/apr/): A visual guide to Balancer pools' historical APR.

• Gyro ECLP API (apps/gyro-eclp-api/): [Description needed]

• Pool Metadata (apps/pool-metadata/): Bridges pools to their corresponding IPFS CIDs.

  • Contracts (apps/pool-metadata/contracts): Foundry project presenting the PoolMetadataRegistry contract.

  • Subgraph (apps/pool-metadata/contracts): A Subgraph project updating via events from the PoolMetadataRegistry contract and supports the NextJS frontend with data.

Packages

The packages/ directory shelters the core components:

• GQL (packages/gql/): bridges the UI and Balancer's Subgraphs GraphQL servers.

• Math (packages/math-poolsimulator/ & packages/math-stableswapsimulator/): Mathematical backbone for pool mechanisms.

• utils (packages/utils/): shared code consistency and simplified maintenance.

• eslint Configuration (packages/eslint-config/): repo-wide JS/TS linting configs.

• TS Config (packages/tsconfig/): tsconfig.json templates for different types of packages.

lib/

the lib in the root of this repo is a symlink stemming from a requirement from Foundry, which we use in the pool metadata contracts and uses git submodules to manage dependencies. Most of the times you won't need to care about it, and you don't need to recurse submodules unless you need to build the pool metadata contracts.