Use getIndexingMetadataContext for all ENSNode Metadata reads from ENSDb instnace

Author: tk-o

apps/ensapi/src/cache/indexing-status.cache.ts

@@ -1,5 +1,9 @@
 import { EnsNodeMetadataKeys } from "@ensnode/ensdb-sdk";
-import { type CrossChainIndexingStatusSnapshot, SWRCache } from "@ensnode/ensnode-sdk";
+import {
+  type CrossChainIndexingStatusSnapshot,
+  IndexingMetadataContextStatusCodes,
+  SWRCache,
+} from "@ensnode/ensnode-sdk";
 
 import { ensDbClient } from "@/lib/ensdb/singleton";
 import { lazyProxy } from "@/lib/lazy";
@@ -16,9 +20,11 @@ export const indexingStatusCache = lazyProxy<SWRCache<CrossChainIndexingStatusSn
     new SWRCache<CrossChainIndexingStatusSnapshot>({
       fn: async (_cachedResult) =>
         ensDbClient
-          .getIndexingStatusSnapshot() // get the latest indexing status snapshot
-          .then((snapshot) => {
-            if (snapshot === undefined) {
+          .getIndexingMetadataContext() // get the latest indexing status snapshot
+          .then((indexingMetadataContext) => {
+            if (
+              indexingMetadataContext.statusCode !== IndexingMetadataContextStatusCodes.Initialized
+            ) {
               // An indexing status snapshot has not been found in ENSDb yet.
               // This might happen during application startup, i.e. when ENSDb
               // has not yet been populated with the first snapshot.
@@ -30,7 +36,7 @@ export const indexingStatusCache = lazyProxy<SWRCache<CrossChainIndexingStatusSn
             // Therefore, return it so that this current invocation of `readCache` will:
             // - Replace the currently cached value (if any) with this new value.
             // - Return this non-null value.
-            return snapshot;
+            return indexingMetadataContext.indexingStatus;
           })
           .catch((error) => {
             // Either the indexing status snapshot fetch failed, or the indexing status snapshot was not found in ENSDb yet.

apps/ensapi/src/config/config.schema.ts

@@ -1,7 +1,7 @@
 import pRetry from "p-retry";
 import { prettifyError, ZodError, z } from "zod/v4";
 
-import type { EnsApiPublicConfig } from "@ensnode/ensnode-sdk";
+import { type EnsApiPublicConfig, IndexingMetadataContextStatusCodes } from "@ensnode/ensnode-sdk";
 import {
   buildRpcConfigsFromEnv,
   canFallbackToTheGraph,
@@ -70,13 +70,13 @@ export async function buildConfigFromEnvironment(env: EnsApiEnvironment): Promis
     // https://github.com/namehash/ensnode/issues/1806
     const ensIndexerPublicConfig = await pRetry(
       async () => {
-        const config = await ensDbClient.getEnsIndexerPublicConfig();
+        const indexingMetadataContext = await ensDbClient.getIndexingMetadataContext();
 
-        if (!config) {
-          throw new Error("ENSIndexer Public Config not yet available in ENSDb.");
+        if (indexingMetadataContext.statusCode !== IndexingMetadataContextStatusCodes.Initialized) {
+          throw new Error("Indexing metadata context is uninitialized in ENSDb.");
         }
 
-        return config;
+        return indexingMetadataContext.stackInfo.ensIndexer;
       },
       {
         retries: 13, // This allows for a total of over 1 hour of retries with the exponential backoff strategy

apps/ensindexer/ponder/src/api/handlers/ensnode-api.ts

@@ -6,6 +6,7 @@ import {
   EnsIndexerIndexingStatusResponseCodes,
   type EnsIndexerIndexingStatusResponseError,
   type EnsIndexerIndexingStatusResponseOk,
+  IndexingMetadataContextStatusCodes,
   serializeEnsIndexerIndexingStatusResponse,
   serializeEnsIndexerPublicConfig,
 } from "@ensnode/ensnode-sdk";
@@ -17,32 +18,33 @@ const app = new Hono();
 
 // include ENSIndexer Public Config endpoint
 app.get("/config", async (c) => {
-  const publicConfig = await ensDbClient.getEnsIndexerPublicConfig();
+  const indexingMetadataContext = await ensDbClient.getIndexingMetadataContext();
 
   // Invariant: the public config is guaranteed to be available in ENSDb after
   // application startup.
-  if (typeof publicConfig === "undefined") {
+  if (indexingMetadataContext.statusCode !== IndexingMetadataContextStatusCodes.Initialized) {
     throw new Error("Unreachable: ENSIndexer Public Config is not available in ENSDb");
   }
 
   // respond with the serialized public config object
-  return c.json(serializeEnsIndexerPublicConfig(publicConfig));
+  return c.json(serializeEnsIndexerPublicConfig(indexingMetadataContext.stackInfo.ensIndexer));
 });
 
 app.get("/indexing-status", async (c) => {
   try {
-    const crossChainSnapshot = await ensDbClient.getIndexingStatusSnapshot();
+    const indexingMetadataContext = await ensDbClient.getIndexingMetadataContext();
 
     // Invariant: the Indexing Status Snapshot is expected to be available in
     // ENSDb shortly after application startup. There is a possibility that
     // the snapshot is not yet available at the time of the request,
     // i.e. when ENSDb has not yet been populated with the first snapshot.
     // In this case, we treat the snapshot as unavailable and respond with
     // an error response.
-    if (typeof crossChainSnapshot === "undefined") {
+    if (indexingMetadataContext.statusCode !== IndexingMetadataContextStatusCodes.Initialized) {
       throw new Error("ENSDb does not contain an Indexing Status Snapshot");
     }
 
+    const crossChainSnapshot = indexingMetadataContext.indexingStatus;
     const projectedAt = getUnixTime(new Date());
     const realtimeProjection = createRealtimeIndexingStatusProjection(
       crossChainSnapshot,

packages/integration-test-env/src/orchestrator.ts

@@ -39,7 +39,10 @@ import {
 } from "testcontainers";
 
 import { ENSNamespaceIds } from "@ensnode/datasources";
-import { OmnichainIndexingStatusIds } from "@ensnode/ensnode-sdk";
+import {
+  IndexingMetadataContextStatusCodes,
+  OmnichainIndexingStatusIds,
+} from "@ensnode/ensnode-sdk";
 
 const MONOREPO_ROOT = resolve(import.meta.dirname, "../../..");
 const ENSRAINBOW_DIR = resolve(MONOREPO_ROOT, "apps/ensrainbow");
@@ -198,9 +201,10 @@ async function pollIndexingStatus(
     while (Date.now() - start < timeoutMs) {
       checkAborted();
       try {
-        const snapshot = await ensDbClient.getIndexingStatusSnapshot();
-        if (snapshot !== undefined) {
-          const omnichainStatus = snapshot.omnichainSnapshot.omnichainStatus;
+        const indexingMetadataContext = await ensDbClient.getIndexingMetadataContext();
+
+        if (indexingMetadataContext.statusCode === IndexingMetadataContextStatusCodes.Initialized) {
+          const { omnichainStatus } = indexingMetadataContext.indexingStatus.omnichainSnapshot;
           log(`Omnichain status: ${omnichainStatus}`);
           if (
             omnichainStatus === OmnichainIndexingStatusIds.Following ||