feat: improve batch validator exit UX #6327
Merged
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6327 +/- ##
============================================
- Coverage 76.61% 76.59% -0.02%
============================================
Files 248 248
Lines 25898 25907 +9
Branches 1448 1448
============================================
+ Hits 19842 19844 +2
- Misses 6026 6033 +7
Partials 30 30 |
|
Bulk withdrawals: Ran it one more time: Voluntary exit errored for 0x8069cae6625b9db897c51808d29a662038228ddf449ba0756e27f6c21c44ff2e13cae5760e6030b91e1431027559cdf5 (2183) 1/100: Internal Server Error: VOLUNTARY_EXIT_ERROR_INVALID
Voluntary exit already submitted for 99/100
- 0x80c1c1e2be166e969d86bfd99cfc6f6f44958d7c7d52d500d9a7b39a31792667f009c53c02403152f8b8d61bfe6c0f70 (2180)
- 0x8289754e5fbff939d619f329b0fc5cbd8d259bd98cc9c7e58d619fb4f54fdc5b48b3c1abb2a514e442fe575c68af458f (2132)
....Interesting to see that one of the validators (that have already exited) reports to be: |
barnabasbusa
approved these changes
Jan 19, 2024
Performance Report✔️ no performance regression detected Full benchmark results
|
wemeetagain
reviewed
Jan 19, 2024
| break; | ||
| const alreadySubmitted = []; | ||
| for (const [i, validatorToExit] of validatorsToExit.entries()) { | ||
| const {err} = await wrapError(processVoluntaryExit({config, client}, exitEpoch, validatorToExit)); |
There was a problem hiding this comment.
If we wanted to support better logging, esp in the case an exit is already processed by the chain, we could modify isValidVoluntaryExit to return an enum value
export enum VoluntaryExitValidity {
valid = "valid",
inactive = "inactive",
alreadyExited = "already_exited",
earlyEpoch = "early_epoch",
shortTimeActive = "short_time_active"
invalidSignature = "invalid_signature"
}
export function isValidVoluntaryExit(
state: CachedBeaconStateAllForks,
signedVoluntaryExit: phase0.SignedVoluntaryExit,
verifySignature = true
): boolean {
const {config, epochCtx} = state;
const voluntaryExit = signedVoluntaryExit.message;
const validator = state.validators.get(voluntaryExit.validatorIndex);
const currentEpoch = epochCtx.epoch;
// verify the validator is active
if(isActiveValidator(validator, currentEpoch) return VoluntaryExitValidity.inactive;
...
return VoluntaryExitValidity.valid;
}That enum value can get passed up into an error message / code and checked against for logging.
There was a problem hiding this comment.
we can do it if requested by anyone, for now this suffices as the main aim was to process all the exits and not bail early even if one errored
There was a problem hiding this comment.
Ok, lets make a low priority issue for it based on @barnabasbusa 's comment of:
Interesting to see that one of the validators (that have already exited) reports to be: 1/100: Internal Server Error: VOLUNTARY_EXIT_ERROR_INVALID
I read that "interesting to see" as "its weird/confusing/bad ux to see"
There was a problem hiding this comment.
It's not great UX to show internal server error imho, but I'm happy the bulk exists just work! Happy to get it merged as is.
There was a problem hiding this comment.
It's not great UX to show internal server error imho
The beacon node returning more user friendly errors could solve this as well, as per spec we should return a 400 (and not 500) error if voluntary exit is invalid.
wemeetagain
approved these changes
Jan 19, 2024
nflaig
reviewed
Jan 20, 2024
| break; | ||
| const alreadySubmitted = []; | ||
| for (const [i, validatorToExit] of validatorsToExit.entries()) { | ||
| const {err} = await wrapError(processVoluntaryExit({config, client}, exitEpoch, validatorToExit)); |
There was a problem hiding this comment.
It's not great UX to show internal server error imho
The beacon node returning more user friendly errors could solve this as well, as per spec we should return a 400 (and not 500) error if voluntary exit is invalid.
| @@ -2,3 +2,12 @@ | |||
| * Expected error that shouldn't print a stack trace | |||
| */ | |||
| export class YargsError extends Error {} | |||
|
|
|||
| export type Result<T> = {err: null; result: T} | {err: Error}; | |||
| export async function wrapError<T>(promise: Promise<T>): Promise<Result<T>> { | |||
There was a problem hiding this comment.
This function already exists as part of beacon node utils
Would make sense to move this to @lodestar/utils to make it more reusable across packages
|
🎉 This PR is included in v1.15.0 🎉 |
jeluard
pushed a commit
to jeluard/lodestar
that referenced
this pull request
Jan 30, 2024
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.
if there is an issue with one validator exit submission (most of the times already exited) other exits are not processed causing user frustration.
this PR processes all exits and console logs the status, and neatly handles the already exit scenarios of some of the validatoes which is what is what user faces most of the time
cc @barnabasbusa