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

Makefile

@@ -87,7 +87,6 @@ go_oapi-codegen:
 		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:
@@ -251,6 +250,7 @@ protogen_local: go_protoc-go-inject-tag
 	protoc --go_opt=paths=source_relative  -I=./p2p/raintree/types/proto  --go_out=./p2p/types          	./p2p/raintree/types/proto/*.proto  --experimental_allow_proto3_optional
 	protoc --go_opt=paths=source_relative  -I=./p2p/types/proto           --go_out=./p2p/types          	./p2p/types/proto/*.proto           --experimental_allow_proto3_optional
 	protoc --go_opt=paths=source_relative  -I=./telemetry/proto           --go_out=./telemetry          	./telemetry/proto/*.proto           --experimental_allow_proto3_optional
+	protoc --go_opt=paths=source_relative  -I=./rpc/types/proto 		  --go_out=./rpc/types          	./rpc/types/proto/*.proto           --experimental_allow_proto3_optional
 	echo "View generated proto files by running: make protogen_show"
 
 .PHONY: protogen_docker_m1
@@ -270,7 +270,12 @@ generate_rpc_openapi: go_oapi-codegen
 	oapi-codegen  --config ./rpc/client.gen.config.yml ./rpc/v1/openapi.yaml > ./rpc/client.gen.go
 	echo "OpenAPI client and server generated"
 
+## Starts a local Swagger UI instance for the RPC API
+swagger-ui:
+	echo "Attempting to start Swagger UI at http://localhost:8080\n\n"
+	docker run -p 8080:8080 -e SWAGGER_JSON=/v1/openapi.yaml -v $(shell pwd)/rpc/v1:/v1 swaggerapi/swagger-ui
 .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")
@@ -285,12 +290,12 @@ test_all: # generate_mocks
 
 .PHONY: test_all_with_json
 ## Run all go unit tests, output results in json file
-test_all_with_json: # generate_mocks
+test_all_with_json: generate_rpc_openapi # generate_mocks
 	go test -p 1 -json ./... > test_results.json
 
 .PHONY: test_all_with_coverage
 ## Run all go unit tests, output results & coverage into files
-test_all_with_coverage: # generate_mocks
+test_all_with_coverage: generate_rpc_openapi # generate_mocks
 	go test -p 1 -v ./... -covermode=count -coverprofile=coverage.out
 	go tool cover -func=coverage.out -o=coverage.out
 

app/app.go

@@ -0,0 +1,5 @@
+package app
+
+var (
+	AppVersion = "v0.0.1-pre-alpha.1" // this can be injected at build time with something like: go build -ldflags "-X github.com/pokt-network/pocket/app.AppVersion=v1.0.1" ./app/pocket
+)

app/pocket/doc/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this module 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.0] - 2022-11-02
+
+### Added
+
+- Added the simplest form of feature flagging for the RPC server functionality
+- Calling the RPC server entrypoint in a goroutine if enabled

app/pocket/doc/README.md

@@ -0,0 +1,32 @@
+# Node binary
+
+The node binary is essentially the program that executes the node logic along with its supporting functions like for example the RPC server.
+
+The spirit of the documentation is to continuously update and inform the reader of the general scope of the node binary as breaking, rapid development occurs.
+
+## Flags
+
+Currently, in order to run the node, it's necessary to provide at least two flags:
+
+- `config`: Relative or absolute path to the config file
+- `genesis`: Relative or absolute path to the genesis file.
+
+### Example
+
+```bash
+pocket -config ./config.json -genesis ./genesis.json
+```
+
+## Configuration
+
+The configuration file provides a structured way for configuring various aspects of the node and how it should behave functionally.
+
+Things like "should the RPC server be enabled?", "what port should it be listening to?" are all defined in the config file.
+
+For a detailed overview of all the possible settings, please review `RuntimeMgr` at [README.md](../../../runtime/docs/README.md).
+
+## Genesis
+
+The genesis file contains the initial state (aka genesis) of the blockchain associated with each module. Feel free to dive into the specific modules and their genesis-specific types for more information.
+
+For a detailed overview of all the possible settings, please look in the `RuntimeMgr` [README.md](../../../runtime/docs/README.md).

app/pocket/main.go

@@ -4,13 +4,11 @@ import (
 	"flag"
 	"log"
 
-	"github.com/benbjohnson/clock"
+	"github.com/pokt-network/pocket/app"
+	"github.com/pokt-network/pocket/runtime"
 	"github.com/pokt-network/pocket/shared"
 )
 
-// See `docs/build/README.md` for details on how this is injected via mage.
-var version = "UNKNOWN"
-
 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.")
@@ -19,10 +17,13 @@ func main() {
 	flag.Parse()
 
 	if *v {
-		log.Printf("Version flag currently unused %s\n", version)
+		log.Printf("Version flag currently unused %s\n", app.AppVersion)
 		return
 	}
-	pocketNode, err := shared.Create(*configFilename, *genesisFilename, clock.New())
+
+	runtimeMgr := runtime.NewManagerFromFiles(*configFilename, *genesisFilename)
+
+	pocketNode, err := shared.CreateNode(runtimeMgr)
 	if err != nil {
 		log.Fatalf("Failed to create pocket node: %s", err)
 	}

build/config/config1.json

@@ -31,5 +31,10 @@
     "enabled": true,
     "address": "0.0.0.0:9000",
     "endpoint": "/metrics"
+  },
+  "rpc": {
+    "enabled": true,
+    "port": "50832",
+    "timeout": 30000
   }
 }

build/config/config2.json

@@ -31,5 +31,10 @@
     "enabled": true,
     "address": "0.0.0.0:9000",
     "endpoint": "/metrics"
+  },
+  "rpc": {
+    "enabled": true,
+    "port": "50832",
+    "timeout": 30000
   }
 }

build/config/config3.json

@@ -31,5 +31,10 @@
     "enabled": true,
     "address": "0.0.0.0:9000",
     "endpoint": "/metrics"
+  },
+  "rpc": {
+    "enabled": true,
+    "port": "50832",
+    "timeout": 30000
   }
 }

build/config/config4.json

@@ -31,5 +31,10 @@
     "enabled": true,
     "address": "0.0.0.0:9000",
     "endpoint": "/metrics"
+  },
+  "rpc": {
+    "enabled": true,
+    "port": "50832",
+    "timeout": 30000
   }
 }

build/deployments/docker-compose.yaml

@@ -35,10 +35,12 @@ services:
       - "8080"
       - "9080"
       - "9000"
+      - "50832"
     ports:
       - "7081:7081"
       - "8081:8080"
       - "9081:9080"
+      - "50832:50832"
     volumes:
       - ${PWD}:/go/src/github.com/pocket-network
     # Needed for DLV debugging
@@ -61,10 +63,12 @@ services:
       - "8080"
       - "9080"
       - "9000"
+      - "50832"
     ports:
       - "7082:7082"
       - "8082:8080"
       - "9082:9080"
+      - "50833:50832"
     volumes:
       - ${PWD}:/go/src/github.com/pocket-network
     # Needed for DLV debugging
@@ -87,10 +91,12 @@ services:
       - "8080"
       - "9080"
       - "9000"
+      - "50832"
     ports:
       - "7083:7083"
       - "8083:8080"
       - "9083:9080"
+      - "50834:50832"
     volumes:
       - ${PWD}:/go/src/github.com/pocket-network
     # Needed for DLV debugging
@@ -113,10 +119,12 @@ services:
       - "8080"
       - "9080"
       - "9000"
+      - "50832"
     ports:
       - "7084:7084"
       - "8084:8080"
       - "9084:9080"
+      - "50835:50832"
     volumes:
       - ${PWD}:/go/src/github.com/pocket-network
     # Needed for DLV debugging

consensus/consensus_tests/utils_test.go

@@ -141,8 +141,9 @@ func CreateTestConsensusPocketNode(
 	p2pMock := baseP2PMock(t, testChannel)
 	utilityMock := baseUtilityMock(t, testChannel)
 	telemetryMock := baseTelemetryMock(t, testChannel)
+	rpcMock := baseRpcMock(t, testChannel)
 
-	bus, err := shared.CreateBus(runtimeMgr, persistenceMock, p2pMock, utilityMock, consensusMod.(modules.ConsensusModule), telemetryMock)
+	bus, err := shared.CreateBus(runtimeMgr, persistenceMock, p2pMock, utilityMock, consensusMod.(modules.ConsensusModule), telemetryMock, rpcMock)
 	require.NoError(t, err)
 
 	pk, err := cryptoPocket.NewPrivateKey(runtimeMgr.GetConfig().GetBaseConfig().GetPrivateKey())
@@ -394,6 +395,15 @@ func baseTelemetryMock(t *testing.T, _ modules.EventsChannel) *modulesMock.MockT
 	return telemetryMock
 }
 
+func baseRpcMock(t *testing.T, _ modules.EventsChannel) *modulesMock.MockRPCModule {
+	ctrl := gomock.NewController(t)
+	rpcMock := modulesMock.NewMockRPCModule(ctrl)
+	rpcMock.EXPECT().Start().Return(nil).AnyTimes()
+	rpcMock.EXPECT().SetBus(gomock.Any()).Return().AnyTimes()
+
+	return rpcMock
+}
+
 func baseTelemetryTimeSeriesAgentMock(t *testing.T) *modulesMock.MockTimeSeriesAgent {
 	ctrl := gomock.NewController(t)
 	timeSeriesAgentMock := modulesMock.NewMockTimeSeriesAgent(ctrl)

consensus/leader_election/module.go

@@ -8,7 +8,7 @@ import (
 )
 
 const (
-	LeaderElectionModuleName = "leader_election"
+	leaderElectionModuleName = "leader_election"
 )
 
 type LeaderElectionModule interface {
@@ -40,7 +40,7 @@ func (m *leaderElectionModule) Stop() error {
 }
 
 func (m *leaderElectionModule) GetModuleName() string {
-	return LeaderElectionModuleName
+	return leaderElectionModuleName
 }
 
 func (m *leaderElectionModule) SetBus(pocketBus modules.Bus) {

consensus/module.go

@@ -18,7 +18,7 @@ import (
 
 const (
 	DefaultLogPrefix    = "NODE" // TODO(#164): Make implicit when logging is standardized
-	ConsensusModuleName = "consensus"
+	consensusModuleName = "consensus"
 )
 
 var (
@@ -181,7 +181,7 @@ func (m *consensusModule) Stop() error {
 }
 
 func (m *consensusModule) GetModuleName() string {
-	return ConsensusModuleName
+	return consensusModuleName
 }
 
 func (m *consensusModule) GetBus() modules.Bus {
@@ -198,6 +198,7 @@ func (m *consensusModule) SetBus(pocketBus modules.Bus) {
 }
 
 func (*consensusModule) ValidateConfig(cfg modules.Config) error {
+	// TODO (#334): implement this
 	return nil
 }
 
@@ -259,6 +260,14 @@ func (m *consensusModule) CurrentHeight() uint64 {
 	return m.Height
 }
 
+func (m *consensusModule) CurrentRound() uint64 {
+	return m.Round
+}
+
+func (m *consensusModule) CurrentStep() uint64 {
+	return uint64(m.Step)
+}
+
 func (m *consensusModule) ValidatorMap() modules.ValidatorMap { // TODO: This needs to be dynamically updated during various operations and network changes.
 	return typesCons.ValidatorMapToModulesValidatorMap(m.validatorMap)
 }

consensus/pacemaker.go

@@ -13,7 +13,7 @@ import (
 )
 
 const (
-	PacemakerModuleName = "pacemaker"
+	pacemakerModuleName = "pacemaker"
 )
 
 type Pacemaker interface {
@@ -93,7 +93,7 @@ func (p *paceMaker) Stop() error {
 }
 
 func (p *paceMaker) GetModuleName() string {
-	return PacemakerModuleName
+	return pacemakerModuleName
 }
 
 func (m *paceMaker) SetBus(pocketBus modules.Bus) {

go.mod

@@ -83,6 +83,7 @@ require (
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/go-openapi/jsonpointer v0.19.5 // indirect
 	github.com/go-openapi/swag v0.19.5 // indirect
+	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/invopop/yaml v0.1.0 // indirect
 	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
@@ -110,6 +111,7 @@ require (
 	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
 	golang.org/x/sys v0.0.0-20221013171732-95e765b1cc43 // indirect
 	golang.org/x/text v0.3.8 // indirect
+	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
 	golang.org/x/tools v0.1.12 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect

go.sum

@@ -156,6 +156,8 @@ github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRx
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
+github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
+github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/glog v1.0.0 h1:nfP3RFugxnNRyKgeWd4oI1nYvXpxrx8ck8ZrcizshdQ=
 github.com/golang/glog v1.0.0/go.mod h1:EWib/APOK0SL3dFbYqvxE3UYd8E6s1ouQ7iEp/0LWV4=
@@ -711,6 +713,8 @@ golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
+golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 h1:Hir2P/De0WpUhtrKGGjvSb2YxUgyZ7EFOSLIcSSpiwE=
+golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=

p2p/module.go

@@ -18,7 +18,7 @@ import (
 var _ modules.P2PModule = &p2pModule{}
 
 const (
-	P2PModuleName = "p2p"
+	p2pModuleName = "p2p"
 )
 
 type p2pModule struct {
@@ -82,7 +82,7 @@ func (m *p2pModule) GetBus() modules.Bus {
 }
 
 func (m *p2pModule) GetModuleName() string {
-	return P2PModuleName
+	return p2pModuleName
 }
 
 func (m *p2pModule) Start() error {
@@ -163,6 +163,7 @@ func (m *p2pModule) Send(addr cryptoPocket.Address, msg *anypb.Any, topic debug.
 }
 
 func (*p2pModule) ValidateConfig(cfg modules.Config) error {
+	// TODO (#334): implement this
 	return nil
 }