Class ProvableSMTUtils

Collection of utility functions for sparse merkle tree in the circuit.

Hierarchy

ProvableSMTUtils

Index

Constructors

constructor

new ProvableSMTUtils(): ProvableSMTUtils
Returns ProvableSMTUtils

Properties

`Static` EMPTY_VALUE

EMPTY_VALUE: Field = EMPTY_VALUE

Empty value for sparse merkle tree

Static

Memberof

ProvableSMTUtils

`Static` computeRootByField

computeRootByField: ((sideNodes: Field[], keyHashOrKeyField: Field, valueHashOrValueField: Field, hasher??: Hasher) => Field) = computeRootByFieldInCircuit

Type declaration

- (sideNodes: Field[], keyHashOrKeyField: Field, valueHashOrValueField: Field, hasher??: Hasher): Field
- Calculate new root based on sideNodes, keyHashOrKeyField and valueHashOrValueField in circuit.
  
  Returns
  {Field}
  Parameters
  - sideNodes: Field[]
  - keyHashOrKeyField: Field
  - valueHashOrValueField: Field
  - Optional hasher: Hasher = Poseidon.hash
  Returns Field

`Static` verifyProofByField

verifyProofByField: ((proof: SparseMerkleProof, expectedRoot: Field, keyHashOrKeyField: Field, valueHashOrValueField: Field, hasher??: Hasher) => Bool) = verifyProofByFieldInCircuit

Type declaration

- (proof: SparseMerkleProof, expectedRoot: Field, keyHashOrKeyField: Field, valueHashOrValueField: Field, hasher??: Hasher): Bool
- Verify a merkle proof by root, keyHashOrKeyField and valueHashOrValueField in circuit.
  
  Returns
  {Bool}
  Parameters
  - proof: SparseMerkleProof
  - expectedRoot: Field
  - keyHashOrKeyField: Field
  - valueHashOrValueField: Field
  - Optional hasher: Hasher = Poseidon.hash
  Returns Bool

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;
}): Bool
Returns true if the value is in the tree and it is at the index from the key

Static

Returns
{Bool}

Memberof
ProvableSMTUtils
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
  - Optional hasher?: Hasher
Returns Bool
- Defined in src/lib/smt/verify_circuit.ts:71

`Static` checkNonMembership

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

Static

Returns
{Bool}

Memberof
ProvableSMTUtils
Type Parameters
- K
Parameters
- proof: SparseMerkleProof
- expectedRoot: Field
- key: K
- keyType: Provable<K>
- Optional options: {
  hashKey: boolean;
  hasher?: Hasher;
  } = ...
  - hashKey: boolean
  - Optional hasher?: Hasher
Returns Bool
- Defined in src/lib/smt/verify_circuit.ts:126

`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
ProvableSMTUtils
Type Parameters
- K
- V
Parameters
- sideNodes: Field[]
- key: K
- keyType: Provable<K>
- value: V
- valueType: Provable<V>
- Optional options: {
      hashKey: boolean;
      hashValue: boolean;
      hasher?: Hasher;
  } = ...
  - hashKey: boolean
  - hashValue: boolean
  - Optional hasher?: Hasher
Returns Field
- Defined in src/lib/smt/verify_circuit.ts:175

Class ProvableSMTUtils

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ProvableSMTUtils

Properties

Static EMPTY_VALUE

Static

Memberof

Static computeRootByField

Type declaration

Returns

Parameters

sideNodes: Field[]

keyHashOrKeyField: Field

valueHashOrValueField: Field

Optional hasher: Hasher = Poseidon.hash

Returns Field

Static verifyProofByField

Type declaration

Returns

Parameters

proof: SparseMerkleProof

expectedRoot: Field

keyHashOrKeyField: Field

valueHashOrValueField: Field

Optional hasher: Hasher = Poseidon.hash

Returns Bool

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

Optional hasher?: Hasher

Returns Bool

Static checkNonMembership

Static

Returns

Memberof

Type Parameters

K

Parameters

proof: SparseMerkleProof

expectedRoot: Field

key: K

keyType: Provable<K>

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

hashKey: boolean

Optional hasher?: Hasher

Returns Bool

Static computeRoot

Static

Returns

Memberof

Type Parameters

K

V

Parameters

sideNodes: Field[]

key: K

keyType: Provable<K>

value: V

valueType: Provable<V>

`Static` EMPTY_VALUE

`Static` computeRootByField

`Optional` hasher: Hasher = Poseidon.hash

`Static` verifyProofByField

`Optional` hasher: Hasher = Poseidon.hash

`Static` checkMembership

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

`Optional` hasher?: Hasher

`Static` checkNonMembership

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

`Optional` hasher?: Hasher

`Static` computeRoot

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

`Optional` hasher?: Hasher