[Utility] Local Proof of Stake CLI - RPC server [part 2/2] - Issue #112 by deblasis · Pull Request #176 · pokt-network/pocket

deblasis · 2022-08-25T12:05:58Z

Description

This PR introduces a simple RPC (JSONRPC) server that will be used to interact with the CLI and/or other clients

Issue

Part of Issue #112 but we decided to split the work in 2 separate PRs

Type of change

Please mark the options that are relevant.

New feature, functionality or library

List of changes

Updated node to start an RPC server if enabled via config

Testing

make test_all
LocalNet w/ all of the steps outlined in the README

Checklist

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have tested my changes using the available tooling
If applicable, I have made corresponding changes to related local or global README
If applicable, I have added new diagrams using mermaid.js
If applicable, I have added tests that prove my fix is effective or that my feature works

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

for CLI/client use

andrewnguyen22

Great start. A few changes requested.

Needs README/CHANGELOG (see the structure of the other modules)

Open separate issue for specification doc

In addition, I'd like to see some tests with this

andrewnguyen22 · 2022-08-30T15:45:10Z

app/app.go

+package app
+
+const (
+	AppVersion = "RC-1.0.0.alpha" // DISCUSS (team): see app/pocket/main.go, one of the two should be a source of truth, potentially replaced at build-time as described in `docs/build/README.md`


@iajrz can you confirm the versioning schema?

I updated here a little while ago: https://github.com/pokt-network/pocket/blob/main/docs/build/README.md#release-tag-versioning.

The currently release is v0.0.1-pre-alpha.1 so we should use that.

@iajrz bump on this

app/client/rpc/http.go

app/client/rpc/routing.go

app/client/rpc/handlers.go

app/client/rpc/server.go

build/config/config1.json

shared/config/defaults.go

Olshansk

Took a first round of review over everything and left a couple of open-ended comments.

Similar to the other PR, I think the scope and functionality of this PR is great once we tend to the outstanding items.

Olshansk · 2022-09-03T18:47:33Z

app/app.go

+package app
+
+const (
+	AppVersion = "RC-1.0.0.alpha" // DISCUSS (team): see app/pocket/main.go, one of the two should be a source of truth, potentially replaced at build-time as described in `docs/build/README.md`


cc @okdas for context

Olshansk · 2022-09-03T23:08:12Z

app/client/rpc/handlers.go

@@ -0,0 +1,56 @@
+package rpc


Out of interest (since I haven't done my research), what drove the usage of these libraries/design?

V0? Ignite? Some other project? Is this just the standard way of doing thing?

KISS and wanting to show where I was going fast by using mostly a codebase (V0) that you guys already are familiar with but that I don't know much about.

It's easy to switch library while I learn more about the requirements.
For example, you mentioned that it would be nice to have the ability to generate the RPC server code starting from an openAPI specification.

I am going to simplify the codebase quite a bit and also implement this nice feature (along with the Makefile command to generate/regenerate the server code whenever we'll update the spec).

The next update of this PR tomorrow will have this too together with the fixes suggested by you guys, for which I thank you both obviously.

Sneak peek:

app/client/rpc/handlers.go

build/config/config1.json

shared/tests/utility_module/transaction_test.go

app/client/rpc/http.go

app/client/rpc/routing.go

RPC server refactoring with code generation from openapi spec

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

…roof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

Olshansk

2/2!

runtime/test_artifacts/generator.go

andrewnguyen22 · 2022-11-04T16:58:11Z

Looks good - just conflict resolve, a nit, and and ask from @iajrz on versioning schema

andrewnguyen22 · 2022-11-04T16:55:35Z

rpc/doc/README.md

+
+Definitely we'll need ways to retrieve transactions as well so we can envisage:
+
+- Get a transaction by hash (**GET /v1/client/tx**)


This should be /v1/query/tx atleast in V0 the v1/client is for API client only (relay / dispatch / submitting transactions) while /v1/query is for blockchain data

andrewnguyen22 · 2022-11-04T16:57:21Z

app/app.go

+package app
+
+const (
+	AppVersion = "RC-1.0.0.alpha" // DISCUSS (team): see app/pocket/main.go, one of the two should be a source of truth, potentially replaced at build-time as described in `docs/build/README.md`


@iajrz bump on this

…_proof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

iajrz · 2022-11-10T14:35:01Z

app/app.go

+package app
+
+const (
+	AppVersion = "v0.0.1-pre-alpha.1" // DISCUSS (team): see app/pocket/main.go, one of the two should be a source of truth, potentially replaced at build-time as described in `docs/build/README.md`


since main depends on any and everything else, directly or indirectly, version number should be provided by a non-main package. I suspect this should be the source of truth.

Corollary: this package shouldn't use many (or any?) packages from the rest of the app so that anyone can import the version information.

I have updated accordingly and also added some pointers on how to override this at build time:

Useful if we also want to tag with the git-commits our official releases later on.

5ce3563

@andrewnguyen22 PTAL if you are happy about this

iajrz · 2022-11-10T15:52:45Z

rpc/handlers.go

+		Height: int(consensus.CurrentHeight()),
+		Round:  int(consensus.CurrentRound()),
+		Step:   int(consensus.CurrentStep()),


Suggested change

Height: int(consensus.CurrentHeight()),

Round: int(consensus.CurrentRound()),

Step: int(consensus.CurrentStep()),

Height: int64(consensus.CurrentHeight()),

Round: int64(consensus.CurrentRound()),

Step: int64(consensus.CurrentStep()),

Addressed in e9a742f

iajrz · 2022-11-10T16:00:17Z

rpc/module.go

+}
+
+const (
+	RPCModuleName = "rpc"


since we're implementing InitializableModule, this const does not need to be public. Arguably it shouldn't be?

good catch, applied consistently across the board 9958b01

…_proof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

…_proof_of_stake_cli_RPC

deblasis · 2022-11-11T15:27:26Z

This, as well as the other ones, was great teamwork 🙏

… (#176) ## Description This PR introduces a simple RPC (JSONRPC) server that will be used to interact with the CLI and/or other clients ## Issue Part of Issue #112 but we decided to split the work in 2 separate PRs ## Type of change Please mark the options that are relevant. - [x] New feature, functionality or library ## List of changes - Updated node to start an RPC server if enabled via config ## Testing - [x] `make test_all` - [x] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Checklist - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have tested my changes using the available tooling - [x] If applicable, I have made corresponding changes to related local or global README - [x] If applicable, I have added new diagrams using [mermaid.js](https://mermaid-js.github.io) - [x] If applicable, I have added tests that prove my fix is effective or that my feature works * feat(RPC): scaffolding Signed-off-by: Alessandro De Blasis <alex@deblasis.net> * feat(RPC): scaffolding * feat(RPC): scaffolding Signed-off-by: Alessandro De Blasis <alex@deblasis.net> * fix(RPC): updated config handling * fix(config.proto): updated timeout type * feat(RPC): basic RPC server with naive sync TX broadcast * fix(RPC): fixed HTTP method for Health and Version routes * style(RPC): format * refactor(Utility): RPC server RoutesMap for CLI/client use * refactor(Utility): RPC server exporting RouteKey and RoutesMap for CLI/client use * feat(Utility): RPC OpenApi spec and code generation * refactor(Utility): RPC server refactoring using code generation RPC server refactoring with code generation from openapi spec * feat(Utility): Updated RPC spec * feat(Utility): Regenerated RPC boilerplate and updates * docs(Utility): RPC and node docs barebones + RPC spec notes * refactor(Shared): RPC config defaults -changing soon,I'm centralizin Signed-off-by: Alessandro De Blasis <alex@deblasis.net> * fix(Utility): RPC: updated to use test_artifacts defaults * docs(Utility): RPC and node basic docs * chore(Utility): fixed versioning schema * fix(Utility): RPC configs post-merge * feat(Consensus): configOptions * feat(P2P): configOptions * fix(Utility): RPC fix post merge * fix(Utility): RPC disabled by default because of TECHDEBT * fix(RPC): test_artifacts in runtime * fix(go.mod): tidy * fix(RPC): added imports used in codegen files * feat(RPC): config proto * feat(RPC): RPCModule and noopRpcModule * refactor(Shared): shared.Create -> shared.CreateNode * docs(RPC): updated code organization post refactoring * fix(RPC): gitignoring generated files Signed-off-by: Alessandro De Blasis <alex@deblasis.net> * refactor(Consensus): mocks with Return(nil) and not Do(...) * docs(RPC): updated changelog versions * fix(Makefile): generate_rpc_openapi * fix(Makefile): fix for git clone + make develop_test * Update rpc/v1/openapi.yaml Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * Update rpc/doc/CHANGELOG.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * Update rpc/noop_module.go Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * chore(Shared): added TODOes for ValidateXXX() in modules * docs(RPC): broadcast_tx_sync summary updated * Update rpc/doc/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * Update rpc/doc/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * Update rpc/doc/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * fix(Makefile): gitignoring generated files breaks tests fix * feat(Consensus): CurrentRound() and CurrentStep() * feat(RPC): /v1/consensus/round_state * feat(RPC): /v1/consensus/round_state handler * docs(Docs): Adding some more color config + raw_hex_bytes * chore(Runtime): comment spacing * Update runtime/docs/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * chore(Consensus): SetBus mock Do(func(modules.Bus) {}) -> Return() * docs(Pocket): changelog * Update app/pocket/doc/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * Update app/pocket/doc/README.md Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> * docs(RPC): changelog * docs(RPC): docs TOC * docs(RPC): Transports -> Endpoints * feat(Tooling): swagger-ui Signed-off-by: Alessandro De Blasis <alex@deblasis.net> * docs(RPC): swagger ui link to editor and ref to make cmd * feat(rpcServer): rpcServer is now IntegratableModule * chore(Shared): tracking TODO (implement validations) #334 * fix(RPC): merge fix * chore(go.mod): tidy * docs(RPC): nit * fix(RPC): int64 on RoundState fields * refactor(Shared): unexporting XXModuleName * feat(node): single source of truth for version + overridable Signed-off-by: Alessandro De Blasis <alex@deblasis.net> Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com>

jessicadaugherty · 2022-12-20T01:45:33Z

Note for future RPC server owners: neither the RPC spec in

https://github.com/pokt-network/pocket-core/blob/staging/doc/specs/rpc-spec.yaml
or
https://docs.pokt.network/api-docs/pokt/#/

are complete sources of truth ATM. docs/specs/rpc-spec.yaml will need to reference docs to fill in missing gaps. There is also information not included from docs/specs/rpc-spec.yaml in docs.pokt.network/api-docs/pokt.

When the RPC server is revisited in the future, we should update docs/specs/rpc-server.yaml to reflect the API docs and then update the API docs with any missing information from docs/specs/rpc-server.yaml that wasn't already included.

Olshansk · 2022-12-20T02:12:33Z

Note for future RPC server owners: neither the RPC spec in

pokt-network/pocket-core@staging/doc/specs/rpc-spec.yaml
or
docs.pokt.network/api-docs/pokt/#

are complete sources of truth ATM. docs/specs/rpc-spec.yaml will need to reference docs to fill in missing gaps. There is also information not included from docs/specs/rpc-spec.yaml in docs.pokt.network/api-docs/pokt.

When the RPC server is revisited in the future, we should update docs/specs/rpc-server.yaml to reflect the API docs and then update the API docs with any missing information from docs/specs/rpc-server.yaml that wasn't already included.

To add to the above, the current V1 in-progress RPC spec can be found at the following link at the time of writing: https://github.com/pokt-network/pocket/blob/main/rpc/v1/openapi.yaml

The RPC spec at docs.pokt.network and in the pocket-core repo is for V0, and should be used as a guiding reference for future features.

deblasis added 8 commits August 24, 2022 18:39

feat(RPC): scaffolding

6f105dd

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

feat(RPC): scaffolding

50f2241

feat(RPC): scaffolding

23d3bbd

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

fix(RPC): updated config handling

5330530

fix(config.proto): updated timeout type

d72bf2d

feat(RPC): basic RPC server with naive sync TX broadcast

be4875d

fix(RPC): fixed HTTP method for Health and Version routes

43bd107

style(RPC): format

4d3331d

Olshansk assigned deblasis Aug 27, 2022

Olshansk added core Core infrastructure - protocol related persistence Persistence specific changes priority:high client work needed to interface with the node (rpc, cli, etc..) labels Aug 27, 2022

Olshansk added this to the M1: Pocket PoS (Proof of Stake) milestone Aug 27, 2022

Olshansk added tooling tooling to support development, testing et al and removed persistence Persistence specific changes labels Aug 27, 2022

Olshansk requested review from Olshansk and andrewnguyen22 August 27, 2022 19:22

deblasis added 2 commits August 29, 2022 15:47

refactor(Utility): RPC server RoutesMap for CLI/client use

762c85c

refactor(Utility): RPC server exporting RouteKey and RoutesMap

af55e4a

for CLI/client use

deblasis marked this pull request as ready for review August 29, 2022 15:04

deblasis requested a review from a team August 29, 2022 15:04

deblasis changed the title ~~[WIP] [Utility] Local Proof of Stake CLI - RPC server [part 2/2] - Issue #112~~ [Utility] Local Proof of Stake CLI - RPC server [part 2/2] - Issue #112 Aug 29, 2022

deblasis mentioned this pull request Aug 29, 2022

[Utility] Local Proof of Stake CLI #112

Closed

16 tasks

andrewnguyen22 suggested changes Aug 30, 2022

View reviewed changes

andrewnguyen22 mentioned this pull request Aug 30, 2022

[Utility] Local Proof of Stake CLI - Issue #112 #169

Merged

9 tasks

Olshansk requested changes Sep 4, 2022

View reviewed changes

deblasis added 3 commits September 6, 2022 11:12

feat(Utility): RPC OpenApi spec and code generation

f07965e

refactor(Utility): RPC server refactoring using code generation

20f0185

RPC server refactoring with code generation from openapi spec

feat(Utility): Updated RPC spec

dc51992

deblasis added 5 commits November 3, 2022 11:37

docs(RPC): Transports -> Endpoints

022becd

feat(Tooling): swagger-ui

5f2ba8b

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

docs(RPC): swagger ui link to editor and ref to make cmd

15e326d

feat(rpcServer): rpcServer is now IntegratableModule

e85f046

chore(Shared): tracking TODO (implement validations) pokt-network#334

b26eb91

deblasis requested a review from Olshansk November 3, 2022 12:17

deblasis added 3 commits November 3, 2022 16:09

Merge remote-tracking branch 'origin/main' into issue/utility_local_p…

1f2d6c6

…roof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

fix(RPC): merge fix

ae931be

chore(go.mod): tidy

39bc308

Olshansk approved these changes Nov 3, 2022

View reviewed changes

runtime/test_artifacts/generator.go Outdated Show resolved Hide resolved

andrewnguyen22 suggested changes Nov 4, 2022

View reviewed changes

deblasis added 2 commits November 4, 2022 17:05

Merge remote-tracking branch 'upstream/main' into issue/utility_local…

c268a99

…_proof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

docs(RPC): nit

52bf2c5

iajrz reviewed Nov 10, 2022

View reviewed changes

deblasis added 5 commits November 10, 2022 19:36

fix(RPC): int64 on RoundState fields

e9a742f

refactor(Shared): unexporting XXModuleName

9958b01

Merge remote-tracking branch 'upstream/main' into issue/utility_local…

9ba7989

…_proof_of_stake_cli_RPC Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

Merge remote-tracking branch 'upstream/main' into issue/utility_local…

0b2e2f3

…_proof_of_stake_cli_RPC

feat(node): single source of truth for version + overridable

5ce3563

deblasis requested a review from andrewnguyen22 November 10, 2022 21:29

andrewnguyen22 approved these changes Nov 11, 2022

View reviewed changes

deblasis merged commit 9fe53d9 into pokt-network:main Nov 11, 2022

jessicadaugherty mentioned this pull request Mar 28, 2023

[Tooling] RPC specification parity #628

Closed

10 tasks


		Definitely we'll need ways to retrieve transactions as well so we can envisage:

		- Get a transaction by hash (GET /v1/client/tx)

Conversation

deblasis commented Aug 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue

Type of change

List of changes

Testing

Checklist

Uh oh!

andrewnguyen22 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrewnguyen22 commented Nov 4, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

deblasis commented Nov 11, 2022

Uh oh!

jessicadaugherty commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Olshansk commented Dec 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

deblasis commented Aug 25, 2022 •

edited

Loading

jessicadaugherty commented Dec 20, 2022 •

edited

Loading