Luke Schoen
267411d778
* fix: Remove docs/api since replaced with docs/rpc-core * fix: Remove docs/api-provider since replaced with docs/rpc-provider * fix: Remove docs/api-rx since replaced with docs/rpc-rx * fix: Remove the guide file that serves no purpose * fix: Change license from ui-observable to api-observable * fix: Remove disused mockHttp and mockWs that are duplicates of those in rpc-provider * fix: Clarifies difference between PropIndex and ProposalIndex from Issue #226 * fix: Update api-observable Readme to refer to rpc-core, previously called api * misc: Update Readme of rpc-core. See commit message details. * Update name to be @polkadot/rpc-core instead of @polkadot/api * Use Yarn instead of NPM for instructions adding dependencies * Refer to @polkadot/rpc-core as `Rpc` * Highlight that given block header hash should be a 0x-prefixed hex string with length of 64 (not only length of 10 as shown in the example) * Showcase more information that you can obtain from the header object (i.e. best block number, parentHash, stateRoot, extrinsicsRoot, and digest) * Use `header.raw` instead of just `header` to access properties of the header object * Update the example to console.log the subscription ID * Add missing semicolon * fix: Fix name in license header and rename Api to Rpc for rpc-core e2e tests * fix: Update rpc-provider Readme to use Yarn instead of NPM install * fix: Fix minor typo * fix: Rename Api to Rpc for rpc-provider ws * fix: Refer to rpc-core instead of api in the rpc-rx Readme * fix: Update rpc-rx files to refer to it as RpcRx instead of RxApi or just Api * fix: Refer to rpc-core as Rpc instead of Api * fix: Update type-jsonrpc Readme. Fix typo. Use Yarn not NPM. Refer to TSLint not Flow * refactor: Move non-type dependency import with non-type dependencies * docs: Add link to parity-codec repo * fix: Avoid use of .raw. Fix listen to blocks example * fix: Add missing error to newHead in listen to blocks example
2.1 KiB
2.1 KiB
@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)