Class MerkleTree

constructor

• new MerkleTree(
      levels: number,
      lightWasm: LightWasm,
      elements?: string[],
      __namedParameters?: { zeroElement?: string },
  ): MerkleTree

  Parameters

  • levels: number
  • lightWasm: LightWasm
  • elements: string[] = []
  • __namedParameters: { zeroElement?: string } = {}

  Returns MerkleTree

levels

capacity

zeroElement

_zeros

_layers

_lightWasm

_rebuild

• _rebuild(): void

  Returns void

root

• root(): string

  Get tree root

  Returns string

insert

• insert(element: string): void

  Insert new element into the tree

  Parameters

  • element: string

    Element to insert

  Returns void

bulkInsert

• bulkInsert(elements: string[]): void

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

  Parameters

  • elements: string[]

    Elements to insert

  Returns void

update

• update(index: number, element: string): void

  Change an element in the tree

  Parameters

  • index: number

    Index of element to change

  • element: string

    Updated element value

  Returns void

path

• path(index: number): { 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

indexOf

• indexOf(
      element: string,
      comparator?: ((element: string, el: string) => boolean) | null,
  ): number

  Find an element in the tree

  Parameters

  • element: string

    An element to find

  • comparator: ((element: string, el: string) => boolean) | null = null

    A function that checks leaf value equality

  Returns number

  Index if element is found, otherwise -1

elements

• elements(): string[]

  Returns a copy of non-zero tree elements

  Returns string[]

serialize

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

  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 { levels: number; _zeros: string[]; _layers: string[][] }

Staticdeserialize

• deserialize(
      data: any,
      hashFunction: (left: string, right: string) => string,
  ): 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: (left: string, right: string) => string

  Returns any