Chevdor
0981a30d84
* Add documentation * Justification u8a decoding and json encoding (#146) * Decode Justifications * Json encoding for justifications * Bump deps * Allow extrinsic length encoding to operate on u8a[] (#148) * Fix config and move generated doc to a subfolder * Cleanup extrinsic encoding (#150) * Cleanup extrinsic encoding * Removed now-defunct type * Add uncheckedLength encoding * Add examples * Ignore package-lock since we use yarn * Cleanup examples * Add gitbook config and some base files for the doc * Do not make full doc mandatory for now * Add contributing guide, polish doc and samples * Update the deps of all samples and add yarn scripts Fix and regenerate the doc * Fix Contributing guide
@polkadot/api
This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client. As part of the JsonRpc defintions, the exposed methods are documented.
The API is split up into a number of internal packages -
- @polkadot/api The low-level base API library
- @polkadot/api-rx A RxJs Observable wrapper around the API
- @polkadot/api-format Input and output formatters
- @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/params Input/output parameter formatting
- @polkadot/primitives Primitive type definitions, builder & codecs
- @polkadot/storage Definitions for storage entries