@proto-kit/common • Docs

Documentation / @proto-kit/common / LinkedMerkleTree

Class: LinkedMerkleTree

Extends

• AbstractLinkedMerkleTree

Constructors

new LinkedMerkleTree()

new LinkedMerkleTree(store, leafStore): LinkedMerkleTree

Parameters

• store: MerkleTreeStore

• leafStore: LinkedLeafStore

Returns

LinkedMerkleTree

Inherited from

createLinkedMerkleTree(40).constructor

Defined in

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

Properties

leafStore

leafStore: LinkedLeafStore

Inherited from

AbstractLinkedMerkleTree.leafStore

Defined in

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

tree

tree: RollupMerkleTree

Inherited from

AbstractLinkedMerkleTree.tree

Defined in

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

EMPTY_ROOT

static EMPTY_ROOT: Field

Inherited from

createLinkedMerkleTree(40).EMPTY_ROOT

Defined in

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

HEIGHT

static HEIGHT: number

Inherited from

createLinkedMerkleTree(40).HEIGHT

Defined in

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

READ_WITNESS

static READ_WITNESS: typeof LinkedMerkleWitnessTemplate & TypedClass<object>

Inherited from

createLinkedMerkleTree(40).READ_WITNESS

Defined in

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

WITNESS

static WITNESS: typeof LinkedOperationWitnessTemplate & object

Type declaration

fromReadWitness()

Parameters

• readWitness: LinkedMerkleWitnessTemplate

Returns

LinkedOperationWitnessTemplate

Inherited from

createLinkedMerkleTree(40).WITNESS

Defined in

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

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.

Inherited from

AbstractLinkedMerkleTree.getLeaf

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.

Inherited from

AbstractLinkedMerkleTree.getReadWitness

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.

Inherited from

AbstractLinkedMerkleTree.getRoot

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

Inherited from

AbstractLinkedMerkleTree.setLeaf

Defined in

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

setLeaves()

setLeaves(batch): void

Parameters

• batch: object[]

Returns

void

Inherited from

AbstractLinkedMerkleTree.setLeaves

Defined in

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

dummyReadWitness()

static dummyReadWitness(): LinkedMerkleWitnessValue

Returns

LinkedMerkleWitnessValue

Inherited from

createLinkedMerkleTree(40).dummyReadWitness

Defined in

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

dummyWitness()

static dummyWitness(): LinkedOperationWitnessValue

Returns

LinkedOperationWitnessValue

Inherited from

createLinkedMerkleTree(40).dummyWitness

Defined in

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