Class: Circuit

The Circuit API is a low level interface to interact and build circuits with

Table of contents

Constructors

• constructor

Methods

• _witness
• addConstraint
• array
• asProver
• assertEqual
• constraintSystem
• equal
• generateKeypair
• if
• inCheckedComputation
• inProver
• log
• newVariable
• prove
• runAndCheck
• switch
• toFields
• verify
• witness

Constructors

constructor

• new Circuit()

Methods

_witness

▸ Static _witness<S>(ctor, f): Field[]

Type parameters

Name	Type
S	extends Provable<any, S>

Parameters

Name	Type
ctor	S
f	() => Field[]

Returns

Field[]

Defined in

snarky.d.ts:647

---

addConstraint

▸ Static addConstraint(this, kind, x, y, z): void

Adds a constraint to the circuit.

Parameters

Name	Type
this	Circuit
kind	"multiply"
x	Field
y	Field
z	Field

Returns

void

Defined in

snarky.d.ts:612

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
this	Circuit
kind	"add"
x	Field
y	Field
z	Field

Returns

void

Defined in

snarky.d.ts:619

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
this	Circuit
kind	"equal"
x	Field
y	Field
z	Field

Returns

void

Defined in

snarky.d.ts:626

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
this	Circuit
kind	"boolean"
x	Field
y	Field
z	Field

Returns

void

Defined in

snarky.d.ts:633

---

array

▸ Static array<T>(elementType, length): Provable<T[]>

Creates a generic Provable array^.

Type parameters

Name
T

Parameters

Name	Type
elementType	Provable<T>
length	number

Returns

Provable<T[]>

Defined in

snarky.d.ts:675

---

asProver

▸ Static asProver(f): void

Runs code as a prover.

Parameters

Name	Type
f	() => void

Returns

void

Defined in

snarky.d.ts:656

---

assertEqual

▸ Static assertEqual<T>(ctor, x, y): void

Asserts that two values are equal.

Type parameters

Name
T

Parameters

Name	Type
ctor	Object
ctor.toFields	(x: T) => Field[]
x	T
y	T

Returns

void

Defined in

snarky.d.ts:680

▸ Static assertEqual<T>(x, y): void

Asserts that two values are equal.

Type parameters

Name
T

Parameters

Name	Type
x	T
y	T

Returns

void

Defined in

snarky.d.ts:685

---

constraintSystem

▸ Static constraintSystem<T>(f): Object

Returns information about the constraint system in the callback function.

Type parameters

Name
T

Parameters

Name	Type
f	() => T

Returns

Object

Name	Type
digest	string
result	T
rows	number

Defined in

snarky.d.ts:666

---

equal

▸ Static equal<T>(ctor, x, y): Bool

Checks if two elements are equal.

Type parameters

Name
T

Parameters

Name	Type
ctor	Object
ctor.toFields	(x: T) => Field[]
x	T
y	T

Returns

Bool

Defined in

snarky.d.ts:690

▸ Static equal<T>(x, y): Bool

Checks if two elements are equal.

Type parameters

Name
T

Parameters

Name	Type
x	T
y	T

Returns

Bool

Defined in

snarky.d.ts:695

---

generateKeypair

▸ Static generateKeypair(): Keypair

Generates a proving key and a verification key for this circuit.

Returns

Keypair

Defined in

snarky.d.ts:725

---

if

▸ Static if<T>(b, ctor, x, y): T

Circuit-compatible if-statement.

Type parameters

Name
T

Parameters

Name	Type
b	boolean | Bool
ctor	ProvablePure<T>
x	T
y	T

Returns

T

Defined in

snarky.d.ts:700

▸ Static if<T>(b, x, y): T

Circuit-compatible if-statement.

Type parameters

Name
T

Parameters

Name	Type
b	boolean | Bool
x	T
y	T

Returns

T

Defined in

snarky.d.ts:704

---

inCheckedComputation

▸ Static inCheckedComputation(): boolean

Checks if the circuit is in checked computation mode.

Returns

boolean

Defined in

snarky.d.ts:750

---

inProver

▸ Static inProver(): boolean

Checks if the circuit is in prover mode.

Returns

boolean

Defined in

snarky.d.ts:745

---

log

▸ Static log(...args): void

Interface to log elements within a circuit. Similar to Console.log().

Parameters

Name	Type
...args	any

Returns

void

Defined in

snarky.d.ts:755

---

newVariable

▸ Static newVariable(f): Field

Creates a new variable inside the circuit.

Parameters

Name	Type
f	() => string | number | boolean | Field

Returns

Field

Defined in

snarky.d.ts:644

---

prove

▸ Static prove(privateInput, publicInput, kp): Proof

Proves a statement using the private input, public input and the Keypair of the circuit.

Parameters

Name	Type
privateInput	any[]
publicInput	any[]
kp	Keypair

Returns

Proof

Defined in

snarky.d.ts:730

---

runAndCheck

▸ Static runAndCheck<T>(f): T

Runs code and checks its correctness.

Type parameters

Name
T

Parameters

Name	Type
f	() => T

Returns

T

Defined in

snarky.d.ts:661

---

switch

▸ Static switch<T, A>(mask, type, values): T

Generalization of Circuit.if for choosing between more than two different cases. It takes a "mask", which is an array of Bools that contains only one true element, as well as a type/constructor and an array of values of that type. The result is that value which corresponds to the true element of the mask. Example:

let x = Circuit.switch([Bool(false), Bool(true)], Field, [Field(1), Field(2)]);
x.assertEquals(2);

Type parameters

Name	Type
T	T
A	extends Provable<T, A>

Parameters

Name	Type
mask	Bool[]
type	A
values	T[]

Returns

T

Defined in

snarky.d.ts:716

---

toFields

▸ Static toFields<A>(a): Field[]

Serializes an element into Field elements.

Type parameters

Name
A

Parameters

Name	Type
a	A

Returns

Field[]

Defined in

snarky.d.ts:740

---

verify

▸ Static verify(publicInput, vk, pi): boolean

Verifies a proof using the public input, the proof and the initial Keypair of the circuit.

Parameters

Name	Type
publicInput	any[]
vk	VerificationKey
pi	Proof

Returns

boolean

Defined in

snarky.d.ts:735

---

witness

▸ Static witness<T, S>(ctor, f): T

Type parameters

Name	Type
T	T
S	extends Provable<T, S> = Provable<T>

Parameters

Name	Type
ctor	S
f	() => T

Returns

T

Defined in

snarky.d.ts:648