Class: DvrModuleClient

Client class for the DVR module, accessing the DVR module functions

Table of contents

Constructors

• constructor

Properties

• credentials

• library

• PACKAGE_NAME

• LIBRARY_NAME

Methods

• loadLibrary

• callDvrGenerateUserDataToken

• callDvrGenerateQueryToken

• callDvrGenerateZkPassProof

• callDvrVerifyZkPassProof

Constructors

constructor

• new DvrModuleClient(config): DvrModuleClient

Constructs a new instance of the DvrModuleClient.

Parameters

Name	Type	Description
config	PrivacyAppClientConfig	Configuration object
config.baseUrl	string	The base URL for the API
config.apiKey	string	The API key for authentication
config.secretApiKey	string	The secret API key for authentication

Returns

DvrModuleClient

Properties

credentials

• private credentials: PrivacyAppCredentialsStruct

The credentials structure containing authentication details for the Privacy App Client, including base URL, API key, and secret API key.

---

library

• private library: ReturnType<typeof loadLibrary>

The loaded library instance containing the foreign function interface (FFI) definitions for DVR module functions.

---

PACKAGE_NAME

• private PACKAGE_NAME: "@zkpass/dvr-client-ts" : string

The NPM package name for the DVR client TypeScript library.

---

LIBRARY_NAME

• private LIBRARY_NAME: "libdvr_client.so" : string

The name of the shared library file that contains the DVR client implementation.

Methods

loadLibrary

▸ private loadLibrary(): Object

Loads the specified library and defines the foreign function interface (FFI) for the DVR module.

Returns

Object - An object representing the loaded library with the defined FFI functions

The following functions are defined in the FFI:

• dvr_generate_user_data_token

• dvr_generate_query_token

• dvr_generate_zkpass_proof

• dvr_verify_zkpass_proof

---

callDvrGenerateUserDataToken

▸ callDvrGenerateUserDataToken(signingKey, stringifiedUserData, verifyingKeyOptionParam): string

Generates a user data JWS token using the provided signing key, user data, and public key option.

Parameters

Name	Type	Description
signingKey	string	The key used to sign the user data token
stringifiedUserData	string	The user data in stringified format
verifyingKeyOptionParam	PublicKeyOrKeysetEndpoint	The associated key to verify the user data token

Returns

string - The generated user data token, or throws an error if generation fails

---

callDvrGenerateQueryToken

▸ callDvrGenerateQueryToken(signingKey, dvrData): string

Generates a DVR query JWS token using the provided signing key and DVR data.

Parameters

Name	Type	Description
signingKey	string	The key used to sign the DVR query
dvrData	DvrData	The data required for generating the DVR query token

Returns

string - The generated DVR query token, or throws an error if generation fails

---

callDvrGenerateZkPassProof

▸ callDvrGenerateZkPassProof(stringifiedUserDataTokens, dvrtoken): string

Parameters

Name	Type	Description
stringifiedUserDataTokens	string	Stringified representation of multiple user data tokens using tag as the key
dvrtoken	string	The DVR token to be used in the proof generation

Returns

string - The generated zkPass proof, or throws an error if generation fails

---

callDvrVerifyZkPassProof

▸ callDvrVerifyZkPassProof(zkvm, zkPassProofToken, expectedMetaData): VerifyZkPassProofResult

Parameters

Name	Type	Description
zkvm	string	The zkVM identifier
zkPassProofToken	string	The zkPass proof token to be verified
expectedMetaData	ExpectedDvrMetadata	The expected metadata for the DVR verification

Returns

VerifyZkPassProofResult - The output committed into the zkPass proof, and the zkPass proof data