Stefanie DollandAmaury Martiny
c01ade86a6
* Add jest watch option to package.json * convert promise-alex-spec to ts & add types * convert ./api tests from JS to TS * convert ./api tests from JS to TS pt. 2 * More convert tests from JS to TS * rpc-provider convert tests from js to ts * rpc-provider tests js => ts * rpc-provider tests js => ts * linting issues * tslint fixes * 101 => 68 typescript errors * WIP * connect() e2e tests * more fixes * Fix linting errors of new ERA tests after merge * test for listeners in connect * formatting * getting there... * re-add skips * test refactoring & codeclimate fixes * more fixed tests * mock.body workaround * Fixed wrong test description * ApiPromiseInterface => Api * ws polyfill / send * bring back isZero() test * .then().catch() => .catch() * Removed leftover body * Type ProviderInterface => Http * Fixed polyfill tests * trailing whitespce * (mock.body as any)['test_body'] and Balance * Fix autoconnect in WsProvider * Fixed part of linting errors in ERA tests * call unused const unsubscribe * added ts-ignores for testing private properties/ methods of Provider * Archive node test * Fixed linting for ERA tests * Further changes * Update packages/rpc-provider/src/ws/polyfill.spec.ts Co-Authored-By: Amaury Martiny <amaury.martiny@protonmail.com> * relative paths for imports inside module & reordering of imports pt. 1 * relative paths for imports inside module & reordering of imports pt. 2 * added skip back to e2e transactions * Fix some more tests in TS (#952) * Fix some more tests in ts * Add more constructor * More typing in ./api * .skip * <SubmittableResult>'s * .catch() -> return() * Extrinsics tests * Left TODO's for extrinsic e2e tests * Workaround for failing Type Extrinsic tests
@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 and Substrate 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 everything via
yarn run build - You can also launch the API Docs, via
yarn vuepress dev docs - Access the docs via http://localhost:8080