Class ProvableDeepSparseMerkleSubTree<K, V>

ProvableDeepSparseMerkleSubTree is a deep sparse merkle subtree for working on only a few leafs in circuit.

Type Parameters

K
V

Hierarchy

ProvableDeepSparseMerkleSubTree

Index

Constructors

Properties

config hasher keyType nodeStore root valueStore valueType

Methods

addBranch getHeight getKeyField getRoot getValueField prove update

Constructors

constructor

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

Memberof
ProvableDeepSparseMerkleSubTree
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 ProvableDeepSparseMerkleSubTree<K, V>
- Defined in src/lib/smt/deep_subtree_circuit.ts:40

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): void
Add a branch to the tree, a branch is generated by smt.prove.

Memberof
ProvableDeepSparseMerkleSubTree
Parameters
- proof: SparseMerkleProof
- key: K
- Optional value: V
Returns void
- Defined in src/lib/smt/deep_subtree_circuit.ts:109

getHeight

getHeight(): number
Get height of the tree.

Returns
{number}

Memberof
ProvableDeepSparseMerkleSubTree

Returns number
- Defined in src/lib/smt/deep_subtree_circuit.ts:75

`Private` getKeyField

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

getRoot

getRoot(): Field
Get current root.

Returns
{Field}

Memberof
ProvableDeepSparseMerkleSubTree

Returns Field
- Defined in src/lib/smt/deep_subtree_circuit.ts:65

`Private` getValueField

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

prove

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

Returns
{SparseMerkleProof}

Memberof
ProvableDeepSparseMerkleSubTree
Parameters
- key: K
Returns SparseMerkleProof
- Defined in src/lib/smt/deep_subtree_circuit.ts:136

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
ProvableDeepSparseMerkleSubTree
Parameters
- key: K
- Optional value: V
Returns Field
- Defined in src/lib/smt/deep_subtree_circuit.ts:178

Generated using TypeDoc