Move to lerna repo (#19)
* Pull api-* packages into lerna repo * Bootstrap with hoist * Update jest alias config * Add api-jsonrpc * Pull in jsonrpc * Update badges * Don't hoist, use workspaces * .eslintrc to root * Cleanups, build from root * Shorthand commands * Update to @polkadot/dev 0.9.1 * Update description
This commit is contained in:
@@ -1,40 +1,22 @@
|
||||

|
||||
[](https://www.npmjs.com/package/@polkadot/api)
|
||||
[](https://travis-ci.org/polkadot-js/api)
|
||||
[](https://coveralls.io/github/polkadot-js/api?branch=master)
|
||||
[](https://greenkeeper.io/)
|
||||
[](https://david-dm.org/polkadot-js/api)
|
||||
[](https://david-dm.org/polkadot-js/api#info=devDependencies)
|
||||
|
||||
# @polkadot/api
|
||||
# @polkadot/client
|
||||
|
||||
Warning - currently this does not actually do all that much, it is an attempt to put into code some thoughts about how to maintain the endpoints. This library provides a clean wrapper around all the methods exposed by a Polkadot network client. Methods are auto-generated for the [JsonRPC interface definitions](https://github.com/polkadot-js/jsonrpc).
|
||||
This library provides a clean wrapper around all the methods exposed by a Polkadot network client.
|
||||
|
||||
## Usage
|
||||
It is split up into a number of internal packages -
|
||||
|
||||
Installation -
|
||||
- [@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
|
||||
|
||||
```
|
||||
npm install --save @polkadot/api
|
||||
```
|
||||
## Contributing
|
||||
|
||||
Initialisation -
|
||||
|
||||
```js
|
||||
import Api from '@polkadot/api';
|
||||
import HttpProvider from '@polkadot/api-provider/http';
|
||||
|
||||
const provider = new HttpProvider('http://127.0.0.1:9933');
|
||||
const api = new Api(provider);
|
||||
```
|
||||
|
||||
Making calls -
|
||||
|
||||
```js
|
||||
api.chain
|
||||
.getHeader('0x1234567890')
|
||||
.then((header) => console.log(header))
|
||||
.catch((error) => console.error(error));
|
||||
```
|
||||
|
||||
## Available methods
|
||||
|
||||
For a list of currently exposed methods, see the [@polkadot/jsonrpc](https://github.com/polkadot-js/jsonrpc#readme) repository.
|
||||
- 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
|
||||
|
||||
Reference in New Issue
Block a user