Web3Signer: Object Mapper and Types

validator/keymanager/remote-web3signer/BUILD.bazel

@@ -17,6 +17,7 @@ go_library(
         "//crypto/bls:go_default_library",
         "//encoding/bytesutil:go_default_library",
         "//proto/prysm/v1alpha1/validator-client:go_default_library",
+        "//validator/keymanager/remote-web3signer/v1:go_default_library",
         "@com_github_ethereum_go_ethereum//common/hexutil:go_default_library",
         "@com_github_pkg_errors//:go_default_library",
         "@com_github_sirupsen_logrus//:go_default_library",
@@ -35,6 +36,7 @@ go_test(
         "//encoding/bytesutil:go_default_library",
         "//proto/prysm/v1alpha1:go_default_library",
         "//proto/prysm/v1alpha1/validator-client:go_default_library",
+        "//validator/keymanager/remote-web3signer/v1:go_default_library",
         "@com_github_ethereum_go_ethereum//common/hexutil:go_default_library",
         "@com_github_stretchr_testify//assert:go_default_library",
     ],

validator/keymanager/remote-web3signer/README.md

@@ -0,0 +1,56 @@
+# Web3Signer
+
+Web3Signer is a popular remote signer tool by Consensys to allow users to store validation keys outside the validation
+client and signed without the vc knowing the private keys. Web3Signer Specs are found by
+searching `Consensys' Web3Signer API specification`
+
+issue: https://github.com/prysmaticlabs/prysm/issues/9994
+
+## Support
+
+WIP
+
+## Features
+
+### CLI
+
+WIP
+
+### API
+
+- Get Public keys: returns all public keys currently stored with web3signer excluding newly added keys if reload keys
+  was not run.
+- Sign: Signs a message with a given public key. There are several types of messages that can be signed ( web3signer
+  type to prysm type):
+    - BLOCK <- *validatorpb.SignRequest_Block
+    - ATTESTATION <- *validatorpb.SignRequest_AttestationData
+    - AGGREGATE_AND_PROOF <- *validatorpb.SignRequest_AggregateAttestationAndProof
+    - AGGREGATION_SLOT <- *validatorpb.SignRequest_Slot
+    - BLOCK_V2 <- *validatorpb.SignRequest_BlockV2
+    - BLOCK_V3 <- *validatorpb.SignRequest_BlockV3
+    - DEPOSIT <- not supported
+    - RANDAO_REVEAL <- *validatorpb.SignRequest_Epoch
+    - VOLUNTARY_EXIT <- *validatorpb.SignRequest_Exit
+    - SYNC_COMMITTEE_MESSAGE <- *validatorpb.SignRequest_SyncMessageBlockRoot
+    - SYNC_COMMITTEE_SELECTION_PROOF <- *validatorpb.SignRequest_SyncAggregatorSelectionData
+    - SYNC_COMMITTEE_CONTRIBUTION_AND_PROOF <- *validatorpb.SignRequest_ContributionAndProof
+- Reload Keys: reloads all public keys from the web3signer.
+- Get Server Status: returns OK if the web3signer is ok.
+
+## Files Added and Files Changed
+
+- Files Added:
+    - validator/keymanager/remote-web3signer package
+
+- Files Modified:
+    - modified:   cmd/validator/flags/flags.go
+    - modified:   validator/accounts/accounts_backup.go
+    - modified:   validator/accounts/accounts_list.go
+    - modified:   validator/accounts/iface/wallet.go
+    - modified:   validator/accounts/userprompt/prompt.go
+    - modified:   validator/accounts/wallet/wallet.go
+    - modified:   validator/accounts/wallet_create.go
+    - modified:   validator/client/runner.go
+    - modified:   validator/client/validator.go
+    - modified:   validator/keymanager/remote-web3signer/keymanager.go
+    - modified:   validator/keymanager/types.go

validator/keymanager/remote-web3signer/client.go

@@ -14,6 +14,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/prysmaticlabs/prysm/crypto/bls"
 	"github.com/prysmaticlabs/prysm/encoding/bytesutil"
+	v1 "github.com/prysmaticlabs/prysm/validator/keymanager/remote-web3signer/v1"
 )
 
 const (
@@ -47,35 +48,11 @@ func newApiClient(baseEndpoint string) (*apiClient, error) {
 	}, nil
 }
 
-// SignRequest is a request object for web3signer sign api.
 type SignRequest struct {
-	Type            string           `json:"type"`
-	ForkInfo        *ForkInfo        `json:"fork_info"`
-	SigningRoot     string           `json:"signingRoot"`
-	AggregationSlot *AggregationSlot `json:"aggregation_slot"`
-}
-
-// ForkInfo a sub property object of the Sign request,in the future before bellatrix to remove the need to send the entire block body and just use the block_body_root.
-type ForkInfo struct {
-	Fork                  *Fork  `json:"fork"`
-	GenesisValidatorsRoot string `json:"genesis_validators_root"`
-}
-
-// Fork a sub property of ForkInfo.
-type Fork struct {
-	PreviousVersion string `json:"previous_version"`
-	CurrentVersion  string `json:"current_version"`
-	Epoch           string `json:"epoch"`
-}
-
-// AggregationSlot a sub property of SignRequest.
-type AggregationSlot struct {
-	Slot string `json:"slot"`
-}
-
-// signResponse the response object of the web3signer sign api.
-type signResponse struct {
-	Signature string `json:"signature"`
+	Type            string              `json:"type"`
+	ForkInfo        *v1.ForkInfo        `json:"fork_info"`
+	SigningRoot     string              `json:"signingRoot"`
+	AggregationSlot *v1.AggregationSlot `json:"aggregation_slot"`
 }
 
 // Sign is a wrapper method around the web3signer sign api.
@@ -95,7 +72,7 @@ func (client *apiClient) Sign(_ context.Context, pubKey string, request *SignReq
 	if resp.StatusCode == 412 {
 		return nil, errors.Wrap(err, "signing operation failed due to slashing protection rules")
 	}
-	signResp := &signResponse{}
+	signResp := &v1.SignResponse{}
 	if err := client.unmarshalResponse(resp.Body, &signResp); err != nil {
 		return nil, err
 	}

validator/keymanager/remote-web3signer/client_test.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"testing"
 
+	v1 "github.com/prysmaticlabs/prysm/validator/keymanager/remote-web3signer/v1"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -22,17 +23,17 @@ func (m *mockTransport) RoundTrip(*http.Request) (*http.Response, error) {
 }
 
 func getClientMockSignRequest() *SignRequest {
-	forkData := &Fork{
+	forkData := &v1.Fork{
 		PreviousVersion: "",
 		CurrentVersion:  "",
 		Epoch:           "",
 	}
-	forkInfoData := &ForkInfo{
+	forkInfoData := &v1.ForkInfo{
 		Fork:                  forkData,
 		GenesisValidatorsRoot: "",
 	}
 
-	AggregationSlotData := &AggregationSlot{Slot: ""}
+	AggregationSlotData := &v1.AggregationSlot{Slot: ""}
 	// remember to replace signing root with hex encoding remove 0x
 	web3SignerRequest := SignRequest{
 		Type:            "foo",

validator/keymanager/remote-web3signer/keymanager.go

@@ -9,6 +9,7 @@ import (
 	"github.com/prysmaticlabs/prysm/async/event"
 	"github.com/prysmaticlabs/prysm/crypto/bls"
 	validatorpb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1/validator-client"
+	v1 "github.com/prysmaticlabs/prysm/validator/keymanager/remote-web3signer/v1"
 )
 
 // SetupConfig includes configuration values for initializing.
@@ -85,16 +86,16 @@ func (km *Keymanager) Sign(ctx context.Context, request *validatorpb.SignRequest
 		return nil, err
 	}
 
-	forkData := &Fork{
+	forkData := &v1.Fork{
 		PreviousVersion: hexutil.Encode(request.Fork.PreviousVersion),
 		CurrentVersion:  hexutil.Encode(request.Fork.CurrentVersion),
 		Epoch:           fmt.Sprint(request.Fork.Epoch),
 	}
-	forkInfoData := &ForkInfo{
+	forkInfoData := &v1.ForkInfo{
 		Fork:                  forkData,
 		GenesisValidatorsRoot: hexutil.Encode(km.genesisValidatorsRoot),
 	}
-	aggregationSlotData := &AggregationSlot{Slot: fmt.Sprint(request.AggregationSlot)}
+	aggregationSlotData := &v1.AggregationSlot{Slot: fmt.Sprint(request.AggregationSlot)}
 	web3SignerRequest := SignRequest{
 		Type:            signRequestType,
 		ForkInfo:        forkInfoData,

validator/keymanager/remote-web3signer/v1/BUILD.bazel

@@ -0,0 +1,32 @@
+load("@prysm//tools/go:def.bzl", "go_library", "go_test")
+
+go_library(
+    name = "go_default_library",
+    srcs = [
+        "custom_mappers.go",
+        "mocks.go",
+        "web3signer_types.go",
+    ],
+    importpath = "github.com/prysmaticlabs/prysm/validator/keymanager/remote-web3signer/v1",
+    visibility = ["//visibility:public"],
+    deps = [
+        "//config/fieldparams:go_default_library",
+        "//proto/prysm/v1alpha1:go_default_library",
+        "@com_github_ethereum_go_ethereum//common/hexutil:go_default_library",
+        "@com_github_pkg_errors//:go_default_library",
+        "@com_github_prysmaticlabs_go_bitfield//:go_default_library",
+    ],
+)
+
+go_test(
+    name = "go_default_test",
+    srcs = ["custom_mappers_test.go"],
+    embed = [":go_default_library"],
+    deps = [
+        "//config/fieldparams:go_default_library",
+        "//proto/prysm/v1alpha1:go_default_library",
+        "//testing/util:go_default_library",
+        "@com_github_ethereum_go_ethereum//common/hexutil:go_default_library",
+        "@com_github_prysmaticlabs_go_bitfield//:go_default_library",
+    ],
+)