Class ProvableMerkleTreeUtils

Collection of utility functions for merkle tree in the circuit.

Hierarchy

ProvableMerkleTreeUtils

Index

Constructors

Properties

Methods

MerkleProof checkMembership checkNonMembership computeRoot

Constructors

constructor

new ProvableMerkleTreeUtils(): ProvableMerkleTreeUtils
Returns ProvableMerkleTreeUtils

Properties

`Static` EMPTY_VALUE

EMPTY_VALUE: Field = EMPTY_VALUE

Empty value for merkle tree

Static

Memberof

ProvableMerkleTreeUtils

Methods

`Static` MerkleProof

MerkleProof(height: number): typeof BaseMerkleProof
Create a meerkle proof circuit value type based on the specified tree height.

Static

Returns
{typeof BaseMerkleProof}

Memberof
ProvableMerkleTreeUtils
Parameters
- height: number
Returns typeof BaseMerkleProof
- Defined in src/lib/merkle/verify_circuit.ts:30

`Static` checkMembership

checkMembership<V>(proof: BaseMerkleProof, expectedRoot: Field, index: Field, value: V, valueType: Provable<V>, options??: {
hashValue: boolean;
hasher?: Hasher;
}): Bool
Returns true if the value is in the tree and it is at the index from the key

Static

Returns
{Bool}

Memberof
ProvableMerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: Field
- value: V
- valueType: Provable<V>
- Optional options: {
  hashValue: boolean;
  hasher?: Hasher;
  } = ...
  - hashValue: boolean
  - Optional hasher?: Hasher
Returns Bool
- Defined in src/lib/merkle/verify_circuit.ts:107

`Static` checkNonMembership

checkNonMembership(proof: BaseMerkleProof, expectedRoot: Field, index: Field, hasher??: Hasher): Bool
Returns true if there is no value at the index from the key

Static

Returns
{Bool}

Memberof
ProvableMerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: Field
- Optional hasher: Hasher = Poseidon.hash
Returns Bool
- Defined in src/lib/merkle/verify_circuit.ts:139

`Static` computeRoot

computeRoot<V>(proof: BaseMerkleProof, index: Field, value: V, valueType: Provable<V>, options??: {
hashValue: boolean;
hasher?: Hasher;
}): Field
Calculate new root based on index and value.

Static

Returns
{Field}

Memberof
ProvableMerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- index: Field
- value: V
- valueType: Provable<V>
- Optional options: {
  hashValue: boolean;
  hasher?: Hasher;
  } = ...
  - hashValue: boolean
  - Optional hasher?: Hasher
Returns Field
- Defined in src/lib/merkle/verify_circuit.ts:61

Generated using TypeDoc