Adjust historical_summaries REST endpoint to deal with forks

kdeme · kdeme · commit e123f65f637a · 2025-02-13T18:55:12.000+01:00
diff --git a/beacon_chain/rpc/rest_nimbus_api.nim b/beacon_chain/rpc/rest_nimbus_api.nim
@@ -1,5 +1,5 @@
 # beacon_chain
-# Copyright (c) 2018-2024 Status Research & Development GmbH
+# Copyright (c) 2018-2025 Status Research & Development GmbH
 # Licensed and distributed under either of
 #   * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
 #   * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
@@ -547,32 +547,49 @@ proc installNimbusApiHandlers*(router: var RestRouter, node: BeaconNode) =
 
     node.withStateForBlockSlotId(bslot):
       return withState(state):
-        when consensusFork >= ConsensusFork.Capella:
-          # Build the proof for historical_summaries field (28th field in BeaconState)
-          let gIndex = GeneralizedIndex(59) # 31 + 28 = 59
-          var proof: array[5, Digest]
-          if forkyState.data.build_proof(gIndex, proof).isErr:
+        when consensusFork >= ConsensusFork.Electra:
+          var proof: HistoricalSummariesProofElectra
+          if forkyState.data.build_proof(HISTORICAL_SUMMARIES_GINDEX_ELECTRA, proof).isErr:
             return RestApiResponse.jsonError(Http500, InvalidMerkleProofIndexError)
 
+          let response = GetHistoricalSummariesV1ResponseElectra(
+            historical_summaries: forkyState.data.historical_summaries,
+            proof: proof,
+            slot: bslot.slot,
+          )
+
           if contentType == jsonMediaType:
-            let response = RestHistoricalSummaries(
-              historical_summaries: forkyState.data.historical_summaries.asSeq(),
-              proof: proof,
-              slot: bslot.slot,
+            RestApiResponse.jsonResponseFinalizedWVersion(
+              response,
+              node.getStateOptimistic(state),
+              node.dag.isFinalized(bslot.bid),
+              consensusFork,
             )
+          elif contentType == sszMediaType:
+            let headers = [("eth-consensus-version", consensusFork.toString())]
+            RestApiResponse.sszResponse(response, headers)
+          else:
+            RestApiResponse.jsonError(Http500, InvalidAcceptError)
+        elif consensusFork >= ConsensusFork.Capella:
+          var proof: HistoricalSummariesProof
+          if forkyState.data.build_proof(HISTORICAL_SUMMARIES_GINDEX, proof).isErr:
+            return RestApiResponse.jsonError(Http500, InvalidMerkleProofIndexError)
+
+          let response = GetHistoricalSummariesV1Response(
+            historical_summaries: forkyState.data.historical_summaries,
+            proof: proof,
+            slot: bslot.slot,
+          )
 
-            RestApiResponse.jsonResponseFinalized(
-              response, node.getStateOptimistic(state), node.dag.isFinalized(bslot.bid)
+          if contentType == jsonMediaType:
+            RestApiResponse.jsonResponseFinalizedWVersion(
+              response,
+              node.getStateOptimistic(state),
+              node.dag.isFinalized(bslot.bid),
+              consensusFork,
             )
           elif contentType == sszMediaType:
-            let
-              headers = [("eth-consensus-version", consensusFork.toString())]
-              response = GetHistoricalSummariesV1Response(
-                historical_summaries: forkyState.data.historical_summaries,
-                proof: proof,
-                slot: bslot.slot,
-              )
-
+            let headers = [("eth-consensus-version", consensusFork.toString())]
             RestApiResponse.sszResponse(response, headers)
           else:
             RestApiResponse.jsonError(Http500, InvalidAcceptError)
diff --git a/beacon_chain/spec/eth2_apis/eth2_rest_serialization.nim b/beacon_chain/spec/eth2_apis/eth2_rest_serialization.nim
@@ -85,6 +85,7 @@ RestJson.useDefaultSerializationFor(
   GetHeaderResponseDeneb,
   GetHeaderResponseElectra,
   GetHistoricalSummariesV1Response,
+  GetHistoricalSummariesV1ResponseElectra,
   GetKeystoresResponse,
   GetNextWithdrawalsResponse,
   GetPoolAttesterSlashingsResponse,
@@ -133,7 +134,6 @@ RestJson.useDefaultSerializationFor(
   RestEpochSyncCommittee,
   RestExtraData,
   RestGenesis,
-  RestHistoricalSummaries,
   RestIndexedErrorMessage,
   RestIndexedErrorMessageItem,
   RestMetadata,
@@ -404,6 +404,7 @@ type
     GetBlockV2Response |
     GetDistributedKeystoresResponse |
     GetHistoricalSummariesV1Response |
+    GetHistoricalSummariesV1ResponseElectra |
     GetKeystoresResponse |
     GetRemoteKeystoresResponse |
     GetStateForkResponse |
diff --git a/beacon_chain/spec/eth2_apis/rest_nimbus_calls.nim b/beacon_chain/spec/eth2_apis/rest_nimbus_calls.nim
@@ -1,5 +1,5 @@
 # beacon_chain
-# Copyright (c) 2018-2024 Status Research & Development GmbH
+# Copyright (c) 2018-2025 Status Research & Development GmbH
 # Licensed and distributed under either of
 #   * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
 #   * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
@@ -77,6 +77,64 @@ proc getTimeOffset*(client: RestClientRef,
     raise (ref RestResponseError)(
       msg: msg, status: error.code, message: error.message)
 
+func decodeSszResponse(
+    T: type ForkedHistoricalSummariesWithProof,
+    data: openArray[byte],
+    consensusFork: ConsensusFork,
+    cfg: RuntimeConfig,
+): T {.raises: [RestDecodingError].} =
+  if consensusFork >= ConsensusFork.Electra:
+    let summaries =
+      try:
+        SSZ.decode(data, GetHistoricalSummariesV1ResponseElectra)
+      except SerializationError as exc:
+        raise newException(RestDecodingError, exc.msg)
+    ForkedHistoricalSummariesWithProof.init(summaries, consensusFork)
+  elif consensusFork >= ConsensusFork.Capella:
+    let summaries =
+      try:
+        SSZ.decode(data, GetHistoricalSummariesV1Response)
+      except SerializationError as exc:
+        raise newException(RestDecodingError, exc.msg)
+    ForkedHistoricalSummariesWithProof.init(summaries, consensusFork)
+  else:
+    raiseRestDecodingBytesError(cstring("Unsupported fork: " & $consensusFork))
+
+proc decodeJsonResponse(
+    T: type ForkedHistoricalSummariesWithProof,
+    data: openArray[byte],
+    consensusFork: ConsensusFork,
+    cfg: RuntimeConfig,
+): T {.raises: [RestDecodingError].} =
+  if consensusFork >= ConsensusFork.Electra:
+    let summaries = decodeBytes(
+      GetHistoricalSummariesV1ResponseElectra, data, Opt.none(ContentTypeData)
+    ).valueOr:
+      raise newException(RestDecodingError, $error)
+    ForkedHistoricalSummariesWithProof.init(summaries, consensusFork)
+  elif consensusFork >= ConsensusFork.Capella:
+    let summaries = decodeBytes(
+      GetHistoricalSummariesV1Response, data, Opt.none(ContentTypeData)
+    ).valueOr:
+      raise newException(RestDecodingError, $error)
+    ForkedHistoricalSummariesWithProof.init(summaries, consensusFork)
+  else:
+    raiseRestDecodingBytesError(cstring("Unsupported fork: " & $consensusFork))
+
+proc decodeHttpResponse(
+    T: type ForkedHistoricalSummariesWithProof,
+    data: openArray[byte],
+    mediaType: MediaType,
+    consensusFork: ConsensusFork,
+    cfg: RuntimeConfig,
+): T {.raises: [RestDecodingError].} =
+  if mediaType == OctetStreamMediaType:
+    ForkedHistoricalSummariesWithProof.decodeSszResponse(data, consensusFork, cfg)
+  elif mediaType == ApplicationJsonMediaType:
+    ForkedHistoricalSummariesWithProof.decodeJsonResponse(data, consensusFork, cfg)
+  else:
+    raise newException(RestDecodingError, "Unsupported content-type")
+
 proc getHistoricalSummariesV1Plain*(
   state_id: StateIdent
 ): RestPlainResponse {.
@@ -88,7 +146,7 @@ proc getHistoricalSummariesV1Plain*(
 
 proc getHistoricalSummariesV1*(
     client: RestClientRef, state_id: StateIdent, cfg: RuntimeConfig, restAccept = ""
-): Future[Option[GetHistoricalSummariesV1Response]] {.
+): Future[Opt[ForkedHistoricalSummariesWithProof]] {.
     async: (
       raises: [
         CancelledError, RestEncodingError, RestDnsResolveError, RestCommunicationError,
@@ -108,24 +166,20 @@ proc getHistoricalSummariesV1*(
       if resp.contentType.isNone() or isWildCard(resp.contentType.get().mediaType):
         raise newException(RestDecodingError, "Missing or incorrect Content-Type")
       else:
-        let mediaType = resp.contentType.get().mediaType
-        if mediaType == ApplicationJsonMediaType:
-          let summaries = decodeBytes(
-            GetHistoricalSummariesV1Response, resp.data, resp.contentType
+        let
+          consensusFork = ConsensusFork.decodeString(
+            resp.headers.getString("eth-consensus-version")
           ).valueOr:
-            raise newException(RestDecodingError, $error)
-          some(summaries)
-        elif mediaType == OctetStreamMediaType:
-          let summaries =
-            try:
-              SSZ.decode(resp.data, GetHistoricalSummariesV1Response)
-            except SerializationError as exc:
-              raise newException(RestDecodingError, exc.msg)
-          some(summaries)
-        else:
-          raise newException(RestDecodingError, "Unsupported Content-Type")
+            raiseRestDecodingBytesError(error)
+          mediaType = resp.contentType.value().mediaType
+
+        Opt.some(
+          ForkedHistoricalSummariesWithProof.decodeHttpResponse(
+            resp.data, mediaType, consensusFork, cfg
+          )
+        )
     of 404:
-      none(GetHistoricalSummariesV1Response)
+      Opt.none(ForkedHistoricalSummariesWithProof)
     of 400, 500:
       let error = decodeBytes(RestErrorMessage, resp.data, resp.contentType).valueOr:
         let msg =
@@ -135,4 +189,4 @@ proc getHistoricalSummariesV1*(
       raise
         (ref RestResponseError)(msg: msg, status: error.code, message: error.message)
     else:
-      raiseRestResponseError(resp)
+      raiseRestResponseError(resp)
diff --git a/beacon_chain/spec/eth2_apis/rest_types.nim b/beacon_chain/spec/eth2_apis/rest_types.nim
@@ -1,5 +1,5 @@
 # beacon_chain
-# Copyright (c) 2018-2024 Status Research & Development GmbH
+# Copyright (c) 2018-2025 Status Research & Development GmbH
 # Licensed and distributed under either of
 #   * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
 #   * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
@@ -15,7 +15,7 @@
 
 import
   std/[json, tables],
-  stew/base10, web3/primitives, httputils,
+  stew/base10, web3/primitives, httputils, stew/bitops2,
   ".."/[deposit_snapshots, forks],
   ".."/mev/[deneb_mev]
 
@@ -343,11 +343,6 @@ type
   RestEpochRandao* = object
     randao*: Eth2Digest
 
-  RestHistoricalSummaries* = object
-    historical_summaries*: seq[HistoricalSummary]
-    proof*: array[5, Eth2Digest]
-    slot*: Slot
-
   DataEnclosedObject*[T] = object
     data*: T
 
@@ -480,11 +475,6 @@ type
   GetStateV2Response* = ref ForkedHashedBeaconState
   GetAggregatedAttestationV2Response* = ForkedAttestation
 
-  GetHistoricalSummariesV1Response* = object
-    historical_summaries*: HashList[HistoricalSummary, Limit HISTORICAL_ROOTS_LIMIT]
-    proof*: array[5, Eth2Digest]
-    slot*: Slot
-
   RestRoot* = object
     root*: Eth2Digest
 
@@ -1086,3 +1076,88 @@ func toValidatorIndex*(value: RestValidatorIndex): Result[ValidatorIndex,
       err(ValidatorIndexError.TooHighValue)
   else:
     doAssert(false, "ValidatorIndex type size is incorrect")
+
+## Types and helpers for historical_summaries + proof endpoint
+const
+  # gIndex for historical_summaries field (27th field in BeaconState)
+  HISTORICAL_SUMMARIES_GINDEX* = GeneralizedIndex(59) # 32 + 27 = 59
+  HISTORICAL_SUMMARIES_GINDEX_ELECTRA* = GeneralizedIndex(91) # 64 + 27 = 91
+
+type
+  # Note: these could go in separate Capella/Electra spec files if they were
+  # part of the specification.
+  HistoricalSummariesProof* = array[log2trunc(HISTORICAL_SUMMARIES_GINDEX), Eth2Digest]
+  HistoricalSummariesProofElectra* =
+    array[log2trunc(HISTORICAL_SUMMARIES_GINDEX_ELECTRA), Eth2Digest]
+
+  # REST API types
+  GetHistoricalSummariesV1Response* = object
+    historical_summaries*: HashList[HistoricalSummary, Limit HISTORICAL_ROOTS_LIMIT]
+    proof*: HistoricalSummariesProof
+    slot*: Slot
+
+  GetHistoricalSummariesV1ResponseElectra* = object
+    historical_summaries*: HashList[HistoricalSummary, Limit HISTORICAL_ROOTS_LIMIT]
+    proof*: HistoricalSummariesProofElectra
+    slot*: Slot
+
+  # REST client response type
+  ForkedHistoricalSummariesWithProof* = object
+    case kind*: ConsensusFork
+    of ConsensusFork.Phase0: discard
+    of ConsensusFork.Altair: discard
+    of ConsensusFork.Bellatrix: discard
+    of ConsensusFork.Capella: capellaData*: GetHistoricalSummariesV1Response
+    of ConsensusFork.Deneb: denebData*: GetHistoricalSummariesV1Response
+    of ConsensusFork.Electra: electraData*: GetHistoricalSummariesV1ResponseElectra
+    of ConsensusFork.Fulu: fuluData*: GetHistoricalSummariesV1ResponseElectra
+
+template init*(
+    T: type ForkedHistoricalSummariesWithProof,
+    historical_summaries: GetHistoricalSummariesV1Response,
+    fork: ConsensusFork,
+): T =
+  case fork
+  of ConsensusFork.Phase0:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Altair:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Bellatrix:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Capella:
+    ForkedHistoricalSummariesWithProof(
+      kind: ConsensusFork.Capella, capellaData: historical_summaries
+    )
+  of ConsensusFork.Deneb:
+    ForkedHistoricalSummariesWithProof(
+      kind: ConsensusFork.Deneb, denebData: historical_summaries
+    )
+  of ConsensusFork.Electra:
+    raiseAssert $fork & " fork should not be used for this type of historical summaries"
+  of ConsensusFork.Fulu:
+    raiseAssert $fork & " fork should not be used for this type of historical summaries"
+
+template init*(
+    T: type ForkedHistoricalSummariesWithProof,
+    historical_summaries: GetHistoricalSummariesV1ResponseElectra,
+    fork: ConsensusFork,
+): T =
+  case fork
+  of ConsensusFork.Phase0:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Altair:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Bellatrix:
+    raiseAssert $fork & " fork should not be used for historical summaries"
+  of ConsensusFork.Capella:
+    raiseAssert $fork & " fork should not be used for this type of historical summaries"
+  of ConsensusFork.Deneb:
+    raiseAssert $fork & " fork should not be used for this type of historical summaries"
+  of ConsensusFork.Electra:
+    ForkedHistoricalSummariesWithProof(
+      kind: ConsensusFork.Electra, electraData: historical_summaries
+    )
+  of ConsensusFork.Fulu:
+    ForkedHistoricalSummariesWithProof(
+      kind: ConsensusFork.Fulu, fuluData: historical_summaries
+    )
