Mavryk_protocol_environment.Memory_contextMemory_context is a recursive map backed by an in-memory Irmin tree, i.e. Mavryk_context_memory.Context (in src/lib_context), used by the mockup mode and by proof verifiers (i.e. clients of Mavryk_context_helpers.Context.Make_tree.Proof). It abstracts away Mavryk_context_memory.Context.t.
It is one of the instances of Environment_context along Shell_context and Proxy_context. All these 3 instances can implement the same API (i.e. Environment_context), because this API is highly polymorphic, thanks to Environment_context.Context.ops.
As such, a Memory_context value is an instance of Environment_context whose Environment_context.Context.kind is the one declared below in this file, i.e. Context.
Instances of t are easier to obtain than Shell_context (which are used by nodes), because they don't require access to a disk: they live completely in memory. That is why they are ideal for testing.
type t = Mavryk_context_memory.Context.tThe type of the context backing Memory_context. Main use is the parameterization of Environment_context.Context.kind below, as well as the instantiation of the S signature below (the module type of M).
type Mavryk_protocol_environment__.Environment_context.Context.kind += | Context : t Mavryk_protocol_environment__.Environment_context.Context.kindThe additional kind identifying Memory_context values. Used to detect at runtime when a memory context is expected, to disambiguate from other kinds.
empty creates a pristine memory context: a Protocol_environment.Context.t value whose kind indicates that it is a memory context. See wrap_memory_context for an alternative constructor.
val encoding :
Mavryk_protocol_environment__.Environment_context.Context.t
Mavryk_base.TzPervasives.Data_encoding.tencoding is an appropriate encoding for Environment_context.Context.t values whose kind is Memory_context. This is used by the mockup for storing its state on disk. This is unique to Memory_context:
Shell_context is backed by an Irmin on-disk storage and so doesn't need its own serialization mechanism.Proxy_context doesn't need to be serializable.module M : sig ... endM is the Memory_context specific instance of Environment_context_intf.S
val wrap_memory_context :
t ->
Mavryk_protocol_environment__.Environment_context.Context.twrap_memory_context t creates a memory context from an Irmin in-memory tree: in this signature, t comes from Mavryk_context_memory.Context (in src/lib_context. See empty for an alternative constructor.
val unwrap_memory_context :
Mavryk_protocol_environment__.Environment_context.Context.t ->
tunwrap_memory_context ctxt returns the Mavryk_context_memory.Context.t underlying ctxt.