@lodestar/api 1.39.0-dev.aceb5b7416 → 1.39.0-dev.b2437a6348

package/src/beacon/routes/beacon/rewards.ts

@@ -1,112 +1,12 @@
-import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {Epoch, ssz} from "@lodestar/types";
-import {ArrayOf, JsonOnlyReq} from "../../../utils/codecs.js";
+import {Epoch, rewards} from "@lodestar/types";
+import {JsonOnlyReq} from "../../../utils/codecs.js";
 import {Endpoint, RouteDefinitions, Schema} from "../../../utils/index.js";
 import {ExecutionOptimisticAndFinalizedCodec, ExecutionOptimisticAndFinalizedMeta} from "../../../utils/metadata.js";
 import {fromValidatorIdsStr, toValidatorIdsStr} from "../../../utils/serdes.js";
 import {BlockArgs} from "./block.js";
 import {ValidatorId} from "./state.js";
 
-const BlockRewardsType = new ContainerType(
-  {
-    /** Proposer of the block, the proposer index who receives these rewards */
-    proposerIndex: ssz.ValidatorIndex,
-    /** Total block reward, equal to attestations + sync_aggregate + proposer_slashings + attester_slashings */
-    total: ssz.UintNum64,
-    /** Block reward component due to included attestations */
-    attestations: ssz.UintNum64,
-    /** Block reward component due to included sync_aggregate */
-    syncAggregate: ssz.UintNum64,
-    /** Block reward component due to included proposer_slashings */
-    proposerSlashings: ssz.UintNum64,
-    /** Block reward component due to included attester_slashings */
-    attesterSlashings: ssz.UintNum64,
-  },
-  {jsonCase: "eth2"}
-);
-
-const AttestationsRewardType = new ContainerType(
-  {
-    /** Reward for head vote. Could be negative to indicate penalty */
-    head: ssz.UintNum64,
-    /** Reward for target vote. Could be negative to indicate penalty */
-    target: ssz.UintNum64,
-    /** Reward for source vote. Could be negative to indicate penalty */
-    source: ssz.UintNum64,
-    /** Inclusion delay reward (phase0 only) */
-    inclusionDelay: ssz.UintNum64,
-    /** Inactivity penalty. Should be a negative number to indicate penalty */
-    inactivity: ssz.UintNum64,
-  },
-  {jsonCase: "eth2"}
-);
-
-const IdealAttestationsRewardsType = new ContainerType(
-  {
-    ...AttestationsRewardType.fields,
-    effectiveBalance: ssz.UintNum64,
-  },
-  {jsonCase: "eth2"}
-);
-
-const TotalAttestationsRewardsType = new ContainerType(
-  {
-    ...AttestationsRewardType.fields,
-    validatorIndex: ssz.ValidatorIndex,
-  },
-  {jsonCase: "eth2"}
-);
-
-const AttestationsRewardsType = new ContainerType(
-  {
-    idealRewards: ArrayOf(IdealAttestationsRewardsType),
-    totalRewards: ArrayOf(TotalAttestationsRewardsType),
-  },
-  {jsonCase: "eth2"}
-);
-
-const SyncCommitteeRewardsType = ArrayOf(
-  new ContainerType(
-    {
-      validatorIndex: ssz.ValidatorIndex,
-      reward: ssz.UintNum64,
-    },
-    {jsonCase: "eth2"}
-  )
-);
-
-/**
- * Rewards info for a single block. Every reward value is in Gwei.
- */
-export type BlockRewards = ValueOf<typeof BlockRewardsType>;
-
-/**
- * Rewards for a single set of (ideal or actual depending on usage) attestations. Reward value is in Gwei
- */
-export type AttestationsReward = ValueOf<typeof AttestationsRewardType>;
-
-/**
- * Rewards info for ideal attestations ie. Maximum rewards could be earned by making timely head, target and source vote.
- * `effectiveBalance` is in Gwei
- */
-export type IdealAttestationsReward = ValueOf<typeof IdealAttestationsRewardsType>;
-
-/**
- * Rewards info for actual attestations
- */
-export type TotalAttestationsReward = ValueOf<typeof TotalAttestationsRewardsType>;
-
-export type AttestationsRewards = ValueOf<typeof AttestationsRewardsType>;
-
-/**
- * Rewards info for sync committee participation. Every reward value is in Gwei.
- * Note: In the case that block proposer is present in `SyncCommitteeRewards`, the reward value only reflects rewards for
- * participating in sync committee. Please refer to `BlockRewards.syncAggregate` for rewards of proposer including sync committee
- * outputs into their block
- */
-export type SyncCommitteeRewards = ValueOf<typeof SyncCommitteeRewardsType>;
-
 export type Endpoints = {
   /**
    * Get block rewards
@@ -116,7 +16,7 @@ export type Endpoints = {
     "GET",
     BlockArgs,
     {params: {block_id: string}},
-    BlockRewards,
+    rewards.BlockRewards,
     ExecutionOptimisticAndFinalizedMeta
   >;
 
@@ -133,7 +33,7 @@ export type Endpoints = {
       validatorIds?: ValidatorId[];
     },
     {params: {epoch: number}; body: string[]},
-    AttestationsRewards,
+    rewards.AttestationsRewards,
     ExecutionOptimisticAndFinalizedMeta
   >;
 
@@ -148,7 +48,7 @@ export type Endpoints = {
       validatorIds?: ValidatorId[];
     },
     {params: {block_id: string}; body: string[]},
-    SyncCommitteeRewards,
+    rewards.SyncCommitteeRewards,
     ExecutionOptimisticAndFinalizedMeta
   >;
 };
@@ -164,7 +64,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         schema: {params: {block_id: Schema.StringRequired}},
       },
       resp: {
-        data: BlockRewardsType,
+        data: rewards.BlockRewardsType,
         meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
@@ -186,7 +86,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         },
       }),
       resp: {
-        data: AttestationsRewardsType,
+        data: rewards.AttestationsRewardsType,
         meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },
@@ -208,7 +108,7 @@ export function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpo
         },
       }),
       resp: {
-        data: SyncCommitteeRewardsType,
+        data: rewards.SyncCommitteeRewardsType,
         meta: ExecutionOptimisticAndFinalizedCodec,
       },
     },

package/src/beacon/routes/beacon/state.ts

@@ -2,6 +2,7 @@ import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
 import {MAX_VALIDATORS_PER_COMMITTEE} from "@lodestar/params";
 import {
+  ArrayOf,
   CommitteeIndex,
   Epoch,
   RootHex,
@@ -13,7 +14,7 @@ import {
   phase0,
   ssz,
 } from "@lodestar/types";
-import {ArrayOf, JsonOnlyReq} from "../../../utils/codecs.js";
+import {JsonOnlyReq} from "../../../utils/codecs.js";
 import {Endpoint, RequestCodec, RouteDefinitions, Schema} from "../../../utils/index.js";
 import {
   ExecutionOptimisticAndFinalizedCodec,

package/src/beacon/routes/config.ts

@@ -1,8 +1,7 @@
 import {ContainerType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig, SpecJson} from "@lodestar/config";
-import {ssz} from "@lodestar/types";
+import {ArrayOf, ssz} from "@lodestar/types";
 import {
-  ArrayOf,
   EmptyArgs,
   EmptyMeta,
   EmptyMetaCodec,

package/src/beacon/routes/debug.ts

@@ -1,8 +1,7 @@
 import {ContainerType, Type, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {BeaconState, StringType, fulu, ssz} from "@lodestar/types";
+import {ArrayOf, BeaconState, StringType, fulu, ssz} from "@lodestar/types";
 import {
-  ArrayOf,
   EmptyArgs,
   EmptyMeta,
   EmptyMetaCodec,

package/src/beacon/routes/lodestar.ts

@@ -1,8 +1,7 @@
 import {ContainerType, Type, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {BeaconState, Epoch, RootHex, Slot, ssz} from "@lodestar/types";
+import {ArrayOf, BeaconState, Epoch, RootHex, Slot, ssz} from "@lodestar/types";
 import {
-  ArrayOf,
   EmptyArgs,
   EmptyMeta,
   EmptyRequest,

package/src/beacon/routes/node.ts

@@ -1,8 +1,7 @@
 import {ContainerType, OptionalType, ValueOf} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {StringType, fulu, ssz, stringType} from "@lodestar/types";
+import {ArrayOf, StringType, fulu, ssz, stringType} from "@lodestar/types";
 import {
-  ArrayOf,
   EmptyArgs,
   EmptyMeta,
   EmptyMetaCodec,

package/src/beacon/routes/proof.ts

@@ -1,9 +1,8 @@
 import {CompactMultiProof, ProofType} from "@chainsafe/persistent-merkle-tree";
 import {ByteListType, ContainerType} from "@chainsafe/ssz";
 import {ChainForkConfig} from "@lodestar/config";
-import {ssz} from "@lodestar/types";
+import {ArrayOf, ssz} from "@lodestar/types";
 import {fromHex, toHex} from "@lodestar/utils";
-import {ArrayOf} from "../../utils/codecs.js";
 import {Endpoint, RouteDefinitions, Schema} from "../../utils/index.js";
 import {VersionCodec, VersionMeta} from "../../utils/metadata.js";
 

package/src/beacon/routes/validator.ts

@@ -8,6 +8,7 @@ import {
   isForkPostElectra,
 } from "@lodestar/params";
 import {
+  ArrayOf,
   Attestation,
   BLSSignature,
   BeaconBlock,
@@ -28,7 +29,6 @@ import {
 } from "@lodestar/types";
 import {fromHex, toHex, toRootHex} from "@lodestar/utils";
 import {
-  ArrayOf,
   EmptyMeta,
   EmptyMetaCodec,
   EmptyResponseCodec,
@@ -498,6 +498,10 @@ export type Endpoints = {
    * a validator client to correctly determine if one of its validators has been selected to
    * perform an aggregation duty in this slot.
    *
+   * Validator clients running in a distributed validator cluster must query this endpoint
+   * at the start of an epoch for the current and lookahead (next) epochs for all validators
+   * that have attester duties in the current and lookahead epochs.
+   *
    * Note that this endpoint is not implemented by the beacon node and will return a 501 error
    *
    * Returns an array of threshold aggregated beacon committee selection proofs
@@ -521,6 +525,9 @@ export type Endpoints = {
    * a validator client to correctly determine if one of its validators has been selected to
    * perform a sync committee contribution (sync aggregation) duty in this slot.
    *
+   * Validator clients running in a distributed validator cluster must query this endpoint
+   * at the start of each slot for all validators that are included in the current sync committee.
+   *
    * Note that this endpoint is not implemented by the beacon node and will return a 501 error
    *
    * Returns an array of threshold aggregated sync committee selection proofs

package/src/builder/routes.ts

@@ -1,6 +1,7 @@
 import {ChainForkConfig} from "@lodestar/config";
 import {ForkName, VALIDATOR_REGISTRY_LIMIT, isForkPostDeneb} from "@lodestar/params";
 import {
+  ArrayOf,
   BLSPubkey,
   ExecutionPayload,
   ExecutionPayloadAndBlobsBundle,
@@ -14,7 +15,6 @@ import {
 } from "@lodestar/types";
 import {fromHex, toPubkeyHex, toRootHex} from "@lodestar/utils";
 import {
-  ArrayOf,
   EmptyArgs,
   EmptyMeta,
   EmptyRequest,

package/src/utils/codecs.ts

@@ -1,4 +1,4 @@
-import {ArrayType, ListBasicType, ListCompositeType, Type, isBasicType, isCompositeType} from "@chainsafe/ssz";
+import {Type} from "@chainsafe/ssz";
 import {ForkName} from "@lodestar/params";
 import {objectToExpectedCase} from "@lodestar/utils";
 import {
@@ -68,16 +68,6 @@ export const EmptyResponseCodec: ResponseCodec<EmptyResponseEndpoint> = {
   isEmpty: true,
 };
 
-export function ArrayOf<T>(elementType: Type<T>, limit = Infinity): ArrayType<Type<T>, unknown, unknown> {
-  if (isCompositeType(elementType)) {
-    return new ListCompositeType(elementType, limit) as unknown as ArrayType<Type<T>, unknown, unknown>;
-  }
-  if (isBasicType(elementType)) {
-    return new ListBasicType(elementType, limit) as unknown as ArrayType<Type<T>, unknown, unknown>;
-  }
-  throw Error(`Unknown type ${elementType.typeName}`);
-}
-
 export function WithMeta<T, M extends {version: ForkName}>(getType: (m: M) => Type<T>): ResponseDataCodec<T, M> {
   return {
     toJson: (data, meta: M) => getType(meta).toJson(data),