feat: add debug_getHistoricalSummaries endpoint

packages/api/src/beacon/routes/debug.ts

@@ -85,7 +85,13 @@ const DebugChainHeadListType = ArrayOf(DebugChainHeadType);
 type ProtoNodeList = ValueOf<typeof ProtoNodeListType>;
 type DebugChainHeadList = ValueOf<typeof DebugChainHeadListType>;
 type ForkChoiceResponse = ValueOf<typeof ForkChoiceResponseType>;
-
+const HistoricalSummariesResponseType = new ContainerType(
+  {
+    HistoricalSummaries: ssz.capella.HistoricalSummaries,
+    proof: ArrayOf(ssz.Bytes8),
+  },
+  {jsonCase: "eth2"}
+);
 export type Endpoints = {
   /**
    * Retrieves all possible chain heads (leaves of fork choice tree).
@@ -135,6 +141,13 @@ export type Endpoints = {
     BeaconState,
     ExecutionOptimisticFinalizedAndVersionMeta
   >;
+  getHistoricalSummaries: Endpoint<
+    "GET",
+    StateArgs,
+    {params: {state_id: string}},
+    ValueOf<typeof HistoricalSummariesResponseType>,
+    EmptyMeta
+  >;
 };
 
 export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpoints> {
@@ -196,5 +209,20 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         timeoutMs: 5 * 60 * 1000,
       },
     },
+    getHistoricalSummaries: {
+      url: "/eth/v0/debug/historical_summaries/{state_id}",
+      method: "GET",
+      req: {
+        writeReq: ({stateId}) => ({params: {state_id: stateId.toString()}}),
+        parseReq: ({params}) => ({stateId: params.state_id}),
+        schema: {
+          params: {state_id: Schema.StringRequired},
+        },
+      },
+      resp: {
+        data: HistoricalSummariesResponseType,
+        meta: EmptyMetaCodec,
+      },
+    },
   };
 }

packages/api/test/unit/beacon/genericServerTest/debug.test.ts

@@ -58,5 +58,21 @@ describe("beacon / debug", () => {
       expect(res.wireFormat()).toBe(WireFormat.ssz);
       expect(toHexString(res.ssz())).toBe(toHexString(stateSerialized));
     });
+    it("getHistoricalSummaries", async () => {
+      const state = ssz.deneb.BeaconState.defaultValue();
+      mockApi.getHistoricalSummaries.mockResolvedValue({
+        data: {HistoricalSummaries: state.historicalSummaries, proof: []},
+        meta: undefined,
+      });
+
+      const httpClient = new HttpClient({baseUrl});
+      const client = getClient(config, httpClient);
+
+      const res = await client.getHistoricalSummaries({stateId: "head"}, {responseWireFormat: WireFormat.json});
+
+      expect(res.ok).toBe(true);
+      expect(res.wireFormat()).toBe(WireFormat.json);
+      expect(res.json()).toStrictEqual({data: {Historical_summaries: [], proof: []}});
+    });
   });
 });

packages/beacon-node/src/api/impl/debug/index.ts

@@ -1,12 +1,13 @@
 import {routes} from "@lodestar/api";
 import {ApplicationMethods} from "@lodestar/api/server";
 import {ExecutionStatus} from "@lodestar/fork-choice";
-import {ZERO_HASH_HEX} from "@lodestar/params";
-import {BeaconState} from "@lodestar/types";
+import {ForkName, ForkSeq, ZERO_HASH_HEX} from "@lodestar/params";
+import {BeaconState, ssz} from "@lodestar/types";
 import {isOptimisticBlock} from "../../../util/forkChoice.js";
 import {getStateSlotFromBytes} from "../../../util/multifork.js";
 import {getStateResponseWithRegen} from "../beacon/state/utils.js";
 import {ApiModules} from "../types.js";
+import {Tree} from "@chainsafe/persistent-merkle-tree";
 
 export function getDebugApi({
   chain,
@@ -85,5 +86,28 @@ export function getDebugApi({
         },
       };
     },
+    async getHistoricalSummaries({stateId}, _context) {
+      const {state} = await getStateResponseWithRegen(chain, stateId);
+      let slot: number;
+      if (state instanceof Uint8Array) {
+        slot = getStateSlotFromBytes(state);
+      } else {
+        slot = state.slot;
+      }
+      if (config.getForkSeq(slot) < ForkSeq.capella) {
+        throw new Error("Historical summaries are not supported before Capella");
+      }
+      const fork = config.getForkName(slot) as Exclude<ForkName, "phase0" | "altair" | "bellatrix">;
+      const stateView = state instanceof Uint8Array ? ssz[fork].BeaconState.deserializeToViewDU(state) : state;
+      const gindex = ssz[fork].BeaconState.getPathInfo(["historicalSummaries"]);
+      const proof = new Tree(stateView.node).getSingleProof(gindex.gindex);
+
+      return {
+        data: {
+          HistoricalSummaries: (stateView as any).historicalSummaries.toValue(),
+          proof: proof,
+        },
+      };
+    },
   };
 }

packages/types/src/capella/sszTypes.ts

@@ -125,6 +125,10 @@ export const HistoricalSummary = new ContainerType(
   {typeName: "HistoricalSummary", jsonCase: "eth2"}
 );
 
+export const HistoricalSummaries = new ListCompositeType(HistoricalSummary, HISTORICAL_ROOTS_LIMIT, {
+  typeName: "HistoricalSummaries",
+});
+
 // we don't reuse bellatrix.BeaconState fields since we need to replace some keys
 // and we cannot keep order doing that
 export const BeaconState = new ContainerType(
@@ -168,7 +172,7 @@ export const BeaconState = new ContainerType(
     nextWithdrawalIndex: WithdrawalIndex, // [New in Capella]
     nextWithdrawalValidatorIndex: ValidatorIndex, // [New in Capella]
     // Deep history valid from Capella onwards
-    historicalSummaries: new ListCompositeType(HistoricalSummary, HISTORICAL_ROOTS_LIMIT), // [New in Capella]
+    historicalSummaries: HistoricalSummaries, // [New in Capella]
   },
   {typeName: "BeaconState", jsonCase: "eth2"}
 );