Documentation
¶
Index ¶
- func GetContentMap(indexs []int64) *map[int64]struct{}
- func MidOrder(tree *Node, subtreeLeafs *[]Content)
- func PostOrder(tree *Node, subtreeLeafs *[]Content)
- func RebuildNodeList(nodes *[]NodeSerializable) [][]*Node
- func SortNodeIndex(nodes *[]*Node)
- func Swap(arr *[]*Node, i, j int)
- type Content
- type MerkleTree
- func (m *MerkleTree) GetMerkleAuxiliaryNode(content *map[int64]struct{}) ([][]byte, map[int64][]int64, []*Node, error)
- func (m *MerkleTree) GetMerklePath(content Content) ([][]byte, []int64, error)
- func (m *MerkleTree) GetNodeFromCoordinate(Height, Index int64) (*Node, error)
- func (m *MerkleTree) MerkleRoot() []byte
- func (t *MerkleTree) RebuildNodeListWithTree(auxiliary map[int64][]int64, leaf []int64) ([][]*Node, error)
- func (m *MerkleTree) RebuildTree() error
- func (m *MerkleTree) RebuildTreeWith(cs []Content) error
- func (m *MerkleTree) String() string
- func (m *MerkleTree) VerifyContent(content Content) (bool, error)
- func (m *MerkleTree) VerifyTree() (bool, error)
- type Node
- type NodeSerializable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetContentMap ¶
func RebuildNodeList ¶ added in v0.0.2
func RebuildNodeList(nodes *[]NodeSerializable) [][]*Node
Types ¶
type Content ¶
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 MerkleTree ¶
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 GenerateSubtreeMHT ¶
func GenerateSubtreeMHT(subTreeRoot Node) (*MerkleTree, error)
GenerateSubtreeMHT Construct an MHT with a branch node as the root node
func NewTree ¶
func NewTree(cs []Content) (*MerkleTree, error)
NewTree creates a new Merkle Tree using the content cs.
func NewTreeWithHashStrategy ¶
func NewTreeWithHashStrategy(cs []Content, hashStrategy func() hash.Hash) (*MerkleTree, error)
NewTreeWithHashStrategy creates a new Merkle Tree using the content cs using the provided hash strategy. Note that the hash type used in the type that implements the Content interface must match the hash type profided to the tree.
func NewTreeWithIndexAndHeight ¶
func NewTreeWithIndexAndHeight(cs []Content, index, height int64) (*MerkleTree, error)
NewTreeWithIndexAndHeight Used when constructing subtrees, create a tree through consecutive nodes of any height, but retain the index of its leaf nodes
func (*MerkleTree) GetMerkleAuxiliaryNode ¶
func (m *MerkleTree) GetMerkleAuxiliaryNode(content *map[int64]struct{}) ([][]byte, map[int64][]int64, []*Node, error)
GetMerkleAuxiliaryNode: Get Merkle path ,merkle path map and list of auxiliary node
func (*MerkleTree) GetMerklePath ¶
func (m *MerkleTree) GetMerklePath(content Content) ([][]byte, []int64, error)
GetMerklePath: Get Merkle path and indexes(left leaf or right leaf)
func (*MerkleTree) GetNodeFromCoordinate ¶
func (m *MerkleTree) GetNodeFromCoordinate(Height, Index int64) (*Node, error)
func (*MerkleTree) MerkleRoot ¶
func (m *MerkleTree) MerkleRoot() []byte
MerkleRoot returns the unverified Merkle Root (hash of the root node) of the tree.
func (*MerkleTree) RebuildNodeListWithTree ¶ added in v0.0.2
func (t *MerkleTree) RebuildNodeListWithTree(auxiliary map[int64][]int64, leaf []int64) ([][]*Node, error)
RebuildNodeListWithTree use map to describe the hierarchical relationship of each node participating in the construction of the tree auxiliary: the list of auxiliary nodes, and the list of original nodes can be traced back to the Root node original: a list of original nodes, and a list of auxiliary nodes can be traced back to the Root node
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(content Content) (bool, error)
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, error)
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 { Tree *MerkleTree Parent *Node Left *Node Right *Node Hash []byte C Content Height int64 //The height of the node, the height of the leaf node is 0 Index int64 //The serial number of the node in this layer, the serial number of the leftmost node is 0 // 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.