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.

Issuer-Verifier SDK Structures

To find out how the issuer-verifier SDK is structured, at the root of the zkPass SDK run the following:

cd ~/zkpass-sdk/typescript/node-js/issuer-verifier
tree -L 2

The output should look like this:

├── LICENSE
├── next.config.js
├── node_modules
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── issuer
│   └── verifier
├── README.md
├── src
│   ├── app
│   └── utils
├── tailwind.config.ts
└── tsconfig.json

Here are the descriptions for each sub directory:

• node_modules This contains all packages that are installed when running npm i. These packages are needed to run the sdk and app.

• src This is the main cli demo source code.

Client SDK Structures

To find out how the client SDK is structured, at the root of the zkPass SDK run the following:

cd ~/zkpass-sdk/typescript/node-js/client
tree -L 2

The output should look like this:

├── LICENSE
├── next.config.js
├── node_modules
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── next.svg
│   └── vercel.svg
├── README.md
├── src
│   ├── app
│   ├── components
│   └── utils
├── tailwind.config.js
├── tailwind.config.ts
└── tsconfig.json

Here are the descriptions for each sub directory:

• node_modules This contains all packages that are installed when running npm i. These packages are needed to run the sdk and app.

• src This is the main cli demo source code.

SDK Structures

To find out how the SDK is structured, at the root of the zkPass SDK run the following:

cd ~/zkpass-sdk/typescript/node-js/cli
tree -L 2

The output should look like this:

├── LICENSE
├── package.json
├── package-lock.json
├── README.md
├── src
│   ├── index.ts
│   ├── libs
│   ├── MyHolder.ts
│   ├── MyIssuer.ts
│   ├── MyVerifier.ts
│   └── utils
├── test
│   └── data
└── tsconfig.json

Here are the descriptions for each sub directory:

• src This is the main cli demo source code.

• test/data This contains several test queries and their related user data in json encoding. You can use this test data when running the cli demo.