@ensnode/ponder-subgraph 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 NameHash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Ponder Subgraph API
+
+Ponder Subgraph API is a Hono middleware for generating Subgraph-compatible GraphQL schema.

package/dist/graphql.d.ts

@@ -0,0 +1,65 @@
+import { NodePgDatabase } from 'drizzle-orm/node-postgres';
+import { PgliteDatabase } from 'drizzle-orm/pglite';
+import DataLoader from 'dataloader';
+import { TableRelationalConfig } from 'drizzle-orm';
+import { TableConfig, PgTableExtraConfig, PgTable } from 'drizzle-orm/pg-core';
+import { GraphQLSchema } from 'graphql';
+
+/**
+ * This is a graphql schema generated from a drizzle (sql) schema, initially based on ponder's.
+ * https://github.com/ponder-sh/ponder/blob/main/packages/core/src/graphql/index.ts
+ *
+ * Its goal is to mimic the subgraph graphql api for queries we've deemed relevant (see docs).
+ *
+ * 1. inlines some ponder internal types
+ * 2. implement subgraph's simpler offset pagination with first & skip w/out Page types
+ * 3. PascalCase entity names
+ * 4. Polymorphic Interfaces
+ * 5. lower-case and/or filters
+ * 6. relation id shorthand filters (i.e. domains(where: { owner_id: String }))
+ * 7. sortable id columns
+ * 8. temporarily ignores column normalization that was fixed in
+ *    https://github.com/ponder-sh/ponder/pull/1517/files
+ */
+
+type Drizzle<TSchema extends Schema = {
+    [name: string]: never;
+}> = NodePgDatabase<TSchema> | PgliteDatabase<TSchema>;
+type Schema = {
+    [name: string]: unknown;
+};
+declare const onchain: unique symbol;
+type OnchainTable<T extends TableConfig & {
+    extra: PgTableExtraConfig | undefined;
+} = TableConfig & {
+    extra: PgTableExtraConfig | undefined;
+}> = PgTable<T> & {
+    [Key in keyof T["columns"]]: T["columns"][Key];
+} & {
+    [onchain]: true;
+} & {
+    enableRLS: () => Omit<OnchainTable<T>, "enableRLS">;
+};
+
+/**
+ * the following type describes:
+ * 1. `types` — mapping a polymorphic type name to the set of entities that implement that interface
+ *   ex: DomainEvent -> [TransferEvent, ...]
+ * 2. `fields` — mapping a typeName to the polymorphic type it represents
+ *   ex: Domain.events -> DomainEvent
+ *
+ * NOTE: in future implementations of ponder, this information could be provided by the schema
+ * using materialized views, and most/all of this code can be removed.
+ */
+interface PolymorphicConfig {
+    types: Record<string, PgTable<TableConfig>[]>;
+    fields: Record<string, string>;
+}
+declare function buildGraphQLSchema(_schema: Schema, polymorphicConfig?: PolymorphicConfig): GraphQLSchema;
+declare function buildDataLoaderCache({ drizzle }: {
+    drizzle: Drizzle<Schema>;
+}): ({ table }: {
+    table: TableRelationalConfig;
+}) => DataLoader<string, any, string>;
+
+export { type Drizzle, type OnchainTable, type PolymorphicConfig, type Schema, buildDataLoaderCache, buildGraphQLSchema, onchain };