RPC/API Improvements Tracking

[distractedm1nd]

RPC/Autogen

First stable version

• rpc: decide on versioning #1345
• docs(rpc+gateway): Finish adding example types #1358
• Clarify the public APIs intended to be used by external developers #425
• Add reflect tests to ensure compliance with RPC requirements
  • Context always exists as first parameter
  • Two return types, both JSON serializable, second one is always err
• API module definitions should match specification in ADR
• update ADR with overview of architecture

Nice to haves

• blob module
• improve UX around generating auth token

Hardening

• nodebuilder/state: Stub out state methods if no connection to core #1401
• OpenRPC Schema generation improvements for autogenerated clients
• CLI over RPC
• feat(rpc/gateway): adding WriteTimeout and IdleTimeout to rpc and gateway #1276
• [Feature Request]: /health RPC endpoint #739
• libs: Add expiry for JWT #2420

Gateway:

• [Feature Request]: /health RPC endpoint #739
• Add JWT auth to writes
• feat(gateway): automatic docgen for endpoints #1184

Refactorings:

• nodebuilder: Private proxy constructors in all modules #1375
• nodebuilder: extract module names into consts and reuse those consts where possible(refactor(nodebuilder): extract module names to a const #1176)
• Researching alternatives to Internal fields in API structs for go-jsonrpc
• nodebuilder/state: Stub out state methods if no connection to core #1401

General API endpoint improvements / feature requests

• header.GetAt endpoint
• consider deprecating header.GetRangeByHeight in favour of header.GetVerifiedRangeByHeight
• feat: Add header.Subscribe method #1942

Future considerations

• feat(header)!: add pagination to GetVerifiedRangeByHeight #2811
• Reconsider fx being part of our public API #1143
• feat(rpc): autogenerate API structs from Module interfaces in nodebuilder/<pkg>/<pkg.go> files #1302
• Consider separating monolithic config into separate configs, allowing nodebuilder.Store to move to nodebuilder/node.Store #1144

[Wondertan]

We must find a way to add options to our APIs for optional things like fee prices, versioning, etc.
The canonical way of using functional patterns would not be compatible with our RPC autogen. Though there might be a brilliant way to make the functional pattern work with reflection, but it's not known nor implemented in the RPC lib.

As a simple step, I propose adding an optional structure to each method, requiring an option. That structure would contain all the optional fields of the method. This way is compatible with our RPC lib and should be easy to replicate in different languages.

[ramin]

going to close this as a stale/general tracking issue and let the requisite linked issues that remain open track the work, so as we reduce issue count we can rely less on these kind of big issues