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
@polkadot/api
This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client. For complete documentation around the classes, interfaces and their use, visit the documentation portal.
overview
The API is split up into a number of internal packages -
- @polkadot/api The low-level base API library
- @polkadot/api-codec Codecs for all Polkadot primitives
- @polkadot/api-rx A RxJs Observable wrapper around the API
- @polkadot/api-provider Providers for connecting
Type definitions for interfaces as exposed by Polkadot & Substrate clients -
- @polkadot/extrinsics Base extrinsic definitions & codecs
- @polkadot/jsonrpc Definitions for JSONRPC endpoints
- @polkadot/storage Definitions for storage entries
development
Contributions are welcome!
To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organise the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.
To get started -
- Clone the repo locally, via
git clone https://github.com/polkadot-js/api <optional local path> - Ensure that you have a recent version of Node.js, for development purposes Node 10 is recommended.
- Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.3.2 is required.
- Install the dependencies by running
yarn - Build the API Docs, via
yarn run build - Ready! Now you can launch the API Docs, via
yarn gitbook serve - Access the API Docs via http://localhost:4000
tutorials
Looking for tutorials to get started? Look at examples for guides on how to use the API.