Javascript API Reference

The Pl^g blockchain features a rich API for developing your D'App.

The easiest way to get started is to follow our API getting started guide

For a detailed reference on how the API works, see the Polkadot API reference

API Object

The full Blockchain API is accessed by creating an API object:

const provider = new WsProvider('ws://localhost:9944');
const api = await ApiPromise.create({ 
  provider,
  types: PlugRuntimeTypes,
});

The object needs:

• The websocket provider (for testing locally, the default is ws://localhost:9944)
• Specific runtime types used by your application
  • As new runtime modules are added to your Pl^g blockchain, you may need to add more types here.

The imports required to build the API object are:

import {ApiPromise, WsProvider} from '@polkadot/api';
import PlugRuntimeTypes from '@plugnet/plug-api-types';

Sending Extrinsics with Doughnut

One of the key features of Pl^g is delegated dispatch calls. This allows Bob to give Alice permissions using Bob's account.

When sending an extrinsic, doughnuts are attached when signing:

const txHash = await api.tx.balances
  .transfer(keyring.charlie.address, "1_500_000_000")
  .signAndSend(keyring.alice, {doughnut: encoded_doughnut});

For a more detailed guide see using Doughnut with Pl^g