Merge remote-tracking branch 'pokt/main' into refactor/consolidate-p2p-modules

* pokt/main:
  [Utility][Persistence][Savepoints/Rollbacks] Refactor UtilityContext into UtilityUnitOfWork (Issue #563) (#577)
  [Consensus] Add Quorum Certificate to the block (#593)
  docs(wiki): ValueError: Duplicate wiki path: devlog/template (#620)
  Remove unused import
  [Infra][P2P] Bug: "address not found in peerstore" error in localnet_debug_client when scaling up Localnet - Issue #604 (#611)
  [CLI][Localnet][Bug] - [localnet_client_debug] Error 137 - Issue #607 (#608)
  [Documentation] Fix links to RPC module docs in README (#603)

Author: bryanchriswhite

.github/workflows/changelog-verify.yml

@@ -61,7 +61,7 @@ jobs:
             const result = `<!-- validate_changelogs_review -->The changelog validation failed with the following output:
 
             \`\`\`
-            ${{ needs.validate.outputs.all }}
+            ${{ fromJSON(needs.validate.outputs.all) }}
             \`\`\`
 
             Please update the relevant CHANGELOG.md files and ensure they follow the correct format.`;

Makefile

@@ -116,6 +116,7 @@ develop_start: ## Run all of the make commands necessary to develop on the proje
 		make go_clean_deps && \
 		make mockgen && \
 		make generate_rpc_openapi && \
+		make refresh_debug_keybase && \
 		make build
 
 .PHONY: develop_test
@@ -218,6 +219,10 @@ docker_loki_install: docker_check ## Installs the loki docker driver
 docker_loki_check:
 	if [ `docker plugin ls | grep loki: | wc -l` -eq 0 ]; then make docker_loki_install; fi
 
+.PHONY: refresh_debug_keybase
+refresh_debug_keybase: ## Refreshes the debug keybase with the latest keys from the private_keys.yaml file if necessary
+	go run build/debug_keybase/main.go ./build/localnet/manifests/private-keys.yaml ./build/debug_keybase
+
 .PHONY: clean_mocks
 clean_mocks: ## Use `clean_mocks` to delete mocks before recreating them. Also useful to cleanup code that was generated from a different branch
 	$(eval modules_dir = "shared/modules")

README.md

@@ -44,7 +44,7 @@ If you'd like to contribute to the Pocket V1 Protocol, start by:
 - [Persistence Architecture](persistence/docs/README.md)
 - [P2P Architecture](p2p/README.md)
 - [APP Architecture](app/client/doc/README.md)
-- [RPC Architecture](app/pocket/rpc/doc/README.md)
+- [RPC Architecture](rpc/doc/README.md)
 - [Node binary Architecture](app/pocket/doc/README.md)
 
 ### Changelogs
@@ -55,7 +55,7 @@ If you'd like to contribute to the Pocket V1 Protocol, start by:
 - [Persistence Changelog](persistence/docs/CHANGELOG.md)
 - [P2P Changelog](p2p/CHANGELOG.md)
 - [APP Changelog](app/client/doc/CHANGELOG.md)
-- [RPC Changelog](app/pocket/rpc/doc/CHANGELOG.md)
+- [RPC Changelog](rpc/doc/CHANGELOG.md)
 - [Node binary Changelog](app/pocket/doc/CHANGELOG.md)
 
 - _Coming Soon: Telemetry Changelog_

app/client/cli/debug.go

@@ -223,15 +223,15 @@ func broadcastDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage)
 
 	pstore, err := fetchPeerstore(cmd)
 	if err != nil {
-		logger.Global.Fatal().Msg("Unable to retrieve the pstore")
+		logger.Global.Fatal().Err(err).Msg("Unable to retrieve the pstore")
 	}
 	for _, val := range pstore.GetPeerList() {
 		addr := val.GetAddress()
 		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")
+			logger.Global.Error().Err(err).Msg("Failed to send debug message")
 		}
 	}
 
@@ -246,7 +246,7 @@ func sendDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 
 	pstore, err := fetchPeerstore(cmd)
 	if err != nil {
-		logger.Global.Fatal().Msg("Unable to retrieve the pstore")
+		logger.Global.Fatal().Err(err).Msg("Unable to retrieve the pstore")
 	}
 
 	var validatorAddress []byte
@@ -261,7 +261,7 @@ func sendDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 	}
 
 	if err := p2pMod.Send(validatorAddress, anyProto); err != nil {
-		logger.Global.Fatal().Err(err).Msg("Failed to send debug message")
+		logger.Global.Error().Err(err).Msg("Failed to send debug message")
 	}
 }
 
@@ -286,5 +286,22 @@ func fetchPeerstore(cmd *cobra.Command) (typesP2P.Peerstore, error) {
 	if err != nil {
 		return nil, fmt.Errorf("retrieving peerstore at height %d", height)
 	}
-	return pstore, err
+	// Inform the client's main P2P that a the blockchain is at a new height so it can, if needed, update its view of the validator set
+	err = sendConsensusNewHeightEventToP2PModule(height, bus)
+	if err != nil {
+		return nil, errors.New("sending consensus new height event")
+	}
+	return pstore, nil
+}
+
+// sendConsensusNewHeightEventToP2PModule mimicks the consensus module sending a ConsensusNewHeightEvent to the p2p module
+// This is necessary because the debug client is not a validator and has no consensus module but it has to update the peerstore
+// depending on the changes in the validator set.
+// TODO(#613): Make the debug client mimic a full node.
+func sendConsensusNewHeightEventToP2PModule(height uint64, bus modules.Bus) error {
+	newHeightEvent, err := messaging.PackMessage(&messaging.ConsensusNewHeightEvent{Height: height})
+	if err != nil {
+		logger.Global.Fatal().Err(err).Msg("Failed to pack consensus new height event")
+	}
+	return bus.GetP2PModule().HandleEvent(newHeightEvent.Content)
 }

app/client/keybase/debug/keystore.go

@@ -3,27 +3,17 @@
 package debug
 
 import (
-	"fmt"
+	"io/ioutil"
 	"os"
+	"path/filepath"
 
-	"github.com/korovkin/limiter"
+	"github.com/dgraph-io/badger/v3"
 	"github.com/pokt-network/pocket/app/client/keybase"
 	"github.com/pokt-network/pocket/build"
 	"github.com/pokt-network/pocket/logger"
-	cryptoPocket "github.com/pokt-network/pocket/shared/crypto"
-	"gopkg.in/yaml.v2"
 )
 
-const (
-	// NOTE: This is the number of validators in the private-keys.yaml manifest file
-	numValidators      = 999
-	debugKeybaseSuffix = "/.pocket/keys"
-
-	// Increasing this number is linearly proportional to the amount of RAM required for the debug client to start and import
-	// pre-generated keys into the keybase. Beware that might cause OOM and process can exit with 137 status code.
-	// 4 threads takes 350-400MiB from a few tests which sounds acceptable.
-	debugKeybaseImportConcurrencyLimit = 4
-)
+const debugKeybaseSuffix = "/.pocket/keys"
 
 var (
 	// TODO: Allow users to override this value via `datadir` flag or env var or config file
@@ -45,81 +35,17 @@ func init() {
 }
 
 func initializeDebugKeybase() error {
-	var (
-		validatorKeysPairMap map[string]string
-		err                  error
-	)
-
-	validatorKeysPairMap, err = parseValidatorPrivateKeysFromEmbeddedYaml()
-
-	if err != nil {
-		return err
-	}
-
 	// Create/Open the keybase at `$HOME/.pocket/keys`
 	kb, err := keybase.NewKeybase(debugKeybasePath)
 	if err != nil {
 		return err
 	}
 	db := kb.GetBadgerDB()
 
-	// Add the keys if the keybase contains less than 999
-	curAddr, _, err := kb.GetAll()
-	if err != nil {
+	if err := restoreBadgerDB(build.DebugKeybaseBackup, db); err != nil {
 		return err
 	}
 
-	// Add validator addresses if not present
-	if len(curAddr) < numValidators {
-		logger.Global.Debug().Msgf(fmt.Sprintf("Debug keybase initializing... Adding %d validator keys to the keybase", numValidators-len(curAddr)))
-
-		// Use writebatch to speed up bulk insert
-		wb := db.NewWriteBatch()
-
-		// Create a channel to receive errors from goroutines
-		errCh := make(chan error, numValidators)
-
-		limit := limiter.NewConcurrencyLimiter(debugKeybaseImportConcurrencyLimit)
-
-		for _, privHexString := range validatorKeysPairMap {
-			limit.Execute(func() {
-				// Import the keys into the keybase with no passphrase or hint as these are for debug purposes
-				keyPair, err := cryptoPocket.CreateNewKeyFromString(privHexString, "", "")
-				if err != nil {
-					errCh <- err
-					return
-				}
-
-				// Use key address as key in DB
-				addrKey := keyPair.GetAddressBytes()
-
-				// Encode KeyPair into []byte for value
-				keypairBz, err := keyPair.Marshal()
-				if err != nil {
-					errCh <- err
-					return
-				}
-				if err := wb.Set(addrKey, keypairBz); err != nil {
-					errCh <- err
-					return
-				}
-			})
-		}
-
-		limit.WaitAndClose()
-
-		// Check if any goroutines returned an error
-		select {
-		case err := <-errCh:
-			return err
-		default:
-		}
-
-		if err := wb.Flush(); err != nil {
-			return err
-		}
-	}
-
 	// Close DB connection
 	if err := kb.Stop(); err != nil {
 		return err
@@ -128,24 +54,31 @@ func initializeDebugKeybase() error {
 	return nil
 }
 
-// parseValidatorPrivateKeysFromEmbeddedYaml fetches the validator private keys from the embedded build/localnet/manifests/private-keys.yaml manifest file.
-func parseValidatorPrivateKeysFromEmbeddedYaml() (map[string]string, error) {
+func restoreBadgerDB(backupData []byte, db *badger.DB) error {
+	logger.Global.Debug().Msg("Debug keybase initializing... Restoring from the embedded backup file...")
 
-	// Parse the YAML file and load into the config struct
-	var config struct {
-		ApiVersion string            `yaml:"apiVersion"`
-		Kind       string            `yaml:"kind"`
-		MetaData   map[string]string `yaml:"metadata"`
-		Type       string            `yaml:"type"`
-		StringData map[string]string `yaml:"stringData"`
+	// Create a temporary directory to store the backup data
+	tempDir, err := ioutil.TempDir("", "badgerdb-restore")
+	if err != nil {
+		return err
 	}
-	if err := yaml.Unmarshal(build.PrivateKeysFile, &config); err != nil {
-		return nil, err
+	defer os.RemoveAll(tempDir)
+
+	// Write the backup data to a file in the temporary directory
+	backupFilePath := filepath.Join(tempDir, "backup")
+	if err := ioutil.WriteFile(backupFilePath, backupData, 0644); err != nil {
+		return err
 	}
-	validatorKeysMap := make(map[string]string)
 
-	for id, privHexString := range config.StringData {
-		validatorKeysMap[id] = privHexString
+	backupFile, err := os.Open(backupFilePath)
+	if err != nil {
+		return err
 	}
-	return validatorKeysMap, nil
+	defer backupFile.Close()
+
+	if err := db.Load(backupFile, 4); err != nil {
+		return err
+	}
+
+	return nil
 }

app/docs/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.5] - 2023-03-24
+
+- The debug CLI now updates its peerstore mimicking the behavior of the validators via `sendConsensusNewHeightEventToP2PModule`.
+
+## [0.0.0.4] - 2023-03-24
+
+- Updated debug keystore initialization to use an embedded backup instead of the yaml file that has to be rehydrated every time.
+
 ## [0.0.0.3] - 2023-03-20
 
 - Adds message routing type field labels to debug CLI actions

build/debug.go

@@ -4,13 +4,13 @@ package build
 
 import _ "embed"
 
-// PrivateKeysFile is the pre-generated manifest file for LocalNet debugging
+// DebugKeybaseBackup is a backup of the pre-loaded debug keybase sourced from the manifest file for LocalNet debugging
 //
-//go:embed localnet/manifests/private-keys.yaml
-var PrivateKeysFile []byte
+//go:embed debug_keybase/debug_keybase.bak
+var DebugKeybaseBackup []byte
 
 func init() {
-	if len(PrivateKeysFile) == 0 {
-		panic("PrivateKeysFile is empty")
+	if len(DebugKeybaseBackup) == 0 {
+		panic("DebugKeybaseBackup is empty")
 	}
 }

build/debug_keybase/cedffe1d784ca397062169b565abc056.md5

@@ -0,0 +1 @@
+This file is used to check if the keybase dump is in sync with the YAML file. Its name is the MD5 hash of the private_keys.yaml