Skip to content

Promise and RxJS APIs around Polkadot and any Substrate-based chain RPC calls. It is dynamically generated based on what the Substrate runtime provides in terms of metadata. Full documentation & examples available

License

Notifications You must be signed in to change notification settings

KarishmaBothara/api

This branch is 3012 commits behind polkadot-js/api:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ae6a330 · May 27, 2021
Oct 26, 2020
Mar 3, 2021
Oct 23, 2020
May 27, 2021
May 24, 2021
Feb 26, 2020
Nov 18, 2017
Feb 26, 2021
Feb 28, 2020
Nov 28, 2017
Apr 26, 2021
Mar 3, 2021
May 27, 2021
Feb 28, 2019
Nov 21, 2018
Apr 29, 2021
Dec 4, 2019
Mar 2, 2021
Mar 9, 2021
May 27, 2021
Jan 19, 2021
May 27, 2021

Repository files navigation

polkadotjs license npm beta maintainability coverage

@polkadot/api

This library provides a clean wrapper around all the methods exposed by a Polkadot/Substrate 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.

If you are an existing user, please be sure to track the CHANGELOG and UPGRADING guides when changing versions.

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/metadata Base extrinsic, storage and constant injectors for injection
  • @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

Type definitions for interfaces as exposed by Polkadot & Substrate clients -

About

Promise and RxJS APIs around Polkadot and any Substrate-based chain RPC calls. It is dynamically generated based on what the Substrate runtime provides in terms of metadata. Full documentation & examples available

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.7%
  • Other 0.3%