package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Global types used in the store library

type block_descriptor = Tezos_base.TzPervasives.Block_hash.t * int32

The type used to describe a block pointer i.e. its hash and level.

val block_descriptor_equal : block_descriptor -> block_descriptor -> bool

Equality function for block_descriptor.

val block_descriptor_encoding : block_descriptor Tezos_base.TzPervasives.Data_encoding.t

Encoding for block_descriptor.

type chain_config = {
  1. history_mode : Tezos_shell_services.History_mode.t;
  2. genesis : Tezos_base.TzPervasives.Genesis.t;
  3. expiration : Tezos_base.TzPervasives.Time.Protocol.t option;
}

The type for chain configuration.

val chain_config_equal : chain_config -> chain_config -> bool

Equality function for chain_config.

val chain_config_encoding : chain_config Tezos_base.TzPervasives.Data_encoding.t

Encoding for chain_config.

val pp_block_descriptor : Format.formatter -> block_descriptor -> unit

Pretty-printer for block_descriptor

type invalid_block = {
  1. level : int32;
  2. errors : Tezos_base.TzPervasives.Error_monad.error list;
}

The type used to store an invalid block's value. We only retain the level and the errors encountered during validation. These values should be indexed by the block's hash.

val invalid_block_equal : invalid_block -> invalid_block -> bool

Equality function on invalid_block. Warning: uses polymorphic comparison on errors.

val invalid_block_encoding : invalid_block Tezos_base.TzPervasives.Data_encoding.t

Encoding for invalid_block.

module Block_lru_cache : Aches_lwt.Lache.MAP_OPTION with type key = Tezos_base.TzPervasives.Block_hash.t

Module Block_lru_cache implements a lwt LRU cache map indexed by block hashes.

module Protocol_levels : sig ... end

Module Protocol_levels represents an associative map of protocol levels to corresponding blocks which supposedly activate new protocols, that is to say blocks that acknowledge a protocol change in the next block.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct