Module `Tezos_layer2_store.Indexed_store`Source

This library provides functors to build various kinds of stores using mirage's index and Octez data-encoding libraries.

It is tailored to build stores for the Layer 2 nodes of Tezos (Tx-rollups and Smart rollups).

The stores built with this library support concurrent accesses thanks to the use of the light scheduler provided by Lwt_idle_waiter for exclusive write access.

Signatures

Sourcemodule type SINGLETON_STORE = sig ... end

A store for single updatable values. Values are stored in a file on disk and are kept in memory in a cache.

Sourcemodule type INDEXABLE_STORE = sig ... end

An index store mapping keys to values. It uses an index file internally.

Sourcemodule type INDEXABLE_REMOVABLE_STORE = sig ... end

An index store mapping keys to values. Keys are associated to optional values in the index which allows them to be removed.

Sourcemodule type INDEXED_FILE = sig ... end

An indexed file (i.e. a file and an index) mapping keys to values. Contrary to INDEXABLE_STORE, the values can vary in size. Internally, values are stored, concatenated, in a append only file. The index file associates keys to offsets in this file (and a header to retrieve information more efficiently).

Sourcemodule type SIMPLE_INDEXED_FILE = sig ... end

Same as INDEXED_FILE but where headers are extracted from values.

Sourcemodule type NAME = sig ... end

Names for stores.

Sourcemodule type INDEX_KEY = sig ... end

Values that can be used as keys for indices.

Sourcemodule type ENCODABLE_VALUE = sig ... end

Values that can be encoded.

Sourcemodule type FIXED_ENCODABLE_VALUE = sig ... end

Values that can be encoded and whose encoding is a fixed size.

Sourcemodule type ENCODABLE_VALUE_HEADER = sig ... end

Values with a given fixed size header.

Functors

Source

module Make_singleton
  (S : ENCODABLE_VALUE) : 
  SINGLETON_STORE with type value := S.t

Source

module Make_indexable
  (_ : NAME)
  (K : INDEX_KEY)
  (V : Index.Value.S) : 
  INDEXABLE_STORE with type key := K.t and type value := V.t

Source

module Make_indexable_removable
  (_ : NAME)
  (K : INDEX_KEY)
  (V : Index.Value.S) : 
  INDEXABLE_REMOVABLE_STORE with type key := K.t and type value := V.t

Source

module Make_indexed_file
  (_ : NAME)
  (K : INDEX_KEY)
  (V : ENCODABLE_VALUE_HEADER) : 
  INDEXED_FILE
    with type key := K.t
     and type value := V.t
     and type header := V.Header.t

Source

module Make_simple_indexed_file
  (_ : NAME)
  (K : INDEX_KEY)
  (V : sig ... end) : 
  SIMPLE_INDEXED_FILE
    with type key := K.t
     and type value := V.t
     and type header := V.Header.t

Helper functors

Source

module Make_fixed_encodable
  (V : ENCODABLE_VALUE) : 
  FIXED_ENCODABLE_VALUE with type t = V.t

Source

module Make_index_value
  (E : FIXED_ENCODABLE_VALUE) : 
  Index.Value.S with type t = E.t

Sourcemodule Make_index_key (E : sig ... end) : INDEX_KEY with type t = E.t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-l2-libs.layer2_store/Tezos_layer2_store/Indexed_store/index.html

Module `Tezos_layer2_store.Indexed_store`Source

Signatures

Functors

Helper functors

package octez-l2-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-l2-libs.layer2_store/Tezos_layer2_store/Indexed_store/index.html

Module Tezos_layer2_store.Indexed_storeSource

Signatures

Functors

Helper functors

Module `Tezos_layer2_store.Indexed_store`Source