polkadot-js/docs

Stars
164
Rank 230,032 (Top 5 %)
Language
JavaScript
License
Creative Commons ...
Created about 4 years ago
Updated 6 months ago

polkadot-js/docs

polkadot-js

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

This is the documentation portal for all Polkadot and Substrate related tools and libraries in the polkadot-js family of repos.

polkadot-js docs

This is a documentation portal for the @polkadot family of tools and libraries. The latest version is always available at https://polkadot.js.org/docs/

Help us help others

If you spot gaps in the information provided, or are uncertain about any specific area, please do log an issue or if you are that way inclined, make a pull-request. We really want to have good documentation in these areas and allow people to be productive right from the start.

apps

Basic Polkadot/Substrate UI for interacting with a Polkadot and Substrate node. This is the main user-facing application, allowing access to all features available on Substrate chains.

api

Promise and RxJS APIs around Polkadot and Substrate based chains via RPC calls. It is dynamically generated based on what the Substrate runtime provides in terms of metadata.

extension

Simple browser extension for managing Polkadot and Substrate network accounts in a browser. Allows the signing of extrinsics using these accounts. Also provides a simple interface for compliant extensions for dapps.

tools

Various cli tools for Polkadot and Substrate chains, including basic node monitoring, making API queries via a cli app and other command-line tools

common

Utilities and base libraries for use across polkadot-js for Polkadot and Substrate. Includes base libraries, crypto helpers and cross-environment helpers.

phishing

A curated list of known less-than-honest operators on Polkadot and Substrate networks. Includes a simple JS utility function to check any host or address against this list.

wasm

A collection of WASM wrappers (mostly around Rust libraries) that are used as faster versions of JS-native functions on Polkadot and Substrate networks.

ui

Re-usable browser libraries and React UI components used inside the polkadot.{js} family of Polkadot and Substrate applications. Full documentation & examples available

dotapps.io

IPNS with dnslink for the apps UI to interact with Polkadot and Substrate chains.

client

An alternative Polkadot Runtime Environment implementation acting as a full-node (excluding block production for validators) for syncing with Substrate-based chains.

dev

Development configuration, scripts and and CI setup for polkadot-js projects. It acts as templates for other projects to reduce boilerplate, making everything consistent.

polkadot-js.github.io

Simple landing and project overview page for the polkadot-js family of repos.

build-deno.land

Package publishing for deno.land/x/polkadot

ts

Misc. TypeScript definitions that are not yet available on DefinitelyTyped but required by other projects in this repo. Should be merged with upstream projects or the DT project.

polkadot-identicon

Deprecated. Moved to partitytech/oo7.

ss58

The SS58 address encoder/decoder

build-bundle

Browser bundles that can be included as-is, without a build step

oo7-polkadot

Polkadot Bonds library

polyfill

Deprecated. Moved to the common repo. A collection of cross-environment polyfills