T

Amaury Martiny d07ed8ac38 Refactor api-promise/rx (#566 )

* Use a generic abstract OnCall

* Add OnCall for Promise

* First run at fixing extrinsics

* Fix types

* Make submittable extrinsic work

* Move file

* Make derive work

* Fix types

* Only call metadata once

* Make tests pass

* Put event emitter in apirx

* Fix small bugs

* Fix tests

* Fix bug decorateStorage

* Make tests pass for tx

* Move rpc base to apirx

* Fix lint

* Fix small bugs

* Fix bug with isSubscription

* Fix codeclimate

* Revert

* Add tslint disable line

* Fix lint

* Skip e2e

* Typo

* Lint

* Re-add combinator back

* Add ._rx in Base

* Make extrinsics work

* Update derivex

* Fix bug lint

* Fix circular dep

* Fix bug e2e

* Remove useless check

* Add description comment

* Clean stuff

* Move assert to Base

* Bump version, update CHANGELOG

* Make _rx private

* Private emit

2019-01-16 15:42:59 +01:00

docs

[CI Skip] 0.39.12

2019-01-16 09:59:36 +00:00

packages

Refactor api-promise/rx (#566 )

2019-01-16 15:42:59 +01:00

.babelrc.js

TypeScript conversion (#101 )

2018-06-23 13:39:31 +02:00

.codeclimate.yml

Additional Codeclimate cleanups (#452 )

2018-12-09 10:54:43 +01:00

.editorconfig

Initial add

2017-11-18 08:38:18 +01:00

.gitignore

Fix CI publish (#570 )

2019-01-11 12:06:51 +01:00

.npmignore

Move to lerna repo (#19 )

2017-11-28 18:03:48 +01:00

.nvmrc

Add documentation and examples (#145 )

2018-09-15 09:11:56 +02:00

.travis.yml

Use latest yarn on CI (#568 )

2019-01-11 07:59:20 +01:00

babel.config.js

Use @babel 7 (#90 )

2018-05-16 13:53:29 +02:00

book.json

Absolute logo url (#283 )

2018-10-13 18:01:53 +02:00

CHANGELOG.md

Refactor api-promise/rx (#566 )

2019-01-16 15:42:59 +01:00

jest.config.js

Add derive functions (#540 )

2019-01-09 10:59:56 +01:00

lerna.json

Refactor api-promise/rx (#566 )

2019-01-16 15:42:59 +01:00

LICENSE

Update LICENSE and README (#408 )

2018-11-21 13:37:27 +01:00

package.json

[CI Skip] 0.39.12

2019-01-16 09:59:36 +00:00

README.md

Simple README change, trigger bump

2019-01-16 10:53:49 +01:00

tsconfig.json

Add derive functions (#540 )

2019-01-09 10:59:56 +01:00

tslint.json

API formatting for inputs & outputs (#171 )

2018-09-28 15:42:23 +02:00

typedoc.js

API documentation (#253 )

2018-10-11 15:27:00 +02:00

yarn.lock

AccountId toString() with isEmpty (#592 )

2019-01-16 10:05:46 +01:00

README.md

@polkadot/api

This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client and defines all the types exposed by a node. For complete documentation around the classes, interfaces and their use, visit the documentation portal.

tutorials

Looking for tutorials to get started? Look at examples for guides on how to use the API to make queries and submit transactions.

overview

The API is split up into a number of internal packages -

@polkadot/api The API library, providing both Promise and RxJS Observable-based interfaces. This is the main user-facing entry point.
@polkadot/api-derive Derived results that are injected into the API, allowing for combinations of various query results (only used internally and exposed on the Api instances via api.derive.*)
@polkadot/rpc-core Wrapper around all JSON-RPC methods exposed by a Polkadot network client
@polkadot/rpc-provider Providers for connecting to nodes, including WebSockets and Http
@polkadot/rpc-rx A RxJs Observable wrapper around @polkadot/rpc-provider

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
@polkadot/types Codecs for all Polkadot primitives

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, its 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.10.1 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