Follow convention from block rewards

ChainSafe · Feb 23, 2024 · 5302c93 · 5302c93
1 parent 017565e
commit 5302c93
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 14 deletions.
diff --git a/packages/api/src/beacon/routes/beacon/index.ts b/packages/api/src/beacon/routes/beacon/index.ts
@@ -20,7 +20,7 @@ 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";
+export type {BlockRewards, SyncCommitteeRewards} from "./rewards.js";
 // TODO: Review if re-exporting all these types is necessary
 export type {
   StateId,

diff --git a/packages/api/src/beacon/routes/beacon/rewards.ts b/packages/api/src/beacon/routes/beacon/rewards.ts
@@ -40,7 +40,11 @@ export type BlockRewards = {
   attesterSlashings: number;
 };
 
-export type SyncCommitteeRewardsResponse = {validatorIndex: ValidatorIndex; reward: number}[];
+/**
+ * Rewards info for sync committee participation. Every reward value is in Gwei.
+ * Note: This excludes sync aggregate reward. The reward for proposer here only reflect the sync committee participation portion
+ */
+export type SyncCommitteeRewards = {validatorIndex: ValidatorIndex; reward: number}[];
 
 export type Api = {
   /**
@@ -63,7 +67,7 @@ export type Api = {
     filters?: ValidatorId[]
   ): Promise<
     ApiClientResponse<
-      {[HttpStatusCode.OK]: {data: SyncCommitteeRewardsResponse; executionOptimistic: ExecutionOptimistic}},
+      {[HttpStatusCode.OK]: {data: SyncCommitteeRewards; executionOptimistic: ExecutionOptimistic}},
       HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND
     >
   >;
@@ -114,7 +118,7 @@ export function getReturnTypes(): ReturnTypes<Api> {
     {jsonCase: "eth2"}
   );
 
-  const SyncCommitteeRewards = new ContainerType(
+  const SyncCommitteeRewardsResponse = new ContainerType(
     {
       validatorIndex: ssz.ValidatorIndex,
       reward: ssz.UintNum64,
@@ -124,6 +128,6 @@ export function getReturnTypes(): ReturnTypes<Api> {
 
   return {
     getBlockRewards: ContainerDataExecutionOptimistic(BlockRewardsResponse),
-    getSyncCommitteeRewards: ContainerDataExecutionOptimistic(ArrayOf(SyncCommitteeRewards)),
+    getSyncCommitteeRewards: ContainerDataExecutionOptimistic(ArrayOf(SyncCommitteeRewardsResponse)),
   };
 }
diff --git a/packages/beacon-node/src/chain/chain.ts b/packages/beacon-node/src/chain/chain.ts
@@ -1009,9 +1009,12 @@ export class BeaconChain implements IBeaconChain {
     block: allForks.FullOrBlindedBeaconBlock,
     filter?: (ValidatorIndex | string)[]
   ): Promise<SyncCommitteeRewards> {
-    const preState = (await this.regen.getPreState(block, {dontTransferCache: true}, RegenCaller.restApi)).clone();
-    preState.slot = block.slot; // regen.getPreState guarantees pre_state of the same epoch but not the same slot
-    const result = computeSyncCommitteeRewards(block, preState, filter);
-    return result;
+    const preState = this.regen.getPreStateSync(block);
+
+    if (preState === null) {
+      throw Error(`Pre-state is unavailable given block's parent root ${toHexString(block.parentRoot)}`);
+    }
+
+    return computeSyncCommitteeRewards(block, preState.clone(), filter);
   }
 }
diff --git a/packages/beacon-node/src/chain/rewards/syncCommitteeRewards.ts b/packages/beacon-node/src/chain/rewards/syncCommitteeRewards.ts
@@ -1,12 +1,9 @@
 import {CachedBeaconStateAllForks, CachedBeaconStateAltair} from "@lodestar/state-transition";
 import {ValidatorIndex, allForks, altair} from "@lodestar/types";
 import {ForkName, SYNC_COMMITTEE_SIZE} from "@lodestar/params";
+import {routes} from "@lodestar/api";
 
-// Note: This excludes sync aggregate reward. The reward for proposer here only reflect the sync committee participation portion
-export type SyncCommitteeRewards = {
-  validatorIndex: ValidatorIndex;
-  reward: number;
-}[];
+export type SyncCommitteeRewards = routes.beacon.SyncCommitteeRewards;
 
 export async function computeSyncCommitteeRewards(
   block: allForks.BeaconBlock,