Javascript API Reference

Introduction to JS API

How to create a new JS API

Your JS API library can be injected into an API session from @polkadot/api in order to connect and transact with a Plug chain.

As an example, the "Plug types" contains additional data types required to use Doughnut. The codebase can be found here:Plug API types

The package is defined in package.json:

{
  "name": "@plugnet/plug-api-types",
  "version": "0.0.0",
  "description": "SDK type definitions for the Plug runtime",
  "main": "dist/index.js",
  ....
}

How to Import your JS API

To add your API as a dependency, add it to the package.json in your JS script:

// package.json
{ 
  "dependencies": {
    "@plugnet/plug-api-types": "git+https://github.com/plugblockchain/plug-api-types.git#1.0.0-rc2"
  }
}

In your JS script, you can now initialize and use your API:

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

async function main() {
  const provider = new WsProvider('ws://example.com:9944');
  const api = await ApiPromise.create({ 
    provider,
    types: PlugRuntimeTypes,
  });

  //...

}

Now you can make calls to your API library using the api object.

Using Doughnut in JS API

Creating Doughnuts

You can create a signed and encoded doughnut:

const Doughnut = require('plug-doughnut').Doughnut;
const domain = 'awesome_node';

const doughnut = Doughnut
    .new(issuer, holder, expiry, not_before)
    .add_domain(domain, 0x00)
    .sign(issuer_secrect_key)
    .encode();

Attaching Doughnuts to Extrinsic calls

You can add the encoded doughnut to the extrinsic call. This example creates a normal balance transfer with the encoded doughnut added in the option parameter.

// Create the API and wait until ready
const provider = new WsProvider("ws://localhost:9944");
const types = PlugRuntimeTypes.default;
const api = await ApiPromise.create({ provider, types });

// Send transfer extrinsic with doughnut
const options = { doughnut: doughnut.encode() };
const txHash = await api.tx.balances
  .transfer(keyring.bob.address, "1_500_000_000")
  .signAndSend(keyring.alice, options);