Documentation
¶
Index ¶
- type Node
- func (n *Node) AllPayloads() []ledger.Payload
- func (n *Node) FmtStr(prefix string, subpath string) string
- func (n *Node) Hash() hash.Hash
- 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 two node types:
- INTERIM node: has at least one child (i.e. lChild or rChild is not nil). Interim nodes do not store a path and have no payload.
- LEAF node: has _no_ children.
Per convention, we also consider nil as a leaf. Formally, nil is the generic representative for any empty (sub)-trie (i.e. a trie without allocated registers).
Nodes are supposed to be treated as _immutable_ data structures. TODO: optimized data structures might be able to reduce memory consumption
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 UNCHECKED requirement: if lchild != nil then height = lchild.height + 1, and same for rchild
func NewLeaf ¶
NewLeaf creates a compact leaf Node. UNCHECKED requirement: height must be non-negative UNCHECKED requirement: payload is non nil
func NewNode ¶
func NewNode(height int, lchild, rchild *Node, path ledger.Path, payload *ledger.Payload, hashValue hash.Hash, 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 INTERIM 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) Path ¶
Path returns a pointer to the Node's register storage path. If the node is not a leaf, the function returns `nil`.
func (*Node) RightChild ¶ added in v0.12.0
RightChild returns the the Node's right child. Only INTERIM nodes have children. Do NOT MODIFY returned Node!
func (*Node) VerifyCachedHash ¶ added in v0.12.0
VerifyCachedHash verifies the hash of a node is valid
Source Files