cmd: add exit commands #2934

gsora · 2024-03-03T01:49:14Z

This PR adds exit-related commands under the exit subcommand:

submit-partial-exit, which signs and submit to an instance of Obol API a partial exit for a given DV in a given cluster lock
broadcast, which downloads a full exit from an instance of Obol API for a given validator if available, and broadcasts it to the configured beacon node
active-validator-list, which returns the list of validators which are ACTIVE_ONGOING contained in the specified cluster lock (useful for scripting).

Moved obolapi mock implementation to testutil/obolapimock so other tests can use it.

Added a few utility functions in eth2util/keystore, taken from lido-dv-exit: since it depends on Charon, we can migrate them.

category: feature
ticket: #2848

Closes #2848.

This PR adds exit-related commands under the `exit` subcommand: - `submit-partial-exit`, which signs and submit to an instance of Obol API a partial exit for a given DV in a given cluster lock - `broadcast`, which downloads a full exit from an instance of Obol API for a given validator if available, and broadcasts it to the configured beacon node - `active-validator-list`, which returns the list of validators which are `ACTIVE_ONGOING` contained in the specified cluster lock (useful for scripting). Moved `obolapi` mock implementation to `testutil/obolapimock` so other tests can use it. Added a few utility functions in `eth2util/keystore`, taken from `lido-dv-exit`: since it depends on Charon, we can migrate them.

codecov · 2024-03-03T01:52:59Z

Codecov Report

Attention: Patch coverage is 44.21642% with 299 lines in your changes are missing coverage. Please review.

Project coverage is 53.96%. Comparing base (aa8a82e) to head (05d252d).
Report is 4 commits behind head on main.

❗ Current head 05d252d differs from pull request most recent head c101faa. Consider uploading reports for the commit c101faa to get more accurate results

Files	Patch %	Lines
cmd/exit.go	28.86%	64 Missing and 5 partials ⚠️
cmd/exit_broadcast.go	50.00%	49 Missing and 9 partials ⚠️
cmd/exit_fetch.go	32.50%	45 Missing and 9 partials ⚠️
cmd/exit_sign.go	52.21%	46 Missing and 8 partials ⚠️
cmd/exit_list.go	41.17%	36 Missing and 4 partials ⚠️
eth2util/keystore/keystore.go	67.85%	12 Missing and 6 partials ⚠️
cmd/cmd.go	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2934      +/-   ##
==========================================
- Coverage   54.16%   53.96%   -0.21%     
==========================================
  Files         195      200       +5     
  Lines       27564    28100     +536     
==========================================
+ Hits        14930    15164     +234     
- Misses      10876    11134     +258     
- Partials     1758     1802      +44

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…IWPUMIH4odoHtO0PhnHcP3EjMuAVhwU0/edit

…and enr privkey paths

need to adapt `broadcast` to read from a static file

cmd/exit.go

cmd/exit_list.go

cmd/exit_fullexit_internal_test.go

cmd/exit_list.go

cmd/exit_submitpartial.go

cmd/exit_fullexit.go

cmd/exit_fullexit_internal_test.go

OisinKyne

Not all suggestions are musts. There might be some slight contradictions between them, use best judgement :)

cmd/exit_fetch.go

OisinKyne · 2024-03-29T17:49:44Z

cmd/exit_list.go

+	"github.com/obolnetwork/charon/app/z"
+)
+
+func newListActiveValidatorsCmd(runFunc func(context.Context, exitConfig) error) *cobra.Command {


Should we consider not adding this if we intend to remove (move) it under the get command?

I'd rather have it here for now, ops and support requested such function for a while now.

cmd/exit_sign.go

cmd/exit.go

cmd/exit_broadcast.go

cmd/exit_sign.go

OisinKyne · 2024-03-29T18:59:48Z

eth2util/keystore/keystore.go

@@ -225,3 +240,86 @@ func checkDir(dir string) error {

 	return nil
 }
+
+// KeysharesToValidatorPubkey maps each share in cl to the associated validator private key.
+// It returns an error if a keyshare does not appear in cl, or if there's a validator public key associated to no


Suggested change

// It returns an error if a keyshare does not appear in cl, or if there's a validator public key associated to no

// It returns an error if a keyshare does not appear in cl, or if there's a validator public key associated to no

Will we get pushback if charon needs all partials private keys returned to it, to broadcast the exit of a subset of them? This looks like it needs the full clusters worth to work? Whereas technically a user might bring back only the online keys to a charon command to sign exits for?

Hmm not really, this function maps a partial key share to its full validator pubkey by looking into the cluster lock, not by doing aggregation or any operation with the private key.

eth2util/keystore/keystore.go

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

sonarcloud · 2024-04-03T09:13:53Z

Quality Gate passed

Issues
21 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
24.7% Duplication on New Code

See analysis details on SonarCloud

gsora · 2024-04-03T09:14:09Z

Seems to me we fixed all wording issues and the code looks okay.

Merging! 🎉

dB2510 approved these changes Mar 4, 2024

View reviewed changes

pinebit approved these changes Mar 4, 2024

View reviewed changes

xenowits approved these changes Mar 5, 2024

View reviewed changes

gsora and others added 6 commits March 11, 2024 11:32

address comments from https://docs.google.com/document/d/140kknAtq2MW…

ce6efde

…IWPUMIH4odoHtO0PhnHcP3EjMuAVhwU0/edit

Merge branch 'main' into gsora/exitcmd-submit-partial-exit

c629f12

refactor to allow individually specifying cluster lock, validar_keys …

8b64f3a

…and enr privkey paths

refactor exit submit cmd to "sign"

b2368c7

add "exit fetch" command

eae226b

need to adapt `broadcast` to read from a static file

wire broadcast to read from file, if specified

8c0eb8e

pinebit approved these changes Mar 26, 2024

View reviewed changes

gsora requested a review from KaloyanTanev March 26, 2024 10:55

OisinKyne reviewed Mar 26, 2024

View reviewed changes

address review comments

a02c49c

OisinKyne approved these changes Mar 29, 2024

View reviewed changes

gsora and others added 8 commits April 3, 2024 10:57

Update exit_fetch.go

b983026

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit_fetch.go

7388a71

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit.go

fac09a5

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit.go

31e599d

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit_sign.go

83422ad

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit_broadcast.go

ddcf018

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update exit_sign.go

05d252d

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

Update keystore.go

c101faa

Co-authored-by: Oisín Kyne <4981644+OisinKyne@users.noreply.github.com>

gsora added the merge when ready Indicates bulldozer bot may merge when all checks pass label Apr 3, 2024

obol-bulldozer bot merged commit 2d662f0 into main Apr 3, 2024
11 checks passed

obol-bulldozer bot deleted the gsora/exitcmd-submit-partial-exit branch April 3, 2024 09:17

gsora mentioned this pull request Apr 10, 2024

Document exit commands ObolNetwork/obol-docs#349

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd: add exit commands #2934

cmd: add exit commands #2934

gsora commented Mar 3, 2024

codecov bot commented Mar 3, 2024 •

edited

Loading

OisinKyne left a comment

OisinKyne Mar 29, 2024

gsora Apr 3, 2024

OisinKyne Mar 29, 2024

gsora Apr 3, 2024

sonarcloud bot commented Apr 3, 2024

gsora commented Apr 3, 2024

	// It returns an error if a keyshare does not appear in cl, or if there's a validator public key associated to no
	// It returns an error if a keyshare does not appear in cl, or if there's a validator public key associated to no

cmd: add exit commands #2934

cmd: add exit commands #2934

Conversation

gsora commented Mar 3, 2024

codecov bot commented Mar 3, 2024 • edited Loading

Codecov Report

OisinKyne left a comment

Choose a reason for hiding this comment

OisinKyne Mar 29, 2024

Choose a reason for hiding this comment

gsora Apr 3, 2024

Choose a reason for hiding this comment

OisinKyne Mar 29, 2024

Choose a reason for hiding this comment

gsora Apr 3, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Apr 3, 2024

Quality Gate passed

gsora commented Apr 3, 2024

codecov bot commented Mar 3, 2024 •

edited

Loading