Class SparseMerkleTree<K, V>

Sparse Merkle Tree

Type Parameters

Hierarchy

SparseMerkleTree

Index

Constructors

constructor

Properties

config hasher keyType root store valueType initialPoseidonHashRoot

Constructors

`Private` constructor

new SparseMerkleTree<K, V>(root: Field, store: Store<V>, keyType: Provable<K>, valueType: Provable<V>, hasher: Hasher, config: {
hashKey: boolean;
hashValue: boolean;
}): SparseMerkleTree<K, V>
Type Parameters
- K
- V
Parameters
- root: Field
- store: Store<V>
- keyType: Provable<K>
- valueType: Provable<V>
- hasher: Hasher
- config: {
  hashKey: boolean;
  hashValue: boolean;
  }
  - hashKey: boolean
  - hashValue: boolean
Returns SparseMerkleTree<K, V>
- Defined in src/lib/smt/smt.ts:155

Properties

`Protected` config

config: {
hashKey: boolean;
hashValue: boolean;
}

Type declaration

hashKey: boolean
hashValue: boolean

`Protected` hasher

hasher: Hasher

`Protected` keyType

keyType: Provable<K>

`Protected` root

root: Field

`Protected` store

store: Store<V>

`Protected` valueType

valueType: Provable<V>

`Static` initialPoseidonHashRoot

initialPoseidonHashRoot: Field = ...

Initial empty tree root based on poseidon hash algorithm

Static

Memberof

SparseMerkleTree

Methods

clear

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

Returns
{Promise}

Memberof
SparseMerkleTree

Returns Promise<void>
- Defined in src/lib/smt/smt.ts:300

delete

delete(key: K): Promise<Field>
Delete a value from tree and return the new root of the tree.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- key: K
Returns Promise<Field>
- Defined in src/lib/smt/smt.ts:311

depth

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

Returns
{number}

Memberof
SparseMerkleTree

Returns number
- Defined in src/lib/smt/smt.ts:214

`Protected` digest

digest(data: Field[]): Field
Parameters
- data: Field[]
Returns Field
- Defined in src/lib/smt/smt.ts:376

get

get(key: K): Promise<null | V>
Get the value for a key from the tree.

Returns
{(Promise<V | null>)}

Memberof
SparseMerkleTree
Parameters
- key: K
Returns Promise<null | V>
- Defined in src/lib/smt/smt.ts:258

getHasher

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

Returns
{Hasher}

Memberof
SparseMerkleTree

Returns Hasher
- Defined in src/lib/smt/smt.ts:247

`Private` getKeyField

getKeyField(key: K): Field
Parameters
- key: K
Returns Field
- Defined in src/lib/smt/smt.ts:171

getRoot

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

Returns
{Field}

Memberof
SparseMerkleTree

Returns Field
- Defined in src/lib/smt/smt.ts:193

getStore

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

Returns
{Store}

Memberof
SparseMerkleTree

Returns Store<V>
- Defined in src/lib/smt/smt.ts:237

has

has(key: K): Promise<boolean>
Check if the key exists in the tree.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- key: K
Returns Promise<boolean>
- Defined in src/lib/smt/smt.ts:285

isEmpty

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

Returns
{boolean}

Memberof
SparseMerkleTree

Returns boolean
- Defined in src/lib/smt/smt.ts:203

prove

prove(key: K): Promise<SparseMerkleProof>
Create a merkle proof for a key against the current root.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- key: K
Returns Promise<SparseMerkleProof>
- Defined in src/lib/smt/smt.ts:360

proveCompact

proveCompact(key: K): Promise<SparseCompactMerkleProof>
Create a compacted merkle proof for a key against the current root.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- key: K
Returns Promise<SparseCompactMerkleProof>
- Defined in src/lib/smt/smt.ts:371

`Protected` proveForRoot

proveForRoot(root: Field, key: K): Promise<SparseMerkleProof>
Parameters
- root: Field
- key: K
Returns Promise<SparseMerkleProof>
- Defined in src/lib/smt/smt.ts:499

setRoot

setRoot(root: Field): Promise<void>
Set the root of the tree.

Memberof
SparseMerkleTree
Parameters
- root: Field
Returns Promise<void>
- Defined in src/lib/smt/smt.ts:224

`Protected` sideNodesForRoot

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

update

update(key: K, value?: V): Promise<Field>
Update a new value for a key in the tree and return the new root of the tree.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- key: K
- Optional value: V
Returns Promise<Field>
- Defined in src/lib/smt/smt.ts:323

updateAll

updateAll(kvs: {
key: K;
value?: V;
}[]): Promise<Field>
Update multiple leaves and return the new root of the tree.

Returns
{Promise}

Memberof
SparseMerkleTree
Parameters
- kvs: {
  key: K;
  value?: V;
  }[]
Returns Promise<Field>
- Defined in src/lib/smt/smt.ts:340

`Protected` updateForRoot

updateForRoot(root: Field, key: K, value?: V): Promise<Field>
Parameters
- root: Field
- key: K
- Optional value: V
Returns Promise<Field>
- Defined in src/lib/smt/smt.ts:380

`Protected` updateWithSideNodes

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

`Static` build

build<K, V>(store: Store<V>, KeyType: Provable<K>, ValueType: Provable<V>, options??: {
    hashKey?: boolean;
    hashValue?: boolean;
    hasher?: Hasher;
}): Promise<SparseMerkleTree<K, V>>
Build a new sparse merkle tree

Static

Returns
{Promise<SparseMerkleTree<K, V>>}

Memberof
SparseMerkleTree
Type Parameters
- K
- V
Parameters
- store: Store<V>
- KeyType: Provable<K>
- ValueType: Provable<V>
- Optional options: {
      hashKey?: boolean;
      hashValue?: boolean;
      hasher?: Hasher;
  } = ...
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<SparseMerkleTree<K, V>>
- Defined in src/lib/smt/smt.ts:58

`Static` import

import<K, V>(store: Store<V>, keyType: Provable<K>, valueType: Provable<V>, options??: {
    hashKey?: boolean;
    hashValue?: boolean;
    hasher?: Hasher;
}): Promise<SparseMerkleTree<K, V>>
Import a sparse merkle tree via existing store

Static

Returns
{Promise<SparseMerkleTree<K, V>>}

Memberof
SparseMerkleTree
Type Parameters
- K
- V
Parameters
- store: Store<V>
- keyType: Provable<K>
- valueType: Provable<V>
- Optional options: {
      hashKey?: boolean;
      hashValue?: boolean;
      hasher?: Hasher;
  } = ...
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<SparseMerkleTree<K, V>>
- Defined in src/lib/smt/smt.ts:121

Class SparseMerkleTree<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Type Parameters

K

V

Parameters

root: Field

store: Store<V>

keyType: Provable<K>

valueType: Provable<V>

hasher: Hasher

config: { hashKey: boolean; hashValue: boolean; }

hashKey: boolean

hashValue: boolean

Returns SparseMerkleTree<K, V>

Properties

Protected config

Type declaration

hashKey: boolean

hashValue: boolean

Protected hasher

Protected keyType

Protected root

Protected store

Protected valueType

Static initialPoseidonHashRoot

Static

Memberof

Methods

clear

Returns

Memberof

Returns Promise<void>

delete

Returns

Memberof

Parameters

key: K

Returns Promise<Field>

depth

Returns

Memberof

Returns number

Protected digest

Parameters

data: Field[]

Returns Field

get

Returns

Memberof

Parameters

key: K

Returns Promise<null | V>

getHasher

Returns

Memberof

Returns Hasher

Private getKeyField

Parameters

key: K

Returns Field

getRoot

Returns

Memberof

Returns Field

getStore

Returns

Memberof

Returns Store<V>

has

Returns

`Private` constructor

config: {
hashKey: boolean;
hashValue: boolean;
}

`Protected` config

`Protected` hasher

`Protected` keyType

`Protected` root

`Protected` store

`Protected` valueType

`Static` initialPoseidonHashRoot

`Protected` digest

`Private` getKeyField

`Protected` proveForRoot

`Protected` sideNodesForRoot

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

`Optional` value: V

kvs: {
key: K;
value?: V;
}[]

`Protected` updateForRoot

`Optional` value: V

`Protected` updateWithSideNodes

`Optional` value: V

`Static` build