CLI Demo Setup

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/cli.

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 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.