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
Export as PDF
  1. API Reference
  2. Typescript

Errors

A collection of error codes reference for the DVR module

PreviousEnumsNextRust

Last updated 5 months ago

Error Messages

The following table lists all error messages used across the DVR client modules:

Module
Error Message
Description

MISSING_PUBLIC_KEY_VALUES

Thrown when a public key option is missing 'x' or 'y' values

MISSING_KEYSET_ENDPOINT_VALUES

Thrown when a keyset endpoint option is missing 'jku' or 'kid' values

INVALID_PUBLIC_KEY_OPTION_TYPE

Thrown when an invalid public key option type is provided

MISSING_USER_DATA_REQUESTS

Thrown when user_data_requests array is empty

MISSING_USER_DATA_VERIFYING_KEYS

Thrown when user_data_verifying_keys array is empty

ERROR_INVALID_PAYLOAD

Thrown when parsed payload is not of type DvrData

ERROR_INVALID_JWT

Thrown when JWT token format is invalid

ERROR_INVALID_ZK_PROOF

Thrown when ZK proof payload format is invalid

INVALID_INPUT

Thrown when input is neither a valid PublicKey nor KeysetEndpoint

INVALID_TOKEN

Constant string representing an invalid token

INVALID_VERIFY_PROOF

JSON string representing an invalid verify proof error

FFI Helpers
FFI Helpers
FFI Helpers
FFI Helpers
FFI Helpers
JWT Helpers
JWT Helpers
JWT Helpers
Public Key Utils
Interface
Interface