Interface IMerkleTree

Defines the interface for a Merkle tree.

interface IMerkleTree {
    commit(): Promise<void>;
    getDepth(): number;
    getLeafValue(index, includeUncommitted): Promise<undefined | Field>;
    getNumLeaves(includeUncommitted): bigint;
    getRoot(includeUncommitted): Field;
    getSiblingPath(index, includeUncommitted): Promise<BaseSiblingPath>;
    rollback(): Promise<void>;
}

Hierarchy (view full)

Methods

commit getDepth getLeafValue getNumLeaves getRoot getSiblingPath rollback

Methods

commit

getDepth

getLeafValue

  • getLeafValue(index, includeUncommitted): Promise<undefined | Field>

  • Returns the value of a leaf at the specified index.

    Parameters

    • index: bigint

      The index of the leaf value to be returned.

    • includeUncommitted: boolean

      Set to true to include uncommitted updates in the data set.

    Returns Promise<undefined | Field>

getNumLeaves

  • getNumLeaves(includeUncommitted): bigint

  • Returns the number of leaves in the tree.

    Parameters

    • includeUncommitted: boolean

      Set to true to include uncommitted updates in the returned value.

    Returns bigint

getRoot

  • getRoot(includeUncommitted): Field

  • Returns the current root of the tree.

    Parameters

    • includeUncommitted: boolean

      Set to true to include uncommitted updates in the calculated root.

    Returns Field

getSiblingPath

rollback

Settings

Member Visibility

Theme

On This Page

commitgetDepthgetLeafValuegetNumLeavesgetRootgetSiblingPathrollback