@ponder/client 0.9.0-next.1 → 0.9.0-next.3

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
+export { alias, except, exceptAll, intersect, intersectAll, union, unionAll } from 'drizzle-orm/pg-core';
 import { PgRemoteDatabase } from 'drizzle-orm/pg-proxy';
 export { and, asc, avg, avgDistinct, between, count, countDistinct, desc, eq, exists, gt, gte, inArray, isNotNull, isNull, like, lt, lte, max, min, ne, not, notBetween, notExists, notIlike, notInArray, or, relations, sql, sum, sumDistinct } from 'drizzle-orm';
-export { alias, except, exceptAll, intersect, intersectAll, union, unionAll } from 'drizzle-orm/pg-core';
 
 declare const setDatabaseSchema: <T extends {
     [name: string]: unknown;
@@ -12,11 +13,114 @@ type Schema = {
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
+type ClientDb<schema extends Schema = Schema> = Prettify<Omit<PgRemoteDatabase<schema>, "insert" | "update" | "delete" | "transaction" | "refreshMaterializedView" | "_">>;
 type Client<schema extends Schema = Schema> = {
-    db: Prettify<Omit<PgRemoteDatabase<schema>, "insert" | "update" | "delete" | "transaction" | "refreshMaterializedView" | "_">>;
+    /** Query the database. */
+    db: ClientDb<schema>;
+    /** Subscribe to live updates. */
+    live: <result>(query: (db: ClientDb<schema>) => Promise<result>, onData: (result: result) => void, onError?: (error: Error) => void) => {
+        unsubscribe: () => void;
+    };
 };
-declare const createClient: <schema extends Schema>(url: string, { schema }: {
+/**
+ * A table that tracks the status of each chain.
+ *
+ * @property {number} chainId - The chain ID.
+ * @property {number} blockNumber - The closest-to-tip indexed block number.
+ * @property {number} blockTimestamp - The closest-to-tip indexed block timestamp.
+ * @property {boolean} ready - `true` if the chain has completed the historical backfill.
+ */
+declare const status: drizzle_orm_pg_core.PgTableWithColumns<{
+    name: "_ponder_status";
+    schema: undefined;
+    columns: {
+        chainId: drizzle_orm_pg_core.PgColumn<{
+            name: "chainId";
+            tableName: "_ponder_status";
+            dataType: "number";
+            columnType: "PgBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        blockNumber: drizzle_orm_pg_core.PgColumn<{
+            name: "blockNumber";
+            tableName: "_ponder_status";
+            dataType: "number";
+            columnType: "PgBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        blockTimestamp: drizzle_orm_pg_core.PgColumn<{
+            name: "blockTimestamp";
+            tableName: "_ponder_status";
+            dataType: "number";
+            columnType: "PgBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        ready: drizzle_orm_pg_core.PgColumn<{
+            name: "ready";
+            tableName: "_ponder_status";
+            dataType: "boolean";
+            columnType: "PgBoolean";
+            data: boolean;
+            driverParam: boolean;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
+/**
+ * Create a client for querying Ponder apps.
+ *
+ * @param baseUrl - The URL of the Ponder app.
+ * @param schema - The schema of the Ponder app.
+ *
+ * @example
+ * ```ts
+ * import { createClient } from "@ponder/client";
+ * import * as schema from "../ponder.schema";
+ *
+ * const client = createClient("https://...", { schema });
+ * ```
+ */
+declare const createClient: <schema extends Schema>(baseUrl: string, { schema }: {
     schema: schema;
 }) => Client<schema>;
 
-export { type Client, createClient, setDatabaseSchema };
+export { type Client, createClient, setDatabaseSchema, status };

package/dist/index.js

@@ -1,7 +1,9 @@
 // src/index.ts
+import { sql } from "drizzle-orm";
+import { pgTable } from "drizzle-orm/pg-core";
 import { drizzle } from "drizzle-orm/pg-proxy";
 import {
-  sql,
+  sql as sql2,
   eq,
   gt,
   gte,
@@ -56,18 +58,109 @@ var setDatabaseSchema = (schema, schemaName) => {
 };
 
 // src/index.ts
-var createClient = (url, { schema }) => {
-  const db = drizzle(
-    async (sql2, params, method, typings) => {
-      const result = await fetch(`${url}/client`, {
-        method: "POST",
-        body: JSON.stringify({ sql: sql2, params, method, typings })
-      });
-      return await result.json();
-    },
-    { schema, casing: "snake_case" }
-  );
-  return { db };
+var getEventSource = async () => {
+  let SSE;
+  if (typeof window === "undefined") {
+    const undici = await import(
+      /* webpackIgnore: true */
+      "undici"
+    );
+    SSE = undici.EventSource;
+  } else {
+    SSE = EventSource;
+  }
+  return SSE;
+};
+var getUrl = (baseUrl, method, query) => {
+  const url = new URL(`${baseUrl}/client/${method}`);
+  if (query) {
+    url.searchParams.set("sql", JSON.stringify(query));
+  }
+  return url;
+};
+var status = pgTable("_ponder_status", (t) => ({
+  chainId: t.bigint({ mode: "number" }).primaryKey(),
+  blockNumber: t.bigint({ mode: "number" }),
+  blockTimestamp: t.bigint({ mode: "number" }),
+  ready: t.boolean().notNull()
+}));
+status[Symbol.for("ponder:onchain")] = true;
+var createClient = (baseUrl, { schema }) => {
+  const noopDatabase = drizzle(() => Promise.resolve({ rows: [] }), {
+    schema,
+    casing: "snake_case"
+  });
+  const dialect = noopDatabase.dialect;
+  const session = noopDatabase.session;
+  let sse;
+  let liveCount = 0;
+  const client = {
+    db: drizzle(
+      async (sql3, params, _, typings) => {
+        const builtQuery = { sql: sql3, params, typings };
+        const response = await fetch(getUrl(baseUrl, "db", builtQuery), {
+          method: "POST"
+        });
+        if (response.ok === false) {
+          const error = new Error(await response.text());
+          error.stack = void 0;
+          throw error;
+        }
+        const result = await response.json();
+        return {
+          ...result,
+          rows: result.rows.map((row) => Object.values(row))
+        };
+      },
+      { schema, casing: "snake_case" }
+    ),
+    live: (_query, onData, onError) => {
+      const query = _query(noopDatabase);
+      const sequel = typeof query === "string" ? sql.raw(query) : query.getSQL();
+      const builtQuery = dialect.sqlToQuery(sequel);
+      if (builtQuery.sql === 'select "chain_id", "block_number", "block_timestamp", "ready" from "_ponder_status"' && builtQuery.params.length === 0) {
+        const addEventListeners = () => {
+          sse.addEventListener("message", (event) => {
+            const data = JSON.parse(event.data);
+            if (data.status === "error") {
+              const error = new Error(data.error);
+              error.stack = void 0;
+              onError?.(error);
+            } else {
+              onData(data.result);
+            }
+          });
+          sse.addEventListener("error", () => {
+            onError?.(new Error("server disconnected"));
+          });
+        };
+        liveCount++;
+        if (sse === void 0) {
+          getEventSource().then((SSE) => {
+            sse = new SSE(getUrl(baseUrl, "live"));
+            addEventListeners();
+          });
+        } else {
+          addEventListeners();
+        }
+        return {
+          unsubscribe: () => {
+            if (--liveCount === 0)
+              sse?.close();
+          }
+        };
+      } else {
+        return client.live(
+          (db) => db.select().from(status),
+          () => {
+            _query(client.db).then(onData).catch(onError);
+          },
+          onError
+        );
+      }
+    }
+  };
+  return client;
 };
 export {
   alias,
@@ -105,7 +198,8 @@ export {
   or,
   relations,
   setDatabaseSchema,
-  sql,
+  sql2 as sql,
+  status,
   sum,
   sumDistinct,
   union,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/setDatabaseSchema.ts"],"sourcesContent":["import { type PgRemoteDatabase, drizzle } from \"drizzle-orm/pg-proxy\";\n\ntype Schema = { [name: string]: unknown };\n\ntype Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport type Client<schema extends Schema = Schema> = {\n  db: Prettify<\n    Omit<\n      PgRemoteDatabase<schema>,\n      | \"insert\"\n      | \"update\"\n      | \"delete\"\n      | \"transaction\"\n      | \"refreshMaterializedView\"\n      | \"_\"\n    >\n  >;\n};\n\nexport const createClient = <schema extends Schema>(\n  url: string,\n  { schema }: { schema: schema },\n): Client<schema> => {\n  const db = drizzle(\n    async (sql, params, method, typings) => {\n      const result = await fetch(`${url}/client`, {\n        method: \"POST\",\n        body: JSON.stringify({ sql, params, method, typings }),\n      });\n\n      return await result.json();\n    },\n    { schema, casing: \"snake_case\" },\n  );\n\n  return { db };\n};\n\nexport {\n  sql,\n  eq,\n  gt,\n  gte,\n  lt,\n  lte,\n  ne,\n  isNull,\n  isNotNull,\n  inArray,\n  notInArray,\n  exists,\n  notExists,\n  between,\n  notBetween,\n  like,\n  notIlike,\n  not,\n  asc,\n  desc,\n  and,\n  or,\n  count,\n  countDistinct,\n  avg,\n  avgDistinct,\n  sum,\n  sumDistinct,\n  max,\n  min,\n  relations,\n} from \"drizzle-orm\";\n\nexport {\n  alias,\n  union,\n  unionAll,\n  intersect,\n  intersectAll,\n  except,\n  exceptAll,\n} from \"drizzle-orm/pg-core\";\n\nexport { setDatabaseSchema } from \"./setDatabaseSchema.js\";\n","import { Table, is } from \"drizzle-orm\";\n\nconst Schema = Symbol.for(\"drizzle:Schema\");\n\nexport const setDatabaseSchema = <T extends { [name: string]: unknown }>(\n  schema: T,\n  schemaName: string,\n): T => {\n  for (const table of Object.values(schema)) {\n    if (is(table, Table)) {\n      // @ts-ignore\n      table[Schema] = schemaName;\n    }\n  }\n  return schema;\n};\n"],"mappings":";AAAA,SAAgC,eAAe;AAyC/C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACnFP,SAAS,OAAO,UAAU;AAE1B,IAAM,SAAS,OAAO,IAAI,gBAAgB;AAEnC,IAAM,oBAAoB,CAC/B,QACA,eACM;AACN,aAAW,SAAS,OAAO,OAAO,MAAM,GAAG;AACzC,QAAI,GAAG,OAAO,KAAK,GAAG;AAEpB,YAAM,MAAM,IAAI;AAAA,IAClB;AAAA,EACF;AACA,SAAO;AACT;;;ADOO,IAAM,eAAe,CAC1B,KACA,EAAE,OAAO,MACU;AACnB,QAAM,KAAK;AAAA,IACT,OAAOA,MAAK,QAAQ,QAAQ,YAAY;AACtC,YAAM,SAAS,MAAM,MAAM,GAAG,GAAG,WAAW;AAAA,QAC1C,QAAQ;AAAA,QACR,MAAM,KAAK,UAAU,EAAE,KAAAA,MAAK,QAAQ,QAAQ,QAAQ,CAAC;AAAA,MACvD,CAAC;AAED,aAAO,MAAM,OAAO,KAAK;AAAA,IAC3B;AAAA,IACA,EAAE,QAAQ,QAAQ,aAAa;AAAA,EACjC;AAEA,SAAO,EAAE,GAAG;AACd;","names":["sql"]}
+{"version":3,"sources":["../src/index.ts","../src/setDatabaseSchema.ts"],"sourcesContent":["import { type QueryWithTypings, type SQLWrapper, sql } from \"drizzle-orm\";\nimport { type PgDialect, type PgSession, pgTable } from \"drizzle-orm/pg-core\";\nimport { type PgRemoteDatabase, drizzle } from \"drizzle-orm/pg-proxy\";\n\nconst getEventSource = async () => {\n  let SSE: typeof EventSource;\n  if (typeof window === \"undefined\") {\n    const undici = await import(/* webpackIgnore: true */ \"undici\");\n    // @ts-ignore\n    SSE = undici.EventSource;\n  } else {\n    SSE = EventSource;\n  }\n\n  return SSE;\n};\n\ntype Schema = { [name: string]: unknown };\n\ntype Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\ntype ClientDb<schema extends Schema = Schema> = Prettify<\n  Omit<\n    PgRemoteDatabase<schema>,\n    | \"insert\"\n    | \"update\"\n    | \"delete\"\n    | \"transaction\"\n    | \"refreshMaterializedView\"\n    | \"_\"\n  >\n>;\n\nexport type Client<schema extends Schema = Schema> = {\n  /** Query the database. */\n  db: ClientDb<schema>;\n  /** Subscribe to live updates. */\n  live: <result>(\n    query: (db: ClientDb<schema>) => Promise<result>,\n    onData: (result: result) => void,\n    onError?: (error: Error) => void,\n  ) => {\n    unsubscribe: () => void;\n  };\n};\n\nconst getUrl = (\n  baseUrl: string,\n  method: \"live\" | \"db\" | \"status\",\n  query?: QueryWithTypings,\n) => {\n  const url = new URL(`${baseUrl}/client/${method}`);\n  if (query) {\n    url.searchParams.set(\"sql\", JSON.stringify(query));\n  }\n  return url;\n};\n\n/**\n * A table that tracks the status of each chain.\n *\n * @property {number} chainId - The chain ID.\n * @property {number} blockNumber - The closest-to-tip indexed block number.\n * @property {number} blockTimestamp - The closest-to-tip indexed block timestamp.\n * @property {boolean} ready - `true` if the chain has completed the historical backfill.\n */\nexport const status = pgTable(\"_ponder_status\", (t) => ({\n  chainId: t.bigint({ mode: \"number\" }).primaryKey(),\n  blockNumber: t.bigint({ mode: \"number\" }),\n  blockTimestamp: t.bigint({ mode: \"number\" }),\n  ready: t.boolean().notNull(),\n}));\n\n// @ts-ignore\nstatus[Symbol.for(\"ponder:onchain\")] = true;\n\n/**\n * Create a client for querying Ponder apps.\n *\n * @param baseUrl - The URL of the Ponder app.\n * @param schema - The schema of the Ponder app.\n *\n * @example\n * ```ts\n * import { createClient } from \"@ponder/client\";\n * import * as schema from \"../ponder.schema\";\n *\n * const client = createClient(\"https://...\", { schema });\n * ```\n */\nexport const createClient = <schema extends Schema>(\n  baseUrl: string,\n  { schema }: { schema: schema },\n): Client<schema> => {\n  const noopDatabase = drizzle(() => Promise.resolve({ rows: [] }), {\n    schema,\n    casing: \"snake_case\",\n  });\n\n  // @ts-ignore\n  const dialect: PgDialect = noopDatabase.dialect;\n  // @ts-ignore\n  const session: PgSession = noopDatabase.session;\n\n  let sse: EventSource | undefined;\n  let liveCount = 0;\n\n  const client: Client<schema> = {\n    db: drizzle(\n      async (sql, params, _, typings) => {\n        const builtQuery = { sql, params, typings };\n        const response = await fetch(getUrl(baseUrl, \"db\", builtQuery), {\n          method: \"POST\",\n        });\n\n        if (response.ok === false) {\n          const error = new Error(await response.text());\n          error.stack = undefined;\n          throw error;\n        }\n\n        const result = await response.json();\n\n        return {\n          ...result,\n          rows: result.rows.map((row: object) => Object.values(row)),\n        };\n      },\n      { schema, casing: \"snake_case\" },\n    ),\n    live: (_query, onData, onError) => {\n      // https://github.com/drizzle-team/drizzle-orm/blob/04c91434c7ac10aeb2923efd1d19a7ebf10ea9d4/drizzle-orm/src/pg-core/db.ts#L602-L621\n\n      const query = _query(noopDatabase) as unknown as SQLWrapper | string;\n      const sequel =\n        typeof query === \"string\" ? sql.raw(query) : query.getSQL();\n      const builtQuery = dialect.sqlToQuery(sequel);\n\n      if (\n        builtQuery.sql ===\n          'select \"chain_id\", \"block_number\", \"block_timestamp\", \"ready\" from \"_ponder_status\"' &&\n        builtQuery.params.length === 0\n      ) {\n        const addEventListeners = () => {\n          sse!.addEventListener(\"message\", (event) => {\n            const data = JSON.parse(event.data) as\n              | { status: \"success\"; result: unknown }\n              | { status: \"error\"; error: string };\n\n            if (data.status === \"error\") {\n              const error = new Error(data.error);\n              error.stack = undefined;\n              onError?.(error);\n            } else {\n              // @ts-ignore\n              onData(data.result);\n            }\n          });\n\n          sse!.addEventListener(\"error\", () => {\n            onError?.(new Error(\"server disconnected\"));\n          });\n        };\n\n        liveCount++;\n        if (sse === undefined) {\n          getEventSource().then((SSE) => {\n            sse = new SSE(getUrl(baseUrl, \"live\"));\n            addEventListeners();\n          });\n        } else {\n          addEventListeners();\n        }\n\n        return {\n          unsubscribe: () => {\n            if (--liveCount === 0) sse?.close();\n          },\n        };\n      } else {\n        return client.live(\n          (db) => db.select().from(status),\n          () => {\n            _query(client.db).then(onData).catch(onError);\n          },\n          onError,\n        );\n      }\n    },\n  };\n\n  return client;\n};\n\nexport {\n  sql,\n  eq,\n  gt,\n  gte,\n  lt,\n  lte,\n  ne,\n  isNull,\n  isNotNull,\n  inArray,\n  notInArray,\n  exists,\n  notExists,\n  between,\n  notBetween,\n  like,\n  notIlike,\n  not,\n  asc,\n  desc,\n  and,\n  or,\n  count,\n  countDistinct,\n  avg,\n  avgDistinct,\n  sum,\n  sumDistinct,\n  max,\n  min,\n  relations,\n} from \"drizzle-orm\";\n\nexport {\n  alias,\n  union,\n  unionAll,\n  intersect,\n  intersectAll,\n  except,\n  exceptAll,\n} from \"drizzle-orm/pg-core\";\n\nexport { setDatabaseSchema } from \"./setDatabaseSchema.js\";\n","import { Table, is } from \"drizzle-orm\";\n\nconst Schema = Symbol.for(\"drizzle:Schema\");\n\nexport const setDatabaseSchema = <T extends { [name: string]: unknown }>(\n  schema: T,\n  schemaName: string,\n): T => {\n  for (const table of Object.values(schema)) {\n    if (is(table, Table)) {\n      // @ts-ignore\n      table[Schema] = schemaName;\n    }\n  }\n  return schema;\n};\n"],"mappings":";AAAA,SAAiD,WAAW;AAC5D,SAAyC,eAAe;AACxD,SAAgC,eAAe;AAkM/C;AAAA,EACE,OAAAA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;AC9OP,SAAS,OAAO,UAAU;AAE1B,IAAM,SAAS,OAAO,IAAI,gBAAgB;AAEnC,IAAM,oBAAoB,CAC/B,QACA,eACM;AACN,aAAW,SAAS,OAAO,OAAO,MAAM,GAAG;AACzC,QAAI,GAAG,OAAO,KAAK,GAAG;AAEpB,YAAM,MAAM,IAAI;AAAA,IAClB;AAAA,EACF;AACA,SAAO;AACT;;;ADXA,IAAM,iBAAiB,YAAY;AACjC,MAAI;AACJ,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,SAAS,MAAM;AAAA;AAAA,MAAiC;AAAA,IAAQ;AAE9D,UAAM,OAAO;AAAA,EACf,OAAO;AACL,UAAM;AAAA,EACR;AAEA,SAAO;AACT;AAiCA,IAAM,SAAS,CACb,SACA,QACA,UACG;AACH,QAAM,MAAM,IAAI,IAAI,GAAG,OAAO,WAAW,MAAM,EAAE;AACjD,MAAI,OAAO;AACT,QAAI,aAAa,IAAI,OAAO,KAAK,UAAU,KAAK,CAAC;AAAA,EACnD;AACA,SAAO;AACT;AAUO,IAAM,SAAS,QAAQ,kBAAkB,CAAC,OAAO;AAAA,EACtD,SAAS,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC,EAAE,WAAW;AAAA,EACjD,aAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAAA,EACxC,gBAAgB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAAA,EAC3C,OAAO,EAAE,QAAQ,EAAE,QAAQ;AAC7B,EAAE;AAGF,OAAO,OAAO,IAAI,gBAAgB,CAAC,IAAI;AAgBhC,IAAM,eAAe,CAC1B,SACA,EAAE,OAAO,MACU;AACnB,QAAM,eAAe,QAAQ,MAAM,QAAQ,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG;AAAA,IAChE;AAAA,IACA,QAAQ;AAAA,EACV,CAAC;AAGD,QAAM,UAAqB,aAAa;AAExC,QAAM,UAAqB,aAAa;AAExC,MAAI;AACJ,MAAI,YAAY;AAEhB,QAAM,SAAyB;AAAA,IAC7B,IAAI;AAAA,MACF,OAAOC,MAAK,QAAQ,GAAG,YAAY;AACjC,cAAM,aAAa,EAAE,KAAAA,MAAK,QAAQ,QAAQ;AAC1C,cAAM,WAAW,MAAM,MAAM,OAAO,SAAS,MAAM,UAAU,GAAG;AAAA,UAC9D,QAAQ;AAAA,QACV,CAAC;AAED,YAAI,SAAS,OAAO,OAAO;AACzB,gBAAM,QAAQ,IAAI,MAAM,MAAM,SAAS,KAAK,CAAC;AAC7C,gBAAM,QAAQ;AACd,gBAAM;AAAA,QACR;AAEA,cAAM,SAAS,MAAM,SAAS,KAAK;AAEnC,eAAO;AAAA,UACL,GAAG;AAAA,UACH,MAAM,OAAO,KAAK,IAAI,CAAC,QAAgB,OAAO,OAAO,GAAG,CAAC;AAAA,QAC3D;AAAA,MACF;AAAA,MACA,EAAE,QAAQ,QAAQ,aAAa;AAAA,IACjC;AAAA,IACA,MAAM,CAAC,QAAQ,QAAQ,YAAY;AAGjC,YAAM,QAAQ,OAAO,YAAY;AACjC,YAAM,SACJ,OAAO,UAAU,WAAW,IAAI,IAAI,KAAK,IAAI,MAAM,OAAO;AAC5D,YAAM,aAAa,QAAQ,WAAW,MAAM;AAE5C,UACE,WAAW,QACT,yFACF,WAAW,OAAO,WAAW,GAC7B;AACA,cAAM,oBAAoB,MAAM;AAC9B,cAAK,iBAAiB,WAAW,CAAC,UAAU;AAC1C,kBAAM,OAAO,KAAK,MAAM,MAAM,IAAI;AAIlC,gBAAI,KAAK,WAAW,SAAS;AAC3B,oBAAM,QAAQ,IAAI,MAAM,KAAK,KAAK;AAClC,oBAAM,QAAQ;AACd,wBAAU,KAAK;AAAA,YACjB,OAAO;AAEL,qBAAO,KAAK,MAAM;AAAA,YACpB;AAAA,UACF,CAAC;AAED,cAAK,iBAAiB,SAAS,MAAM;AACnC,sBAAU,IAAI,MAAM,qBAAqB,CAAC;AAAA,UAC5C,CAAC;AAAA,QACH;AAEA;AACA,YAAI,QAAQ,QAAW;AACrB,yBAAe,EAAE,KAAK,CAAC,QAAQ;AAC7B,kBAAM,IAAI,IAAI,OAAO,SAAS,MAAM,CAAC;AACrC,8BAAkB;AAAA,UACpB,CAAC;AAAA,QACH,OAAO;AACL,4BAAkB;AAAA,QACpB;AAEA,eAAO;AAAA,UACL,aAAa,MAAM;AACjB,gBAAI,EAAE,cAAc;AAAG,mBAAK,MAAM;AAAA,UACpC;AAAA,QACF;AAAA,MACF,OAAO;AACL,eAAO,OAAO;AAAA,UACZ,CAAC,OAAO,GAAG,OAAO,EAAE,KAAK,MAAM;AAAA,UAC/B,MAAM;AACJ,mBAAO,OAAO,EAAE,EAAE,KAAK,MAAM,EAAE,MAAM,OAAO;AAAA,UAC9C;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["sql","sql"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ponder/client",
-  "version": "0.9.0-next.1",
+  "version": "0.9.0-next.3",
   "description": "",
   "license": "MIT",
   "type": "module",
@@ -26,6 +26,9 @@
       "import": "./dist/index.js"
     }
   },
+  "browser": {
+    "undici": false
+  },
   "peerDependencies": {
     "typescript": ">=5.0.4"
   },
@@ -35,7 +38,8 @@
     }
   },
   "dependencies": {
-    "drizzle-orm": "0.36.4"
+    "drizzle-orm": "0.36.4",
+    "undici": "^7.2.0"
   },
   "devDependencies": {
     "tsup": "^8.0.1"

package/src/index.ts

@@ -1,42 +1,197 @@
+import { type QueryWithTypings, type SQLWrapper, sql } from "drizzle-orm";
+import { type PgDialect, type PgSession, pgTable } from "drizzle-orm/pg-core";
 import { type PgRemoteDatabase, drizzle } from "drizzle-orm/pg-proxy";
 
+const getEventSource = async () => {
+  let SSE: typeof EventSource;
+  if (typeof window === "undefined") {
+    const undici = await import(/* webpackIgnore: true */ "undici");
+    // @ts-ignore
+    SSE = undici.EventSource;
+  } else {
+    SSE = EventSource;
+  }
+
+  return SSE;
+};
+
 type Schema = { [name: string]: unknown };
 
 type Prettify<T> = {
   [K in keyof T]: T[K];
 } & {};
 
+type ClientDb<schema extends Schema = Schema> = Prettify<
+  Omit<
+    PgRemoteDatabase<schema>,
+    | "insert"
+    | "update"
+    | "delete"
+    | "transaction"
+    | "refreshMaterializedView"
+    | "_"
+  >
+>;
+
 export type Client<schema extends Schema = Schema> = {
-  db: Prettify<
-    Omit<
-      PgRemoteDatabase<schema>,
-      | "insert"
-      | "update"
-      | "delete"
-      | "transaction"
-      | "refreshMaterializedView"
-      | "_"
-    >
-  >;
+  /** Query the database. */
+  db: ClientDb<schema>;
+  /** Subscribe to live updates. */
+  live: <result>(
+    query: (db: ClientDb<schema>) => Promise<result>,
+    onData: (result: result) => void,
+    onError?: (error: Error) => void,
+  ) => {
+    unsubscribe: () => void;
+  };
+};
+
+const getUrl = (
+  baseUrl: string,
+  method: "live" | "db" | "status",
+  query?: QueryWithTypings,
+) => {
+  const url = new URL(`${baseUrl}/client/${method}`);
+  if (query) {
+    url.searchParams.set("sql", JSON.stringify(query));
+  }
+  return url;
 };
 
+/**
+ * A table that tracks the status of each chain.
+ *
+ * @property {number} chainId - The chain ID.
+ * @property {number} blockNumber - The closest-to-tip indexed block number.
+ * @property {number} blockTimestamp - The closest-to-tip indexed block timestamp.
+ * @property {boolean} ready - `true` if the chain has completed the historical backfill.
+ */
+export const status = pgTable("_ponder_status", (t) => ({
+  chainId: t.bigint({ mode: "number" }).primaryKey(),
+  blockNumber: t.bigint({ mode: "number" }),
+  blockTimestamp: t.bigint({ mode: "number" }),
+  ready: t.boolean().notNull(),
+}));
+
+// @ts-ignore
+status[Symbol.for("ponder:onchain")] = true;
+
+/**
+ * Create a client for querying Ponder apps.
+ *
+ * @param baseUrl - The URL of the Ponder app.
+ * @param schema - The schema of the Ponder app.
+ *
+ * @example
+ * ```ts
+ * import { createClient } from "@ponder/client";
+ * import * as schema from "../ponder.schema";
+ *
+ * const client = createClient("https://...", { schema });
+ * ```
+ */
 export const createClient = <schema extends Schema>(
-  url: string,
+  baseUrl: string,
   { schema }: { schema: schema },
 ): Client<schema> => {
-  const db = drizzle(
-    async (sql, params, method, typings) => {
-      const result = await fetch(`${url}/client`, {
-        method: "POST",
-        body: JSON.stringify({ sql, params, method, typings }),
-      });
-
-      return await result.json();
+  const noopDatabase = drizzle(() => Promise.resolve({ rows: [] }), {
+    schema,
+    casing: "snake_case",
+  });
+
+  // @ts-ignore
+  const dialect: PgDialect = noopDatabase.dialect;
+  // @ts-ignore
+  const session: PgSession = noopDatabase.session;
+
+  let sse: EventSource | undefined;
+  let liveCount = 0;
+
+  const client: Client<schema> = {
+    db: drizzle(
+      async (sql, params, _, typings) => {
+        const builtQuery = { sql, params, typings };
+        const response = await fetch(getUrl(baseUrl, "db", builtQuery), {
+          method: "POST",
+        });
+
+        if (response.ok === false) {
+          const error = new Error(await response.text());
+          error.stack = undefined;
+          throw error;
+        }
+
+        const result = await response.json();
+
+        return {
+          ...result,
+          rows: result.rows.map((row: object) => Object.values(row)),
+        };
+      },
+      { schema, casing: "snake_case" },
+    ),
+    live: (_query, onData, onError) => {
+      // https://github.com/drizzle-team/drizzle-orm/blob/04c91434c7ac10aeb2923efd1d19a7ebf10ea9d4/drizzle-orm/src/pg-core/db.ts#L602-L621
+
+      const query = _query(noopDatabase) as unknown as SQLWrapper | string;
+      const sequel =
+        typeof query === "string" ? sql.raw(query) : query.getSQL();
+      const builtQuery = dialect.sqlToQuery(sequel);
+
+      if (
+        builtQuery.sql ===
+          'select "chain_id", "block_number", "block_timestamp", "ready" from "_ponder_status"' &&
+        builtQuery.params.length === 0
+      ) {
+        const addEventListeners = () => {
+          sse!.addEventListener("message", (event) => {
+            const data = JSON.parse(event.data) as
+              | { status: "success"; result: unknown }
+              | { status: "error"; error: string };
+
+            if (data.status === "error") {
+              const error = new Error(data.error);
+              error.stack = undefined;
+              onError?.(error);
+            } else {
+              // @ts-ignore
+              onData(data.result);
+            }
+          });
+
+          sse!.addEventListener("error", () => {
+            onError?.(new Error("server disconnected"));
+          });
+        };
+
+        liveCount++;
+        if (sse === undefined) {
+          getEventSource().then((SSE) => {
+            sse = new SSE(getUrl(baseUrl, "live"));
+            addEventListeners();
+          });
+        } else {
+          addEventListeners();
+        }
+
+        return {
+          unsubscribe: () => {
+            if (--liveCount === 0) sse?.close();
+          },
+        };
+      } else {
+        return client.live(
+          (db) => db.select().from(status),
+          () => {
+            _query(client.db).then(onData).catch(onError);
+          },
+          onError,
+        );
+      }
     },
-    { schema, casing: "snake_case" },
-  );
+  };
 
-  return { db };
+  return client;
 };
 
 export {