ponder-with-flashblocks 0.16.3

package/src/sync-store/schema.ts

@@ -0,0 +1,248 @@
+import type { Factory, FragmentId } from "@/internal/types.js";
+import {
+  customType,
+  index,
+  pgSchema,
+  primaryKey,
+  unique,
+} from "drizzle-orm/pg-core";
+import type { Address, Hash, Hex } from "viem";
+
+const nummultirange = customType<{ data: string }>({
+  dataType() {
+    return "nummultirange";
+  },
+});
+
+const numeric78 = customType<{ data: bigint; driverData: string }>({
+  dataType() {
+    return "numeric(78,0)";
+  },
+  fromDriver(value: string) {
+    return BigInt(value);
+  },
+});
+
+/**
+ * Database schemas for the sync.
+ *
+ * @dev The order of the schemas represents the order of the migrations.
+ * @dev The schemas must match the files in "./sql".
+ */
+export const PONDER_SYNC_SCHEMAS = ["ponder_sync"] as const;
+/**
+ * Latest database schema for the sync.
+ */
+export const PONDER_SYNC_SCHEMA =
+  PONDER_SYNC_SCHEMAS[PONDER_SYNC_SCHEMAS.length - 1]!;
+
+export const PONDER_SYNC = pgSchema(PONDER_SYNC_SCHEMA);
+
+export const blocks = PONDER_SYNC.table(
+  "blocks",
+  (t) => ({
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    number: t.bigint({ mode: "bigint" }).notNull(),
+    timestamp: t.bigint({ mode: "bigint" }).notNull(),
+    hash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    parentHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    logsBloom: t.varchar({ length: 514 }).notNull().$type<Hex>(),
+    miner: t.varchar({ length: 42 }).notNull().$type<Address>(),
+    gasUsed: numeric78().notNull(),
+    gasLimit: numeric78().notNull(),
+    baseFeePerGas: numeric78(),
+    nonce: t.varchar({ length: 18 }).$type<Hex>(),
+    mixHash: t.varchar({ length: 66 }).$type<Hash>(),
+    stateRoot: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    receiptsRoot: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    transactionsRoot: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    sha3Uncles: t.varchar({ length: 66 }).$type<Hash>(),
+    size: numeric78().notNull(),
+    difficulty: numeric78().notNull(),
+    totalDifficulty: numeric78(),
+    extraData: t.text().notNull().$type<Hex>(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "blocks_pkey",
+      columns: [table.chainId, table.number],
+    }),
+  ],
+);
+
+export const transactions = PONDER_SYNC.table(
+  "transactions",
+  (t) => ({
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }).notNull(),
+    transactionIndex: t.integer().notNull(),
+    hash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    blockHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    from: t.varchar({ length: 42 }).notNull().$type<Address>(),
+    to: t.varchar({ length: 42 }).$type<Address>(),
+    input: t.text().notNull().$type<Hex>(),
+    value: numeric78().notNull(),
+    nonce: t.integer().notNull(),
+    r: t.varchar({ length: 66 }).$type<Hex>(),
+    s: t.varchar({ length: 66 }).$type<Hex>(),
+    v: numeric78(),
+    type: t.text().notNull().$type<Hex>(),
+    gas: numeric78().notNull(),
+    gasPrice: numeric78(),
+    maxFeePerGas: numeric78(),
+    maxPriorityFeePerGas: numeric78(),
+    accessList: t.text(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "transactions_pkey",
+      columns: [table.chainId, table.blockNumber, table.transactionIndex],
+    }),
+  ],
+);
+
+export const transactionReceipts = PONDER_SYNC.table(
+  "transaction_receipts",
+  (t) => ({
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }).notNull(),
+    transactionIndex: t.integer().notNull(),
+    transactionHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    blockHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    from: t.varchar({ length: 42 }).notNull().$type<Address>(),
+    to: t.varchar({ length: 42 }).$type<Address>(),
+    contractAddress: t.varchar({ length: 42 }).$type<Address>(), // Note: incorrect
+    logsBloom: t.varchar({ length: 514 }).notNull().$type<Hex>(),
+    gasUsed: numeric78().notNull(),
+    cumulativeGasUsed: numeric78().notNull(),
+    effectiveGasPrice: numeric78().notNull(),
+    status: t.text().notNull().$type<Hex>(),
+    type: t.text().notNull().$type<Hex>(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "transaction_receipts_pkey",
+      columns: [table.chainId, table.blockNumber, table.transactionIndex],
+    }),
+  ],
+);
+
+export const logs = PONDER_SYNC.table(
+  "logs",
+  (t) => ({
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }).notNull(),
+    logIndex: t.integer().notNull(),
+    transactionIndex: t.integer().notNull(),
+    blockHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    transactionHash: t.varchar({ length: 66 }).notNull().$type<Hash>(),
+    address: t.varchar({ length: 42 }).notNull().$type<Address>(),
+    topic0: t.varchar({ length: 66 }).$type<Hex>(),
+    topic1: t.varchar({ length: 66 }).$type<Hex>(),
+    topic2: t.varchar({ length: 66 }).$type<Hex>(),
+    topic3: t.varchar({ length: 66 }).$type<Hex>(),
+    data: t.text().notNull().$type<Hex>(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "logs_pkey",
+      columns: [table.chainId, table.blockNumber, table.logIndex],
+    }),
+  ],
+);
+
+export const traces = PONDER_SYNC.table(
+  "traces",
+  (t) => ({
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }).notNull(),
+    transactionIndex: t.integer().notNull(),
+    traceIndex: t.integer().notNull(),
+    from: t.varchar({ length: 42 }).notNull().$type<Address>(),
+    to: t.varchar({ length: 42 }).$type<Address>(),
+    input: t.text().notNull().$type<Hex>(),
+    output: t.text().$type<Hex>(),
+    value: numeric78(),
+    type: t.text().notNull(),
+    gas: numeric78().notNull(),
+    gasUsed: numeric78().notNull(),
+    error: t.text(),
+    revertReason: t.text(),
+    subcalls: t.integer().notNull(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "traces_pkey",
+      columns: [
+        table.chainId,
+        table.blockNumber,
+        table.transactionIndex,
+        table.traceIndex,
+      ],
+    }),
+  ],
+);
+
+export const rpcRequestResults = PONDER_SYNC.table(
+  "rpc_request_results",
+  (t) => ({
+    requestHash: t.text().notNull(),
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }),
+    result: t.text().notNull(),
+  }),
+  (table) => [
+    primaryKey({
+      name: "rpc_request_results_pkey",
+      columns: [table.chainId, table.requestHash],
+    }),
+    index("rpc_request_results_chain_id_block_number_index").on(
+      table.chainId,
+      table.blockNumber,
+    ),
+  ],
+);
+
+export const intervals = PONDER_SYNC.table("intervals", (t) => ({
+  fragmentId: t.text().notNull().$type<FragmentId>().primaryKey(),
+  chainId: t.bigint({ mode: "bigint" }).notNull(),
+  blocks: nummultirange().notNull(),
+}));
+
+export const factories = PONDER_SYNC.table(
+  "factories",
+  (t) => ({
+    id: t.integer().primaryKey().generatedAlwaysAsIdentity(),
+    factory: t
+      .jsonb()
+      .$type<
+        Pick<
+          Factory,
+          | "type"
+          | "chainId"
+          | "address"
+          | "eventSelector"
+          | "childAddressLocation"
+          | "fromBlock"
+          | "toBlock"
+        >
+      >()
+      .notNull(),
+  }),
+  (table) => [
+    index("factories_factory_idx").on(table.factory),
+    unique("factories_factory_key").on(table.factory),
+  ],
+);
+
+export const factoryAddresses = PONDER_SYNC.table(
+  "factory_addresses",
+  (t) => ({
+    id: t.integer().primaryKey().generatedAlwaysAsIdentity(),
+    factoryId: t.integer().notNull(), // references `factories.id`
+    chainId: t.bigint({ mode: "bigint" }).notNull(),
+    blockNumber: t.bigint({ mode: "bigint" }).notNull(),
+    address: t.text().$type<Address>().notNull(),
+  }),
+  (table) => [index("factory_addresses_factory_id_index").on(table.factoryId)],
+);

package/src/types/db.ts

@@ -0,0 +1,292 @@
+import { onchain } from "@/drizzle/onchain.js";
+import type { OnchainTable, PrimaryKeyBuilder } from "@/drizzle/onchain.js";
+import type { Schema } from "@/internal/types.js";
+import type {
+  Column,
+  GetColumnData,
+  InferInsertModel,
+  InferSelectModel,
+  Table,
+} from "drizzle-orm";
+import type { NodePgDatabase } from "drizzle-orm/node-postgres";
+import type { PgTableExtraConfig, TableConfig } from "drizzle-orm/pg-core";
+import type { PgliteDatabase } from "drizzle-orm/pglite";
+import type { PonderTypeError, Prettify } from "./utils.js";
+
+export type Drizzle<TSchema extends Schema = { [name: string]: never }> =
+  | NodePgDatabase<TSchema>
+  | PgliteDatabase<TSchema>;
+
+export type ReadonlyDrizzle<
+  TSchema extends Schema = { [name: string]: never },
+> = Omit<
+  Drizzle<TSchema>,
+  | "insert"
+  | "update"
+  | "delete"
+  | "transaction"
+  | "refreshMaterializedView"
+  | "_"
+>;
+
+export type Db<schema extends Schema> = {
+  /**
+   * Find a row
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#find
+   *
+   * @example
+   * ```ts twoslash
+   * const result = await db.find(table, { id: 10 });
+   * ```
+   *
+   * @param table - The table to select from.
+   * @param key - The primary key.
+   * @returns The row if it exists or undefined if it doesn't.
+   */
+  find: Find;
+  /**
+   * Create new rows
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#insert
+   *
+   * @example
+   * ```ts twoslash
+   * await db.insert(table).values({ id: 10, name: "joe" });
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db.insert(table).values([
+   *   { id: 10, name: "joe" },
+   *   { id: 3, name: "rob" }
+   * ]);
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db.insert(table).values({ id: 10, name: "joe" }).onConflictDoNothing();
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db
+   *   .insert(table)
+   *   .values({ id: 10, name: "joe" })
+   *   .onConflictDoUpdate((row) => ({ age: row.age + 3 }));
+   * ```
+   *
+   * @param table - The table to insert into.
+   */
+  insert: Insert;
+  /**
+   * Update a row
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#update
+   *
+   * @example
+   * ```ts twoslash
+   * await db
+   *   .update(table, { id: 10 })
+   *   .set({ age: 19 });
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db
+   *   .update(table, { id: 10 })
+   *   .set((row) => ({ age: row.age + 3 }));
+   * ```
+   *
+   * @param table - The table to select from.
+   * @param key - The primary key.
+   */
+  update: Update;
+  /**
+   * Delete a row
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#delete
+   *
+   * @example
+   * ```ts twoslash
+   * const deleted = await db.delete(table, { id: 10 });
+   * ```
+   *
+   * @param table - The table to select from.
+   * @param key - The primary key.
+   * @returns `true` if the row existed.
+   */
+  delete: Delete;
+  /**
+   * Access the raw drizzle object
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#raw-sql
+   */
+  sql: Prettify<Omit<Drizzle<schema>, "refreshMaterializedView" | "_">>;
+};
+
+type InferPrimaryKey<
+  table extends Table,
+  ///
+  columns extends Record<string, Column> = table["_"]["columns"],
+  columnNames extends keyof columns & string = keyof columns & string,
+> = columnNames extends columnNames
+  ? columns[columnNames]["_"]["isPrimaryKey"] extends true
+    ? columnNames
+    : never
+  : never;
+
+export type Key<
+  table extends Table,
+  ///
+  compositePrimaryKey extends // @ts-ignore
+  keyof table["_"]["columns"] = InferCompositePrimaryKey<table>,
+  primaryKey extends keyof table["_"]["columns"] = [
+    compositePrimaryKey,
+  ] extends [never]
+    ? InferPrimaryKey<table>
+    : compositePrimaryKey,
+> = {
+  [columnName in primaryKey]: GetColumnData<table["_"]["columns"][columnName]>;
+};
+
+export type InferCompositePrimaryKey<
+  table extends OnchainTable<
+    TableConfig & { extra: PgTableExtraConfig | undefined }
+  >,
+  ///
+  extra extends PgTableExtraConfig | undefined = table["_"]["config"]["extra"],
+  builders = extra[keyof extra],
+> = builders extends builders
+  ? builders extends PrimaryKeyBuilder
+    ? builders["columnNames"]
+    : never
+  : never;
+
+export type Find = <table extends Table>(
+  table: table extends { [onchain]: true }
+    ? table
+    : PonderTypeError<`db.find() can only be used with onchain tables, and '${table["_"]["name"]}' is an offchain table or a view.`>,
+  key: Key<table>,
+) => Promise<InferSelectModel<table> | null>;
+
+export type Insert = <
+  table extends Table,
+  ///
+  insertModel = InferInsertModel<table>,
+  selectModel = InferSelectModel<table>,
+  updateModel = Prettify<Omit<insertModel, keyof Key<table>>>,
+  updateFn = (row: selectModel) => Partial<updateModel>,
+>(
+  table: table extends { [onchain]: true }
+    ? table
+    : PonderTypeError<`Indexing functions can only write to onchain tables, and '${table["_"]["name"]}' is an offchain table or a view.`>,
+) => {
+  /**
+   * Create new rows
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#insert
+   *
+   * @example
+   * ```ts twoslash
+   * await db.insert(table).values({ id: 10, name: "joe" });
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db.insert(table).values([
+   *   { id: 10, name: "joe" },
+   *   { id: 3, name: "rob" }
+   * ]);
+   * ```
+   * @param table - The table to insert into.
+   */
+  values: <values extends insertModel | insertModel[]>(
+    values: values,
+  ) => Promise<values extends unknown[] ? selectModel[] : selectModel> & {
+    /**
+     * Create new rows, cancelling the insert if there is a conflict
+     *
+     * - Docs: https://ponder.sh/docs/indexing/write#onconflictdonothing
+     * @example
+     * ```ts twoslash
+     * await db.insert(table).values({ id: 10, name: "joe" }).onConflictDoNothing();
+     * ```
+     * @param table - The table to insert into.
+     */
+    onConflictDoNothing: () => Promise<
+      values extends unknown[] ? (selectModel | null)[] : selectModel | null
+    >;
+    /**
+     * Create new rows, updating the row if there is a conflict
+     *
+     * - Docs: https://ponder.sh/docs/indexing/write#onconflictdoupdate
+     *
+     * @example
+     * ```ts twoslash
+     * await db
+     *   .insert(table)
+     *   .values({ id: 10, name: "joe" })
+     *   .onConflictDoUpdate({ age: 24 });
+     * ```
+     *
+     * @example
+     * ```ts twoslash
+     * await db
+     *   .insert(table)
+     *   .values({ id: 10, name: "joe" })
+     *   .onConflictDoUpdate((row) => ({ age: row.age + 3 }));
+     * ```
+     *
+     * @param table - The table to insert into.
+     */
+    onConflictDoUpdate: (
+      values: Partial<updateModel> | updateFn,
+    ) => Promise<values extends unknown[] ? selectModel[] : selectModel>;
+  };
+};
+
+export type Update = <
+  table extends Table,
+  ///
+  insertModel = InferInsertModel<table>,
+  selectModel = InferSelectModel<table>,
+  insertValues = Prettify<Omit<insertModel, keyof Key<table>>>,
+  updateFn = (row: selectModel) => Partial<insertModel>,
+>(
+  table: table extends { [onchain]: true }
+    ? table
+    : PonderTypeError<`Indexing functions can only write to onchain tables, and '${table["_"]["name"]}' is an offchain table or a view.`>,
+  key: Key<table>,
+) => {
+  /**
+   * Update a row
+   *
+   * - Docs: https://ponder.sh/docs/indexing/write#update
+   *
+   * @example
+   * ```ts twoslash
+   * await db
+   *   .update(table, { id: 10 })
+   *   .set({ age: 19 });
+   * ```
+   *
+   * @example
+   * ```ts twoslash
+   * await db
+   *   .update(table, { id: 10 })
+   *   .set((row) => ({ age: row.age + 3 }));
+   * ```
+   *
+   * @param table - The table to select from.
+   * @param key - The primary key.
+   */
+  set: (values: Partial<insertValues> | updateFn) => Promise<selectModel>;
+};
+
+export type Delete = <table extends Table>(
+  table: table extends { [onchain]: true }
+    ? table
+    : PonderTypeError<`Indexing functions can only write to onchain tables, and '${table["_"]["name"]}' is an offchain table or a view.`>,
+  key: Key<table>,
+) => Promise<boolean>;