contractFactory

Track dynamically created contracts with evmEventDecoder().

contractFactory(config: ContractFactoryOptions): Factory

Parameters:

address: Factory contract address or array of addresses (required)
event: Factory creation event ABI or filtered event object (required)
- Simple format: AbiEvent<T> - Capture all factory events
- Filtered format: { event: AbiEvent<T>, params: {...} } - Filter by indexed parameters
Events should be specified using the same approach as evmEventDecoder() itself uses.
childAddressField: How to extract the child contract address from the decoded factory event (required). Either
- a key of the decoded event data (e.g. 'pool'), or
- a function (decodedEventData) => string | null. Return null to skip the event.
database: A factory store that persists the list of known child contracts (required). Accepts a FactoryPersistentAdapter instance or a Promise resolving to one, so you can pass the result of contractFactorySqliteStore() directly.

Example:

import { contractFactory, contractFactorySqliteStore } from "@subsquid/pipes/evm";
import * as factoryAbi from "./abi/uniswap-v3-factory";

const factoryInstance = contractFactory({
  address: "0x1f98431c8ad98523631ae4a59f267346ea31f984",
  event: factoryAbi.events.PoolCreated,
  childAddressField: "pool",
  database: contractFactorySqliteStore({ path: "./pools.sqlite" }),
});

Filtered factory events:

contractFactory({
  address: "0x1f98431c8ad98523631ae4a59f267346ea31f984",
  event: {
    event: factoryAbi.events.PoolCreated,
    params: {
      token0: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2", // WETH
    },
  },
  childAddressField: "pool",
  database: contractFactorySqliteStore({ path: "./weth-pools.sqlite" }),
});

Only indexed event parameters can be used in the params object. Another way to look at it is that parameter values should be available as event topics. Reference.

contractFactorySqliteStore

Create an SQLite factory database: an object used to persist the list of child contracts in a fork-aware way. For now, only SQLite-based factory databases are supported.

contractFactorySqliteStore(config: { path: string }): Promise<FactoryPersistentAdapter>

The returned promise can be passed to contractFactory()’s database option as is.

Overview

Pipes SDK

Squid SDK

Alternative clients

contractFactorySqliteStore

​contractFactorySqliteStore

contractFactorySqliteStore