EAS Indexer

A Ponder indexer for Ethereum Attestation Service (EAS) attestations on Optimism.

Overview

This indexer tracks EAS attestations and stores them into Postgres database. It watches for Attested and Revoked events from the EAS contract on Optimism, decodes the attestation data according to predefined schemas, and stores the results in structured tables.

How it Works

1. Schema Configuration

   • Schemas are defined in schemas.config.ts with their IDs and optional attester addresses
   • Schema parameter signatures are defined in src/schemas.ts for decoding attestation data
   • Database tables are defined in ponder.schema.ts matching the schema structures

2. Event Processing

   • Listens for Attested events matching configured schema IDs
   • Validates attester address if specified in schema config
   • Retrieves full attestation data using getAttestation
   • Decodes raw data using schema-specific parameter signatures
   • Stores decoded data in corresponding database tables
   • Tracks revocations through Revoked events

3. Database Structure

   • Each schema has its own table with appropriate columns
   • All attestations store:
     • Unique ID
     • Recipient address
     • Schema-specific data fields
     • Revocation status

Setup

1. Install dependencies:

   yarn install

2. Configure environment:

   • Copy .env.example to .env
   • Add your RPC URL for Optimism mainnet

3. Start the indexer:

yarn dev

Development

Adding New Schemas

1. Add schema configuration in schemas.config.ts:

   export const schemas = [
     {
       id: "0x...",
       name: "citizen",
       attester: "0x...", // optional
     },
   ];

2. Define schema parameters in src/schemas.ts

3. Add corresponding table definition in ponder.schema.ts

4. Add schema to ponder.config.ts

5. Update src/index.ts to include the new schema

Adding New Entities

1. Add entity configuration in ponder.schema.ts
2. Add entity to ponder.config.ts
3. Update src/index.ts to include the new entity

API Endpoints

The indexer exposes REST API endpoints for querying attestation data. Endpoints are automatically generated for each schema defined in schemas.config.ts.

Get Attestations by Address

For each schema (citizen, badgeholder, gov_contribution, etc.), the following endpoint is available:

GET /api/{schema}/address/{address}

Example:

GET /api/citizen/address/0x1234...

Response:

{
  "attestations": [
    {
      "id": "0xabcd...",
      "recipient": "0x1234...",
      "attester": "0x5678...",
      "time": "2024-03-21T15:30:00Z",
      "revoked": false
      // schema-specific fields
    }
  ]
}