Update ENSDb schema definitions

packages/ensnode-schema/package.json

@@ -16,34 +16,60 @@
     "Ponder"
   ],
   "exports": {
-    ".": "./src/ponder.schema.ts"
+    ".": "./src/index.ts",
+    "./ponder": "./src/ponder-schema/index.ts",
+    "./ensindexer": "./src/ensindexer-schema/index.ts",
+    "./ensnode": "./src/ensnode-schema/index.ts"
   },
   "files": [
     "dist"
   ],
   "publishConfig": {
     "access": "public",
     "exports": {
-      "types": "./dist/ponder.schema.d.ts",
-      "default": "./dist/ponder.schema.js"
-    },
-    "main": "./dist/ponder.schema.js",
-    "module": "./dist/ponder.schema.mjs",
-    "types": "./dist/ponder.schema.d.ts"
+      ".": {
+        "import": {
+          "types": "./dist/index.d.ts",
+          "default": "./dist/index.js"
+        }
+      },
+      "./ponder": {
+        "import": {
+          "types": "./dist/ponder-schema.d.ts",
+          "default": "./dist/ponder-schema.js"
+        }
+      },
+      "./ensindexer": {
+        "import": {
+          "types": "./dist/ensindexer-schema.d.ts",
+          "default": "./dist/ensindexer-schema.js"
+        }
+      },
+      "./ensnode": {
+        "import": {
+          "types": "./dist/ensnode-schema.d.ts",
+          "default": "./dist/ensnode-schema.js"
+        }
+      }
+    }
   },
   "scripts": {
     "prepublish": "tsup",
     "lint": "biome check --write .",
     "lint:ci": "biome ci"
   },
-  "dependencies": {
+  "peerDependencies": {
+    "drizzle-orm": "catalog:",
     "ponder": "catalog:",
     "viem": "catalog:"
   },
   "devDependencies": {
     "@ensnode/ensnode-sdk": "workspace:",
     "@ensnode/shared-configs": "workspace:*",
+    "drizzle-orm": "catalog:",
+    "ponder": "catalog:",
     "tsup": "catalog:",
-    "typescript": "catalog:"
+    "typescript": "catalog:",
+    "viem": "catalog:"
   }
 }

packages/ensnode-schema/src/ensnode-schema/index.ts

@@ -0,0 +1,66 @@
+/**
+ * ENSNode Schema
+ *
+ * Defines the database objects describing the ENSNode services state.
+ */
+
+import { primaryKey } from "drizzle-orm/pg-core";
+
+import { ENSNODE_SCHEMA } from "./schema";
+
+export { ENSNODE_SCHEMA_NAME } from "./schema";
+
+/**
+ * ENSNode Metadata
+ *
+ * Possible key value pairs are defined by 'EnsNodeMetadata' type:
+ * - `EnsNodeMetadataEnsDbVersion`
+ * - `EnsNodeMetadataEnsIndexerPublicConfig`
+ * - `EnsNodeMetadataEnsIndexerIndexingStatus`
+ */
+export const ensNodeMetadata = ENSNODE_SCHEMA.table(
+  "ensnode_metadata",
+  (t) => ({
+    /**
+     * ENSIndexer Reference
+     *
+     * References the ENSIndexer instance by a unique ENSIndexer schema name
+     * that a metadata record is associated with. This allows us to support
+     * multiple ENSIndexer instances using the same database, while ensuring
+     * that their metadata records do not conflict with each other.
+     */
+    ensIndexerRef: t.text().notNull(),
+
+    /**
+     * Key
+     *
+     * Allowed keys:
+     * - `EnsNodeMetadataEnsDbVersion['key']`
+     * - `EnsNodeMetadataEnsIndexerPublicConfig['key']`
+     * - `EnsNodeMetadataEnsIndexerIndexingStatus['key']`
+     */
+    key: t.text().notNull(),
+
+    /**
+     * Value
+     *
+     * Allowed values:
+     * - `EnsNodeMetadataEnsDbVersion['value']`
+     * - `EnsNodeMetadataEnsIndexerPublicConfig['value']`
+     * - `EnsNodeMetadataEnsIndexerIndexingStatus['value']`
+     *
+     * Guaranteed to be a serialized representation of JSON object.
+     */
+    value: t.jsonb().notNull(),
+  }),
+  (table) => [
+    /**
+     * Primary key constraint on 'ensIndexerRef' and 'key' columns,
+     * to ensure that there is only one record for each key per ENSIndexer instance.
+     */
+    primaryKey({
+      name: "ensnode_metadata_pkey",
+      columns: [table.ensIndexerRef, table.key],
+    }),
+  ],
+);

packages/ensnode-schema/src/ensnode-schema/schema.ts

@@ -0,0 +1,5 @@
+import { pgSchema } from "drizzle-orm/pg-core";
+
+export const ENSNODE_SCHEMA_NAME = "ensnode";
+
+export const ENSNODE_SCHEMA = pgSchema(ENSNODE_SCHEMA_NAME);

packages/ensnode-schema/src/index.ts

@@ -0,0 +1,2 @@
+// Re-export relevant schema definitions for backward compatibility.
+export * from "./ensindexer-schema";

packages/ensnode-schema/src/ponder-schema/index.ts

@@ -0,0 +1,186 @@
+// This file defines tables for RPC request cache schema.
+// Relevant codebase was copied from Ponder Sync schema defined in the Ponder repository:
+// https://github.com/ponder-sh/ponder/blob/ponder%400.16.2/packages/core/src/sync-store/schema.ts
+
+/**
+ * RPC Request Cache Schema
+ *
+ * Defines the database objects for caching RPC requests and their results.
+ *
+ * This file defines tables for RPC request cache schema.
+ * Relevant codebase was copied from Ponder Sync schema defined in the Ponder repository.
+ * @see https://github.com/ponder-sh/ponder/blob/ponder%400.16.2/packages/core/src/sync-store/schema.ts
+ */
+
+import { customType, index, primaryKey } from "drizzle-orm/pg-core";
+import type { Address, Hash, Hex } from "viem";
+
+import { PONDER_SCHEMA } from "./schema";
+
+export { PONDER_SCHEMA_NAME } from "./schema";
+
+const numeric78 = customType<{ data: bigint; driverData: string }>({
+  dataType() {
+    return "numeric(78,0)";
+  },
+  fromDriver(value: string) {
+    return BigInt(value);
+  },
+});
+
+export const blocks = PONDER_SCHEMA.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_SCHEMA.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_SCHEMA.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_SCHEMA.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_SCHEMA.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_SCHEMA.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),
+  ],
+);

packages/ensnode-schema/src/ponder-schema/schema.ts

@@ -0,0 +1,5 @@
+import { pgSchema } from "drizzle-orm/pg-core";
+
+export const PONDER_SCHEMA_NAME = "ponder_sync";
+
+export const PONDER_SCHEMA = pgSchema(PONDER_SCHEMA_NAME);

packages/ensnode-schema/tsconfig.json

@@ -1,5 +1,8 @@
 {
-  "extends": "@ensnode/shared-configs/tsconfig.ponder.json",
+  "extends": "@ensnode/shared-configs/tsconfig.lib.json",
+  "compilerOptions": {
+    "rootDir": "." // necessary for 'The project root is ambiguous'
+  },
   "include": ["./**/*.ts"],
   "exclude": ["node_modules"]
 }