mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-26 21:27:19 +00:00
588dea83b7
* test coverage and updates to config twiddlers * LoadChainConfigFile error if SetActive conflicts * lint * wip working around test issues * more fixes, mass test updates * lint * linting * thanks deepsource! * fix undeclared vars * fixing more undefined * fix a bug, make a bug, repeat * gaz * use stock mainnet in case fork schedule matters * remove unused KnownConfigs * post-merge cleanup * eliminating OverrideBeaconConfig outside tests * more cleanup of OverrideBeaconConfig outside tests * config for interop w/ genesis gen support * improve var name * API on package instead of exported value * cleanup remainders of "registry" naming * Nishant feedback * add ropstein to configset * lint * lint #2 * ✂️ * revert accidental commented line * check if active is nil (replace called on empty) * Nishant feedback * replace OverrideBeaconConfig call * update interop instructions w/ new flag * don't let interop replace config set via cli flags Co-authored-by: kasey <kasey@users.noreply.github.com>
809 lines
28 KiB
Go
809 lines
28 KiB
Go
// Package node is the main process which handles the lifecycle of
|
|
// the runtime services in a validator client process, gracefully shutting
|
|
// everything down upon close.
|
|
package node
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"os/signal"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync"
|
|
"syscall"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
gwruntime "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
|
|
"github.com/pkg/errors"
|
|
"github.com/prysmaticlabs/prysm/api/gateway"
|
|
"github.com/prysmaticlabs/prysm/api/gateway/apimiddleware"
|
|
"github.com/prysmaticlabs/prysm/async/event"
|
|
"github.com/prysmaticlabs/prysm/cmd"
|
|
"github.com/prysmaticlabs/prysm/cmd/validator/flags"
|
|
"github.com/prysmaticlabs/prysm/config/features"
|
|
fieldparams "github.com/prysmaticlabs/prysm/config/fieldparams"
|
|
"github.com/prysmaticlabs/prysm/config/params"
|
|
validatorServiceConfig "github.com/prysmaticlabs/prysm/config/validator/service"
|
|
"github.com/prysmaticlabs/prysm/encoding/bytesutil"
|
|
"github.com/prysmaticlabs/prysm/io/file"
|
|
"github.com/prysmaticlabs/prysm/monitoring/backup"
|
|
"github.com/prysmaticlabs/prysm/monitoring/prometheus"
|
|
tracing2 "github.com/prysmaticlabs/prysm/monitoring/tracing"
|
|
ethpbservice "github.com/prysmaticlabs/prysm/proto/eth/service"
|
|
pb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1"
|
|
validatorpb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1/validator-client"
|
|
"github.com/prysmaticlabs/prysm/runtime"
|
|
"github.com/prysmaticlabs/prysm/runtime/debug"
|
|
"github.com/prysmaticlabs/prysm/runtime/prereqs"
|
|
"github.com/prysmaticlabs/prysm/runtime/version"
|
|
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
|
|
"github.com/prysmaticlabs/prysm/validator/client"
|
|
"github.com/prysmaticlabs/prysm/validator/db/kv"
|
|
g "github.com/prysmaticlabs/prysm/validator/graffiti"
|
|
"github.com/prysmaticlabs/prysm/validator/keymanager/local"
|
|
remote_web3signer "github.com/prysmaticlabs/prysm/validator/keymanager/remote-web3signer"
|
|
"github.com/prysmaticlabs/prysm/validator/rpc"
|
|
validatorMiddleware "github.com/prysmaticlabs/prysm/validator/rpc/apimiddleware"
|
|
"github.com/prysmaticlabs/prysm/validator/web"
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/urfave/cli/v2"
|
|
"google.golang.org/protobuf/encoding/protojson"
|
|
)
|
|
|
|
// ValidatorClient defines an instance of an Ethereum validator that manages
|
|
// the entire lifecycle of services attached to it participating in proof of stake.
|
|
type ValidatorClient struct {
|
|
cliCtx *cli.Context
|
|
ctx context.Context
|
|
cancel context.CancelFunc
|
|
db *kv.Store
|
|
services *runtime.ServiceRegistry // Lifecycle and service store.
|
|
lock sync.RWMutex
|
|
wallet *wallet.Wallet
|
|
walletInitialized *event.Feed
|
|
stop chan struct{} // Channel to wait for termination notifications.
|
|
}
|
|
|
|
// NewValidatorClient creates a new instance of the Prysm validator client.
|
|
func NewValidatorClient(cliCtx *cli.Context) (*ValidatorClient, error) {
|
|
// TODO(#9883) - Maybe we can pass in a new validator client config instead of the cliCTX to abstract away the use of flags here .
|
|
if err := tracing2.Setup(
|
|
"validator", // service name
|
|
cliCtx.String(cmd.TracingProcessNameFlag.Name),
|
|
cliCtx.String(cmd.TracingEndpointFlag.Name),
|
|
cliCtx.Float64(cmd.TraceSampleFractionFlag.Name),
|
|
cliCtx.Bool(cmd.EnableTracingFlag.Name),
|
|
); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
verbosity := cliCtx.String(cmd.VerbosityFlag.Name)
|
|
level, err := logrus.ParseLevel(verbosity)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
logrus.SetLevel(level)
|
|
|
|
// Warn if user's platform is not supported
|
|
prereqs.WarnIfPlatformNotSupported(cliCtx.Context)
|
|
|
|
registry := runtime.NewServiceRegistry()
|
|
ctx, cancel := context.WithCancel(cliCtx.Context)
|
|
validatorClient := &ValidatorClient{
|
|
cliCtx: cliCtx,
|
|
ctx: ctx,
|
|
cancel: cancel,
|
|
services: registry,
|
|
walletInitialized: new(event.Feed),
|
|
stop: make(chan struct{}),
|
|
}
|
|
|
|
if err := features.ConfigureValidator(cliCtx); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := cmd.ConfigureValidator(cliCtx); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if cliCtx.IsSet(cmd.ChainConfigFileFlag.Name) {
|
|
chainConfigFileName := cliCtx.String(cmd.ChainConfigFileFlag.Name)
|
|
if err := params.LoadChainConfigFile(chainConfigFileName, nil); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
// If the --web flag is enabled to administer the validator
|
|
// client via a web portal, we start the validator client in a different way.
|
|
if cliCtx.IsSet(flags.EnableWebFlag.Name) {
|
|
if cliCtx.IsSet(flags.Web3SignerURLFlag.Name) || cliCtx.IsSet(flags.Web3SignerPublicValidatorKeysFlag.Name) {
|
|
log.Warn("Remote Keymanager API enabled. Prysm web does not properly support web3signer at this time")
|
|
}
|
|
log.Info("Enabling web portal to manage the validator client")
|
|
if err := validatorClient.initializeForWeb(cliCtx); err != nil {
|
|
return nil, err
|
|
}
|
|
return validatorClient, nil
|
|
}
|
|
|
|
if err := validatorClient.initializeFromCLI(cliCtx); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return validatorClient, nil
|
|
}
|
|
|
|
// Start every service in the validator client.
|
|
func (c *ValidatorClient) Start() {
|
|
c.lock.Lock()
|
|
|
|
log.WithFields(logrus.Fields{
|
|
"version": version.Version(),
|
|
}).Info("Starting validator node")
|
|
|
|
c.services.StartAll()
|
|
|
|
stop := c.stop
|
|
c.lock.Unlock()
|
|
|
|
go func() {
|
|
sigc := make(chan os.Signal, 1)
|
|
signal.Notify(sigc, syscall.SIGINT, syscall.SIGTERM)
|
|
defer signal.Stop(sigc)
|
|
<-sigc
|
|
log.Info("Got interrupt, shutting down...")
|
|
debug.Exit(c.cliCtx) // Ensure trace and CPU profile data are flushed.
|
|
go c.Close()
|
|
for i := 10; i > 0; i-- {
|
|
<-sigc
|
|
if i > 1 {
|
|
log.WithField("times", i-1).Info("Already shutting down, interrupt more to panic.")
|
|
}
|
|
}
|
|
panic("Panic closing the validator client")
|
|
}()
|
|
|
|
// Wait for stop channel to be closed.
|
|
<-stop
|
|
}
|
|
|
|
// Close handles graceful shutdown of the system.
|
|
func (c *ValidatorClient) Close() {
|
|
c.lock.Lock()
|
|
defer c.lock.Unlock()
|
|
|
|
c.services.StopAll()
|
|
log.Info("Stopping Prysm validator")
|
|
c.cancel()
|
|
close(c.stop)
|
|
}
|
|
|
|
func (c *ValidatorClient) initializeFromCLI(cliCtx *cli.Context) error {
|
|
var err error
|
|
dataDir := cliCtx.String(flags.WalletDirFlag.Name)
|
|
if !cliCtx.IsSet(flags.InteropNumValidators.Name) {
|
|
// Custom Check For Web3Signer
|
|
if cliCtx.IsSet(flags.Web3SignerURLFlag.Name) {
|
|
c.wallet = wallet.NewWalletForWeb3Signer()
|
|
} else {
|
|
w, err := wallet.OpenWalletOrElseCli(cliCtx, func(cliCtx *cli.Context) (*wallet.Wallet, error) {
|
|
return nil, wallet.ErrNoWalletFound
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not open wallet")
|
|
}
|
|
c.wallet = w
|
|
// TODO(#9883) - Remove this when we have a better way to handle this.
|
|
log.WithFields(logrus.Fields{
|
|
"wallet": w.AccountsDir(),
|
|
"keymanager-kind": w.KeymanagerKind().String(),
|
|
}).Info("Opened validator wallet")
|
|
dataDir = c.wallet.AccountsDir()
|
|
}
|
|
}
|
|
if cliCtx.String(cmd.DataDirFlag.Name) != cmd.DefaultDataDir() {
|
|
dataDir = cliCtx.String(cmd.DataDirFlag.Name)
|
|
}
|
|
clearFlag := cliCtx.Bool(cmd.ClearDB.Name)
|
|
forceClearFlag := cliCtx.Bool(cmd.ForceClearDB.Name)
|
|
if clearFlag || forceClearFlag {
|
|
if dataDir == "" && c.wallet != nil {
|
|
dataDir = c.wallet.AccountsDir()
|
|
if dataDir == "" {
|
|
log.Fatal(
|
|
"Could not determine your system'c HOME path, please specify a --datadir you wish " +
|
|
"to use for your validator data",
|
|
)
|
|
}
|
|
|
|
}
|
|
if err := clearDB(cliCtx.Context, dataDir, forceClearFlag); err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
dataFile := filepath.Join(dataDir, kv.ProtectionDbFileName)
|
|
if !file.FileExists(dataFile) {
|
|
log.Warnf("Slashing protection file %s is missing.\n"+
|
|
"If you changed your --wallet-dir or --datadir, please copy your previous \"validator.db\" file into your current --datadir.\n"+
|
|
"Disregard this warning if this is the first time you are running this set of keys.", dataFile)
|
|
}
|
|
}
|
|
log.WithField("databasePath", dataDir).Info("Checking DB")
|
|
|
|
valDB, err := kv.NewKVStore(cliCtx.Context, dataDir, &kv.Config{
|
|
PubKeys: nil,
|
|
InitialMMapSize: cliCtx.Int(cmd.BoltMMapInitialSizeFlag.Name),
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not initialize db")
|
|
}
|
|
c.db = valDB
|
|
if err := valDB.RunUpMigrations(cliCtx.Context); err != nil {
|
|
return errors.Wrap(err, "could not run database migration")
|
|
}
|
|
|
|
if !cliCtx.Bool(cmd.DisableMonitoringFlag.Name) {
|
|
if err := c.registerPrometheusService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if err := c.registerValidatorService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
if cliCtx.Bool(flags.EnableRPCFlag.Name) {
|
|
if err := c.registerRPCService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
if err := c.registerRPCGatewayService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (c *ValidatorClient) initializeForWeb(cliCtx *cli.Context) error {
|
|
var err error
|
|
dataDir := cliCtx.String(flags.WalletDirFlag.Name)
|
|
if cliCtx.IsSet(flags.Web3SignerURLFlag.Name) {
|
|
c.wallet = wallet.NewWalletForWeb3Signer()
|
|
} else {
|
|
// Read the wallet password file from the cli context.
|
|
if err = setWalletPasswordFilePath(cliCtx); err != nil {
|
|
return errors.Wrap(err, "could not read wallet password file")
|
|
}
|
|
|
|
// Read the wallet from the specified path.
|
|
w, err := wallet.OpenWalletOrElseCli(cliCtx, func(cliCtx *cli.Context) (*wallet.Wallet, error) {
|
|
return nil, nil
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not open wallet")
|
|
}
|
|
c.wallet = w
|
|
if c.wallet != nil {
|
|
dataDir = c.wallet.AccountsDir()
|
|
}
|
|
}
|
|
|
|
if cliCtx.String(cmd.DataDirFlag.Name) != cmd.DefaultDataDir() {
|
|
dataDir = cliCtx.String(cmd.DataDirFlag.Name)
|
|
}
|
|
clearFlag := cliCtx.Bool(cmd.ClearDB.Name)
|
|
forceClearFlag := cliCtx.Bool(cmd.ForceClearDB.Name)
|
|
|
|
if clearFlag || forceClearFlag {
|
|
if dataDir == "" {
|
|
dataDir = cmd.DefaultDataDir()
|
|
if dataDir == "" {
|
|
log.Fatal(
|
|
"Could not determine your system'c HOME path, please specify a --datadir you wish " +
|
|
"to use for your validator data",
|
|
)
|
|
}
|
|
|
|
}
|
|
if err := clearDB(cliCtx.Context, dataDir, forceClearFlag); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
log.WithField("databasePath", dataDir).Info("Checking DB")
|
|
valDB, err := kv.NewKVStore(cliCtx.Context, dataDir, &kv.Config{
|
|
PubKeys: nil,
|
|
InitialMMapSize: cliCtx.Int(cmd.BoltMMapInitialSizeFlag.Name),
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not initialize db")
|
|
}
|
|
c.db = valDB
|
|
if err := valDB.RunUpMigrations(cliCtx.Context); err != nil {
|
|
return errors.Wrap(err, "could not run database migration")
|
|
}
|
|
|
|
if !cliCtx.Bool(cmd.DisableMonitoringFlag.Name) {
|
|
if err := c.registerPrometheusService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if err := c.registerValidatorService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
if err := c.registerRPCService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
if err := c.registerRPCGatewayService(cliCtx); err != nil {
|
|
return err
|
|
}
|
|
gatewayHost := cliCtx.String(flags.GRPCGatewayHost.Name)
|
|
gatewayPort := cliCtx.Int(flags.GRPCGatewayPort.Name)
|
|
webAddress := fmt.Sprintf("http://%s:%d", gatewayHost, gatewayPort)
|
|
log.WithField("address", webAddress).Info(
|
|
"Starting Prysm web UI on address, open in browser to access",
|
|
)
|
|
return nil
|
|
}
|
|
|
|
func (c *ValidatorClient) registerPrometheusService(cliCtx *cli.Context) error {
|
|
var additionalHandlers []prometheus.Handler
|
|
if cliCtx.IsSet(cmd.EnableBackupWebhookFlag.Name) {
|
|
additionalHandlers = append(
|
|
additionalHandlers,
|
|
prometheus.Handler{
|
|
Path: "/db/backup",
|
|
Handler: backup.BackupHandler(c.db, cliCtx.String(cmd.BackupWebhookOutputDir.Name)),
|
|
},
|
|
)
|
|
}
|
|
service := prometheus.NewService(
|
|
fmt.Sprintf("%s:%d", c.cliCtx.String(cmd.MonitoringHostFlag.Name), c.cliCtx.Int(flags.MonitoringPortFlag.Name)),
|
|
c.services,
|
|
additionalHandlers...,
|
|
)
|
|
logrus.AddHook(prometheus.NewLogrusCollector())
|
|
return c.services.RegisterService(service)
|
|
}
|
|
|
|
func (c *ValidatorClient) registerValidatorService(cliCtx *cli.Context) error {
|
|
|
|
endpoint := c.cliCtx.String(flags.BeaconRPCProviderFlag.Name)
|
|
dataDir := c.cliCtx.String(cmd.DataDirFlag.Name)
|
|
logValidatorBalances := !c.cliCtx.Bool(flags.DisablePenaltyRewardLogFlag.Name)
|
|
emitAccountMetrics := !c.cliCtx.Bool(flags.DisableAccountMetricsFlag.Name)
|
|
cert := c.cliCtx.String(flags.CertFlag.Name)
|
|
graffiti := c.cliCtx.String(flags.GraffitiFlag.Name)
|
|
maxCallRecvMsgSize := c.cliCtx.Int(cmd.GrpcMaxCallRecvMsgSizeFlag.Name)
|
|
grpcRetries := c.cliCtx.Uint(flags.GrpcRetriesFlag.Name)
|
|
grpcRetryDelay := c.cliCtx.Duration(flags.GrpcRetryDelayFlag.Name)
|
|
var interopKeysConfig *local.InteropKeymanagerConfig
|
|
if c.cliCtx.IsSet(flags.InteropNumValidators.Name) {
|
|
interopKeysConfig = &local.InteropKeymanagerConfig{
|
|
Offset: cliCtx.Uint64(flags.InteropStartIndex.Name),
|
|
NumValidatorKeys: cliCtx.Uint64(flags.InteropNumValidators.Name),
|
|
}
|
|
}
|
|
|
|
gStruct := &g.Graffiti{}
|
|
var err error
|
|
if c.cliCtx.IsSet(flags.GraffitiFileFlag.Name) {
|
|
n := c.cliCtx.String(flags.GraffitiFileFlag.Name)
|
|
gStruct, err = g.ParseGraffitiFile(n)
|
|
if err != nil {
|
|
log.WithError(err).Warn("Could not parse graffiti file")
|
|
}
|
|
}
|
|
|
|
wsc, err := web3SignerConfig(c.cliCtx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bpc, err := feeRecipientConfig(c.cliCtx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
v, err := client.NewValidatorService(c.cliCtx.Context, &client.Config{
|
|
Endpoint: endpoint,
|
|
DataDir: dataDir,
|
|
LogValidatorBalances: logValidatorBalances,
|
|
EmitAccountMetrics: emitAccountMetrics,
|
|
CertFlag: cert,
|
|
GraffitiFlag: g.ParseHexGraffiti(graffiti),
|
|
GrpcMaxCallRecvMsgSizeFlag: maxCallRecvMsgSize,
|
|
GrpcRetriesFlag: grpcRetries,
|
|
GrpcRetryDelay: grpcRetryDelay,
|
|
GrpcHeadersFlag: c.cliCtx.String(flags.GrpcHeadersFlag.Name),
|
|
ValDB: c.db,
|
|
UseWeb: c.cliCtx.Bool(flags.EnableWebFlag.Name),
|
|
InteropKeysConfig: interopKeysConfig,
|
|
Wallet: c.wallet,
|
|
WalletInitializedFeed: c.walletInitialized,
|
|
GraffitiStruct: gStruct,
|
|
LogDutyCountDown: c.cliCtx.Bool(flags.EnableDutyCountDown.Name),
|
|
Web3SignerConfig: wsc,
|
|
FeeRecipientConfig: bpc,
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not initialize validator service")
|
|
}
|
|
|
|
return c.services.RegisterService(v)
|
|
}
|
|
|
|
func web3SignerConfig(cliCtx *cli.Context) (*remote_web3signer.SetupConfig, error) {
|
|
var web3signerConfig *remote_web3signer.SetupConfig
|
|
if cliCtx.IsSet(flags.Web3SignerURLFlag.Name) {
|
|
urlStr := cliCtx.String(flags.Web3SignerURLFlag.Name)
|
|
u, err := url.ParseRequestURI(urlStr)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "web3signer url %s is invalid", urlStr)
|
|
}
|
|
if u.Scheme == "" || u.Host == "" {
|
|
return nil, fmt.Errorf("web3signer url must be in the format of http(s)://host:port url used: %v", urlStr)
|
|
}
|
|
web3signerConfig = &remote_web3signer.SetupConfig{
|
|
BaseEndpoint: u.String(),
|
|
GenesisValidatorsRoot: nil,
|
|
}
|
|
if cliCtx.IsSet(flags.Web3SignerPublicValidatorKeysFlag.Name) {
|
|
publicKeysStr := cliCtx.String(flags.Web3SignerPublicValidatorKeysFlag.Name)
|
|
pURL, err := url.ParseRequestURI(publicKeysStr)
|
|
if err == nil && pURL.Scheme != "" && pURL.Host != "" {
|
|
web3signerConfig.PublicKeysURL = publicKeysStr
|
|
} else {
|
|
var validatorKeys [][48]byte
|
|
for _, key := range strings.Split(publicKeysStr, ",") {
|
|
decodedKey, decodeErr := hexutil.Decode(key)
|
|
if decodeErr != nil {
|
|
return nil, errors.Wrapf(decodeErr, "could not decode public key for web3signer: %s", key)
|
|
}
|
|
validatorKeys = append(validatorKeys, bytesutil.ToBytes48(decodedKey))
|
|
}
|
|
web3signerConfig.ProvidedPublicKeys = validatorKeys
|
|
}
|
|
}
|
|
}
|
|
return web3signerConfig, nil
|
|
}
|
|
|
|
func feeRecipientConfig(cliCtx *cli.Context) (*validatorServiceConfig.FeeRecipientConfig, error) {
|
|
var fileConfig *validatorServiceConfig.FeeRecipientFileConfig
|
|
if cliCtx.IsSet(flags.FeeRecipientConfigFileFlag.Name) && cliCtx.IsSet(flags.FeeRecipientConfigURLFlag.Name) {
|
|
return nil, errors.New("cannot specify both --validators-proposer-fileConfig-dir and --validators-proposer-fileConfig-url")
|
|
}
|
|
if cliCtx.IsSet(flags.FeeRecipientConfigFileFlag.Name) {
|
|
if err := unmarshalFromFile(cliCtx.Context, cliCtx.String(flags.FeeRecipientConfigFileFlag.Name), &fileConfig); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
if cliCtx.IsSet(flags.FeeRecipientConfigURLFlag.Name) {
|
|
if err := unmarshalFromURL(cliCtx.Context, cliCtx.String(flags.FeeRecipientConfigURLFlag.Name), &fileConfig); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
// override the default fileConfig with the fileConfig from the command line
|
|
if cliCtx.IsSet(flags.SuggestedFeeRecipientFlag.Name) {
|
|
suggestedFee := cliCtx.String(flags.SuggestedFeeRecipientFlag.Name)
|
|
fileConfig = &validatorServiceConfig.FeeRecipientFileConfig{
|
|
ProposeConfig: nil,
|
|
DefaultConfig: &validatorServiceConfig.FeeRecipientFileOptions{
|
|
FeeRecipient: suggestedFee,
|
|
},
|
|
}
|
|
}
|
|
// nothing is set, so just return nil
|
|
if fileConfig == nil {
|
|
return nil, nil
|
|
}
|
|
//convert file config to proposer config for internal use
|
|
frConfig := &validatorServiceConfig.FeeRecipientConfig{}
|
|
|
|
// default fileConfig is mandatory
|
|
if fileConfig.DefaultConfig == nil {
|
|
return nil, errors.New("default fileConfig is required")
|
|
}
|
|
bytes, err := hexutil.Decode(fileConfig.DefaultConfig.FeeRecipient)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "could not decode fee recipient %s", fileConfig.DefaultConfig.FeeRecipient)
|
|
}
|
|
if !common.IsHexAddress(fileConfig.DefaultConfig.FeeRecipient) {
|
|
return nil, errors.New("default fileConfig fee recipient is not a valid eth1 address")
|
|
}
|
|
frConfig.DefaultConfig = &validatorServiceConfig.FeeRecipientOptions{
|
|
FeeRecipient: common.BytesToAddress(bytes),
|
|
}
|
|
|
|
if fileConfig.ProposeConfig != nil {
|
|
frConfig.ProposeConfig = make(map[[fieldparams.BLSPubkeyLength]byte]*validatorServiceConfig.FeeRecipientOptions)
|
|
for key, option := range fileConfig.ProposeConfig {
|
|
decodedKey, err := hexutil.Decode(key)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "could not decode public key for web3signer: %s", key)
|
|
}
|
|
if len(decodedKey) != fieldparams.BLSPubkeyLength {
|
|
return nil, fmt.Errorf("%v is not a bls public key", key)
|
|
}
|
|
if option == nil {
|
|
return nil, fmt.Errorf("fee recipient is required for proposer %s", key)
|
|
}
|
|
feebytes, err := hexutil.Decode(option.FeeRecipient)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "could not decode fee recipient %s", option.FeeRecipient)
|
|
}
|
|
if !common.IsHexAddress(option.FeeRecipient) {
|
|
return nil, errors.New("fee recipient is not a valid eth1 address")
|
|
}
|
|
mixedcaseAddress, err := common.NewMixedcaseAddressFromString(option.FeeRecipient)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "could not decode fee recipient %s", option.FeeRecipient)
|
|
}
|
|
checksumAddress := common.BytesToAddress(feebytes)
|
|
if !mixedcaseAddress.ValidChecksum() {
|
|
log.Warnf("Fee recipient %s is not a checksum Ethereum address. "+
|
|
"The checksummed address is %s and will be used as the fee recipient. "+
|
|
"We recommend using a mixed-case address (checksum) "+
|
|
"to prevent spelling mistakes in your fee recipient Ethereum address", option.FeeRecipient, checksumAddress.Hex())
|
|
}
|
|
frConfig.ProposeConfig[bytesutil.ToBytes48(decodedKey)] = &validatorServiceConfig.FeeRecipientOptions{
|
|
FeeRecipient: checksumAddress,
|
|
}
|
|
}
|
|
}
|
|
|
|
return frConfig, nil
|
|
}
|
|
|
|
func (c *ValidatorClient) registerRPCService(cliCtx *cli.Context) error {
|
|
var vs *client.ValidatorService
|
|
if err := c.services.FetchService(&vs); err != nil {
|
|
return err
|
|
}
|
|
validatorGatewayHost := cliCtx.String(flags.GRPCGatewayHost.Name)
|
|
validatorGatewayPort := cliCtx.Int(flags.GRPCGatewayPort.Name)
|
|
validatorMonitoringHost := cliCtx.String(cmd.MonitoringHostFlag.Name)
|
|
validatorMonitoringPort := cliCtx.Int(flags.MonitoringPortFlag.Name)
|
|
rpcHost := cliCtx.String(flags.RPCHost.Name)
|
|
rpcPort := cliCtx.Int(flags.RPCPort.Name)
|
|
nodeGatewayEndpoint := cliCtx.String(flags.BeaconRPCGatewayProviderFlag.Name)
|
|
beaconClientEndpoint := cliCtx.String(flags.BeaconRPCProviderFlag.Name)
|
|
maxCallRecvMsgSize := c.cliCtx.Int(cmd.GrpcMaxCallRecvMsgSizeFlag.Name)
|
|
grpcRetries := c.cliCtx.Uint(flags.GrpcRetriesFlag.Name)
|
|
grpcRetryDelay := c.cliCtx.Duration(flags.GrpcRetryDelayFlag.Name)
|
|
walletDir := cliCtx.String(flags.WalletDirFlag.Name)
|
|
grpcHeaders := c.cliCtx.String(flags.GrpcHeadersFlag.Name)
|
|
clientCert := c.cliCtx.String(flags.CertFlag.Name)
|
|
server := rpc.NewServer(cliCtx.Context, &rpc.Config{
|
|
ValDB: c.db,
|
|
Host: rpcHost,
|
|
Port: fmt.Sprintf("%d", rpcPort),
|
|
WalletInitializedFeed: c.walletInitialized,
|
|
ValidatorService: vs,
|
|
SyncChecker: vs,
|
|
GenesisFetcher: vs,
|
|
NodeGatewayEndpoint: nodeGatewayEndpoint,
|
|
WalletDir: walletDir,
|
|
Wallet: c.wallet,
|
|
ValidatorGatewayHost: validatorGatewayHost,
|
|
ValidatorGatewayPort: validatorGatewayPort,
|
|
ValidatorMonitoringHost: validatorMonitoringHost,
|
|
ValidatorMonitoringPort: validatorMonitoringPort,
|
|
BeaconClientEndpoint: beaconClientEndpoint,
|
|
ClientMaxCallRecvMsgSize: maxCallRecvMsgSize,
|
|
ClientGrpcRetries: grpcRetries,
|
|
ClientGrpcRetryDelay: grpcRetryDelay,
|
|
ClientGrpcHeaders: strings.Split(grpcHeaders, ","),
|
|
ClientWithCert: clientCert,
|
|
})
|
|
return c.services.RegisterService(server)
|
|
}
|
|
|
|
func (c *ValidatorClient) registerRPCGatewayService(cliCtx *cli.Context) error {
|
|
gatewayHost := cliCtx.String(flags.GRPCGatewayHost.Name)
|
|
if gatewayHost != flags.DefaultGatewayHost {
|
|
log.WithField("web-host", gatewayHost).Warn(
|
|
"You are using a non-default web host. Web traffic is served by HTTP, so be wary of " +
|
|
"changing this parameter if you are exposing this host to the Internet!",
|
|
)
|
|
}
|
|
gatewayPort := cliCtx.Int(flags.GRPCGatewayPort.Name)
|
|
rpcHost := cliCtx.String(flags.RPCHost.Name)
|
|
rpcPort := cliCtx.Int(flags.RPCPort.Name)
|
|
rpcAddr := fmt.Sprintf("%s:%d", rpcHost, rpcPort)
|
|
gatewayAddress := fmt.Sprintf("%s:%d", gatewayHost, gatewayPort)
|
|
timeout := cliCtx.Int(cmd.ApiTimeoutFlag.Name)
|
|
var allowedOrigins []string
|
|
if cliCtx.IsSet(flags.GPRCGatewayCorsDomain.Name) {
|
|
allowedOrigins = strings.Split(cliCtx.String(flags.GPRCGatewayCorsDomain.Name), ",")
|
|
} else {
|
|
allowedOrigins = strings.Split(flags.GPRCGatewayCorsDomain.Value, ",")
|
|
}
|
|
maxCallSize := cliCtx.Uint64(cmd.GrpcMaxCallRecvMsgSizeFlag.Name)
|
|
|
|
registrations := []gateway.PbHandlerRegistration{
|
|
validatorpb.RegisterAuthHandler,
|
|
validatorpb.RegisterWalletHandler,
|
|
pb.RegisterHealthHandler,
|
|
validatorpb.RegisterHealthHandler,
|
|
validatorpb.RegisterAccountsHandler,
|
|
validatorpb.RegisterBeaconHandler,
|
|
validatorpb.RegisterSlashingProtectionHandler,
|
|
ethpbservice.RegisterKeyManagementHandler,
|
|
}
|
|
gwmux := gwruntime.NewServeMux(
|
|
gwruntime.WithMarshalerOption(gwruntime.MIMEWildcard, &gwruntime.HTTPBodyMarshaler{
|
|
Marshaler: &gwruntime.JSONPb{
|
|
MarshalOptions: protojson.MarshalOptions{
|
|
EmitUnpopulated: true,
|
|
UseProtoNames: true,
|
|
},
|
|
UnmarshalOptions: protojson.UnmarshalOptions{
|
|
DiscardUnknown: true,
|
|
},
|
|
},
|
|
}),
|
|
gwruntime.WithMarshalerOption(
|
|
"text/event-stream", &gwruntime.EventSourceJSONPb{},
|
|
),
|
|
)
|
|
muxHandler := func(apiMware *apimiddleware.ApiProxyMiddleware, h http.HandlerFunc, w http.ResponseWriter, req *http.Request) {
|
|
// The validator gateway handler requires this special logic as it serves two kinds of APIs, namely
|
|
// the standard validator keymanager API under the /eth namespace, and the Prysm internal
|
|
// validator API under the /api namespace. Finally, it also serves requests to host the validator web UI.
|
|
if strings.HasPrefix(req.URL.Path, "/api/eth/") {
|
|
req.URL.Path = strings.Replace(req.URL.Path, "/api", "", 1)
|
|
// If the prefix has /eth/, we handle it with the standard API gateway middleware.
|
|
apiMware.ServeHTTP(w, req)
|
|
} else if strings.HasPrefix(req.URL.Path, "/api") {
|
|
req.URL.Path = strings.Replace(req.URL.Path, "/api", "", 1)
|
|
// Else, we handle with the Prysm API gateway without a middleware.
|
|
h(w, req)
|
|
} else {
|
|
// Finally, we handle with the web server.
|
|
web.Handler(w, req)
|
|
}
|
|
}
|
|
|
|
pbHandler := &gateway.PbMux{
|
|
Registrations: registrations,
|
|
Patterns: []string{"/accounts/", "/v2/", "/internal/eth/v1/"},
|
|
Mux: gwmux,
|
|
}
|
|
opts := []gateway.Option{
|
|
gateway.WithRemoteAddr(rpcAddr),
|
|
gateway.WithGatewayAddr(gatewayAddress),
|
|
gateway.WithMaxCallRecvMsgSize(maxCallSize),
|
|
gateway.WithPbHandlers([]*gateway.PbMux{pbHandler}),
|
|
gateway.WithAllowedOrigins(allowedOrigins),
|
|
gateway.WithApiMiddleware(&validatorMiddleware.ValidatorEndpointFactory{}),
|
|
gateway.WithMuxHandler(muxHandler),
|
|
gateway.WithTimeout(uint64(timeout)),
|
|
}
|
|
gw, err := gateway.New(cliCtx.Context, opts...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return c.services.RegisterService(gw)
|
|
}
|
|
|
|
func setWalletPasswordFilePath(cliCtx *cli.Context) error {
|
|
walletDir := cliCtx.String(flags.WalletDirFlag.Name)
|
|
defaultWalletPasswordFilePath := filepath.Join(walletDir, wallet.DefaultWalletPasswordFile)
|
|
if file.FileExists(defaultWalletPasswordFilePath) {
|
|
// Ensure file has proper permissions.
|
|
hasPerms, err := file.HasReadWritePermissions(defaultWalletPasswordFilePath)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !hasPerms {
|
|
return fmt.Errorf(
|
|
"wallet password file %s does not have proper 0600 permissions",
|
|
defaultWalletPasswordFilePath,
|
|
)
|
|
}
|
|
|
|
// Set the filepath into the cli context.
|
|
if err := cliCtx.Set(flags.WalletPasswordFileFlag.Name, defaultWalletPasswordFilePath); err != nil {
|
|
return errors.Wrap(err, "could not set default wallet password file path")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func clearDB(ctx context.Context, dataDir string, force bool) error {
|
|
var err error
|
|
clearDBConfirmed := force
|
|
|
|
if !force {
|
|
actionText := "This will delete your validator's historical actions database stored in your data directory. " +
|
|
"This may lead to potential slashing - do you want to proceed? (Y/N)"
|
|
deniedText := "The historical actions database will not be deleted. No changes have been made."
|
|
clearDBConfirmed, err = cmd.ConfirmAction(actionText, deniedText)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "Could not clear DB in dir %s", dataDir)
|
|
}
|
|
}
|
|
|
|
if clearDBConfirmed {
|
|
valDB, err := kv.NewKVStore(ctx, dataDir, &kv.Config{})
|
|
if err != nil {
|
|
return errors.Wrapf(err, "Could not create DB in dir %s", dataDir)
|
|
}
|
|
if err := valDB.Close(); err != nil {
|
|
return errors.Wrapf(err, "could not close DB in dir %s", dataDir)
|
|
}
|
|
|
|
log.Warning("Removing database")
|
|
if err := valDB.ClearDB(); err != nil {
|
|
return errors.Wrapf(err, "Could not clear DB in dir %s", dataDir)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func unmarshalFromURL(ctx context.Context, from string, to interface{}) error {
|
|
u, err := url.ParseRequestURI(from)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if u.Scheme == "" || u.Host == "" {
|
|
return fmt.Errorf("invalid URL: %s", from)
|
|
}
|
|
req, reqerr := http.NewRequestWithContext(ctx, http.MethodGet, from, nil)
|
|
if reqerr != nil {
|
|
return errors.Wrap(reqerr, "failed to create http request")
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
resp, resperr := http.DefaultClient.Do(req)
|
|
if resperr != nil {
|
|
return errors.Wrap(resperr, "failed to send http request")
|
|
}
|
|
defer func(Body io.ReadCloser) {
|
|
err = Body.Close()
|
|
if err != nil {
|
|
log.WithError(err).Error("failed to close response body")
|
|
}
|
|
}(resp.Body)
|
|
if resp.StatusCode != http.StatusOK {
|
|
return errors.Errorf("http request to %v failed with status code %d", from, resp.StatusCode)
|
|
}
|
|
if decodeerr := json.NewDecoder(resp.Body).Decode(&to); decodeerr != nil {
|
|
return errors.Wrap(decodeerr, "failed to decode http response")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func unmarshalFromFile(ctx context.Context, from string, to interface{}) error {
|
|
if ctx == nil {
|
|
return errors.New("node: nil context passed to unmarshalFromFile")
|
|
}
|
|
cleanpath := filepath.Clean(from)
|
|
fileExtension := filepath.Ext(cleanpath)
|
|
if fileExtension != ".json" {
|
|
return errors.Errorf("unsupported file extension %s , (ex. '.json')", fileExtension)
|
|
}
|
|
jsonFile, jsonerr := os.Open(cleanpath)
|
|
if jsonerr != nil {
|
|
return errors.Wrap(jsonerr, "failed to open json file")
|
|
}
|
|
// defer the closing of our jsonFile so that we can parse it later on
|
|
defer func(jsonFile *os.File) {
|
|
err := jsonFile.Close()
|
|
if err != nil {
|
|
log.WithError(err).Error("failed to close json file")
|
|
}
|
|
}(jsonFile)
|
|
byteValue, readerror := io.ReadAll(jsonFile)
|
|
if readerror != nil {
|
|
return errors.Wrap(readerror, "failed to read json file")
|
|
}
|
|
if unmarshalerr := json.Unmarshal(byteValue, &to); unmarshalerr != nil {
|
|
return errors.Wrap(unmarshalerr, "failed to unmarshal json file")
|
|
}
|
|
return nil
|
|
}
|