@proto-kit/commonDocs


Documentation / @proto-kit/common / AbstractMerkleTree

Interface: AbstractMerkleTree

Extended by

Properties

leafCount

readonly leafCount: bigint

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:62


store

store: MerkleTreeStore

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:61

Methods

assertIndexRange()

assertIndexRange(index): void

Parameters

index: bigint

Returns

void

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:64


fill()

fill(leaves): void

Fills all leaves of the tree.

Parameters

leaves: Field[]

Values to fill the leaves with.

Returns

void

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:102


getNode()

getNode(level, index): Field

Returns a node which lives at a given index and level.

Parameters

level: number

Level of the node.

index: bigint

Index of the node.

Returns

Field

The data of the node.

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:72


getRoot()

getRoot(): Field

Returns the root of the Merkle Tree.

Returns

Field

The root of the Merkle Tree.

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:78


getWitness()

getWitness(index): AbstractMerkleWitness

Returns the witness (also known as Merkle Proof or Merkle Witness) for the leaf at the given index.

Parameters

index: bigint

Position of the leaf node.

Returns

AbstractMerkleWitness

The witness that belongs to the leaf.

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:96


setLeaf()

setLeaf(index, leaf): void

Sets the value of a leaf node at a given index to a given value.

Parameters

index: bigint

Position of the leaf node.

leaf: Field

New value.

Returns

void

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:85


setLeaves()

setLeaves(updates): void

Parameters

updates: object[]

Returns

void

Defined in

packages/common/src/trees/sparse/RollupMerkleTree.ts:87