sovereign-nature / unique-sdk

Intro

The SDK is intended for developers whose goal is to implement Unique Network functions avoiding working with a low-level blockchain API. This SDK may be used as an npm package or REST API.

Table of Contents

• Getting started
• Packages
  • SDK
  • Web
  • Recipes

How to start

Add SDK to your JavaScript/TypeScript project with

npm install @unique-nft/sdk

or deploy your own SDK as HTTP REST Service with

docker run uniquenetwork/web:latest

You can also use Public endpoints. To learn more read SDK Deployment guide: Docker, Git.

Packages

SDK

SDK package contains npm package of SDK itself.

Web

As an alternative to the whole SDK, you can use proxy http serviсe for SDK to implement server logic - HTTP API Service. It is created to interact with the blockchain using simple HTTP requests. In general, this service provides the following functions:

1. Building an unsigned extrinsic
2. Extrinsic signing and verification using service (These functions should be implemented on client for safety)
3. Submitting an extrinsic

HTTP API Service also allows to upload images using IPFS, can be used with existing public nodes or with your own private nodes. Use service documentation to learn its methods.

Recipes

Here you can find some useful hints or life hacks that will ease using of SDK.