Skip to content

Improve discoverability of API methodsΒ #286

@jordy25519

Description

@jordy25519

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions