ponder.config.ts

Ponder's configuration file file contains smart contract addresses, paths to ABIs, RPC URLs, and database connection details.

• ponder.config.ts must provide a named export called config, not a default export.
• By default, ponder {dev/start/codegen} looks for ponder.config.ts in the current working directory, but you can specify a different path with the --config-file option.
• The config variable exported by ponder.config.ts can be an object, a function, or a function returning a Promise (you can do async stuff to determine your config).

Fields

Networks

Networks are Ethereum-based blockchains like Ethereum mainnet, Goerli, or Foundry's local Anvil node. Each network has a name, chainId, and transport.

Contracts

Contracts are smart contracts deployed to a network. All contracts defined here will become available as ReadOnlyContract objects in the event context. Ponder will fetch and process event logs emitted by all contracts with isLogEventSource: true (the default).

Factory

Filters

Filters are custom event log filters that are more flexible than contracts. Ponder will fetch and process event logs that match the filter field.

Filter

Database

Ponder uses a SQL database to cache blockchain data and store entity data. In development, Ponder uses a SQLite database located at .ponder/cache.db. In production, Ponder works best with a PostgreSQL database. If no database is specified in ponder.config.ts, Ponder will use SQLite unless the DATABASE_URL environment variable is present, in which case it will use PostgreSQL with DATABASE_URL as the connection string.

See Deploy to production for more details.

Options

Examples

Basic example

import type { Config } from "@ponder/core";
import { http } from "viem";
 
export const config: Config = {
  networks: [
    {
      name: "mainnet",
      chainId: 1,
      transport: http(process.env.PONDER_RPC_URL_1),
    },
  ],
  contracts: [
    {
      name: "ArtGobblers",
      network: "mainnet",
      abi: "./abis/ArtGobblers.json",
      address: "0x60bb1e2aa1c9acafb4d34f71585d7e959f387769",
      startBlock: 15863321,
    },
  ],
};

Async function

import type { Config } from "@ponder/core";
 
export const config: Config = async () => {
  const startBlock = await fetch("http://...");
 
  return {
    networks: [ /* ... */ ],
    contracts: [
      {
        name: "ArtGobblers",
        network: "mainnet",
        abi: "./abis/ArtGobblers.json",
        address: "0x60bb1e2aa1c9acafb4d34f71585d7e959f387769",
        startBlock: startBlock
      }
    ]
  };
};