@lodestar/api 1.35.0-dev.b42a298a7c → 1.35.0-dev.ba92bd8a88

package/src/beacon/client/events.ts

@@ -0,0 +1,69 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {getEventSource} from "../../utils/client/eventSource.js";
+import {stringifyQuery, urlJoin} from "../../utils/client/format.js";
+import {ApiClientMethods} from "../../utils/client/method.js";
+import {RouteDefinitionExtra} from "../../utils/client/request.js";
+import {ApiResponse} from "../../utils/client/response.js";
+import {BeaconEvent, Endpoints, getDefinitions, getEventSerdes} from "../routes/events.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for events routes
+ */
+export function getClient(config: ChainForkConfig, baseUrl: string): ApiClient {
+  const definitions = getDefinitions(config);
+  const eventSerdes = getEventSerdes(config);
+
+  return {
+    eventstream: async ({
+      topics,
+      signal,
+      onEvent,
+      onError,
+      onClose,
+    }): Promise<ApiResponse<Endpoints["eventstream"]>> => {
+      const query = stringifyQuery({topics});
+      const url = `${urlJoin(baseUrl, definitions.eventstream.url)}?${query}`;
+      const EventSource = await getEventSource();
+      const eventSource = new EventSource(url);
+
+      const close = (): void => {
+        eventSource.close();
+        onClose?.();
+        signal.removeEventListener("abort", close);
+      };
+      signal.addEventListener("abort", close, {once: true});
+
+      for (const topic of topics) {
+        eventSource.addEventListener(topic, (event: MessageEvent) => {
+          const message = eventSerdes.fromJson(topic, JSON.parse(event.data));
+          onEvent({type: topic, message} as BeaconEvent);
+        });
+      }
+
+      // EventSource will try to reconnect always on all errors
+      // `eventSource.onerror` events are informative but don't indicate the EventSource closed
+      // The only way to abort the connection from the client is via eventSource.close()
+      eventSource.onerror = function onerror(err): void {
+        const errEs = err as unknown as EventSourceError;
+
+        // Ignore noisy errors due to beacon node being offline
+        if (!/ECONNREFUSED|EAI_AGAIN/.test(errEs.message ?? "")) {
+          // If there is no message it likely indicates that the server closed the connection
+          onError?.(new Error(errEs.message ?? "Server closed connection"));
+        }
+
+        // Consider 400 and 500 status errors unrecoverable, close the eventsource
+        if (errEs.status === 400 || errEs.status === 500) {
+          close();
+        }
+      };
+
+      return new ApiResponse(definitions.eventstream as RouteDefinitionExtra<Endpoints["eventstream"]>);
+    },
+  };
+}
+
+// https://github.com/EventSource/eventsource/blob/82e034389bd2c08d532c63172b8e858c5b185338/lib/eventsource.js#L143
+type EventSourceError = {status?: number; message?: string};

package/src/beacon/client/index.ts

@@ -0,0 +1,46 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {
+  ApiClientMethods,
+  HttpClient,
+  HttpClientModules,
+  HttpClientOptions,
+  IHttpClient,
+} from "../../utils/client/index.js";
+import {Endpoints} from "../routes/index.js";
+import * as beacon from "./beacon.js";
+import * as configApi from "./config.js";
+import * as debug from "./debug.js";
+import * as events from "./events.js";
+import * as lightclient from "./lightclient.js";
+import * as lodestar from "./lodestar.js";
+import * as node from "./node.js";
+import * as proof from "./proof.js";
+import * as validator from "./validator.js";
+
+type ClientModules = HttpClientModules & {
+  config: ChainForkConfig;
+  httpClient?: IHttpClient;
+};
+
+export type ApiClient = {[K in keyof Endpoints]: ApiClientMethods<Endpoints[K]>} & {httpClient: IHttpClient};
+
+/**
+ * REST HTTP client for all routes
+ */
+export function getClient(opts: HttpClientOptions, modules: ClientModules): ApiClient {
+  const {config} = modules;
+  const httpClient = modules.httpClient ?? new HttpClient(opts, modules);
+
+  return {
+    beacon: beacon.getClient(config, httpClient),
+    config: configApi.getClient(config, httpClient),
+    debug: debug.getClient(config, httpClient),
+    events: events.getClient(config, httpClient.baseUrl),
+    lightclient: lightclient.getClient(config, httpClient),
+    lodestar: lodestar.getClient(config, httpClient),
+    node: node.getClient(config, httpClient),
+    proof: proof.getClient(config, httpClient),
+    validator: validator.getClient(config, httpClient),
+    httpClient,
+  };
+}

package/src/beacon/client/lightclient.ts

@@ -0,0 +1,12 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {ApiClientMethods, IHttpClient, createApiClientMethods} from "../../utils/client/index.js";
+import {Endpoints, getDefinitions} from "../routes/lightclient.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for lightclient routes
+ */
+export function getClient(config: ChainForkConfig, httpClient: IHttpClient): ApiClient {
+  return createApiClientMethods(getDefinitions(config), httpClient);
+}

package/src/beacon/client/lodestar.ts

@@ -0,0 +1,12 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {ApiClientMethods, IHttpClient, createApiClientMethods} from "../../utils/client/index.js";
+import {Endpoints, getDefinitions} from "../routes/lodestar.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for lodestar routes
+ */
+export function getClient(config: ChainForkConfig, httpClient: IHttpClient): ApiClient {
+  return createApiClientMethods(getDefinitions(config), httpClient);
+}

package/src/beacon/client/node.ts

@@ -0,0 +1,12 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {ApiClientMethods, IHttpClient, createApiClientMethods} from "../../utils/client/index.js";
+import {Endpoints, getDefinitions} from "../routes/node.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for beacon routes
+ */
+export function getClient(config: ChainForkConfig, httpClient: IHttpClient): ApiClient {
+  return createApiClientMethods(getDefinitions(config), httpClient);
+}

package/src/beacon/client/proof.ts

@@ -0,0 +1,12 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {ApiClientMethods, IHttpClient, createApiClientMethods} from "../../utils/client/index.js";
+import {Endpoints, getDefinitions} from "../routes/proof.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for proof routes
+ */
+export function getClient(config: ChainForkConfig, httpClient: IHttpClient): ApiClient {
+  return createApiClientMethods(getDefinitions(config), httpClient);
+}

package/src/beacon/client/validator.ts

@@ -0,0 +1,12 @@
+import {ChainForkConfig} from "@lodestar/config";
+import {ApiClientMethods, IHttpClient, createApiClientMethods} from "../../utils/client/index.js";
+import {Endpoints, getDefinitions} from "../routes/validator.js";
+
+export type ApiClient = ApiClientMethods<Endpoints>;
+
+/**
+ * REST HTTP client for validator routes
+ */
+export function getClient(config: ChainForkConfig, httpClient: IHttpClient): ApiClient {
+  return createApiClientMethods(getDefinitions(config), httpClient);
+}

package/src/beacon/index.ts

@@ -0,0 +1,24 @@
+import type {Endpoints} from "./routes/index.js";
+
+// NOTE: Don't export server here so it's not bundled to all consumers
+
+import * as routes from "./routes/index.js";
+export {routes};
+
+export {type ApiClient, getClient} from "./client/index.js";
+export type {Endpoints};
+
+// Declare namespaces for CLI options
+export type ApiNamespace = keyof Endpoints;
+const allNamespacesObj: {[K in keyof Endpoints]: true} = {
+  beacon: true,
+  config: true,
+  debug: true,
+  events: true,
+  lightclient: true,
+  lodestar: true,
+  node: true,
+  proof: true,
+  validator: true,
+};
+export const allNamespaces = Object.keys(allNamespacesObj) as ApiNamespace[];