prysmctl: output proposer settings #12181

james-prysm · 2023-03-23T20:25:16Z

What type of PR is this?

Feature

What does this PR do? Why is it needed?

introduces a new command under prysmctl to query the validator client against the keymanagerAPIs and get the proposer settings ( namely the fee recipient) registered on the validator client. optionally you can output a proposer settings file which would be useful for webui migrations.

prysm currently requires --web flag against the validator client to enable its apis, in this process of startup an oauth token is created which is used in the --token flag below.

example command line:

prysmctl validator proposer-settings --validator-client-host=http://127.0.0.1:7500 --token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.VXjrSItV_Kmwg_XilpscyPm2SPIsstytYLtr_AuJI8I --settings-path=./settings.json

example of a successful run:

time="2023-03-23T20:51:07-05:00" level=info msg="===============DISPLAYING CURRENT PROPOSER SETTINGS==============="
time="2023-03-23T20:51:07-05:00" level=info msg="validator: 0x855ae9c6184d6edd46351b375f16f541b2d33b0ed0da9be4571b13938588aee840ba606a946f0e8023ae3a4b2a43b4d4. fee-recipient: 0xb698D697092822185bF0311052215d5B5e1F3944"
time="2023-03-23T20:51:07-05:00" level=info msg="validator: 0x844ae9c6184d6edd46351b375f16f541b2d33b0ed0da9be4571b13938588aee840ba606a946f0e8023ae3a4b2a43b4d4. fee-recipient: 0xb698D697092822185bF0311052215d5B5e1F3944"
time="2023-03-23T20:51:07-05:00" level=info msg="the default fee recipient is set to 0xb698D697092822185bF0311052215d5B5e1F3944"
time="2023-03-23T20:51:07-05:00" level=info msg="successfully created `./testdata/settings.json`. settings can be imported into validator client using --proposer-settings-file flag. does not include custom builder settings."

kasey · 2023-04-18T21:42:18Z

api/client/beacon/client.go

-}
-
-// Client provides a collection of helper methods for calling the Eth Beacon Node API endpoints.
-type Client struct {


This is already namespaced by its package. Renaming it to BeaconClient is not necessary and causes the package + type name to stutter.

api/client/options.go

rkapka

validateIsExecutionAddress has a bug

rkapka · 2023-06-02T14:50:02Z

api/client/client.go

+	"github.com/pkg/errors"
+)
+
+// Client provides a collection of helper methods for calling the Eth Beacon Node API endpoints.


This is more generic and can be used outside of Beacon API. I would describe this type as an HTTP wrapper.

api/client/errors.go

rkapka · 2023-06-02T14:54:51Z

api/client/errors.go

+	"github.com/pkg/errors"
+)
+
+// ErrMalformedHostname is used to indicate if a host name's format is incorrect while providing the port.


This sentence is unclear to me. Wouldn't ErrMalformedHostname is used to indicate if a host name's format is incorrect be enough?

api/client/options.go

cmd/prysmctl/validator/proposer_settings.go

rkapka · 2023-06-02T15:16:35Z

cmd/prysmctl/validator/proposer_settings.go

+	return nil
+}
+
+func validateIsExecutionAddress(input string) error {


This function is incorrect because 0xpppp... with the correct length will pass. You should use bytesutil.IsHex + the length check. It would be nice to add some unit tests too.

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

rkapka · 2023-06-06T16:28:15Z

cmd/prysmctl/validator/error.go

+import "fmt"
+
+// ErrNoFlag takes a flag name and returns a formatted error representing no flag was provided.
+func ErrNoFlag(flagName string) error {


I think it can be unexported

rkapka · 2023-06-06T16:28:34Z

cmd/prysmctl/validator/proposer_settings.go

+	return nil
+}
+
+func ValidateIsExecutionAddress(input string) error {


I think it can be unexported.

* wip proposer settings * WIP validator client APIs * adding proposer settings output * adding unit tests * fixing linting * fixing deepsource issues * fixing e2e * fixing deep source issue * updating naming to not stutter * updating bazel * fixing linting error * reverting comment * adding builder settings * gaz * Update validator/client/validator.go Co-authored-by: Sammy Rosso <15244892+saolyn@users.noreply.github.com> * adding comments * adding some tests * gaz * Update cmd/prysmctl/validator/proposer_settings.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/prysmctl/validator/proposer_settings.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/prysmctl/validator/proposer_settings.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/prysmctl/validator/proposer_settings.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/options.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/options.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/errors.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/options.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/options.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/validator/client.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/prysmctl/validator/cmd.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/validator/client.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/validator/client.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update cmd/prysmctl/validator/proposer_settings.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * Update api/client/errors.go Co-authored-by: Radosław Kapka <rkapka@wp.pl> * fixing feedback * fixing unit test * addressign comments --------- Co-authored-by: Sammy Rosso <15244892+saolyn@users.noreply.github.com> Co-authored-by: Radosław Kapka <rkapka@wp.pl>

james-prysm and others added 7 commits March 16, 2023 15:29

wip proposer settings

5572dab

Merge branch 'develop' into prysmctl-proposer-settings

03e7368

WIP validator client APIs

249c1a0

adding proposer settings output

a1e05a8

Merge branch 'develop' into prysmctl-proposer-settings

8a42066

adding unit tests

4cf0b94

fixing linting

8e3af0c

james-prysm marked this pull request as ready for review March 24, 2023 02:08

james-prysm requested a review from a team as a code owner March 24, 2023 02:08

james-prysm requested review from kasey, terencechain and rkapka March 24, 2023 02:08

james-prysm and others added 4 commits March 24, 2023 09:11

Merge branch 'develop' into prysmctl-proposer-settings

e6562a0

fixing deepsource issues

509c940

fixing e2e

5267781

Merge branch 'develop' into prysmctl-proposer-settings

222e6dd

james-prysm requested a review from potuz March 27, 2023 16:17

james-prysm and others added 3 commits March 30, 2023 10:00

Merge branch 'develop' into prysmctl-proposer-settings

953bb34

Merge branch 'develop' into prysmctl-proposer-settings

2b53d4b

fixing deep source issue

df44ccb

james-prysm dismissed a stale review via df44ccb April 17, 2023 22:10

Merge branch 'develop' into prysmctl-proposer-settings

f898c8c

james-prysm requested a review from rauljordan April 18, 2023 20:30

Merge branch 'develop' into prysmctl-proposer-settings

dadbad2

kasey reviewed Apr 18, 2023

View reviewed changes

james-prysm and others added 2 commits April 18, 2023 18:25

updating naming to not stutter

d7ac19c

Merge branch 'develop' into prysmctl-proposer-settings

483312a

kasey reviewed Apr 18, 2023

View reviewed changes

api/client/options.go Outdated Show resolved Hide resolved

kasey reviewed Apr 18, 2023

View reviewed changes

api/client/options.go Outdated Show resolved Hide resolved

kasey reviewed Apr 18, 2023

View reviewed changes

api/client/options.go Outdated Show resolved Hide resolved

Merge branch 'develop' into prysmctl-proposer-settings

18abc11

rkapka requested changes Jun 2, 2023

View reviewed changes

james-prysm and others added 2 commits June 5, 2023 13:00

Merge branch 'develop' into prysmctl-proposer-settings

356360a

Update cmd/prysmctl/validator/proposer_settings.go

68477ac

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

james-prysm dismissed saolyn’s stale review via 68477ac June 5, 2023 18:01

james-prysm and others added 17 commits June 5, 2023 13:01

Update cmd/prysmctl/validator/proposer_settings.go

c534bef

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update cmd/prysmctl/validator/proposer_settings.go

2c27eb7

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update cmd/prysmctl/validator/proposer_settings.go

2dd3917

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/options.go

1ed0b24

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/options.go

4bad08e

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/errors.go

5a66a95

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/options.go

1200543

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/options.go

98be85d

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/validator/client.go

5da0805

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update cmd/prysmctl/validator/cmd.go

ed9590d

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/validator/client.go

531a412

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/validator/client.go

39ddf35

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update cmd/prysmctl/validator/proposer_settings.go

7553b02

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Update api/client/errors.go

c054561

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

fixing feedback

802ae59

fixing unit test

46c73c3

Merge branch 'develop' into prysmctl-proposer-settings

73ac102

rkapka reviewed Jun 6, 2023

View reviewed changes

addressign comments

d0ee80e

rkapka approved these changes Jun 6, 2023

View reviewed changes

james-prysm added OK to merge prysmctl labels Jun 6, 2023

prylabs-bulldozer bot merged commit 6672d14 into develop Jun 6, 2023
15 of 16 checks passed

prylabs-bulldozer bot deleted the prysmctl-proposer-settings branch June 6, 2023 17:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

prysmctl: output proposer settings #12181

prysmctl: output proposer settings #12181

james-prysm commented Mar 23, 2023 •

edited

Loading

kasey Apr 18, 2023

rkapka left a comment

rkapka Jun 2, 2023

rkapka Jun 2, 2023

rkapka Jun 2, 2023

rkapka Jun 6, 2023

rkapka Jun 6, 2023

prysmctl: output proposer settings #12181

prysmctl: output proposer settings #12181

Conversation

james-prysm commented Mar 23, 2023 • edited Loading

kasey Apr 18, 2023

Choose a reason for hiding this comment

rkapka left a comment

Choose a reason for hiding this comment

rkapka Jun 2, 2023

Choose a reason for hiding this comment

rkapka Jun 2, 2023

Choose a reason for hiding this comment

rkapka Jun 2, 2023

Choose a reason for hiding this comment

rkapka Jun 6, 2023

Choose a reason for hiding this comment

rkapka Jun 6, 2023

Choose a reason for hiding this comment

james-prysm commented Mar 23, 2023 •

edited

Loading