SDK Integration

Importing the VWBL SDK to your Project

Integrating the SDK...?

SDK integration is the process of importing a library file (SDK), known as a software development kit, into your project in order to use the library file's functions. By integrating the VWBL SDK into a TypeScript project, you can easily create a NFT project. (e.g. a bespoke NFT market).

A VWBL SDK Demo App

The Integration Demo application demonstrates how to integrate the VWBL SDK in your app.

Download our Demo Application ​​

Step 1. Add the SDK to Your Project

Install the via npm or yarn to get started.

yarn add vwbl-sdk

nom install vwbl-sdk

Step 2. Create a VWBL Instance

In order to use functions in the VWBL SDK, you will need to create an instance of VWBL first.

const vwblInstance = new VWBL({
  web3,
  contractAddress: "0x...",
  manageKeyType: ManageKeyType.VWBL_NETWORK_SERVER,
  uploadContentType: UploadContentType.S3,
  uploadMetadataType: UploadMetadataType.S3,
  vwblNetworkUrl: "https://vwbl.network",
  awsConfig: {
    region: "ap-northeast-1",
    idPoolId: "ap-northeast-1:...",
    cloudFrontUrl: "https://d2d...7o5.cloudfront.net",
    bucketName: {
      metadata: "your_s3_bucket",
      content: "your_s3_bucket",
    },
  },
});

Constructor Options

*1 AWS Config

*2 IPFSConfig

VWBL SDK uses Pinata to upload IPFS.

Step 3. Use Functions of VWBL-SDK

Sign to Server

Signing is necessary before creating token or viewing contents.

await vwbl.sign();

Create NFT

await vwbl.managedCreateToken(
  name,
  description,
  fileContent,
  thumbnailContent,
  0 // royaltiesPercentage
);

Arguments

view contents ( get NFT metadata from given tokenId)

const token = await vwbl.getTokenById(tokenId);

Response

Example Response(called by non-NFT owner)

{
  id: 1,
  name: 'VWBL NFT',
  description: 'This is VWBL NFT',
  image: 'https://dadt0t1exaqoh.cloudfront.net/data/74c3b520-bc17-4727-b23c-5dc7de8fcfd4-bench.jpg',
  mimeType: 'video/mp4',
  owner: '0x8b8613A2cFe9Aa546a41Eab13F0V1a4c4F0b6054'
}

If the function is called by NFT owner, extra fields listed below will be returned.