Class DeepSparseMerkleSubTree<K, V>

DeepSparseMerkleSubTree is a deep sparse merkle subtree for working on only a few leafs.

DeepSparseMerkleSubTree

Type Parameters

  • K
  • V

Constructors

constructor

Properties

config hasher keyType nodeStore root valueStore valueType

Methods

addBranch getHeight getKeyField getRoot getValueField has prove update

Constructors

constructor

  • new DeepSparseMerkleSubTree<K, V>(root, keyType, valueType, options?): DeepSparseMerkleSubTree<K, V>

  • Creates an instance of DeepSparseMerkleSubTree.

    Type Parameters

    • K
    • V

    Parameters

    • root: Field

      merkle root

    • 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.

      • hashKey: boolean
      • hashValue: boolean
      • hasher: Hasher

    Returns DeepSparseMerkleSubTree<K, V>

    Memberof

    DeepSparseMerkleSubTree

Properties

Private config

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

Type declaration

  • hashKey: boolean
  • hashValue: boolean

Private hasher

hasher: Hasher

Private keyType

keyType: Provable<K>

Private nodeStore

nodeStore: Map<string, Field[]>

Private root

root: Field

Private valueStore

valueStore: Map<string, Field>

Private valueType

valueType: Provable<V>

Methods

addBranch

  • addBranch(proof, key, value?, ignoreInvalidProof?): void

  • Add a branch to the tree, a branch is generated by smt.prove.

    Parameters

    • proof: SparseMerkleProof
    • key: K
    • Optional value: V
    • Optional ignoreInvalidProof: boolean = false

      whether to throw an error when proof is invalid

    Returns void

    Memberof

    DeepSparseMerkleSubTree

getHeight

Private getKeyField

getRoot

Private getValueField

has

  • has(key, value): boolean

  • Check whether there is a corresponding key and value in the tree

    Parameters

    • key: K
    • value: V

    Returns boolean

    {boolean}

    Memberof

    DeepSparseMerkleSubTree

prove

update

  • update(key, value?): 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 Field

    {Field}

    Memberof

    DeepSparseMerkleSubTree

Settings

Member Visibility

Theme

On This Page

constructorconfighasherkeyTypenodeStorerootvalueStorevalueTypeaddBranchgetHeightgetKeyFieldgetRootgetValueFieldhasproveupdate