@lodestar/api 1.43.0 → 1.44.0-dev.00facd40a8

package/src/beacon/routes/debug.ts

@@ -1,4 +1,4 @@
-import {ContainerType, Type, ValueOf} from "@chainsafe/ssz";
+import {ContainerType, OptionalType, Type, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
 import {isForkPostFulu} from "@lodestar/params";
 import {ArrayOf, BeaconState, DataColumnSidecars, StringType, ssz, sszTypesFor} from "@lodestar/types";
@@ -78,12 +78,62 @@ const ForkChoiceResponseType = new ContainerType(
   {jsonCase: "eth2"}
 );
 
+const ForkChoiceNodeV2ExtraDataType = new ContainerType(
+  {
+    executionOptimistic: ssz.Boolean,
+    timestamp: ssz.UintNum64,
+    target: stringType,
+    justifiedEpoch: ssz.Epoch,
+    finalizedEpoch: ssz.Epoch,
+    unrealizedJustifiedEpoch: ssz.Epoch,
+    unrealizedFinalizedEpoch: ssz.Epoch,
+    payloadAttesterCount: new OptionalType(ssz.UintNum64),
+    payloadAvailabilityYesCount: new OptionalType(ssz.UintNum64),
+    payloadDataAvailabilityYesCount: new OptionalType(ssz.UintNum64),
+    gasLimit: new OptionalType(ssz.UintNum64),
+  },
+  {jsonCase: "eth2"}
+);
+const ForkChoiceNodeV2Type = new ContainerType(
+  {
+    payloadStatus: new StringType<"pending" | "empty" | "full">(),
+    slot: ssz.Slot,
+    blockRoot: stringType,
+    parentRoot: stringType,
+    weight: ssz.UintNum64,
+    validity: new StringType<"valid" | "invalid" | "optimistic">(),
+    executionBlockHash: stringType,
+    extraData: ForkChoiceNodeV2ExtraDataType,
+  },
+  {jsonCase: "eth2"}
+);
+const ForkChoiceExtraDataType = new ContainerType(
+  {
+    unrealizedJustifiedCheckpoint: ssz.phase0.Checkpoint,
+    unrealizedFinalizedCheckpoint: ssz.phase0.Checkpoint,
+    proposerBoostRoot: stringType,
+    previousProposerBoostRoot: stringType,
+    headRoot: stringType,
+  },
+  {jsonCase: "eth2"}
+);
+const ForkChoiceResponseV2Type = new ContainerType(
+  {
+    justifiedCheckpoint: ssz.phase0.Checkpoint,
+    finalizedCheckpoint: ssz.phase0.Checkpoint,
+    forkChoiceNodes: ArrayOf(ForkChoiceNodeV2Type),
+    extraData: ForkChoiceExtraDataType,
+  },
+  {jsonCase: "eth2"}
+);
+
 const ProtoNodeListType = ArrayOf(ProtoNodeType);
 const DebugChainHeadListType = ArrayOf(DebugChainHeadType);
 
 type ProtoNodeList = ValueOf<typeof ProtoNodeListType>;
 type DebugChainHeadList = ValueOf<typeof DebugChainHeadListType>;
 type ForkChoiceResponse = ValueOf<typeof ForkChoiceResponseType>;
+type ForkChoiceResponseV2 = ValueOf<typeof ForkChoiceResponseV2Type>;
 
 export type Endpoints = {
   /**
@@ -110,6 +160,18 @@ export type Endpoints = {
     EmptyMeta
   >;
 
+  /**
+   * Retrieves all current fork choice context (v2: per (root, payload_status) with PTC vote tallies)
+   */
+  getDebugForkChoiceV2: Endpoint<
+    // ⏎
+    "GET",
+    EmptyArgs,
+    EmptyRequest,
+    ForkChoiceResponseV2,
+    EmptyMeta
+  >;
+
   /**
    * Dump all ProtoArray's nodes to debug
    */
@@ -185,6 +247,24 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         },
       },
     },
+    getDebugForkChoiceV2: {
+      url: "/eth/v2/debug/fork_choice",
+      method: "GET",
+      req: EmptyRequestCodec,
+      resp: {
+        data: ForkChoiceResponseV2Type,
+        meta: EmptyMetaCodec,
+        onlySupport: WireFormat.json,
+        transform: {
+          toResponse: (data) => ({
+            ...(data as ForkChoiceResponseV2),
+          }),
+          fromResponse: (resp) => ({
+            data: resp as ForkChoiceResponseV2,
+          }),
+        },
+      },
+    },
     getProtoArrayNodes: {
       url: "/eth/v0/debug/forkchoice",
       method: "GET",

package/src/beacon/routes/events.ts

@@ -108,6 +108,8 @@ export enum EventType {
   executionPayloadAvailable = "execution_payload_available",
   /** The node has received a `SignedExecutionPayloadBid` (from P2P or API) that passes gossip validation on the `execution_payload_bid` topic */
   executionPayloadBid = "execution_payload_bid",
+  /** The node has received a `SignedProposerPreferences` (from P2P or API) that passes gossip validation on the `proposer_preferences` topic */
+  proposerPreferences = "proposer_preferences",
 }
 
 export const eventTypes: {[K in EventType]: K} = {
@@ -132,6 +134,7 @@ export const eventTypes: {[K in EventType]: K} = {
   [EventType.executionPayloadGossip]: EventType.executionPayloadGossip,
   [EventType.executionPayloadAvailable]: EventType.executionPayloadAvailable,
   [EventType.executionPayloadBid]: EventType.executionPayloadBid,
+  [EventType.proposerPreferences]: EventType.proposerPreferences,
 };
 
 export type EventData = {
@@ -199,6 +202,7 @@ export type EventData = {
     blockRoot: RootHex;
   };
   [EventType.executionPayloadBid]: {version: ForkName; data: gloas.SignedExecutionPayloadBid};
+  [EventType.proposerPreferences]: {version: ForkName; data: gloas.SignedProposerPreferences};
 };
 
 export type BeaconEvent = {[K in EventType]: {type: K; message: EventData[K]}}[EventType];
@@ -395,6 +399,7 @@ export function getTypeByEvent(config: ChainForkConfig): {[K in EventType]: Type
       {jsonCase: "eth2"}
     ),
     [EventType.executionPayloadBid]: WithVersion((fork) => getPostGloasForkTypes(fork).SignedExecutionPayloadBid),
+    [EventType.proposerPreferences]: WithVersion((fork) => getPostGloasForkTypes(fork).SignedProposerPreferences),
 
     [EventType.lightClientOptimisticUpdate]: WithVersion(
       (fork) => getPostAltairForkTypes(fork).LightClientOptimisticUpdate

package/src/beacon/routes/node.ts

@@ -108,6 +108,7 @@ export enum ClientCode {
   BU = "BU", // besu
   EJ = "EJ", // ethereumJS
   EG = "EG", // erigon
+  EX = "EX", // ethrex
   GE = "GE", // go-ethereum
   GR = "GR", // grandine
   LH = "LH", // lighthouse

package/src/beacon/routes/validator.ts

@@ -960,7 +960,7 @@ export function getDefinitions(config: ChainForkConfig): RouteDefinitions<Endpoi
       },
     },
     getExecutionPayloadEnvelope: {
-      url: "/eth/v1/validator/execution_payload_envelope/{slot}/{beacon_block_root}",
+      url: "/eth/v1/validator/execution_payload_envelopes/{slot}/{beacon_block_root}",
       method: "GET",
       req: {
         writeReq: ({slot, beaconBlockRoot}) => ({