Class CompactDeepSparseMerkleSubTree<K, V>

This is used to compute new roots for state transitions based on sideNodes.

CompactSparseMerkleTree

Type Parameters

Hierarchy (view full)

CompactSparseMerkleTree<K, V>
- CompactDeepSparseMerkleSubTree

Index

Constructors

constructor

new CompactDeepSparseMerkleSubTree<K, V>(store, root, keyType, valueType, options?): CompactDeepSparseMerkleSubTree<K, V>
Creates an instance of CompactDeepSparseMerkleSubTree.
Type Parameters
- K
- V
Parameters
- store: Store<V>
- root: Field
- keyType: Provable<K>
- valueType: Provable<V>
- Optional options: {
      hashKey?: boolean;
      hashValue?: boolean;
      hasher?: Hasher;
  } = ...
  hasher: The hash function to use, defaults to PoseidonHasherFunc; hashKey: whether to hash the key, the default is true; hashValue: whether to hash the value, the default is true.
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns CompactDeepSparseMerkleSubTree<K, V>
Memberof
CompactDeepSparseMerkleSubTree
Overrides CompactSparseMerkleTree.constructor
- Defined in src/lib/compact_smt/deep_subtree.ts:36

Properties

`Protected` config

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

Type declaration

hashKey: boolean
hashValue: boolean

`Protected` keyType

keyType: Provable<K>

`Protected` root

root: Field

`Protected` store

store: Store<V>

`Protected` th

th: TreeHasher<K, V>

`Protected` valueType

valueType: Provable<V>

Methods

addBranch

addBranch(proof, key, value?): Promise<void>
Add a branch to the tree, a branch is generated by smt.prove.
Parameters
- proof: CompactSparseMerkleProof
- key: K
- Optional value: V
Returns Promise<void>
Memberof
CompactDeepSparseMerkleSubTree
- Defined in src/lib/compact_smt/deep_subtree.ts:58

clear

clear(): Promise<void>
Clear the tree.

Returns Promise<void>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.clear
- Defined in src/lib/compact_smt/csmt.ts:207

delete

delete(key): Promise<Field>
Delete a value from tree and return the new root of the tree.
Parameters
- key: K
Returns Promise<Field>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.delete
- Defined in src/lib/compact_smt/csmt.ts:287

depth

depth(): number
Get the depth of the tree.

Returns number
{number}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.depth
- Defined in src/lib/compact_smt/csmt.ts:197

get

get(key): Promise<null | V>
Get the value for a key from the tree.
Parameters
- key: K
Returns Promise<null | V>
{(Promise<V | null>)}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.get
- Defined in src/lib/compact_smt/csmt.ts:218

`Protected` getKeyField

getKeyField(key): Field
Parameters
- key: K
Returns Field
Inherited from CompactSparseMerkleTree.getKeyField
- Defined in src/lib/compact_smt/csmt.ts:130

getRoot

getRoot(): Field
Get the root of the tree.

Returns Field
{Field}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.getRoot
- Defined in src/lib/compact_smt/csmt.ts:153

getStore

getStore(): Store<V>
Get the data store of the tree.

Returns Store<V>
{Store}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.getStore
- Defined in src/lib/compact_smt/csmt.ts:173

getTreeHasher

getTreeHasher(): TreeHasher<K, V>
Get the tree hasher used by the tree.

Returns TreeHasher<K, V>
{TreeHasher<K, V>}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.getTreeHasher
- Defined in src/lib/compact_smt/csmt.ts:163

has

has(key): Promise<boolean>
Check if the key exists in the tree.
Parameters
- key: K
Returns Promise<boolean>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.has
- Defined in src/lib/compact_smt/csmt.ts:234

prove

prove(key): Promise<CompactSparseMerkleProof>
Create a merkle proof for a key against the current root.
Parameters
- key: K
Returns Promise<CompactSparseMerkleProof>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.prove
- Defined in src/lib/compact_smt/csmt.ts:298

proveCompact

proveCompact(key): Promise<CSparseCompactMerkleProof>
Create a compacted merkle proof for a key against the current root.
Parameters
- key: K
Returns Promise<CSparseCompactMerkleProof>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.proveCompact
- Defined in src/lib/compact_smt/csmt.ts:320

proveUpdatable

proveUpdatable(key): Promise<CompactSparseMerkleProof>
Create an updatable Merkle proof for a key against the current root.
Parameters
- key: K
Returns Promise<CompactSparseMerkleProof>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.proveUpdatable
- Defined in src/lib/compact_smt/csmt.ts:309

setRoot

setRoot(root): Promise<void>
Set the root of the tree.
Parameters
- root: Field
Returns Promise<void>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.setRoot
- Defined in src/lib/compact_smt/csmt.ts:184

update

update(key, value?): Promise<Field>
Update a new value for a key in the tree and return the new root of the tree.
Parameters
- key: K
- Optional value: V
Returns Promise<Field>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.update
- Defined in src/lib/compact_smt/csmt.ts:251

updateAll

updateAll(kvs): Promise<Field>
Update multiple leaves and return the new root of the tree.
Parameters
- kvs: {
  key: K;
  value?: V;
  }[]
Returns Promise<Field>
{Promise}

Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.updateAll
- Defined in src/lib/compact_smt/csmt.ts:267

`Static` import

import<K, V>(store, keyType, valueType, options?): Promise<CompactSparseMerkleTree<K, V>>
Import a compacted sparse merkle tree
Type Parameters
- K
- V
Parameters
- store: Store<V>
- keyType: Provable<K>
- valueType: Provable<V>
- Optional options: {
      hashKey?: boolean;
      hashValue?: boolean;
      hasher?: Hasher;
  } = ...
  hasher: The hash function to use, defaults to PoseidonHasherFunc; hashKey: whether to hash the key, the default is true; hashValue: whether to hash the value, the default is true.
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<CompactSparseMerkleTree<K, V>>
{Promise<CompactSparseMerkleTree<K, V>>}

Static
Memberof
CompactSparseMerkleTree
Inherited from CompactSparseMerkleTree.import
- Defined in src/lib/compact_smt/csmt.ts:101

Class CompactDeepSparseMerkleSubTree<K, V>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Optional hashKey?: boolean

Optional hashValue?: boolean

Optional hasher?: Hasher

Returns CompactDeepSparseMerkleSubTree<K, V>

Memberof

Properties

Protected config

Type declaration

hashKey: boolean

hashValue: boolean

Protected keyType

Protected root

Protected store

Protected th

Protected valueType

Methods

addBranch

Parameters

Returns Promise<void>

Memberof

clear

Returns Promise<void>

Memberof

delete

Parameters

Returns Promise<Field>

Memberof

depth

Returns number

Memberof

get

Parameters

Returns Promise<null | V>

Memberof

Protected getKeyField

Parameters

Returns Field

getRoot

Returns Field

Memberof

getStore

Returns Store<V>

Memberof

getTreeHasher

Returns TreeHasher<K, V>

Memberof

has

Parameters

Returns Promise<boolean>

Memberof

prove

Parameters

Returns Promise<CompactSparseMerkleProof>

Memberof

proveCompact

Parameters

Returns Promise<CSparseCompactMerkleProof>

Memberof

proveUpdatable

Parameters

Returns Promise<CompactSparseMerkleProof>

Memberof

setRoot

Parameters

Returns Promise<void>

Memberof

update

Parameters

Returns Promise<Field>

`Optional` hashKey?: boolean

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher

`Protected` config

`Protected` keyType

`Protected` root

`Protected` store

`Protected` th

`Protected` valueType

`Protected` getKeyField

`Static` import

`Optional` hashKey?: boolean

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher