@ensnode/ensnode-sdk 1.13.1 → 1.15.0

package/dist/index.js

@@ -363,6 +363,7 @@ var PluginName = /* @__PURE__ */ ((PluginName2) => {
   PluginName2["Registrars"] = "registrars";
   PluginName2["TokenScope"] = "tokenscope";
   PluginName2["ENSv2"] = "ensv2";
+  PluginName2["Unigraph"] = "unigraph";
   return PluginName2;
 })(PluginName || {});
 
@@ -1491,14 +1492,26 @@ function invariant_realtimeIndexingStatusProjectionWorstCaseDistanceIsCorrect(ct
   }
 }
 var makeRealtimeIndexingStatusProjectionSchema = (valueLabel = "Realtime Indexing Status Projection") => z9.object({
-  projectedAt: makeUnixTimestampSchema(valueLabel),
-  worstCaseDistance: makeDurationSchema(valueLabel),
-  snapshot: makeCrossChainIndexingStatusSnapshotSchema(valueLabel)
+  projectedAt: makeUnixTimestampSchema(valueLabel).describe(
+    "The timestamp representing 'now' as of the time this projection was generated."
+  ),
+  worstCaseDistance: makeDurationSchema(valueLabel).describe(
+    "The distance between `projectedAt` and `snapshot.slowestChainIndexingCursor` in seconds. This is a worst-case distance because it assumes no indexing progress has been made since `snapshot.snapshotTime` and that each indexed chain has added a new block as of `projectedAt`."
+  ),
+  snapshot: makeCrossChainIndexingStatusSnapshotSchema(valueLabel).describe(
+    "The cross-chain indexing status snapshot that this projection is based on."
+  )
 }).check(invariant_realtimeIndexingStatusProjectionProjectedAtIsAfterOrEqualToSnapshotTime).check(invariant_realtimeIndexingStatusProjectionWorstCaseDistanceIsCorrect);
 var makeSerializedRealtimeIndexingStatusProjectionSchema = (valueLabel = "Value") => z9.object({
-  snapshot: makeSerializedCrossChainIndexingStatusSnapshotSchema(valueLabel),
-  projectedAt: makeUnixTimestampSchema(valueLabel),
-  worstCaseDistance: makeDurationSchema(valueLabel)
+  snapshot: makeSerializedCrossChainIndexingStatusSnapshotSchema(valueLabel).describe(
+    "The cross-chain indexing status snapshot that this projection is based on."
+  ),
+  projectedAt: makeUnixTimestampSchema(valueLabel).describe(
+    "The timestamp representing 'now' as of the time this projection was generated."
+  ),
+  worstCaseDistance: makeDurationSchema(valueLabel).describe(
+    "The distance between `projectedAt` and `snapshot.slowestChainIndexingCursor` in seconds. This is a worst-case distance because it assumes no indexing progress has been made since `snapshot.snapshotTime` and that each indexed chain has added a new block as of `projectedAt`."
+  )
 });
 
 // src/indexing-status/deserialize/cross-chain-indexing-status-snapshot.ts
@@ -2684,8 +2697,8 @@ function getNameTokenOwnership(namespaceId, name, owner) {
 // src/ensnode/api/shared/errors/zod-schemas.ts
 import { z as z16 } from "zod/v4";
 var makeErrorResponseSchema = () => z16.object({
-  message: z16.string(),
-  details: z16.optional(z16.unknown())
+  message: z16.string().describe("A description of the error that occurred."),
+  details: z16.optional(z16.unknown()).describe("Additional details about the error.")
 });
 
 // src/ensnode/api/name-tokens/response.ts
@@ -4126,15 +4139,28 @@ function isResolvedIdentity(identity) {
   return identity.resolutionStatus !== ResolutionStatusIds.Unresolved;
 }
 
+// src/ensnode/api/prerequisites.ts
+function hasBackfillCompleted(indexingStatus) {
+  const supported = indexingStatus === OmnichainIndexingStatusIds.Completed || indexingStatus === OmnichainIndexingStatusIds.Following;
+  if (supported) return { supported };
+  return {
+    supported: false,
+    reason: `The connected ENSNode's Indexing Status must be "${OmnichainIndexingStatusIds.Completed}" or "${OmnichainIndexingStatusIds.Following}". Currently, it is "${indexingStatus}".`
+  };
+}
+
 // src/omnigraph-api/prerequisites.ts
 function hasOmnigraphApiConfigSupport(config) {
-  const supported = config.plugins.includes("ensv2" /* ENSv2 */);
+  const supported = config.plugins.includes("unigraph" /* Unigraph */) || config.plugins.includes("ensv2" /* ENSv2 */);
   if (supported) return { supported };
   return {
     supported: false,
-    reason: `The connected ENSNode's Config must have the '${"ensv2" /* ENSv2 */}' plugin enabled.`
+    reason: `The connected ENSNode's Config must have the '${"unigraph" /* Unigraph */}' plugin enabled.`
   };
 }
+function hasOmnigraphApiIndexingStatusSupport(indexingStatus) {
+  return hasBackfillCompleted(indexingStatus);
+}
 
 // src/registrars/registration-expiration.ts
 function isRegistrationExpired(info, now) {
@@ -4414,6 +4440,30 @@ var SWRCache = class {
     }
     return this.cache.result;
   }
+  /**
+   * Synchronously returns the most recently cached result without triggering revalidation.
+   *
+   * Unlike {@link read}, this method is synchronous and never causes any I/O — it simply
+   * returns whatever value is already in memory. Use this when you need a best-effort
+   * snapshot of the cached value and can tolerate stale data.
+   *
+   * @returns the most recently cached `ValueType`, or an `Error` if the last fetch failed.
+   * @throws if the cache has not been initialized yet (i.e. {@link read} has never been awaited
+   * and `proactivelyInitialize` was not set to `true`).
+   *
+   * @example
+   * ```ts
+   * // Ensure cache is initialized first
+   * await cache.read();
+   *
+   * // Later, peek synchronously without triggering revalidation
+   * const result = cache.peek();
+   * ```
+   */
+  peek() {
+    if (!this.cache) throw new Error("Cache is not initialized yet");
+    return this.cache.result;
+  }
   /**
    * Destroys the background revalidation interval, if exists.
    */
@@ -4494,7 +4544,7 @@ var TtlCache = class {
 import {
   maybeGetDatasource as maybeGetDatasource2
 } from "@ensnode/datasources";
-function buildIndexedBlockranges(namespace, pluginsDatasourceNames) {
+function buildIndexedBlockranges(namespace, globalBlockrangeEndBlock, pluginsDatasourceNames) {
   const indexedBlockranges = /* @__PURE__ */ new Map();
   for (const [, datasourceNames] of pluginsDatasourceNames) {
     for (const datasourceName of datasourceNames) {
@@ -4504,9 +4554,12 @@ function buildIndexedBlockranges(namespace, pluginsDatasourceNames) {
       const datasourceContracts = Object.values(datasource.contracts);
       for (const datasourceContract of datasourceContracts) {
         const currentChainIndexedBlockrange = indexedBlockranges.get(datasourceChainId);
+        if (typeof globalBlockrangeEndBlock === "number" && datasourceContract.startBlock > globalBlockrangeEndBlock) {
+          continue;
+        }
         const contractIndexedBlockrange = buildBlockNumberRange(
           datasourceContract.startBlock,
-          datasourceContract.endBlock
+          datasourceContract.endBlock ?? globalBlockrangeEndBlock
         );
         const indexedBlockrange = currentChainIndexedBlockrange ? mergeBlockNumberRanges(currentChainIndexedBlockrange, contractIndexedBlockrange) : contractIndexedBlockrange;
         if (indexedBlockrange.rangeType !== RangeTypeIds.LeftBounded && indexedBlockrange.rangeType !== RangeTypeIds.Bounded) {
@@ -4782,6 +4835,9 @@ function hasSubgraphApiConfigSupport(config) {
     reason: `The connected ENSNode's Config must have the '${"subgraph" /* Subgraph */}' plugin enabled.`
   };
 }
+function hasSubgraphApiIndexingStatusSupport(indexingStatus) {
+  return hasBackfillCompleted(indexingStatus);
+}
 
 // src/tracing/ens-protocol-tracing.ts
 var PROTOCOL_ATTRIBUTE_PREFIX = "ens";
@@ -4945,9 +5001,11 @@ export {
   getTimestampForLowestOmnichainStartBlock,
   hasNullByte,
   hasOmnigraphApiConfigSupport,
+  hasOmnigraphApiIndexingStatusSupport,
   hasRegistrarActionsConfigSupport,
   hasRegistrarActionsIndexingStatusSupport,
   hasSubgraphApiConfigSupport,
+  hasSubgraphApiIndexingStatusSupport,
   interpretAddress,
   interpretAddressRecordValue,
   interpretContenthashValue,