Skip to main content

Installation

image

Installing the Primus zkTLS SDK​

Welcome to the first step in integrating Primus zkTLS SDK into your project! This guide will walk you through the installation process and help you get started quickly.

Prerequisites​

Before you begin, make sure you have:

  • Node.js（version 18 or later）installed on your system
  • npm (usually comes with Node.js) or yarn as your package manager

Installation Steps​

1. Install the SDK​

Open your terminal and navigate to your project directory. Then run one of the following commands:

  • Using npm:
npm install --save @primuslabs/zktls-js-sdk
  • Using yarn:
yarn add --save @primuslabs/zktls-js-sdk

This command will download and install the Primus zkTLS SDK and its dependencies into your project.

2. Verify Installation​

To ensure the SDK was installed correctly, you can check your package.json file. You should see primuslabs/zktls-js-sdk listed in the dependencies section.

Importing the SDK​

After installation, you can import the SDK in your JavaScript or TypeScript files. Here's how:

import PrimusZKTLS from "@primuslabs/zktls-js-sdk"

Next Steps​

Congratulations! You've successfully installed the Primus zkTLS SDK. Here's what you can do next:

  1. Quick Start: Explore our Test Example to quickly experience the project in action.

  2. Real-World Usage: Check out the Production Example to learn how to use the SDK in a real-world application and create your first proof request.

If you need further support, feel free to reach out through our community on Discord.