Class ProvableSMTUtils

constructor

• new ProvableSMTUtils(): ProvableSMTUtils

• Returns ProvableSMTUtils

Static EMPTY_VALUE

Static computeRootByField

Static verifyProofByField

Static checkMembership

• checkMembership<K, V>(proof, expectedRoot, key, keyType, value, valueType, options?): Bool

• Returns true if the value is in the tree and it is at the index from the key

  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;
    } = ...

    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.

    • hashKey: boolean

    • hashValue: boolean

    • Optional hasher?: Hasher

  Returns Bool

  {Bool}

  Static

  Memberof

  ProvableSMTUtils

Static checkNonMembership

• checkNonMembership<K>(proof, expectedRoot, key, keyType, options?): Bool

• Returns true if there is no value at the index from the key

  Type Parameters

  • K

  Parameters

  • proof: SparseMerkleProof
  • expectedRoot: Field
  • key: K
  • keyType: Provable<K>
  • Optional options: {
        hashKey: 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.

    • hashKey: boolean

    • Optional hasher?: Hasher

  Returns Bool

  {Bool}

  Static

  Memberof

  ProvableSMTUtils

Static computeRoot

• computeRoot<K, V>(sideNodes, key, keyType, value, valueType, options?): Field

• Calculate new root based on sideNodes, key and value

  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

  {Field}

  Static

  Memberof

  ProvableSMTUtils