api/docs/README.md at af682bc23bf56017d64eb3d1196d38f2da7b1bd4

Files

T

Jaco GreeffandThibaut Sardan 55fb391465 Things I wish I knew... (#1374 )

* Make a start

* Intro

* Installation

* Flatten

* Move METHODS_*.md to substrate/*.md

* Basics

* Apply suggestions from code review

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Substrate links

* Create

* api.consts

* Typo

* Typo, ms -> md

* types.basics (SIP)

* Type basics

* api.consts jumps to api.query

* Start to api.query

* Basic queries

* Point starting to actual overview

* api.rpc

* Derive detour

* Query subs & query multi

* Apply suggestions from code review

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* typo

* Query extras

* Basic transactions

* Misplaced ,

* keyring WIP

* Keyring wrap-up

* Subs SIP

* tx subs more WIP

* tx subs

* Small types cleanups

* Apply suggested changes from @JoshOrndorff

* Clarify naked await

* tx wrapping WIP

* Wrap api.wrap

* TS placeholder

* [WIP] markers for not-started

* Clarifying comments

* Additional clarifications

* types.extend... well, extended...

* Remove *nix

* Warp up TypeScript... it is it (for now)

* Some small text clarifications

* Some cleanups

* Cleanups, typos

* keyring cleanups

* Cleanups

* Wrap

* api.wrap wrapped... hopefully

* typos

* Registration typos

* typescript typos, hope I caught most...

2019-09-11 17:32:34 +02:00

2.2 KiB

Raw Blame History

home, heroText, tagline, features, footer

home

heroText

tagline

features

footer

true

title	details
API	A powerful dynamic API that allows chain interactions with transparent encoding and decoding.

title	details
Substrate defaults	An overview of the various default methods, state entries and RPCs for Substrate-based chains.

title	details
Types	Various type interfaces to make using returned values from API calls transparent in your code.

Welcome

The API provides application developers the ability to query a node and interact with the Polkadot or Substrate chains using Javascript. Here you will find documentation and examples to get you started.

::: tip Getting started & Examples Jump right in and get an overview on using the API in your projects, from installation all the way through to making it do magic. Already understand how things work and just want the examples? The ApiPromise examples provide some basic recipies. :::

Available packages

This repository split up into a number of internal packages, namely -

api Promise and RxJS-based APIs
types Type encoding and decoding wrappers

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/ and more about the polkadot-js projects at https://polkadot.js.org

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/api

Contributing

Contribution to the Polkadot JS API are more than welcome. You can report issues and log feature requests.

2.2 KiB Raw Blame History