merkletree

Documentation

Index

• type Content
• type HashContent
  • func (t HashContent) CalculateHash() []byte
  • func (t HashContent) Equals(other Content) bool
• type MerkleTree
  • func NewTree(cs []Content) (*MerkleTree, error)
  • func (m *MerkleTree) MerkleRoot() []byte
  • func (m *MerkleTree) RebuildTree() error
  • func (m *MerkleTree) RebuildTreeWith(cs []Content) error
  • func (m *MerkleTree) String() string
  • func (m *MerkleTree) VerifyContent(expectedMerkleRoot []byte, content Content) bool
  • func (m *MerkleTree) VerifyTree() bool
• type Node

Types

type Content

type Content interface {
	CalculateHash() []byte
	Equals(other Content) bool
}

Content represents the data that is stored and verified by the tree. A type that implements this interface can be used as an item in the tree.

type HashContent

type HashContent struct {
	H hexutil.Bytes
}

HashContent Content For metaID

func (HashContent) CalculateHash

func (t HashContent) CalculateHash() []byte

CalculateHash function to calculate hash

func (HashContent) Equals

func (t HashContent) Equals(other Content) bool

Equals function to compare other Content

type MerkleTree

type MerkleTree struct {
	Root *Node

	Leafs []*Node
	// contains filtered or unexported fields
}

MerkleTree is the container for the tree. It holds a pointer to the root of the tree, a list of pointers to the leaf nodes, and the merkle root.

func NewTree

func NewTree(cs []Content) (*MerkleTree, error)

NewTree creates a new Merkle Tree using the content cs.

func (*MerkleTree) MerkleRoot

func (m *MerkleTree) MerkleRoot() []byte

MerkleRoot returns the unverified Merkle Root (hash of the root node) of the tree.

func (*MerkleTree) RebuildTree

func (m *MerkleTree) RebuildTree() error

RebuildTree is a helper function that will rebuild the tree reusing only the content that it holds in the leaves.

func (*MerkleTree) RebuildTreeWith

func (m *MerkleTree) RebuildTreeWith(cs []Content) error

RebuildTreeWith replaces the content of the tree and does a complete rebuild; while the root of the tree will be replaced the MerkleTree completely survives this operation. Returns an error if the list of content cs contains no entries.

func (*MerkleTree) String

func (m *MerkleTree) String() string

String returns a string representation of the tree. Only leaf nodes are included in the output.

func (*MerkleTree) VerifyContent

func (m *MerkleTree) VerifyContent(expectedMerkleRoot []byte, content Content) bool

VerifyContent indicates whether a given content is in the tree and the hashes are valid for that content. Returns true if the expected Merkle Root is equivalent to the Merkle root calculated on the critical path for a given content. Returns true if valid and false otherwise.

func (*MerkleTree) VerifyTree

func (m *MerkleTree) VerifyTree() bool

VerifyTree verify tree validates the hashes at each level of the tree and returns true if the resulting hash at the root of the tree matches the resulting root hash; returns false otherwise.

type Node

type Node struct {
	Parent *Node
	Left   *Node
	Right  *Node

	Hash []byte
	C    Content
	// contains filtered or unexported fields
}

Node represents a node, root, or leaf in the tree. It stores pointers to its immediate relationships, a hash, the content stored if it is a leaf, and other metadata.