Getting started

This section is dedicated to providing a comprehensive guide on installing and setting up the PAKT SDK in your NodeJS project.

Installation

To use the PAKT SDK, you first need to install it using npm command. To do so, run:

npm install pakt-sdk

or

yarn add pakt-sdk

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can access or generate your API key from the control panel tab within Pakt's Command Center. Before attempting to access, ensure you have a paid and deployed Chainsite.

To deploy and activate a chainsite, follow this guide on Deploying a Pakt Chainsite

Initialization

To initialize, use the following code block:

Typescript

import PaktSDK from "pakt-sdk";

const apiKey = config.PAKT_SDK_API_KEY;
const configData: PaktConfig = {
  token: apiKey,
  verbose: true,
};

const sdkInit = await PaktSDK.init(configData);

Javascript

const PaktSDK = require("pakt-sdk");

const apiKey = config.PAKT_SDK_API_KEY;
const configData = {
  token: apiKey,
  verbose: true,
};
const sdkInit = await PaktSDK.init(configData);

Make your first request

The above code initializes the PAKT SDK and ensures the Command Centre generates the API Key.

---

Making calls with the PAKT SDK is straightforward. Refer to the code blocks below for examples. The SDK is also typed with the models and includes a default wrapper.ResponseDto<T>.

ResponseDto<T> Is declared as:

interface ResponseDto<T> {
  data: T;
  status: Status;
  message?: string;
  code?: string;
}

//For example, from the initialized sdk, we can log in this way:

const auth: ResponseDto<UserModelDto> = await sdkInit.auth.login();