Jaco Greeff
b313614935
* Pull in latest @polkadot/dev, cleanup existing *.html * Cleanups (old gitbook interfaces) * Bump, WIP * Ready for testing * Update examples * Include source * Cleanup links * Adjust links * Add typedoc exclusions * Default classes from class files * Adjust imports * Adjust config * Re-add types split * Update links to substrate interfaces * Anchors for metadata * Adjust links * Restore HTML (to be deleted on CI) * Bump deps * Re-gen yarn.lock * Remove a in links * Adjust interfaces
@polkadot/jsonrpc
A definition of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.
For a list of currently exposed methods, see the method documentation.
Usage
Installation -
yarn add @polkadot/jsonrpc
Adding methods
As methods are added, simply adding the name, inputs & output will prepare it for use.
- Add the method to the correct file in src/rpc/ (Input/Output types as cross-referenced from the canonical implementation and match one-to-one)
- Should a new type be required, add it to the type list, src/types.js (Required for TSLint type checking)