package octez-l2-libs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Signatures
Functors
Helper functors

octez-l2-libs.layer2_store
- Tezos_layer2_store
  - Delayed_write_monad
    
    Lwt_result_syntax
  - Indexed_store
    
    ENCODABLE_VALUE
    
    ENCODABLE_VALUE_HEADER
    
    Header
    
    FIXED_ENCODABLE_VALUE
    
    INDEXABLE_REMOVABLE_STORE
    
    INDEXABLE_STORE
    
    INDEXED_FILE
    
    Make_fixed_encodable
    
    V
    
    Make_index_key
    
    E
    
    Make_index_value
    
    E
    
    Make_indexable
    
    K
    
    V
    
    _
    
    Make_indexable_removable
    
    K
    
    V
    
    _
    
    Make_indexed_file
    
    K
    
    V
    
    Header
    
    _
    
    Make_simple_indexed_file
    
    K
    
    V
    
    Header
    
    _
    
    Make_singleton
    
    S
    
    NAME
    
    SIMPLE_INDEXED_FILE
    
    SINGLETON_STORE
  - Irmin_store
    
    Make
    
    N
    
    Raw_irmin
    
    Backend
    
    Branch
    
    Key
    
    Val
    
    Commit
    
    Hash
    
    Key
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Metadata
    
    Path
    
    Val
    
    Metadata
    
    Val
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Node
    
    Contents
    
    Hash
    
    Key
    
    Val
    
    Hash
    
    Key
    
    Val
    
    Metadata
    
    Remote
    
    Repo
    
    Slice
    
    Branch
    
    Commit
    
    Contents
    
    Hash
    
    Head
    
    Info
    
    Metadata
    
    Path
    
    Repo
    
    Schema
    
    Branch
    
    Contents
    
    Hash
    
    Info
    
    Metadata
    
    Status
    
    Tree
    
    Contents
    
    Private
    
    Env
    
    Proof
  - Store_errors
  - Store_sigs
    
    Append_only_map
    
    BACKEND
    
    COMPARABLE_KEY
    
    KEY
    
    Map
    
    Mutable_value
    
    Nested_map
    
    STORAGE_INFO
    
    Store
    
    Make_append_only_map
    
    K
    
    S
    
    V
    
    Make_mutable_value
    
    S
    
    V
    
    Make_nested_map
    
    K1
    
    K2
    
    S
    
    V
    
    Make_updatable_map
    
    K
    
    S
    
    V
    
    VALUE
  - Store_utils
    
    Make
    
    B
    
    Make_append_only_map
    
    K
    
    S
    
    V
    
    Make_mutable_value
    
    S
    
    V
    
    Make_nested_map
    
    K1
    
    K2
    
    S
    
    V
    
    Make_updatable_map
    
    K
    
    S
    
    V
octez-l2-libs.scoru-wasm
- Tezos_scoru_wasm
  - Binary_parser_encodings
    
    Block
    
    Building_state
    
    Byte_vector
    
    Code
    
    Data
    
    Decode
    
    Elem
    
    Export
    
    Field
    
    Func_type
    
    Import
    
    Instr_block
    
    Lazy_stack
    
    Lazy_vec
    
    Module
    
    Name
    
    Size
  - Builtins
  - Constants
  - Data_encoding_utils
    
    Little_endian
  - Durable
    
    Internal_for_tests
  - Host_funcs
    
    Aux
    
    Make
    
    Memory_access
    
    S
    
    Error
    
    Internal_for_tests
    
    Memory_access
    
    Memory_access_interpreter
    
    Tick_model
  - Init_encodings
  - Interpreter_encodings
    
    Ast
    
    IntOp
    
    V128Op
    
    Source
    
    Types
    
    V128
    
    Values
  - Kont_encodings
  - Pvm_input_kind
    
    Internal_for_tests
  - Wasm_encoding
    
    Internal_for_tests
  - Wasm_pvm
    
    Make
    
    Internal_for_tests
    
    T
    
    Make_pvm
    
    Internal_for_tests
    
    T
    
    Wasm_vm
    
    Internal_for_tests
  - Wasm_pvm_errors
  - Wasm_pvm_sig
    
    Internal_for_tests
    
    S
    
    Internal_for_tests
  - Wasm_pvm_state
    
    Compatibility
    
    Internal_state
  - Wasm_vm
    
    Internal_for_tests
  - Wasm_vm_sig
    
    Generic
    
    Internal_for_tests
    
    Internal_for_tests
    
    S
    
    Internal_for_tests
octez-l2-libs.scoru-wasm-fast
- Tezos_scoru_wasm_fast
  - Cache
    
    CACHE_INFO
    
    Make
    
    Input
  - Exec
  - Funcs
  - Memory_access
    
    Wasmer
  - Module_cache
  - Pvm
    
    Make
    
    Internal_for_tests
    
    T
  - Vm
    
    Internal_for_tests
octez-l2-libs.scoru-wasm-helpers
- Tezos_scoru_wasm_helpers
  - Ast_printer
    
    Ast
    
    Func
    
    Instance
    
    Types
    
    Values
  - Encodings_util
  - Wasm_utils
    
    Ctx
    
    Tree
    
    Tree_encoding_runner
    
    In_memory_context
    
    Tree
    
    Tree_encoding_runner
    
    Kernels
    
    Make
    
    Ctx
    
    Tree
    
    Tree_encoding_runner
    
    Tree_encoding_runner
    
    Wasm
    
    Internal_for_tests
    
    Wasm_fast
    
    Internal_for_tests
    
    Tree_encoding_runner
    
    Wasm
    
    Internal_for_tests
    
    Wasm_fast
    
    Internal_for_tests
  - Wasm_utils_intf
    
    S
    
    Ctx
    
    Tree
    
    Tree_encoding_runner
    
    Tree_encoding_runner
    
    Wasm
    
    Internal_for_tests
    
    Wasm_fast
    
    Internal_for_tests
octez-l2-libs.scoru_wasm_durable_snapshot
- Tezos_scoru_wasm_durable_snapshot
  - Durable
    
    Internal_for_tests
octez-l2-libs.scoru_wasm_test_helpers
- Tezos_scoru_wasm_test_helpers
octez-l2-libs.smart-rollup
- Octez_smart_rollup
  - Address
  - Commitment
    
    V1
  - Dal
    
    Commitment
    
    Page_index
    
    Slot_header
    
    V1
    
    Slot_history
    
    V1
    
    Slot_history_cache
    
    V1
    
    Slot_index
  - Error
  - Game
    
    V1
  - Inbox
    
    Skip_list
    
    Lwt
    
    MONADIC
    
    Make_monadic
    
    M
    
    V1
  - Inbox_hash
  - Kind
  - L1_operation
  - L2_message
    
    Hash
    
    Error_table
    
    Map
    
    Set
    
    Table
    
    WeakRingTable
    
    H
  - Merkelized_payload_hashes_hash
  - Rollup_constants
  - Rollup_node_services
    
    Arg
    
    Encodings
    
    Global
    
    Local
    
    Make_services
    
    P
    
    PREFIX
  - Sc_rollup_block
  - Smart_rollup_context_hash
    
    Error_table
    
    Map
    
    Set
    
    Table
    
    WeakRingTable
    
    H
  - State_hash
  - Versioned_data
    
    S
octez-l2-libs.smart_rollup_wasm_benchmark_lib
- Octez_smart_rollup_wasm_benchmark_lib
  - Data
    
    Csv
  - Exec
  - Inputs
    
    Kernels
    
    Messages
    
    Demo
  - Measure
  - Pvm_instance
    
    PP
    
    Wasm
    
    Internal_for_tests
    
    Wasm_fast_vm
    
    Internal_for_tests
  - Scenario
octez-l2-libs.wasmer
- Tezos_wasmer
  - Config
  - Engine
  - Exports
  - Instance
  - Memory
    
    Internal_for_tests
  - Module
  - Ref
  - Store
octez-l2-libs.webassembly-interpreter
- Tezos_webassembly_interpreter
  - Ast
    
    FloatOp
    
    IntOp
    
    V128Op
  - Binary_exn
    
    Decode_error
    
    Encode_error
    
    Floating_point
  - Decode
  - Durable_storage
  - Encode
  - Env
  - Error
    
    Make
  - Eval
  - Eval_num
  - Eval_vec
  - F32
  - F32_convert
  - F64
  - F64_convert
  - Free
  - Func
  - Fxx
    
    Make
    
    Rep
    
    RepType
    
    S
  - Global
  - Host_funcs
  - I16
  - I32
  - I32_convert
  - I64
  - I64_convert
  - I8
  - Import
  - Input_buffer
  - Instance
    
    ModuleMap
    
    Map
    
    Map
    
    NameMap
    
    Map
  - Ixx
    
    Make
    
    Rep
    
    RepType
    
    S
  - Lib
    
    Array32
    
    Bigarray
    
    Array1_64
    
    Fun
    
    Int
    
    List
    
    List32
    
    Option
    
    String
  - Memory
  - Memory_sig
    
    S
  - Operators
  - Output_buffer
    
    Internal_for_tests
  - Partial_memory
  - Partial_table
  - Proto_compat
  - Source
  - Spectest
  - Table
  - Table_sig
    
    S
  - Tick_model
  - Types
  - Utf8
  - V128
    
    F32x4
    
    F32x4_convert
    
    F64x2
    
    F64x2_convert
    
    FloatShape
    
    I16x8
    
    I16x8_convert
    
    I32x4
    
    I32x4_convert
    
    I64x2
    
    I64x2_convert
    
    I8x16
    
    I8x16_convert
    
    IntShape
    
    V1x128
    
    V8x16
  - Valid
  - Values
    
    F32Num
    
    F64Num
    
    I32Num
    
    I64Num
    
    NumType
    
    V128Vec
    
    VecType
octez-l2-libs.webassembly-interpreter-extra
- Tezos_webassembly_interpreter_extra
  - Lexer
  - Parse
  - Parser
  - Script

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

module 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.

module type INDEXABLE_STORE = sig ... end

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

module 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.

module 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).

module type SIMPLE_INDEXED_FILE = sig ... end

Same as INDEXED_FILE but where headers are extracted from values.

module type NAME = sig ... end

Names for stores.

module type ENCODABLE_VALUE = sig ... end

Values that can be encoded.

module type FIXED_ENCODABLE_VALUE = sig ... end

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

module type ENCODABLE_VALUE_HEADER = sig ... end

Values with a given fixed size header.

Functors

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

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

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

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

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

Helper functors

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

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

module Make_index_key (E : sig ... end) : Index.Key.S with type t = E.t