BaseMerkleWitness

Defined in: lib/provable/merkle-tree.ts:168

The BaseMerkleWitness class defines a circuit-compatible base class for Merkle Witness.

Extends

• CircuitValue

Constructors

new BaseMerkleWitness()

new BaseMerkleWitness(witness: Witness): BaseMerkleWitness

Defined in: lib/provable/merkle-tree.ts:181

Takes a Witness and turns it into a circuit-compatible Witness.

Parameters

witness

Witness

Witness.

Returns

BaseMerkleWitness

A circuit-compatible Witness.

Overrides

CircuitValue.constructor

Properties

isLeft

isLeft: Bool[];

Defined in: lib/provable/merkle-tree.ts:171

---

path

path: Field[];

Defined in: lib/provable/merkle-tree.ts:170

---

height

static height: number;

Defined in: lib/provable/merkle-tree.ts:169

Methods

assertEquals()

assertEquals(x: this): void

Defined in: lib/provable/types/circuit-value.ts:121

Parameters

x

this

Returns

void

Inherited from

CircuitValue.assertEquals

---

calculateIndex()

calculateIndex(): Field

Defined in: lib/provable/merkle-tree.ts:215

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

Returns

Field

Index of the leaf.

---

calculateRoot()

calculateRoot(leaf: Field): Field

Defined in: lib/provable/merkle-tree.ts:198

Calculates a root depending on the leaf value.

Parameters

leaf

Field

Value of the leaf node that belongs to this Witness.

Returns

Field

The calculated root.

---

equals()

equals(x: this): Bool

Defined in: lib/provable/types/circuit-value.ts:117

Parameters

x

this

Returns

Bool

Inherited from

CircuitValue.equals

---

height()

height(): number

Defined in: lib/provable/merkle-tree.ts:172

Returns

number

---

isConstant()

isConstant(): boolean

Defined in: lib/provable/types/circuit-value.ts:125

Returns

boolean

Inherited from

CircuitValue.isConstant

---

toConstant()

toConstant(): this

Defined in: lib/provable/types/circuit-value.ts:113

Returns

this

Inherited from

CircuitValue.toConstant

---

toFields()

toFields(): Field[]

Defined in: lib/provable/types/circuit-value.ts:79

Returns

Field[]

Inherited from

CircuitValue.toFields

---

toJSON()

toJSON(): any

Defined in: lib/provable/types/circuit-value.ts:109

Returns

any

Inherited from

CircuitValue.toJSON

---

check()

static check<T>(this: T, v: InstanceType<T>): void

Defined in: lib/provable/types/circuit-value.ts:148

Type Parameters

• T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

void

Inherited from

CircuitValue.check

---

empty()

static empty<T>(): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:205

Type Parameters

• T extends AnyConstructor

Returns

InstanceType<T>

Inherited from

CircuitValue.empty

---

fromFields()

static fromFields<T>(this: T, xs: Field[]): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:129

Type Parameters

• T extends AnyConstructor

Parameters

this

T

xs

Field[]

Returns

InstanceType<T>

Inherited from

CircuitValue.fromFields

---

fromJSON()

static fromJSON<T>(this: T, value: any): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:186

Type Parameters

• T extends AnyConstructor

Parameters

this

T

value

any

Returns

InstanceType<T>

Inherited from

CircuitValue.fromJSON

---

fromObject()

static fromObject<T>(this: T, value: NonMethods<InstanceType<T>>): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:30

Type Parameters

• T extends AnyConstructor

Parameters

this

T

value

NonMethods<InstanceType<T>>

Returns

InstanceType<T>

Inherited from

CircuitValue.fromObject

---

fromValue()

static fromValue<T>(this: T, value: any): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:92

Type Parameters

• T extends AnyConstructor

Parameters

this

T

value

any

Returns

InstanceType<T>

Inherited from

CircuitValue.fromValue

---

sizeInFields()

static sizeInFields(): number

Defined in: lib/provable/types/circuit-value.ts:37

Returns

number

Inherited from

CircuitValue.sizeInFields

---

toAuxiliary()

static toAuxiliary(): []

Defined in: lib/provable/types/circuit-value.ts:56

Returns

[]

Inherited from

CircuitValue.toAuxiliary

---

toCanonical()

static toCanonical<T>(this: T, value: InstanceType<T>): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:161

Type Parameters

• T extends AnyConstructor

Parameters

this

T

value

InstanceType<T>

Returns

InstanceType<T>

Inherited from

CircuitValue.toCanonical

---

toConstant()

static toConstant<T>(this: T, t: InstanceType<T>): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:170

Type Parameters

• T extends AnyConstructor

Parameters

this

T

t

InstanceType<T>

Returns

InstanceType<T>

Inherited from

CircuitValue.toConstant

---

toFields()

static toFields<T>(this: T, v: InstanceType<T>): Field[]

Defined in: lib/provable/types/circuit-value.ts:42

Type Parameters

• T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

---

toInput()

static toInput<T>(this: T, v: InstanceType<T>): HashInput

Defined in: lib/provable/types/circuit-value.ts:60

Type Parameters

• T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

HashInput

Inherited from

CircuitValue.toInput

---

toJSON()

static toJSON<T>(this: T, v: InstanceType<T>): any

Defined in: lib/provable/types/circuit-value.ts:175

Type Parameters

• T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

any

Inherited from

CircuitValue.toJSON

---

toValue()

static toValue<T>(this: T, v: InstanceType<T>): any

Defined in: lib/provable/types/circuit-value.ts:83

Type Parameters

• T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

any

Inherited from

CircuitValue.toValue