Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rajkaramchedu opened this issue Mar 27, 2024 · 0 comments
Open

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

rajkaramchedu opened this issue Mar 27, 2024 · 0 comments
Assignees

Comments

@rajkaramchedu
Copy link
Collaborator

rajkaramchedu commented Mar 27, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant