Keymanager APIs - get,post,delete graffiti #13474
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
saolyn
reviewed
Jan 18, 2024
rkapka
requested changes
Jan 22, 2024
validator/accounts/testing/mock.go
Outdated
| @@ -90,6 +91,7 @@ func (_ *Wallet) InitializeKeymanager(_ context.Context, _ iface.InitKeymanagerC | |||
| type Validator struct { | |||
| Km keymanager.IKeymanager | |||
| proposerSettings *validatorserviceconfig.ProposerSettings | |||
| Graffiti string | |||
There was a problem hiding this comment.
The field should not be exported because we have a setter.
validator/accounts/testing/mock.go
Outdated
Comment on lines
220
to
222
| if m.Graffiti == "" { | ||
| return nil, errors.New("graffiti is missing ") | ||
| } |
There was a problem hiding this comment.
Why would not having a graffiti produce an error?
There was a problem hiding this comment.
was just for the mock, but i'll think of a better way to represent
| @@ -429,3 +446,34 @@ func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubk | |||
|
|
|||
| return []byte{}, nil | |||
| } | |||
|
|
|||
| func (v *validator) SetGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte, graffiti []byte) error { | |||
| if v.proposerSettings != nil { | |||
There was a problem hiding this comment.
We usually handle error conditions first. I would rewrite the code as
if v.proposerSettings == nil {
// error
}
if v.proposerSettings.ProposeConfig == nil {
// error
}
ps := v.proposerSettings.Clone()
There was a problem hiding this comment.
oops yeah i should do it this way
validator/client/propose.go
Outdated
| } | ||
|
|
||
| func (v *validator) DeleteGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) error { | ||
| if v.proposerSettings != nil { |
| @@ -55,6 +55,7 @@ type FakeValidator struct { | |||
| proposerSettings *validatorserviceconfig.ProposerSettings | |||
| ProposerSettingWait time.Duration | |||
| Km keymanager.IKeymanager | |||
| Graffiti string | |||
Co-authored-by: Radosław Kapka <[email protected]>
Co-authored-by: Radosław Kapka <[email protected]>
nalepae
reviewed
Mar 12, 2024
nalepae
reviewed
Mar 12, 2024
validator/client/propose.go
Outdated
| return v.SetProposerSettings(ctx, settings) | ||
| } | ||
| ps := settings.Clone() | ||
| var option *proposer.Option |
validator/client/propose.go
Outdated
| option.GraffitiConfig = &proposer.GraffitiConfig{ | ||
| Graffiti: string(graffiti), | ||
| } | ||
| ps.ProposeConfig[pubkey] = option |
There was a problem hiding this comment.
Removing this line does not break any test.
validator/node/node.go
Outdated
| @@ -264,6 +264,7 @@ func (c *ValidatorClient) initializeFromCLI(cliCtx *cli.Context, router *mux.Rou | |||
| if isWeb3SignerURLFlagSet { | |||
| c.wallet = wallet.NewWalletForWeb3Signer() | |||
| } else { | |||
| fmt.Println("initializeFromCLI asking for wallet") | |||
There was a problem hiding this comment.
that's a mistake from debugging , should remove
Co-authored-by: Manu NALEPA <[email protected]>
nalepae
previously approved these changes
Mar 13, 2024
rkapka
approved these changes
Mar 18, 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.
What type of PR is this?
Feature
What does this PR do? Why is it needed?
https://ethereum.github.io/keymanager-APIs/?urls.primaryName=dev#/Graffiti
this PR introduces the graffiti keymanager API endpoints ( GET,POST,DELETE ). The approach taken here is adding graffiti to the proposer settings to persist. This also means that only the proposer settings will be saved, if a graffiti is passed via flag it will continue even if the keymanager API is called to delete. That being said the proposer settings now take priority and you will be able to see that in the
GetGraffitifunction.tests
curl -X POST "http://localhost:7500/eth/v1/validator/0x82f4fca8aacccd676beebda99d662d2e346adcd4f89acb142671f30ded77dda64fc760ef8ed6e62b7bf8cb53dc285778/graffiti" -H "Content-Type: application/json" -d '{"graffiti":"plain text here"}' -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.1cIoNTAywQNDzFT4_f285omZXuzvSnxLozjtDKxqx-E"
curl -X GET "http://localhost:7500/eth/v1/validator/0x82f4fca8aacccd676beebda99d662d2e346adcd4f89acb142671f30ded77dda64fc760ef8ed6e62b7bf8cb53dc285778/graffiti" -H "accept: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.1cIoNTAywQNDzFT4_f285omZXuzvSnxLozjtDKxqx-E"
{"data":{"pubkey":"0x82f4fca8aacccd676beebda99d662d2e346adcd4f89acb142671f30ded77dda64fc760ef8ed6e62b7bf8cb53dc285778","graffiti":"plain text here"}}
Which issues(s) does this PR fix?
Fixes #13188
Other notes for review