[Client] [Tooling] refactor: CLI

Makefile

@@ -155,7 +155,7 @@ rebuild_client_start: docker_check ## Rebuild and run a client daemon which is o
 
 .PHONY: client_connect
 client_connect: docker_check ## Connect to the running client debugging daemon
-	docker exec -it client /bin/bash -c "POCKET_P2P_IS_CLIENT_ONLY=true go run -tags=debug app/client/*.go debug"
+	docker exec -it client /bin/bash -c "POCKET_P2P_IS_CLIENT_ONLY=true go run -tags=debug app/client/*.go debug --remote_cli_url=http://validator1:50832"
 
 .PHONY: build_and_watch
 build_and_watch: ## Continous build Pocket's main entrypoint as files change
@@ -510,7 +510,7 @@ localnet_up: ## Starts up a k8s LocalNet with all necessary dependencies (tl;dr
 
 .PHONY: localnet_client_debug
 localnet_client_debug: ## Opens a `client debug` cli to interact with blockchain (e.g. change pacemaker mode, reset to genesis, etc). Though the node binary updates automatiacally on every code change (i.e. hot reloads), if client is already open you need to re-run this command to execute freshly compiled binary.
-	kubectl exec -it deploy/dev-cli-client --container pocket -- p1 debug
+	kubectl exec -it deploy/dev-cli-client --container pocket -- p1 debug --remote_cli_url http://pocket-validators:50832
 
 .PHONY: localnet_shell
 localnet_shell: ## Opens a shell in the pod that has the `client` cli available. The binary updates automatically whenever the code changes (i.e. hot reloads).

app/client/cli/account.go

@@ -3,9 +3,11 @@ package cli
 import (
 	"fmt"
 
+	"github.com/spf13/cobra"
+
+	"github.com/pokt-network/pocket/app/client/cli/flags"
 	"github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/utility/types"
-	"github.com/spf13/cobra"
 )
 
 func init() {
@@ -48,7 +50,7 @@ func accountCommands() []*cobra.Command {
 					return err
 				}
 
-				if !nonInteractive {
+				if !flags.NonInteractive {
 					pwd = readPassphrase(pwd)
 				}
 

app/client/cli/actor.go

@@ -6,10 +6,12 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/spf13/cobra"
+
+	"github.com/pokt-network/pocket/app/client/cli/flags"
 	coreTypes "github.com/pokt-network/pocket/shared/core/types"
 	"github.com/pokt-network/pocket/shared/crypto"
 	typesUtil "github.com/pokt-network/pocket/utility/types"
-	"github.com/spf13/cobra"
 )
 
 func init() {
@@ -100,7 +102,7 @@ If no changes are desired for the parameter, just enter the current param value
 				return err
 			}
 
-			if !nonInteractive {
+			if !flags.NonInteractive {
 				pwd = readPassphrase(pwd)
 			}
 
@@ -169,7 +171,7 @@ func newEditStakeCmd(cmdDef actorCmdDef) *cobra.Command {
 				return err
 			}
 
-			if !nonInteractive {
+			if !flags.NonInteractive {
 				pwd = readPassphrase(pwd)
 			}
 
@@ -233,7 +235,7 @@ func newUnstakeCmd(cmdDef actorCmdDef) *cobra.Command {
 				return err
 			}
 
-			if !nonInteractive {
+			if !flags.NonInteractive {
 				pwd = readPassphrase(pwd)
 			}
 			pk, err := kb.GetPrivKey(fromAddrHex, pwd)
@@ -284,7 +286,7 @@ func newUnpauseCmd(cmdDef actorCmdDef) *cobra.Command {
 				return err
 			}
 
-			if !nonInteractive {
+			if !flags.NonInteractive {
 				pwd = readPassphrase(pwd)
 			}
 

app/client/cli/cmd.go

@@ -2,40 +2,43 @@ package cli
 
 import (
 	"context"
+	"log"
 
-	"github.com/pokt-network/pocket/runtime/configs"
-	"github.com/pokt-network/pocket/runtime/defaults"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+
+	"github.com/pokt-network/pocket/app/client/cli/flags"
+	"github.com/pokt-network/pocket/runtime/configs"
+	"github.com/pokt-network/pocket/runtime/defaults"
 )
 
 const (
 	cliExecutableName = "p1"
 )
 
 var (
-	remoteCLIURL   string
-	dataDir        string
-	configPath     string
-	nonInteractive bool
-	verbose        bool
-	cfg            *configs.Config
+	cfg *configs.Config
 )
 
 func init() {
-	rootCmd.PersistentFlags().StringVar(&remoteCLIURL, "remote_cli_url", defaults.DefaultRemoteCLIURL, "takes a remote endpoint in the form of <protocol>://<host> (uses RPC Port)")
-	rootCmd.PersistentFlags().BoolVar(&nonInteractive, "non_interactive", false, "if true skips the interactive prompts wherever possible (useful for scripting & automation)")
+	rootCmd.PersistentFlags().StringVar(&flags.RemoteCLIURL, "remote_cli_url", defaults.DefaultRemoteCLIURL, "takes a remote endpoint in the form of <protocol>://<host>:<port> (uses RPC Port)")
+	// ensure that this flag can be overidden by the respective viper-conventional environment variable (i.e. `POCKET_REMOTE_CLI_URL`)
+	if err := viper.BindPFlag("remote_cli_url", rootCmd.PersistentFlags().Lookup("remote_cli_url")); err != nil {
+		log.Fatalf("could not bind flag %q: %v", "remote_cli_url", err)
+	}
+
+	rootCmd.PersistentFlags().BoolVar(&flags.NonInteractive, "non_interactive", false, "if true skips the interactive prompts wherever possible (useful for scripting & automation)")
 
 	// TECHDEBT: Why do we have a data dir when we have a config path if the data dir is only storing keys?
-	rootCmd.PersistentFlags().StringVar(&dataDir, "data_dir", defaults.DefaultRootDirectory, "Path to store pocket related data (keybase etc.)")
-	rootCmd.PersistentFlags().StringVar(&configPath, "config", "", "Path to config")
+	rootCmd.PersistentFlags().StringVar(&flags.DataDir, "data_dir", defaults.DefaultRootDirectory, "Path to store pocket related data (keybase etc.)")
+	rootCmd.PersistentFlags().StringVar(&flags.ConfigPath, "config", "", "Path to config")
 	if err := viper.BindPFlag("root_directory", rootCmd.PersistentFlags().Lookup("data_dir")); err != nil {
-		panic(err)
+		log.Fatalf("could not bind flag %q: %v", "data_dir", err)
 	}
 
-	rootCmd.PersistentFlags().BoolVar(&verbose, "verbose", false, "Show verbose output")
+	rootCmd.PersistentFlags().BoolVar(&flags.Verbose, "verbose", false, "Show verbose output")
 	if err := viper.BindPFlag("verbose", rootCmd.PersistentFlags().Lookup("verbose")); err != nil {
-		panic(err)
+		log.Fatalf("could not bind flag %q: %v", "verbose", err)
 	}
 }
 
@@ -45,7 +48,7 @@ var rootCmd = &cobra.Command{
 	Long:  "The CLI is meant to be an user but also a machine friendly way for interacting with Pocket Network.",
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		// by this time, the config path should be set
-		cfg = configs.ParseConfig(configPath)
+		cfg = configs.ParseConfig(flags.ConfigPath)
 		return nil
 	},
 }

app/client/cli/consensus.go

@@ -2,9 +2,10 @@ package cli
 
 import (
 	"fmt"
+	"github.com/spf13/cobra"
 
+	"github.com/pokt-network/pocket/app/client/cli/flags"
 	"github.com/pokt-network/pocket/rpc"
-	"github.com/spf13/cobra"
 )
 
 func init() {
@@ -96,7 +97,7 @@ func consensusCommands() []*cobra.Command {
 }
 
 func getConsensusState(cmd *cobra.Command) (*rpc.GetV1ConsensusStateResponse, error) {
-	client, err := rpc.NewClientWithResponses(remoteCLIURL)
+	client, err := rpc.NewClientWithResponses(flags.RemoteCLIURL)
 	if err != nil {
 		return nil, nil
 	}

app/client/cli/debug.go

@@ -6,19 +6,16 @@ import (
 	"os"
 
 	"github.com/manifoldco/promptui"
+	"github.com/spf13/cobra"
+	"google.golang.org/protobuf/types/known/anypb"
+
+	"github.com/pokt-network/pocket/app/client/cli/helpers"
 	"github.com/pokt-network/pocket/logger"
-	"github.com/pokt-network/pocket/p2p"
 	"github.com/pokt-network/pocket/p2p/providers/current_height_provider"
-	rpcCHP "github.com/pokt-network/pocket/p2p/providers/current_height_provider/rpc"
 	"github.com/pokt-network/pocket/p2p/providers/peerstore_provider"
-	rpcABP "github.com/pokt-network/pocket/p2p/providers/peerstore_provider/rpc"
 	typesP2P "github.com/pokt-network/pocket/p2p/types"
-	"github.com/pokt-network/pocket/runtime"
-	"github.com/pokt-network/pocket/runtime/defaults"
 	"github.com/pokt-network/pocket/shared/messaging"
 	"github.com/pokt-network/pocket/shared/modules"
-	"github.com/spf13/cobra"
-	"google.golang.org/protobuf/types/known/anypb"
 )
 
 // TECHDEBT: Lowercase variables / constants that do not need to be exported.
@@ -33,9 +30,6 @@ const (
 )
 
 var (
-	// A P2P module is initialized in order to broadcast a message to the local network
-	p2pMod modules.P2PModule
-
 	items = []string{
 		PromptPrintNodeState,
 		PromptTriggerNextView,
@@ -45,28 +39,12 @@ var (
 		PromptSendMetadataRequest,
 		PromptSendBlockRequest,
 	}
-
-	genesisPath string = runtime.GetEnv("GENESIS_PATH", "build/config/genesis.json")
-	rpcHost     string
 )
 
-// NOTE: this is required by the linter, otherwise a simple string constant would have been enough
-type cliContextKey string
-
-const busCLICtxKey = "bus"
-
 func init() {
 	dbg := NewDebugCommand()
 	dbg.AddCommand(NewDebugSubCommands()...)
 	rootCmd.AddCommand(dbg)
-
-	// by default, we point at the same endpoint used by the CLI but the debug client is used either in docker-compose of K8S, therefore we cater for overriding
-	validator1Endpoint := defaults.Validator1EndpointDockerCompose
-	if runtime.IsProcessRunningInsideKubernetes() {
-		validator1Endpoint = defaults.Validator1EndpointK8S
-	}
-
-	rpcHost = runtime.GetEnv("RPC_HOST", validator1Endpoint)
 }
 
 // NewDebugSubCommands builds out the list of debug subcommands by matching the
@@ -77,10 +55,8 @@ func NewDebugSubCommands() []*cobra.Command {
 	commands := make([]*cobra.Command, len(items))
 	for idx, promptItem := range items {
 		commands[idx] = &cobra.Command{
-			Use: promptItem,
-			PersistentPreRun: func(cmd *cobra.Command, args []string) {
-				persistentPreRun(cmd, args)
-			},
+			Use:               promptItem,
+			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
 			Run: func(cmd *cobra.Command, args []string) {
 				handleSelect(cmd, cmd.Use)
 			},
@@ -93,70 +69,11 @@ func NewDebugSubCommands() []*cobra.Command {
 // NewDebugCommand returns the cobra CLI for the Debug command.
 func NewDebugCommand() *cobra.Command {
 	return &cobra.Command{
-		Use:   "debug",
-		Short: "Debug utility for rapid development",
-		Args:  cobra.MaximumNArgs(0),
-		PersistentPreRun: func(cmd *cobra.Command, args []string) {
-			persistentPreRun(cmd, args)
-		},
-		RunE: runDebug,
-	}
-}
-
-// persistentPreRun is called by both debug and debug sub-commands before runs
-func persistentPreRun(cmd *cobra.Command, _ []string) {
-	// TECHDEBT: this is to keep backwards compatibility with localnet
-	configPath = runtime.GetEnv("CONFIG_PATH", "build/config/config.validator1.json")
-	rpcURL := fmt.Sprintf("http://%s:%s", rpcHost, defaults.DefaultRPCPort)
-
-	runtimeMgr := runtime.NewManagerFromFiles(
-		configPath, genesisPath,
-		runtime.WithClientDebugMode(),
-		runtime.WithRandomPK(),
-	)
-
-	bus := runtimeMgr.GetBus()
-	setValueInCLIContext(cmd, busCLICtxKey, bus)
-
-	setupPeerstoreProvider(*runtimeMgr, rpcURL)
-	setupCurrentHeightProvider(*runtimeMgr, rpcURL)
-	setupAndStartP2PModule(*runtimeMgr)
-}
-
-func setupPeerstoreProvider(rm runtime.Manager, rpcURL string) {
-	bus := rm.GetBus()
-	modulesRegistry := bus.GetModulesRegistry()
-	pstoreProvider := rpcABP.NewRPCPeerstoreProvider(
-		rpcABP.WithP2PConfig(rm.GetConfig().P2P),
-		rpcABP.WithCustomRPCURL(rpcURL),
-	)
-	modulesRegistry.RegisterModule(pstoreProvider)
-}
-
-func setupCurrentHeightProvider(rm runtime.Manager, rpcURL string) {
-	bus := rm.GetBus()
-	modulesRegistry := bus.GetModulesRegistry()
-	currentHeightProvider := rpcCHP.NewRPCCurrentHeightProvider(
-		rpcCHP.WithCustomRPCURL(rpcURL),
-	)
-	modulesRegistry.RegisterModule(currentHeightProvider)
-}
-
-func setupAndStartP2PModule(rm runtime.Manager) {
-	bus := rm.GetBus()
-	mod, err := p2p.Create(bus)
-	if err != nil {
-		logger.Global.Fatal().Err(err).Msg("Failed to create p2p module")
-	}
-
-	var ok bool
-	p2pMod, ok = mod.(modules.P2PModule)
-	if !ok {
-		logger.Global.Fatal().Msgf("unexpected P2P module type: %T", mod)
-	}
-
-	if err := p2pMod.Start(); err != nil {
-		logger.Global.Fatal().Err(err).Msg("Failed to start p2p module")
+		Use:               "debug",
+		Short:             "Debug utility for rapid development",
+		Args:              cobra.MaximumNArgs(0),
+		PersistentPreRunE: helpers.P2PDependenciesPreRunE,
+		RunE:              runDebug,
 	}
 }
 
@@ -269,7 +186,7 @@ func broadcastDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage)
 		if err != nil {
 			logger.Global.Fatal().Err(err).Msg("Failed to convert validator address into pocketCrypto.Address")
 		}
-		if err := p2pMod.Send(addr, anyProto); err != nil {
+		if err := helpers.P2PMod.Send(addr, anyProto); err != nil {
 			logger.Global.Error().Err(err).Msg("Failed to send debug message")
 		}
 	}
@@ -299,14 +216,14 @@ func sendDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 		logger.Global.Fatal().Err(err).Msg("Failed to convert validator address into pocketCrypto.Address")
 	}
 
-	if err := p2pMod.Send(validatorAddress, anyProto); err != nil {
+	if err := helpers.P2PMod.Send(validatorAddress, anyProto); err != nil {
 		logger.Global.Error().Err(err).Msg("Failed to send debug message")
 	}
 }
 
 // fetchPeerstore retrieves the providers from the CLI context and uses them to retrieve the address book for the current height
 func fetchPeerstore(cmd *cobra.Command) (typesP2P.Peerstore, error) {
-	bus, ok := getValueFromCLIContext[modules.Bus](cmd, busCLICtxKey)
+	bus, ok := helpers.GetValueFromCLIContext[modules.Bus](cmd, helpers.BusCLICtxKey)
 	if !ok || bus == nil {
 		return nil, errors.New("retrieving bus from CLI context")
 	}

app/client/cli/flags/flags.go

@@ -0,0 +1,24 @@
+package flags
+
+var (
+	// RemoveCLIURL is the URL of the remote RPC node which the CLI will interact with.
+	// Formatted as <protocol>://<host>:<port> (uses RPC Port).
+	// (see: --help the root command for more info).
+	RemoteCLIURL string
+
+	// DataDir a path to store pocket related data (keybase etc.).
+	// (see: --help the root command for more info).
+	DataDir string
+
+	// ConfigPath is the path to the node config file.
+	// (see: --help the root command for more info).
+	ConfigPath string
+
+	// If true skips the interactive prompts wherever possible (useful for scripting & automation)
+	// (see: --help the root command for more info).
+	NonInteractive bool
+
+	// Show verbose output
+	// (see: --help the root command for more info).
+	Verbose bool
+)