Closed Olshansk closed 2 weeks ago
Decouple pkg/sdk to prepare for a full-time owner of the Shannon SDK
pkg/sdk
Note: not all of these are publically accessible
pocket-shannon-go
poktroll
storage
network
depinject
TODO_DECOUPLE
1
gRPC
OpenAPI
service
*.proto
docs/static/openapi.yml
pocket-go
future owner
Creator: @Olshansk Co-Owners: @red-0ne @moatus
Close with #554 and #594
Objective
Decouple
pkg/sdk
to prepare for a full-time owner of the Shannon SDKOrigin Document
Note: not all of these are publically accessible
Goals
Deliverables
pkg/sdk
into its own repository calledpocket-shannon-go
and updatepoktroll
to depend on itstorage
andnetwork
statefullness configurable in the new SDKpoktroll
still works.depinject
) as longs as its straightforward.TODO_DECOUPLE
if it's non-trivial. Goal1
is the top priorityTechnical notes/considerations for future SDK owners
gRPC
instead ofOpenAPI
as the source of truthservice
across all*.proto
files in this repo, they will come pop up and be viewed as the source of truthdocs/static/openapi.yml
contains a swagger-compatible OpenAPI spec but should not be seen as the source of truthpocket-go
as they should (theoretically) be using the new SDKNon-goals / Non-deliverables
future owner
section aboveGeneral deliverables
Creator: @Olshansk Co-Owners: @red-0ne @moatus