KISS Peer discovery, KISS Bootstrapping, Nodes auto-stake/unstake via K8S cluster-manager, Node Finite state machine - Issues #416, #490, #429, #498, #499

Makefile

@@ -305,6 +305,11 @@ generate_cli_commands_docs: ## (Re)generates the CLI commands docs (this is mean
 	cd app/client/cli/docgen && go run .
 	echo "CLI commands docs generated in ${cli_docs_dir}"
 
+.PHONY: generate_node_state_machine_diagram
+generate_node_state_machine_diagram: ## (Re)generates the Node State Machine diagram
+	go run ./state_machine/visualizer/main.go
+	echo "Node State Machine diagram generated in state_machine/docs/state-machine.diagram.md"
+
 .PHONY: test_all
 test_all: ## Run all go unit tests
 	go test -p 1 -count=1 ./...
@@ -477,6 +482,11 @@ localnet_down: ## Stops LocalNet and cleans up dependencies (tl;dr `tilt down` +
 	tilt down --file=build/localnet/Tiltfile
 	kubectl delete pvc --ignore-not-found=true data-dependencies-postgresql-0
 
+.PHONY: localnet_db_cli
+localnet_db_cli: ## Open a CLI to the local containerized postgres instancedb_cli:
+	echo "View schema by running 'SELECT schema_name FROM information_schema.schemata;'"
+	kubectl exec -it services/dependencies-postgresql -- bash -c "psql postgresql://postgres:LocalNetPassword@localhost"
+
 .PHONY: check_cross_module_imports
 check_cross_module_imports: ## Lists cross-module imports
 	$(eval exclude_common=--exclude=Makefile --exclude-dir=shared --exclude-dir=app --exclude-dir=runtime)

app/client/cli/actor.go

@@ -108,9 +108,10 @@ If no changes are desired for the parameter, just enter the current param value
 			chains := strings.Split(rawChains, ",")
 			serviceURI := args[3]
 
-			// TODO (team): passphrase is currently not used since there's no keybase yet, the prompt is here to mimick the real world UX
-			pwd = readPassphrase(pwd)
-
+			if !notInteractive {
+				// TODO(#484): passphrase is currently not used since there's no keybase yet, the prompt is here to mimick the real world UX
+				pwd = readPassphrase(pwd)
+			}
 			msg := &typesUtil.MessageStake{
 				PublicKey:     pk.PublicKey().Bytes(),
 				Chains:        chains,
@@ -209,8 +210,9 @@ func newUnstakeCmd(cmdDef actorCmdDef) *cobra.Command {
 			}
 
 			// TODO (team): passphrase is currently not used since there's no keybase yet, the prompt is here to mimick the real world UX
-			pwd = readPassphrase(pwd)
-
+			if !notInteractive {
+				pwd = readPassphrase(pwd)
+			}
 			msg := &typesUtil.MessageUnstake{
 				Address:   pk.Address(),
 				Signer:    pk.Address(),

app/client/cli/cmd.go

@@ -12,11 +12,13 @@ const cliExecutableName = "client"
 var (
 	remoteCLIURL       string
 	privateKeyFilePath string
+	notInteractive     bool
 )
 
 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().StringVar(&privateKeyFilePath, "path_to_private_key_file", "./pk.json", "Path to private key to use when signing")
+	rootCmd.PersistentFlags().BoolVar(&notInteractive, "not_interactive", false, "if true skips the interactive prompts wherever possible (useful for scripting)")
 }
 
 var rootCmd = &cobra.Command{

app/client/cli/debug.go

@@ -1,16 +1,18 @@
 package cli
 
 import (
+	"context"
 	"os"
 
 	"github.com/manifoldco/promptui"
 	"github.com/pokt-network/pocket/logger"
 	"github.com/pokt-network/pocket/p2p"
-	debugABP "github.com/pokt-network/pocket/p2p/providers/addrbook_provider/debug"
-	debugCHP "github.com/pokt-network/pocket/p2p/providers/current_height_provider/debug"
+	"github.com/pokt-network/pocket/p2p/providers/addrbook_provider"
+	rpcABP "github.com/pokt-network/pocket/p2p/providers/addrbook_provider/rpc"
+	"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/types"
 	"github.com/pokt-network/pocket/runtime"
-	coreTypes "github.com/pokt-network/pocket/shared/core/types"
-	pocketCrypto "github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/shared/messaging"
 	"github.com/pokt-network/pocket/shared/modules"
 	"github.com/spf13/cobra"
@@ -44,15 +46,17 @@ var (
 		PromptSendBlockRequest,
 	}
 
-	// validators holds the list of the validators at genesis time so that we can use it to create a debug address book provider.
-	// Its purpose is to allow the CLI to "discover" the nodes in the network. Since currently we don't have churn and we run nodes only in LocalNet, we can rely on the genesis state.
-	// HACK(#416): This is a temporary solution that guarantees backward compatibility while we implement peer discovery
-	validators []*coreTypes.Actor
-
 	configPath  string = getEnv("CONFIG_PATH", "build/config/config1.json")
 	genesisPath string = getEnv("GENESIS_PATH", "build/config/genesis.json")
 )
 
+type ctxKey int
+
+const (
+	addrBookProviderCtxKey ctxKey = iota
+	currentHeightProviderCtxKey
+)
+
 func getEnv(key, defaultValue string) string {
 	if value, ok := os.LookupEnv(key); ok {
 		return value
@@ -71,24 +75,26 @@ func NewDebugCommand() *cobra.Command {
 		Short: "Debug utility for rapid development",
 		Args:  cobra.ExactArgs(0),
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
-			runtimeMgr := runtime.NewManagerFromFiles(configPath, genesisPath, runtime.WithClientDebugMode(), runtime.WithRandomPK())
-
-			// HACK(#416): this is a temporary solution that guarantees backward compatibility while we implement peer discovery.
-			validators = runtimeMgr.GetGenesis().Validators
+			runtimeMgr := runtime.NewManagerFromFiles(
+				configPath, genesisPath,
+				runtime.WithClientDebugMode(),
+				runtime.WithRandomPK(),
+			)
 
-			debugAddressBookProvider := debugABP.NewDebugAddrBookProvider(
-				runtimeMgr.GetConfig().P2P,
-				debugABP.WithActorsByHeight(
-					map[int64][]*coreTypes.Actor{
-						debugABP.ANY_HEIGHT: validators,
-					},
+			modulesRegistry := runtimeMgr.GetBus().GetModulesRegistry()
+			addressBookProvider := rpcABP.NewRPCAddrBookProvider(
+				rpcABP.WithP2PConfig(
+					runtimeMgr.GetConfig().P2P,
 				),
 			)
+			modulesRegistry.RegisterModule(addressBookProvider)
+			cmd.SetContext(context.WithValue(cmd.Context(), addrBookProviderCtxKey, addressBookProvider))
 
-			debugCurrentHeightProvider := debugCHP.NewDebugCurrentHeightProvider(0)
+			currentHeightProvider := rpcCHP.NewRPCCurrentHeightProvider()
+			modulesRegistry.RegisterModule(currentHeightProvider)
+			cmd.SetContext(context.WithValue(cmd.Context(), currentHeightProviderCtxKey, currentHeightProvider))
 
-			// TODO(#429): refactor injecting the dependencies into the bus so that they can be consumed in an updated `P2PModule.Create()` implementation
-			p2pM, err := p2p.CreateWithProviders(runtimeMgr.GetBus(), debugAddressBookProvider, debugCurrentHeightProvider)
+			p2pM, err := p2p.Create(runtimeMgr.GetBus())
 			if err != nil {
 				logger.Global.Fatal().Err(err).Msg("Failed to create p2p module")
 			}
@@ -105,7 +111,7 @@ func NewDebugCommand() *cobra.Command {
 func runDebug(cmd *cobra.Command, args []string) (err error) {
 	for {
 		if selection, err := promptGetInput(); err == nil {
-			handleSelect(selection)
+			handleSelect(cmd, selection)
 		} else {
 			return err
 		}
@@ -133,57 +139,57 @@ func promptGetInput() (string, error) {
 	return result, nil
 }
 
-func handleSelect(selection string) {
+func handleSelect(cmd *cobra.Command, selection string) {
 	switch selection {
 	case PromptResetToGenesis:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_RESET_TO_GENESIS,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	case PromptPrintNodeState:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_PRINT_NODE_STATE,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	case PromptTriggerNextView:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_TRIGGER_NEXT_VIEW,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	case PromptTogglePacemakerMode:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_TOGGLE_PACE_MAKER_MODE,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	case PromptShowLatestBlockInStore:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_SHOW_LATEST_BLOCK_IN_STORE,
 			Message: nil,
 		}
-		sendDebugMessage(m)
+		sendDebugMessage(cmd, m)
 	case PromptSendMetadataRequest:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_METADATA_REQ,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	case PromptSendBlockRequest:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_BLOCK_REQ,
 			Message: nil,
 		}
-		broadcastDebugMessage(m)
+		broadcastDebugMessage(cmd, m)
 	default:
 		logger.Global.Error().Msg("Selection not yet implemented...")
 	}
 }
 
 // Broadcast to the entire validator set
-func broadcastDebugMessage(debugMsg *messaging.DebugMessage) {
+func broadcastDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 	anyProto, err := anypb.New(debugMsg)
 	if err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to create Any proto")
@@ -192,33 +198,40 @@ func broadcastDebugMessage(debugMsg *messaging.DebugMessage) {
 	// TODO(olshansky): Once we implement the cleanup layer in RainTree, we'll be able to use
 	// broadcast. The reason it cannot be done right now is because this client is not in the
 	// address book of the actual validator nodes, so `node1.consensus` never receives the message.
-	// p2pMod.Broadcast(anyProto, messaging.PocketTopic_DEBUG_TOPIC)
+	// p2pMod.Broadcast(anyProto)
 
-	for _, valAddr := range validators {
-		addr, err := pocketCrypto.NewAddress(valAddr.GetAddress())
+	addrBook, err := fetchAddressBook(cmd)
+	for _, val := range addrBook {
+		addr := val.Address
 		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 {
 			logger.Global.Fatal().Err(err).Msg("Failed to send debug message")
 		}
 	}
+
 }
 
 // Send to just a single (i.e. first) validator in the set
-func sendDebugMessage(debugMsg *messaging.DebugMessage) {
+func sendDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 	anyProto, err := anypb.New(debugMsg)
 	if err != nil {
 		logger.Global.Error().Err(err).Msg("Failed to create Any proto")
 	}
 
+	addrBook, err := fetchAddressBook(cmd)
+	if err != nil {
+		logger.Global.Fatal().Msg("Unable to retrieve the addrBook")
+	}
+
 	var validatorAddress []byte
-	if len(validators) == 0 {
+	if len(addrBook) == 0 {
 		logger.Global.Fatal().Msg("No validators found")
 	}
 
 	// if the message needs to be broadcast, it'll be handled by the business logic of the message handler
-	validatorAddress, err = pocketCrypto.NewAddress(validators[0].GetAddress())
+	validatorAddress = addrBook[0].Address
 	if err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to convert validator address into pocketCrypto.Address")
 	}
@@ -227,3 +240,16 @@ func sendDebugMessage(debugMsg *messaging.DebugMessage) {
 		logger.Global.Fatal().Err(err).Msg("Failed to send debug message")
 	}
 }
+
+// fetchAddressBook retrieves the providers from the CLI context and uses them to retrieve the address book for the current height
+func fetchAddressBook(cmd *cobra.Command) (types.AddrBook, error) {
+	addrBookProvider := cmd.Context().Value(addrBookProviderCtxKey)
+	currentHeightProvider := cmd.Context().Value(currentHeightProviderCtxKey)
+
+	height := currentHeightProvider.(current_height_provider.CurrentHeightProvider).CurrentHeight()
+	addrBook, err := addrBookProvider.(addrbook_provider.AddrBookProvider).GetStakedAddrBookAtHeight(height)
+	if err != nil {
+		logger.Global.Fatal().Msg("Unable to retrieve the addrBook")
+	}
+	return addrBook, err
+}

app/client/doc/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.12] - 2023-02-10
+
+- Added `not_interactive` flag to allow for non-interactive `Stake` and `Unstake` transactions (dogfooding in `cluster-manager`)
+- Updated CLI to use to source the address book and the current height from the RPC server leveraging the `rpcAddressBookProvider` and `rpcCurrentHeightProvider` respectively and the `bus` for dependency injection
+
 ## [0.0.0.11] - 2023-02-09
 
 - Added debugging prompts to drive state sync requests

app/pocket/doc/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.5] - 2023-02-10
+
+- Updated to handle `bootstrap-nodes` flag that can be used to override the default bootstrap nodes
+
 ## [0.0.0.4] - 2023-02-07
 
 - Added GITHUB_WIKI tags where it was missing

app/pocket/main.go

@@ -12,6 +12,7 @@ import (
 func main() {
 	configFilename := flag.String("config", "", "Relative or absolute path to the config file.")
 	genesisFilename := flag.String("genesis", "", "Relative or absolute path to the genesis file.")
+	bootstrapNodes := flag.String("bootstrap-nodes", "", "Comma separated list of bootstrap nodes.")
 
 	v := flag.Bool("version", false, "")
 	flag.Parse()
@@ -21,7 +22,12 @@ func main() {
 		return
 	}
 
-	runtimeMgr := runtime.NewManagerFromFiles(*configFilename, *genesisFilename)
+	options := []func(*runtime.Manager){}
+	if bootstrapNodes != nil && *bootstrapNodes != "" {
+		options = append(options, runtime.WithCustomBootstrapNodes(*bootstrapNodes))
+	}
+
+	runtimeMgr := runtime.NewManagerFromFiles(*configFilename, *genesisFilename, options...)
 	bus, err := runtime.CreateBus(runtimeMgr)
 	if err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to create bus")