@lodestar/api 1.17.0-dev.eeaa7dabf3 → 1.17.0-dev.f47cc18b9c

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

@@ -6,14 +6,17 @@ import { RoutesData, ReturnTypes } from "../../../utils/index.js";
 import * as block from "./block.js";
 import * as pool from "./pool.js";
 import * as state from "./state.js";
+import * as rewards from "./rewards.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";
 export type { StateId, ValidatorId, ValidatorStatus, ValidatorFilters, CommitteesFilters, FinalityCheckpoints, ValidatorResponse, ValidatorBalance, EpochCommitteeResponse, EpochSyncCommitteeResponse, } from "./state.js";
-export type Api = block.Api & pool.Api & state.Api & {
+export type Api = block.Api & pool.Api & state.Api & rewards.Api & {
     getGenesis(): Promise<ApiClientResponse<{
         [HttpStatusCode.OK]: {
             data: phase0.Genesis;
@@ -25,6 +28,16 @@ export type ReqTypes = {
     [K in keyof ReturnType<typeof getReqSerializers>]: ReturnType<ReturnType<typeof getReqSerializers>[K]["writeReq"]>;
 };
 export declare function getReqSerializers(config: ChainForkConfig): {
+    getBlockRewards: import("../../../utils/types.js").ReqSerializer<(blockId: block.BlockId) => Promise<ApiClientResponse<{
+        200: {
+            data: rewards.BlockRewards;
+            executionOptimistic: boolean;
+        };
+    }, HttpStatusCode.BAD_REQUEST | HttpStatusCode.NOT_FOUND>>, {
+        params: {
+            block_id: string;
+        };
+    }>;
     getStateRoot: import("../../../utils/types.js").ReqSerializer<(stateId: state.StateId) => Promise<ApiClientResponse<{
         200: {
             data: {

package/lib/beacon/routes/beacon/index.js

@@ -4,18 +4,21 @@ import { reqEmpty, ContainerData } from "../../../utils/index.js";
 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
 // NOTE: We choose to split the block, pool, and state namespaces so the files are not too big.
 // However, for a consumer all these methods are within the same service "beacon"
 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 const routesData = {
     getGenesis: { url: "/eth/v1/beacon/genesis", method: "GET" },
     ...block.routesData,
     ...pool.routesData,
     ...state.routesData,
+    ...rewards.routesData,
 };
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function getReqSerializers(config) {
@@ -24,6 +27,7 @@ export function getReqSerializers(config) {
         ...block.getReqSerializers(config),
         ...pool.getReqSerializers(),
         ...state.getReqSerializers(),
+        ...rewards.getReqSerializers(),
     };
 }
 export function getReturnTypes() {
@@ -32,6 +36,7 @@ export function getReturnTypes() {
         ...block.getReturnTypes(),
         ...pool.getReturnTypes(),
         ...state.getReturnTypes(),
+        ...rewards.getReturnTypes(),
     };
 }
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/beacon/routes/beacon/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,GAAG,EAAC,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAA0B,QAAQ,EAAE,aAAa,EAAC,MAAM,yBAAyB,CAAC;AACzF,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,yFAAyF;AAEzF,+FAA+F;AAC/F,iFAAiF;AAEjF,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAC,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAuB/C,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,UAAU,EAAE,EAAC,GAAG,EAAE,wBAAwB,EAAE,MAAM,EAAE,KAAK,EAAC;IAC1D,GAAG,KAAK,CAAC,UAAU;IACnB,GAAG,IAAI,CAAC,UAAU;IAClB,GAAG,KAAK,CAAC,UAAU;CACpB,CAAC;AAMF,4EAA4E;AAC5E,MAAM,UAAU,iBAAiB,CAAC,MAAuB;IACvD,OAAO;QACL,UAAU,EAAE,QAAQ;QACpB,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAClC,GAAG,IAAI,CAAC,iBAAiB,EAAE;QAC3B,GAAG,KAAK,CAAC,iBAAiB,EAAE;KAC7B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,UAAU,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7C,GAAG,KAAK,CAAC,cAAc,EAAE;QACzB,GAAG,IAAI,CAAC,cAAc,EAAE;QACxB,GAAG,KAAK,CAAC,cAAc,EAAE;KAC1B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/beacon/routes/beacon/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,GAAG,EAAC,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAA0B,QAAQ,EAAE,aAAa,EAAC,MAAM,yBAAyB,CAAC;AACzF,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAExC,yFAAyF;AAEzF,+FAA+F;AAC/F,iFAAiF;AAEjF,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,EAAC,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAyB/C,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,UAAU,EAAE,EAAC,GAAG,EAAE,wBAAwB,EAAE,MAAM,EAAE,KAAK,EAAC;IAC1D,GAAG,KAAK,CAAC,UAAU;IACnB,GAAG,IAAI,CAAC,UAAU;IAClB,GAAG,KAAK,CAAC,UAAU;IACnB,GAAG,OAAO,CAAC,UAAU;CACtB,CAAC;AAMF,4EAA4E;AAC5E,MAAM,UAAU,iBAAiB,CAAC,MAAuB;IACvD,OAAO;QACL,UAAU,EAAE,QAAQ;QACpB,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAClC,GAAG,IAAI,CAAC,iBAAiB,EAAE;QAC3B,GAAG,KAAK,CAAC,iBAAiB,EAAE;QAC5B,GAAG,OAAO,CAAC,iBAAiB,EAAE;KAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,UAAU,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7C,GAAG,KAAK,CAAC,cAAc,EAAE;QACzB,GAAG,IAAI,CAAC,cAAc,EAAE;QACxB,GAAG,KAAK,CAAC,cAAc,EAAE;QACzB,GAAG,OAAO,CAAC,cAAc,EAAE;KAC5B,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,56 @@
+import { ValidatorIndex } from "@lodestar/types";
+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";
+/**
+ * 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;
+/**
+ * Rewards info for a single block. Every reward value is in Gwei.
+ */
+export type BlockRewards = {
+    /** Proposer of the block, the proposer index who receives these rewards */
+    proposerIndex: ValidatorIndex;
+    /** Total block reward, equal to attestations + sync_aggregate + proposer_slashings + attester_slashings */
+    total: number;
+    /** Block reward component due to included attestations */
+    attestations: number;
+    /** Block reward component due to included sync_aggregate */
+    syncAggregate: number;
+    /** Block reward component due to included proposer_slashings */
+    proposerSlashings: number;
+    /** Block reward component due to included attester_slashings */
+    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 declare const routesData: RoutesData<Api>;
+export type ReqTypes = {
+    getBlockRewards: {
+        params: {
+            block_id: string;
+        };
+    };
+};
+export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
+export declare function getReturnTypes(): ReturnTypes<Api>;
+//# sourceMappingURL=rewards.d.ts.map

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

@@ -0,0 +1,33 @@
+import { ContainerType } from "@chainsafe/ssz";
+import { ssz } from "@lodestar/types";
+import { Schema, ContainerDataExecutionOptimistic, } 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" },
+};
+export function getReqSerializers() {
+    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() {
+    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),
+    };
+}
+//# sourceMappingURL=rewards.js.map

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

@@ -0,0 +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"}

package/package.json

@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/ChainSafe/lodestar/issues"
   },
-  "version": "1.17.0-dev.eeaa7dabf3",
+  "version": "1.17.0-dev.f47cc18b9c",
   "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.eeaa7dabf3",
-    "@lodestar/params": "1.17.0-dev.eeaa7dabf3",
-    "@lodestar/types": "1.17.0-dev.eeaa7dabf3",
-    "@lodestar/utils": "1.17.0-dev.eeaa7dabf3",
+    "@lodestar/config": "1.17.0-dev.f47cc18b9c",
+    "@lodestar/params": "1.17.0-dev.f47cc18b9c",
+    "@lodestar/types": "1.17.0-dev.f47cc18b9c",
+    "@lodestar/utils": "1.17.0-dev.f47cc18b9c",
     "eventsource": "^2.0.2",
     "qs": "^6.11.1"
   },
@@ -89,5 +89,5 @@
     "api",
     "blockchain"
   ],
-  "gitHead": "f383403044d1fe10f610040631e01f31f2131490"
+  "gitHead": "ffe416684827a3624af0b16d40696707e773f07a"
 }