@ensnode/ensdb-sdk 1.9.0 → 1.10.1

package/dist/{index-CUYtpVSw.d.ts → index-DN0SGSyd.d.ts}

@@ -1,7 +1,7 @@
 import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 import * as drizzle_orm from 'drizzle-orm';
 import * as ponder from 'ponder';
-import { DomainId, InterpretedLabel, PermissionsId, PermissionsResourceId, PermissionsUserId, RegistrationId, RegistryId, ENSv2DomainId, RenewalId, ResolverId, ENSv1DomainId, ResolverRecordsId } from '@ensnode/ensnode-sdk';
+import { DomainId, InterpretedLabel, PermissionsId, PermissionsResourceId, PermissionsUserId, RegistrationId, RegistryId, ENSv2DomainId, RenewalId, ResolverId, ENSv1DomainId, ResolverRecordsId, InterpretedName } from 'enssdk';
 
 /**
  * The ENSv2 Schema
@@ -859,7 +859,7 @@ declare const relations_v2Domain: drizzle_orm.Relations<"v2_domains", {
     label: drizzle_orm.One<"labels", true>;
     registrations: drizzle_orm.Many<"registrations">;
 }>;
-declare const registrationType: ponder.OnchainEnum<["NameWrapper", "BaseRegistrar", "ThreeDNS", "ENSv2Registry"]>;
+declare const registrationType: ponder.OnchainEnum<["NameWrapper", "BaseRegistrar", "ThreeDNS", "ENSv2RegistryRegistration", "ENSv2RegistryReservation"]>;
 declare const registration: ponder.OnchainTable<{
     name: "registrations";
     schema: undefined;
@@ -902,8 +902,8 @@ declare const registration: ponder.OnchainTable<{
         }, {}, {
             $type: DomainId;
         }>;
-        index: ponder.PgColumn<{
-            name: "index";
+        registrationIndex: ponder.PgColumn<{
+            name: "registrationIndex";
             tableName: "registrations";
             dataType: "number";
             columnType: "PgInteger";
@@ -924,14 +924,14 @@ declare const registration: ponder.OnchainTable<{
             tableName: "registrations";
             dataType: "string";
             columnType: "PgEnumColumn";
-            data: "BaseRegistrar" | "NameWrapper" | "ThreeDNS" | "ENSv2Registry";
+            data: "BaseRegistrar" | "NameWrapper" | "ThreeDNS" | "ENSv2RegistryRegistration" | "ENSv2RegistryReservation";
             driverParam: string;
             notNull: true;
             hasDefault: false;
             isPrimaryKey: false;
             isAutoincrement: false;
             hasRuntimeDefault: false;
-            enumValues: ["NameWrapper", "BaseRegistrar", "ThreeDNS", "ENSv2Registry"];
+            enumValues: ["NameWrapper", "BaseRegistrar", "ThreeDNS", "ENSv2RegistryRegistration", "ENSv2RegistryReservation"];
             baseColumn: never;
             identity: undefined;
             generated: undefined;
@@ -1044,6 +1044,25 @@ declare const registration: ponder.OnchainTable<{
         }, {}, {
             $type: `0x${string}`;
         }>;
+        unregistrantId: ponder.PgColumn<{
+            name: "unregistrantId";
+            tableName: "registrations";
+            dataType: "string";
+            columnType: "PgHex";
+            data: `0x${string}`;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            $type: `0x${string}`;
+        }>;
         referrer: ponder.PgColumn<{
             name: "referrer";
             tableName: "registrations";
@@ -1177,8 +1196,8 @@ declare const latestRegistrationIndex: ponder.OnchainTable<{
         }, {}, {
             $type: DomainId;
         }>;
-        index: ponder.PgColumn<{
-            name: "index";
+        registrationIndex: ponder.PgColumn<{
+            name: "registrationIndex";
             tableName: "latest_registration_indexes";
             dataType: "number";
             columnType: "PgInteger";
@@ -1202,6 +1221,7 @@ declare const registration_relations: drizzle_orm.Relations<"registrations", {
     v1Domain: drizzle_orm.One<"v1_domains", true>;
     v2Domain: drizzle_orm.One<"v2_domains", true>;
     registrant: drizzle_orm.One<"accounts", false>;
+    unregistrant: drizzle_orm.One<"accounts", false>;
     renewals: drizzle_orm.Many<"renewals">;
     event: drizzle_orm.One<"events", true>;
 }>;
@@ -1264,8 +1284,8 @@ declare const renewal: ponder.OnchainTable<{
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
-        index: ponder.PgColumn<{
-            name: "index";
+        renewalIndex: ponder.PgColumn<{
+            name: "renewalIndex";
             tableName: "renewals";
             dataType: "number";
             columnType: "PgInteger";
@@ -1418,8 +1438,8 @@ declare const latestRenewalIndex: ponder.OnchainTable<{
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
-        index: ponder.PgColumn<{
-            name: "index";
+        renewalIndex: ponder.PgColumn<{
+            name: "renewalIndex";
             tableName: "latest_renewal_indexes";
             dataType: "number";
             columnType: "PgInteger";
@@ -1880,7 +1900,7 @@ declare const reverseNameRecord: ponder.OnchainTable<{
             tableName: "reverse_name_records";
             dataType: "string";
             columnType: "PgText";
-            data: string;
+            data: InterpretedName;
             driverParam: string;
             notNull: true;
             hasDefault: false;
@@ -1891,7 +1911,9 @@ declare const reverseNameRecord: ponder.OnchainTable<{
             baseColumn: never;
             identity: undefined;
             generated: undefined;
-        }, {}, {}>;
+        }, {}, {
+            $type: InterpretedName;
+        }>;
     };
     extra: {
         pk: ponder.PrimaryKeyBuilder<"address" | "coinType">;
@@ -1988,7 +2010,7 @@ declare const domainResolverRelation: ponder.OnchainTable<{
         }>;
     };
     extra: {
-        pk: ponder.PrimaryKeyBuilder<"address" | "chainId" | "domainId">;
+        pk: ponder.PrimaryKeyBuilder<"chainId" | "address" | "domainId">;
     };
     dialect: "pg";
 }>;
@@ -2169,7 +2191,7 @@ declare const resolverRecords: ponder.OnchainTable<{
             tableName: "resolver_records";
             dataType: "string";
             columnType: "PgText";
-            data: string;
+            data: InterpretedName;
             driverParam: string;
             notNull: false;
             hasDefault: false;
@@ -2180,7 +2202,96 @@ declare const resolverRecords: ponder.OnchainTable<{
             baseColumn: never;
             identity: undefined;
             generated: undefined;
+        }, {}, {
+            $type: InterpretedName;
+        }>;
+        contenthash: ponder.PgColumn<{
+            name: "contenthash";
+            tableName: "resolver_records";
+            dataType: "string";
+            columnType: "PgHex";
+            data: `0x${string}`;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        pubkeyX: ponder.PgColumn<{
+            name: "pubkeyX";
+            tableName: "resolver_records";
+            dataType: "string";
+            columnType: "PgHex";
+            data: `0x${string}`;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
         }, {}, {}>;
+        pubkeyY: ponder.PgColumn<{
+            name: "pubkeyY";
+            tableName: "resolver_records";
+            dataType: "string";
+            columnType: "PgHex";
+            data: `0x${string}`;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        dnszonehash: ponder.PgColumn<{
+            name: "dnszonehash";
+            tableName: "resolver_records";
+            dataType: "string";
+            columnType: "PgHex";
+            data: `0x${string}`;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        version: ponder.PgColumn<{
+            name: "version";
+            tableName: "resolver_records";
+            dataType: "bigint";
+            columnType: "PgEvmBigint";
+            data: bigint;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            $type: bigint;
+        }>;
     };
     extra: {
         byId: drizzle_orm_pg_core.IndexBuilder;
@@ -2296,7 +2407,7 @@ declare const resolverAddressRecord: ponder.OnchainTable<{
         }, {}, {}>;
     };
     extra: {
-        pk: ponder.PrimaryKeyBuilder<"address" | "node" | "coinType" | "chainId">;
+        pk: ponder.PrimaryKeyBuilder<"chainId" | "address" | "node" | "coinType">;
     };
     dialect: "pg";
 }>;
@@ -2407,7 +2518,7 @@ declare const resolverTextRecord: ponder.OnchainTable<{
         }, {}, {}>;
     };
     extra: {
-        pk: ponder.PrimaryKeyBuilder<"address" | "node" | "key" | "chainId">;
+        pk: ponder.PrimaryKeyBuilder<"chainId" | "address" | "node" | "key">;
     };
     dialect: "pg";
 }>;
@@ -2458,7 +2569,9 @@ declare const migratedNode: ponder.OnchainTable<{
             baseColumn: never;
             identity: undefined;
             generated: undefined;
-        }, {}, {}>;
+        }, {}, {
+            $type: `0x${string}`;
+        }>;
     };
     extra: undefined;
     dialect: "pg";
@@ -2834,7 +2947,9 @@ declare const registrarActions: ponder.OnchainTable<{
             baseColumn: never;
             identity: undefined;
             generated: undefined;
-        }, {}, {}>;
+        }, {}, {
+            $type: `0x${string}`;
+        }>;
         blockNumber: ponder.PgColumn<{
             name: "blockNumber";
             tableName: "registrar_actions";
@@ -3325,6 +3440,8 @@ declare const subgraph_domain: ponder.OnchainTable<{
         }, {}, {}>;
     };
     extra: {
+        byExactName: drizzle_orm_pg_core.IndexBuilder;
+        byFuzzyName: drizzle_orm_pg_core.IndexBuilder;
         byLabelhash: drizzle_orm_pg_core.IndexBuilder;
         byParentId: drizzle_orm_pg_core.IndexBuilder;
         byOwnerId: drizzle_orm_pg_core.IndexBuilder;

package/dist/index.d.ts

@@ -1,15 +1,27 @@
-import { EnsIndexerPublicConfig, CrossChainIndexingStatusSnapshot } from '@ensnode/ensnode-sdk';
+import { EnsIndexerPublicConfig, EnsDbPublicConfig, CrossChainIndexingStatusSnapshot, Unvalidated } from '@ensnode/ensnode-sdk';
 import { NodePgDatabase } from 'drizzle-orm/node-postgres';
-import { a as abstractEnsIndexerSchema } from './index-CUYtpVSw.js';
+import { a as abstractEnsIndexerSchema } from './index-DN0SGSyd.js';
 import { e as ensNodeSchema } from './index-BHoa233Z.js';
 import 'drizzle-orm/pg-core';
 import 'drizzle-orm';
 import 'ponder';
+import 'enssdk';
 
 /**
  * Utilities for Drizzle ORM integration with ENSDb.
  */
 
+/**
+ * PostgreSQL startup `options` string for ENSDb connections.
+ *
+ * Sets `search_path` so unqualified references (notably the `gin_trgm_ops`
+ * opclass from the pg_trgm extension, installed in the `ensnode` schema by
+ * migration 0001) resolve correctly at query and index-creation time.
+ *
+ * Pass via node-postgres `PoolConfig.options` (e.g. Ponder's
+ * `database.poolConfig.options`) or Drizzle's connection config.
+ */
+declare const ENSDB_CONNECTION_OPTIONS = "-c search_path=ensnode,public";
 /**
  * Abstract ENSIndexer Schema
  *
@@ -39,6 +51,39 @@ type EnsDbSchema<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSchema> = Co
  */
 type EnsDbDrizzleClient<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSchema> = NodePgDatabase<EnsDbSchema<ConcreteEnsIndexerSchema>>;
 
+/**
+ * ENSDb Config
+ */
+interface EnsDbConfig {
+    /**
+     * PostgreSQL connection string for ENSDb.
+     *
+     * Guaranteed to be a valid PostgreSQL connection string with the format:
+     * `postgresql://username:password@host:port/database` or
+     * `postgres://username:password@host:port/database`
+     */
+    ensDbUrl: string;
+    /**
+     * The name of the ENSIndexer Schema in the ENSDb instance.
+     *
+     * Guaranteed to be a non-empty string that is
+     * a valid Postgres database schema identifier
+     */
+    ensIndexerSchemaName: string;
+}
+/**
+ * ENSDb Schema Checksum
+ *
+ * Checksum representing the ENSDb Schema definition, which is a combination of
+ * - the ENSIndexer Schema definition, and
+ * - the ENSNode Schema definition.
+ *
+ * This checksum can be used to verify compatibility between
+ * the ENSDb Schema definition expected by any client app connecting to ENSDb
+ * instance and the actual ENSDb Schema definition present in ENSDb SDK.
+ */
+declare const ENSDB_SCHEMA_CHECKSUM: string;
+
 /**
  * ENSDb Reader
  *
@@ -118,6 +163,10 @@ declare class EnsDbReader<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSch
      * @returns the existing record, or `undefined`.
      */
     getEnsIndexerPublicConfig(): Promise<EnsIndexerPublicConfig | undefined>;
+    /**
+     * Build ENSDb Public Config
+     */
+    buildEnsDbPublicConfig(): Promise<EnsDbPublicConfig>;
     /**
      * Get Indexing Status Snapshot
      *
@@ -133,6 +182,19 @@ declare class EnsDbReader<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSch
      *         'ensIndexerSchemaName' and 'key')
      */
     private getEnsNodeMetadata;
+    /**
+     * Get PostgreSQL version for the server hosting the ENSDb instance.
+     *
+     * @throws when the version cannot be retrieved or parsed from the query result.
+     */
+    private getPostgresVersion;
+    /**
+     * Build ENSDb version info.
+     *
+     * @throws when version info cannot be retrieved or parsed from
+     *         the ENSDb instance.
+     */
+    private buildEnsDbVersionInfo;
 }
 
 /**
@@ -205,4 +267,13 @@ interface EnsNodeMetadataEnsIndexerIndexingStatus {
  */
 type EnsNodeMetadata = EnsNodeMetadataEnsDbVersion | EnsNodeMetadataEnsIndexerPublicConfig | EnsNodeMetadataEnsIndexerIndexingStatus;
 
-export { type EnsDbDrizzleClient, EnsDbReader, EnsDbWriter, type EnsNodeMetadata, type EnsNodeMetadataEnsDbVersion, type EnsNodeMetadataEnsIndexerIndexingStatus, type EnsNodeMetadataEnsIndexerPublicConfig, type EnsNodeMetadataKey, EnsNodeMetadataKeys };
+/**
+ * Validate ENSDb config
+ *
+ * @param unvalidatedConfig - Unvalidated ENSDb config
+ * @returns Valid ENSDb config
+ * @throws Error if validation fails, with details about the validation errors
+ */
+declare function validateEnsDbConfig(unvalidatedConfig: Unvalidated<EnsDbConfig>): EnsDbConfig;
+
+export { ENSDB_CONNECTION_OPTIONS, ENSDB_SCHEMA_CHECKSUM, type EnsDbConfig, type EnsDbDrizzleClient, EnsDbReader, EnsDbWriter, type EnsNodeMetadata, type EnsNodeMetadataEnsDbVersion, type EnsNodeMetadataEnsIndexerIndexingStatus, type EnsNodeMetadataEnsIndexerPublicConfig, type EnsNodeMetadataKey, EnsNodeMetadataKeys, validateEnsDbConfig };