flag loader required param refactoring

Author: tclemos

cmd/cdk/cdk.go

@@ -88,7 +88,7 @@ var CDKCmd = &cobra.Command{
 	Short: "Utilities for interacting with CDK networks",
 	Long:  "Basic utility commands for interacting with the cdk contracts",
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		cdkInputArgs.rpcURL, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
+		cdkInputArgs.rpcURL = flag_loader.GetRpcUrlFlagValue(cmd)
 	},
 	Args: cobra.NoArgs,
 }

cmd/dumpblocks/dumpblocks.go

@@ -56,7 +56,7 @@ var DumpblocksCmd = &cobra.Command{
 	Short: "Export a range of blocks from a JSON-RPC endpoint.",
 	Long:  usage,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcUrlFlagValue, _ := flag_loader.GetRpcUrlFlagValue(cmd, false)
+		rpcUrlFlagValue := flag_loader.GetRpcUrlFlagValue(cmd)
 		inputDumpblocks.RpcUrl = *rpcUrlFlagValue
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {

cmd/ecrecover/ecrecover.go

@@ -33,7 +33,7 @@ var EcRecoverCmd = &cobra.Command{
 	Long:  usage,
 	Args:  cobra.NoArgs,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcUrlFlagValue, _ := flag_loader.GetRpcUrlFlagValue(cmd, false)
+		rpcUrlFlagValue := flag_loader.GetRpcUrlFlagValue(cmd)
 		rpcUrl = *rpcUrlFlagValue
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {

cmd/fixnoncegap/fixnoncegap.go

@@ -27,8 +27,8 @@ var FixNonceGapCmd = &cobra.Command{
 	Args:  cobra.NoArgs,
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		var err error
-		inputFixNonceGapArgs.rpcURL, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
-		inputFixNonceGapArgs.privateKey, err = flag_loader.GetPrivateKeyFlagValue(cmd, true)
+		inputFixNonceGapArgs.rpcURL = flag_loader.GetRpcUrlFlagValue(cmd)
+		inputFixNonceGapArgs.privateKey, err = flag_loader.GetRequiredPrivateKeyFlagValue(cmd)
 		if err != nil {
 			return err
 		}

cmd/flag_loader/flag_loader.go

@@ -7,12 +7,27 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func GetRpcUrlFlagValue(cmd *cobra.Command, required bool) (*string, error) {
-	return getFlagValue(cmd, "rpc-url", "ETH_RPC_URL", required)
+const (
+	rpcUrlFlagName, rpcUrlEnvVar         = "rpc-url", "ETH_RPC_URL"
+	privateKeyFlagName, privateKeyEnvVar = "private-key", "PRIVATE_KEY"
+)
+
+func GetRpcUrlFlagValue(cmd *cobra.Command) *string {
+	v, _ := getFlagValue(cmd, rpcUrlFlagName, rpcUrlEnvVar, false)
+	return v
+}
+
+func GetRequiredRpcUrlFlagValue(cmd *cobra.Command) (*string, error) {
+	return getFlagValue(cmd, rpcUrlFlagName, rpcUrlEnvVar, true)
+}
+
+func GetPrivateKeyFlagValue(cmd *cobra.Command) *string {
+	v, _ := getFlagValue(cmd, privateKeyFlagName, privateKeyEnvVar, false)
+	return v
 }
 
-func GetPrivateKeyFlagValue(cmd *cobra.Command, required bool) (*string, error) {
-	return getFlagValue(cmd, "private-key", "PRIVATE_KEY", required)
+func GetRequiredPrivateKeyFlagValue(cmd *cobra.Command) (*string, error) {
+	return getFlagValue(cmd, privateKeyFlagName, privateKeyEnvVar, true)
 }
 
 func getFlagValue(cmd *cobra.Command, flagName, envVarName string, required bool) (*string, error) {

cmd/fund/cmd.go

@@ -46,8 +46,8 @@ var FundCmd = &cobra.Command{
 	Short: "Bulk fund crypto wallets automatically.",
 	Long:  usage,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		params.RpcUrl, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
-		params.PrivateKey, _ = flag_loader.GetPrivateKeyFlagValue(cmd, false)
+		params.RpcUrl = flag_loader.GetRpcUrlFlagValue(cmd)
+		params.PrivateKey = flag_loader.GetPrivateKeyFlagValue(cmd)
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {
 		return checkFlags()

cmd/loadtest/app.go

@@ -168,8 +168,8 @@ var LoadtestCmd = &cobra.Command{
 	Long:  loadtestUsage,
 	Args:  cobra.NoArgs,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		inputLoadTestParams.RPCUrl, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
-		inputLoadTestParams.PrivateKey, _ = flag_loader.GetPrivateKeyFlagValue(cmd, false)
+		inputLoadTestParams.RPCUrl = flag_loader.GetRpcUrlFlagValue(cmd)
+		inputLoadTestParams.PrivateKey = flag_loader.GetPrivateKeyFlagValue(cmd)
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {
 		zerolog.DurationFieldUnit = time.Second

cmd/monitor/cmd.go

@@ -58,7 +58,7 @@ var MonitorCmd = &cobra.Command{
 	Args:         cobra.NoArgs,
 	SilenceUsage: true,
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-		rpcUrlFlagValue, _ := flag_loader.GetRpcUrlFlagValue(cmd, false)
+		rpcUrlFlagValue := flag_loader.GetRpcUrlFlagValue(cmd)
 		rpcUrl = *rpcUrlFlagValue
 		// By default, hide logs from `polycli monitor`.
 		verbosityFlag := cmd.Flag("verbosity")

cmd/nodekey/nodekey.go

@@ -67,7 +67,7 @@ var NodekeyCmd = &cobra.Command{
 	Short: "Generate node keys for different blockchain clients and protocols.",
 	Long:  usage,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		inputNodeKeyPrivateKey, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
+		inputNodeKeyPrivateKey = flag_loader.GetRpcUrlFlagValue(cmd)
 	},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		var nko nodeKeyOut

cmd/rpcfuzz/cmd.go

@@ -40,8 +40,8 @@ var RPCFuzzCmd = &cobra.Command{
 	Long:  usage,
 	Args:  cobra.NoArgs,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcUrl, _ = flag_loader.GetRpcUrlFlagValue(cmd, false)
-		testPrivateHexKey, _ = flag_loader.GetPrivateKeyFlagValue(cmd, false)
+		rpcUrl = flag_loader.GetRpcUrlFlagValue(cmd)
+		testPrivateHexKey = flag_loader.GetPrivateKeyFlagValue(cmd)
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {
 		return checkFlags()