CircuitValue

SnarkyJS / Modules / CircuitValue

Class: CircuitValue

Deprecated

CircuitValue is deprecated in favor of Struct, which features a simpler API and better typing.

Hierarchy

• CircuitValue

  ↳ UInt32

  ↳ UInt64

  ↳ Int64

  ↳ Sign

  ↳ PublicKey

  ↳ Character

  ↳ CircuitString

  ↳ MerkleMapWitness

  ↳ PrivateKey

  ↳ Signature

Table of contents

Constructors

• constructor

Methods

• assertEquals
• equals
• isConstant
• toConstant
• toFields
• toJSON
• check
• fromFields
• fromJSON
• fromObject
• sizeInFields
• toAuxiliary
• toConstant
• toFields
• toInput
• toJSON

Constructors

constructor

• new CircuitValue(...props)

Parameters

Name	Type
...props	any[]

Defined in

lib/circuit_value.ts:70

Methods

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	CircuitValue

Returns

void

Defined in

lib/circuit_value.ts:158

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	CircuitValue

Returns

Bool

Defined in

lib/circuit_value.ts:154

---

isConstant

▸ isConstant(): boolean

Returns

boolean

Defined in

lib/circuit_value.ts:162

---

toConstant

▸ toConstant(): CircuitValue

Returns

CircuitValue

Defined in

lib/circuit_value.ts:150

---

toFields

▸ toFields(): Field[]

Returns

Field[]

Defined in

lib/circuit_value.ts:142

---

toJSON

▸ toJSON(): any

Returns

any

Defined in

lib/circuit_value.ts:146

---

check

▸ Static check<T>(this, v): void

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

void

Defined in

lib/circuit_value.ts:191

---

fromFields

▸ Static fromFields<T>(this, xs): InstanceType<T>

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
xs	Field[]

Returns

InstanceType<T>

Defined in

lib/circuit_value.ts:166

---

fromJSON

▸ Static fromJSON<T>(this, value): InstanceType<T>

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	any

Returns

InstanceType<T>

Defined in

lib/circuit_value.ts:224

---

fromObject

▸ Static fromObject<T>(this, value): InstanceType<T>

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	NonMethods<InstanceType<T>>

Returns

InstanceType<T>

Defined in

lib/circuit_value.ts:87

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Defined in

lib/circuit_value.ts:94

---

toAuxiliary

▸ Static toAuxiliary(): []

Returns

[]

Defined in

lib/circuit_value.ts:116

---

toConstant

▸ Static toConstant<T>(this, t): InstanceType<T>

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
t	InstanceType<T>

Returns

InstanceType<T>

Defined in

lib/circuit_value.ts:205

---

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

Field[]

Defined in

lib/circuit_value.ts:99

---

toInput

▸ Static toInput<T>(this, v): HashInput

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

HashInput

Defined in

lib/circuit_value.ts:120

---

toJSON

▸ Static toJSON<T>(this, v): any

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

any

Defined in

lib/circuit_value.ts:213