24 lines
1.5 KiB
Markdown
24 lines
1.5 KiB
Markdown
|
|
[](https://www.npmjs.com/package/@polkadot/api)
|
|
[](https://travis-ci.org/polkadot-js/api)
|
|
[](https://codeclimate.com/github/polkadot-js/api/maintainability)
|
|
[](https://coveralls.io/github/polkadot-js/api?branch=master)
|
|
[](https://greenkeeper.io/)
|
|
|
|
# @polkadot/client
|
|
|
|
This library provides a clean wrapper around all the methods exposed by a Polkadot network client. As part of the JsonRpc defintions, the [exposed methods are documented][packages/api-jsonrpc/docs/].
|
|
|
|
The API is split up into a number of internal packages -
|
|
|
|
- [@polkadot/api](packages/api/) The API library
|
|
- [@polkadot/api-format](packages/api-format/) Input and output formatters
|
|
- [@polkadot/api-jsonrpc](packages/api-jsonrpc/) Interface definitions for RPC
|
|
- [@polkadot/api-provider](packages/api-provider/) Transport providers
|
|
|
|
## Contributing
|
|
|
|
- Make sure you have [Lerna](https://lernajs.io/) installed, `yarn install -g lerna`
|
|
- Bootstrap the dependencies, `lerna bootstrap`
|
|
- Make any changes in the relevant package, on master merges new versions will be published automatically
|