feat(ensnode-sdk): introduce EnsIndexerClient (#1643)

Author: tk-o

.changeset/petite-rings-accept.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensnode-sdk": minor
+---
+
+Introduces `EnsIndexerClient` class, supporting easy interactions with ENSIndexer APIs.

packages/ensnode-sdk/src/ensapi/client.test.ts

@@ -200,9 +200,9 @@ const _EXAMPLE_INDEXING_STATUS_FOLLOWING_RESPONSE: EnsApiIndexingStatusResponse
     responseCode: EnsApiIndexingStatusResponseCodes.Ok,
   });
 
-// Mock fetch globally
+// Mock fetch globally (auto-restored by vitest)
 const mockFetch = vi.fn();
-global.fetch = mockFetch;
+vi.stubGlobal("fetch", mockFetch);
 
 describe("EnsApiClient", () => {
   beforeEach(() => {

packages/ensnode-sdk/src/ensapi/client.ts

@@ -33,11 +33,18 @@ import { getDefaultEnsNodeUrl } from "./deployments";
 /**
  * Configuration options for ENSNode API client
  */
-export interface ClientOptions {
+export interface EnsApiClientOptions {
   /** The ENSNode API URL */
   url: URL;
 }
 
+/**
+ * Configuration options for ENSNode API client
+ *
+ * @deprecated Use {@link EnsApiClientOptions} instead.
+ */
+export type ClientOptions = EnsApiClientOptions;
+
 /**
  * EnsApi Client
  *
@@ -93,22 +100,22 @@ export interface ClientOptions {
  * ```
  */
 export class EnsApiClient {
-  private readonly options: ClientOptions;
+  private readonly options: EnsApiClientOptions;
 
-  static defaultOptions(): ClientOptions {
+  static defaultOptions(): EnsApiClientOptions {
     return {
       url: getDefaultEnsNodeUrl(),
     };
   }
 
-  constructor(options: Partial<ClientOptions> = {}) {
+  constructor(options: Partial<EnsApiClientOptions> = {}) {
     this.options = {
       ...EnsApiClient.defaultOptions(),
       ...options,
     };
   }
 
-  getOptions(): Readonly<ClientOptions> {
+  getOptions(): Readonly<EnsApiClientOptions> {
     return Object.freeze({
       url: new URL(this.options.url.href),
     });
@@ -311,7 +318,7 @@ export class EnsApiClient {
    * @returns {EnsApiConfigResponse}
    *
    * @throws if the ENSApi request fails
-   * @throws if the ENSApi returns an error response
+   * @throws if the ENSApi returns a non-ok response
    * @throws if the ENSApi response breaks required invariants
    */
   async config(): Promise<EnsApiConfigResponse> {
@@ -342,7 +349,7 @@ export class EnsApiClient {
    * @returns {EnsApiIndexingStatusResponse}
    *
    * @throws if the ENSApi request fails
-   * @throws if the ENSApi returns an error response
+   * @throws if the ENSApi returns a non-ok response
    * @throws if the ENSApi response breaks required invariants
    */
   async indexingStatus(): Promise<EnsApiIndexingStatusResponse> {
@@ -366,9 +373,7 @@ export class EnsApiClient {
       try {
         errorResponse = deserializeErrorResponse(responseData);
       } catch {
-        // if errorResponse could not be determined,
-        // it means the response includes indexing status data
-        console.log("Indexing Status API: handling a known indexing status server error.");
+        // No-op: allow subsequent deserialization of indexing status response.
       }
 
       // however, if errorResponse was defined,

packages/ensnode-sdk/src/ensapi/index.ts

@@ -1,5 +1,10 @@
 export * from "./api";
-export { type ClientOptions, ENSNodeClient, EnsApiClient } from "./client";
+export {
+  type ClientOptions,
+  ENSNodeClient,
+  EnsApiClient,
+  type EnsApiClientOptions,
+} from "./client";
 export * from "./client-error";
 export * from "./config";
 export * from "./deployments";

packages/ensnode-sdk/src/ensindexer/api/config/deserialize.ts

@@ -0,0 +1,13 @@
+import type { Unvalidated } from "../../../shared/types";
+import { deserializeEnsIndexerPublicConfig } from "../../config/deserialize";
+import type { EnsIndexerConfigResponse } from "./response";
+import type { SerializedEnsIndexerConfigResponse } from "./serialized-response";
+
+/**
+ * Deserialize value into {@link EnsIndexerConfigResponse} object.
+ */
+export function deserializeEnsIndexerConfigResponse(
+  maybeResponse: Unvalidated<SerializedEnsIndexerConfigResponse>,
+): EnsIndexerConfigResponse {
+  return deserializeEnsIndexerPublicConfig(maybeResponse, "EnsIndexerConfigResponse");
+}

packages/ensnode-sdk/src/ensindexer/api/config/index.ts

@@ -0,0 +1,4 @@
+export * from "./deserialize";
+export * from "./response";
+export * from "./serialize";
+export * from "./serialized-response";

packages/ensnode-sdk/src/ensindexer/api/config/response.ts

@@ -0,0 +1,6 @@
+import type { EnsIndexerPublicConfig } from "../../config/types";
+
+/**
+ * ENSIndexer Public Config Response
+ */
+export type EnsIndexerConfigResponse = EnsIndexerPublicConfig;

packages/ensnode-sdk/src/ensindexer/api/config/serialize.ts

@@ -0,0 +1,9 @@
+import { serializeEnsIndexerPublicConfig } from "../../config/serialize";
+import type { EnsIndexerConfigResponse } from "./response";
+import type { SerializedEnsIndexerConfigResponse } from "./serialized-response";
+
+export function serializeEnsIndexerConfigResponse(
+  response: EnsIndexerConfigResponse,
+): SerializedEnsIndexerConfigResponse {
+  return serializeEnsIndexerPublicConfig(response);
+}

packages/ensnode-sdk/src/ensindexer/api/config/serialized-response.ts

@@ -0,0 +1,3 @@
+import type { SerializedEnsIndexerPublicConfig } from "../../config/serialized-types";
+
+export type SerializedEnsIndexerConfigResponse = SerializedEnsIndexerPublicConfig;

packages/ensnode-sdk/src/ensindexer/api/index.ts

@@ -0,0 +1,2 @@
+export * from "./config";
+export * from "./indexing-status";