WIP ENSDb migrations

.changeset/big-impalas-brush.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": minor
+---
+
+Extended `EnsDbClient` with `EnsDbClientMigration` interface implementation.

.changeset/humble-pets-trade.md

@@ -0,0 +1,5 @@
+---
+"ensapi": minor
+---
+
+Replaced ENSIndexer Public Config source, from ENSIndexer to ENSDb.

.changeset/petite-peaches-watch.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensnode-schema": minor
+---
+
+Split database schemas into Ponder Schema, ENSIndexer Schema, and ENSNode Schema.

.changeset/seven-hands-ask.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensnode-sdk": minor
+---
+
+Introduced `EnsDbClientMigration` interface.

.changeset/silly-bats-smell.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": minor
+---
+
+Introduced database migration toolkit based on `drizzle-kit`.

.changeset/vast-comics-burn.md

@@ -0,0 +1,5 @@
+---
+"ensapi": minor
+---
+
+Updated ENSDb connections to be always read-only.

apps/ensapi/src/lib/db.ts

@@ -1,11 +1,22 @@
 import config from "@/config";
 
-import * as schema from "@ensnode/ensnode-schema";
+import { EnsIndexerDbReader } from "@ensnode/ensnode-schema";
 
-import { makeDrizzle } from "@/lib/handlers/drizzle";
+// TODO: pending rename `config.databaseUrl` to `config.ensDbUrl`
+// Will be executed once https://github.com/namehash/ensnode/issues/1763 is resolved.
+const ensDbUrl = config.databaseUrl;
+// TODO: pending rename `config.databaseSchemaName` to `config.ensIndexerSchemaName`
+// Will be executed once https://github.com/namehash/ensnode/issues/1762 is resolved.
+const ensIndexerSchemaName = config.databaseSchemaName;
 
-export const db = makeDrizzle({
-  databaseUrl: config.databaseUrl,
-  databaseSchema: config.databaseSchemaName,
-  schema,
-});
+const ensIndexerDbReader = new EnsIndexerDbReader(ensDbUrl, ensIndexerSchemaName);
+
+/**
+ * Read-only Drizzle instance for queries to ENSIndexer Schema in ENSDb.
+ */
+export const ensIndexerDbReadonly = ensIndexerDbReader.db;
+
+/**
+ * Read-only Drizzle instance for queries to ENSIndexer Schema in ENSDb.
+ */
+export const db = ensIndexerDbReadonly;

apps/ensapi/src/lib/handlers/drizzle.ts

@@ -1,5 +1,6 @@
 import { setDatabaseSchema } from "@ponder/client";
 import { drizzle } from "drizzle-orm/node-postgres";
+import { parseIntoClientConfig } from "pg-connection-string";
 
 import { makeLogger } from "@/lib/logger";
 
@@ -8,21 +9,32 @@ type Schema = { [name: string]: unknown };
 const logger = makeLogger("drizzle");
 
 /**
- * Makes a Drizzle DB object.
+ * Makes a read-only Drizzle DB object.
  */
-export const makeDrizzle = <SCHEMA extends Schema>({
+export const makeReadOnlyDrizzle = <SCHEMA extends Schema>({
   schema,
   databaseUrl,
   databaseSchema,
 }: {
   schema: SCHEMA;
   databaseUrl: string;
-  databaseSchema: string;
+  databaseSchema?: string;
 }) => {
-  // monkeypatch schema onto tables
-  setDatabaseSchema(schema, databaseSchema);
+  // monkeypatch schema onto tables if databaseSchema is provided
+  if (databaseSchema) {
+    setDatabaseSchema(schema, databaseSchema);
+  }
 
-  return drizzle(databaseUrl, {
+  const parsedConfig = parseIntoClientConfig(databaseUrl);
+  const existingOptions = parsedConfig.options || "";
+  const readOnlyOption = "-c default_transaction_read_only=on";
+
+  return drizzle({
+    connection: {
+      ...parsedConfig,
+      // Combine existing options from URL with read-only requirement
+      options: existingOptions ? `${existingOptions} ${readOnlyOption}` : readOnlyOption,
+    },
     schema,
     casing: "snake_case",
     logger: {

apps/ensindexer/drizzle-kit/config.ts

@@ -0,0 +1,13 @@
+import { fileURLToPath } from "node:url";
+
+import { defineConfig } from "drizzle-kit";
+
+// Resolve the path to the database schema file for Drizzle migrations.
+const dbSchemaPath = fileURLToPath(new URL("./schema.ts", import.meta.url));
+
+export default defineConfig({
+  casing: "snake_case",
+  dialect: "postgresql",
+  out: `drizzle-kit/migrations`,
+  schema: dbSchemaPath,
+});

apps/ensindexer/drizzle-kit/migrations/0000_certain_slyde.sql

@@ -0,0 +1,8 @@
+CREATE SCHEMA IF NOT EXISTS ensnode;
+
+CREATE TABLE "ensnode"."ensnode_metadata" (
+	"ens_indexer_schema_name" text NOT NULL,
+	"key" text NOT NULL,
+	"value" jsonb NOT NULL,
+	CONSTRAINT "ensnode_metadata_pkey" PRIMARY KEY("ens_indexer_schema_name","key")
+);

apps/ensindexer/drizzle-kit/migrations/meta/0000_snapshot.json

@@ -0,0 +1,58 @@
+{
+  "id": "033e8b27-4739-4da9-b9da-517b0c2700d7",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "ensnode.ensnode_metadata": {
+      "name": "ensnode_metadata",
+      "schema": "ensnode",
+      "columns": {
+        "ens_indexer_schema_name": {
+          "name": "ens_indexer_schema_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "key": {
+          "name": "key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "value": {
+          "name": "value",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {
+        "ensnode_metadata_pkey": {
+          "name": "ensnode_metadata_pkey",
+          "columns": [
+            "ens_indexer_schema_name",
+            "key"
+          ]
+        }
+      },
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

apps/ensindexer/drizzle-kit/migrations/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1773421837301,
+      "tag": "0000_certain_slyde",
+      "breakpoints": true
+    }
+  ]
+}

apps/ensindexer/drizzle-kit/schema.ts

@@ -0,0 +1,2 @@
+// Re-export the ENSNode schema for Drizzle migrations.
+export * from "@ensnode/ensnode-schema/ensnode";

apps/ensindexer/package.json

@@ -20,7 +20,8 @@
     "test": "vitest",
     "lint": "biome check --write .",
     "lint:ci": "biome ci",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "drizzle-gen": "drizzle-kit generate --config ./drizzle-kit/config.ts"
   },
   "dependencies": {
     "@ensdomains/ensjs": "^4.0.2",
@@ -47,6 +48,7 @@
     "@types/dns-packet": "^5.6.5",
     "@types/node": "catalog:",
     "@types/pg": "8.16.0",
+    "drizzle-kit": "0.31.9",
     "typescript": "catalog:",
     "vitest": "catalog:"
   }

apps/ensindexer/ponder/ponder.schema.ts

@@ -1,2 +1,2 @@
-// export the shared ponder schema
-export * from "@ensnode/ensnode-schema";
+// export the ENSIndexer schema for Ponder to use when indexing data
+export * from "@ensnode/ensnode-schema/ensindexer";

apps/ensindexer/ponder/src/api/handlers/ensnode-api.ts

@@ -10,13 +10,13 @@ import {
   serializeIndexingStatusResponse,
 } from "@ensnode/ensnode-sdk";
 
-import { ensDbClient } from "@/lib/ensdb-client/singleton";
+import { ensNodeDbWriter } from "@/lib/ensdb-client/singleton";
 
 const app = new Hono();
 
 // include ENSIndexer Public Config endpoint
 app.get("/config", async (c) => {
-  const publicConfig = await ensDbClient.getEnsIndexerPublicConfig();
+  const publicConfig = await ensNodeDbWriter.getEnsIndexerPublicConfig();
 
   // Invariant: the public config is guaranteed to be available in ENSDb after
   // application startup.
@@ -30,7 +30,7 @@ app.get("/config", async (c) => {
 
 app.get("/indexing-status", async (c) => {
   try {
-    const crossChainSnapshot = await ensDbClient.getIndexingStatusSnapshot();
+    const crossChainSnapshot = await ensNodeDbWriter.getIndexingStatusSnapshot();
 
     // Invariant: the Indexing Status Snapshot is expected to be available in
     // ENSDb shortly after application startup. There is a possibility that