mt

Documentation

Index

• Variables
• func EvalMerklePath(merklePath []*PathItem, leaf Data, hashAlgorithm crypto.Hash) ([]byte, error)
• func PlainTreeOutput(merklePath []*PathItem, input []byte, hashAlgorithm crypto.Hash) ([]byte, error)
• type Data
• type MerkleTree
  • func New[T Data](hashAlgorithm crypto.Hash, data []T) (*MerkleTree, error)
  • func (s *MerkleTree) GetMerklePath(leafIdx int) ([]*PathItem, error)
  • func (s *MerkleTree) GetRootHash() []byte
  • func (s *MerkleTree) PrettyPrint() string
• type PathItem

Variables

var ErrIndexOutOfBounds = errors.New("merkle tree data index out of bounds")

Functions

func EvalMerklePath

func EvalMerklePath(merklePath []*PathItem, leaf Data, hashAlgorithm crypto.Hash) ([]byte, error)

EvalMerklePath returns root hash calculated from the given leaf and path items

func PlainTreeOutput

func PlainTreeOutput(merklePath []*PathItem, input []byte, hashAlgorithm crypto.Hash) ([]byte, error)

PlainTreeOutput calculates the output hash of the chain.

Types

type Data

type Data interface {
	Hash(hashAlgorithm crypto.Hash) ([]byte, error)
}

type MerkleTree

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

func New

func New[T Data](hashAlgorithm crypto.Hash, data []T) (*MerkleTree, error)

New creates a new canonical Merkle Tree.

func (*MerkleTree) GetMerklePath

func (s *MerkleTree) GetMerklePath(leafIdx int) ([]*PathItem, error)

GetMerklePath extracts the merkle path from the given leaf to root.

func (*MerkleTree) GetRootHash

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

GetRootHash returns the root Hash of the Merkle Tree.

func (*MerkleTree) PrettyPrint

func (s *MerkleTree) PrettyPrint() string

PrettyPrint returns human readable string representation of the Merkle Tree.

type PathItem

type PathItem struct {
	Hash          hex.Bytes `json:"hash"`
	DirectionLeft bool      `json:"directionLeft"` // true - left from parent, false - right from parent
}

PathItem helper struct for proof extraction, contains Hash and Direction from parent node