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

Improve discoverability of API methods #286

Open
jordy25519 opened this issue May 4, 2021 · 0 comments
Open

Improve discoverability of API methods #286

jordy25519 opened this issue May 4, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@jordy25519
Copy link
Contributor

jordy25519 commented May 4, 2021

the api object is filled with auto-generated methods.
It makes some sense once you've learnt the details but is not that great when you haven't.

api.query - reads from storage
api.tx - makes a transaction
api.derive - generally compound queries, could do anything read/write
api.rpc - generally triggers calculations + reads on node side, can also do things like test run a contract, set local node session keys

We could look to group & present these in a nicer way to the user.
Might allow us some affordance to breaking changes also if the underlying generated api changes

cc @Amy-Centrality

@jordy25519 jordy25519 added the enhancement New feature or request label May 4, 2021
@jordy25519 jordy25519 changed the title More discoverable API methods Improve discoverability of API methods May 4, 2021
@jordy25519 jordy25519 mentioned this issue May 5, 2021
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant