feat: add endpoint for Altair block reward

packages/api/src/beacon/index.ts

@@ -5,6 +5,7 @@ import type {Api} from "./routes/index.js";
 export * as routes from "./routes/index.js";
 export {getClient} from "./client/index.js";
 export type {Api};
+export type {BlockRewards} from "./routes/index.js";
 
 // Declare namespaces for CLI options
 export type ApiNamespace = keyof Api;

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

@@ -6,6 +6,7 @@ import {RoutesData, ReturnTypes, reqEmpty, ContainerData} from "../../../utils/i
 import * as block from "./block.js";
 import * as pool from "./pool.js";
 import * as state from "./state.js";
+import * as rewards from "./rewards.js";
 
 // See /packages/api/src/routes/index.ts for reasoning and instructions to add new routes
 
@@ -15,9 +16,11 @@ import * as state from "./state.js";
 export * as block from "./block.js";
 export * as pool from "./pool.js";
 export * as state from "./state.js";
+export * as rewards from "./rewards.js";
 export {BroadcastValidation} from "./block.js";
 export type {BlockId, BlockHeaderResponse} from "./block.js";
 export type {AttestationFilters} from "./pool.js";
+export type {BlockRewards} from "./rewards.js";
 // TODO: Review if re-exporting all these types is necessary
 export type {
   StateId,
@@ -34,7 +37,8 @@ export type {
 
 export type Api = block.Api &
   pool.Api &
-  state.Api & {
+  state.Api &
+  rewards.Api & {
     getGenesis(): Promise<ApiClientResponse<{[HttpStatusCode.OK]: {data: phase0.Genesis}}>>;
   };
 
@@ -43,6 +47,7 @@ export const routesData: RoutesData<Api> = {
   ...block.routesData,
   ...pool.routesData,
   ...state.routesData,
+  ...rewards.routesData,
 };
 
 export type ReqTypes = {
@@ -56,6 +61,7 @@ export function getReqSerializers(config: ChainForkConfig) {
     ...block.getReqSerializers(config),
     ...pool.getReqSerializers(),
     ...state.getReqSerializers(),
+    ...rewards.getReqSerializers(),
   };
 }
 
@@ -65,5 +71,6 @@ export function getReturnTypes(): ReturnTypes<Api> {
     ...block.getReturnTypes(),
     ...pool.getReturnTypes(),
     ...state.getReturnTypes(),
+    ...rewards.getReturnTypes(),
   };
 }

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

@@ -0,0 +1,88 @@
+import {ContainerType} from "@chainsafe/ssz";
+import {ssz, ValidatorIndex} from "@lodestar/types";
+
+import {
+  RoutesData,
+  ReturnTypes,
+  Schema,
+  ReqSerializers,
+  ContainerDataExecutionOptimistic,
+} from "../../../utils/index.js";
+import {HttpStatusCode} from "../../../utils/client/httpStatusCode.js";
+import {ApiClientResponse} from "../../../interfaces.js";
+import {BlockId} from "./block.js";
+
+// See /packages/api/src/routes/index.ts for reasoning and instructions to add new routes
+
+/**
+ * True if the response references an unverified execution payload. Optimistic information may be invalidated at
+ * a later time. If the field is not present, assume the False value.
+ */
+export type ExecutionOptimistic = boolean;
+
+export type BlockRewards = {
+  proposerIndex: ValidatorIndex;
+  total: number;
+  attestations: number;
+  syncAggregate: number;
+  proposerSlashings: number;
+  attesterSlashings: number;
+};
+
+export type Api = {
+  /**
+   * Get block rewards
+   * Returns the info of rewards received by the block proposer
+   *
+   * @param blockId Block identifier.
+   * Can be one of: "head" (canonical head in node's view), "genesis", "finalized", \<slot\>, \<hex encoded blockRoot with 0x prefix\>.
+   */
+  getBlockRewards(
+    blockId: BlockId
+  ): Promise<
+    ApiClientResponse<
+      {[HttpStatusCode.OK]: {data: BlockRewards; executionOptimistic: ExecutionOptimistic}},
+      HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND
+    >
+  >;
+};
+
+/**
+ * Define javascript values for each route
+ */
+export const routesData: RoutesData<Api> = {
+  getBlockRewards: {url: "/eth/v1/beacon/rewards/blocks/{block_id}", method: "GET"},
+};
+
+export type ReqTypes = {
+  /* eslint-disable @typescript-eslint/naming-convention */
+  getBlockRewards: {params: {block_id: string}};
+};
+
+export function getReqSerializers(): ReqSerializers<Api, ReqTypes> {
+  return {
+    getBlockRewards: {
+      writeReq: (block_id) => ({params: {block_id: String(block_id)}}),
+      parseReq: ({params}) => [params.block_id],
+      schema: {params: {block_id: Schema.StringRequired}},
+    },
+  };
+}
+
+export function getReturnTypes(): ReturnTypes<Api> {
+  const BlockRewardsResponse = new ContainerType(
+    {
+      proposerIndex: ssz.ValidatorIndex,
+      total: ssz.UintNum64,
+      attestations: ssz.UintNum64,
+      syncAggregate: ssz.UintNum64,
+      proposerSlashings: ssz.UintNum64,
+      attesterSlashings: ssz.UintNum64,
+    },
+    {jsonCase: "eth2"}
+  );
+
+  return {
+    getBlockRewards: ContainerDataExecutionOptimistic(BlockRewardsResponse),
+  };
+}

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

@@ -30,6 +30,8 @@ export type Api = {
   validator: ValidatorApi;
 };
 
+export type {BlockRewards} from "./beacon/index.js";
+
 // Reasoning of the API definitions
 // ================================
 //

packages/api/test/unit/beacon/oapiSpec.test.ts

@@ -88,7 +88,6 @@ const ignoredOperations = [
   /* missing route */
   /* https://github.com/ChainSafe/lodestar/issues/5694 */
   "getSyncCommitteeRewards",
-  "getBlockRewards",
   "getAttestationsRewards",
   "getDepositSnapshot", // Won't fix for now, see https://github.com/ChainSafe/lodestar/issues/5697
   "getBlindedBlock", // https://github.com/ChainSafe/lodestar/issues/5699
@@ -123,6 +122,7 @@ const ignoredProperties: Record<string, IgnoredProperty> = {
   getBlockRoot: {response: ["finalized"]},
   getBlockAttestations: {response: ["finalized"]},
   getStateV2: {response: ["finalized"]},
+  getBlockRewards: {response: ["finalized"]},
 
   /* 
    https://github.com/ChainSafe/lodestar/issues/6168

packages/api/test/unit/beacon/testData/beacon.ts

@@ -168,6 +168,23 @@ export const testData: GenericServerTestCases<Api> = {
     res: {executionOptimistic: true, data: {validators: [1300], validatorAggregates: [[1300]]}},
   },
 
+  // reward
+
+  getBlockRewards: {
+    args: ["head"],
+    res: {
+      executionOptimistic: true,
+      data: {
+        proposerIndex: 0,
+        total: 15,
+        attestations: 8,
+        syncAggregate: 4,
+        proposerSlashings: 2,
+        attesterSlashings: 1,
+      },
+    },
+  },
+
   // -
 
   getGenesis: {

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

@@ -3,20 +3,23 @@ import {ApiModules} from "../types.js";
 import {getBeaconBlockApi} from "./blocks/index.js";
 import {getBeaconPoolApi} from "./pool/index.js";
 import {getBeaconStateApi} from "./state/index.js";
+import {getBeaconRewardsApi} from "./rewards/index.js";
 
 export function getBeaconApi(
   modules: Pick<ApiModules, "chain" | "config" | "logger" | "metrics" | "network" | "db">
 ): ServerApi<routes.beacon.Api> {
   const block = getBeaconBlockApi(modules);
   const pool = getBeaconPoolApi(modules);
   const state = getBeaconStateApi(modules);
+  const rewards = getBeaconRewardsApi(modules);
 
   const {chain, config} = modules;
 
   return {
     ...block,
     ...pool,
     ...state,
+    ...rewards,
 
     async getGenesis() {
       return {

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

@@ -0,0 +1,13 @@
+import {routes, ServerApi} from "@lodestar/api";
+import {ApiModules} from "../../types.js";
+import {resolveBlockId} from "../blocks/utils.js";
+
+export function getBeaconRewardsApi({chain}: Pick<ApiModules, "chain">): ServerApi<routes.beacon.rewards.Api> {
+  return {
+    async getBlockRewards(blockId) {
+      const {block, executionOptimistic} = await resolveBlockId(chain, blockId);
+      const data = await chain.getBlockRewards(block.message);
+      return {data, executionOptimistic};
+    },
+  };
+}

packages/beacon-node/src/chain/chain.ts

@@ -33,6 +33,7 @@ import {ProcessShutdownCallback} from "@lodestar/validator";
 import {Logger, gweiToWei, isErrorAborted, pruneSetToMax, sleep, toHex} from "@lodestar/utils";
 import {ForkSeq, SLOTS_PER_EPOCH} from "@lodestar/params";
 
+import {type BlockRewards} from "@lodestar/api";
 import {GENESIS_EPOCH, ZERO_HASH} from "../constants/index.js";
 import {IBeaconDb} from "../db/index.js";
 import {Metrics} from "../metrics/index.js";
@@ -76,6 +77,7 @@ import {BlockAttributes, produceBlockBody, produceCommonBlockBody} from "./produ
 import {computeNewStateRoot} from "./produceBlock/computeNewStateRoot.js";
 import {BlockInput} from "./blocks/types.js";
 import {SeenAttestationDatas} from "./seenCache/seenAttestationData.js";
+import {computeBlockRewards} from "./rewards/blockRewards.js";
 import {ShufflingCache} from "./shufflingCache.js";
 import {StateContextCache} from "./stateCache/stateContextCache.js";
 import {SeenGossipBlockInput} from "./seenCache/index.js";
@@ -991,4 +993,11 @@ export class BeaconChain implements IBeaconChain {
       }
     }
   }
+
+  async getBlockRewards(block: allForks.FullOrBlindedBeaconBlock): Promise<BlockRewards> {
+    const preState = (await this.regen.getPreState(block, {dontTransferCache: true}, RegenCaller.restApi)).clone();
+    const postState = this.regen.getStateSync(toHexString(block.stateRoot)) ?? undefined;
+    const result = computeBlockRewards(block, preState, postState);
+    return result;
+  }
 }

packages/beacon-node/src/chain/interface.ts

@@ -24,6 +24,7 @@ import {BeaconConfig} from "@lodestar/config";
 import {Logger} from "@lodestar/utils";
 
 import {IForkChoice, ProtoBlock} from "@lodestar/fork-choice";
+import {type BlockRewards} from "@lodestar/api";
 import {IEth1ForBlockProduction} from "../eth1/index.js";
 import {IExecutionEngine, IExecutionBuilder} from "../execution/index.js";
 import {Metrics} from "../metrics/metrics.js";
@@ -198,6 +199,8 @@ export interface IBeaconChain {
 
   regenCanAcceptWork(): boolean;
   blsThreadPoolCanAcceptWork(): boolean;
+
+  getBlockRewards(blockRef: allForks.FullOrBlindedBeaconBlock): Promise<BlockRewards>;
 }
 
 export type SSZObjectType =