imt

Documentation

Index

• Variables
• func IndexTreeOutput(merklePath []*PathItem, key []byte, hashAlgorithm crypto.Hash) ([]byte, error)
• type LeafData
• type PathItem
• type Tree
  • func New(hashAlgorithm crypto.Hash, leaves []LeafData) (*Tree, error)
  • func (s *Tree) GetMerklePath(key []byte) ([]*PathItem, error)
  • func (s *Tree) GetRootHash() []byte
  • func (s *Tree) PrettyPrint() string

Variables

var ErrTreeEmpty = errors.New("tree is empty")

Functions

func IndexTreeOutput

func IndexTreeOutput(merklePath []*PathItem, key []byte, hashAlgorithm crypto.Hash) ([]byte, error)

IndexTreeOutput calculates the output hash of the index Merkle tree hash chain from hash chain, key and data hash.

Types

type LeafData

type LeafData interface {
	Key() []byte
	AddToHasher(hasher abhash.Hasher)
}

LeafData indexed tree leaf. NB!: indexed tree leaves must be sorted lexicographically by key in strict order k1 < k2 < ... kn

type PathItem

type PathItem struct {
	Key  hex.Bytes `json:"key"`
	Hash hex.Bytes `json:"hash"`
}

PathItem helper struct for proof extraction, contains Hash and Key of node

type Tree

type Tree struct {
	// contains filtered or unexported fields
}

func New

func New(hashAlgorithm crypto.Hash, leaves []LeafData) (*Tree, error)

New creates a new indexed Merkle tree.

func (*Tree) GetMerklePath

func (s *Tree) GetMerklePath(key []byte) ([]*PathItem, error)

GetMerklePath extracts the indexed merkle hash chain from the given leaf key to root. A hash chain is always returned. If the key is not present, a chain is returned from where the key is supposed to be.

func (*Tree) GetRootHash

func (s *Tree) GetRootHash() []byte

GetRootHash returns the root Hash of the indexed Merkle tree.

func (*Tree) PrettyPrint

func (s *Tree) PrettyPrint() string

PrettyPrint returns a human-readable string representation of the indexed Merkle tree.