[Merged by Bors] - Add new validator API for voluntary exit #4119

jimmygchen · 2023-03-22T05:36:06Z

Issue Addressed

Addresses #4117

Proposed Changes

See ethereum/keymanager-APIs#58 for proposed API specification.

TODO

~~Add submission to BN~~
- removed, see discussion in keymanager API
~~Add flag to allow voluntary exit via the API~~
- no longer needed now the VC doesn't submit exit directly
~~Additional verification / checks, e.g. if validator on same network as BN~~
- to be done on client side
~~Potentially wait for the message to propagate and return some exit information in the response~~
- not required
Update http tests
~~Update lighthouse book~~
- not required if this endpoint makes it to the standard keymanager API

jimmygchen · 2023-03-22T06:34:00Z

Hi @AgeManning

I've done an basic implementation based on the existing voluntary exit logic from account manager. I have a few questions:

Is it necessary and possible here to check the validator is on the same network as the BN? I wonder if the BN already does some sort of checks. I think this may require passing the Eth2NetworkConfig to the http-api::Context, I'm checking if this is available in the VC.
- UPDATE: Not required, this is already checked during VC startup
I think it may be useful to wait for the message to propagate (one slot?) and return additional info in the response (e.g. current_epoch, exit_epoch, withdrawal_epoch). Alternatively, we could get the UI to query the validator a slot later - this might be easier. What do you think?
- UPDATE: best for the UI to query

jimmygchen · 2023-03-22T10:29:29Z

Looks like we may not need to submit the message to the BN with this API, we could return the signed voluntary exit object and leave it to the UI to publish to BN.

…of submitting to BN

AgeManning · 2023-03-22T21:45:15Z

Looking good!

jimmygchen · 2023-03-24T00:17:02Z

The current implementation works, but I'd probably hold off further changes for now as we have an active discussion on this endpoint in the key manager API spec ethereum/keymanager-APIs#57

jimmygchen · 2023-03-24T04:35:14Z

PR for keymanager-API spec: ethereum/keymanager-APIs#58

…nd return SignedVoluntaryExit object

paulhauner · 2023-03-29T03:48:31Z

validator_client/src/http_api/create_signed_voluntary_exit.rs

+    let validator_index = validator_store
+        .validator_index(&pubkey_bytes)
+        .ok_or_else(|| {
+            warp_utils::reject::custom_server_error(format!(


Perhaps this should be a 404 "not found" rather than a 500 "internal server error"?

Good catch. Updated, thanks!

paulhauner

Very nice, I used this a couple of days ago to produce a signed exit on Prater! It worked really well. I've just made a couple of very minor suggestions based on my experience.

Happy to merge this after they've been addressed!

paulhauner · 2023-03-30T07:57:12Z

validator_client/src/http_api/create_signed_voluntary_exit.rs

+        .validator_index(&pubkey_bytes)
+        .ok_or_else(|| {
+            warp_utils::reject::custom_not_found(format!(
+                "Unable to find validator with public key: {}",


I was using this endpoint on Goerli on a VC with 5,000 validators on it (a pretty unreasonable amount of validators, I know). It turns out that it takes some time to obtain all the validator indices for all pubkeys when the VCs starts (on a fresh boot the VC only knows pubkeys but doesn't know validator indices). I was hitting this 404 and it took me a bit to figure out what was going on.

Here's a suggestion you're free to cherry-pick which would clarify things:

b1a1cbf

Hey @paulhauner, thanks for this, nice changes! 👍 I've cherry-picked your changes. I wasn't aware that the validator indices were fetched / available later - good to know!

validator_client/src/http_api/create_signed_voluntary_exit.rs

Co-authored-by: Paul Hauner <[email protected]>

paulhauner

Excellent, let's do it!

paulhauner · 2023-04-03T03:02:40Z

bors r+

## Issue Addressed Addresses #4117 ## Proposed Changes See ethereum/keymanager-APIs#58 for proposed API specification. ## TODO - [x] ~~Add submission to BN~~ - removed, see discussion in [keymanager API](ethereum/keymanager-APIs#58) - [x] ~~Add flag to allow voluntary exit via the API~~ - no longer needed now the VC doesn't submit exit directly - [x] ~~Additional verification / checks, e.g. if validator on same network as BN~~ - to be done on client side - [x] ~~Potentially wait for the message to propagate and return some exit information in the response~~ - not required - [x] Update http tests - [x] ~~Update lighthouse book~~ - not required if this endpoint makes it to the standard keymanager API Co-authored-by: Paul Hauner <[email protected]> Co-authored-by: Jimmy Chen <[email protected]>

bors · 2023-04-03T05:35:00Z

Pull request successfully merged into unstable.

Build succeeded:

## Issue Addressed Addresses sigp#4117 ## Proposed Changes See ethereum/keymanager-APIs#58 for proposed API specification. ## TODO - [x] ~~Add submission to BN~~ - removed, see discussion in [keymanager API](ethereum/keymanager-APIs#58) - [x] ~~Add flag to allow voluntary exit via the API~~ - no longer needed now the VC doesn't submit exit directly - [x] ~~Additional verification / checks, e.g. if validator on same network as BN~~ - to be done on client side - [x] ~~Potentially wait for the message to propagate and return some exit information in the response~~ - not required - [x] Update http tests - [x] ~~Update lighthouse book~~ - not required if this endpoint makes it to the standard keymanager API Co-authored-by: Paul Hauner <[email protected]> Co-authored-by: Jimmy Chen <[email protected]>

Add validator exit endpoint to validator API

8b39d21

jimmygchen changed the base branch from stable to unstable March 22, 2023 05:36

jimmygchen requested a review from AgeManning March 22, 2023 06:25

jimmygchen self-assigned this Mar 22, 2023

jimmygchen removed the request for review from AgeManning March 22, 2023 10:30

jimmygchen added 2 commits March 22, 2023 22:39

Update exit validator endpoint to return SignedVoluntaryExit instead …

9ad2519

…of submitting to BN

Add http test for validator voluntary exit api

53529a2

jimmygchen added work-in-progress PR is a work-in-progress HTTP-API labels Mar 22, 2023

Rename file and fix test

3a6fe18

Add VC voluntary exit endpoint to Lighthouse book.

f053edd

jimmygchen marked this pull request as ready for review March 23, 2023 06:13

jimmygchen added 4 commits March 24, 2023 15:58

Revert back to submitting exit to Beacon API

b204dea

Update exit endpoint to latest proposed spec

ef64b7f

Update VC exit endpoint: remove confirm param, make epoch mandatory a…

63898d3

…nd return SignedVoluntaryExit object

Remove exit endpoint from LH book

f05fa5b

jimmygchen added ready-for-review The code is ready for review and removed work-in-progress PR is a work-in-progress labels Mar 28, 2023

jimmygchen added 3 commits March 28, 2023 22:46

Rename file only

e1cddc9

Renamed function and file

37adc18

Make Epoch optional again, default to current if not set.

f621c3e

paulhauner reviewed Mar 29, 2023

View reviewed changes

jimmygchen added 2 commits March 29, 2023 15:04

Return 404 when validator is not found

abf58bb

Improve validator exit test

709131e

jimmygchen requested a review from paulhauner March 29, 2023 05:41

paulhauner reviewed Mar 31, 2023

View reviewed changes

paulhauner added waiting-on-author The reviewer has suggested changes and awaits thier implementation. and removed ready-for-review The code is ready for review labels Mar 31, 2023

paulhauner and others added 2 commits April 3, 2023 11:43

Add more detail for 404s

6edcfe3

Improve logs when signing voluntary exits

9e8a17d

Co-authored-by: Paul Hauner <[email protected]>

jimmygchen requested a review from paulhauner April 3, 2023 01:52

jimmygchen added ready-for-review The code is ready for review and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels Apr 3, 2023

paulhauner approved these changes Apr 3, 2023

View reviewed changes

paulhauner added ready-for-merge This PR is ready to merge. and removed ready-for-review The code is ready for review labels Apr 3, 2023

bors bot changed the title ~~Add new validator API for voluntary exit~~ [Merged by Bors] - Add new validator API for voluntary exit Apr 3, 2023

bors bot closed this Apr 3, 2023

jimmygchen deleted the validator-exit-api branch April 4, 2023 06:29

This was referenced Apr 4, 2023

Add new validator API for voluntary exit #4117

Closed

Enable withdrawals sigp/siren#148

Open

alex-miller-0 mentioned this pull request Apr 20, 2023

Feature Request: Sign voluntary exit without broadcast #4205

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Add new validator API for voluntary exit #4119

[Merged by Bors] - Add new validator API for voluntary exit #4119

jimmygchen commented Mar 22, 2023 •

edited

Loading

jimmygchen commented Mar 22, 2023 •

edited

Loading

jimmygchen commented Mar 22, 2023

AgeManning commented Mar 22, 2023

jimmygchen commented Mar 24, 2023

jimmygchen commented Mar 24, 2023

paulhauner Mar 29, 2023

jimmygchen Mar 29, 2023

paulhauner left a comment

paulhauner Mar 30, 2023

jimmygchen Apr 3, 2023

paulhauner left a comment

paulhauner commented Apr 3, 2023

bors bot commented Apr 3, 2023

[Merged by Bors] - Add new validator API for voluntary exit #4119

[Merged by Bors] - Add new validator API for voluntary exit #4119

Conversation

jimmygchen commented Mar 22, 2023 • edited Loading

Issue Addressed

Proposed Changes

TODO

jimmygchen commented Mar 22, 2023 • edited Loading

jimmygchen commented Mar 22, 2023

AgeManning commented Mar 22, 2023

jimmygchen commented Mar 24, 2023

jimmygchen commented Mar 24, 2023

paulhauner Mar 29, 2023

Choose a reason for hiding this comment

jimmygchen Mar 29, 2023

Choose a reason for hiding this comment

paulhauner left a comment

Choose a reason for hiding this comment

paulhauner Mar 30, 2023

Choose a reason for hiding this comment

jimmygchen Apr 3, 2023

Choose a reason for hiding this comment

paulhauner left a comment

Choose a reason for hiding this comment

paulhauner commented Apr 3, 2023

bors bot commented Apr 3, 2023

jimmygchen commented Mar 22, 2023 •

edited

Loading

jimmygchen commented Mar 22, 2023 •

edited

Loading