Apply changes from #6645

ChainSafe · Apr 27, 2024 · 81a96d4 · 81a96d4
1 parent 948dad9
commit 81a96d4
Show file tree

Hide file tree

Showing 11 changed files with 201 additions and 123 deletions.
diff --git a/packages/api/src/beacon/routes/beacon/block.ts b/packages/api/src/beacon/routes/beacon/block.ts
@@ -9,10 +9,10 @@ import {
   EmptyMetaCodec,
   EmptyResponseCodec,
   EmptyResponseData,
-  ExecutionOptimisticAndVersionCodec,
-  ExecutionOptimisticAndVersionMeta,
-  ExecutionOptimisticCodec,
-  ExecutionOptimisticMeta,
+  ExecutionOptimisticAndFinalizedCodec,
+  ExecutionOptimisticAndFinalizedMeta,
+  ExecutionOptimisticFinalizedAndVersionCodec,
+  ExecutionOptimisticFinalizedAndVersionMeta,
   WithVersion,
 } from "../../../utils/codecs.js";
 import {toForkName} from "../../../utils/serdes.js";
@@ -90,7 +90,7 @@ export type Endpoints = {
     {blockId: BlockId},
     {params: {block_id: string}},
     allForks.SignedBeaconBlock,
-    ExecutionOptimisticAndVersionMeta
+    ExecutionOptimisticFinalizedAndVersionMeta
   >;
 
   /**
@@ -105,7 +105,7 @@ export type Endpoints = {
     {blockId: BlockId},
     {params: {block_id: string}},
     allForks.BeaconBlockBody["attestations"],
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -120,7 +120,7 @@ export type Endpoints = {
     {blockId: BlockId},
     {params: {block_id: string}},
     BlockHeaderResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -132,7 +132,7 @@ export type Endpoints = {
     {slot?: Slot; parentRoot?: string},
     {query: {slot?: number; parent_root?: string}},
     BlockHeaderResponse[],
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -147,7 +147,7 @@ export type Endpoints = {
     {blockId: BlockId},
     {params: {block_id: string}},
     RootResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -215,7 +215,7 @@ export type Endpoints = {
     {blockId: BlockId; indices?: number[]},
     {params: {block_id: string}; query: {indices?: number[]}},
     deneb.BlobSidecars,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 };
 
@@ -243,7 +243,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       req: blockIdOnlyReq,
       resp: {
         data: WithVersion((fork) => ssz[fork].SignedBeaconBlock),
-        meta: ExecutionOptimisticAndVersionCodec,
+        meta: ExecutionOptimisticFinalizedAndVersionCodec,
       },
     },
     getBlockAttestations: {
@@ -252,7 +252,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       req: blockIdOnlyReq,
       resp: {
         data: ssz.phase0.BeaconBlockBody.fields.attestations,
-        meta: ExecutionOptimisticCodec,
+        meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
     getBlockHeader: {
@@ -261,7 +261,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       req: blockIdOnlyReq,
       resp: {
         data: BlockHeaderResponseType,
-        meta: ExecutionOptimisticCodec,
+        meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
     getBlockHeaders: {
@@ -274,7 +274,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       },
       resp: {
         data: BlockHeadersResponseType,
-        meta: ExecutionOptimisticCodec,
+        meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
     getBlockRoot: {
@@ -283,7 +283,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       req: blockIdOnlyReq,
       resp: {
         data: RootResponseType,
-        meta: ExecutionOptimisticCodec,
+        meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
     publishBlock: {
@@ -523,7 +523,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       },
       resp: {
         data: ssz.deneb.BlobSidecars,
-        meta: ExecutionOptimisticCodec,
+        meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
   };

diff --git a/packages/api/src/beacon/routes/beacon/rewards.ts b/packages/api/src/beacon/routes/beacon/rewards.ts
@@ -3,7 +3,12 @@ import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {Epoch, ssz} from "@lodestar/types";
 
 import {Schema, Endpoint, RouteDefinitions} from "../../../utils/index.js";
-import {ArrayOf, ExecutionOptimisticCodec, ExecutionOptimisticMeta, JsonOnlyReq} from "../../../utils/codecs.js";
+import {
+  ArrayOf,
+  ExecutionOptimisticAndFinalizedCodec,
+  ExecutionOptimisticAndFinalizedMeta,
+  JsonOnlyReq,
+} from "../../../utils/codecs.js";
 import {BlockId} from "./block.js";
 import {ValidatorId} from "./state.js";
 
@@ -77,11 +82,6 @@ const SyncCommitteeRewardsType = ArrayOf(
   )
 );
 
-/**
- * True if the response references the finalized history of the chain, as determined by fork choice.
- */
-export type Finalized = boolean;
-
 /**
  * Rewards info for a single block. Every reward value is in Gwei.
  */
@@ -126,7 +126,7 @@ export type Endpoints = {
     {blockId: BlockId},
     {params: {block_id: string}},
     BlockRewards,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -141,7 +141,7 @@ export type Endpoints = {
     {epoch: Epoch; validatorIds?: ValidatorId[]},
     {params: {epoch: number}; body: ValidatorId[]},
     AttestationsRewards,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -157,7 +157,7 @@ export type Endpoints = {
     {blockId: BlockId; validatorIds?: ValidatorId[]},
     {params: {block_id: string}; body: ValidatorId[]},
     SyncCommitteeRewards,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 };
 
@@ -172,7 +172,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     },
     resp: {
       data: BlockRewardsType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getAttestationsRewards: {
@@ -194,7 +194,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     }),
     resp: {
       data: AttestationsRewardsType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getSyncCommitteeRewards: {
@@ -216,7 +216,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     }),
     resp: {
       data: SyncCommitteeRewardsType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
 };
diff --git a/packages/api/src/beacon/routes/beacon/state.ts b/packages/api/src/beacon/routes/beacon/state.ts
@@ -2,7 +2,11 @@
 import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {phase0, CommitteeIndex, Slot, Epoch, ssz, RootHex, StringType} from "@lodestar/types";
 import {Endpoint, RequestCodec, RouteDefinitions, Schema} from "../../../utils/index.js";
-import {ArrayOf, ExecutionOptimisticCodec, ExecutionOptimisticMeta} from "../../../utils/codecs.js";
+import {
+  ArrayOf,
+  ExecutionOptimisticAndFinalizedCodec,
+  ExecutionOptimisticAndFinalizedMeta,
+} from "../../../utils/codecs.js";
 import {WireFormat} from "../../../utils/headers.js";
 import {RootResponse, RootResponseType} from "./block.js";
 
@@ -88,7 +92,7 @@ export type Endpoints = {
     {stateId: StateId},
     {params: {state_id: string}},
     RootResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -104,7 +108,7 @@ export type Endpoints = {
     {stateId: StateId},
     {params: {state_id: string}},
     phase0.Fork,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -119,7 +123,7 @@ export type Endpoints = {
     {stateId: StateId; epoch?: Epoch},
     {params: {state_id: string}; query: {epoch?: number}},
     RandaoResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -135,7 +139,7 @@ export type Endpoints = {
     {stateId: StateId},
     {params: {state_id: string}},
     FinalityCheckpoints,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -151,7 +155,7 @@ export type Endpoints = {
     {stateId: StateId; validatorId: ValidatorId},
     {params: {state_id: string; validator_id: ValidatorId}},
     ValidatorResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -168,7 +172,7 @@ export type Endpoints = {
     {stateId: StateId; id?: ValidatorId[]; status?: ValidatorStatus[]},
     {params: {state_id: string}; query: {id?: ValidatorId[]; status?: ValidatorStatus[]}},
     ValidatorResponseList,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -184,7 +188,7 @@ export type Endpoints = {
     {stateId: StateId; indices?: ValidatorId[]},
     {params: {state_id: string}; query: {id?: ValidatorId[]}},
     ValidatorBalanceList,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   /**
@@ -202,7 +206,7 @@ export type Endpoints = {
     {stateId: StateId; epoch?: Epoch; index?: CommitteeIndex; slot?: Slot},
     {params: {state_id: string}; query: {slot?: number; epoch?: number; index?: number}},
     EpochCommitteeResponseList,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 
   getEpochSyncCommittees: Endpoint<
@@ -211,7 +215,7 @@ export type Endpoints = {
     {stateId: StateId; epoch?: Epoch},
     {params: {state_id: string}; query: {epoch?: number}},
     EpochSyncCommitteeResponse,
-    ExecutionOptimisticMeta
+    ExecutionOptimisticAndFinalizedMeta
   >;
 };
 
@@ -244,7 +248,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     },
     resp: {
       data: EpochCommitteeResponseListType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getEpochSyncCommittees: {
@@ -260,7 +264,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     },
     resp: {
       data: EpochSyncCommitteeResponseType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateFinalityCheckpoints: {
@@ -269,7 +273,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     req: stateIdOnlyReq,
     resp: {
       data: FinalityCheckpointsType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateFork: {
@@ -278,7 +282,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     req: stateIdOnlyReq,
     resp: {
       data: ssz.phase0.Fork,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateRoot: {
@@ -287,7 +291,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     req: stateIdOnlyReq,
     resp: {
       data: RootResponseType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateRandao: {
@@ -303,7 +307,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     },
     resp: {
       data: RandaoResponseType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateValidator: {
@@ -319,7 +323,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     resp: {
       onlySupport: WireFormat.json,
       data: ValidatorResponseType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateValidators: {
@@ -336,7 +340,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     resp: {
       onlySupport: WireFormat.json,
       data: ValidatorResponseListType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
   getStateValidatorBalances: {
@@ -352,7 +356,7 @@ export const definitions: RouteDefinitions<Endpoints> = {
     },
     resp: {
       data: ValidatorBalanceListType,
-      meta: ExecutionOptimisticCodec,
+      meta: ExecutionOptimisticAndFinalizedCodec,
     },
   },
 };