perf(ensv2): address label-heal and DB-lookup hotspots

.changeset/config.json

@@ -27,7 +27,8 @@
       "@docs/ensnode",
       "@docs/ensrainbow",
       "@namehash/ens-referrals",
-      "@namehash/namehash-ui"
+      "@namehash/namehash-ui",
+      "@ensnode/ensindexer-perf-testing"
     ]
   ],
   "updateInternalDependencies": "patch",

.changeset/lovely-rooms-count.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensindexer-perf-testing": minor
+---
+
+Introduces the ENSIndexer Performance Testing package for running a local Prometheus x Grafana stack against an ENSIndexer instance.

.changeset/social-emus-sleep.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": patch
+---
+
+ENSIndexer's ensv2 plugin now avoids attempting to heal addr.reverse subnames if they've already been healed.

apps/ensindexer/src/lib/ensv2/label-db-helpers.ts

@@ -10,6 +10,14 @@ import {
 import { labelByLabelHash } from "@/lib/graphnode-helpers";
 import { ensIndexerSchema, type IndexingEngineContext } from "@/lib/indexing-engines/ponder";
 
+/**
+ * Determines whether the Label identified by `labelHash` has already been indexed.
+ */
+export async function labelExists(context: IndexingEngineContext, labelHash: LabelHash) {
+  const existing = await context.ensDb.find(ensIndexerSchema.label, { labelHash });
+  return existing !== null;
+}
+
 /**
  * Ensures that the LiteralLabel `label` is interpreted and upserted into the Label rainbow table.
  */
@@ -24,14 +32,11 @@ export async function ensureLabel(context: IndexingEngineContext, label: Literal
 }
 
 /**
- * Ensures that the LabelHash `labelHash` is available in the Label rainbow table, attempting an
- * ENSRainbow heal if this is the first time it has been encountered.
+ * Ensures that the LabelHash `labelHash` is available in the Label rainbow table, also attempting
+ * an ENSRainbow heal. To avoid duplicate ENSRainbow healing requests, callers must gate this
+ * function on {@link labelExists} returning false.
  */
 export async function ensureUnknownLabel(context: IndexingEngineContext, labelHash: LabelHash) {
-  // do nothing for existing labels, they're either healed or we don't know them
-  const exists = await context.ensDb.find(ensIndexerSchema.label, { labelHash });
-  if (exists) return;
-
   // attempt ENSRainbow heal
   const healedLabel = await labelByLabelHash(labelHash);
 

apps/ensindexer/src/lib/indexing-engines/ponder.test.ts

@@ -1,6 +1,8 @@
 import type { Context, EventNames } from "ponder:registry";
 import { beforeEach, describe, expect, expectTypeOf, it, vi } from "vitest";
 
+import "@/lib/__test__/mockLogger";
+
 import type { IndexingEngineContext, IndexingEngineEvent } from "./ponder";
 
 const { mockPonderOn } = vi.hoisted(() => ({ mockPonderOn: vi.fn() }));

apps/ensindexer/src/lib/indexing-engines/ponder.ts

@@ -16,6 +16,7 @@ import {
 } from "ponder:registry";
 
 import { waitForEnsRainbowToBeReady } from "@/lib/ensrainbow/singleton";
+import { logger } from "@/lib/logger";
 
 /**
  * Context passed to event handlers registered with
@@ -179,19 +180,48 @@ async function initializeIndexingActivation(): Promise<void> {
 let indexingSetupPromise: Promise<void> | null = null;
 let indexingActivationPromise: Promise<void> | null = null;
 
+// Cumulative events-per-second tracking across the process lifetime. Logged at most
+// once per minute. Overhead is one Date.now() and a counter increment per event.
+const EPS_LOG_INTERVAL_MS = 60_000;
+let epsTotalEvents = 0;
+let epsStartTime: number | null = null;
+let epsLastLogTime = 0;
+
+function recordEventForEps(): void {
+  const now = Date.now();
+  if (epsStartTime === null) {
+    epsStartTime = now;
+    epsLastLogTime = now;
+  }
+  epsTotalEvents++;
+  if (now - epsLastLogTime <= EPS_LOG_INTERVAL_MS) return;
+  const durationSec = (now - epsStartTime) / 1000;
+  logger.info({
+    msg: "Indexing throughput",
+    events: epsTotalEvents,
+    durationSec: Number(durationSec.toFixed(1)),
+    eps: Number((epsTotalEvents / durationSec).toFixed(2)),
+  });
+  epsLastLogTime = now;
+}
+
 /**
  * Execute any necessary preconditions before running an event handler
  * for a given event type.
  *
  * Some event handlers may have preconditions that need to be met before
  * they can run.
  *
- * This function is idempotent and will only execute its logic once, even if
- * called multiple times. This is to ensure that we affect the "hot path" of
- * indexing as little as possible, since this function is called for every
- * "onchain" event.
+ * The Setup and Onchain preconditions are memoized and execute their logic only
+ * once per process, regardless of how often this function is called — essential
+ * because it's invoked for every indexed event. EPS accounting via
+ * {@link recordEventForEps} runs on every call, but its hot-path cost is a
+ * single Date.now() and a counter increment; structured logging is emitted at
+ * most once per {@link EPS_LOG_INTERVAL_MS}.
  */
 async function eventHandlerPreconditions(eventType: EventTypeId): Promise<void> {
+  recordEventForEps();
+
   switch (eventType) {
     case EventTypeIds.Setup: {
       if (indexingSetupPromise === null) {

apps/ensindexer/src/lib/protocol-acceleration/registry-migration-status.ts

@@ -19,7 +19,7 @@ export async function nodeIsMigrated(context: IndexingEngineContext, node: Node)
   }
 
   const record = await context.ensDb.find(ensIndexerSchema.migratedNode, { node });
-  return !!record;
+  return record !== null;
 }
 
 /**

apps/ensindexer/src/plugins/ensv2/handlers/ensv1/ENSv1Registry.ts

@@ -15,7 +15,7 @@ import { getENSRootChainId, interpretAddress, PluginName } from "@ensnode/ensnod
 
 import { materializeENSv1DomainEffectiveOwner } from "@/lib/ensv2/domain-db-helpers";
 import { ensureDomainEvent } from "@/lib/ensv2/event-db-helpers";
-import { ensureLabel, ensureUnknownLabel } from "@/lib/ensv2/label-db-helpers";
+import { ensureLabel, ensureUnknownLabel, labelExists } from "@/lib/ensv2/label-db-helpers";
 import { healAddrReverseSubnameLabel } from "@/lib/heal-addr-reverse-subname-label";
 import {
   addOnchainEventListener,
@@ -58,22 +58,26 @@ export default function () {
     const domainId = makeENSv1DomainId(node);
     const parentId = makeENSv1DomainId(parentNode);
 
-    // If this is a direct subname of addr.reverse, we have 100% on-chain label discovery.
-    //
-    // Note: Per ENSIP-19, only the ENS Root chain may record primary names under the `addr.reverse`
-    // subname. Also per ENSIP-19 no Reverse Names need exist in (shadow)Registries on non-root
-    // chains, so we explicitly only support Root chain addr.reverse-based Reverse Names: ENSIP-19
-    // CoinType-specific Reverse Names (ex: [address].[coinType].reverse) don't actually exist in
-    // the ENS Registry: wildcard resolution is used, so this NewOwner event will never be emitted
-    // with a domain created as a child of a Coin-Type specific Reverse Node (ex: [coinType].reverse).
-    if (
-      parentNode === ADDR_REVERSE_NODE &&
-      context.chain.id === getENSRootChainId(config.namespace)
-    ) {
-      const label = await healAddrReverseSubnameLabel(context, event, labelHash);
-      await ensureLabel(context, label);
-    } else {
-      await ensureUnknownLabel(context, labelHash);
+    // only attempt to heal label if it doesn't already exist
+    const exists = await labelExists(context, labelHash);
+    if (!exists) {
+      // If this is a direct subname of addr.reverse, we have 100% on-chain label discovery.
+      //
+      // Note: Per ENSIP-19, only the ENS Root chain may record primary names under the `addr.reverse`
+      // subname. Also per ENSIP-19 no Reverse Names need exist in (shadow)Registries on non-root
+      // chains, so we explicitly only support Root chain addr.reverse-based Reverse Names: ENSIP-19
+      // CoinType-specific Reverse Names (ex: [address].[coinType].reverse) don't actually exist in
+      // the ENS Registry: wildcard resolution is used, so this NewOwner event will never be emitted
+      // with a domain created as a child of a Coin-Type specific Reverse Node (ex: [coinType].reverse).
+      if (
+        parentNode === ADDR_REVERSE_NODE &&
+        context.chain.id === getENSRootChainId(config.namespace)
+      ) {
+        const label = await healAddrReverseSubnameLabel(context, event, labelHash);
+        await ensureLabel(context, label);
+      } else {
+        await ensureUnknownLabel(context, labelHash);
+      }
     }
 
     // upsert domain

apps/ensindexer/src/plugins/ensv2/handlers/ensv1/RegistrarController.ts

@@ -12,7 +12,7 @@ import {
 import { type EncodedReferrer, PluginName, toJson } from "@ensnode/ensnode-sdk";
 
 import { ensureDomainEvent } from "@/lib/ensv2/event-db-helpers";
-import { ensureLabel, ensureUnknownLabel } from "@/lib/ensv2/label-db-helpers";
+import { ensureLabel, ensureUnknownLabel, labelExists } from "@/lib/ensv2/label-db-helpers";
 import { getLatestRegistration, getLatestRenewal } from "@/lib/ensv2/registration-db-helpers";
 import { getThisAccountId } from "@/lib/get-this-account-id";
 import {
@@ -63,11 +63,13 @@ export default function () {
       );
     }
 
-    // ensure label
+    // if the contract emitted a healed label, ensure that it is indexed
     if (label !== undefined) {
       await ensureLabel(context, label);
     } else {
-      await ensureUnknownLabel(context, labelHash);
+      // otherwise, attempt a heal if not exists
+      const exists = await labelExists(context, labelHash);
+      if (!exists) await ensureUnknownLabel(context, labelHash);
     }
 
     // update registration's base/premium
@@ -103,12 +105,13 @@ export default function () {
       );
     }
 
-    // ensure label
-    // NOTE: technically not necessary, as should be ensured by NameRegistered, but we include here anyway
+    // if the contract emitted a healed label, ensure that it is indexed
     if (label !== undefined) {
       await ensureLabel(context, label);
     } else {
-      await ensureUnknownLabel(context, labelHash);
+      // otherwise, attempt a heal if not exists
+      const exists = await labelExists(context, labelHash);
+      if (!exists) await ensureUnknownLabel(context, labelHash);
     }
 
     const controller = getThisAccountId(context, event);

packages/ensindexer-perf-testing/README.md

@@ -0,0 +1,33 @@
+# @ensnode/ensindexer-perf-testing
+
+Local Prometheus + Grafana bundle for benchmarking ENSIndexer throughput.
+
+## What's in the box
+
+- **Prometheus** on `http://localhost:9090`, scraping `host.docker.internal:42069/metrics` every 5s (6h retention, admin API enabled).
+- **Grafana** on `http://localhost:3001` (anonymous admin, no login) with a pre-provisioned Prometheus datasource and a **Ponder / ensindexer** dashboard.
+
+Dashboard panels are tuned for indexer perf work:
+
+- Top handlers by share of wall-clock time (`rate(ponder_indexing_function_duration_sum[1m]) / 1000`)
+- Handler p95 duration (top 15)
+- Events/sec per event and total
+- Total events per handler (bar gauge)
+- Synced block + historical blocks/sec per chain
+- RPC req/s + p95 duration per chain/method
+- Node event-loop lag p99, Postgres queue size, DB store queries/sec
+
+## Usage
+
+From this package's directory:
+
+```bash
+pnpm up       # start prometheus + grafana
+pnpm down     # stop and remove containers
+pnpm logs     # tail container logs
+pnpm wipe     # purge prometheus series (useful between benchmark runs)
+```
+
+Then start the indexer in another terminal (`pnpm -F ensindexer dev`) and open the dashboard at <http://localhost:3001/d/ensindexer>.
+
+The scrape target is `host.docker.internal:42069` — on macOS that resolves to the host via the `host-gateway` declaration in the compose file. On Linux hosts you may need Docker 20.10+ for the same behavior.

packages/ensindexer-perf-testing/docker-compose.yml

@@ -0,0 +1,31 @@
+services:
+  prometheus:
+    image: prom/prometheus:v2.55.1
+    container_name: ensnode-prometheus
+    # bound to loopback to avoid exposing publicly
+    ports:
+      - "127.0.0.1:9090:9090"
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
+    command:
+      - --config.file=/etc/prometheus/prometheus.yml
+      - --storage.tsdb.retention.time=6h
+      - --web.enable-admin-api
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+  grafana:
+    image: grafana/grafana:11.3.0
+    container_name: ensnode-grafana
+    # bound to loopback to avoid exposing publicly
+    ports:
+      - "127.0.0.1:3001:3000"
+    environment:
+      GF_AUTH_ANONYMOUS_ENABLED: "true"
+      GF_AUTH_ANONYMOUS_ORG_ROLE: Admin
+      GF_AUTH_DISABLE_LOGIN_FORM: "true"
+    volumes:
+      - ./grafana/provisioning:/etc/grafana/provisioning:ro
+      - ./grafana/dashboards:/var/lib/grafana/dashboards:ro
+    depends_on:
+      - prometheus