Class DeepMerkleSubTree<V>

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

DeepMerkleSubTree

Type Parameters

  • V

Constructors

constructor

Properties

hashValue hasher height nodeStore root valueStore valueType

Methods

addBranch getHeight getRoot getValueField has prove update

Constructors

constructor

  • new DeepMerkleSubTree<V>(root, height, valueType, options?): DeepMerkleSubTree<V>

  • Creates an instance of DeepMerkleSubTree.

    Type Parameters

    • V

    Parameters

    • root: Field
    • 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.

      • hashValue: boolean
      • hasher: Hasher

    Returns DeepMerkleSubTree<V>

    Memberof

    DeepMerkleSubTree

Properties

Private hashValue

hashValue: boolean

Private hasher

hasher: Hasher

Private height

height: number

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, index, value?, ignoreInvalidProof?): void

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

    Parameters

    • proof: BaseMerkleProof
    • index: bigint
    • Optional value: V
    • Optional ignoreInvalidProof: boolean = false

    Returns void

    Memberof

    DeepMerkleSubTree

getHeight

getRoot

Private getValueField

has

  • has(index, value): boolean

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

    Parameters

    • index: bigint
    • value: V

    Returns boolean

    {boolean}

    Memberof

    DeepMerkleSubTree

prove

update

  • update(index, value?): Field

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

    Parameters

    • index: bigint
    • Optional value: V

    Returns Field

    {Field}

    Memberof

    DeepMerkleSubTree

Settings

Member Visibility

Theme

On This Page

constructorhashValuehasherheightnodeStorerootvalueStorevalueTypeaddBranchgetHeightgetRootgetValueFieldhasproveupdate