Class CompactDeepSparseMerkleSubTree<K, V>

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

Type Parameters

Hierarchy

CompactSparseMerkleTree<K, V>
- CompactDeepSparseMerkleSubTree

Index

Constructors

constructor

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

Memberof
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;
  } = ...
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns CompactDeepSparseMerkleSubTree<K, V>
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: CompactSparseMerkleProof, key: K, value?: V): Promise<void>
Add a branch to the tree, a branch is generated by smt.prove.

Memberof
CompactDeepSparseMerkleSubTree
Parameters
- proof: CompactSparseMerkleProof
- key: K
- Optional value: V
Returns Promise<void>
- Defined in src/lib/compact_smt/deep_subtree.ts:58

clear

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree

Returns Promise<void>
Inherited from CompactSparseMerkleTree.clear
- Defined in src/lib/compact_smt/csmt.ts:207

delete

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<Field>
Inherited from CompactSparseMerkleTree.delete
- Defined in src/lib/compact_smt/csmt.ts:287

depth

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

Returns
{number}

Memberof
CompactSparseMerkleTree

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

get

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

Returns
{(Promise<V | null>)}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<null | V>
Inherited from CompactSparseMerkleTree.get
- Defined in src/lib/compact_smt/csmt.ts:218

`Protected` getKeyField

getKeyField(key: K): 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}

Memberof
CompactSparseMerkleTree

Returns Field
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}

Memberof
CompactSparseMerkleTree

Returns Store<V>
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>}

Memberof
CompactSparseMerkleTree

Returns TreeHasher<K, V>
Inherited from CompactSparseMerkleTree.getTreeHasher
- Defined in src/lib/compact_smt/csmt.ts:163

has

has(key: K): Promise<boolean>
Check if the key exists in the tree.

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<boolean>
Inherited from CompactSparseMerkleTree.has
- Defined in src/lib/compact_smt/csmt.ts:234

prove

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<CompactSparseMerkleProof>
Inherited from CompactSparseMerkleTree.prove
- Defined in src/lib/compact_smt/csmt.ts:298

proveCompact

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<CSparseCompactMerkleProof>
Inherited from CompactSparseMerkleTree.proveCompact
- Defined in src/lib/compact_smt/csmt.ts:320

proveUpdatable

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
Returns Promise<CompactSparseMerkleProof>
Inherited from CompactSparseMerkleTree.proveUpdatable
- Defined in src/lib/compact_smt/csmt.ts:309

setRoot

setRoot(root: Field): Promise<void>
Set the root of the tree.

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- root: Field
Returns Promise<void>
Inherited from CompactSparseMerkleTree.setRoot
- Defined in src/lib/compact_smt/csmt.ts:184

update

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- key: K
- Optional value: V
Returns Promise<Field>
Inherited from CompactSparseMerkleTree.update
- Defined in src/lib/compact_smt/csmt.ts:251

updateAll

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree
Parameters
- kvs: {
  key: K;
  value?: V;
  }[]
Returns Promise<Field>
Inherited from CompactSparseMerkleTree.updateAll
- Defined in src/lib/compact_smt/csmt.ts:267

`Static` import

import<K, V>(store: Store<V>, keyType: Provable<K>, valueType: Provable<V>, options??: {
    hashKey?: boolean;
    hashValue?: boolean;
    hasher?: Hasher;
}): Promise<CompactSparseMerkleTree<K, V>>
Import a compacted sparse merkle tree

Static

Returns
{Promise<CompactSparseMerkleTree<K, V>>}

Memberof
CompactSparseMerkleTree
Type Parameters
- K
- V
Parameters
- store: Store<V>
- keyType: Provable<K>
- valueType: Provable<V>
- Optional options: {
      hashKey?: boolean;
      hashValue?: boolean;
      hasher?: Hasher;
  } = ...
  - Optional hashKey?: boolean
  - Optional hashValue?: boolean
  - Optional hasher?: Hasher
Returns Promise<CompactSparseMerkleTree<K, V>>
Inherited from CompactSparseMerkleTree.import
- Defined in src/lib/compact_smt/csmt.ts:101

Class CompactDeepSparseMerkleSubTree<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Type Parameters

K

V

Parameters

store: Store<V>

root: Field

keyType: Provable<K>

valueType: Provable<V>

Optional options: { hashKey?: boolean; hashValue?: boolean; hasher?: Hasher; } = ...

Optional hashKey?: boolean

Optional hashValue?: boolean

Optional hasher?: Hasher

Returns CompactDeepSparseMerkleSubTree<K, V>

Properties

Protected config

Type declaration

hashKey: boolean

hashValue: boolean

Protected keyType

Protected root

Protected store

Protected th

Protected valueType

Methods

addBranch

Memberof

Parameters

proof: CompactSparseMerkleProof

key: K

Optional value: V

Returns Promise<void>

clear

Returns

Memberof

Returns Promise<void>

delete

Returns

Memberof

Parameters

key: K

Returns Promise<Field>

depth

Returns

Memberof

Returns number

get

Returns

Memberof

Parameters

key: K

Returns Promise<null | V>

Protected getKeyField

Parameters

key: K

Returns Field

getRoot

Returns

Memberof

Returns Field

getStore

Returns

Memberof

Returns Store<V>

getTreeHasher

Returns

Memberof

Returns TreeHasher<K, V>

has

`Optional` options: {
hashKey?: boolean;
hashValue?: boolean;
hasher?: Hasher;
} = ...

`Optional` hashKey?: boolean

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher

`Protected` config

`Protected` keyType

`Protected` root

`Protected` store

`Protected` th

`Protected` valueType

`Optional` value: V

`Protected` getKeyField

`Optional` value: V

kvs: {
key: K;
value?: V;
}[]

`Static` import

`Optional` options: {
hashKey?: boolean;
hashValue?: boolean;
hasher?: Hasher;
} = ...

`Optional` hashKey?: boolean

`Optional` hashValue?: boolean

`Optional` hasher?: Hasher