Skip to main content

Interface: Provable<T>

Provable<T> is the general circuit type interface. It describes how a type T is made up of field elements and auxiliary (non-field element) data.

You will find this as the required input type in a few places in snarkyjs. One convenient way to create a Provable<T> is using Struct.

Type parameters

Name
T

Hierarchy

Table of contents

Properties

Methods

Properties

check

check: (x: T) => void

Type declaration

▸ (x): void

Parameters
NameType
xT
Returns

void

Defined in

snarky.d.ts:29


fromFields

fromFields: (x: Field[], aux: any[]) => T

Type declaration

▸ (x, aux): T

Parameters
NameType
xField[]
auxany[]
Returns

T

Defined in

snarky.d.ts:27


toAuxiliary

toAuxiliary: (x?: T) => any[]

Type declaration

▸ (x?): any[]

Parameters
NameType
x?T
Returns

any[]

Defined in

snarky.d.ts:26


toFields

toFields: (x: T) => Field[]

Type declaration

▸ (x): Field[]

Parameters
NameType
xT
Returns

Field[]

Defined in

snarky.d.ts:25

Methods

sizeInFields

sizeInFields(): number

Returns

number

Defined in

snarky.d.ts:28