Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get block reward description update #9084

Merged
merged 3 commits into from
Feb 5, 2025
Merged

Get block reward description update #9084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
117f69c
update getBlockReward description
gfukushima Feb 5, 2025
52dd664
fix IT json
gfukushima Feb 5, 2025
40e609f
Merge branch 'master' into getBlockReward-description-update
gfukushima Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v1_beacon_rewards_blocks_{block_id}.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"tags" : [ "Beacon", "Rewards" ],
"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.",
"parameters" : [ {
"name" : "block_id",
"required" : true,
Expand Down
2 changes: 1 addition & 1 deletion ...sources/tech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v3_validator_blocks_{slot}.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
}
},
"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.",
"description": "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": {
"type": "string",
Expand Down
3 changes: 2 additions & 1 deletion ...pi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/rewards/GetBlockRewards.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ public GetBlockRewards(final ChainDataProvider chainDataProvider) {
EndpointMetadata.get(ROUTE)
.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(TAG_BEACON, TAG_REWARDS)
.pathParam(PARAMETER_BLOCK_ID)
.response(SC_OK, "Request successful", RESPONSE_TYPE)
Expand Down
2 changes: 1 addition & 1 deletion ethereum/json-types/src/main/java/tech/pegasys/teku/ethereum/json/types/EthereumTypes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public class EthereumTypes {
new StringBasedHeaderTypeDefinition.Builder<UInt256>()
.title(HEADER_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.")
.formatter(value -> value.toBigInteger().toString(10))
.parser(value -> UInt256.valueOf(new BigInteger(value, 10)))
.example("1")
Expand Down