ponder-with-flashblocks 0.16.3

package/src/config/index.ts

@@ -0,0 +1,246 @@
+import type { ConnectionOptions } from "node:tls";
+import type { Prettify } from "@/types/utils.js";
+import type { Abi } from "abitype";
+import type { PoolConfig } from "pg";
+import type { Narrow, Transport } from "viem";
+import type { AddressConfig } from "./address.js";
+import type { GetEventFilter } from "./eventFilter.js";
+
+export type Config = {
+  database?: DatabaseConfig;
+  ordering?: "omnichain" | "multichain" | "experimental_isolated";
+  chains: { [chainName: string]: ChainConfig<unknown> };
+  contracts: { [contractName: string]: GetContract };
+  accounts: { [accountName: string]: AccountConfig<unknown> };
+  blocks: {
+    [sourceName: string]: GetBlockFilter<unknown>;
+  };
+};
+
+export type CreateConfigReturnType<chains, contracts, accounts, blocks> = {
+  database?: DatabaseConfig;
+  ordering?: "omnichain" | "multichain" | "experimental_isolated";
+  chains: chains;
+  contracts: contracts;
+  accounts: accounts;
+  blocks: blocks;
+};
+
+export const createConfig = <
+  const chains,
+  const contracts = {},
+  const accounts = {},
+  const blocks = {},
+>(config: {
+  database?: DatabaseConfig;
+  ordering?: "omnichain" | "multichain" | "experimental_isolated";
+  // TODO: add jsdoc to these properties.
+  chains: ChainsConfig<Narrow<chains>>;
+  contracts?: ContractsConfig<chains, Narrow<contracts>>;
+  accounts?: AccountsConfig<chains, Narrow<accounts>>;
+  blocks?: BlockFiltersConfig<chains, blocks>;
+}): CreateConfigReturnType<chains, contracts, accounts, blocks> =>
+  config as Prettify<
+    CreateConfigReturnType<chains, contracts, accounts, blocks>
+  >;
+
+// database
+
+type DatabaseConfig =
+  | {
+      kind: "pglite";
+      /** Directory path to use for PGlite database files. Default: `".ponder/pglite"`. */
+      directory?: string;
+    }
+  | {
+      kind: "postgres";
+      /** Postgres database connection string. Default: `DATABASE_PRIVATE_URL` > `DATABASE_URL` environment variable. */
+      connectionString?: string;
+      /** Postgres pool configuration passed to `node-postgres`. */
+      poolConfig?: {
+        /** Maximum number of clients in the pool. Default: `30`. */
+        max?: number;
+        /** Enable SSL, or provide a custom SSL configuration. Default: `undefined`. */
+        ssl?: boolean | Prettify<ConnectionOptions>;
+      } & Omit<PoolConfig, "max" | "ssl" | "connectionString">;
+    };
+
+// base
+
+type BlockConfig = {
+  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
+  startBlock?: number | "latest";
+  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
+  endBlock?: number | "latest";
+};
+
+type TransactionReceiptConfig = {
+  includeTransactionReceipts?: boolean;
+};
+
+type FunctionCallConfig = {
+  /*
+   * Enable call trace indexing for this contract.
+   *
+   * - Docs: https://ponder.sh/docs/guides/call-traces
+   */
+  includeCallTraces?: boolean;
+};
+
+// chain
+
+type ChainConfig<chain> = {
+  /** Chain ID of the chain. */
+  id: chain extends { id: infer id extends number } ? id | number : number;
+  /** RPC url. */
+  rpc: string | string[] | Transport | undefined;
+  ws?: string;
+  /** Polling interval (in ms). Default: `1_000`. */
+  pollingInterval?: number;
+  /**
+   * Maximum number of RPC requests per second.
+   * @deprecated Handled automatically instead.
+   */
+  maxRequestsPerSecond?: number;
+  /** Disable RPC request caching. Default: `false`. */
+  disableCache?: boolean;
+  /**
+   * Maximum block range for eth_getLogs. If undefined, Ponder will
+   * attempt to determine the block range automatically based on error messages.
+   */
+  ethGetLogsBlockRange?: number;
+  /**
+   * Use "pending" block tag instead of "latest" when polling for new blocks.
+   * Enables reading pre-confirmation data such as Base flashblocks.
+   * Default: `false`.
+   */
+  readPending?: boolean;
+};
+
+type ChainsConfig<chains> = {} extends chains
+  ? {}
+  : {
+      [chainName in keyof chains]: ChainConfig<chains[chainName]>;
+    };
+
+// contracts
+
+type AbiConfig<abi extends Abi | readonly unknown[]> = {
+  /** Contract application byte interface. */
+  abi: abi;
+};
+
+type GetContractChain<
+  chains,
+  abi extends Abi,
+  ///
+  allChainNames extends string = [keyof chains] extends [never]
+    ? string
+    : keyof chains & string,
+> = {
+  /**
+   * Chain that this contract is deployed to. Must match a chain name in `chains`.
+   * Any filter information overrides the values in the higher level "contracts" property.
+   */
+  chain:
+    | allChainNames
+    | {
+        [name in allChainNames]?: Prettify<
+          AddressConfig &
+            GetEventFilter<abi> &
+            TransactionReceiptConfig &
+            FunctionCallConfig &
+            BlockConfig
+        >;
+      };
+};
+
+type ContractConfig<chains, abi extends Abi> = Prettify<
+  AbiConfig<abi> &
+    GetContractChain<chains, abi> &
+    AddressConfig &
+    GetEventFilter<abi> &
+    TransactionReceiptConfig &
+    FunctionCallConfig &
+    BlockConfig
+>;
+
+type GetContract<chains = unknown, contract = unknown> = contract extends {
+  abi: infer abi extends Abi;
+}
+  ? // 1. Contract has a valid abi
+    ContractConfig<chains, abi>
+  : // 2. Contract has an invalid abi
+    ContractConfig<chains, Abi>;
+
+type ContractsConfig<chains, contracts> = {} extends contracts
+  ? // contracts empty, return empty
+    {}
+  : {
+      [name in keyof contracts]: GetContract<chains, contracts[name]>;
+    };
+
+// accounts
+
+type GetAccountChain<
+  chains,
+  ///
+  allChainNames extends string = [keyof chains] extends [never]
+    ? string
+    : keyof chains & string,
+> = {
+  /**
+   * Chain that this account is deployed to. Must match a chain name in `chains`.
+   * Any filter information overrides the values in the higher level "accounts" property.
+   */
+  chain:
+    | allChainNames
+    | {
+        [name in allChainNames]?: Prettify<
+          AddressConfig & TransactionReceiptConfig & BlockConfig
+        >;
+      };
+};
+
+type AccountConfig<chains> = Prettify<
+  GetAccountChain<chains> &
+    Required<AddressConfig> &
+    TransactionReceiptConfig &
+    BlockConfig
+>;
+
+type AccountsConfig<chains, accounts> = {} extends accounts
+  ? {}
+  : {
+      [name in keyof accounts]: AccountConfig<chains>;
+    };
+
+// blocks
+
+type BlockFilterConfig = {
+  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
+  startBlock?: number | "latest";
+  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
+  endBlock?: number | "latest";
+  interval?: number;
+};
+
+type GetBlockFilter<
+  chains,
+  ///
+  allChainNames extends string = [keyof chains] extends [never]
+    ? string
+    : keyof chains & string,
+> = BlockFilterConfig & {
+  chain:
+    | allChainNames
+    | {
+        [name in allChainNames]?: BlockFilterConfig;
+      };
+};
+
+type BlockFiltersConfig<chains = unknown, blocks = unknown> = {} extends blocks
+  ? {}
+  : {
+      [name in keyof blocks]: GetBlockFilter<chains>;
+    };

package/src/config/utilityTypes.ts

@@ -0,0 +1,152 @@
+import type {
+  Abi,
+  AbiEvent,
+  AbiFunction,
+  AbiParametersToPrimitiveTypes,
+  FormatAbiItem,
+} from "abitype";
+import type { GetEventArgs, ParseAbiItem } from "viem";
+
+export type NonStrictPick<T, K> = {
+  [P in Extract<keyof T, K>]: T[P];
+};
+
+export type ExtractAbiEvents<
+  abi extends Abi,
+  events = Extract<abi[number], { type: "event" }>,
+> = [events] extends [never] ? AbiEvent : events;
+
+export type ExtractAbiFunctions<
+  abi extends Abi,
+  functions = Extract<abi[number], { type: "function" }>,
+> = [functions] extends [never] ? AbiFunction : functions;
+
+/** Return the abi event given the abi and compact signature. */
+export type ParseAbiEvent<
+  abi extends Abi,
+  signature extends string,
+  ///
+  abiEvents extends AbiEvent = ExtractAbiEvents<abi>,
+  noOverloadEvent = Extract<abiEvents, { name: signature }>,
+  overloadEvent = Extract<abiEvents, ParseAbiItem<`event ${signature}`>>,
+> = [noOverloadEvent] extends [never]
+  ? [overloadEvent] extends [never]
+    ? AbiEvent
+    : overloadEvent
+  : noOverloadEvent;
+
+/** Return the abi function given the abi and compact signature. */
+export type ParseAbiFunction<
+  abi extends Abi,
+  signature extends string,
+  ///
+  abiFunctions extends AbiFunction = ExtractAbiFunctions<abi>,
+  noOverloadFunction = Extract<
+    abiFunctions,
+    { name: signature extends `${infer _signature}()` ? _signature : never }
+  >,
+  overloadFunction = Extract<
+    abiFunctions,
+    ParseAbiItem<`function ${signature}`>
+  >,
+> = [overloadFunction] extends [never]
+  ? [noOverloadFunction] extends [never]
+    ? AbiFunction
+    : noOverloadFunction
+  : overloadFunction;
+
+/** Return the compact signature given the abi and abi event. */
+export type FormatAbiEvent<
+  abi extends Abi,
+  event extends AbiEvent,
+  ///
+  abiEvents extends AbiEvent = ExtractAbiEvents<abi>,
+  matchingNameEvents extends AbiEvent = Extract<
+    abiEvents,
+    { name: event["name"] }
+  >,
+> = [matchingNameEvents] extends [never]
+  ? Abi extends abi
+    ? event["name"]
+    : never
+  : [Exclude<matchingNameEvents, event>] extends [never]
+    ? event["name"]
+    : FormatAbiItem<event> extends `event ${infer signature}`
+      ? signature
+      : never;
+
+/** Return the compact signature given the abi and abi function. */
+export type FormatAbiFunction<
+  abi extends Abi,
+  _function extends AbiFunction,
+  ///
+  abiFunctions extends AbiFunction = ExtractAbiFunctions<abi>,
+  matchingNameFunctions extends AbiFunction = Extract<
+    abiFunctions,
+    { name: _function["name"] }
+  >,
+> = [matchingNameFunctions] extends [never]
+  ? Abi extends abi
+    ? `${_function["name"]}()`
+    : never
+  : [Exclude<matchingNameFunctions, _function>] extends [never]
+    ? `${_function["name"]}()`
+    : FormatAbiItem<_function> extends `function ${infer signature}`
+      ? signature
+      : never;
+
+/**
+ * Return an union of safe event names that handle event overriding.
+ */
+export type SafeEventNames<
+  abi extends Abi,
+  ///
+  abiEvents extends AbiEvent = ExtractAbiEvents<abi>,
+> = abiEvents extends abiEvents ? FormatAbiEvent<abi, abiEvents> : never;
+
+/**
+ * Return an union of safe function names that handle function overriding.
+ */
+export type SafeFunctionNames<
+  abi extends Abi,
+  ///
+  abiFunctions extends AbiFunction = ExtractAbiFunctions<abi>,
+> = abiFunctions extends abiFunctions
+  ? FormatAbiFunction<abi, abiFunctions>
+  : never;
+
+export type FormatEventArgs<
+  abi extends Abi,
+  signature extends string,
+> = GetEventArgs<
+  Abi,
+  string,
+  {
+    EnableUnion: false;
+    IndexedOnly: false;
+    Required: true;
+  },
+  ParseAbiEvent<abi, signature>
+>;
+
+export type FormatFunctionArgs<
+  abi extends Abi,
+  signature extends string,
+  ///
+  args = AbiParametersToPrimitiveTypes<
+    ParseAbiFunction<abi, signature>["inputs"]
+  >,
+> = readonly [] extends args ? never : args;
+
+export type FormatFunctionResult<
+  abi extends Abi,
+  signature extends string,
+  ///
+  result = AbiParametersToPrimitiveTypes<
+    ParseAbiFunction<abi, signature>["outputs"]
+  >,
+> = readonly [] extends result
+  ? never
+  : result extends readonly [unknown]
+    ? result[0]
+    : result;