zkPass
zkPass Developer's Guide
zkPass Developer's Guide
  • â›Šī¸Introduction
  • ZKPASS OVERVIEW
    • đŸ›ī¸Architecture
    • 🧱zkPass Components
    • 🤝Trust Models
    • 🚚Deployment
      • Public-Cloud Hosting
      • Private-Cloud Hosting
      • On-Premise Hosting
    • đŸŽ¯SDK Objectives
    • 🔑API Key
  • zkPass Modules
    • â˜ī¸DVR
      • đŸ—ģHigh Level View
      • đŸ—ī¸Key Concepts
        • User Data
        • DVR Info
        • zkPass Proof
      • đŸ‘ĨDVR Client Roles
        • Data Issuer
          • Providing User Data Retrieval API
        • Data Holder
          • 1. Retrieving the DVR
          • 2. Retrieving the User Data
          • 3. Generating the Proof
          • 4. Verifying the Proof
        • Proof Verifier
          • 1. Providing DVR Retrieval API
          • 2. Providing Proof Verification API
      • 🔎DVR Query
        • Building Query Engine
        • Processing Query
        • Query Grammar
      • đŸ—ī¸Integration Guidelines
      • 🌊DVR Workflows
  • SDK Tutorial
    • Typescript
      • Running Code
      • Code Snippet
      • Directory Structure
    • Rust
      • Running Code
      • Code Snippet
      • Directory Structure
  • API Reference
    • Typescript
      • Classes
        • Class: DvrModuleClient
      • Functions
        • Functions: ffiHelper
        • Functions: jwtHelper
        • Functions: publicKeyOptionUtils
      • Type Aliases
        • Types
        • Types: ffiType
      • Interfaces
        • Interfaces
      • Constants
        • Constants
        • Enums
      • Errors
    • Rust
      • Building Rust doc
    • RESTful API
      • Overview
      • Endpoints
        • Generate Proof
      • Utilities
        • Generate Key Pair
        • Sign User Data and DVR
        • Encrypt User Data and DVR
      • Errors
  • Glossary
    • DVR
    • User Data
    • ZKP
Powered by GitBook
On this page
  • Key Technical Features
  • zkPass Modules
  • What Lies Ahead?
Export as PDF

Introduction

Welcome to the zkPass Developer's Guide. This document is engineered for developers, software architects, and technical leads who aim to implement Zero-Knowledge Proof (ZKP) functionalities in their applications via a scalable, cloud-based architecture. Through a Proof-As-a-Service model, zkPass offers an API-driven approach for ZKP computations, abstracting away the computational complexity and focusing on seamless integration.

zkPass is a specialized Proof-As-a-Service that enables the efficient execution of Zero-Knowledge Proofs (ZKPs) within a Trusted Execution Environment (TEE). The service exposes a set of APIs and an SDK library (zkpass-client) to facilitate the delegation of ZKP computational tasks to a cloud-based environment. This architectural choice is particularly beneficial for client devices with resource constraints, allowing for scalability without sacrificing data privacy.

Key Technical Features

zkPass Modules

The heart of zkPass is the zkPass module model. This is a privacy-preserving application which features the following characteristics:

  • Data Privacy zkPass uses state-of-the-art Zero Knowledge Proof (ZKP) to maintain data confidentiality. In addition, the cloud-based architecture operates within a TEE, providing an additional layer of security against the risks inherent to data centralization.

  • Verifiable Computation With Zero Knowledge Proof (ZKP) technology, the execution of zkPass modules becomes verifiable, ensuring the integrity and security of the code. This means that any attempt to tamper with or alter the application's code can be detected and prevented. This verifiability is crucial for maintaining trust in zkPass modules in a trustless fashion, as it ensures that the application operates as intended and that user data remains secure and confidential.

  • Scalable Computation Architecturally designed to serve a range of devices, from mobile endpoints to data centers.

  • Easy Integration The zkPass module presents high-level concepts that are easy to grasp, enabling a swift integration environment for third-party applications seeking to implement privacy-protecting features. This design ensures that developers can quickly understand and incorporate these concepts, facilitating the seamless addition of privacy measures into their applications.

While zkPass offers many advantages, it's crucial to note that the service-centric approach implies that sensitive user data will be processed on a centralized server. However, the TEE environment aims to mitigate this by adding an extra layer of security, ensuring the confidentiality and integrity of user data.

What Lies Ahead?

Continue to the subsequent sections for granular setup guidelines, extensive API documentation, code examples, and architectural discussions aimed to empower you to exploit the full capabilities of zkPass.

Thank you for considering zkPass for your application's ZKP requirements. We are eager to see your contributions to this evolving field!

NextArchitecture

Last updated 6 months ago

â›Šī¸
Page cover image