Skip to content

Add SSZ response support for validator_balances endpoints #622

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

Merged
nflaig merged 5 commits into from
Jul 3, 2026
Merged

Add SSZ response support for validator_balances endpoints #622

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5ae305
Add SSZ response to GET validator_balances endpoint
Zyra-V21 Jul 2, 2026
14f856b
Add 406 Not Acceptable response to GET validator_balances
Zyra-V21 Jul 2, 2026
9e83998
Add SSZ response to POST validator_balances endpoint
Zyra-V21 Jul 2, 2026
ba68cc4
Add 406 Not Acceptable response to POST validator_balances
Zyra-V21 Jul 2, 2026
f469def
Merge branch 'master' into feat/ssz-validator-balances
nflaig Jul 2, 2026
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
14 changes: 14 additions & 0 deletions apis/beacon/states/validator_balances.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ get:
match any known validator, no balance will be returned but this will not cause an error. There are no guarantees for the
returned data in terms of ordering; the index is returned for each balance, and can be used to confirm for which inputs a
response has been returned.

Depending on `Accept` header data can be returned either as JSON or as bytes serialized by SSZ.
tags:
- Beacon
parameters:
Expand Down Expand Up @@ -44,6 +46,9 @@ get:
type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ValidatorBalanceResponse'
application/octet-stream:
schema:
description: "SSZ serialized `List[Container{index: uint64, balance: uint64}, VALIDATOR_REGISTRY_LIMIT]` bytes. Use Accept header to choose this response type"
"400":
description: "Invalid state or validator ID"
content:
Expand All @@ -62,6 +67,8 @@ get:
example:
code: 404
message: "State not found"
"406":
$ref: "../../../beacon-node-oapi.yaml#/components/responses/NotAcceptable"
"414":
description: "Too many validator IDs"
content:
Expand All @@ -83,6 +90,8 @@ post:
match any known validator, no balance will be returned but this will not cause an error. There are no guarantees for the
returned data in terms of ordering; the index is returned for each balance, and can be used to confirm for which inputs a
response has been returned.

Depending on `Accept` header data can be returned either as JSON or as bytes serialized by SSZ.
tags:
- Beacon
parameters:
Expand Down Expand Up @@ -121,6 +130,9 @@ post:
type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ValidatorBalanceResponse'
application/octet-stream:
schema:
description: "SSZ serialized `List[Container{index: uint64, balance: uint64}, VALIDATOR_REGISTRY_LIMIT]` bytes. Use Accept header to choose this response type"
"400":
description: "Invalid state ID or malformed request"
content:
Expand All @@ -139,5 +151,7 @@ post:
example:
code: 404
message: "State not found"
"406":
$ref: "../../../beacon-node-oapi.yaml#/components/responses/NotAcceptable"
"500":
$ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'
Loading