[Utility] Local Proof of Stake CLI - CLI and RPC client [part 1/2] - Issue #112

.github/workflows/main.yml

@@ -48,8 +48,8 @@ jobs:
           version: ${{ env.PROTOC_VERSION }}
       - name: install cli dependencies
         run: make install_cli_deps
-      - name: generate protobufs and mocks
-        run: make protogen_local && make mockgen
+      - name: generate protobufs, RPC server, RPC client and mocks
+        run: make protogen_local && make mockgen && make generate_rpc_openapi
       - name: run all tests
         run: make test_all_with_json
       - name: Annotate tests on GitHub

.gitignore

@@ -52,5 +52,9 @@ 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
+build/config/gen*.json

Makefile

@@ -79,6 +79,15 @@ go_protoc-go-inject-tag:
 	fi; \
 	}
 
+.PHONY: go_oapi-codegen
+### Checks if oapi-codegen is installed
+go_oapi-codegen:
+	{ \
+	if ! command -v oapi-codegen >/dev/null; then \
+		echo "Install with 'go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.11.0'"; \
+	fi; \
+	}
+
 .PHONY: go_clean_deps
 ## Runs `go mod tidy` && `go mod vendor`
 go_clean_deps:
@@ -95,21 +104,27 @@ gofmt:
 	gofmt -w -s .
 
 .PHONY: install_cli_deps
-## Installs `protoc-gen-go` and `mockgen`
+## Installs `protoc-gen-go`, `mockgen`, 'protoc-go-inject-tag' and other tooling
 install_cli_deps:
 	go install "google.golang.org/protobuf/cmd/protoc-gen-go@v1.28" && protoc-gen-go --version
 	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"
+
+.PHONY: develop_start
+## Run all of the make commands necessary to develop on the project
+develop_start:
+		make protogen_clean && make protogen_local && \
+		make go_clean_deps && \
+		make mockgen && \
+		make generate_rpc_openapi
 
 .PHONY: develop_test
 ## Run all of the make commands necessary to develop on the project and verify the tests pass
 develop_test: docker_check
-		make go_clean_deps && \
-		make mockgen && \
-		make protogen_clean && make protogen_local && \
+		make develop_start && \
 		make test_all
 
-
 .PHONY: client_start
 ## Run a client daemon which is only used for debugging purposes
 client_start: docker_check
@@ -118,7 +133,7 @@ client_start: docker_check
 .PHONY: client_connect
 ## Connect to the running client debugging daemon
 client_connect: docker_check
-	docker exec -it client /bin/bash -c "go run app/client/*.go"
+	docker exec -it client /bin/bash -c "go run -tags=debug app/client/*.go debug"
 
 .PHONY: build_and_watch
 ## Continous build Pocket's main entrypoint as files change
@@ -242,6 +257,21 @@ protogen_docker_m1: docker_check
 protogen_docker: docker_check
 	docker build -t pocket/proto-generator -f ./build/Dockerfile.proto . && docker run -it -v $(CWD)/:/usr/src/app/ pocket/proto-generator
 
+.PHONY: generate_rpc_openapi
+## (Re)generates the RPC server and client infra code from the openapi spec file (./rpc/v1/openapi.yaml)
+generate_rpc_openapi: go_oapi-codegen
+	oapi-codegen  --config ./rpc/server.gen.config.yml ./rpc/v1/openapi.yaml > ./rpc/server.gen.go
+	oapi-codegen  --config ./rpc/client.gen.config.yml ./rpc/v1/openapi.yaml > ./rpc/client.gen.go
+	echo "OpenAPI client and server generated"
+
+.PHONY: generate_cli_commands_docs
+### (Re)generates the CLI commands docs (this is meant to be called by CI)
+generate_cli_commands_docs:
+	$(eval cli_docs_dir = "app/client/cli/doc/commands")
+	rm ${cli_docs_dir}/*.md >/dev/null 2>&1 || true
+	cd app/client/cli/docgen && go run .
+	echo "CLI commands docs generated in ${cli_docs_dir}"
+
 .PHONY: test_all
 ## Run all go unit tests
 test_all: # generate_mocks

app/client/cli/account.go

@@ -0,0 +1,76 @@
+package cli
+
+import (
+	"fmt"
+
+	"github.com/pokt-network/pocket/shared/crypto"
+	"github.com/pokt-network/pocket/utility/types"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	accounCmd := NewAccountCommand()
+	accounCmd.Flags().StringVar(&pwd, "pwd", "", "passphrase used by the cmd, non empty usage bypass interactive prompt")
+	rootCmd.AddCommand(accounCmd)
+}
+
+func NewAccountCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "Account",
+		Short:   "Account specific commands",
+		Aliases: []string{"account"},
+		Args:    cobra.ExactArgs(0),
+	}
+
+	cmd.AddCommand(accountCommands()...)
+
+	return cmd
+}
+
+func accountCommands() []*cobra.Command {
+	cmds := []*cobra.Command{
+		{
+			Use:     "Send <fromAddr> <to> <amount>",
+			Short:   "Send <fromAddr> <to> <amount>",
+			Long:    "Sends <amount> to address <to> from address <fromAddr>",
+			Aliases: []string{"send"},
+			Args:    cobra.ExactArgs(3), // REFACTOR(#150): <fromAddr> not being used at the moment. Update once a keybase is implemented.
+			RunE: func(cmd *cobra.Command, args []string) error {
+				// TODO(#150): update when we have keybase
+				pk, err := readEd25519PrivateKeyFromFile(privateKeyFilePath)
+				if err != nil {
+					return err
+				}
+				// NOTE: since we don't have a keybase yet (tracked in #150), we are currently inferring the `fromAddr` from the PrivateKey supplied via the flag `--path_to_private_key_file`
+				// the following line is commented out to show that once we have a keybase, `fromAddr` should come from the command arguments and not the PrivateKey (pk) anymore.
+				//
+				// fromAddr := crypto.AddressFromString(args[0])
+				toAddr := crypto.AddressFromString(args[1])
+				amount := args[2]
+
+				msg := &types.MessageSend{
+					FromAddress: pk.Address(),
+					ToAddress:   toAddr,
+					Amount:      amount,
+				}
+
+				tx, err := prepareTxJson(msg, pk)
+				if err != nil {
+					return err
+				}
+
+				resp, err := postRawTx(cmd.Context(), pk, tx)
+				if err != nil {
+					return err
+				}
+
+				// DISCUSS(#310): define UX for return values - should we return the raw response or a parsed/human readable response? For now, I am simply printing to stdout
+				fmt.Printf("HTTP status code: %d\n", resp.StatusCode())
+				fmt.Println(string(resp.Body))
+
+				return nil
+			},
+		},
+	}
+	return cmds
+}