T

Amaury Martiny 63846ac367 Remove onCall, use decorateMethod (#987 )

* update signature of doublemap storage function

* add test cases

* update doublemap implementation

* update implementation

* remove duplicate test case

* update test cases

* Add hkt

* Fix derive types

* Make derive work

* Fix some bugs

* Fix some bugs

* More stuff

* Make some more stuff work

* Fix types in derive

* Fix all tests in derive

* Change back ApiType

* Remove vscode

* Fix Submittables

* Fix some errors

* Fix some bugs

* Change some stuff

* Fix merge conflict

* Fix types

* Add console.log

* Add console.log

* Re-add decorateMethod

* Fix tests

* Skip e2e

* Small fixes

* Fix signAndSend

* Fix typings in test

* Fix lint

* Add comments

* One line

* Remove useless

* URI->ApiType

* Indentation

2019-06-14 12:12:53 +02:00

docs

[CI Skip] 0.81.0-beta.13

2019-06-13 12:52:11 +00:00

packages

Remove onCall, use decorateMethod (#987 )

2019-06-14 12:12:53 +02:00

.123trigger

multi-merge failure

2019-05-23 22:40:48 +02: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

rm -rf cc-test-reporter

2019-04-29 15:44:23 +02: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

Bump deps (#861 )

2019-04-29 13:47:55 +02:00

babel.config.js

Use @babel 7 (#90 )

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

CHANGELOG.md

0.81 (#1010 )

2019-06-14 10:41:23 +02:00

CONTRIBUTING.md

Deploy docs via gh-pages (#746 )

2019-02-28 17:06:49 +01:00

jest.config.js

Revert "Move contracts into api-contract"

2019-06-14 09:06:57 +02:00

lerna.json

[CI Skip] 0.81.1

2019-06-14 08:50:24 +00:00

LICENSE

Update LICENSE and README (#408 )

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

package.json

[CI Skip] 0.81.1

2019-06-14 08:50:24 +00:00

README.md

Remove useless ascii art :) (#862 )

2019-04-30 10:54:14 +02:00

tsconfig.json

Revert "Move contracts into api-contract"

2019-06-14 09:06:57 +02:00

tslint.json

API formatting for inputs & outputs (#171 )

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

typedoc.js

Pull in vuepress foir docs (as opposed to gitbook) (#742 )

2019-02-26 15:21:39 +01:00

yarn.lock

0.81 (#1010 )

2019-06-14 10:41:23 +02: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 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