Apply specific variant types for ChainIndexingMetrics

packages/ponder-sdk/src/chains.ts

@@ -14,3 +14,8 @@ export const schemaChainId = schemaPositiveInteger;
  * Chain id standards are organized by the Ethereum Community @ https://github.com/ethereum-lists/chains
  **/
 export type ChainId = z.infer<typeof schemaChainId>;
+
+/**
+ * String representation of a valid Chain ID.
+ */
+export type ChainIdString = string;

packages/ponder-sdk/src/client.test.ts

@@ -124,12 +124,6 @@ describe("Ponder Client", () => {
           expect(errorMessage).toContain(
             "Missing required Prometheus metric: ponder_historical_total_blocks",
           );
-          expect(errorMessage).toContain(
-            "Missing required Prometheus metric: ponder_sync_is_complete",
-          );
-          expect(errorMessage).toContain(
-            "Missing required Prometheus metric: ponder_sync_is_realtime",
-          );
         }
       });
 
@@ -151,11 +145,21 @@ describe("Ponder Client", () => {
           const errorMessage = error instanceof Error ? error.message : "unknown error";
           // Assert
           expect(errorMessage).toContain("Invalid serialized Ponder Indexing Metrics");
-          expect(errorMessage).toContain("'optimism' must be a string representing a chain ID");
-          expect(errorMessage).toContain("'mainnet' must be a string representing a chain ID");
-          expect(errorMessage).toContain("'base' must be a string representing a chain ID");
-          expect(errorMessage).toContain("'scroll' must be a string representing a chain ID");
-          expect(errorMessage).toContain("'linea' must be a string representing a chain ID");
+          expect(errorMessage).toContain(
+            "metric must be a string representing a valid ChainId, but got: 'optimism'",
+          );
+          expect(errorMessage).toContain(
+            "metric must be a string representing a valid ChainId, but got: 'mainnet'",
+          );
+          expect(errorMessage).toContain(
+            "metric must be a string representing a valid ChainId, but got: 'base'",
+          );
+          expect(errorMessage).toContain(
+            "metric must be a string representing a valid ChainId, but got: 'scroll'",
+          );
+          expect(errorMessage).toContain(
+            "metric must be a string representing a valid ChainId, but got: 'linea'",
+          );
         }
       });
 
@@ -189,7 +193,7 @@ describe("Ponder Client", () => {
 
         // Act & Assert
         await expect(ponderClient.metrics()).rejects.toThrowError(
-          /Invalid serialized Ponder Indexing Metrics.*Chain Indexing Metrics cannot have both `indexingCompleted` and `indexingRealtime` as `true`/,
+          /Invalid serialized Ponder Indexing Metrics.*'ponder_sync_is_complete' and 'ponder_sync_is_realtime' metrics cannot both be 1 at the same time for chain 10/,
         );
       });
     });

packages/ponder-sdk/src/deserialize/indexing-metrics.mock.ts

@@ -1,4 +1,6 @@
 import {
+  type ChainIndexingMetricsRealtime,
+  ChainIndexingStates,
   PonderAppCommands,
   type PonderIndexingMetrics,
   PonderIndexingOrderings,
@@ -55,56 +57,44 @@ ponder_historical_total_blocks{chain="59144"} 21873991
       [
         10,
         {
-          backfillSyncBlocksTotal: 36827849,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 147268938, timestamp: 1770136653 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
       [
         1,
         {
-          backfillSyncBlocksTotal: 21042285,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 24377568, timestamp: 1770136655 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
       [
         8453,
         {
-          backfillSyncBlocksTotal: 24103899,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 41673653, timestamp: 1770136653 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
       [
         534352,
         {
-          backfillSyncBlocksTotal: 12693186,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 29373405, timestamp: 1770136654 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
       [
         42161,
         {
-          backfillSyncBlocksTotal: 78607197,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 428248999, timestamp: 1770136654 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
       [
         59144,
         {
-          backfillSyncBlocksTotal: 21873991,
-          indexingCompleted: false,
-          indexingRealtime: true,
+          state: ChainIndexingStates.Realtime,
           latestSyncedBlock: { number: 28584906, timestamp: 1770136654 },
-        },
+        } satisfies ChainIndexingMetricsRealtime,
       ],
     ]),
   } satisfies PonderIndexingMetrics,
@@ -215,15 +205,15 @@ ponder_sync_is_realtime{chain="1"} 1
 ponder_sync_is_realtime{chain="59144"} 1
 ponder_sync_is_realtime{chain="8453"} 1
 
+# HELP ponder_sync_is_complete Boolean (0 or 1) indicating if the sync has synced all blocks
+# TYPE ponder_sync_is_complete gauge
 ponder_sync_is_complete{chain="42161"} 1
 ponder_sync_is_complete{chain="534352"} 1
 ponder_sync_is_complete{chain="10"} 1
 ponder_sync_is_complete{chain="1"} 1
 ponder_sync_is_complete{chain="59144"} 1
 ponder_sync_is_complete{chain="8453"} 1
 
-# HELP ponder_sync_is_complete Boolean (0 or 1) indicating if the sync has synced all blocks
-# TYPE ponder_sync_is_complete gauge
 
 # HELP ponder_historical_total_blocks Number of blocks required for the historical sync
 # TYPE ponder_historical_total_blocks gauge