fix: improve error logging of voluntary-exit command #5756
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
nflaig
commented
Jul 13, 2023
| @@ -28,6 +28,10 @@ export async function decryptKeystoreDefinitions( | |||
| keystoreDefinitions: LocalKeystoreDefinition[], | |||
| opts: KeystoreDecryptOptions | |||
| ): Promise<SignerLocal[]> { | |||
| if (keystoreDefinitions.length === 0) { | |||
There was a problem hiding this comment.
This prevents printing out meaningless progress indicator
100% of local keystores imported. current=0 total=0 rate=0.00keys/m
Loaded keystores via keystore cache
| @@ -33,7 +33,7 @@ If no `pubkeys` are provided, it will exit all validators that have been importe | |||
|
|
|||
| examples: [ | |||
| { | |||
| command: "validator voluntary-exit --pubkeys 0xF00", | |||
| command: "validator voluntary-exit --network goerli --pubkeys 0xF00", | |||
There was a problem hiding this comment.
Aligned with validator-import command and makes it more apparent that this command is network specific
Performance Report✔️ no performance regression detected Full benchmark results
|
philknows
reviewed
Jul 13, 2023
Co-authored-by: Phil Ngo <58080811+philknows@users.noreply.github.com>
|
This is great work! Do you think we should add a section to the docs about validator exiting? |
matthewkeil
approved these changes
Jul 13, 2023
There is a section in the docs generated from code, see validator voluntary exit. We could document this in validator management as well but I don't see the point unless we document a lot more details there. |
wemeetagain
approved these changes
Jul 13, 2023
Nice! I looked in validator management is what sparked the question @nflaig . I will read through the other section |
|
We could go way more in-depth in our docs about different concepts and not just how to do something with Lodestar. The Lighthouse docs are a great example, see their voluntary exit page, there is even a FAQ. Dumping more information into current validator management does not make sense in my opinion. First step would be to split out topics into sub sections to make them easier to find and read. Afterwards, we could consider adding more pages overtime and explaining a sort of topics more in-depth. Like just from the learnings we had so far in Eth protocol discussions we could fill a few pages with good content. |
|
🎉 This PR is included in v1.10.0 🎉 |
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
Closes #4540 and addresses error logging UX issues mentioned in #4540 (comment).
Description
This should address most of the confusion around why voluntary-exit does not work
getStateValidatorswithout pubkeys (user feedback)Error logging
No local keystores
Unknown pubkey (not found in local signers)
Validator with pubkey is unknown (not found in beacon state)