@lodestar/api/src/builder/index.ts

A Typescript REST client for the Ethereum Consensus API

import {ChainForkConfig} from "@lodestar/config";
import {HttpClient, HttpClientModules, HttpClientOptions, IHttpClient} from "../utils/client/httpClient.js";
import type {ApiClient} from "./client.js";
import * as builder from "./client.js";
import {Endpoints} from "./routes.js";

// NOTE: Don't export server here so it's not bundled to all consumers

export type {ApiClient, Endpoints};

// Note: builder API does not have namespaces as routes are declared at the "root" namespace

type ClientModules = HttpClientModules & {
  config: ChainForkConfig;
  httpClient?: IHttpClient;
};

/**
 * REST HTTP client for builder routes
 */
export function getClient(opts: HttpClientOptions, modules: ClientModules): ApiClient {
  const {config} = modules;
  const httpClient = modules.httpClient ?? new HttpClient(opts, modules);

  return builder.getClient(config, httpClient);
}