refactor: improve types package to use forks as generics

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

@@ -1,7 +1,17 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {ContainerType, ListCompositeType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {allForks, Slot, ssz, RootHex, deneb, isSignedBlockContents} from "@lodestar/types";
+import {
+  Slot,
+  ssz,
+  RootHex,
+  deneb,
+  isSignedBlockContents,
+  SignedBeaconBlock,
+  BeaconBlockBody,
+  SignedBeaconBlockOrContents,
+  SignedBlindedBeaconBlock,
+} from "@lodestar/types";
 import {ForkName, ForkSeq} from "@lodestar/params";
 import {Endpoint, RequestCodec, RouteDefinitions, Schema} from "../../../utils/index.js";
 import {EmptyMeta, EmptyResponseCodec, EmptyResponseData, WithVersion} from "../../../utils/codecs.js";
@@ -74,7 +84,7 @@ export type Endpoints = {
     "GET",
     BlockArgs,
     {params: {block_id: string}},
-    allForks.SignedBeaconBlock,
+    SignedBeaconBlock,
     ExecutionOptimisticFinalizedAndVersionMeta
   >;
 
@@ -86,7 +96,7 @@ export type Endpoints = {
     "GET",
     BlockArgs,
     {params: {block_id: string}},
-    allForks.BeaconBlockBody["attestations"],
+    BeaconBlockBody["attestations"],
     ExecutionOptimisticAndFinalizedMeta
   >;
 
@@ -139,7 +149,7 @@ export type Endpoints = {
    */
   publishBlock: Endpoint<
     "POST",
-    {signedBlockOrContents: allForks.SignedBeaconBlockOrContents},
+    {signedBlockOrContents: SignedBeaconBlockOrContents},
     {body: unknown; headers: {[MetaHeader.Version]: string}},
     EmptyResponseData,
     EmptyMeta
@@ -148,7 +158,7 @@ export type Endpoints = {
   publishBlockV2: Endpoint<
     "POST",
     {
-      signedBlockOrContents: allForks.SignedBeaconBlockOrContents;
+      signedBlockOrContents: SignedBeaconBlockOrContents;
       broadcastValidation?: BroadcastValidation;
     },
     {body: unknown; headers: {[MetaHeader.Version]: string}; query: {broadcast_validation?: string}},
@@ -162,7 +172,7 @@ export type Endpoints = {
    */
   publishBlindedBlock: Endpoint<
     "POST",
-    {signedBlindedBlock: allForks.SignedBlindedBeaconBlock},
+    {signedBlindedBlock: SignedBlindedBeaconBlock},
     {body: unknown; headers: {[MetaHeader.Version]: string}},
     EmptyResponseData,
     EmptyMeta
@@ -171,7 +181,7 @@ export type Endpoints = {
   publishBlindedBlockV2: Endpoint<
     "POST",
     {
-      signedBlindedBlock: allForks.SignedBlindedBeaconBlock;
+      signedBlindedBlock: SignedBlindedBeaconBlock;
       broadcastValidation?: BroadcastValidation;
     },
     {body: unknown; headers: {[MetaHeader.Version]: string}; query: {broadcast_validation?: string}},
@@ -267,9 +277,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
           return {
             body:
               config.getForkSeq(slot) < ForkSeq.deneb
-                ? config
-                    .getForkTypes(slot)
-                    .SignedBeaconBlock.toJson(signedBlockOrContents as allForks.SignedBeaconBlock)
+                ? config.getForkTypes(slot).SignedBeaconBlock.toJson(signedBlockOrContents as SignedBeaconBlock)
                 : SignedBlockContentsType.toJson(signedBlockOrContents as SignedBlockContents),
             headers: {
               [MetaHeader.Version]: config.getForkName(slot),
@@ -286,8 +294,8 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
             // Determine fork from slot in JSON payload
             forkName = config.getForkName(
               (body as {signed_block: unknown}).signed_block !== undefined
-                ? (body as {signed_block: allForks.SignedBeaconBlock}).signed_block.message.slot
-                : (body as allForks.SignedBeaconBlock).message.slot
+                ? (body as {signed_block: SignedBeaconBlock}).signed_block.message.slot
+                : (body as SignedBeaconBlock).message.slot
             );
           }
           const forkSeq = config.forks[forkName].seq;
@@ -305,9 +313,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
           return {
             body:
               config.getForkSeq(slot) < ForkSeq.deneb
-                ? config
-                    .getForkTypes(slot)
-                    .SignedBeaconBlock.serialize(signedBlockOrContents as allForks.SignedBeaconBlock)
+                ? config.getForkTypes(slot).SignedBeaconBlock.serialize(signedBlockOrContents as SignedBeaconBlock)
                 : SignedBlockContentsType.serialize(signedBlockOrContents as SignedBlockContents),
             headers: {
               [MetaHeader.Version]: config.getForkName(slot),
@@ -345,9 +351,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
           return {
             body:
               config.getForkSeq(slot) < ForkSeq.deneb
-                ? config
-                    .getForkTypes(slot)
-                    .SignedBeaconBlock.toJson(signedBlockOrContents as allForks.SignedBeaconBlock)
+                ? config.getForkTypes(slot).SignedBeaconBlock.toJson(signedBlockOrContents as SignedBeaconBlock)
                 : SignedBlockContentsType.toJson(signedBlockOrContents as SignedBlockContents),
             headers: {
               [MetaHeader.Version]: config.getForkName(slot),
@@ -373,9 +377,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
           return {
             body:
               config.getForkSeq(slot) < ForkSeq.deneb
-                ? config
-                    .getForkTypes(slot)
-                    .SignedBeaconBlock.serialize(signedBlockOrContents as allForks.SignedBeaconBlock)
+                ? config.getForkTypes(slot).SignedBeaconBlock.serialize(signedBlockOrContents as SignedBeaconBlock)
                 : SignedBlockContentsType.serialize(signedBlockOrContents as SignedBlockContents),
             headers: {
               [MetaHeader.Version]: config.getForkName(slot),

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

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {ContainerType, Type, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {allForks, ssz, StringType} from "@lodestar/types";
+import {ssz, StringType, BeaconState} from "@lodestar/types";
 import {
   ArrayOf,
   EmptyArgs,
@@ -98,7 +98,7 @@ export type Endpoints = {
     "GET",
     StateArgs,
     {params: {state_id: string}},
-    allForks.BeaconState,
+    BeaconState,
     ExecutionOptimisticFinalizedAndVersionMeta
   >;
 };
@@ -136,7 +136,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         },
       },
       resp: {
-        data: WithVersion((fork) => ssz[fork].BeaconState as Type<allForks.BeaconState>),
+        data: WithVersion((fork) => ssz[fork].BeaconState as Type<BeaconState>),
         meta: ExecutionOptimisticFinalizedAndVersionCodec,
       },
       init: {

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

@@ -1,6 +1,19 @@
 import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {Epoch, phase0, capella, Slot, ssz, StringType, RootHex, altair, UintNum64, allForks} from "@lodestar/types";
+import {
+  Epoch,
+  phase0,
+  capella,
+  Slot,
+  ssz,
+  StringType,
+  RootHex,
+  altair,
+  UintNum64,
+  LightClientOptimisticUpdate,
+  LightClientFinalityUpdate,
+  SSEPayloadAttributes,
+} from "@lodestar/types";
 import {ForkName} from "@lodestar/params";
 
 import {Endpoint, RouteDefinitions, Schema} from "../../utils/index.js";
@@ -113,9 +126,9 @@ export type EventData = {
     executionOptimistic: boolean;
   };
   [EventType.contributionAndProof]: altair.SignedContributionAndProof;
-  [EventType.lightClientOptimisticUpdate]: {version: ForkName; data: allForks.LightClientOptimisticUpdate};
-  [EventType.lightClientFinalityUpdate]: {version: ForkName; data: allForks.LightClientFinalityUpdate};
-  [EventType.payloadAttributes]: {version: ForkName; data: allForks.SSEPayloadAttributes};
+  [EventType.lightClientOptimisticUpdate]: {version: ForkName; data: LightClientOptimisticUpdate};
+  [EventType.lightClientFinalityUpdate]: {version: ForkName; data: LightClientFinalityUpdate};
+  [EventType.payloadAttributes]: {version: ForkName; data: SSEPayloadAttributes};
   [EventType.blobSidecar]: BlobSidecarSSE;
 };
 

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

@@ -1,6 +1,13 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {ListCompositeType, ValueOf} from "@chainsafe/ssz";
-import {ssz, SyncPeriod, allForks} from "@lodestar/types";
+import {
+  LightClientBootstrap,
+  LightClientFinalityUpdate,
+  LightClientOptimisticUpdate,
+  LightClientUpdate,
+  ssz,
+  SyncPeriod,
+} from "@lodestar/types";
 import {ForkName} from "@lodestar/params";
 import {ChainForkConfig} from "@lodestar/config";
 import {Endpoint, RouteDefinitions, Schema} from "../../utils/index.js";
@@ -33,7 +40,7 @@ export type Endpoints = {
     "GET",
     {startPeriod: SyncPeriod; count: number},
     {query: {start_period: number; count: number}},
-    allForks.LightClientUpdate[],
+    LightClientUpdate[],
     {versions: ForkName[]}
   >;
 
@@ -46,7 +53,7 @@ export type Endpoints = {
     "GET",
     EmptyArgs,
     EmptyRequest,
-    allForks.LightClientOptimisticUpdate,
+    LightClientOptimisticUpdate,
     VersionMeta
   >;
 
@@ -55,7 +62,7 @@ export type Endpoints = {
     "GET",
     EmptyArgs,
     EmptyRequest,
-    allForks.LightClientFinalityUpdate,
+    LightClientFinalityUpdate,
     VersionMeta
   >;
 
@@ -68,7 +75,7 @@ export type Endpoints = {
     "GET",
     {blockRoot: string},
     {params: {block_root: string}},
-    allForks.LightClientBootstrap,
+    LightClientBootstrap,
     VersionMeta
   >;
 
@@ -105,7 +112,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
           },
           fromJson: (data, meta) => {
             const updates = data as unknown[];
-            const value: allForks.LightClientUpdate[] = [];
+            const value: LightClientUpdate[] = [];
             for (let i = 0; i < updates.length; i++) {
               const version = meta.versions[i];
               value.push(getLightClientForkTypes(version).LightClientUpdate.fromJson(updates[i]));
@@ -132,9 +139,9 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
             if (!Array.isArray(resp)) {
               throw Error("JSON is not an array");
             }
-            const updates: allForks.LightClientUpdate[] = [];
+            const updates: LightClientUpdate[] = [];
             const meta: {versions: ForkName[]} = {versions: []};
-            for (const {data, version} of resp as {data: allForks.LightClientUpdate; version: string}[]) {
+            for (const {data, version} of resp as {data: LightClientUpdate; version: string}[]) {
               updates.push(data);
               meta.versions.push(toForkName(version));
             }

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

@@ -3,7 +3,6 @@ import {ContainerType, fromHexString, toHexString, Type, ValueOf} from "@chainsa
 import {ChainForkConfig} from "@lodestar/config";
 import {isForkBlobs} from "@lodestar/params";
 import {
-  allForks,
   altair,
   BLSSignature,
   CommitteeIndex,
@@ -16,6 +15,8 @@ import {
   ValidatorIndex,
   ProducedBlockSource,
   stringType,
+  BeaconBlockOrContents,
+  BlindedBeaconBlock,
 } from "@lodestar/types";
 import {Endpoint, RouteDefinitions, Schema} from "../../utils/index.js";
 import {fromGraffitiHex, toBoolean, toGraffitiHex} from "../../utils/serdes.js";
@@ -315,7 +316,7 @@ export type Endpoints = {
         strict_fee_recipient_check?: boolean;
       };
     },
-    allForks.BeaconBlockOrContents,
+    BeaconBlockOrContents,
     VersionMeta
   >;
 
@@ -349,7 +350,7 @@ export type Endpoints = {
         blinded_local?: boolean;
       };
     },
-    allForks.FullOrBlindedBeaconBlockOrContents,
+    BeaconBlockOrContents | BlindedBeaconBlock,
     ProduceBlockV3Meta
   >;
 
@@ -361,7 +362,7 @@ export type Endpoints = {
       graffiti: string;
     },
     {params: {slot: number}; query: {randao_reveal: string; graffiti: string}},
-    allForks.BlindedBeaconBlock,
+    BlindedBeaconBlock,
     VersionMeta
   >;
 
@@ -623,8 +624,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
       },
       resp: {
         data: WithVersion(
-          (fork) =>
-            (isForkBlobs(fork) ? BlockContentsType : ssz[fork].BeaconBlock) as Type<allForks.BeaconBlockOrContents>
+          (fork) => (isForkBlobs(fork) ? BlockContentsType : ssz[fork].BeaconBlock) as Type<BeaconBlockOrContents>
         ),
         meta: VersionCodec,
       },
@@ -688,7 +688,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
               ? getBlindedForkTypes(version).BeaconBlock
               : isForkBlobs(version)
                 ? BlockContentsType
-                : ssz[version].BeaconBlock) as Type<allForks.FullOrBlindedBeaconBlockOrContents>
+                : ssz[version].BeaconBlock) as Type<BeaconBlockOrContents | BlindedBeaconBlock>
         ),
         meta: {
           toJson: (meta) => ({

packages/api/src/builder/routes.ts

@@ -1,6 +1,16 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {fromHexString, toHexString} from "@chainsafe/ssz";
-import {ssz, allForks, bellatrix, Slot, Root, BLSPubkey} from "@lodestar/types";
+import {
+  ssz,
+  bellatrix,
+  Slot,
+  Root,
+  BLSPubkey,
+  ExecutionPayload,
+  ExecutionPayloadAndBlobsBundle,
+  SignedBlindedBeaconBlock,
+  SignedBuilderBid,
+} from "@lodestar/types";
 import {ForkName, isForkBlobs} from "@lodestar/params";
 import {ChainForkConfig} from "@lodestar/config";
 
@@ -26,7 +36,7 @@ import {fromHeaders} from "../utils/headers.js";
 // In this case, we receive a success response (204) which is not handled as an error. The generic response
 // handler already checks the status code and will not attempt to parse the body, but it will return no value.
 // It is important that this type indicates that there might be no value to ensure it is properly handled downstream.
-export type MaybeSignedBuilderBid = allForks.SignedBuilderBid | undefined;
+export type MaybeSignedBuilderBid = SignedBuilderBid | undefined;
 
 const RegistrationsType = ArrayOf(ssz.bellatrix.SignedValidatorRegistrationV1);
 
@@ -62,9 +72,9 @@ export type Endpoints = {
 
   submitBlindedBlock: Endpoint<
     "POST",
-    {signedBlindedBlock: allForks.SignedBlindedBeaconBlock},
+    {signedBlindedBlock: SignedBlindedBeaconBlock},
     {body: unknown; headers: {[MetaHeader.Version]: string}},
-    allForks.ExecutionPayload | allForks.ExecutionPayloadAndBlobsBundle,
+    ExecutionPayload | ExecutionPayloadAndBlobsBundle,
     VersionMeta
   >;
 };
@@ -138,13 +148,11 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
         },
       }),
       resp: {
-        data: WithVersion<allForks.ExecutionPayload | allForks.ExecutionPayloadAndBlobsBundle, VersionMeta>(
-          (fork: ForkName) => {
-            return isForkBlobs(fork)
-              ? ssz.allForksBlobs[fork].ExecutionPayloadAndBlobsBundle
-              : getExecutionForkTypes(fork).ExecutionPayload;
-          }
-        ),
+        data: WithVersion<ExecutionPayload | ExecutionPayloadAndBlobsBundle, VersionMeta>((fork: ForkName) => {
+          return isForkBlobs(fork)
+            ? ssz.allForksBlobs[fork].ExecutionPayloadAndBlobsBundle
+            : getExecutionForkTypes(fork).ExecutionPayload;
+        }),
         meta: VersionCodec,
       },
     },