TypeScript/Node.js/Linux

For the purposes of this guide, thezkpass-sdk repository is cloned into the home directory of the current user, retaining its default name. This places thezkpass-sdk repository at ~/zkpass-sdk. As a result, the root directory for the zkpass-client-ts SDK is set to ~/zkpass-sdk/typescript/node-js.

Should you choose to clone the zkpass-sdk repository into a different location, ensure that you adjust any referenced paths in the instructions to match your chosen directory structure.

SDK Setup Sections

This guide is divided into three main sections to help you navigate through the setup and usage of the zkpass-client-ts SDK:

1. Client SDK Setup

   • Directory: ~/zkpass-sdk/typescript/node-js/client

   • This section covers the setup and installation of the Client SDK. It includes detailed instructions on how to configure and run the client-side components of the zkpass-client-ts SDK.

2. CLI Demo Setup

   • Directory: ~/zkpass-sdk/typescript/node-js/cli

   • This section provides a step-by-step guide to setting up and running the Command Line Interface (CLI) demo. It explains how to configure the CLI environment and use the provided demo scripts to interact with the SDK.

3. Issuer-Verifier SDK Setup

   • Directory: ~/zkpass-sdk/typescript/node-js/issuer-verifier

   • This section details the setup process for the Issuer and Verifier components of the SDK. It includes instructions on how to install, configure, and use these components to perform verification tasks within the zkpass-client-ts SDK framework.

Each section contains specific instructions and examples to help you understand and implement the different parts of the zkpass-client-ts SDK. Make sure to follow the instructions in each section to ensure a smooth setup process.