@lodestar/api 1.20.0-dev.14855ea72f → 1.20.0-dev.26e9bc4b15

package/lib/beacon/routes/lightclient.d.ts

@@ -1,9 +1,13 @@
+import { ListCompositeType, ValueOf } from "@chainsafe/ssz";
 import { SyncPeriod, allForks } from "@lodestar/types";
 import { ForkName } from "@lodestar/params";
-import { ReturnTypes, RoutesData, ReqSerializers, ReqEmpty } from "../../utils/index.js";
-import { HttpStatusCode } from "../../utils/client/httpStatusCode.js";
-import { ApiClientResponse } from "../../interfaces.js";
-export type Api = {
+import { ChainForkConfig } from "@lodestar/config";
+import { Endpoint, RouteDefinitions } from "../../utils/index.js";
+import { VersionMeta } from "../../utils/metadata.js";
+import { EmptyArgs, EmptyMeta, EmptyRequest } from "../../utils/codecs.js";
+export declare const HashListType: ListCompositeType<import("@chainsafe/ssz").ByteVectorType>;
+export type HashList = ValueOf<typeof HashListType>;
+export type Endpoints = {
     /**
      * Returns an array of best updates given a `startPeriod` and `count` number of sync committee period to return.
      * Best is defined by (in order of priority):
@@ -11,73 +15,47 @@ export type Api = {
      * - Has most bits
      * - Oldest update
      */
-    getUpdates(startPeriod: SyncPeriod, count: number): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            version: ForkName;
-            data: allForks.LightClientUpdate;
-        }[];
-    }>>;
+    getLightClientUpdatesByRange: Endpoint<"GET", {
+        startPeriod: SyncPeriod;
+        count: number;
+    }, {
+        query: {
+            start_period: number;
+            count: number;
+        };
+    }, allForks.LightClientUpdate[], {
+        versions: ForkName[];
+    }>;
     /**
      * Returns the latest optimistic head update available. Clients should use the SSE type `light_client_optimistic_update`
      * unless to get the very first head update after syncing, or if SSE are not supported by the server.
      */
-    getOptimisticUpdate(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            version: ForkName;
-            data: allForks.LightClientOptimisticUpdate;
-        };
-    }>>;
-    getFinalityUpdate(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            version: ForkName;
-            data: allForks.LightClientFinalityUpdate;
-        };
-    }>>;
+    getLightClientOptimisticUpdate: Endpoint<"GET", EmptyArgs, EmptyRequest, allForks.LightClientOptimisticUpdate, VersionMeta>;
+    getLightClientFinalityUpdate: Endpoint<"GET", EmptyArgs, EmptyRequest, allForks.LightClientFinalityUpdate, VersionMeta>;
     /**
      * Fetch a bootstrapping state with a proof to a trusted block root.
      * The trusted block root should be fetched with similar means to a weak subjectivity checkpoint.
      * Only block roots for checkpoints are guaranteed to be available.
      */
-    getBootstrap(blockRoot: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            version: ForkName;
-            data: allForks.LightClientBootstrap;
+    getLightClientBootstrap: Endpoint<"GET", {
+        blockRoot: string;
+    }, {
+        params: {
+            block_root: string;
         };
-    }>>;
+    }, allForks.LightClientBootstrap, VersionMeta>;
     /**
      * Returns an array of sync committee hashes based on the provided period and count
      */
-    getCommitteeRoot(startPeriod: SyncPeriod, count: number): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: Uint8Array[];
-        };
-    }>>;
-};
-/**
- * Define javascript values for each route
- */
-export declare const routesData: RoutesData<Api>;
-export type ReqTypes = {
-    getUpdates: {
-        query: {
-            start_period: number;
-            count: number;
-        };
-    };
-    getOptimisticUpdate: ReqEmpty;
-    getFinalityUpdate: ReqEmpty;
-    getBootstrap: {
-        params: {
-            block_root: string;
-        };
-    };
-    getCommitteeRoot: {
+    getLightClientCommitteeRoot: Endpoint<"GET", {
+        startPeriod: SyncPeriod;
+        count: number;
+    }, {
         query: {
             start_period: number;
             count: number;
         };
-    };
+    }, HashList, EmptyMeta>;
 };
-export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
-export declare function getReturnTypes(): ReturnTypes<Api>;
+export declare function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpoints>;
 //# sourceMappingURL=lightclient.d.ts.map

package/lib/beacon/routes/lightclient.js

@@ -1,55 +1,115 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { ListCompositeType } from "@chainsafe/ssz";
 import { ssz } from "@lodestar/types";
-import { isForkLightClient } from "@lodestar/params";
-import { ArrayOf, Schema, reqEmpty, WithVersion, ContainerData, } from "../../utils/index.js";
-import { HttpStatusCode } from "../../utils/client/httpStatusCode.js";
-/**
- * Define javascript values for each route
- */
-export const routesData = {
-    getUpdates: { url: "/eth/v1/beacon/light_client/updates", method: "GET" },
-    getOptimisticUpdate: { url: "/eth/v1/beacon/light_client/optimistic_update", method: "GET" },
-    getFinalityUpdate: { url: "/eth/v1/beacon/light_client/finality_update", method: "GET" },
-    getBootstrap: { url: "/eth/v1/beacon/light_client/bootstrap/{block_root}", method: "GET" },
-    getCommitteeRoot: { url: "/eth/v0/beacon/light_client/committee_root", method: "GET" },
-};
-export function getReqSerializers() {
+import { Schema } from "../../utils/index.js";
+import { VersionCodec } from "../../utils/metadata.js";
+import { getLightClientForkTypes, toForkName } from "../../utils/fork.js";
+import { EmptyRequestCodec, EmptyMetaCodec, WithVersion, JsonOnlyResp, } from "../../utils/codecs.js";
+// See /packages/api/src/routes/index.ts for reasoning and instructions to add new routes
+export const HashListType = new ListCompositeType(ssz.Root, 10000);
+export function getDefinitions(_config) {
     return {
-        getUpdates: {
-            writeReq: (start_period, count) => ({ query: { start_period, count } }),
-            parseReq: ({ query }) => [query.start_period, query.count],
-            schema: { query: { start_period: Schema.UintRequired, count: Schema.UintRequired } },
+        getLightClientUpdatesByRange: {
+            url: "/eth/v1/beacon/light_client/updates",
+            method: "GET",
+            req: {
+                writeReq: ({ startPeriod, count }) => ({ query: { start_period: startPeriod, count } }),
+                parseReq: ({ query }) => ({ startPeriod: query.start_period, count: query.count }),
+                schema: { query: { start_period: Schema.UintRequired, count: Schema.UintRequired } },
+            },
+            resp: JsonOnlyResp({
+                data: {
+                    toJson: (data, meta) => {
+                        const json = [];
+                        for (const [i, update] of data.entries()) {
+                            json.push(getLightClientForkTypes(meta.versions[i]).LightClientUpdate.toJson(update));
+                        }
+                        return json;
+                    },
+                    fromJson: (data, meta) => {
+                        const updates = data;
+                        const value = [];
+                        for (let i = 0; i < updates.length; i++) {
+                            const version = meta.versions[i];
+                            value.push(getLightClientForkTypes(version).LightClientUpdate.fromJson(updates[i]));
+                        }
+                        return value;
+                    },
+                },
+                meta: {
+                    toJson: (meta) => meta,
+                    fromJson: (val) => val,
+                    toHeadersObject: () => ({}),
+                    fromHeaders: () => ({ versions: [] }),
+                },
+                transform: {
+                    toResponse: (data, meta) => {
+                        const updates = data;
+                        const resp = [];
+                        for (let i = 0; i < updates.length; i++) {
+                            resp.push({ data: updates[i], version: meta.versions[i] });
+                        }
+                        return resp;
+                    },
+                    fromResponse: (resp) => {
+                        if (!Array.isArray(resp)) {
+                            throw Error("JSON is not an array");
+                        }
+                        const updates = [];
+                        const meta = { versions: [] };
+                        for (const { data, version } of resp) {
+                            updates.push(data);
+                            meta.versions.push(toForkName(version));
+                        }
+                        return { data: updates, meta };
+                    },
+                },
+            }),
         },
-        getOptimisticUpdate: reqEmpty,
-        getFinalityUpdate: reqEmpty,
-        getBootstrap: {
-            writeReq: (block_root) => ({ params: { block_root } }),
-            parseReq: ({ params }) => [params.block_root],
-            schema: { params: { block_root: Schema.StringRequired } },
+        getLightClientOptimisticUpdate: {
+            url: "/eth/v1/beacon/light_client/optimistic_update",
+            method: "GET",
+            req: EmptyRequestCodec,
+            resp: {
+                data: WithVersion((fork) => getLightClientForkTypes(fork).LightClientOptimisticUpdate),
+                meta: VersionCodec,
+            },
         },
-        getCommitteeRoot: {
-            writeReq: (start_period, count) => ({ query: { start_period, count } }),
-            parseReq: ({ query }) => [query.start_period, query.count],
-            schema: { query: { start_period: Schema.UintRequired, count: Schema.UintRequired } },
+        getLightClientFinalityUpdate: {
+            url: "/eth/v1/beacon/light_client/finality_update",
+            method: "GET",
+            req: EmptyRequestCodec,
+            resp: {
+                data: WithVersion((fork) => getLightClientForkTypes(fork).LightClientFinalityUpdate),
+                meta: VersionCodec,
+            },
+        },
+        getLightClientBootstrap: {
+            url: "/eth/v1/beacon/light_client/bootstrap/{block_root}",
+            method: "GET",
+            req: {
+                writeReq: ({ blockRoot }) => ({ params: { block_root: blockRoot } }),
+                parseReq: ({ params }) => ({ blockRoot: params.block_root }),
+                schema: { params: { block_root: Schema.StringRequired } },
+            },
+            resp: {
+                data: WithVersion((fork) => getLightClientForkTypes(fork).LightClientBootstrap),
+                meta: VersionCodec,
+            },
+        },
+        getLightClientCommitteeRoot: {
+            url: "/eth/v0/beacon/light_client/committee_root",
+            method: "GET",
+            req: {
+                writeReq: ({ startPeriod, count }) => ({ query: { start_period: startPeriod, count } }),
+                parseReq: ({ query }) => ({ startPeriod: query.start_period, count: query.count }),
+                schema: { query: { start_period: Schema.UintRequired, count: Schema.UintRequired } },
+            },
+            resp: {
+                data: HashListType,
+                meta: EmptyMetaCodec,
+            },
         },
-    };
-}
-export function getReturnTypes() {
-    // Form a TypeJson convertor for getUpdates
-    const VersionedUpdate = WithVersion((fork) => isForkLightClient(fork) ? ssz.allForksLightClient[fork].LightClientUpdate : ssz.altair.LightClientUpdate);
-    const getUpdates = {
-        toJson: (updates) => updates.map((data) => VersionedUpdate.toJson(data)),
-        fromJson: (updates) => updates.map((data) => VersionedUpdate.fromJson(data)),
-    };
-    return {
-        getUpdates,
-        getOptimisticUpdate: WithVersion((fork) => isForkLightClient(fork)
-            ? ssz.allForksLightClient[fork].LightClientOptimisticUpdate
-            : ssz.altair.LightClientOptimisticUpdate),
-        getFinalityUpdate: WithVersion((fork) => isForkLightClient(fork)
-            ? ssz.allForksLightClient[fork].LightClientFinalityUpdate
-            : ssz.altair.LightClientFinalityUpdate),
-        getBootstrap: WithVersion((fork) => isForkLightClient(fork) ? ssz.allForksLightClient[fork].LightClientBootstrap : ssz.altair.LightClientBootstrap),
-        getCommitteeRoot: ContainerData(ArrayOf(ssz.Root)),
     };
 }
 //# sourceMappingURL=lightclient.js.map

package/lib/beacon/routes/lightclient.js.map

@@ -1 +1 @@
-{"version":3,"file":"lightclient.js","sourceRoot":"","sources":["../../../src/beacon/routes/lightclient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAuB,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAW,iBAAiB,EAAC,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EACL,OAAO,EAGP,MAAM,EAEN,QAAQ,EAER,WAAW,EACX,aAAa,GACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAwEpE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,UAAU,EAAE,EAAC,GAAG,EAAE,qCAAqC,EAAE,MAAM,EAAE,KAAK,EAAC;IACvE,mBAAmB,EAAE,EAAC,GAAG,EAAE,+CAA+C,EAAE,MAAM,EAAE,KAAK,EAAC;IAC1F,iBAAiB,EAAE,EAAC,GAAG,EAAE,6CAA6C,EAAE,MAAM,EAAE,KAAK,EAAC;IACtF,YAAY,EAAE,EAAC,GAAG,EAAE,oDAAoD,EAAE,MAAM,EAAE,KAAK,EAAC;IACxF,gBAAgB,EAAE,EAAC,GAAG,EAAE,4CAA4C,EAAE,MAAM,EAAE,KAAK,EAAC;CACrF,CAAC;AAWF,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL,UAAU,EAAE;YACV,QAAQ,EAAE,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,KAAK,EAAC,EAAC,CAAC;YACnE,QAAQ,EAAE,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC;YACxD,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,EAAC,EAAC;SACjF;QAED,mBAAmB,EAAE,QAAQ;QAC7B,iBAAiB,EAAE,QAAQ;QAE3B,YAAY,EAAE;YACZ,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,UAAU,EAAC,EAAC,CAAC;YAClD,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;YAC3C,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,UAAU,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;SACtD;QACD,gBAAgB,EAAE;YAChB,QAAQ,EAAE,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,KAAK,EAAC,EAAC,CAAC;YACnE,QAAQ,EAAE,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC;YACxD,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,EAAC,EAAC;SACjF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,2CAA2C;IAC3C,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,IAAc,EAAE,EAAE,CACrD,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CACzG,CAAC;IACF,MAAM,UAAU,GAAG;QACjB,MAAM,EAAE,CAAC,OAAgE,EAAE,EAAE,CAC3E,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrD,QAAQ,EAAE,CAAC,OAAkB,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;KACxF,CAAC;IAEF,OAAO;QACL,UAAU;QACV,mBAAmB,EAAE,WAAW,CAAC,CAAC,IAAc,EAAE,EAAE,CAClD,iBAAiB,CAAC,IAAI,CAAC;YACrB,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,2BAA2B;YAC3D,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,2BAA2B,CAC3C;QACD,iBAAiB,EAAE,WAAW,CAAC,CAAC,IAAc,EAAE,EAAE,CAChD,iBAAiB,CAAC,IAAI,CAAC;YACrB,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,yBAAyB;YACzD,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,yBAAyB,CACzC;QACD,YAAY,EAAE,WAAW,CAAC,CAAC,IAAc,EAAE,EAAE,CAC3C,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAC/G;QACD,gBAAgB,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;KACnD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"lightclient.js","sourceRoot":"","sources":["../../../src/beacon/routes/lightclient.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAC,iBAAiB,EAAU,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAC,GAAG,EAAuB,MAAM,iBAAiB,CAAC;AAG1D,OAAO,EAA6B,MAAM,EAAC,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAC,YAAY,EAAc,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAC,uBAAuB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAEL,iBAAiB,EAEjB,cAAc,EAEd,WAAW,EACX,YAAY,GACb,MAAM,uBAAuB,CAAC;AAE/B,yFAAyF;AAEzF,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAkEnE,MAAM,UAAU,cAAc,CAAC,OAAwB;IACrD,OAAO;QACL,4BAA4B,EAAE;YAC5B,GAAG,EAAE,qCAAqC;YAC1C,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,QAAQ,EAAE,CAAC,EAAC,WAAW,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,WAAW,EAAE,KAAK,EAAC,EAAC,CAAC;gBACjF,QAAQ,EAAE,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,WAAW,EAAE,KAAK,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAC,CAAC;gBAC9E,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,EAAC,EAAC;aACjF;YACD,IAAI,EAAE,YAAY,CAAC;gBACjB,IAAI,EAAE;oBACJ,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;wBACrB,MAAM,IAAI,GAAc,EAAE,CAAC;wBAC3B,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;4BACzC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;wBACxF,CAAC;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;wBACvB,MAAM,OAAO,GAAG,IAAiB,CAAC;wBAClC,MAAM,KAAK,GAAiC,EAAE,CAAC;wBAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;4BACxC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;4BACjC,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBACtF,CAAC;wBACD,OAAO,KAAK,CAAC;oBACf,CAAC;iBACF;gBACD,IAAI,EAAE;oBACJ,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI;oBACtB,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAA6B;oBAChD,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;oBAC3B,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,QAAQ,EAAE,EAAE,EAAC,CAAC;iBACpC;gBACD,SAAS,EAAE;oBACT,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;wBACzB,MAAM,OAAO,GAAG,IAAiB,CAAC;wBAClC,MAAM,IAAI,GAAc,EAAE,CAAC;wBAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;4BACxC,IAAI,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAG,IAA6B,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC;wBACrF,CAAC;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE;wBACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;4BACzB,MAAM,KAAK,CAAC,sBAAsB,CAAC,CAAC;wBACtC,CAAC;wBACD,MAAM,OAAO,GAAiC,EAAE,CAAC;wBACjD,MAAM,IAAI,GAA2B,EAAC,QAAQ,EAAE,EAAE,EAAC,CAAC;wBACpD,KAAK,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC,IAAI,IAA6D,EAAE,CAAC;4BAC5F,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;wBAC1C,CAAC;wBACD,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAC,CAAC;oBAC/B,CAAC;iBACF;aACF,CAAC;SACH;QACD,8BAA8B,EAAE;YAC9B,GAAG,EAAE,+CAA+C;YACpD,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iBAAiB;YACtB,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,2BAA2B,CAAC;gBACtF,IAAI,EAAE,YAAY;aACnB;SACF;QACD,4BAA4B,EAAE;YAC5B,GAAG,EAAE,6CAA6C;YAClD,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iBAAiB;YACtB,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,yBAAyB,CAAC;gBACpF,IAAI,EAAE,YAAY;aACnB;SACF;QACD,uBAAuB,EAAE;YACvB,GAAG,EAAE,oDAAoD;YACzD,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,QAAQ,EAAE,CAAC,EAAC,SAAS,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,UAAU,EAAE,SAAS,EAAC,EAAC,CAAC;gBAC9D,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,SAAS,EAAE,MAAM,CAAC,UAAU,EAAC,CAAC;gBACxD,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,UAAU,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;aACtD;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC;gBAC/E,IAAI,EAAE,YAAY;aACnB;SACF;QACD,2BAA2B,EAAE;YAC3B,GAAG,EAAE,4CAA4C;YACjD,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,QAAQ,EAAE,CAAC,EAAC,WAAW,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,WAAW,EAAE,KAAK,EAAC,EAAC,CAAC;gBACjF,QAAQ,EAAE,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,WAAW,EAAE,KAAK,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAC,CAAC;gBAC9E,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,EAAC,EAAC;aACjF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,cAAc;aACrB;SACF;KACF,CAAC;AACJ,CAAC"}

package/lib/beacon/routes/lodestar.d.ts

@@ -1,7 +1,7 @@
+import { ChainForkConfig } from "@lodestar/config";
 import { Epoch, RootHex, Slot } from "@lodestar/types";
-import { ApiClientResponse } from "../../interfaces.js";
-import { HttpStatusCode } from "../../utils/client/httpStatusCode.js";
-import { ReqEmpty, ReturnTypes, ReqSerializers, RoutesData } from "../../utils/index.js";
+import { Endpoint, RouteDefinitions } from "../../utils/index.js";
+import { EmptyArgs, EmptyMeta, EmptyRequest, EmptyResponseData } from "../../utils/codecs.js";
 import { FilterGetPeers, NodePeer, PeerDirection, PeerState } from "./node.js";
 export type SyncChainDebugState = {
     targetRoot: string | null;
@@ -53,178 +53,104 @@ export type LodestarNodePeer = NodePeer & {
     agentVersion: string;
 };
 export type LodestarThreadType = "main" | "network" | "discv5";
-export type Api = {
-    /** Trigger to write a heapdump of either main/network/discv5 thread to disk at `dirpath`. May take > 1min */
-    writeHeapdump(thread?: LodestarThreadType, dirpath?: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: {
-                filepath: string;
-            };
+export type Endpoints = {
+    /** Trigger to write a heapdump to disk at `dirpath`. May take > 1min */
+    writeHeapdump: Endpoint<"POST", {
+        thread?: LodestarThreadType;
+        dirpath?: string;
+    }, {
+        query: {
+            thread?: LodestarThreadType;
+            dirpath?: string;
         };
-    }>>;
-    /** Trigger to write profile of either main/network/discv5 thread to disk */
-    writeProfile(thread?: LodestarThreadType, duration?: number, dirpath?: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: {
-                filepath: string;
-            };
+    }, {
+        filepath: string;
+    }, EmptyMeta>;
+    /** Trigger to write 10m network thread profile to disk */
+    writeProfile: Endpoint<"POST", {
+        thread?: LodestarThreadType;
+        duration?: number;
+        dirpath?: string;
+    }, {
+        query: {
+            thread?: LodestarThreadType;
+            duration?: number;
+            dirpath?: string;
         };
-    }>>;
+    }, {
+        filepath: string;
+    }, EmptyMeta>;
     /** TODO: description */
-    getLatestWeakSubjectivityCheckpointEpoch(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: Epoch;
-        };
-    }>>;
+    getLatestWeakSubjectivityCheckpointEpoch: Endpoint<"GET", EmptyArgs, EmptyRequest, Epoch, EmptyMeta>;
     /** TODO: description */
-    getSyncChainsDebugState(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: SyncChainDebugState[];
-        };
-    }>>;
+    getSyncChainsDebugState: Endpoint<"GET", EmptyArgs, EmptyRequest, SyncChainDebugState[], EmptyMeta>;
     /** Dump all items in a gossip queue, by gossipType */
-    getGossipQueueItems(gossipType: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: unknown[];
+    getGossipQueueItems: Endpoint<"GET", {
+        gossipType: string;
+    }, {
+        params: {
+            gossipType: string;
         };
-    }>>;
+    }, unknown[], EmptyMeta>;
     /** Dump all items in the regen queue */
-    getRegenQueueItems(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: RegenQueueItem[];
-        };
-    }>>;
+    getRegenQueueItems: Endpoint<"GET", EmptyArgs, EmptyRequest, RegenQueueItem[], EmptyMeta>;
     /** Dump all items in the block processor queue */
-    getBlockProcessorQueueItems(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: BlockProcessorQueueItem[];
-        };
-    }>>;
+    getBlockProcessorQueueItems: Endpoint<"GET", EmptyArgs, EmptyRequest, BlockProcessorQueueItem[], EmptyMeta>;
     /** Dump a summary of the states in the block state cache and checkpoint state cache */
-    getStateCacheItems(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: StateCacheItem[];
-        };
-    }>>;
+    getStateCacheItems: Endpoint<"GET", EmptyArgs, EmptyRequest, StateCacheItem[], EmptyMeta>;
     /** Dump peer gossip stats by peer */
-    getGossipPeerScoreStats(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: GossipPeerScoreStat[];
-        };
-    }>>;
+    getGossipPeerScoreStats: Endpoint<"GET", EmptyArgs, EmptyRequest, GossipPeerScoreStat[], EmptyMeta>;
     /** Dump lodestar score stats by peer */
-    getLodestarPeerScoreStats(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: PeerScoreStat[];
-        };
-    }>>;
+    getLodestarPeerScoreStats: Endpoint<"GET", EmptyArgs, EmptyRequest, PeerScoreStat[], EmptyMeta>;
     /** Run GC with `global.gc()` */
-    runGC(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-    }>>;
+    runGC: Endpoint<"POST", EmptyArgs, EmptyRequest, EmptyResponseData, EmptyMeta>;
     /** Drop all states in the state cache */
-    dropStateCache(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-    }>>;
+    dropStateCache: Endpoint<"POST", EmptyArgs, EmptyRequest, EmptyResponseData, EmptyMeta>;
     /** Connect to peer at this multiaddress */
-    connectPeer(peerId: string, multiaddrStrs: string[]): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-    }>>;
-    /** Disconnect peer */
-    disconnectPeer(peerId: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-    }>>;
-    /** Same to node api with new fields */
-    getPeers(filters?: FilterGetPeers): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: LodestarNodePeer[];
-            meta: {
-                count: number;
-            };
-        };
-    }>>;
-    /** Dump Discv5 Kad values */
-    discv5GetKadValues(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: string[];
-        };
-    }>>;
-    /**
-     * Dump level-db entry keys for a given Bucket declared in code, or for all buckets.
-     * @param bucket must be the string name of a bucket entry: `allForks_blockArchive`
-     */
-    dumpDbBucketKeys(bucket: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: string[];
-        };
-    }>>;
-    /** Return all entries in the StateArchive index with bucket index_stateArchiveRootIndex */
-    dumpDbStateIndex(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: {
-                root: RootHex;
-                slot: Slot;
-            }[];
-        };
-    }>>;
-};
-/**
- * Define javascript values for each route
- */
-export declare const routesData: RoutesData<Api>;
-export type ReqTypes = {
-    writeHeapdump: {
-        query: {
-            thread?: LodestarThreadType;
-            dirpath?: string;
-        };
-    };
-    writeProfile: {
-        query: {
-            thread?: LodestarThreadType;
-            duration?: number;
-            dirpath?: string;
-        };
-    };
-    getLatestWeakSubjectivityCheckpointEpoch: ReqEmpty;
-    getSyncChainsDebugState: ReqEmpty;
-    getGossipQueueItems: {
-        params: {
-            gossipType: string;
-        };
-    };
-    getRegenQueueItems: ReqEmpty;
-    getBlockProcessorQueueItems: ReqEmpty;
-    getStateCacheItems: ReqEmpty;
-    getGossipPeerScoreStats: ReqEmpty;
-    getLodestarPeerScoreStats: ReqEmpty;
-    runGC: ReqEmpty;
-    dropStateCache: ReqEmpty;
-    connectPeer: {
+    connectPeer: Endpoint<"POST", {
+        peerId: string;
+        multiaddrs: string[];
+    }, {
         query: {
             peerId: string;
             multiaddr: string[];
         };
-    };
-    disconnectPeer: {
+    }, EmptyResponseData, EmptyMeta>;
+    /** Disconnect peer */
+    disconnectPeer: Endpoint<"POST", {
+        peerId: string;
+    }, {
         query: {
             peerId: string;
         };
-    };
-    getPeers: {
+    }, EmptyResponseData, EmptyMeta>;
+    /** Same to node api with new fields */
+    getPeers: Endpoint<"GET", FilterGetPeers, {
         query: {
             state?: PeerState[];
             direction?: PeerDirection[];
         };
-    };
-    discv5GetKadValues: ReqEmpty;
-    dumpDbBucketKeys: {
+    }, LodestarNodePeer[], {
+        count: number;
+    }>;
+    /** Dump Discv5 Kad values */
+    discv5GetKadValues: Endpoint<"GET", EmptyArgs, EmptyRequest, string[], EmptyMeta>;
+    /**
+     * Dump level-db entry keys for a given Bucket declared in code, or for all buckets.
+     */
+    dumpDbBucketKeys: Endpoint<"GET", {
+        /** Must be the string name of a bucket entry: `allForks_blockArchive` */
+        bucket: string;
+    }, {
         params: {
             bucket: string;
         };
-    };
-    dumpDbStateIndex: ReqEmpty;
+    }, string[], EmptyMeta>;
+    /** Return all entries in the StateArchive index with bucket index_stateArchiveRootIndex */
+    dumpDbStateIndex: Endpoint<"GET", EmptyArgs, EmptyRequest, {
+        root: RootHex;
+        slot: Slot;
+    }[], EmptyMeta>;
 };
-export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
-export declare function getReturnTypes(): ReturnTypes<Api>;
+export declare function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpoints>;
 //# sourceMappingURL=lodestar.d.ts.map