Skip to content

Commit

Permalink
Use jsdoc to document properties
Browse files Browse the repository at this point in the history
  • Loading branch information
nflaig committed Jan 25, 2024
1 parent ee42dde commit b6f68d0
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions packages/api/src/beacon/routes/beacon/rewards.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,18 @@ export type ExecutionOptimistic = boolean;
* Rewards info for a single block. Every reward value is in Gwei.
*/
export type BlockRewards = {
proposerIndex: ValidatorIndex; // proposer of the block, the proposer index who receives these rewards
total: number; // total block reward, equal to attestations + sync_aggregate + proposer_slashings + attester_slashings
attestations: number; // block reward component due to included attestations
syncAggregate: number; // block reward component due to included sync_aggregate
proposerSlashings: number; // block reward component due to included proposer_slashings
attesterSlashings: number; // block reward component due to included attester_slashings
/** 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 = {
Expand Down

0 comments on commit b6f68d0

Please sign in to comment.