Directory Structure

At the root of the ozki-toolkit git repository, the structure of the directories looks like the following:

├── common
│   └── src
├── dist
│   ├── common
│   ├── proof-generator
│   └── proof-verifier
├── proof-generator
│   ├── src
│   └── static
├── proof-verifier
│   ├── src
│   └── static
├── tests
│   ├── build
│   ├── node_modules
│   └── src
├── typings
└── zkp
    ├── circuits
    ├── proof-functions
    ├── tests
    └── tools

The directories of interest are explained below:

• common, proof-generator, proof-verifier These are directories for the implementation codes for the ozki-lib. The ozki-lib has general interfaces which can work with any custom circom programs. In general you don't need make any changes to the library.

• tests Contains unit tests for the circom proof functions

• zkp/circuits A collection of supporting circom libraries, mostly are from circomlibjs, plus a few from OZKi. If you are writing a circom program which is to be as common component, this is the recommended directory.

• zkp/proof-functions These are where the app-specific circom proof functions are located by default. If you add new circom proof functions for your apps, it is recommended you place them onto these directories for consistency. By default the toolkit comes with two proof functions: ProvePayPalSubscriptionMain and ProveGoogleAuthMain.