CFG API V3

A blockchain event indexer for the CFG protocol v3 built with Ponder.sh.

Overview

This project indexes EVM events from smart contracts in the CFG protocol, maintaining a structured database of pools, share classes, and investment transactions.

Key Components

Event Handlers

• Vault Handlers: Process deposit/withdrawal requests and executions
• MultiShareClass Handlers: Manage share class lifecycle, epoch transitions, and investor orders
• PoolRegistry Handlers: Track pool creation and configuration
• PoolManager Handlers: Handle vault deployment for share classes

Services

The project uses several services to maintain data consistency:

• PoolService: Manages investment pools
• ShareClassService: Handles share class configuration and metadata
• EpochService: Tracks investment epochs
• InvestorTransactionService: Processes user deposits and redemptions
• OutstandingOrderService: Tracks pending investment orders

Getting Started

Prerequisites

• Node.js (v22+)
• Ethereum RPC endpoint

Installation

# Install dependencies
yarn install --frozen-lockfile

# Create .env file with your configuration
cp .env.example .env.local
# Edit .env with your settings (RPC endpoint and API key)

yarn codegen

Configuration

• Edit your chains.ts file to specify contracts to query
• Specify what chain to index in ponder.config.ts

Running the Indexer

# Start the development server
yarn dev

# Build for production
yarn build

# Start production server
yarn start

Database Schema

The indexer builds and maintains a structured database with the following primary entities:

• Pools
• ShareClasses
• Epochs
• InvestorTransactions
• OutstandingOrders

API

Once running, the Ponder indexer provides a GraphQL API for querying indexed data. URL printed on start.

Entity Relationships

erDiagram
  direction LR
  Blockchain ||--o{ Pool : ""
  Blockchain ||--o{ Vault : ""
  Blockchain ||--o{ Asset : ""
  Blockchain ||--o{ TokenInstance : ""
  Blockchain ||--o{ AssetRegistration : ""

  Pool ||--o{ PoolSnapshot : ""
  Pool ||--o{ Token : ""
  Pool ||--o{ Epoch : ""

  Asset }o--|| Blockchain : ""
  Asset }o--|| AssetRegistration : ""


  TokenInstance }o--|| Blockchain : ""
  TokenInstance }o--|| Token : ""

  Vault }o--|| Blockchain : ""
  Vault }o--|| Token : ""
  Vault }o--|| Asset : ""
  Vault }o--|| TokenInstance : ""

  InvestorTransaction }o--|| Pool : ""
  InvestorTransaction }o--|| Epoch : ""
  InvestorTransaction }o--|| Token : ""

  OutstandingOrder }o--|| Token : ""

  Holding }o--|| Token : ""
  Holding  }o--|| HoldingAccount : ""

  HoldingEscrow }o--|| Holding : ""
  HoldingEscrow }o--|| Asset : ""
  HoldingEscrow }o--|| Escrow : ""

Loading

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

TBD