From 5ea6e32d6ca9515de9c4eac86dc072ab43a66dcd Mon Sep 17 00:00:00 2001 From: Nishant Das Date: Thu, 16 Mar 2023 20:15:02 +0800 Subject: [PATCH] Remove Deprecated HTTP Provider Flag (#12140) * remove deprecated http provider flag * test --------- Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com> --- cmd/beacon-chain/execution/options.go | 10 +--------- cmd/beacon-chain/flags/base.go | 7 ------- cmd/beacon-chain/main.go | 4 ---- cmd/beacon-chain/usage.go | 1 - cmd/helpers_test.go | 26 +++++++++++++------------- 5 files changed, 14 insertions(+), 34 deletions(-) diff --git a/cmd/beacon-chain/execution/options.go b/cmd/beacon-chain/execution/options.go index add7ea1d8a..30f44c9efc 100644 --- a/cmd/beacon-chain/execution/options.go +++ b/cmd/beacon-chain/execution/options.go @@ -68,8 +68,7 @@ func parseJWTSecretFromFile(c *cli.Context) ([]byte, error) { } func parseExecutionChainEndpoint(c *cli.Context) (string, error) { - aliasUsed := c.IsSet(flags.HTTPWeb3ProviderFlag.Name) - if c.String(flags.ExecutionEngineEndpoint.Name) == "" && !aliasUsed { + if c.String(flags.ExecutionEngineEndpoint.Name) == "" { return "", fmt.Errorf( "you need to specify %s to provide a connection endpoint to an Ethereum execution client "+ "for your Prysm beacon node. This is a requirement for running a node. You can read more about "+ @@ -78,12 +77,5 @@ func parseExecutionChainEndpoint(c *cli.Context) (string, error) { flags.ExecutionEngineEndpoint.Name, ) } - // If users only declare the deprecated flag without setting the execution engine - // flag, we fallback to using the deprecated flag value. - if aliasUsed && !c.IsSet(flags.ExecutionEngineEndpoint.Name) { - log.Warnf("The %s flag has been deprecated and will be removed in a future release,"+ - "please use the execution endpoint flag instead %s", flags.HTTPWeb3ProviderFlag.Name, flags.ExecutionEngineEndpoint.Name) - return c.String(flags.HTTPWeb3ProviderFlag.Name), nil - } return c.String(flags.ExecutionEngineEndpoint.Name), nil } diff --git a/cmd/beacon-chain/flags/base.go b/cmd/beacon-chain/flags/base.go index 76d5154eaf..c82a27d22e 100644 --- a/cmd/beacon-chain/flags/base.go +++ b/cmd/beacon-chain/flags/base.go @@ -39,13 +39,6 @@ var ( Usage: "A comma separated list of key value pairs to pass as HTTP headers for all execution " + "client calls. Example: --execution-headers=key1=value1,key2=value2", } - // Deprecated: HTTPWeb3ProviderFlag is a deprecated flag and is an alias for the ExecutionEngineEndpoint flag. - HTTPWeb3ProviderFlag = &cli.StringFlag{ - Name: "http-web3provider", - Usage: "DEPRECATED: A mainchain web3 provider string http endpoint. Can contain auth header as well in the format --http-web3provider=\"https://goerli.infura.io/v3/xxxx,Basic xxx\" for project secret (base64 encoded) and --http-web3provider=\"https://goerli.infura.io/v3/xxxx,Bearer xxx\" for jwt use", - Value: "http://localhost:8551", - Hidden: true, - } // ExecutionJWTSecretFlag provides a path to a file containing a hex-encoded string representing a 32 byte secret // used to authenticate with an execution node via HTTP. This is required if using an HTTP connection, otherwise all requests // to execution nodes for consensus-related calls will fail. This is not required if using an IPC connection. diff --git a/cmd/beacon-chain/main.go b/cmd/beacon-chain/main.go index ab737190ab..2b05be678c 100644 --- a/cmd/beacon-chain/main.go +++ b/cmd/beacon-chain/main.go @@ -39,7 +39,6 @@ var appFlags = []cli.Flag{ flags.DepositContractFlag, flags.ExecutionEngineEndpoint, flags.ExecutionEngineHeaders, - flags.HTTPWeb3ProviderFlag, flags.ExecutionJWTSecretFlag, flags.RPCHost, flags.RPCPort, @@ -195,9 +194,6 @@ func main() { if err := cmd.ExpandSingleEndpointIfFile(ctx, flags.ExecutionEngineEndpoint); err != nil { return err } - if err := cmd.ExpandSingleEndpointIfFile(ctx, flags.HTTPWeb3ProviderFlag); err != nil { - return err - } if ctx.IsSet(flags.SetGCPercent.Name) { runtimeDebug.SetGCPercent(ctx.Int(flags.SetGCPercent.Name)) } diff --git a/cmd/beacon-chain/usage.go b/cmd/beacon-chain/usage.go index 53d2928c58..ae58e9c3d2 100644 --- a/cmd/beacon-chain/usage.go +++ b/cmd/beacon-chain/usage.go @@ -107,7 +107,6 @@ var appHelpFlagGroups = []flagGroup{ flags.GPRCGatewayCorsDomain, flags.ExecutionEngineEndpoint, flags.ExecutionEngineHeaders, - flags.HTTPWeb3ProviderFlag, flags.ExecutionJWTSecretFlag, flags.SetGCPercent, flags.SlotsPerArchivedPoint, diff --git a/cmd/helpers_test.go b/cmd/helpers_test.go index be1773bd6e..6220ca6ad3 100644 --- a/cmd/helpers_test.go +++ b/cmd/helpers_test.go @@ -84,30 +84,30 @@ func TestEnterPassword(t *testing.T) { func TestExpandSingleEndpointIfFile(t *testing.T) { app := cli.App{} set := flag.NewFlagSet("test", 0) - HTTPWeb3ProviderFlag := &cli.StringFlag{Name: "http-web3provider", Value: ""} - set.String(HTTPWeb3ProviderFlag.Name, "", "") + ExecutionEndpointFlag := &cli.StringFlag{Name: "execution-endpoint", Value: ""} + set.String(ExecutionEndpointFlag.Name, "", "") context := cli.NewContext(&app, set, nil) // with nothing set - require.NoError(t, ExpandSingleEndpointIfFile(context, HTTPWeb3ProviderFlag)) - require.Equal(t, "", context.String(HTTPWeb3ProviderFlag.Name)) + require.NoError(t, ExpandSingleEndpointIfFile(context, ExecutionEndpointFlag)) + require.Equal(t, "", context.String(ExecutionEndpointFlag.Name)) // with url scheme - require.NoError(t, context.Set(HTTPWeb3ProviderFlag.Name, "http://localhost:8545")) - require.NoError(t, ExpandSingleEndpointIfFile(context, HTTPWeb3ProviderFlag)) - require.Equal(t, "http://localhost:8545", context.String(HTTPWeb3ProviderFlag.Name)) + require.NoError(t, context.Set(ExecutionEndpointFlag.Name, "http://localhost:8545")) + require.NoError(t, ExpandSingleEndpointIfFile(context, ExecutionEndpointFlag)) + require.Equal(t, "http://localhost:8545", context.String(ExecutionEndpointFlag.Name)) // relative user home path usr, err := user.Current() require.NoError(t, err) - require.NoError(t, context.Set(HTTPWeb3ProviderFlag.Name, "~/relative/path.ipc")) - require.NoError(t, ExpandSingleEndpointIfFile(context, HTTPWeb3ProviderFlag)) - require.Equal(t, usr.HomeDir+"/relative/path.ipc", context.String(HTTPWeb3ProviderFlag.Name)) + require.NoError(t, context.Set(ExecutionEndpointFlag.Name, "~/relative/path.ipc")) + require.NoError(t, ExpandSingleEndpointIfFile(context, ExecutionEndpointFlag)) + require.Equal(t, usr.HomeDir+"/relative/path.ipc", context.String(ExecutionEndpointFlag.Name)) // current dir path curentdir, err := os.Getwd() require.NoError(t, err) - require.NoError(t, context.Set(HTTPWeb3ProviderFlag.Name, "./path.ipc")) - require.NoError(t, ExpandSingleEndpointIfFile(context, HTTPWeb3ProviderFlag)) - require.Equal(t, curentdir+"/path.ipc", context.String(HTTPWeb3ProviderFlag.Name)) + require.NoError(t, context.Set(ExecutionEndpointFlag.Name, "./path.ipc")) + require.NoError(t, ExpandSingleEndpointIfFile(context, ExecutionEndpointFlag)) + require.Equal(t, curentdir+"/path.ipc", context.String(ExecutionEndpointFlag.Name)) }