Legend:
Library
Module
Module type
Parameter
Class
Class type
Tree representation for proof generation.
NOTE: The index needs to be accessed with write permissions because we need to commit on disk to generate the proofs (e.g. in Inbox.produce_proof, PVM.produce_proof. or PVM.produce_output_proof).
Tree provides immutable, in-memory partial mirror of the context, with lazy reads and delayed writes. The trees are Merkle trees that carry the same hash as the part of the context they mirror.
Trees are immutable and non-persistent (they disappear if the host crash), held in memory for efficiency, where reads are done lazily and writes are done only when needed, e.g. on Context.commit. If a key is modified twice, only the last value will be written to disk on commit.
add t k v is an Lwt promise that resolves to c such that:
k is bound to v in c;
and c is similar to t otherwise.
If k was already bound in t to a value that is physically equal to v, the result of the function is a promise that resolves to t. Otherwise, the previous binding of k in t disappears.
fold ?depth t root ~order ~init ~f recursively folds over the trees and values of t. The f callbacks are called with a key relative to root. f is never called with an empty key for values; i.e., folding over a value is a no-op.
The depth is 0-indexed. If depth is set (by default it is not), then f is only called when the conditions described by the parameter is true:
Eq d folds over nodes and values of depth exactly d.
Lt d folds over nodes and values of depth strictly less than d.
Le d folds over nodes and values of depth less than or equal to d.
Gt d folds over nodes and values of depth strictly more than d.
Ge d folds over nodes and values of depth more than or equal to d.
If order is `Sorted (the default), the elements are traversed in lexicographic order of their keys. For large nodes, it is memory-consuming, use `Undefined for a more memory efficient fold.