Skip to content

Investigate and plan out writing JSON-RPC API docs #176

Open
@rajkaramchedu

Description

@rajkaramchedu

Goal: Document and publish OpenAPI-style JSON-RPC API docs for Bittensor API and subtensor API (if applicable).

Reference material

See this Discord thread: https://discord.com/channels/799672011265015819/1176889641547333683/1222328931718271076

We have:
extrinsics
runtime APIs for info

I think both are good, but runtime APIs might be better to start with as they don't (currently) get detected (and have types filled) by Polkadotjs oracle, unlike the extrinsics.
But both would be good to do
Also, both interfaces are changing based on the recent stao changes

Question: Which ones are runtime APIs in specific? Can you point me to a package in bittensor repo? (if they are there)

https://github.com/opentensor/bittensor/blob/master/bittensor/__init__.py#L129 is a link to the type registry for the runtime APIs
The output types are all Vec (bytes), but they are further decoded to objects
Any of the functions in https://github.com/opentensor/bittensor/blob/master/bittensor/subtensor.py#L2501
that calls query_runtime_api

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions