SDK Documentation

The SDK documentation explains the series of libraries and functions that help dApps interact with the Heima protocol and the IdentityHub.

The client-sdk is a series of libraries authored by the Heima team to help dApps interact with the Heima protocol and the IdentityHub.

With the client-sdk , dApps can:

• Link identities.

• Request Verifiable Credentials.

• Verify Verifiable Credentials.

• Query an id_graph and its hash

Installation of the Client SDK packages

The client-sdk is distributed as a series of TypeScript packages available publicly on NPM. Install the packages by running:

npm install @heima/parachain-api @heima/sidechain-api @heima/chaindata @heima/client-sdk

The following dependencies are needed too, if not installed already:

npm install @polkadot/api

Instantiate a new API connection

The client-sdk requires a Polkadot.js ApiPromise instance with the provider pointing to the Heima Protocol networks.

Create a new Api instance using Heima's network type definitions.

import { ApiPromise, WsProvider } from '@polkadot/api';
import { getChain } from '@heima/chaindata';
import {
  identity,
  vc,
  sidechain,
  trusted_operations,
} from '@heima/parachain-api';

const heimaNetworkApiTypes = {
  ...identity.types,
  ...vc.types,
  ...sidechain.types,
  ...trusted_operations.types,
};

const heimaProductionSpec = getChain('heima-prod');

const wsProvider = new WsProvider(
  heimaProductionSpec.rpcs[0].url
);

const api = await ApiPromise.create({
  provider: wsProvider,
  types: heimaNetworkApiTypes,
});

Next, check what dApps can do with the client-sdk.