Class SparseMerkleTree<K, V>

Sparse Merkle Tree

SparseMerkleTree

Type Parameters

  • K
  • V

Constructors

constructor

Properties

config hasher keyType root store valueType initialPoseidonHashRoot

Methods

clear delete depth digest get getHasher getKeyField getRoot getStore has isEmpty prove proveCompact proveForRoot setRoot sideNodesForRoot update updateAll updateForRoot updateWithSideNodes build import

Constructors

Private constructor

  • new SparseMerkleTree<K, V>(root, store, keyType, valueType, hasher, config): 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>

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<void>

    {Promise}

    Memberof

    SparseMerkleTree

delete

  • delete(key): Promise<Field>

  • Delete a value from tree and return the new root of the tree.

    Parameters

    • key: K

    Returns Promise<Field>

    {Promise}

    Memberof

    SparseMerkleTree

depth

  • depth(): number

  • Get the depth of the tree.

    Returns number

    {number}

    Memberof

    SparseMerkleTree

Protected digest

get

  • get(key): Promise<null | V>

  • Get the value for a key from the tree.

    Parameters

    • key: K

    Returns Promise<null | V>

    {(Promise<V | null>)}

    Memberof

    SparseMerkleTree

getHasher

Private getKeyField

getRoot

  • getRoot(): Field

  • Get the root of the tree.

    Returns Field

    {Field}

    Memberof

    SparseMerkleTree

getStore

has

  • has(key): Promise<boolean>

  • Check if the key exists in the tree.

    Parameters

    • key: K

    Returns Promise<boolean>

    {Promise}

    Memberof

    SparseMerkleTree

isEmpty

  • isEmpty(): boolean

  • Check if the tree is empty.

    Returns boolean

    {boolean}

    Memberof

    SparseMerkleTree

prove

proveCompact

Protected proveForRoot

setRoot

  • setRoot(root): Promise<void>

  • Set the root of the tree.

    Parameters

    • root: Field

    Returns Promise<void>

    Memberof

    SparseMerkleTree

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[];
    }>

update

  • update(key, value?): Promise<Field>

  • Update a new value for a key in the tree and return the new root of the tree.

    Parameters

    • key: K
    • Optional value: V

    Returns Promise<Field>

    {Promise}

    Memberof

    SparseMerkleTree

updateAll

  • updateAll(kvs): Promise<Field>

  • Update multiple leaves and return the new root of the tree.

    Parameters

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

    Returns Promise<Field>

    {Promise}

    Memberof

    SparseMerkleTree

Protected updateForRoot

  • updateForRoot(root, key, value?): Promise<Field>

  • Parameters

    • root: Field
    • key: K
    • Optional value: V

    Returns Promise<Field>

Protected updateWithSideNodes

  • updateWithSideNodes(sideNodes, pathNodes, oldLeafData, path, value?): Field

  • Parameters

    • sideNodes: Field[]
    • pathNodes: Field[]
    • oldLeafData: Field
    • path: Field
    • Optional value: V

    Returns Field

Static build

  • build<K, V>(store, KeyType, ValueType, options?): Promise<SparseMerkleTree<K, V>>

  • Build a new sparse merkle tree

    Type Parameters

    • K
    • V

    Parameters

    • store: Store<V>
    • KeyType: Provable<K>
    • ValueType: Provable<V>
    • Optional options: {
          hashKey?: boolean;
          hashValue?: boolean;
          hasher?: Hasher;
      } = ...

      hasher: The hash function to use, defaults to PoseidonHasherFunc; hashKey: whether to hash the key, the default is true; hashValue: whether to hash the value, the default is true.

      • Optional hashKey?: boolean
      • Optional hashValue?: boolean
      • Optional hasher?: Hasher

    Returns Promise<SparseMerkleTree<K, V>>

    {Promise<SparseMerkleTree<K, V>>}

    Static

    Memberof

    SparseMerkleTree

Static import

  • import<K, V>(store, keyType, valueType, options?): Promise<SparseMerkleTree<K, V>>

  • Import a sparse merkle tree via existing store

    Type Parameters

    • K
    • V

    Parameters

    • store: Store<V>
    • keyType: Provable<K>
    • valueType: Provable<V>
    • Optional options: {
          hashKey?: boolean;
          hashValue?: boolean;
          hasher?: Hasher;
      } = ...

      hasher: The hash function to use, defaults to PoseidonHasherFunc; hashKey: whether to hash the key, the default is true; hashValue: whether to hash the value, the default is true.

      • Optional hashKey?: boolean
      • Optional hashValue?: boolean
      • Optional hasher?: Hasher

    Returns Promise<SparseMerkleTree<K, V>>

    {Promise<SparseMerkleTree<K, V>>}

    Static

    Memberof

    SparseMerkleTree

Settings

Member Visibility

Theme

On This Page

constructorconfighasherkeyTyperootstorevalueTypeinitialPoseidonHashRootcleardeletedepthdigestgetgetHashergetKeyFieldgetRootgetStorehasisEmptyproveproveCompactproveForRootsetRootsideNodesForRootupdateupdateAllupdateForRootupdateWithSideNodesbuildimport