@polkadot/api

Polkadot JavaScript API

Introduction

Warning - currently this does not actually do all that much, it is an attempt to put into code some thoughts about how to maintain the endpoints.

Usage

Installation -

npm install --save @polkadot/api

Initialisation -

import Api from '@polkadot/api';

const provider = new Api.HttpProvider('http://127.0.0.1:9933');
const api = new Api(provider);

Making calls -

api.chain
  .getHeader('0x1234567890')
  .then((header) => console.log(header))
  .catch((error) => console.error(error));

Available methods

For a list of currently exposed methods, see the docs/ folder.

Adding methods

As methods are added, simply adding the name, inputs & output will prepare it for use.

• Add the method to the correct file in src/interface/
• Input types as cross-referenced from the canonical implementation and match one-to-one
• Should a new type be required, add it to the type list, src/types/interface.js
• (Optional) Formatters can be added to src/format/ (Unknown types use the default Noop formatter, i.e. formatted value === input value)