chore: refactor flag_loader

.github/workflows/ci.yml

@@ -179,7 +179,7 @@ jobs:
             sudo apt-get install ethereum
             geth --version
           fi
-      - name: Run loadtest againt ${{ matrix.tool }}
+      - name: Run loadtest against ${{ matrix.tool }}
         run: |
           ${{ matrix.tool }} --version
           make ${{ matrix.tool }} &

cmd/cdk/cdk.go

@@ -11,8 +11,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/0xPolygon/polygon-cli/cmd/flag_loader"
 	"github.com/0xPolygon/polygon-cli/custommarshaller"
+	"github.com/0xPolygon/polygon-cli/flag"
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -44,7 +44,6 @@ import (
 )
 
 const (
-	ArgRpcURL = "rpc-url"
 	ArgForkID = "fork-id"
 
 	ArgRollupManagerAddress = "rollup-manager-address"
@@ -55,7 +54,6 @@ const (
 	ArgBridgeAddress = "bridge-address"
 	ArgGERAddress    = "ger-address"
 
-	defaultRPCURL = "http://localhost:8545"
 	defaultForkId = "12"
 
 	// forks
@@ -106,11 +104,12 @@ var CDKCmd = &cobra.Command{
 	Use:   "cdk",
 	Short: "Utilities for interacting with CDK networks.",
 	Long:  "Basic utility commands for interacting with the cdk contracts.",
-	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcURL := flag_loader.GetRpcUrlFlagValue(cmd)
-		if rpcURL != nil {
-			cdkInputArgs.rpcURL = *rpcURL
+	PersistentPreRunE: func(cmd *cobra.Command, args []string) (err error) {
+		cdkInputArgs.rpcURL, err = flag.GetRPCURL(cmd)
+		if err != nil {
+			return err
 		}
+		return nil
 	},
 	Args: cobra.NoArgs,
 }
@@ -636,7 +635,7 @@ func mustPrintLogs(logs []types.Log, contractInstance reflect.Value, contractABI
 func init() {
 	// cdk
 	f := CDKCmd.PersistentFlags()
-	f.StringVar(&cdkInputArgs.rpcURL, ArgRpcURL, defaultRPCURL, "RPC URL of network containing CDK contracts")
+	f.StringVar(&cdkInputArgs.rpcURL, flag.RPCURL, flag.DefaultRPCURL, "RPC URL of network containing CDK contracts")
 	f.StringVar(&cdkInputArgs.forkID, ArgForkID, defaultForkId, "fork ID of CDK networks")
 	f.StringVar(&cdkInputArgs.rollupManagerAddress, ArgRollupManagerAddress, "", "address of rollup contract")
 

cmd/contract/cmd.go

@@ -8,7 +8,7 @@ import (
 	"math/big"
 	"strings"
 
-	"github.com/0xPolygon/polygon-cli/cmd/flag_loader"
+	"github.com/0xPolygon/polygon-cli/flag"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/ethclient"
@@ -17,9 +17,7 @@ import (
 )
 
 const (
-	ArgRpcURL     = "rpc-url"
-	ArgAddress    = "address"
-	defaultRPCURL = "http://localhost:8545"
+	ArgAddress = "address"
 )
 
 var (
@@ -45,9 +43,12 @@ var Cmd = &cobra.Command{
 	Use:   "contract",
 	Short: "Interact with smart contracts and fetch contract information from the blockchain.",
 	Long:  usage,
-	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcURL := flag_loader.GetRpcUrlFlagValue(cmd)
-		inputArgs.rpcURL = *rpcURL
+	PreRunE: func(cmd *cobra.Command, args []string) (err error) {
+		inputArgs.rpcURL, err = flag.GetRPCURL(cmd)
+		if err != nil {
+			return err
+		}
+		return nil
 	},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return contract(cmd)
@@ -170,8 +171,7 @@ func fetchContractCreationTx(ctx context.Context, client *ethclient.Client, cont
 
 func init() {
 	f := Cmd.Flags()
-	f.StringVar(&inputArgs.rpcURL, ArgRpcURL, defaultRPCURL, "RPC URL of network containing contract")
+	f.StringVar(&inputArgs.rpcURL, flag.RPCURL, flag.DefaultRPCURL, "RPC URL of network containing contract")
 	f.StringVar(&inputArgs.address, ArgAddress, "", "contract address")
-
-	_ = Cmd.MarkFlagRequired(ArgAddress)
+	flag.MarkFlagRequired(Cmd, ArgAddress)
 }

cmd/dumpblocks/dumpblocks.go

@@ -12,7 +12,7 @@ import (
 
 	_ "embed"
 
-	"github.com/0xPolygon/polygon-cli/cmd/flag_loader"
+	"github.com/0xPolygon/polygon-cli/flag"
 	"github.com/0xPolygon/polygon-cli/proto/gen/pb"
 	"github.com/0xPolygon/polygon-cli/rpctypes"
 	"github.com/0xPolygon/polygon-cli/util"
@@ -55,12 +55,12 @@ var DumpblocksCmd = &cobra.Command{
 	Use:   "dumpblocks start end",
 	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)
-		inputDumpblocks.RpcUrl = *rpcUrlFlagValue
-	},
-	PreRunE: func(cmd *cobra.Command, args []string) error {
-		return checkFlags()
+	PreRunE: func(cmd *cobra.Command, args []string) (err error) {
+		inputDumpblocks.RpcUrl, err = flag.GetRPCURL(cmd)
+		if err != nil {
+			return err
+		}
+		return nil
 	},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		ctx := cmd.Context()
@@ -186,7 +186,7 @@ var DumpblocksCmd = &cobra.Command{
 
 func init() {
 	f := DumpblocksCmd.Flags()
-	f.StringVarP(&inputDumpblocks.RpcUrl, "rpc-url", "r", "http://localhost:8545", "the RPC endpoint URL")
+	f.StringVarP(&inputDumpblocks.RpcUrl, flag.RPCURL, "r", flag.DefaultRPCURL, "the RPC endpoint URL")
 	f.UintVarP(&inputDumpblocks.Threads, "concurrency", "c", 1, "how many go routines to leverage")
 	f.BoolVarP(&inputDumpblocks.ShouldDumpBlocks, "dump-blocks", "B", true, "dump blocks to output")
 	f.BoolVar(&inputDumpblocks.ShouldDumpReceipts, "dump-receipts", true, "dump receipts to output")
@@ -196,15 +196,6 @@ func init() {
 	f.StringVarP(&inputDumpblocks.FilterStr, "filter", "F", "{}", "filter output based on tx to and from (not setting a filter means all are allowed)")
 }
 
-func checkFlags() error {
-	// Check rpc url flag.
-	if err := util.ValidateUrl(inputDumpblocks.RpcUrl); err != nil {
-		return err
-	}
-
-	return nil
-}
-
 // writeResponses writes the data to either stdout or a file if one is provided.
 // The message type can be either "block" or "transaction". The format of the
 // output is either "json" or "proto" depending on the mode.

cmd/ecrecover/ecrecover.go

@@ -7,7 +7,7 @@ import (
 	"math/big"
 	"os"
 
-	"github.com/0xPolygon/polygon-cli/cmd/flag_loader"
+	"github.com/0xPolygon/polygon-cli/flag"
 	"github.com/0xPolygon/polygon-cli/util"
 	ethcommon "github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -32,12 +32,12 @@ var EcRecoverCmd = &cobra.Command{
 	Short: "Recovers and returns the public key of the signature.",
 	Long:  usage,
 	Args:  cobra.NoArgs,
-	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		rpcUrlFlagValue := flag_loader.GetRpcUrlFlagValue(cmd)
-		rpcUrl = *rpcUrlFlagValue
-	},
-	PreRunE: func(cmd *cobra.Command, args []string) error {
-		return checkFlags()
+	PreRunE: func(cmd *cobra.Command, args []string) (err error) {
+		rpcUrl, err = flag.GetRPCURL(cmd)
+		if err != nil {
+			return err
+		}
+		return nil
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		ctx := cmd.Context()
@@ -128,21 +128,9 @@ var EcRecoverCmd = &cobra.Command{
 
 func init() {
 	f := EcRecoverCmd.Flags()
-	f.StringVarP(&rpcUrl, "rpc-url", "r", "", "the RPC endpoint URL")
+	f.StringVarP(&rpcUrl, flag.RPCURL, "r", "", "the RPC endpoint URL")
 	f.Uint64VarP(&blockNumber, "block-number", "b", 0, "block number to check the extra data for (default: latest)")
 	f.StringVarP(&filePath, "file", "f", "", "path to a file containing block information in JSON format")
 	f.StringVarP(&txData, "tx", "t", "", "transaction data in hex format")
-
-	// The sources of decoding are mutually exclusive
 	EcRecoverCmd.MarkFlagsMutuallyExclusive("file", "block-number", "tx")
 }
-
-func checkFlags() error {
-	var err error
-	if rpcUrl != "" {
-		if err = util.ValidateUrl(rpcUrl); err != nil {
-			return err
-		}
-	}
-	return err
-}

cmd/fixnoncegap/fixnoncegap.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/0xPolygon/polygon-cli/cmd/flag_loader"
+	"github.com/0xPolygon/polygon-cli/flag"
 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
@@ -25,18 +25,17 @@ var FixNonceGapCmd = &cobra.Command{
 	Short: "Send txs to fix the nonce gap for a specific account.",
 	Long:  fixNonceGapUsage,
 	Args:  cobra.NoArgs,
-	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-		var err error
-		rpcURL := flag_loader.GetRpcUrlFlagValue(cmd)
-		inputFixNonceGapArgs.rpcURL = *rpcURL
-		privateKey, err := flag_loader.GetRequiredPrivateKeyFlagValue(cmd)
+	PreRunE: func(cmd *cobra.Command, args []string) (err error) {
+		inputFixNonceGapArgs.rpcURL, err = flag.GetRPCURL(cmd)
 		if err != nil {
 			return err
 		}
-		inputFixNonceGapArgs.privateKey = *privateKey
-		return nil
+		inputFixNonceGapArgs.privateKey, err = flag.GetRequiredPrivateKey(cmd)
+		if err != nil {
+			return err
+		}
+		return prepareRpcClient(cmd, args)
 	},
-	PreRunE:      prepareRpcClient,
 	RunE:         fixNonceGap,
 	SilenceUsage: true,
 }
@@ -55,10 +54,8 @@ type fixNonceGapArgs struct {
 var inputFixNonceGapArgs = fixNonceGapArgs{}
 
 const (
-	ArgPrivateKey = "private-key"
-	ArgRpcURL     = "rpc-url"
-	ArgReplace    = "replace"
-	ArgMaxNonce   = "max-nonce"
+	ArgReplace  = "replace"
+	ArgMaxNonce = "max-nonce"
 )
 
 //go:embed FixNonceGapUsage.md
@@ -236,8 +233,8 @@ func fixNonceGap(cmd *cobra.Command, args []string) error {
 
 func init() {
 	f := FixNonceGapCmd.Flags()
-	f.StringVarP(&inputFixNonceGapArgs.rpcURL, ArgRpcURL, "r", "http://localhost:8545", "the RPC endpoint URL")
-	f.StringVar(&inputFixNonceGapArgs.privateKey, ArgPrivateKey, "", "private key to be used when sending txs to fix nonce gap")
+	f.StringVarP(&inputFixNonceGapArgs.rpcURL, flag.RPCURL, "r", flag.DefaultRPCURL, "the RPC endpoint URL")
+	f.StringVar(&inputFixNonceGapArgs.privateKey, flag.PrivateKey, "", "private key to be used when sending txs to fix nonce gap")
 	f.BoolVar(&inputFixNonceGapArgs.replace, ArgReplace, false, "replace the existing txs in the pool")
 	f.Uint64Var(&inputFixNonceGapArgs.maxNonce, ArgMaxNonce, 0, "override max nonce value instead of getting it from the pool")
 }