@lodestar/api 1.19.0 → 1.20.0-dev.0cb3998a2a

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

@@ -1,49 +1,43 @@
-import { Proof } from "@chainsafe/persistent-merkle-tree";
-import { ReturnTypes, RoutesData, ReqSerializers } from "../../utils/index.js";
-import { HttpStatusCode } from "../../utils/client/httpStatusCode.js";
-import { ApiClientResponse } from "../../interfaces.js";
-export type Api = {
+import { CompactMultiProof } from "@chainsafe/persistent-merkle-tree";
+import { ByteListType, ContainerType } from "@chainsafe/ssz";
+import { ChainForkConfig } from "@lodestar/config";
+import { Endpoint, RouteDefinitions } from "../../utils/index.js";
+import { VersionMeta } from "../../utils/metadata.js";
+export declare const CompactMultiProofType: ContainerType<{
+    leaves: import("@chainsafe/ssz").ArrayType<import("@chainsafe/ssz").Type<Uint8Array>, unknown, unknown>;
+    descriptor: ByteListType;
+}>;
+export type Endpoints = {
     /**
      * Returns a multiproof of `descriptor` at the requested `stateId`.
      * The requested `stateId` may not be available. Regular nodes only keep recent states in memory.
      */
-    getStateProof(stateId: string, descriptor: Uint8Array): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: Proof;
-        };
-    }>>;
-    /**
-     * Returns a multiproof of `descriptor` at the requested `blockId`.
-     * The requested `blockId` may not be available. Regular nodes only keep recent states in memory.
-     */
-    getBlockProof(blockId: string, descriptor: Uint8Array): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: Proof;
-        };
-    }>>;
-};
-/**
- * Define javascript values for each route
- */
-export declare const routesData: RoutesData<Api>;
-export type ReqTypes = {
-    getStateProof: {
+    getStateProof: Endpoint<"GET", {
+        stateId: string;
+        descriptor: Uint8Array;
+    }, {
         params: {
             state_id: string;
         };
         query: {
             format: string;
         };
-    };
-    getBlockProof: {
+    }, CompactMultiProof, VersionMeta>;
+    /**
+     * Returns a multiproof of `descriptor` at the requested `blockId`.
+     * The requested `blockId` may not be available. Regular nodes only keep recent states in memory.
+     */
+    getBlockProof: Endpoint<"GET", {
+        blockId: string;
+        descriptor: Uint8Array;
+    }, {
         params: {
             block_id: string;
         };
         query: {
             format: string;
         };
-    };
+    }, CompactMultiProof, VersionMeta>;
 };
-export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
-export declare function getReturnTypes(): ReturnTypes<Api>;
+export declare function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpoints>;
 //# sourceMappingURL=proof.d.ts.map

package/lib/beacon/routes/proof.js

@@ -1,32 +1,52 @@
-import { fromHexString, toHexString } from "@chainsafe/ssz";
-import { Schema, sameType } from "../../utils/index.js";
-import { HttpStatusCode } from "../../utils/client/httpStatusCode.js";
-/**
- * Define javascript values for each route
- */
-export const routesData = {
-    getStateProof: { url: "/eth/v0/beacon/proof/state/{state_id}", method: "GET" },
-    getBlockProof: { url: "/eth/v0/beacon/proof/block/{block_id}", method: "GET" },
-};
-export function getReqSerializers() {
+/* eslint-disable @typescript-eslint/naming-convention */
+import { ProofType } from "@chainsafe/persistent-merkle-tree";
+import { ByteListType, ContainerType, fromHexString, toHexString } from "@chainsafe/ssz";
+import { ssz } from "@lodestar/types";
+import { Schema } from "../../utils/index.js";
+import { ArrayOf } from "../../utils/codecs.js";
+import { VersionCodec } from "../../utils/metadata.js";
+export const CompactMultiProofType = new ContainerType({
+    leaves: ArrayOf(ssz.Root, 10000),
+    descriptor: new ByteListType(2048),
+});
+export function getDefinitions(_config) {
     return {
         getStateProof: {
-            writeReq: (state_id, descriptor) => ({ params: { state_id }, query: { format: toHexString(descriptor) } }),
-            parseReq: ({ params, query }) => [params.state_id, fromHexString(query.format)],
-            schema: { params: { state_id: Schema.StringRequired }, query: { format: Schema.StringRequired } },
+            url: "/eth/v0/beacon/proof/state/{state_id}",
+            method: "GET",
+            req: {
+                writeReq: ({ stateId, descriptor }) => ({ params: { state_id: stateId }, query: { format: toHexString(descriptor) } }),
+                parseReq: ({ params, query }) => ({ stateId: params.state_id, descriptor: fromHexString(query.format) }),
+                schema: { params: { state_id: Schema.StringRequired }, query: { format: Schema.StringRequired } },
+            },
+            resp: {
+                data: {
+                    toJson: (data) => CompactMultiProofType.toJson(data),
+                    fromJson: (data) => ({ ...CompactMultiProofType.fromJson(data), type: ProofType.compactMulti }),
+                    serialize: (data) => CompactMultiProofType.serialize(data),
+                    deserialize: (data) => ({ ...CompactMultiProofType.deserialize(data), type: ProofType.compactMulti }),
+                },
+                meta: VersionCodec,
+            },
         },
         getBlockProof: {
-            writeReq: (block_id, descriptor) => ({ params: { block_id }, query: { format: toHexString(descriptor) } }),
-            parseReq: ({ params, query }) => [params.block_id, fromHexString(query.format)],
-            schema: { params: { block_id: Schema.StringRequired }, query: { format: Schema.StringRequired } },
+            url: "/eth/v0/beacon/proof/block/{block_id}",
+            method: "GET",
+            req: {
+                writeReq: ({ blockId, descriptor }) => ({ params: { block_id: blockId }, query: { format: toHexString(descriptor) } }),
+                parseReq: ({ params, query }) => ({ blockId: params.block_id, descriptor: fromHexString(query.format) }),
+                schema: { params: { block_id: Schema.StringRequired }, query: { format: Schema.StringRequired } },
+            },
+            resp: {
+                data: {
+                    toJson: (data) => CompactMultiProofType.toJson(data),
+                    fromJson: (data) => ({ ...CompactMultiProofType.fromJson(data), type: ProofType.compactMulti }),
+                    serialize: (data) => CompactMultiProofType.serialize(data),
+                    deserialize: (data) => ({ ...CompactMultiProofType.deserialize(data), type: ProofType.compactMulti }),
+                },
+                meta: VersionCodec,
+            },
         },
     };
 }
-export function getReturnTypes() {
-    return {
-        // Just sent the proof JSON as-is
-        getStateProof: sameType(),
-        getBlockProof: sameType(),
-    };
-}
 //# sourceMappingURL=proof.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"proof.js","sourceRoot":"","sources":["../../../src/beacon/routes/proof.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAA0B,MAAM,EAAE,QAAQ,EAAiB,MAAM,sBAAsB,CAAC;AAC/F,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAwBpE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,aAAa,EAAE,EAAC,GAAG,EAAE,uCAAuC,EAAE,MAAM,EAAE,KAAK,EAAC;IAC5E,aAAa,EAAE,EAAC,GAAG,EAAE,uCAAuC,EAAE,MAAM,EAAE,KAAK,EAAC;CAC7E,CAAC;AAQF,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL,aAAa,EAAE;YACb,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAC,EAAC,CAAC;YACpG,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7E,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;SAC5F;QACD,aAAa,EAAE;YACb,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAC,EAAC,CAAC;YACpG,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7E,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;SAC5F;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,iCAAiC;QACjC,aAAa,EAAE,QAAQ,EAAE;QACzB,aAAa,EAAE,QAAQ,EAAE;KAC1B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"proof.js","sourceRoot":"","sources":["../../../src/beacon/routes/proof.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAoB,SAAS,EAAC,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAC,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAEvF,OAAO,EAAC,GAAG,EAAC,MAAM,iBAAiB,CAAC;AACpC,OAAO,EAA6B,MAAM,EAAC,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAC,OAAO,EAAC,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAC,YAAY,EAAc,MAAM,yBAAyB,CAAC;AAElE,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,aAAa,CAAC;IACrD,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC;IAChC,UAAU,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC;CACnC,CAAC,CAAC;AA6BH,MAAM,UAAU,cAAc,CAAC,OAAwB;IACrD,OAAO;QACL,aAAa,EAAE;YACb,GAAG,EAAE,uCAAuC;YAC5C,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,QAAQ,EAAE,CAAC,EAAC,OAAO,EAAE,UAAU,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAC,EAAC,CAAC;gBAC9G,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,EAAC,CAAC;gBACpG,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;aAC5F;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC;oBACpD,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,YAAY,EAAC,CAAC;oBAC7F,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC1D,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,YAAY,EAAC,CAAC;iBACpG;gBACD,IAAI,EAAE,YAAY;aACnB;SACF;QACD,aAAa,EAAE;YACb,GAAG,EAAE,uCAAuC;YAC5C,MAAM,EAAE,KAAK;YACb,GAAG,EAAE;gBACH,QAAQ,EAAE,CAAC,EAAC,OAAO,EAAE,UAAU,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAC,EAAC,CAAC;gBAC9G,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,EAAC,CAAC;gBACpG,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;aAC5F;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC;oBACpD,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,YAAY,EAAC,CAAC;oBAC7F,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC1D,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,YAAY,EAAC,CAAC;iBACpG;gBACD,IAAI,EAAE,YAAY;aACnB;SACF;KACF,CAAC;AACJ,CAAC"}