@apibara/plugin-sqlite 2.0.0-beta.27 → 2.0.0-beta.29

package/dist/index.cjs

@@ -68,6 +68,21 @@ class KeyValueStore {
     this.db.prepare(statements$1.del).run(Number(this.endCursor.orderKey), key);
   }
 }
+function finalizeKV(db, cursor) {
+  assertInTransaction(db);
+  db.prepare(statements$1.finalize).run(
+    Number(cursor.orderKey)
+  );
+}
+function invalidateKV(db, cursor) {
+  assertInTransaction(db);
+  db.prepare(statements$1.invalidateDelete).run(
+    Number(cursor.orderKey)
+  );
+  db.prepare(statements$1.invalidateUpdate).run(
+    Number(cursor.orderKey)
+  );
+}
 const statements$1 = {
   createTable: `
     CREATE TABLE IF NOT EXISTS kvs (
@@ -91,40 +106,51 @@ const statements$1 = {
   del: `
     UPDATE kvs
     SET to_block = ?
-    WHERE k = ? AND to_block IS NULL`
+    WHERE k = ? AND to_block IS NULL`,
+  finalize: `
+    DELETE FROM kvs
+    WHERE to_block <= ?`,
+  invalidateDelete: `
+    DELETE FROM kvs
+    WHERE from_block > ?`,
+  invalidateUpdate: `
+    UPDATE kvs
+    SET to_block = NULL
+    WHERE to_block > ?`
 };
 
-const DEFAULT_INDEXER_ID = "default";
 function initializePersistentState(db) {
   assertInTransaction(db);
   db.exec(statements.createCheckpointsTable);
   db.exec(statements.createFiltersTable);
 }
-function persistState(db, endCursor, filter) {
+function persistState(props) {
+  const { db, endCursor, filter, indexerName } = props;
   assertInTransaction(db);
   db.prepare(statements.putCheckpoint).run(
-    DEFAULT_INDEXER_ID,
+    indexerName,
     Number(endCursor.orderKey),
     endCursor.uniqueKey
   );
   if (filter) {
     db.prepare(statements.updateFilterToBlock).run(
       Number(endCursor.orderKey),
-      DEFAULT_INDEXER_ID
+      indexerName
     );
     db.prepare(statements.insertFilter).run(
-      DEFAULT_INDEXER_ID,
+      indexerName,
       serialize(filter),
       Number(endCursor.orderKey)
     );
   }
 }
-function getState(db) {
+function getState(props) {
+  const { db, indexerName } = props;
   assertInTransaction(db);
   const storedCursor = db.prepare(
     statements.getCheckpoint
-  ).get(DEFAULT_INDEXER_ID);
-  const storedFilter = db.prepare(statements.getFilter).get(DEFAULT_INDEXER_ID);
+  ).get(indexerName);
+  const storedFilter = db.prepare(statements.getFilter).get(indexerName);
   let cursor;
   let filter;
   if (storedCursor?.order_key) {
@@ -138,6 +164,26 @@ function getState(db) {
   }
   return { cursor, filter };
 }
+function finalizeState(props) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare(statements.finalizeFilter).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+}
+function invalidateState(props) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare(statements.invalidateFilterDelete).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+  db.prepare(statements.invalidateFilterUpdate).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+}
 const statements = {
   createCheckpointsTable: `
     CREATE TABLE IF NOT EXISTS checkpoints (
@@ -182,7 +228,17 @@ const statements = {
       from_block = excluded.from_block`,
   delFilter: `
     DELETE FROM filters
-    WHERE id = ?`
+    WHERE id = ?`,
+  finalizeFilter: `
+    DELETE FROM filters
+    WHERE id = ? AND to_block <= ?`,
+  invalidateFilterDelete: `
+    DELETE FROM filters
+    WHERE id = ? AND from_block > ?`,
+  invalidateFilterUpdate: `
+    UPDATE filters
+    SET to_block = NULL
+    WHERE id = ? AND to_block > ?`
 };
 
 const KV_PROPERTY = "_kv_sqlite";
@@ -200,7 +256,8 @@ function sqliteStorage({
   persistState: enablePersistState = true,
   keyValueStore: enableKeyValueStore = true,
   serialize: serializeFn = serialize,
-  deserialize: deserializeFn = deserialize
+  deserialize: deserializeFn = deserialize,
+  indexerName = "default"
 }) {
   return plugins.defineIndexerPlugin((indexer) => {
     indexer.hooks.hook("run:before", async () => {
@@ -218,7 +275,7 @@ function sqliteStorage({
         return;
       }
       return await withTransaction(database, async (db) => {
-        const { cursor, filter } = getState(db);
+        const { cursor, filter } = getState({ db, indexerName });
         if (cursor) {
           request.startingCursor = cursor;
         }
@@ -227,6 +284,62 @@ function sqliteStorage({
         }
       });
     });
+    indexer.hooks.hook("connect:after", async ({ request }) => {
+      const cursor = request.startingCursor;
+      if (!cursor) {
+        return;
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
+    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
+      if (!enablePersistState) {
+        return;
+      }
+      assertInTransaction(database);
+      if (endCursor && request.filter[1]) {
+        persistState({
+          db: database,
+          endCursor,
+          indexerName,
+          filter: request.filter[1]
+        });
+      }
+    });
+    indexer.hooks.hook("message:finalize", async ({ message }) => {
+      const { cursor } = message.finalize;
+      if (!cursor) {
+        throw new SqliteStorageError("finalized cursor is undefined");
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          finalizeState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          finalizeKV(db, cursor);
+        }
+      });
+    });
+    indexer.hooks.hook("message:invalidate", async ({ message }) => {
+      const { cursor } = message.invalidate;
+      if (!cursor) {
+        throw new SqliteStorageError("invalidate cursor is undefined");
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
     indexer.hooks.hook("handler:middleware", ({ use }) => {
       use(async (ctx, next) => {
         if (!ctx.finality) {
@@ -249,7 +362,7 @@ function sqliteStorage({
           }
           await next();
           if (enablePersistState) {
-            persistState(db, ctx.endCursor);
+            persistState({ db, endCursor: ctx.endCursor, indexerName });
           }
           if (enableKeyValueStore) {
             delete ctx[KV_PROPERTY];
@@ -257,15 +370,6 @@ function sqliteStorage({
         });
       });
     });
-    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
-      if (!enablePersistState) {
-        return;
-      }
-      assertInTransaction(database);
-      if (endCursor && request.filter[1]) {
-        persistState(database, endCursor, request.filter[1]);
-      }
-    });
   });
 }
 

package/dist/index.d.cts

@@ -22,6 +22,7 @@ type SqliteStorageOptions = {
     database: Database;
     keyValueStore?: boolean;
     persistState?: boolean;
+    indexerName?: string;
     serialize?: SerializeFn;
     deserialize?: DeserializeFn;
 };
@@ -34,7 +35,8 @@ type SqliteStorageOptions = {
  * @param options.keyValueStore - Whether to enable the Key-Value store. Defaults to true.
  * @param options.serialize - A function to serialize the value to the KV.
  * @param options.deserialize - A function to deserialize the value from the KV.
+ * @param options.indexerName - The name of the indexer. Defaults value is 'default'.
  */
-declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
+declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, indexerName, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
 
 export { KeyValueStore, type SqliteStorageOptions, sqliteStorage, useSqliteKeyValueStore };

package/dist/index.d.mts

@@ -22,6 +22,7 @@ type SqliteStorageOptions = {
     database: Database;
     keyValueStore?: boolean;
     persistState?: boolean;
+    indexerName?: string;
     serialize?: SerializeFn;
     deserialize?: DeserializeFn;
 };
@@ -34,7 +35,8 @@ type SqliteStorageOptions = {
  * @param options.keyValueStore - Whether to enable the Key-Value store. Defaults to true.
  * @param options.serialize - A function to serialize the value to the KV.
  * @param options.deserialize - A function to deserialize the value from the KV.
+ * @param options.indexerName - The name of the indexer. Defaults value is 'default'.
  */
-declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
+declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, indexerName, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
 
 export { KeyValueStore, type SqliteStorageOptions, sqliteStorage, useSqliteKeyValueStore };

package/dist/index.d.ts

@@ -22,6 +22,7 @@ type SqliteStorageOptions = {
     database: Database;
     keyValueStore?: boolean;
     persistState?: boolean;
+    indexerName?: string;
     serialize?: SerializeFn;
     deserialize?: DeserializeFn;
 };
@@ -34,7 +35,8 @@ type SqliteStorageOptions = {
  * @param options.keyValueStore - Whether to enable the Key-Value store. Defaults to true.
  * @param options.serialize - A function to serialize the value to the KV.
  * @param options.deserialize - A function to deserialize the value from the KV.
+ * @param options.indexerName - The name of the indexer. Defaults value is 'default'.
  */
-declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
+declare function sqliteStorage<TFilter, TBlock>({ database, persistState: enablePersistState, keyValueStore: enableKeyValueStore, serialize: serializeFn, deserialize: deserializeFn, indexerName, }: SqliteStorageOptions): _apibara_indexer_plugins.IndexerPlugin<TFilter, TBlock>;
 
 export { KeyValueStore, type SqliteStorageOptions, sqliteStorage, useSqliteKeyValueStore };

package/dist/index.mjs

@@ -66,6 +66,21 @@ class KeyValueStore {
     this.db.prepare(statements$1.del).run(Number(this.endCursor.orderKey), key);
   }
 }
+function finalizeKV(db, cursor) {
+  assertInTransaction(db);
+  db.prepare(statements$1.finalize).run(
+    Number(cursor.orderKey)
+  );
+}
+function invalidateKV(db, cursor) {
+  assertInTransaction(db);
+  db.prepare(statements$1.invalidateDelete).run(
+    Number(cursor.orderKey)
+  );
+  db.prepare(statements$1.invalidateUpdate).run(
+    Number(cursor.orderKey)
+  );
+}
 const statements$1 = {
   createTable: `
     CREATE TABLE IF NOT EXISTS kvs (
@@ -89,40 +104,51 @@ const statements$1 = {
   del: `
     UPDATE kvs
     SET to_block = ?
-    WHERE k = ? AND to_block IS NULL`
+    WHERE k = ? AND to_block IS NULL`,
+  finalize: `
+    DELETE FROM kvs
+    WHERE to_block <= ?`,
+  invalidateDelete: `
+    DELETE FROM kvs
+    WHERE from_block > ?`,
+  invalidateUpdate: `
+    UPDATE kvs
+    SET to_block = NULL
+    WHERE to_block > ?`
 };
 
-const DEFAULT_INDEXER_ID = "default";
 function initializePersistentState(db) {
   assertInTransaction(db);
   db.exec(statements.createCheckpointsTable);
   db.exec(statements.createFiltersTable);
 }
-function persistState(db, endCursor, filter) {
+function persistState(props) {
+  const { db, endCursor, filter, indexerName } = props;
   assertInTransaction(db);
   db.prepare(statements.putCheckpoint).run(
-    DEFAULT_INDEXER_ID,
+    indexerName,
     Number(endCursor.orderKey),
     endCursor.uniqueKey
   );
   if (filter) {
     db.prepare(statements.updateFilterToBlock).run(
       Number(endCursor.orderKey),
-      DEFAULT_INDEXER_ID
+      indexerName
     );
     db.prepare(statements.insertFilter).run(
-      DEFAULT_INDEXER_ID,
+      indexerName,
       serialize(filter),
       Number(endCursor.orderKey)
     );
   }
 }
-function getState(db) {
+function getState(props) {
+  const { db, indexerName } = props;
   assertInTransaction(db);
   const storedCursor = db.prepare(
     statements.getCheckpoint
-  ).get(DEFAULT_INDEXER_ID);
-  const storedFilter = db.prepare(statements.getFilter).get(DEFAULT_INDEXER_ID);
+  ).get(indexerName);
+  const storedFilter = db.prepare(statements.getFilter).get(indexerName);
   let cursor;
   let filter;
   if (storedCursor?.order_key) {
@@ -136,6 +162,26 @@ function getState(db) {
   }
   return { cursor, filter };
 }
+function finalizeState(props) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare(statements.finalizeFilter).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+}
+function invalidateState(props) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare(statements.invalidateFilterDelete).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+  db.prepare(statements.invalidateFilterUpdate).run(
+    indexerName,
+    Number(cursor.orderKey)
+  );
+}
 const statements = {
   createCheckpointsTable: `
     CREATE TABLE IF NOT EXISTS checkpoints (
@@ -180,7 +226,17 @@ const statements = {
       from_block = excluded.from_block`,
   delFilter: `
     DELETE FROM filters
-    WHERE id = ?`
+    WHERE id = ?`,
+  finalizeFilter: `
+    DELETE FROM filters
+    WHERE id = ? AND to_block <= ?`,
+  invalidateFilterDelete: `
+    DELETE FROM filters
+    WHERE id = ? AND from_block > ?`,
+  invalidateFilterUpdate: `
+    UPDATE filters
+    SET to_block = NULL
+    WHERE id = ? AND to_block > ?`
 };
 
 const KV_PROPERTY = "_kv_sqlite";
@@ -198,7 +254,8 @@ function sqliteStorage({
   persistState: enablePersistState = true,
   keyValueStore: enableKeyValueStore = true,
   serialize: serializeFn = serialize,
-  deserialize: deserializeFn = deserialize
+  deserialize: deserializeFn = deserialize,
+  indexerName = "default"
 }) {
   return defineIndexerPlugin((indexer) => {
     indexer.hooks.hook("run:before", async () => {
@@ -216,7 +273,7 @@ function sqliteStorage({
         return;
       }
       return await withTransaction(database, async (db) => {
-        const { cursor, filter } = getState(db);
+        const { cursor, filter } = getState({ db, indexerName });
         if (cursor) {
           request.startingCursor = cursor;
         }
@@ -225,6 +282,62 @@ function sqliteStorage({
         }
       });
     });
+    indexer.hooks.hook("connect:after", async ({ request }) => {
+      const cursor = request.startingCursor;
+      if (!cursor) {
+        return;
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
+    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
+      if (!enablePersistState) {
+        return;
+      }
+      assertInTransaction(database);
+      if (endCursor && request.filter[1]) {
+        persistState({
+          db: database,
+          endCursor,
+          indexerName,
+          filter: request.filter[1]
+        });
+      }
+    });
+    indexer.hooks.hook("message:finalize", async ({ message }) => {
+      const { cursor } = message.finalize;
+      if (!cursor) {
+        throw new SqliteStorageError("finalized cursor is undefined");
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          finalizeState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          finalizeKV(db, cursor);
+        }
+      });
+    });
+    indexer.hooks.hook("message:invalidate", async ({ message }) => {
+      const { cursor } = message.invalidate;
+      if (!cursor) {
+        throw new SqliteStorageError("invalidate cursor is undefined");
+      }
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
     indexer.hooks.hook("handler:middleware", ({ use }) => {
       use(async (ctx, next) => {
         if (!ctx.finality) {
@@ -247,7 +360,7 @@ function sqliteStorage({
           }
           await next();
           if (enablePersistState) {
-            persistState(db, ctx.endCursor);
+            persistState({ db, endCursor: ctx.endCursor, indexerName });
           }
           if (enableKeyValueStore) {
             delete ctx[KV_PROPERTY];
@@ -255,15 +368,6 @@ function sqliteStorage({
         });
       });
     });
-    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
-      if (!enablePersistState) {
-        return;
-      }
-      assertInTransaction(database);
-      if (endCursor && request.filter[1]) {
-        persistState(database, endCursor, request.filter[1]);
-      }
-    });
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/plugin-sqlite",
-  "version": "2.0.0-beta.27",
+  "version": "2.0.0-beta.29",
   "type": "module",
   "files": [
     "dist",
@@ -35,7 +35,7 @@
     "better-sqlite3": "^9.0.0"
   },
   "dependencies": {
-    "@apibara/indexer": "2.0.0-beta.28",
-    "@apibara/protocol": "2.0.0-beta.28"
+    "@apibara/indexer": "2.0.0-beta.30",
+    "@apibara/protocol": "2.0.0-beta.30"
   }
 }

package/src/index.ts

@@ -3,10 +3,17 @@ import { defineIndexerPlugin } from "@apibara/indexer/plugins";
 import { isCursor } from "@apibara/protocol";
 import type { Database as SqliteDatabase } from "better-sqlite3";
 
-import { KeyValueStore, initializeKeyValueStore } from "./kv";
 import {
+  KeyValueStore,
+  finalizeKV,
+  initializeKeyValueStore,
+  invalidateKV,
+} from "./kv";
+import {
+  finalizeState,
   getState,
   initializePersistentState,
+  invalidateState,
   persistState,
 } from "./persistence";
 import {
@@ -38,6 +45,7 @@ export type SqliteStorageOptions = {
   database: SqliteDatabase;
   keyValueStore?: boolean;
   persistState?: boolean;
+  indexerName?: string;
 
   serialize?: SerializeFn;
   deserialize?: DeserializeFn;
@@ -52,6 +60,7 @@ export type SqliteStorageOptions = {
  * @param options.keyValueStore - Whether to enable the Key-Value store. Defaults to true.
  * @param options.serialize - A function to serialize the value to the KV.
  * @param options.deserialize - A function to deserialize the value from the KV.
+ * @param options.indexerName - The name of the indexer. Defaults value is 'default'.
  */
 export function sqliteStorage<TFilter, TBlock>({
   database,
@@ -59,6 +68,7 @@ export function sqliteStorage<TFilter, TBlock>({
   keyValueStore: enableKeyValueStore = true,
   serialize: serializeFn = serialize,
   deserialize: deserializeFn = deserialize,
+  indexerName = "default",
 }: SqliteStorageOptions) {
   return defineIndexerPlugin<TFilter, TBlock>((indexer) => {
     indexer.hooks.hook("run:before", async () => {
@@ -79,7 +89,7 @@ export function sqliteStorage<TFilter, TBlock>({
       }
 
       return await withTransaction(database, async (db) => {
-        const { cursor, filter } = getState<TFilter>(db);
+        const { cursor, filter } = getState<TFilter>({ db, indexerName });
 
         if (cursor) {
           request.startingCursor = cursor;
@@ -91,6 +101,80 @@ export function sqliteStorage<TFilter, TBlock>({
       });
     });
 
+    indexer.hooks.hook("connect:after", async ({ request }) => {
+      // On restart, we need to invalidate data for blocks that were processed but not persisted.
+      const cursor = request.startingCursor;
+
+      if (!cursor) {
+        return;
+      }
+
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
+
+    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
+      if (!enablePersistState) {
+        return;
+      }
+
+      // The connect factory hook is called while indexing a block, so the database should be in a transaction
+      // created by the middleware.
+      assertInTransaction(database);
+
+      if (endCursor && request.filter[1]) {
+        persistState({
+          db: database,
+          endCursor,
+          indexerName,
+          filter: request.filter[1],
+        });
+      }
+    });
+
+    indexer.hooks.hook("message:finalize", async ({ message }) => {
+      const { cursor } = message.finalize;
+
+      if (!cursor) {
+        throw new SqliteStorageError("finalized cursor is undefined");
+      }
+
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          finalizeState({ db, cursor, indexerName });
+        }
+
+        if (enableKeyValueStore) {
+          finalizeKV(db, cursor);
+        }
+      });
+    });
+
+    indexer.hooks.hook("message:invalidate", async ({ message }) => {
+      const { cursor } = message.invalidate;
+
+      if (!cursor) {
+        throw new SqliteStorageError("invalidate cursor is undefined");
+      }
+
+      await withTransaction(database, async (db) => {
+        if (enablePersistState) {
+          invalidateState({ db, cursor, indexerName });
+        }
+
+        if (enableKeyValueStore) {
+          invalidateKV(db, cursor);
+        }
+      });
+    });
+
     indexer.hooks.hook("handler:middleware", ({ use }) => {
       use(async (ctx, next) => {
         if (!ctx.finality) {
@@ -117,7 +201,7 @@ export function sqliteStorage<TFilter, TBlock>({
           await next();
 
           if (enablePersistState) {
-            persistState(db, ctx.endCursor);
+            persistState({ db, endCursor: ctx.endCursor, indexerName });
           }
 
           if (enableKeyValueStore) {
@@ -126,19 +210,5 @@ export function sqliteStorage<TFilter, TBlock>({
         });
       });
     });
-
-    indexer.hooks.hook("connect:factory", ({ request, endCursor }) => {
-      if (!enablePersistState) {
-        return;
-      }
-
-      // The connect factory hook is called while indexing a block, so the database should be in a transaction
-      // created by the middleware.
-      assertInTransaction(database);
-
-      if (endCursor && request.filter[1]) {
-        persistState(database, endCursor, request.filter[1]);
-      }
-    });
   });
 }

package/src/kv.ts

@@ -50,6 +50,28 @@ export class KeyValueStore {
   }
 }
 
+export function finalizeKV(db: Database, cursor: Cursor) {
+  assertInTransaction(db);
+
+  db.prepare<[number], KeyValueRow>(statements.finalize).run(
+    Number(cursor.orderKey),
+  );
+}
+
+export function invalidateKV(db: Database, cursor: Cursor) {
+  assertInTransaction(db);
+
+  // Delete entries that started after the invalidation cursor
+  db.prepare<[number], KeyValueRow>(statements.invalidateDelete).run(
+    Number(cursor.orderKey),
+  );
+
+  // Update entries that were supposed to end after the invalidation cursor
+  db.prepare<[number], KeyValueRow>(statements.invalidateUpdate).run(
+    Number(cursor.orderKey),
+  );
+}
+
 type KeyValueRow = {
   from_block: number;
   to_block: number;
@@ -81,4 +103,14 @@ const statements = {
     UPDATE kvs
     SET to_block = ?
     WHERE k = ? AND to_block IS NULL`,
+  finalize: `
+    DELETE FROM kvs
+    WHERE to_block <= ?`,
+  invalidateDelete: `
+    DELETE FROM kvs
+    WHERE from_block > ?`,
+  invalidateUpdate: `
+    UPDATE kvs
+    SET to_block = NULL
+    WHERE to_block > ?`,
 };

package/src/persistence.ts

@@ -3,23 +3,24 @@ import type { Database } from "better-sqlite3";
 
 import { assertInTransaction, deserialize, serialize } from "./utils";
 
-const DEFAULT_INDEXER_ID = "default";
-
 export function initializePersistentState(db: Database) {
   assertInTransaction(db);
   db.exec(statements.createCheckpointsTable);
   db.exec(statements.createFiltersTable);
 }
 
-export function persistState<TFilter>(
-  db: Database,
-  endCursor: Cursor,
-  filter?: TFilter,
-) {
+export function persistState<TFilter>(props: {
+  db: Database;
+  endCursor: Cursor;
+  filter?: TFilter;
+  indexerName: string;
+}) {
+  const { db, endCursor, filter, indexerName } = props;
+
   assertInTransaction(db);
 
   db.prepare(statements.putCheckpoint).run(
-    DEFAULT_INDEXER_ID,
+    indexerName,
     Number(endCursor.orderKey),
     endCursor.uniqueKey,
   );
@@ -27,26 +28,30 @@ export function persistState<TFilter>(
   if (filter) {
     db.prepare(statements.updateFilterToBlock).run(
       Number(endCursor.orderKey),
-      DEFAULT_INDEXER_ID,
+      indexerName,
     );
     db.prepare(statements.insertFilter).run(
-      DEFAULT_INDEXER_ID,
+      indexerName,
       serialize(filter as Record<string, unknown>),
       Number(endCursor.orderKey),
     );
   }
 }
 
-export function getState<TFilter>(db: Database) {
+export function getState<TFilter>(props: {
+  db: Database;
+  indexerName: string;
+}) {
+  const { db, indexerName } = props;
   assertInTransaction(db);
   const storedCursor = db
     .prepare<string, { order_key?: number; unique_key?: string }>(
       statements.getCheckpoint,
     )
-    .get(DEFAULT_INDEXER_ID);
+    .get(indexerName);
   const storedFilter = db
     .prepare<string, { filter: string }>(statements.getFilter)
-    .get(DEFAULT_INDEXER_ID);
+    .get(indexerName);
 
   let cursor: Cursor | undefined;
   let filter: TFilter | undefined;
@@ -65,6 +70,36 @@ export function getState<TFilter>(db: Database) {
   return { cursor, filter };
 }
 
+export function finalizeState(props: {
+  db: Database;
+  cursor: Cursor;
+  indexerName: string;
+}) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare<[string, number]>(statements.finalizeFilter).run(
+    indexerName,
+    Number(cursor.orderKey),
+  );
+}
+
+export function invalidateState(props: {
+  db: Database;
+  cursor: Cursor;
+  indexerName: string;
+}) {
+  const { cursor, db, indexerName } = props;
+  assertInTransaction(db);
+  db.prepare<[string, number]>(statements.invalidateFilterDelete).run(
+    indexerName,
+    Number(cursor.orderKey),
+  );
+  db.prepare<[string, number]>(statements.invalidateFilterUpdate).run(
+    indexerName,
+    Number(cursor.orderKey),
+  );
+}
+
 const statements = {
   createCheckpointsTable: `
     CREATE TABLE IF NOT EXISTS checkpoints (
@@ -110,4 +145,14 @@ const statements = {
   delFilter: `
     DELETE FROM filters
     WHERE id = ?`,
+  finalizeFilter: `
+    DELETE FROM filters
+    WHERE id = ? AND to_block <= ?`,
+  invalidateFilterDelete: `
+    DELETE FROM filters
+    WHERE id = ? AND from_block > ?`,
+  invalidateFilterUpdate: `
+    UPDATE filters
+    SET to_block = NULL
+    WHERE id = ? AND to_block > ?`,
 };