@lodestar/api 1.17.0-dev.d10ed384d6 → 1.17.0-dev.d66f607108

package/lib/beacon/routes/beacon/index.d.ts

@@ -14,7 +14,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";
 export type { StateId, ValidatorId, ValidatorStatus, ValidatorFilters, CommitteesFilters, FinalityCheckpoints, ValidatorResponse, ValidatorBalance, EpochCommitteeResponse, EpochSyncCommitteeResponse, } from "./state.js";
 export type Api = block.Api & pool.Api & state.Api & rewards.Api & {
     getGenesis(): Promise<ApiClientResponse<{
@@ -38,6 +38,17 @@ export declare function getReqSerializers(config: ChainForkConfig): {
             block_id: string;
         };
     }>;
+    getSyncCommitteeRewards: import("../../../utils/types.js").ReqSerializer<(blockId: block.BlockId, validatorIds?: state.ValidatorId[] | undefined) => Promise<ApiClientResponse<{
+        200: {
+            data: rewards.SyncCommitteeRewards;
+            executionOptimistic: boolean;
+        };
+    }, HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND>>, {
+        params: {
+            block_id: string;
+        };
+        body: state.ValidatorId[];
+    }>;
     getStateRoot: import("../../../utils/types.js").ReqSerializer<(stateId: state.StateId) => Promise<ApiClientResponse<{
         200: {
             data: {

package/lib/beacon/routes/beacon/rewards.d.ts

@@ -3,6 +3,7 @@ import { RoutesData, ReturnTypes, ReqSerializers } from "../../../utils/index.js
 import { HttpStatusCode } from "../../../utils/client/httpStatusCode.js";
 import { ApiClientResponse } from "../../../interfaces.js";
 import { BlockId } from "./block.js";
+import { ValidatorId } from "./state.js";
 /**
  * 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.
@@ -25,6 +26,16 @@ export type BlockRewards = {
     /** Block reward component due to included attester_slashings */
     attesterSlashings: number;
 };
+/**
+ * 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 = {
+    validatorIndex: ValidatorIndex;
+    reward: number;
+}[];
 export type Api = {
     /**
      * Get block rewards
@@ -39,6 +50,20 @@ export type Api = {
             executionOptimistic: ExecutionOptimistic;
         };
     }, HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND>>;
+    /**
+     * Get sync committee rewards
+     * Returns participant reward value for each sync committee member at the given block.
+     *
+     * @param blockId Block identifier.
+     * Can be one of: "head" (canonical head in node's view), "genesis", "finalized", \<slot\>, \<hex encoded blockRoot with 0x prefix\>.
+     * @param validatorIds List of validator indices or pubkeys to filter in
+     */
+    getSyncCommitteeRewards(blockId: BlockId, validatorIds?: ValidatorId[]): Promise<ApiClientResponse<{
+        [HttpStatusCode.OK]: {
+            data: SyncCommitteeRewards;
+            executionOptimistic: ExecutionOptimistic;
+        };
+    }, HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND>>;
 };
 /**
  * Define javascript values for each route
@@ -50,6 +75,12 @@ export type ReqTypes = {
             block_id: string;
         };
     };
+    getSyncCommitteeRewards: {
+        params: {
+            block_id: string;
+        };
+        body: ValidatorId[];
+    };
 };
 export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
 export declare function getReturnTypes(): ReturnTypes<Api>;

package/lib/beacon/routes/beacon/rewards.js

@@ -1,12 +1,13 @@
 import { ContainerType } from "@chainsafe/ssz";
 import { ssz } from "@lodestar/types";
-import { Schema, ContainerDataExecutionOptimistic, } from "../../../utils/index.js";
+import { Schema, ContainerDataExecutionOptimistic, ArrayOf, } from "../../../utils/index.js";
 import { HttpStatusCode } from "../../../utils/client/httpStatusCode.js";
 /**
  * Define javascript values for each route
  */
 export const routesData = {
     getBlockRewards: { url: "/eth/v1/beacon/rewards/blocks/{block_id}", method: "GET" },
+    getSyncCommitteeRewards: { url: "/eth/v1/beacon/rewards/sync_committee/{block_id}", method: "POST" },
 };
 export function getReqSerializers() {
     return {
@@ -15,6 +16,14 @@ export function getReqSerializers() {
             parseReq: ({ params }) => [params.block_id],
             schema: { params: { block_id: Schema.StringRequired } },
         },
+        getSyncCommitteeRewards: {
+            writeReq: (block_id, validatorIds) => ({ params: { block_id: String(block_id) }, body: validatorIds || [] }),
+            parseReq: ({ params, body }) => [params.block_id, body],
+            schema: {
+                params: { block_id: Schema.StringRequired },
+                body: Schema.UintOrStringArray,
+            },
+        },
     };
 }
 export function getReturnTypes() {
@@ -26,8 +35,13 @@ export function getReturnTypes() {
         proposerSlashings: ssz.UintNum64,
         attesterSlashings: ssz.UintNum64,
     }, { jsonCase: "eth2" });
+    const SyncCommitteeRewardsResponse = new ContainerType({
+        validatorIndex: ssz.ValidatorIndex,
+        reward: ssz.UintNum64,
+    }, { jsonCase: "eth2" });
     return {
         getBlockRewards: ContainerDataExecutionOptimistic(BlockRewardsResponse),
+        getSyncCommitteeRewards: ContainerDataExecutionOptimistic(ArrayOf(SyncCommitteeRewardsResponse)),
     };
 }
 //# sourceMappingURL=rewards.js.map

package/lib/beacon/routes/beacon/rewards.js.map

@@ -1 +1 @@
-{"version":3,"file":"rewards.js","sourceRoot":"","sources":["../../../../src/beacon/routes/beacon/rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAC,GAAG,EAAiB,MAAM,iBAAiB,CAAC;AAEpD,OAAO,EAGL,MAAM,EAEN,gCAAgC,GACjC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AAgDvE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,eAAe,EAAE,EAAC,GAAG,EAAE,0CAA0C,EAAE,MAAM,EAAE,KAAK,EAAC;CAClF,CAAC;AAOF,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL,eAAe,EAAE;YACf,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAC,EAAC,CAAC;YAChE,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;SACpD;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,oBAAoB,GAAG,IAAI,aAAa,CAC5C;QACE,aAAa,EAAE,GAAG,CAAC,cAAc;QACjC,KAAK,EAAE,GAAG,CAAC,SAAS;QACpB,YAAY,EAAE,GAAG,CAAC,SAAS;QAC3B,aAAa,EAAE,GAAG,CAAC,SAAS;QAC5B,iBAAiB,EAAE,GAAG,CAAC,SAAS;QAChC,iBAAiB,EAAE,GAAG,CAAC,SAAS;KACjC,EACD,EAAC,QAAQ,EAAE,MAAM,EAAC,CACnB,CAAC;IAEF,OAAO;QACL,eAAe,EAAE,gCAAgC,CAAC,oBAAoB,CAAC;KACxE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rewards.js","sourceRoot":"","sources":["../../../../src/beacon/routes/beacon/rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAC,GAAG,EAAiB,MAAM,iBAAiB,CAAC;AAEpD,OAAO,EAGL,MAAM,EAEN,gCAAgC,EAChC,OAAO,GACR,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AA2EvE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,eAAe,EAAE,EAAC,GAAG,EAAE,0CAA0C,EAAE,MAAM,EAAE,KAAK,EAAC;IACjF,uBAAuB,EAAE,EAAC,GAAG,EAAE,kDAAkD,EAAE,MAAM,EAAE,MAAM,EAAC;CACnG,CAAC;AAQF,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL,eAAe,EAAE;YACf,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAC,EAAC,CAAC;YAChE,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC,EAAC;SACpD;QACD,uBAAuB,EAAE;YACvB,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAC,EAAE,IAAI,EAAE,YAAY,IAAI,EAAE,EAAC,CAAC;YACxG,QAAQ,EAAE,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC;YACrD,MAAM,EAAE;gBACN,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAC;gBACzC,IAAI,EAAE,MAAM,CAAC,iBAAiB;aAC/B;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,oBAAoB,GAAG,IAAI,aAAa,CAC5C;QACE,aAAa,EAAE,GAAG,CAAC,cAAc;QACjC,KAAK,EAAE,GAAG,CAAC,SAAS;QACpB,YAAY,EAAE,GAAG,CAAC,SAAS;QAC3B,aAAa,EAAE,GAAG,CAAC,SAAS;QAC5B,iBAAiB,EAAE,GAAG,CAAC,SAAS;QAChC,iBAAiB,EAAE,GAAG,CAAC,SAAS;KACjC,EACD,EAAC,QAAQ,EAAE,MAAM,EAAC,CACnB,CAAC;IAEF,MAAM,4BAA4B,GAAG,IAAI,aAAa,CACpD;QACE,cAAc,EAAE,GAAG,CAAC,cAAc;QAClC,MAAM,EAAE,GAAG,CAAC,SAAS;KACtB,EACD,EAAC,QAAQ,EAAE,MAAM,EAAC,CACnB,CAAC;IAEF,OAAO;QACL,eAAe,EAAE,gCAAgC,CAAC,oBAAoB,CAAC;QACvE,uBAAuB,EAAE,gCAAgC,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;KACjG,CAAC;AACJ,CAAC"}

package/package.json

@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/ChainSafe/lodestar/issues"
   },
-  "version": "1.17.0-dev.d10ed384d6",
+  "version": "1.17.0-dev.d66f607108",
   "type": "module",
   "exports": {
     ".": {
@@ -69,10 +69,10 @@
   "dependencies": {
     "@chainsafe/persistent-merkle-tree": "^0.6.1",
     "@chainsafe/ssz": "^0.14.0",
-    "@lodestar/config": "1.17.0-dev.d10ed384d6",
-    "@lodestar/params": "1.17.0-dev.d10ed384d6",
-    "@lodestar/types": "1.17.0-dev.d10ed384d6",
-    "@lodestar/utils": "1.17.0-dev.d10ed384d6",
+    "@lodestar/config": "1.17.0-dev.d66f607108",
+    "@lodestar/params": "1.17.0-dev.d66f607108",
+    "@lodestar/types": "1.17.0-dev.d66f607108",
+    "@lodestar/utils": "1.17.0-dev.d66f607108",
     "eventsource": "^2.0.2",
     "qs": "^6.11.1"
   },
@@ -89,5 +89,5 @@
     "api",
     "blockchain"
   ],
-  "gitHead": "ff87b171ff36a9ece6ae5267866c5c529e96a3a2"
+  "gitHead": "712475ac532009ebc5c22d6853dc4a7e73b44ffe"
 }