Documentation
¶
Index ¶
- type Node
- func (n *Node) AllPayloads() []ledger.Payload
- func (n *Node) FmtStr(prefix string, subpath string) string
- func (n *Node) Hash() []byte
- func (n *Node) Height() int
- func (n *Node) IsLeaf() bool
- func (n *Node) LeftChild() *Node
- func (n *Node) MaxDepth() uint16
- func (n *Node) Path() ledger.Path
- func (n *Node) Payload() *ledger.Payload
- func (n *Node) RegCount() uint64
- func (n *Node) RightChild() *Node
- func (n *Node) VerifyCachedHash() bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Node ¶
type Node struct {
// contains filtered or unexported fields
}
Node defines an Mtrie node
DEFINITIONS:
- HEIGHT of a node v in a tree is the number of edges on the longest downward path between v and a tree leaf.
Conceptually, an MTrie is a sparse Merkle Trie, which has three different types of nodes:
- LEAF node: fully defined by a storage path, a key-value pair and a height hash is pre-computed, lChild and rChild are nil)
- INTERIOR node: at least one of lChild or rChild is not nil. Height, and Hash value are set; (key-value is nil)
- ROOT of empty trie node: this is a special case, where the node has no children, and no key-value
Currently, we represent both data structures by Node instances
Nodes are supposed to be used in READ-ONLY fashion. However, for performance reasons, we not not copy read. TODO: optimized data structures might be able to reduce memory consumption
func NewEmptyTreeRoot ¶
NewEmptyTreeRoot creates a compact leaf Node UNCHECKED requirement: height must be non-negative
func NewInterimNode ¶
NewInterimNode creates a new Node with the provided value and no children. UNCHECKED requirement: lchild.height and rchild.height must be smaller than height
func NewLeaf ¶
NewLeaf creates a compact leaf Node UNCHECKED requirement: height must be non-negative
func NewNode ¶
func NewNode(height int, lchild, rchild *Node, path ledger.Path, payload *ledger.Payload, hashValue []byte, maxDepth uint16, regCount uint64) *Node
NewNode creates a new Node. UNCHECKED requirement: combination of values must conform to a valid node type (see documentation of `Node` for details)
func (*Node) AllPayloads ¶ added in v0.12.0
AllPayloads returns the payload of this node and all payloads of the subtrie
func (*Node) Height ¶
Height returns the Node's height. Per definition, the height of a node v in a tree is the number of edges on the longest downward path between v and a tree leaf.
func (*Node) LeftChild ¶
LeftChild returns the the Node's left child. Only INTERIOR nodes have children. Do NOT MODIFY returned Node!
func (*Node) MaxDepth ¶
MaxDepth returns the longest path from this node to compacted leafs in the subtree. in contrast to the Height, this value captures compactness of the subtrie.
func (*Node) Payload ¶
Payload returns the the Node's payload. only leaf nodes have children. Do NOT MODIFY returned slices!
func (*Node) RightChild ¶ added in v0.12.0
RightChild returns the the Node's right child. Only INTERIOR nodes have children. Do NOT MODIFY returned Node!
Source Files