Types: ffiType

A collection of FFI types used in the DVR module

Table of contents

Types: ffiType

• FfiResultUserDataToken

• FfiResultDvrToken

• FfiResultZkPassProofToken

• FfiResultVerifyZkPassProofToken

• PublicKeyFfi

• KeysetEndpointFfi

• PublicKeyOptionUnionFfi

• PublicKeyOptionFfi

• UserDataRequestFfi

• DvrDataFfi

• ExpectedDvrMetadataFfi

• UserDataRequestArrayFfi

• UserDataVerifyingKeysFfi

Types: ffiType

FfiResultUserDataToken

▸ FfiResultUserDataToken: StructType A structure representing the result of a user data token operation.

Parameters:

Name	Type	Description
result	ref.refType(ref.types.CString)	The operation result
error	ref.types.CString	Error message if any

---

FfiResultDvrToken

▸ FfiResultDvrToken: StructType A structure representing the result of a DVR token operation.

Parameters:

Name	Type	Description
result	ref.refType(ref.types.CString)	The operation result
error	ref.types.CString	Error message if any

---

FfiResultZkPassProofToken

▸ FfiResultZkPassProofToken: StructType A structure representing the result of a zkPass proof token operation.

Parameters:

Name	Type	Description
result	ref.refType(ref.types.CString)	The operation result
error	ref.types.CString	Error message if any

---

FfiResultVerifyZkPassProofToken

▸ FfiResultVerifyZkPassProofToken: StructType A structure representing the result of a zkPass proof verification token operation.

Parameters:

Name	Type	Description
result	ref.refType(ref.types.CString)	The operation result
error	ref.types.CString	Error message if any

---

PublicKeyFfi

▸ PublicKeyFfi: StructType A structure representing a public key.

Parameters:

Name	Type	Description
x	ref.types.CString	X coordinate of the public key
y	ref.types.CString	Y coordinate of the public key

---

KeysetEndpointFfi

▸ KeysetEndpointFfi: StructType A structure representing a keyset endpoint.

Parameters:

Name	Type	Description
jku	ref.types.CString	JSON Web Key Set URL
kid	ref.types.CString	Key identifier

---

PublicKeyOptionUnionFfi

▸ PublicKeyOptionUnionFfi: StructType A structure representing a union of public key and keyset endpoint.

Parameters:

Name	Type	Description
public_key	PublicKeyFfi	The public key structure
keyset_endpoint	KeysetEndpointFfi	The keyset endpoint structure

---

PublicKeyOptionFfi

▸ PublicKeyOptionFfi: StructType A structure representing a public key option with tag and value.

Parameters:

Name	Type	Description
tag	ref.types.uint64	Type identifier
value	PublicKeyOptionUnionFfi	The key data

---

UserDataRequestFfi

▸ UserDataRequestFfi: StructType A structure representing a user data request.

Parameters:

Name	Type	Description
key	ref.types.CString	Request key
value	PublicKeyOptionFfi	Request value

---

DvrDataFfi

▸ DvrDataFfi: StructType A structure representing DVR data.

Parameters:

Name	Type	Description
zkvm	ref.types.CString	ZKVM identifier
dvr_title	ref.types.CString	DVR title
dvr_id	ref.types.CString	DVR identifier
query	ref.types.CString	Query string
user_data_requests	UserDataRequestArrayFfi	Array of user data requests
user_data_requests_len	ref.types.uint64	Length of user data requests array
dvr_verifying_key	PublicKeyOptionFfi	DVR verifying key

---

ExpectedDvrMetadataFfi

▸ ExpectedDvrMetadataFfi: StructType A structure representing expected DVR metadata.

Parameters:

Name	Type	Description
ttl	ref.types.uint64	Time to live
dvr	ref.types.CString	DVR data token
user_data_verifying_keys	UserDataVerifyingKeysFfi	Array of verifying keys
user_data_verifying_keys_len	ref.types.uint64	Length of verifying keys array

UserDataRequestArrayFfi

▸ UserDataRequestArrayFfi: ArrayType An array type of UserDataRequestFfi structures.

---

UserDataVerifyingKeysFfi

▸ UserDataVerifyingKeysFfi: ArrayType An array type of UserDataRequestFfi structures used for verifying keys.