@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / VKTreeWitness

Class: VKTreeWitness

Extends

• WITNESS

Constructors

new VKTreeWitness()

new VKTreeWitness(value): VKTreeWitness

Parameters

• value

• value.isLeft: Bool[]

• value.path: Field[]

Returns

VKTreeWitness

Inherited from

VKTree.WITNESS.constructor

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:9

Properties

isLeft

isLeft: Bool[]

Inherited from

VKTree.WITNESS.isLeft

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:14

path

path: Field[]

Inherited from

VKTree.WITNESS.path

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:13

_isStruct

static _isStruct: true

Inherited from

VKTree.WITNESS._isStruct

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:16

check()

static check: (value) => void

Add assertions to the proof to check if value is a valid member of type T. This function does not return anything, instead it creates any number of assertions to prove that value is a valid member of the type T.

For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0.

Parameters

• value

the element of type T to put assertions on.

• value.isLeft: Bool[]

• value.path: Field[]

Returns

void

Inherited from

VKTree.WITNESS.check

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60

dummy()

static dummy: () => AbstractMerkleWitness

Returns

AbstractMerkleWitness

Inherited from

VKTree.WITNESS.dummy

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:126

empty()

static empty: () => object

Returns

object

isLeft

isLeft: Bool[]

path

path: Field[]

Inherited from

VKTree.WITNESS.empty

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:57

fromFields()

static fromFields: (fields) => object

Parameters

• fields: Field[]

Returns

object

isLeft

isLeft: Bool[]

path

path: Field[]

Inherited from

VKTree.WITNESS.fromFields

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:24

fromJSON()

static fromJSON: (x) => object

Parameters

• x

• x.isLeft: boolean[]

• x.path: string[]

Returns

object

isLeft

isLeft: Bool[]

path

path: Field[]

Inherited from

VKTree.WITNESS.fromJSON

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:50

fromValue

static fromValue: (x) => object & (value) => object

Convert provable type from a normal JS type.

Inherited from

VKTree.WITNESS.fromValue

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68

toAuxiliary()

static toAuxiliary: (value?) => any[]

A function that takes value (optional), an element of type T, as argument and returns an array of any type that make up the “auxiliary” (non-provable) data of value.

Parameters

• value?

the element of type T to generate the auxiliary data array from, optional. If not provided, a default value for auxiliary data is returned.

• value.isLeft?: Bool[]

• value.path?: Field[]

Returns

any[]

An array of any type describing how this T element is made up of “auxiliary” (non-provable) data.

Inherited from

VKTree.WITNESS.toAuxiliary

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34

toCanonical()?

static optional toCanonical: (x) => object

Optional method which transforms a provable type into its canonical representation.

This is needed for types that have multiple representations of the same underlying value, and might even not have perfect completeness for some of those representations.

An example is the ForeignField class, which allows non-native field elements to exist in unreduced form. The unreduced form is not perfectly complete, for example, addition of two unreduced field elements can cause a prover error.

Specific protocols need to be able to protect themselves against incomplete operations at all costs. For example, when using actions and reducer, the reducer must be able to produce a proof regardless of the input action. toCanonical() converts any input into a safe form and enables us to handle cases like this generically.

Note: For most types, this method is the identity function. The identity function will also be used when the toCanonical() is not present on a type.

Parameters

• x

• x.isLeft: Bool[]

• x.path: Field[]

Returns

object

isLeft

isLeft: Bool[]

path

path: Field[]

Inherited from

VKTree.WITNESS.toCanonical

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:85

toFields()

static toFields: (value) => Field[]

A function that takes value, an element of type T, as argument and returns an array of Field elements that make up the provable data of value.

Parameters

• value

the element of type T to generate the Field array from.

• value.isLeft: Bool[]

• value.path: Field[]

Returns

Field[]

A Field array describing how this T element is made up of Field elements.

Inherited from

VKTree.WITNESS.toFields

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24

toInput()

static toInput: (x) => object

Parameters

• x

• x.isLeft: Bool[]

• x.path: Field[]

Returns

object

fields?

optional fields: Field[]

packed?

optional packed: [Field, number][]

Inherited from

VKTree.WITNESS.toInput

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:36

toJSON()

static toJSON: (x) => object

Parameters

• x

• x.isLeft: Bool[]

• x.path: Field[]

Returns

object

isLeft

isLeft: boolean[]

path

path: string[]

Inherited from

VKTree.WITNESS.toJSON

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:43

toValue()

static toValue: (x) => object

Convert provable type to a normal JS type.

Parameters

• x

• x.isLeft: Bool[]

• x.path: Field[]

Returns

object

isLeft

isLeft: boolean[]

path

path: bigint[]

Inherited from

VKTree.WITNESS.toValue

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64

Methods

calculateIndex()

calculateIndex(): Field

Calculates the index of the leaf node that belongs to this Witness.

Returns

Field

Index of the leaf.

Inherited from

VKTree.WITNESS.calculateIndex

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:77

calculateRoot()

calculateRoot(hash): Field

Calculates a root depending on the leaf value.

Parameters

• hash: Field

Value of the leaf node that belongs to this Witness.

Returns

Field

The calculated root.

Inherited from

VKTree.WITNESS.calculateRoot

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:71

calculateRootIncrement()

calculateRootIncrement(index, leaf): [Field, AbstractMerkleWitness]

Parameters

• index: Field

• leaf: Field

Returns

[Field, AbstractMerkleWitness]

Inherited from

VKTree.WITNESS.calculateRootIncrement

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:72

checkMembership()

checkMembership(root, key, value): Bool

Parameters

• root: Field

• key: Field

• value: Field

Returns

Bool

Inherited from

VKTree.WITNESS.checkMembership

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:78

checkMembershipGetRoots()

checkMembershipGetRoots(root, key, value): [Bool, Field, Field]

Parameters

• root: Field

• key: Field

• value: Field

Returns

[Bool, Field, Field]

Inherited from

VKTree.WITNESS.checkMembershipGetRoots

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:80

checkMembershipSimple()

checkMembershipSimple(root, value): Bool

Parameters

• root: Field

• value: Field

Returns

Bool

Inherited from

VKTree.WITNESS.checkMembershipSimple

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:79

height()

height(): number

Returns

number

Inherited from

VKTree.WITNESS.height

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:65

toShortenedEntries()

toShortenedEntries(): string[]

Returns

string[]

Inherited from

VKTree.WITNESS.toShortenedEntries

Defined in

packages/common/dist/trees/sparse/RollupMerkleTree.d.ts:81

sizeInFields()

static sizeInFields(): number

Return the size of the T type in terms of Field type, as Field is the primitive type.

Returns

number

A number representing the size of the T type in terms of Field type.

Inherited from

VKTree.WITNESS.sizeInFields

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51