merkle

Documentation

Overview

Package merkle provides Merkle tree manipulation functions.

Index

• func Rehash(h [][]byte, nf []NodeFetch, hc func(left, right []byte) []byte) ([][]byte, error)
• type NodeFetch
  • func CalcConsistencyProofNodeAddresses(size1, size2 int64) ([]NodeFetch, error)
  • func CalcInclusionProofNodeAddresses(size, index int64) ([]NodeFetch, error)

Functions

func Rehash

func Rehash(h [][]byte, nf []NodeFetch, hc func(left, right []byte) []byte) ([][]byte, error)

Rehash computes the proof based on the slice of NodeFetch structs, and the corresponding hashes of these nodes. The slices must be of the same length. The hc parameter computes node's hash based on hashes of its children.

Warning: The passed-in slice of hashes can be modified in-place.

Types

type NodeFetch

type NodeFetch struct {
	ID     compact.NodeID
	Rehash bool
}

NodeFetch bundles a node ID with additional information on how to use the node to construct a proof.

func CalcConsistencyProofNodeAddresses

func CalcConsistencyProofNodeAddresses(size1, size2 int64) ([]NodeFetch, error)

CalcConsistencyProofNodeAddresses returns the tree node IDs needed to build a consistency proof between two specified tree sizes. All the returned nodes represent complete subtrees in the tree of size2 or above.

Use Rehash function to compose the proof after the node hashes are fetched.

func CalcInclusionProofNodeAddresses

func CalcInclusionProofNodeAddresses(size, index int64) ([]NodeFetch, error)

CalcInclusionProofNodeAddresses returns the tree node IDs needed to build an inclusion proof for a specified tree size and leaf index. All the returned nodes represent complete subtrees in the tree of this size or above.

Use Rehash function to compose the proof after the node hashes are fetched.