[Infrastructure] LocalNet on Kubernetes

.gitignore

@@ -34,7 +34,6 @@ shared/modules/mocks/*
 p2p/types/mocks/*
 !p2p/types/mocks/mocks.go
 
-
 # TODO(team): Does the `types` directory contain generated or raw type files?
 # types/
 
@@ -62,9 +61,16 @@ rpc/client.gen.go
 # Ignored generated files by build/config/main.go
 build/config/gen*.json
 
+# Binary downloads and manipulations by helm
+**/charts
+**/tmpcharts
+
 # Ignored generated files by build
 bin/*
 
 # Validator keys used for testing/demoes
 val1.json
-val2.json
+val2.json
+
+# Generated by Tilt (tilt.dev)
+localnet_config.yaml

.tiltignore

@@ -0,0 +1,56 @@
+# Binaries for programs and plugins
+
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Vim swap files
+*.swp**
+
+# Vscode
+.vscode
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# MacOS metadata
+.DS_Store
+
+# Intellij / Goland dot files
+.idea/
+
+# Generated Mocks (for testing)
+shared/modules/mocks/
+p2p/types/mocks/
+
+# TODO(team): Does the `types` directory contain generated or raw type files?
+# types/
+
+# ignore protobuf generated files
+*.pb.go
+
+# Local debugging
+temp_test.go
+
+# Output of the go test results and coverage report (used by CI)
+test_results.json
+coverage.out
+
+# Output of `make build_and_watch`
+main
+
+# generated RPC server and client from openapi.yaml
+rpc/server.gen.go
+rpc/client.gen.go
+
+# Ignored generated files by build/config/main.go
+build/config/gen*.json
+
+# Binary downloads and manipulations by helm
+**/charts
+**/tmpcharts

Makefile

@@ -5,7 +5,7 @@ CWD ?= CURRENT_WORKING_DIRECTIONRY_NOT_SUPPLIED
 # IMPROVE: Add `-shuffle=on` to the `go test` command to randomize the order in which tests are run.
 
 # An easy way to turn off verbose test output for some of the test targets. For example
-#  `$ make test_persistence` by default enables verbose testing
+#  `make test_persistence` by default enables verbose testing
 #  `VERBOSE_TEST="" make test_persistence` is an easy way to run the same tests without verbose output
 VERBOSE_TEST ?= -v
 
@@ -101,6 +101,8 @@ install_cli_deps: ## Installs `protoc-gen-go`, `mockgen`, 'protoc-go-inject-tag'
 	go install "github.com/golang/mock/mockgen@v1.6.0" && mockgen --version
 	go install "github.com/favadi/protoc-go-inject-tag@latest"
 	go install "github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.11.0"
+	curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash
+	curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
 
 .PHONY: develop_start
 develop_start: ## Run all of the make commands necessary to develop on the project
@@ -447,6 +449,31 @@ gen_genesis_and_config: ## Generate the genesis and config files for LocalNet
 clear_genesis_and_config: ## Clear the genesis and config files for LocalNet
 	rm build/config/gen.*.json
 
+.PHONY: localnet_up
+localnet_up: ## Starts up a k8s LocalNet with all necessary dependencies (tl;dr `tilt up`)
+	tilt up --file=build/localnet/Tiltfile
+
+.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/pocket-v1-cli-client -- client debug
+
+.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).
+	kubectl exec -it deploy/pocket-v1-cli-client -- /bin/bash
+
+.PHONY: localnet_logs_validators
+localnet_logs_validators: ## Outputs logs from all validators
+	kubectl logs -l v1-purpose=validator --all-containers=true --tail=-1
+
+.PHONY: localnet_logs_validators_follow
+localnet_logs_validators_follow: ## Outputs logs from all validators and follows them (i.e. tail)
+	kubectl logs -l v1-purpose=validator --all-containers=true --max-log-requests=1000 --tail=-1 -f
+
+.PHONY: localnet_down
+localnet_down: ## Stops LocalNet and cleans up dependencies (tl;dr `tilt down` + postgres database)
+	tilt down --file=build/localnet/Tiltfile
+	kubectl delete pvc --ignore-not-found=true data-dependencies-postgresql-0
+
 .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)

README.md

@@ -24,7 +24,7 @@ If you'd like to contribute to the Pocket V1 Protocol, start by:
 
 <!--
   The list of documents below was created by manually curating the output of the following command:
-    $ find .. -name "*.md" | grep -v -e "vendor" -e "prototype" -e "SUMMARY.md" -e "TASTE.md"
+    find .. -name "*.md" | grep -v -e "vendor" -e "prototype" -e "SUMMARY.md" -e "TASTE.md"
 -->
 
 ### Guides

app/client/cli/debug.go

@@ -24,9 +24,6 @@ const (
 	PromptTriggerNextView        string = "TriggerNextView"
 	PromptTogglePacemakerMode    string = "TogglePacemakerMode"
 	PromptShowLatestBlockInStore string = "ShowLatestBlockInStore"
-
-	defaultConfigPath  = "build/config/config1.json"
-	defaultGenesisPath = "build/config/genesis.json"
 )
 
 var (
@@ -41,12 +38,22 @@ var (
 		PromptShowLatestBlockInStore,
 	}
 
+	defaultConfigPath  = getEnv("CONFIG_PATH", "build/config/config1.json")
+	defaultGenesisPath = getEnv("GENESIS_PATH", "build/config/genesis.json")
+
 	// 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
 )
 
+func getEnv(key, defaultValue string) string {
+	if value, ok := os.LookupEnv(key); ok {
+		return value
+	}
+	return defaultValue
+}
+
 func init() {
 	rootCmd.AddCommand(NewDebugCommand())
 }

app/pocket/docs/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to CLI binaries will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.0.1] - 2023-02-03
+
+- Introduced `CONFIG_PATH` and `GENESIS_PATH` environment variables for debug CLI commands

build/config/config1.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a",
+  "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a"
+    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a",
+    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config2.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2",
+  "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2"
+    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2",
+    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config3.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb",
+  "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb"
+    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb",
+    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config4.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4",
+  "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4"
+    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4",
+    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45",
     "max_mempool_count": 100000
   },
   "telemetry": {