@ensnode/ensdb-sdk 1.16.0 → 1.17.0

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { EnsDbPublicConfig, IndexingMetadataContext, IndexingMetadataContextInitialized, Unvalidated } from '@ensnode/ensnode-sdk';
+import { IndexingMetadataContextInitialized, SerializedIndexingMetadataContextInitialized, EnsDbPublicConfig, IndexingMetadataContext, Unvalidated } from '@ensnode/ensnode-sdk';
 export { IndexingMetadataContext, IndexingMetadataContextInitialized, IndexingMetadataContextStatusCodes, IndexingMetadataContextUninitialized } from '@ensnode/ensnode-sdk';
 import { NodePgDatabase } from 'drizzle-orm/node-postgres';
-import { a as abstractEnsIndexerSchema } from './index-D36RM4zS.js';
+import { a as abstractEnsIndexerSchema } from './index-BLniLyqz.js';
 import { e as ensNodeSchema } from './index-BHoa233Z.js';
-import 'ponder';
 import 'drizzle-orm';
 import 'drizzle-orm/pg-core';
+import 'ponder';
 import 'enssdk';
 
 /**
@@ -85,6 +85,42 @@ interface EnsDbConfig {
  */
 declare const ENSDB_SCHEMA_CHECKSUM: string;
 
+/**
+ * Keys used to distinguish records in `ensnode_metadata` table in the ENSDb.
+ */
+declare const EnsNodeMetadataKeys: {
+    readonly IndexingMetadataContext: "indexing_metadata_context";
+};
+type EnsNodeMetadataKey = (typeof EnsNodeMetadataKeys)[keyof typeof EnsNodeMetadataKeys];
+/**
+ * ENSNode Metadata record for Indexing Metadata Context
+ *
+ * This record is used to store the Indexing Metadata Context in
+ * ENSNode Metadata table for each ENSIndexer instance.
+ */
+interface EnsNodeMetadataIndexingMetadataContext {
+    key: typeof EnsNodeMetadataKeys.IndexingMetadataContext;
+    value: IndexingMetadataContextInitialized;
+}
+/**
+ * ENSNode Metadata
+ *
+ * Type alias for ENSNode Metadata records,
+ * currently only includes the record for Indexing Metadata Context,
+ * but can be extended in the future to include more types of
+ * ENSNode Metadata records as needed.
+ */
+type EnsNodeMetadata = EnsNodeMetadataIndexingMetadataContext;
+
+interface SerializedEnsNodeMetadataIndexingMetadataContext {
+    key: typeof EnsNodeMetadataKeys.IndexingMetadataContext;
+    value: SerializedIndexingMetadataContextInitialized;
+}
+/**
+ * Serialized representation of {@link EnsNodeMetadata}
+ */
+type SerializedEnsNodeMetadata = SerializedEnsNodeMetadataIndexingMetadataContext;
+
 /**
  * ENSDb Reader
  *
@@ -167,6 +203,10 @@ declare class EnsDbReader<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSch
      * Build ENSDb Public Config
      */
     buildEnsDbPublicConfig(): Promise<EnsDbPublicConfig>;
+    /**
+     * Check whether a Postgres schema with the given name exists in the ENSDb instance.
+     */
+    schemaExists(schemaName: string): Promise<boolean>;
     /**
      * Get Indexing Metadata Context
      *
@@ -180,12 +220,13 @@ declare class EnsDbReader<ConcreteEnsIndexerSchema extends AbstractEnsIndexerSch
     /**
      * Get ENSNode Metadata record
      *
-     * @returns selected record in ENSDb.
+     * @returns the full `{ key, value }` record for the given key under this instance's
+     *          ENSIndexer Schema, or undefined if no such record exists.
      * @throws when more than one matching metadata record is found
      *         (should be impossible given the composite PK constraint on
      *         'ensIndexerSchemaName' and 'key')
      */
-    private getEnsNodeMetadata;
+    getEnsNodeMetadata<EnsNodeMetadataType extends SerializedEnsNodeMetadata>(metadata: Pick<EnsNodeMetadataType, "key">): Promise<EnsNodeMetadataType | undefined>;
     /**
      * Get PostgreSQL version for the server hosting the ENSDb instance.
      *
@@ -228,6 +269,17 @@ declare class EnsDbWriter extends EnsDbReader {
      * @throws error when migration execution fails.
      */
     migrateEnsNodeSchema(migrationsDirPath: string): Promise<void>;
+    /**
+     * Drop a Postgres schema (and everything in it) from the ENSDb instance, if it exists.
+     */
+    dropSchema(schemaName: string): Promise<void>;
+    /**
+     * Rename a Postgres schema within the ENSDb instance.
+     *
+     * The Postgres schema name does not affect Ponder's build_id, so renaming a restored ENSIndexer
+     * schema is safe for resume.
+     */
+    renameSchema(fromSchemaName: string, toSchemaName: string): Promise<void>;
     /**
      * Upsert Indexing Metadata Context Initialized
      *
@@ -235,40 +287,16 @@ declare class EnsDbWriter extends EnsDbReader {
      */
     upsertIndexingMetadataContext(indexingMetadataContext: IndexingMetadataContextInitialized): Promise<void>;
     /**
-     * Upsert ENSNode metadata
+     * Write (upsert) an ENSNode metadata record under this instance's ENSIndexer Schema.
      *
-     * @throws when upsert operation failed.
+     * Re-keys the record to this writer's {@link ensIndexerSchemaName}, so metadata read from one
+     * ENSIndexer Schema can be written under a different (e.g. renamed) one.
+     *
+     * @throws when the upsert operation failed.
      */
-    private upsertEnsNodeMetadata;
+    writeEnsNodeMetadata(metadata: SerializedEnsNodeMetadata): Promise<void>;
 }
 
-/**
- * Keys used to distinguish records in `ensnode_metadata` table in the ENSDb.
- */
-declare const EnsNodeMetadataKeys: {
-    readonly IndexingMetadataContext: "indexing_metadata_context";
-};
-type EnsNodeMetadataKey = (typeof EnsNodeMetadataKeys)[keyof typeof EnsNodeMetadataKeys];
-/**
- * ENSNode Metadata record for Indexing Metadata Context
- *
- * This record is used to store the Indexing Metadata Context in
- * ENSNode Metadata table for each ENSIndexer instance.
- */
-interface EnsNodeMetadataIndexingMetadataContext {
-    key: typeof EnsNodeMetadataKeys.IndexingMetadataContext;
-    value: IndexingMetadataContextInitialized;
-}
-/**
- * ENSNode Metadata
- *
- * Type alias for ENSNode Metadata records,
- * currently only includes the record for Indexing Metadata Context,
- * but can be extended in the future to include more types of
- * ENSNode Metadata records as needed.
- */
-type EnsNodeMetadata = EnsNodeMetadataIndexingMetadataContext;
-
 /**
  * Validate ENSDb config
  *
@@ -278,4 +306,4 @@ type EnsNodeMetadata = EnsNodeMetadataIndexingMetadataContext;
  */
 declare function validateEnsDbConfig(unvalidatedConfig: Unvalidated<EnsDbConfig>): EnsDbConfig;
 
-export { ENSDB_CONNECTION_OPTIONS, ENSDB_SCHEMA_CHECKSUM, type EnsDbConfig, type EnsDbDrizzleClient, EnsDbReader, EnsDbWriter, type EnsNodeMetadata, type EnsNodeMetadataIndexingMetadataContext, type EnsNodeMetadataKey, EnsNodeMetadataKeys, validateEnsDbConfig };
+export { ENSDB_CONNECTION_OPTIONS, ENSDB_SCHEMA_CHECKSUM, type EnsDbConfig, type EnsDbDrizzleClient, EnsDbReader, EnsDbWriter, type EnsNodeMetadata, type EnsNodeMetadataIndexingMetadataContext, type EnsNodeMetadataKey, EnsNodeMetadataKeys, type SerializedEnsNodeMetadata, type SerializedEnsNodeMetadataIndexingMetadataContext, validateEnsDbConfig };