πŸš€Quick Start

The zkPass Software Development Kit (SDK) consists of the following components:

  1. Client Libraries At the heart of the zkPass SDK is the client library calledzkpass-client. There are three versions of the client library for supporting different language/platform configurations, but basically, they all work the same way. These libraries are essential for participants in the zkPass ecosystem. They simplify and streamline various processes, including the digital signing and verification of data, the generation of proofs, and the validation of these proofs. By using these libraries, developers can efficiently integrate zkPass functionalities into their applications, ensuring secure and reliable data handling.

  2. Developer Tool The SDK includes a convenient Command-Line Interface (CLI) tool known as 'zkpass-query-tool'. This tool is specifically designed to assist developers in learning how to craft zkPass queries effectively. It's an invaluable resource for testing and refining query scripts, making the learning curve smoother for those new to writing zkPass queries.

  3. Sample Demo Applications To further aid in understanding and implementation, the zkPass SDK provides a range of sample demo applications. These applications serve as practical examples, showcasing the coding practices and steps involved in integrating apps with the zkPass Service. They are invaluable for developers looking to get a hands-on feel of how zkPass works in real-world scenarios.

  4. Documentation The Developer’s Guide (this book) is an integral component of the SDK. It serves as a comprehensive source of information, covering everything from basic setup to advanced functionalities of zkPass. This guide is the go-to reference for developers seeking to deepen their understanding of the zkPass system and leverage its capabilities effectively.

Each of these components plays a critical role in making the zkPass SDK a robust and versatile toolkit for developers looking to harness the power of Zero-Knowledge Proofs in their applications.

Supported Platforms

The zkPass Software Development Kit (SDK) library, called the zkpass-client, is available in three bindings based on the language/platform/OS configuration. These bindings facilitate the integration of zkPass services by providing a client-side library tailored to streamline the implementation process.

  • Typescript/Node.js/Linux Suitable for server-side applications running on Node.js. The library is called zkpass-client-ts NPM package.

  • Typescript/React Native/Android Ideal for client-side applications, specifically in React Native mobile app development. The library is called zkpass-client-react-native.

  • Rust/Linux Provides a robust option for system-level and high-performance applications. The library is called zkpass-client crate.

All library versions are designed with parallel functionality, ensuring a consistent development experience. They empower developers to efficiently harness the capabilities of zkPass within their applications. Regardless of the language/platform binding, all zkpass-client libs behave the same way in terms of how they interact in the zkPass workflow, as depicted in the diagram.

Last updated

Copyright Β© 2023 GDP Labs