Class MerkleTree

Merkle tree

Hierarchy

MerkleTree

Index

Constructors

constructor

new MerkleTree(levels: string | number, elements?: BigNumberish[], options?: {
hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber);
zeroElement: undefined | BigNumberish;
}): MerkleTree
Constructor
Parameters
- levels: string | number
  
  Number of levels in the tree
- elements: BigNumberish[] = []
  
  BigNumberish[] of initial elements
- options: {
  hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber);
  zeroElement: undefined | BigNumberish;
  } = {}
  
  Object with the following properties: hashFunction - Function used to hash 2 leaves zeroElement - Value for non-existent leaves
  - hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber)
  - zeroElement: undefined | BigNumberish
Returns MerkleTree
- Defined in sdk-core/src/merkle-tree.ts:42

Properties

_hash

_hash: ((left: BigNumberish, right: BigNumberish) => BigNumber)

Type declaration

- (left: BigNumberish, right: BigNumberish): BigNumber
- Parameters
  - left: BigNumberish
  - right: BigNumberish
  Returns BigNumber

_layers

_layers: BigNumber[][]

_zeros

_zeros: BigNumber[]

capacity

capacity: number

levels

levels: number

zeroElement

zeroElement: BigNumber

Methods

_rebuild

_rebuild(): void
Returns void
- Defined in sdk-core/src/merkle-tree.ts:65

bulkInsert

bulkInsert(elements: BigNumberish[]): void
Insert multiple elements into the tree.
Parameters
- elements: BigNumberish[]
  
  Elements to insert
Returns void
- Defined in sdk-core/src/merkle-tree.ts:124

bulkRemove

bulkRemove(elements: BigNumberish[]): void
Parameters
- elements: BigNumberish[]
Returns void
- Defined in sdk-core/src/merkle-tree.ts:100

elements

elements(): BigNumber[]
Returns a copy of non-zero tree elements

Returns
Object[]

Returns BigNumber[]
- Defined in sdk-core/src/merkle-tree.ts:214

getIndexByElement

getIndexByElement(element: BigNumberish): number
Parameters
- element: BigNumberish
Returns number
- Defined in sdk-core/src/merkle-tree.ts:243

indexOf

indexOf(element: BigNumberish): number
Find an element in the tree

Returns
number - Index if element is found, otherwise -1
Parameters
- element: BigNumberish
  
  An element to find
Returns number
- Defined in sdk-core/src/merkle-tree.ts:206

insert

insert(element: BigNumberish): void
Insert new element into the tree
Parameters
- element: BigNumberish
  
  Element to insert
Returns void
- Defined in sdk-core/src/merkle-tree.ts:92

number_of_elements

number_of_elements(): number
Returns number
- Defined in sdk-core/src/merkle-tree.ts:239

path

path(index: number): MerkleProof
Get merkle path to a leaf

Returns
pathElements: Object[], pathIndex: number[] - An object containing adjacent elements and left-right index
Parameters
- index: number
  
  Leaf index to generate path for
Returns MerkleProof
- Defined in sdk-core/src/merkle-tree.ts:178

remove

remove(element: BigNumberish): void
Parameters
- element: BigNumberish
Returns void
- Defined in sdk-core/src/merkle-tree.ts:106

removeByIndex

removeByIndex(index: number): void
Parameters
- index: number
Returns void
- Defined in sdk-core/src/merkle-tree.ts:116

root

root(): BigNumber
Get tree root

Returns

Returns BigNumber
- Defined in sdk-core/src/merkle-tree.ts:84

serialize

serialize(): {
    _layers: BigNumber[][];
    _zeros: BigNumber[];
    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: BigNumber[][];
    _zeros: BigNumber[];
    levels: number;
}
- _layers: BigNumber[][]
- _zeros: BigNumber[]
- levels: number
- Defined in sdk-core/src/merkle-tree.ts:231

update

update(index: number, element: BigNumberish): void
Change an element in the tree
Parameters
- index: number
  
  Index of element to change
- element: BigNumberish
  
  Updated element value
Returns void
- Defined in sdk-core/src/merkle-tree.ts:155

zeros

zeros(): BigNumber[]
Returns a copy of n-th zero elements array

Returns
Object[]

Returns BigNumber[]
- Defined in sdk-core/src/merkle-tree.ts:222

`Static` calculateIndexFromPathIndices

calculateIndexFromPathIndices(pathIndices: number[]): number
This function calculates the desired index given the pathIndices
Parameters
- pathIndices: number[]
  
  an array of (0, 1) values representing (left, right) selection of nodes for each level in the merkle tree. The leaves level of the tree is at index 0 and the root of the tree is at index 'levels'
Returns number
- Defined in sdk-core/src/merkle-tree.ts:298

`Static` createTreeWithRoot

createTreeWithRoot(levels: number, leaves: string[], targetRoot: string): undefined | MerkleTree
Create a merkle tree with the target root by inserting the given leaves one-by-one. If the root matches after an insertion, return the tree. Else, return undefined.

Returns
MerkleTree | undefined
Parameters
- levels: number
- leaves: string[]
  
  An array of ordered leaves to be inserted in a merkle tree
- targetRoot: string
  
  The root that the caller is trying to build a tree against
Returns undefined | MerkleTree
- Defined in sdk-core/src/merkle-tree.ts:272

`Static` deserialize

deserialize(data: any, hashFunction: any): 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: any
Returns any
- Defined in sdk-core/src/merkle-tree.ts:252

Class MerkleTree

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

levels: string | number

elements: BigNumberish[] = []

options: { hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber); zeroElement: undefined | BigNumberish; } = {}

hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber)

zeroElement: undefined | BigNumberish

Returns MerkleTree

Properties

_hash

Type declaration

Parameters

left: BigNumberish

right: BigNumberish

Returns BigNumber

_layers

_zeros

capacity

levels

zeroElement

Methods

_rebuild

Returns void

bulkInsert

Parameters

elements: BigNumberish[]

Returns void

bulkRemove

Parameters

elements: BigNumberish[]

Returns void

elements

Returns

Returns BigNumber[]

getIndexByElement

Parameters

element: BigNumberish

Returns number

indexOf

Returns

Parameters

element: BigNumberish

Returns number

insert

Parameters

element: BigNumberish

Returns void

number_of_elements

Returns number

path

Returns

Parameters

index: number

Returns MerkleProof

remove

Parameters

element: BigNumberish

Returns void

removeByIndex

Parameters

index: number

Returns void

root

Returns

Returns BigNumber

serialize

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

_layers: BigNumber[][]

_zeros: BigNumber[]

levels: number

update

Parameters

index: number

options: {
hashFunction: undefined | ((left: BigNumberish, right: BigNumberish) => BigNumber);
zeroElement: undefined | BigNumberish;
} = {}

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

`Static` calculateIndexFromPathIndices

`Static` createTreeWithRoot

`Static` deserialize