disambiguate and ensure consistency of proposeBlockV3/`getBlockRewa…

…rds` consensus block value (ethereum#481) Co-authored-by: Paul Harris <[email protected]>
ensi321 · Jan 12, 2025 · aa1be25 · aa1be25
1 parent 7e9bd04
commit aa1be25
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/apis/beacon/rewards/blocks.yaml b/apis/beacon/rewards/blocks.yaml
@@ -1,7 +1,10 @@
 get:
   operationId: getBlockRewards
   summary: Get block rewards
-  description: Retrieve block reward info for a single block
+  description: |
+    Retrieve block reward info for a single block. The rewards value is the sum
+    of values of the proposer rewards from attestations, sync committees and
+    slashings included in the proposal.
   tags:
     - Beacon
     - Rewards

diff --git a/beacon-node-oapi.yaml b/beacon-node-oapi.yaml
@@ -486,8 +486,11 @@ components:
         $ref: './types/primitive.yaml#/Wei'
     Eth-Consensus-Block-Value:
       description: |
-        Consensus rewards paid to the proposer for this block, in Wei. Required in response so
-        client can determine relative value of consensus blocks.
+        Consensus rewards for this block in Wei paid to the proposer. The
+        rewards value is the sum of values of the proposer rewards from
+        attestations, sync committees and slashings included in the proposal.
+        Required in response so client can determine relative value of
+        consensus blocks.
       required: true
       schema:
         $ref: './types/primitive.yaml#/Wei'