Class MerkleTreeUtils

Collection of utility functions for merkle tree

Hierarchy

MerkleTreeUtils

Index

Constructors

Methods

checkMembership checkNonMembership compactMerkleProof compactMerkleProofToJson computeRoot computeRootByField computeRootByFieldWithUpdates decompactMerkleProof jsonToCompactMerkleProof verifyProof verifyProofByField verifyProofByFieldWithUpdates

Constructors

constructor

new MerkleTreeUtils(): MerkleTreeUtils
Returns MerkleTreeUtils

Methods

`Static` checkMembership

checkMembership<V>(proof: BaseMerkleProof, expectedRoot: Field, index: bigint, value: V, valueType: Provable<V>, options??: {
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
MerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: bigint
- value: V
- valueType: Provable<V>
- Optional options: {
  hashValue: boolean;
  hasher: Hasher;
  } = ...
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/merkle/proofs.ts:279

`Static` checkNonMembership

checkNonMembership<V>(proof: BaseMerkleProof, expectedRoot: Field, index: bigint, hasher??: Hasher): boolean
Returns true if there is no value at the index from the key

Static

Returns
{boolean}

Memberof
MerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: bigint
- Optional hasher: Hasher = Poseidon.hash
Returns boolean
- Defined in src/lib/merkle/proofs.ts:312

`Static` compactMerkleProof

compactMerkleProof(proof: BaseMerkleProof, hasher??: Hasher): CompactMerkleProof
Compact a merkle proof to reduce its size

Static

Returns
{CompactMerkleProof}

Memberof
MerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- Optional hasher: Hasher = Poseidon.hash
Returns CompactMerkleProof
- Defined in src/lib/merkle/proofs.ts:90

`Static` compactMerkleProofToJson

compactMerkleProofToJson(proof: CompactMerkleProof): CompactMerkleProofJSON
Convert CompactMerkleProof to JSONValue.

Static

Returns
{CompactMerkleProofJSON}

Memberof
MerkleTreeUtils
Parameters
- proof: CompactMerkleProof
Returns CompactMerkleProofJSON
- Defined in src/lib/merkle/proofs.ts:162

`Static` computeRoot

computeRoot<V>(proof: BaseMerkleProof, index: bigint, value?: V, valueType?: Provable<V>, options??: {
hashValue: boolean;
hasher: Hasher;
}): Field
Calculate new root based on value. Note: This method cannot be executed in a circuit.

Static

Returns
{Field}

Memberof
MerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- index: bigint
- Optional value: V
- Optional valueType: Provable<V>
- Optional options: {
  hashValue: boolean;
  hasher: Hasher;
  } = ...
  - hashValue: boolean
  - hasher: Hasher
Returns Field
- Defined in src/lib/merkle/proofs.ts:213

`Static` computeRootByField

computeRootByField(proof: BaseMerkleProof, index: bigint, valueHashOrValueField: Field, hasher??: Hasher): Field
Compute new merkle root by index and valueHashOrValueField

Static

Returns
{Field}

Memberof
MerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- index: bigint
- valueHashOrValueField: Field
- Optional hasher: Hasher = Poseidon.hash
Returns Field
- Defined in src/lib/merkle/proofs.ts:451

`Static` computeRootByFieldWithUpdates

computeRootByFieldWithUpdates(proof: BaseMerkleProof, index: bigint, valueHashOrValueField: Field, hasher??: Hasher): {
actualRoot: Field;
updates: [Field, Field[]][];
}
Compute new merkle root by index and valueHashOrValueField, return new root and updates.

Static

Returns
{{ actualRoot: Field; updates: [Field, Field[]][] }}

Memberof
MerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- index: bigint
- valueHashOrValueField: Field
- Optional hasher: Hasher = Poseidon.hash
Returns {
actualRoot: Field;
updates: [Field, Field[]][];
}
- actualRoot: Field
- updates: [Field, Field[]][]
- Defined in src/lib/merkle/proofs.ts:489

`Static` decompactMerkleProof

decompactMerkleProof(proof: CompactMerkleProof, hasher??: Hasher): BaseMerkleProof
Decompact a CompactMerkleProof.

Static

Returns
{BaseMerkleProof}

Memberof
MerkleTreeUtils
Parameters
- proof: CompactMerkleProof
- Optional hasher: Hasher = Poseidon.hash
Returns BaseMerkleProof
- Defined in src/lib/merkle/proofs.ts:127

`Static` jsonToCompactMerkleProof

jsonToCompactMerkleProof(jsonValue: CompactMerkleProofJSON): CompactMerkleProof
Convert JSONValue to CompactMerkleProof

Static

Returns
{CompactMerkleProof}

Memberof
MerkleTreeUtils
Parameters
- jsonValue: CompactMerkleProofJSON
Returns CompactMerkleProof
- Defined in src/lib/merkle/proofs.ts:183

`Static` verifyProof

verifyProof<V>(proof: BaseMerkleProof, expectedRoot: Field, index: bigint, value?: V, valueType?: Provable<V>, options??: {
hashValue: boolean;
hasher: Hasher;
}): boolean
Verify the merkle proof.

Static

Returns
{boolean}

Memberof
MerkleTreeUtils
Type Parameters
- V
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: bigint
- Optional value: V
- Optional valueType: Provable<V>
- Optional options: {
  hashValue: boolean;
  hasher: Hasher;
  } = ...
  - hashValue: boolean
  - hasher: Hasher
Returns boolean
- Defined in src/lib/merkle/proofs.ts:349

`Static` verifyProofByField

verifyProofByField(proof: BaseMerkleProof, expectedRoot: Field, index: bigint, valueHashOrValueField: Field, hasher??: Hasher): boolean
Verify the merkle proof by index and valueHashOrValueField

Static

Returns
{boolean}

Memberof
MerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: bigint
- valueHashOrValueField: Field
- Optional hasher: Hasher = Poseidon.hash
Returns boolean
- Defined in src/lib/merkle/proofs.ts:386

`Static` verifyProofByFieldWithUpdates

verifyProofByFieldWithUpdates(proof: BaseMerkleProof, expectedRoot: Field, index: bigint, valueHashOrValueField: Field, hasher??: Hasher): {
ok: boolean;
updates: [Field, Field[]][];
}
Verify the merkle proof by index and valueHashOrValueField, return result and updates

Static

Returns
{{ ok: boolean; updates: [Field, Field[]][] }}

Memberof
MerkleTreeUtils
Parameters
- proof: BaseMerkleProof
- expectedRoot: Field
- index: bigint
- valueHashOrValueField: Field
- Optional hasher: Hasher = Poseidon.hash
Returns {
ok: boolean;
updates: [Field, Field[]][];
}
- ok: boolean
- updates: [Field, Field[]][]
- Defined in src/lib/merkle/proofs.ts:419

Class MerkleTreeUtils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns MerkleTreeUtils

Methods

Static checkMembership

Static

Returns

Memberof

Type Parameters

V

Parameters

proof: BaseMerkleProof

expectedRoot: Field

index: bigint

value: V

valueType: Provable<V>

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

hashValue: boolean

hasher: Hasher

Returns boolean

Static checkNonMembership

Static

Returns

Memberof

Type Parameters

V

Parameters

proof: BaseMerkleProof

expectedRoot: Field

index: bigint

Optional hasher: Hasher = Poseidon.hash

Returns boolean

Static compactMerkleProof

Static

Returns

Memberof

Parameters

proof: BaseMerkleProof

Optional hasher: Hasher = Poseidon.hash

Returns CompactMerkleProof

Static compactMerkleProofToJson

Static

Returns

Memberof

Parameters

proof: CompactMerkleProof

Returns CompactMerkleProofJSON

Static computeRoot

Static

Returns

Memberof

Type Parameters

V

Parameters

proof: BaseMerkleProof

index: bigint

Optional value: V

Optional valueType: Provable<V>

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

hashValue: boolean

hasher: Hasher

Returns Field

Static computeRootByField

Static

Returns

Memberof

Parameters

proof: BaseMerkleProof

index: bigint

valueHashOrValueField: Field

Optional hasher: Hasher = Poseidon.hash

Returns Field

Static computeRootByFieldWithUpdates

Static

Returns

`Static` checkMembership

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

`Static` checkNonMembership

`Optional` hasher: Hasher = Poseidon.hash

`Static` compactMerkleProof

`Optional` hasher: Hasher = Poseidon.hash

`Static` compactMerkleProofToJson

`Static` computeRoot

`Optional` value: V

`Optional` valueType: Provable<V>

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

`Static` computeRootByField

`Optional` hasher: Hasher = Poseidon.hash

`Static` computeRootByFieldWithUpdates

`Optional` hasher: Hasher = Poseidon.hash

Returns {
actualRoot: Field;
updates: [Field, Field[]][];
}

`Static` decompactMerkleProof

`Optional` hasher: Hasher = Poseidon.hash

`Static` jsonToCompactMerkleProof

`Static` verifyProof

`Optional` value: V

`Optional` valueType: Provable<V>

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

`Static` verifyProofByField

`Optional` hasher: Hasher = Poseidon.hash

`Static` verifyProofByFieldWithUpdates

`Optional` hasher: Hasher = Poseidon.hash

Returns {
ok: boolean;
updates: [Field, Field[]][];
}