DocsReference@proto-kit/commonInterfacesAbstractLinkedMerkleTree

@proto-kit/commonDocs


Documentation / @proto-kit/common / AbstractLinkedMerkleTree

Interface: AbstractLinkedMerkleTree

Extended by

Properties

leafStore

leafStore: LinkedLeafStore

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:41


tree

tree: RollupMerkleTree

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:43

Methods

getLeaf()

getLeaf(path): undefined | LinkedLeafStruct

Returns a leaf which lives at a given path. Errors otherwise.

Parameters

path: bigint

Index of the node.

Returns

undefined | LinkedLeafStruct

The data of the leaf.

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:66


getReadWitness()

getReadWitness(path): LinkedMerkleWitnessValue

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

Parameters

path: bigint

Position of the leaf node.

Returns

LinkedMerkleWitnessValue

The witness that belongs to the leaf.

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:75


getRoot()

getRoot(): Field

Returns the root of the Merkle Tree.

Returns

Field

The root of the Merkle Tree.

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:49


setLeaf()

setLeaf(path, value?): LinkedOperationWitnessValue

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

Parameters

path: bigint

of the leaf node.

value?: bigint

New value.

Returns

LinkedOperationWitnessValue

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:56


setLeaves()

setLeaves(batch): void

Parameters

batch: object[]

Returns

void

Defined in

packages/common/src/trees/lmt/AbstractLinkedMerkleTree.ts:58