@novasamatech/spektr-sdk

Easy way to embed Spektr functionality into your dapp.

Overview

Spektr SDK provides a set of tools to integrate your application with Spektr dapp browser. Core features:

• Generic account provider similar to polkadot-js extension.
• Redirect PAPI requests to host application
• Receive additional information from host application - supported chains, theme, etc.

Installation

npm install @novasamatech/spektr-sdk --save -E

Usage

Injecting account provider into injectedWeb3 interface

Spektr SDK can provide account information and signers with same interface as any other polkadot compatible wallet.

import { injectSpektrExtension, SpektrExtensionName } from '@novasamatech/spektr-sdk';
import { connectInjectedExtension, type InjectedPolkadotAccount } from '@polkadot-api/pjs-signer';

async function getSpektrExtension() {
  const ready = await injectSpektrExtension();

  if (ready) {
    return connectInjectedExtension(SpektrExtensionName)
  }

  return null;
}

async function getAccounts(): Promise<InjectedPolkadotAccount[]> {
  const extension = await getSpektrExtension();

  if (extension) {
    return extension.getAccounts()
  }

  // fallback to other providers
  return [];
}

Redirecting PAPI requests to host application

You can wrap your PAPI provider with spektr provider to support redirecting requests to host application.

import { createClient, type PolkadotClient } from 'polkadot-api';
import { getWsProvider } from 'polkadot-api/ws-provider';
import { createSpektrPapiProvider, WellKnownChain } from '@novasamatech/spektr-sdk';

function createPapiClient(): PolkadotClient {
  const polkadotEndpoint = 'wss://...';

-  const provider = getWsProvider(polkadotEndpoint);
+  const provider = createSpektrPapiProvider({
+    chainId: WellKnownChain.polkadotRelay,
+    fallback: getWsProvider(polkadotEndpoint),
+  });

  return createClient(provider);
}