@ethereumjs/mpt/dist/cjs/proof/range.d.ts

Implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper.

import type { HashKeysFunction } from '../types.ts';
/**
 * Checks whether the given leaf nodes and edge proof can prove the given trie leaves range is matched with the specific root.
 *
 * A range proof is a proof that includes the encoded trie nodes from the root node to leaf node for one or more branches of a trie,
 * allowing an entire range of leaf nodes to be validated. This is useful in applications such as snap sync where contiguous ranges
 * of state trie data is received and validated for constructing world state, locally.
 *
 * There are four situations:
 *
 * - All elements proof. In this case the proof can be null, but the range should
 *   be all the leaves in the trie.
 *
 * - One element proof. In this case no matter the edge proof is a non-existent
 *   proof or not, we can always verify the correctness of the proof.
 *
 * - Zero element proof. In this case a single non-existent proof is enough to prove.
 *   Besides, if there are still some other leaves available on the right side, then
 *   an error will be returned.
 *
 * - Two edge elements proof. In this case two existent or non-existent proof(first and last) should be provided.
 *
 * NOTE: Currently only supports verification when the length of firstKey and lastKey are the same.
 *
 * @param rootHash - root hash of state trie this proof is being verified against.
 * @param firstKey - first key of range being proven.
 * @param lastKey - last key of range being proven.
 * @param keys - key list of leaf data being proven.
 * @param values - value list of leaf data being proven, one-to-one correspondence with keys.
 * @param proof - proof node list, if all-elements-proof where no proof is needed, proof should be null, and both `firstKey` and `lastKey` must be null as well
 * @param opts - optional, the opts may include a custom hashing function to use with the trie for proof verification
 * @returns a flag to indicate whether there exists more trie node in the trie
 */
export declare function verifyMerkleRangeProof(rootHash: Uint8Array, firstKeyRaw: Uint8Array | null, lastKeyRaw: Uint8Array | null, keysRaw: Uint8Array[], values: Uint8Array[], proof: Uint8Array[] | null, useKeyHashingFunction?: HashKeysFunction): Promise<boolean>;
//# sourceMappingURL=range.d.ts.map