Class: DataVerificationRequest

This class is typically created by the Proof Verifier client, and the DVR represents a request to verify certain attributes or properties of a user data.

Table of contents

Constructors

• constructor

Properties

• dvrId

• dvrTitle

• dvrVerifyingKey

• query

• queryEngineVer

• queryMethodVer

• userDataRequests

• zkVm

Methods

• getSha256Digest

• serialize

• serializeJson

• signToJwsToken

• deserialize

• fromJSON

Constructors

constructor

• new DataVerificationRequest(dvrTitle, dvrId, queryEngineVer, queryMethodVer, query, userDataRequests, dvrVerifyingKey?): DataVerificationRequest

Parameters

Name	Type
zkVm	string
dvrTitle	string
dvrId	string
queryEngineVer	string
queryMethodVer	string
query	ZkpassQuery | string
userDataRequests	UserDataRequests
dvrVerifyingKey?	PublicKeyOption

Returns

DataVerificationRequest

Properties

dvrId

• dvrId: string

The unique id of the DVR

---

dvrTitle

• dvrTitle: string

The title of the DVR

---

dvrVerifyingKey

• Optional dvrVerifyingKey: PublicKeyOption

The verifying key of the DVR

---

query

• query: ZkpassQuery

The zkPass Query script

---

queryEngineVer

• queryEngineVer: string

The version of the zkpass query engine used to create the DVR

---

queryMethodVer

• queryMethodVer: string

The version of the zkpass query method used to create the DVR

---

userDataRequests

• userDataRequests: UserDataRequests

An object containing one or more user data verifying key and url for the respective user data provided

---

zkVm

• zkVm: string

The option of zkVM. We're planning to support multiple zkVMs.

This field could be filled with r0

Methods

getSha256Digest

▸ getSha256Digest(): string

Returns the DVR's SHA256 digest

Returns

string

---

serialize

▸ serialize(): string

Serializes the DVR into JSON string format

Returns

string

---

serializeJson

▸ serializeJson(): Object

Serializes the DVR into JSON object

Returns

Object

---

signToJwsToken

▸ signToJwsToken(pem, verifyingKeyJWKS?): Promise<string>

Signs the DVR into JWS token

Parameters

Name	Type
pem	string
verifyingKeyJWKS?	KeysetEndpoint

Returns

Promise<string>

---

deserialize

▸ deserialize(json): DataVerificationRequest

Deserializes JSON string into DVR object

Parameters

Name	Type
json	string

Returns

DataVerificationRequest

---

fromJSON

▸ fromJSON(«destructured»): DataVerificationRequest

Deserializes JSON object into DVR object

Parameters

Name	Type
«destructured»	any

Returns

DataVerificationRequest