Class MerkleTree<V>

Merkle Tree.

MerkleTree

Type Parameters

Index

Constructors

`Private` constructor

new MerkleTree<V>(root, store, height, valueType, hasher, hashValue): MerkleTree<V>
Type Parameters
- V
Parameters
- root: Field
- store: Store<V>
- height: number
- valueType: Provable<V>
- hasher: Hasher
- hashValue: boolean
Returns MerkleTree<V>
- Defined in src/lib/merkle/merkle_tree.ts:124

Properties

`Protected` `Readonly` hashValue

hashValue: boolean

`Protected` hasher

hasher: Hasher

`Protected` `Readonly` height

height: number

`Protected` `Readonly` maxNumIndex

maxNumIndex: bigint

`Protected` root

root: Field

`Protected` store

store: Store<V>

`Protected` valueType

valueType: Provable<V>

Methods

clear

clear(): Promise<void>
Clear the tree.

Returns Promise<void>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:261

delete

delete(index): Promise<Field>
Delete a value from tree and return the new root of the tree.
Parameters
- index: bigint
Returns Promise<Field>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:272

depth

depth(): number
Get the depth of the tree.

Returns number
{number}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:175

`Protected` digest

digest(data): Field
Parameters
- data: Field[]
Returns Field
- Defined in src/lib/merkle/merkle_tree.ts:337

get

get(index): Promise<null | V>
Get the value for an index from the tree.
Parameters
- index: bigint
Returns Promise<null | V>
{(Promise<V | null>)}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:219

getHasher

getHasher(): Hasher
Get the hasher function used by the tree.

Returns Hasher
{Hasher}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:208

getRoot

getRoot(): Field
Get the root of the tree.

Returns Field
{Field}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:154

getStore

getStore(): Store<V>
Get the data store of the tree.

Returns Store<V>
{Store}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:198

has

has(index): Promise<boolean>
Check if the index exists in the tree.
Parameters
- index: bigint
Returns Promise<boolean>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:246

isEmpty

isEmpty(): boolean
Check if the tree is empty.

Returns boolean
{boolean}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:164

prove

prove(index): Promise<BaseMerkleProof>
Create a merkle proof for an index against the current root.
Parameters
- index: bigint
Returns Promise<BaseMerkleProof>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:321

proveCompact

proveCompact(index): Promise<CompactMerkleProof>
Create a compacted merkle proof for an index against the current root.
Parameters
- index: bigint
Returns Promise<CompactMerkleProof>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:332

`Protected` proveForRoot

proveForRoot(root, key): Promise<BaseMerkleProof>
Parameters
- root: Field
- key: bigint
Returns Promise<BaseMerkleProof>
- Defined in src/lib/merkle/merkle_tree.ts:468

setRoot

setRoot(root): Promise<void>
Set the root of the tree.
Parameters
- root: Field
Returns Promise<void>
Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:185

`Protected` sideNodesForRoot

sideNodesForRoot(root, path): Promise<{
    leafData: Field;
    pathNodes: Field[];
    sideNodes: Field[];
}>
Parameters
- root: Field
- path: Field
Returns Promise<{
    leafData: Field;
    pathNodes: Field[];
    sideNodes: Field[];
}>
- Defined in src/lib/merkle/merkle_tree.ts:426

update

update(index, value?): Promise<Field>
Update a new value for an index in the tree and return the new root of the tree.
Parameters
- index: bigint
- Optional value: V
Returns Promise<Field>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:284

updateAll

updateAll(ivs): Promise<Field>
Update multiple leaves and return the new root of the tree.
Parameters
- ivs: {
  index: bigint;
  value?: V;
  }[]
Returns Promise<Field>
{Promise}

Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:301

`Protected` updateForRoot

updateForRoot(root, key, value?): Promise<Field>
Parameters
- root: Field
- key: bigint
- Optional value: V
Returns Promise<Field>
- Defined in src/lib/merkle/merkle_tree.ts:341

`Protected` updateWithSideNodes

updateWithSideNodes(sideNodes, pathNodes, oldLeafData, path, value?): Field
Parameters
- sideNodes: Field[]
- pathNodes: Field[]
- oldLeafData: Field
- path: Field
- Optional value: V
Returns Field
- Defined in src/lib/merkle/merkle_tree.ts:368

`Static` build

build<V>(store, height, valueType, options?): Promise<MerkleTree<V>>
Build a new merkle tree.
Type Parameters
- V
Parameters
- store: Store<V>
- height: number
- valueType: Provable<V>
- Optional options: {
  hashValue?: boolean;
  hasher?: Hasher;
  } = ...
  hasher: The hash function to use, defaults to PoseidonHasherFunc; hashValue: whether to hash the value, the default is true.
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<MerkleTree<V>>
{Promise<MerkleTree>}

Static
Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:43

`Static` import

import<V>(store, height, valueType, options?): Promise<MerkleTree<V>>
Import a merkle tree via existing store.
Type Parameters
- V
Parameters
- store: Store<V>
- height: number
- valueType: Provable<V>
- Optional options: {
  hashValue?: boolean;
  hasher?: Hasher;
  } = ...
  hasher: The hash function to use, defaults to PoseidonHasherFunc; hashValue: whether to hash the value, the default is true.
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<MerkleTree<V>>
{Promise<MerkleTree>}

Static
Memberof
MerkleTree
- Defined in src/lib/merkle/merkle_tree.ts:98

Class MerkleTree<V>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

Private constructor

Type Parameters

Parameters

Returns MerkleTree<V>

Properties

Protected Readonly hashValue

Protected hasher

Protected Readonly height

Protected Readonly maxNumIndex

Protected root

Protected store

Protected valueType

Methods

clear

Returns Promise<void>

Memberof

delete

Parameters

Returns Promise<Field>

Memberof

depth

Returns number

Memberof

Protected digest

Parameters

Returns Field

get

Parameters

Returns Promise<null | V>

Memberof

getHasher

Returns Hasher

Memberof

getRoot

Returns Field

Memberof

getStore

Returns Store<V>

Memberof

has

Parameters

Returns Promise<boolean>

Memberof

isEmpty

Returns boolean

Memberof

prove

Parameters

Returns Promise<BaseMerkleProof>

Memberof

proveCompact

Parameters

Returns Promise<CompactMerkleProof>

Memberof

Protected proveForRoot

Parameters

Returns Promise<BaseMerkleProof>

setRoot

Parameters

Returns Promise<void>

Memberof

Protected sideNodesForRoot

Parameters

Returns Promise<{ leafData: Field; pathNodes: Field[]; sideNodes: Field[]; }>

update

Parameters

Returns Promise<Field>

Memberof

updateAll

Parameters

Returns Promise<Field>

Memberof

Protected updateForRoot

`Private` constructor

`Protected` `Readonly` hashValue

`Protected` hasher

`Protected` `Readonly` height

`Protected` `Readonly` maxNumIndex

`Protected` root

`Protected` store

`Protected` valueType

`Protected` digest

`Protected` proveForRoot

`Protected` sideNodesForRoot

Returns Promise<{
leafData: Field;
pathNodes: Field[];
sideNodes: Field[];
}>

`Protected` updateForRoot

`Protected` updateWithSideNodes

`Static` build

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher

`Static` import

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher