Class MerkleTree

constructor

• new MerkleTree(levels, poseidonHash2, elements?, __namedParameters?): MerkleTree

• Parameters

  • levels: number

  • poseidonHash2: any

  • elements: string[] = []

  • __namedParameters: {
        zeroElement: undefined | string;
    } = {}

    • zeroElement: undefined | string

  Returns MerkleTree

_hash

_layers

_zeros

capacity

levels

zeroElement

_rebuild

• _rebuild(): void

• Returns void

bulkInsert

• bulkInsert(elements): void

• Insert multiple elements into the tree. Tree will be fully rebuilt during this operation.

  Parameters

  • elements: string[]

    Elements to insert

  Returns void

elements

• elements(): string[]

• Returns a copy of non-zero tree elements

  Returns string[]

indexOf

• indexOf(element, comparator?): number

• Find an element in the tree

  Parameters

  • element: string

    An element to find

  • comparator: null | Function = null

    A function that checks leaf value equality

  Returns number

  Index if element is found, otherwise -1

insert

• insert(element): void

• Insert new element into the tree

  Parameters

  • element: string

    Element to insert

  Returns void

path

• path(index): {
      pathElements: string[];
      pathIndices: number[];
  }

• Get merkle path to a leaf

  Parameters

  • index: number

    Leaf index to generate path for

  Returns {
      pathElements: string[];
      pathIndices: number[];
  }

  An object containing adjacent elements and left-right index

  • pathElements: string[]

  • pathIndices: number[]

root

• root(): string

• Get tree root

  Returns string

serialize

• serialize(): {
      _layers: string[][];
      _zeros: string[];
      levels: number;
  }

• Serialize entire tree state including intermediate layers into a plain object Deserializing it back will not require to recompute any hashes Elements are not converted to a plain type, this is responsibility of the caller

  Returns {
      _layers: string[][];
      _zeros: string[];
      levels: number;
  }

  • _layers: string[][]

  • _zeros: string[]

  • levels: number

update

• update(index, element): void

• Change an element in the tree

  Parameters

  • index: number

    Index of element to change

  • element: string

    Updated element value

  Returns void

Static deserialize

• deserialize(data, hashFunction): any

• Deserialize data into a MerkleTree instance Make sure to provide the same hashFunction as was used in the source tree, otherwise the tree state will be invalid

  Parameters

  • data: any

  • hashFunction: Function

  Returns any