Class DeepSparseMerkleSubTree<K, V>

DeepSparseMerkleSubTree is a deep sparse merkle subtree for working on only a few leafs.

Type Parameters

K
V

Hierarchy

DeepSparseMerkleSubTree

Index

Constructors

Properties

config hasher keyType nodeStore root valueStore valueType

Methods

addBranch getHeight getKeyField getRoot getValueField has prove update

Constructors

constructor

new DeepSparseMerkleSubTree<K, V>(root: Field, keyType: Provable<K>, valueType: Provable<V>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): DeepSparseMerkleSubTree<K, V>
Creates an instance of DeepSparseMerkleSubTree.

Memberof
DeepSparseMerkleSubTree
Type Parameters
- K
- V
Parameters
- root: Field
  
  merkle root
- keyType: Provable<K>
- valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns DeepSparseMerkleSubTree<K, V>
- Defined in src/lib/smt/deep_subtree.ts:37

Properties

`Private` config

config: {
hashKey: boolean;
hashValue: boolean;
}

Type declaration

hashKey: boolean
hashValue: boolean

`Private` hasher

hasher: Hasher

`Private` keyType

keyType: Provable<K>

`Private` nodeStore

nodeStore: Map<string, Field[]>

`Private` root

root: Field

`Private` valueStore

valueStore: Map<string, Field>

`Private` valueType

valueType: Provable<V>

Methods

addBranch

addBranch(proof: SparseMerkleProof, key: K, value?: V, ignoreInvalidProof??: boolean): void
Add a branch to the tree, a branch is generated by smt.prove.

Returns

Memberof
DeepSparseMerkleSubTree
Parameters
- proof: SparseMerkleProof
- key: K
- Optional value: V
- Optional ignoreInvalidProof: boolean = false
  
  whether to throw an error when proof is invalid
Returns void
- Defined in src/lib/smt/deep_subtree.ts:126

getHeight

getHeight(): number
Get height of the tree.

Returns
{number}

Memberof
DeepSparseMerkleSubTree

Returns number
- Defined in src/lib/smt/deep_subtree.ts:72

`Private` getKeyField

getKeyField(key: K): Field
Parameters
- key: K
Returns Field
- Defined in src/lib/smt/deep_subtree.ts:76

getRoot

getRoot(): Field
Get current root.

Returns
{Field}

Memberof
DeepSparseMerkleSubTree

Returns Field
- Defined in src/lib/smt/deep_subtree.ts:62

`Private` getValueField

getValueField(value?: V): Field
Parameters
- Optional value: V
Returns Field
- Defined in src/lib/smt/deep_subtree.ts:86

has

has(key: K, value: V): boolean
Check whether there is a corresponding key and value in the tree

Returns
{boolean}

Memberof
DeepSparseMerkleSubTree
Parameters
- key: K
- value: V
Returns boolean
- Defined in src/lib/smt/deep_subtree.ts:105

prove

prove(key: K): SparseMerkleProof
Create a merkle proof for a key against the current root.

Returns
{SparseMerkleProof}

Memberof
DeepSparseMerkleSubTree
Parameters
- key: K
Returns SparseMerkleProof
- Defined in src/lib/smt/deep_subtree.ts:167

update

update(key: K, value?: V): Field
Update a new value for a key in the tree and return the new root of the tree.

Returns
{Field}

Memberof
DeepSparseMerkleSubTree
Parameters
- key: K
- Optional value: V
Returns Field
- Defined in src/lib/smt/deep_subtree.ts:208

Generated using TypeDoc