CircuitValue

o1js / 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
• empty
• 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:79

Methods

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	CircuitValue

Returns

void

Defined in

lib/circuit-value.ts:167

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	CircuitValue

Returns

Bool

Defined in

lib/circuit-value.ts:163

---

isConstant

▸ isConstant(): boolean

Returns

boolean

Defined in

lib/circuit-value.ts:171

---

toConstant

▸ toConstant(): CircuitValue

Returns

CircuitValue

Defined in

lib/circuit-value.ts:159

---

toFields

▸ toFields(): Field[]

Returns

Field[]

Defined in

lib/circuit-value.ts:151

---

toJSON

▸ toJSON(): any

Returns

any

Defined in

lib/circuit-value.ts:155

---

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:200

---

empty

▸ Static empty\<T>(): InstanceType\<T>

Type parameters

Name	Type
T	extends AnyConstructor

Returns

InstanceType\<T>

Defined in

lib/circuit-value.ts:255

---

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:175

---

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:233

---

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:96

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Defined in

lib/circuit-value.ts:103

---

toAuxiliary

▸ Static toAuxiliary(): []

Returns

[]

Defined in

lib/circuit-value.ts:125

---

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:214

---

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:108

---

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:129

---

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:222