Class CompactSparseMerkleTree<K, V>

Compact Sparse Merkle Tree

Type Parameters

Hierarchy

CompactSparseMerkleTree
- CompactDeepSparseMerkleSubTree

Index

Constructors

constructor

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

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

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

clear

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

Returns
{Promise}

Memberof
CompactSparseMerkleTree

Returns Promise<void>
- 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>
- Defined in src/lib/compact_smt/csmt.ts:287

`Private` deleteWithSideNodes

deleteWithSideNodes(path: Field, sideNodes: Field[], pathNodes: Field[], oldLeafData: Field[]): Promise<Field>
Parameters
- path: Field
- sideNodes: Field[]
- pathNodes: Field[]
- oldLeafData: Field[]
Returns Promise<Field>
- Defined in src/lib/compact_smt/csmt.ts:524

depth

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

Returns
{number}

Memberof
CompactSparseMerkleTree

Returns number
- Defined in src/lib/compact_smt/csmt.ts:197

`Private` doProveForRoot

doProveForRoot(root: Field, key: K, isUpdatable: boolean): Promise<CompactSparseMerkleProof>
Parameters
- root: Field
- key: K
- isUpdatable: boolean
Returns Promise<CompactSparseMerkleProof>
- Defined in src/lib/compact_smt/csmt.ts:332

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>
- Defined in src/lib/compact_smt/csmt.ts:218

`Protected` getKeyField

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

getRoot

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

Returns
{Field}

Memberof
CompactSparseMerkleTree

Returns Field
- 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>
- 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>
- 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>
- 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>
- 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>
- Defined in src/lib/compact_smt/csmt.ts:320

`Private` proveCompactForRoot

proveCompactForRoot(root: Field, key: K): Promise<CSparseCompactMerkleProof>
Parameters
- root: Field
- key: K
Returns Promise<CSparseCompactMerkleProof>
- Defined in src/lib/compact_smt/csmt.ts:324

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>
- 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>
- Defined in src/lib/compact_smt/csmt.ts:184

`Private` sideNodesForRoot

sideNodesForRoot(path: Field, root: Field, getSiblingData: boolean): Promise<{
    currentData: null | Field[];
    pathNodes: Field[];
    siblingData: null | Field[];
    sideNodes: Field[];
}>
Parameters
- path: Field
- root: Field
- getSiblingData: boolean
Returns Promise<{
    currentData: null | Field[];
    pathNodes: Field[];
    siblingData: null | Field[];
    sideNodes: Field[];
}>
- Defined in src/lib/compact_smt/csmt.ts:586

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>
- 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>
- Defined in src/lib/compact_smt/csmt.ts:267

`Private` updateForRoot

updateForRoot(root: Field, key: K, value?: V): Promise<Field>
Parameters
- root: Field
- key: K
- Optional value: V
Returns Promise<Field>
- Defined in src/lib/compact_smt/csmt.ts:366

`Private` updateWithSideNodes

updateWithSideNodes(path: Field, value: V, sideNodes: Field[], pathNodes: Field[], oldLeafData: Field[]): Field
Parameters
- path: Field
- value: V
- sideNodes: Field[]
- pathNodes: Field[]
- oldLeafData: Field[]
Returns Field
- Defined in src/lib/compact_smt/csmt.ts:407

`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>>
- Defined in src/lib/compact_smt/csmt.ts:101

Class CompactSparseMerkleTree<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Type Parameters

K

V

Parameters

store: Store<V>

keyType: Provable<K>

valueType: Provable<V>

Optional root: Field

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

Optional hashKey?: boolean

Optional hashValue?: boolean

Optional hasher?: Hasher

Returns CompactSparseMerkleTree<K, V>

Properties

Protected config

Type declaration

hashKey: boolean

hashValue: boolean

Protected keyType

Protected root

Protected store

Protected th

Protected valueType

Methods

clear

Returns

Memberof

Returns Promise<void>

delete

Returns

Memberof

Parameters

key: K

Returns Promise<Field>

Private deleteWithSideNodes

Parameters

path: Field

sideNodes: Field[]

pathNodes: Field[]

oldLeafData: Field[]

Returns Promise<Field>

depth

Returns

Memberof

Returns number

Private doProveForRoot

Parameters

root: Field

key: K

isUpdatable: boolean

Returns Promise<CompactSparseMerkleProof>

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

`Optional` root: Field

`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

`Private` deleteWithSideNodes

`Private` doProveForRoot

`Protected` getKeyField

`Private` proveCompactForRoot

`Private` sideNodesForRoot

Returns Promise<{
currentData: null | Field[];
pathNodes: Field[];
siblingData: null | Field[];
sideNodes: Field[];
}>

`Optional` value: V

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

`Private` updateForRoot

`Optional` value: V

`Private` updateWithSideNodes