Package org.symbol.sdk.symbol

Class Merkle

java.lang.Object

org.symbol.sdk.symbol.Merkle

---

public final class Merkle extends Object

Merkle

Merkle tree utilities for Symbol: merkle root building, merkle hash-chain proofs, and compact Patricia tree node types with deserialization and proof checking.

• Nested Class Summary

  Nested Classes

  Modifier and Type

  Class

  Description

  static final class 

  Merkle.BranchNode

  Branch node in a compact Patricia tree.

  static final class 

  Merkle.LeafNode

  Leaf node in a compact Patricia tree.

  static final class 

  Merkle.MerkleHashBuilder

  Builder for creating a merkle hash.

  static final record 

  Merkle.MerklePart

  Represents part of a merkle tree proof.

  static final class 

  Merkle.PatriciaMerkleProofResult

  Possible results of a patricia merkle proof.

  static final record 

  Merkle.PatriciaTreePath

  Path in a Patricia merkle tree.

  static class 

  Merkle.TreeNode

  Node in a compact Patricia tree.

• Method Summary

  All MethodsStatic MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static List<Merkle.TreeNode>

  deserializePatriciaTreeNodes(byte[] buffer)

  Deserializes a buffer containing patricia tree nodes.

  static boolean

  proveMerkle(CryptoTypes.Hash256 leafHash, List<Merkle.MerklePart> merklePath, CryptoTypes.Hash256 rootHash)

  Proves a merkle hash.

  static int

  provePatriciaMerkle(CryptoTypes.Hash256 encodedKey, CryptoTypes.Hash256 valueToTest, List<Merkle.TreeNode> merklePath, CryptoTypes.Hash256 stateHash, List<CryptoTypes.Hash256> subcacheMerkleRoots)

  Proves a patricia merkle hash.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Method Details

  • proveMerkle

    public static boolean proveMerkle(CryptoTypes.Hash256 leafHash, List<Merkle.MerklePart> merklePath, CryptoTypes.Hash256 rootHash)

    Merkle.proveMerkle

    Proves a merkle hash.

    Parameters:

    leafHash - Leaf hash to prove.

    merklePath - Merkle hash chain from leaf to root.

    rootHash - Root hash of the merkle tree.

    Returns:

    true if leaf hash is connected to root hash.

  • deserializePatriciaTreeNodes

    public static List<Merkle.TreeNode> deserializePatriciaTreeNodes(byte[] buffer)

    Merkle.deserializePatriciaTreeNodes

    Deserializes a buffer containing patricia tree nodes.

    Parameters:

    buffer - Buffer containing serialized patricia tree nodes.

    Returns:

    Deserialized patricia tree nodes.

  • provePatriciaMerkle

    public static int provePatriciaMerkle(CryptoTypes.Hash256 encodedKey, CryptoTypes.Hash256 valueToTest, List<Merkle.TreeNode> merklePath, CryptoTypes.Hash256 stateHash, List<CryptoTypes.Hash256> subcacheMerkleRoots)

    Merkle.provePatriciaMerkle

    Proves a patricia merkle hash.

    Parameters:

    encodedKey - Encoded key of the state to prove.

    valueToTest - Expected hash of the state to prove.

    merklePath - Merkle node path from root to leaf.

    stateHash - State hash from a block header.

    subcacheMerkleRoots - Sub-cache merkle roots corresponding to the state hash.

    Returns:

    Proof result code.