Getting started

Overview

The SDK facilitates seamless integration of Unique Network's capabilities into the web3 application, bypassing the need for direct low-level API interaction. It enables you to effortlessly mint collections and tokens, manage account balances, and more.

All transactions require a fee so that you can use Opal tokens for test purposes. You can get them free in Telegram faucet bot.

• Overview
• Installation
• Creating SDK instance
• Creating accounts
  • Get an account from the mnemonic phrase
  • Providers
• Creating collections and NFTs
• Transfer NFT
• Batch several transactions

Installation

Install @unique-nft/sdk for Unique Network interaction and @unique-nft/accounts for account management.

npm install @unique-nft/sdk @unique-nft/accounts @unique-nft/sr25519

yarn add @unique-nft/sdk @unique-nft/accounts @unique-nft/sr25519

Creating SDK instance

In the baseUrl parameter, you must pass one of the paths to the network. For a complete list of endpoints, refer to the reference.

You can also set a default signer; for this, you must set the seed phrase to the signer option.

const mnemonic = "<SET THE MNEMONIC SEED PHRASE FOR THE DEFAULT SIGNER>";
const account = Sr25519Account.fromUri(mnemonic);

// set "account" as a default signer
const sdk = new Sdk({
  baseUrl: CHAIN_CONFIG.opal.restUrl,
  account,
});

Creating accounts

Get an account from the mnemonic phrase

If you already have a mnemonic phrase, you can use it to get an account. Here is what the phrase looks like:

affair spoon other impact target solve extra range cute myself float panda

Here is how we can use it to get an account.

import { Sr25519Account } from "@unique-nft/sr25519";

const mnemonic = "<SET THE MNEMONIC SEED PHRASE FOR THE DEFAULT SIGNER>";
const account = Sr25519Account.fromUri(mnemonic);
console.log(account);

Console log output

{
  mnemonic: 'affair spoon other impact target solve extra range cute myself float panda',
  seed: '0x2a5dd888c0fb536c7c82ee53bb44ca49825ab134dd5a9c09e62423eeba30847b',
  publicKey: '0x094bb2d311460005c5072635beb8a11c8f15521d2136bdfbab3163af3c21412e',
  keyfile: {
    encoded: 'MFMCAQEwBQYDK2VwBCIEICpd2IjA+1NsfILuU7tEykmCWrE03VqcCeYkI+66MIR7Ji4DUViFrOGgvhQNVi8elFCpHSDekzUg/5dpSD2lZsuhIwMhACYuA1FYhazhoL4UDVYvHpRQqR0g3pM1IP+XaUg9pWbL',
    encoding: { content: [Array], type: [Array], version: '3' },
    address: '5CvmLzTcAfSFJgRiJ7DbKYwDUMcRBbNAa3bQeCrNM2nXTvBk',
    meta: {}
  }
}

Providers

You can contact the provider directly if you need to get an account from a specific provider, like polkadot{.js} or Metamask.

The following providers are supported:

// The provider works directly with the chain using `KeyringPair` from the `@polkadotkeyring` package.
import { Account } from '@unique-nft/accounts';
import { KeyringProvider } from '@unique-nft/accounts/keyring';
import { KeyringOptions } from '@polkadot/keyring/types';

const options: KeyringOptions = {
  type: 'sr25519',
  };
  const provider = new KeyringProvider(options);
  await provider.init();

const signer1 = provider.addSeed('<seed of account>');
const signer2 = provider.addKeyfile('<json keyfile>');

import { Account } from '@unique-nft/accounts';
import { KeyringPair } from '@polkadot/keyring/types';
import {
  KeyringLocalOptions,
  KeyringLocalProvider,
  } from '@unique-nft/accounts/keyring-local';

const options: KeyringLocalOptions = {
  type: 'sr25519',
  passwordCallback: async (keyring: KeyringPair) => {
    return '<password>';
      },
      };
      const provider = new KeyringLocalProvider(options);
      await provider.init();

const signer = provider.addUri('<uri of account>', '<password>');

// The provider uses the Polkadot extension (https://polkadot.js.org/extension) for the browser.
import { Web3AccountsOptions } from '@polkadot/extension-inject/types';
import { Account } from '@unique-nft/accounts';
import { PolkadotProvider } from '@unique-nft/accounts/polkadot';

const options: Web3AccountsOptions = {
  accountType: ['sr25519'],
  };
  const provider = new PolkadotProvider(options);
  await provider.init();

const signer = await provider.first();

// The provider uses the Metamask extension (https://metamask.io/download) for the browser.
import { Account } from '@unique-nft/accounts';
import { MetamaskProvider } from '@unique-nft/accounts/metamask';

const provider = new MetamaskProvider();
await provider.init();

const signer = await provider.first();

Creating collections and NFTs

// ... sdk initialization 

const { parsed, error } = await sdk.collection.create.submitWaitResult({
  name: "Test collection",
  description: "My test collection",
  tokenPrefix: "TST",
});

if (error) throw Error("Error occurred while creating a collection");
if (!parsed) throw Error("Cannot parse results");

const { collectionId } = parsed;
const collection = await sdk.collection.get({ collectionId });

// Create NFT
await sdk.token.create({ collectionId });
// ...

Transfer NFT

await sdk.token.transfer({
  collectionId,
  tokenId: 1,
  to: "5EZDbVxdAYH6mB7uAnoUUvaXDL2LyEmYxpsEn9NWajqpQJ2W",
});

Batch several transactions

You should manually increase nonce if you want to send several transactions in one block.

  let { nonce } = await sdk.common.getNonce({ address: signer.address });

  await Promise.all([
    sdk.balance.transfer.submitWaitResult(
      {
        amount: 100,
        destination: "5CiRmhr6pd3YyU2VPR4ePTVxw2FddTiZeocEiiZbvq4XDACq",
      },
      { nonce: nonce++ },
    ),
    sdk.balance.transfer.submitWaitResult(
      {
        amount: 100,
        destination: "5E7DCdEPC8enm49fkQ6ipkxo2EA1F3qZ5WiaaCdeppxQ9ejD",
      },
      { nonce: nonce++ },
    ),
  ]);