Ajust constructor names of nodes (#8362)

* clean up constructors for nodes

* resurrect validator client

* fix small naming issues

Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
This commit is contained in:
Radosław Kapka
2021-02-01 18:12:52 +01:00
committed by GitHub
parent 4595789ac8
commit 48ed506487
7 changed files with 24 additions and 24 deletions

View File

@@ -215,7 +215,7 @@ func startNode(ctx *cli.Context) error {
gethlog.Root().SetHandler(glogger)
}
beacon, err := node.NewBeaconNode(ctx)
beacon, err := node.New(ctx)
if err != nil {
return err
}

View File

@@ -76,9 +76,9 @@ type BeaconNode struct {
stateGen *stategen.State
}
// NewBeaconNode creates a new node instance, sets up configuration options, and registers
// New creates a new node instance, sets up configuration options, and registers
// every required service to the node.
func NewBeaconNode(cliCtx *cli.Context) (*BeaconNode, error) {
func New(cliCtx *cli.Context) (*BeaconNode, error) {
if err := tracing.Setup(
"beacon-chain", // service name
cliCtx.String(cmd.TracingProcessNameFlag.Name),

View File

@@ -35,7 +35,7 @@ func TestNodeClose_OK(t *testing.T) {
context := cli.NewContext(&app, set, nil)
node, err := NewBeaconNode(context)
node, err := New(context)
require.NoError(t, err)
node.Close()
@@ -75,7 +75,7 @@ func TestClearDB(t *testing.T) {
set.Bool(cmd.ForceClearDB.Name, true, "force clear db")
context := cli.NewContext(&app, set, nil)
_, err := NewBeaconNode(context)
_, err := New(context)
require.NoError(t, err)
require.LogsContain(t, hook, "Removing database")

View File

@@ -36,7 +36,7 @@ func startSlasher(cliCtx *cli.Context) error {
return err
}
logrus.SetLevel(level)
slasher, err := node.NewSlasherNode(cliCtx)
slasher, err := node.New(cliCtx)
if err != nil {
return err
}

View File

@@ -49,9 +49,9 @@ type SlasherNode struct {
db db.Database
}
// NewSlasherNode creates a new node instance, sets up configuration options,
// New creates a new node instance, sets up configuration options,
// and registers every required service.
func NewSlasherNode(cliCtx *cli.Context) (*SlasherNode, error) {
func New(cliCtx *cli.Context) (*SlasherNode, error) {
if err := tracing.Setup(
"slasher", // Service name.
cliCtx.String(cmd.TracingProcessNameFlag.Name),

View File

@@ -35,7 +35,7 @@ func TestNodeClose_OK(t *testing.T) {
context := cli.NewContext(&app, set, nil)
node, err := NewSlasherNode(context)
node, err := New(context)
require.NoError(t, err, "Failed to create slasher node")
node.Close()
@@ -56,7 +56,7 @@ func TestClearDB(t *testing.T) {
set.Bool(cmd.ForceClearDB.Name, true, "force clear db")
context := cli.NewContext(&app, set, nil)
slasherNode, err := NewSlasherNode(context)
slasherNode, err := New(context)
require.NoError(t, err)
require.LogsContain(t, hook, "Removing database")

View File

@@ -55,7 +55,7 @@ type ValidatorClient struct {
stop chan struct{} // Channel to wait for termination notifications.
}
// NewValidatorClient creates a new, Prysm validator client.
// NewValidatorClient creates a new instance of the Prysm validator client.
func NewValidatorClient(cliCtx *cli.Context) (*ValidatorClient, error) {
if err := tracing.Setup(
"validator", // service name
@@ -79,7 +79,7 @@ func NewValidatorClient(cliCtx *cli.Context) (*ValidatorClient, error) {
registry := shared.NewServiceRegistry()
ctx, cancel := context.WithCancel(cliCtx.Context)
ValidatorClient := &ValidatorClient{
validatorClient := &ValidatorClient{
cliCtx: cliCtx,
ctx: ctx,
cancel: cancel,
@@ -100,10 +100,10 @@ func NewValidatorClient(cliCtx *cli.Context) (*ValidatorClient, error) {
// client via a web portal, we start the validator client in a different way.
if cliCtx.IsSet(flags.EnableWebFlag.Name) {
log.Info("Enabling web portal to manage the validator client")
if err := ValidatorClient.initializeForWeb(cliCtx); err != nil {
if err := validatorClient.initializeForWeb(cliCtx); err != nil {
return nil, err
}
return ValidatorClient, nil
return validatorClient, nil
}
if cliCtx.IsSet(cmd.ChainConfigFileFlag.Name) {
@@ -111,11 +111,11 @@ func NewValidatorClient(cliCtx *cli.Context) (*ValidatorClient, error) {
params.LoadChainConfigFile(chainConfigFileName)
}
if err := ValidatorClient.initializeFromCLI(cliCtx); err != nil {
if err := validatorClient.initializeFromCLI(cliCtx); err != nil {
return nil, err
}
return ValidatorClient, nil
return validatorClient, nil
}
// Start every service in the validator client.
@@ -239,11 +239,11 @@ func (c *ValidatorClient) initializeFromCLI(cliCtx *cli.Context) error {
}
}
if featureconfig.Get().SlasherProtection {
if err := c.registerSlasherClientService(); err != nil {
if err := c.registerSlasherService(); err != nil {
return err
}
}
if err := c.registerClientService(keyManager); err != nil {
if err := c.registerValidatorService(keyManager); err != nil {
return err
}
if cliCtx.Bool(flags.EnableRPCFlag.Name) {
@@ -326,11 +326,11 @@ func (c *ValidatorClient) initializeForWeb(cliCtx *cli.Context) error {
}
}
if featureconfig.Get().SlasherProtection {
if err := c.registerSlasherClientService(); err != nil {
if err := c.registerSlasherService(); err != nil {
return err
}
}
if err := c.registerClientService(keyManager); err != nil {
if err := c.registerValidatorService(keyManager); err != nil {
return err
}
if err := c.registerRPCService(cliCtx, keyManager); err != nil {
@@ -368,7 +368,7 @@ func (c *ValidatorClient) registerPrometheusService(cliCtx *cli.Context) error {
return c.services.RegisterService(service)
}
func (c *ValidatorClient) registerClientService(
func (c *ValidatorClient) registerValidatorService(
keyManager keymanager.IKeymanager,
) error {
endpoint := c.cliCtx.String(flags.BeaconRPCProviderFlag.Name)
@@ -417,11 +417,11 @@ func (c *ValidatorClient) registerClientService(
})
if err != nil {
return errors.Wrap(err, "could not initialize client service")
return errors.Wrap(err, "could not initialize validator service")
}
return c.services.RegisterService(v)
}
func (c *ValidatorClient) registerSlasherClientService() error {
func (c *ValidatorClient) registerSlasherService() error {
endpoint := c.cliCtx.String(flags.SlasherRPCProviderFlag.Name)
if endpoint == "" {
return errors.New("external slasher feature flag is set but no slasher endpoint is configured")
@@ -440,7 +440,7 @@ func (c *ValidatorClient) registerSlasherClientService() error {
GrpcHeadersFlag: c.cliCtx.String(flags.GrpcHeadersFlag.Name),
})
if err != nil {
return errors.Wrap(err, "could not initialize client service")
return errors.Wrap(err, "could not initialize slasher service")
}
return c.services.RegisterService(sp)
}