fix!: update validator liveness API to be spec compliant #5667
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Performance Report✔️ no performance regression detected Full benchmark results
|
|
@nflaig could you look into why the API spec tests did not catch this? |
|
@dapplion yeah was wondering the same, haven't investigated it yet but will do. It might also be worth to see if we can validate pattern to ensure we are encoding correctly to prevent issues like the graffiti not being hex encoded. |
nflaig
force-pushed
the
nflaig/update-liveness-api
branch
from
ef64e04 to
99f17e4
Compare
nflaig
commented
Jun 19, 2023
| for (const response of previousEpochLiveness) { | ||
| if (response.epoch !== previousEpoch) { | ||
| // Server sending bad data | ||
| throw Error(`Inconsistent livenessResponseData epoch ${response.epoch} != ${previousEpoch}`); |
There was a problem hiding this comment.
Epoch is no longer part of response, no need to check this
wemeetagain
previously approved these changes
Jun 19, 2023
nflaig
force-pushed
the
nflaig/update-liveness-api
branch
from
99f17e4 to
4a781e2
Compare
wemeetagain
approved these changes
Jun 20, 2023
@dapplion this was not caught because our oapi spec tests check against v2.3.0 and not the latest spec (v2.4.1)
This seems to be validated already |
|
🎉 This PR is included in v1.10.0 🎉 |
nflaig
added
the
meta-breaking-change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Current implementation of validator liveness API is not spec compliant, see getLiveness.
The API was initially introduced in
and further updated here
Description
Update validator liveness API to conform with latest beacon API spec (liveness.yaml)
/eth/v1/validator/liveness/{epoch}ApiErrorinstead of normalErrorto improve error handling/loggingThis change is breaking as it introduces an incompatibility with older Lodestar versions but due to the fact that our implementation was never spec compliant I doubt it will cause any issues with other downstream tooling.