Class ZkProof

Hierarchy (view full)

CustomTypeClass<ZkProof>
- ZkProof

Implements

iZkProof

Index

Constructors

Properties

customData uri verificationKey zkpTrackerId

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromJson fromJsonString fromProto

Constructors

constructor

new ZkProof(zkProof): ZkProof
Parameters
- zkProof: iZkProof
Returns ZkProof
Overrides CustomTypeClass.constructor
- Defined in src/core/misc.ts:282

Properties

customData

customData: string

Arbitrary custom data that can be stored on-chain.

uri

uri: string

The URI where to fetch the zkProof metadata from.

verificationKey

verificationKey: string

The verification key of the zkProof.

zkpTrackerId

zkpTrackerId: string

ZKP tracker ID.

Methods

clone

clone(): ZkProof
Deep copies the object and returns a new instance.

Returns ZkProof
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:75

convert

convert<U>(_convertFunction?, options?): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional_convertFunction: ((val: NumberType) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns CustomType<any>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Inherited from CustomTypeClass.convert
- Defined in src/common/base.ts:94

equals

equals<U>(other, normalizeNumberTypes?): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in src/common/base.ts:71

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Inherited from CustomTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:81

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in src/common/base.ts:85

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in src/common/base.ts:63

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:67

toProto

toProto(): proto.badges.ZkProof
Returns proto.badges.ZkProof
- Defined in src/core/misc.ts:290

`Static`fromJson

fromJson(jsonValue, options?): ZkProof
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns ZkProof
- Defined in src/core/misc.ts:294

`Static`fromJsonString

fromJsonString(jsonString, options?): ZkProof
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns ZkProof
- Defined in src/core/misc.ts:298

`Static`fromProto

fromProto(item): ZkProof
Parameters
- item: proto.badges.ZkProof
Returns ZkProof
- Defined in src/core/misc.ts:302