Class SMTUtils

Collection of utility functions for sparse merkle tree

Hierarchy

SMTUtils

Index

Constructors

Methods

checkMembership checkNonMembership compactProof computeRoot decompactProof jsonToSparseCompactMerkleProof sparseCompactMerkleProofToJson verifyCompactProof verifyProof

Constructors

constructor

new SMTUtils(): SMTUtils
Returns SMTUtils

Methods

`Static` checkMembership

checkMembership<K, V>(proof: SparseMerkleProof, expectedRoot: Field, key: K, keyType: Provable<K>, value: V, valueType: Provable<V>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): boolean
Returns true if the value is in the tree and it is at the index from the key

Static

Returns
{boolean}

Memberof
SMTUtils
Type Parameters
- K
- V
Parameters
- proof: SparseMerkleProof
- expectedRoot: Field
- key: K
- keyType: Provable<K>
- value: V
- valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/smt/proofs.ts:189

`Static` checkNonMembership

checkNonMembership<K, V>(proof: SparseMerkleProof, expectedRoot: Field, key: K, keyType: Provable<K>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): boolean
Returns true if there is no value at the index from the key

Static

Returns
{boolean}

Memberof
SMTUtils
Type Parameters
- K
- V
Parameters
- proof: SparseMerkleProof
- expectedRoot: Field
- key: K
- keyType: Provable<K>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/smt/proofs.ts:233

`Static` compactProof

compactProof(proof: SparseMerkleProof, hasher??: Hasher): SparseCompactMerkleProof
Compact a proof to reduce its size

Static

Returns
{SparseCompactMerkleProof}

Memberof
SMTUtils
Parameters
- proof: SparseMerkleProof
- Optional hasher: Hasher = Poseidon.hash
Returns SparseCompactMerkleProof
- Defined in src/lib/smt/proofs.ts:359

`Static` computeRoot

computeRoot<K, V>(sideNodes: Field[], key: K, keyType: Provable<K>, value?: V, valueType?: Provable<V>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): Field
Calculate new root based on sideNodes, key and value

Static

Returns
{Field}

Memberof
SMTUtils
Type Parameters
- K
- V
Parameters
- sideNodes: Field[]
- key: K
- keyType: Provable<K>
- Optional value: V
- Optional valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns Field
- Defined in src/lib/smt/proofs.ts:118

`Static` decompactProof

decompactProof(proof: SparseCompactMerkleProof, hasher??: Hasher): SparseMerkleProof
Decompact a proof

Static

Returns
{SparseMerkleProof}

Memberof
SMTUtils
Parameters
- proof: SparseCompactMerkleProof
- Optional hasher: Hasher = Poseidon.hash
Returns SparseMerkleProof
- Defined in src/lib/smt/proofs.ts:394

`Static` jsonToSparseCompactMerkleProof

jsonToSparseCompactMerkleProof(jsonValue: SparseCompactMerkleProofJSON): SparseCompactMerkleProof
Convert JSONValue to SparseCompactMerkleProof

Static

Returns
{SparseCompactMerkleProof}

Memberof
SMTUtils
Parameters
- jsonValue: SparseCompactMerkleProofJSON
Returns SparseCompactMerkleProof
- Defined in src/lib/smt/proofs.ts:81

`Static` sparseCompactMerkleProofToJson

sparseCompactMerkleProofToJson(proof: SparseCompactMerkleProof): SparseCompactMerkleProofJSON
Convert SparseCompactMerkleProof to JSONValue.

Static

Returns
{SparseCompactMerkleProofJSON}

Memberof
SMTUtils
Parameters
- proof: SparseCompactMerkleProof
Returns SparseCompactMerkleProofJSON
- Defined in src/lib/smt/proofs.ts:57

`Static` verifyCompactProof

verifyCompactProof<K, V>(cproof: SparseCompactMerkleProof, expectedRoot: Field, key: K, keyType: Provable<K>, value?: V, valueType?: Provable<V>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): boolean
Verify a compacted merkle proof

Static

Returns
{boolean}

Memberof
SMTUtils
Type Parameters
- K
- V
Parameters
- cproof: SparseCompactMerkleProof
- expectedRoot: Field
- key: K
- keyType: Provable<K>
- Optional value: V
- Optional valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/smt/proofs.ts:325

`Static` verifyProof

verifyProof<K, V>(proof: SparseMerkleProof, expectedRoot: Field, key: K, keyType: Provable<K>, value?: V, valueType?: Provable<V>, options??: {
    hashKey: boolean;
    hashValue: boolean;
    hasher: Hasher;
}): boolean
Verify a merkle proof

Static

Returns
{boolean}

Memberof
SMTUtils
Type Parameters
- K
- V
Parameters
- proof: SparseMerkleProof
- expectedRoot: Field
- key: K
- keyType: Provable<K>
- Optional value: V
- Optional valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/smt/proofs.ts:277

Class SMTUtils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns SMTUtils

Methods

Static checkMembership

Static

Returns

Memberof

Type Parameters

K

V

Parameters

proof: SparseMerkleProof

expectedRoot: Field

key: K

keyType: Provable<K>

value: V

valueType: Provable<V>

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

hashKey: boolean

hashValue: boolean

hasher: Hasher

Returns boolean

Static checkNonMembership

Static

Returns

Memberof

Type Parameters

K

V

Parameters

proof: SparseMerkleProof

expectedRoot: Field

key: K

keyType: Provable<K>

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

hashKey: boolean

hashValue: boolean

hasher: Hasher

Returns boolean

Static compactProof

Static

Returns

Memberof

Parameters

proof: SparseMerkleProof

Optional hasher: Hasher = Poseidon.hash

Returns SparseCompactMerkleProof

Static computeRoot

Static

Returns

Memberof

Type Parameters

K

V

Parameters

sideNodes: Field[]

key: K

keyType: Provable<K>

Optional value: V

Optional valueType: Provable<V>

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

hashKey: boolean

hashValue: boolean

hasher: Hasher

Returns Field

Static decompactProof

Static

Returns

Memberof

Parameters

proof: SparseCompactMerkleProof

Optional hasher: Hasher = Poseidon.hash

Returns SparseMerkleProof

Static jsonToSparseCompactMerkleProof

`Static` checkMembership

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

`Static` checkNonMembership

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

`Static` compactProof

`Optional` hasher: Hasher = Poseidon.hash

`Static` computeRoot

`Optional` value: V

`Optional` valueType: Provable<V>

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

`Static` decompactProof

`Optional` hasher: Hasher = Poseidon.hash

`Static` jsonToSparseCompactMerkleProof

`Static` sparseCompactMerkleProofToJson

`Static` verifyCompactProof

`Optional` value: V

`Optional` valueType: Provable<V>

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

`Static` verifyProof

`Optional` value: V

`Optional` valueType: Provable<V>

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