Skip to content

[Tooling] RPC specification parity #628

@jessicadaugherty

Description

@jessicadaugherty

Objective

Develop and implement an RPC specification for Pocket Network's v1 protocol with feature parity to the V0 utility RPC specification, ensuring compatibility and seamless integration with the existing system.

Origin Document

The V0 RPC specification can be found in this yaml file:

V0 utility RPC specification

The V1 utility specification can be found here:

V1 Utility Specification

Initial work has been done on the RPC specification when building the CLI MVP and can be reviewed in these PRs:

CLI and RPC MVP pt 1
CLI and RPC MVP pt 2

Goals

  • Achieve parity with V0 RPC specification
  • Identify and implement missing endpoints and requirements for the V1 utility RPC specification

Deliverable

  • Review and analyze the V0 utility RPC specification, identifying key components, functionality, and important endpoints, methods, and data structures.
  • Create endpoints for V1 utility logic in the RPC specification and document
  • Create placeholder endpoints for functionality that is not yet ready in utility, but exists in v0, and will be needed in v1 with a TODO comment

Non-goals / Non-deliverables

  • Implementing new features or enhancements that are not part of the V0 utility RPC specification or unrelated to the M3 (relay) requirements

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references
  • If applicable, update the source code tree explanation
  • If applicable, add or update a state, sequence or flowchart diagram using mermaid

Testing Methodology

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @jessicadaugherty

Metadata

Metadata

Assignees

Labels

communityOpen to or owned by a non-core team membertoolingtooling to support development, testing et al

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions