Interfaces

A collection of interfaces used in the DVR module

Table of contents

Interfaces

Interfaces

PublicKey

▸ PublicKey: Object

Represents a public key with x and y coordinates.

Name
Type
Description

x

string

X coordinate of the public key

y

string

Y coordinate of the public key


KeysetEndpoint

▸ KeysetEndpoint: Object

Represents a keyset endpoint configuration.

Name
Type
Description

jku

string

JSON Web Key Set URL

kid

string

Key identifier


PublicKeyOptionUnion

▸ PublicKeyOptionUnion: Object

Union of possible public key options.

Name
Type
Description

keyset_endpoint?

Optional keyset endpoint

public_key?

Optional public key


PublicKeyOption

▸ PublicKeyOption: Object

Configuration for public key options.

Name
Type
Description

tag

Type of the public key option

value

Value of the public key option


UserDataRequest

▸ UserDataRequest: Object

Request format for user data.

Name
Type
Description

key

string

Key for the user data

value

Verifying key or endpoint


DvrData

▸ DvrData: Object

Data structure for DVR operations.

Name
Type
Description

zkvm

string

ZK Virtual Machine identifier

dvr_title

string

Title of the DVR

dvr_id

string

Identifier of the DVR

query

string

Query string

user_data_requests

Array of user data requests

dvr_verifying_key

Key for verifying DVR


DvrDataPayload

▸ DvrDataPayload: Object

Payload format for DVR data.

Name
Type
Description

zkvm

string

ZK Virtual Machine identifier

dvr_title

string

Title of the DVR

dvr_id

string

Identifier of the DVR

query

string

Query string

query_engine_ver

string

Query engine version

query_method_ver

string

Query method version

user_data_requests

object

User data requests

dvr_verifying_key

object

Key for verifying DVR


ExpectedDvrMetadata

▸ ExpectedDvrMetadata: Object

Expected metadata for DVR operations.

Name
Type
Description

ttl

number

Time to live

dvr

string

DVR string

user_data_verifying_keys

Array of user data verifying keys

Last updated