package octez-shell-libs

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

Block_validator_process is used to validate new blocks. This validation can be

  • internal: the same processus is used to run the node and to validate blocks
  • external: another processus is used to validate blocks This module also ensures the liveness of the operations (see Block_validation:check_liveness).
type validator_environment = {
  1. user_activated_upgrades : Tezos_base.User_activated.upgrades;
    (*

    user activated upgrades

    *)
  2. user_activated_protocol_overrides : Tezos_base.User_activated.protocol_overrides;
    (*

    user activated protocol overrides

    *)
  3. operation_metadata_size_limit : Tezos_shell_services.Shell_limits.operation_metadata_size_limit;
    (*

    size limit for operation metadata that should be written on disk

    *)
}
type validator_kind =
  1. | Internal : Tezos_store.Store.Chain.chain_store -> validator_kind
  2. | External : {
    1. genesis : Tezos_base.Genesis.t;
    2. readonly : bool;
    3. data_dir : string;
    4. context_root : string;
    5. protocol_root : string;
    6. process_path : string;
    7. sandbox_parameters : Tezos_base.TzPervasives.Data_encoding.json option;
    8. dal_config : Tezos_crypto_dal.Cryptobox.Config.t;
    9. internal_events : Tezos_base.Internal_event_config.t;
    } -> validator_kind

For performances reasons, it may be interesting to use another processus (from the OS) to validate blocks (External). However, in that case, only one processus has a write access to the context. Currently informations are exchanged via the file system.

type simple_kind =
  1. | External_process
  2. | Single_process
type t

Internal representation of the block validator process

val kind : t -> simple_kind
val close : t -> unit Lwt.t

close vp closes the given vp. In the case of an External validator process, we first ask the validator to shutdown. If it is still running after 5 seconds, we notice that the block validation process is unresponsive and we force its termination (using a registered Lwt_exit.clean_up_callback).

apply_block bvp predecessor header ops checks the liveness of the operations and then call Block_validation.apply

should_precheck when set, triggers the block prechecking before applying it, see Block_validation.apply.

If simulate is true, the context resulting from the application will not be committed to disk. Set to false by default.

preapply_block bvp chain_store ~predecessor ~protocol_data ~timestamp ops is a wrapper for Block_validation.preapply.

precheck_block bvp chain_store ~predecessor header hash ops is a wrapper for Block_validation.precheck.

val context_garbage_collection : t -> Tezos_context_ops.Context_ops.index -> Tezos_base.TzPervasives.Context_hash.t -> gc_lockfile_path:string -> unit Tezos_base.TzPervasives.tzresult Lwt.t

context_garbage_collection bvp context_index context_hash removes contexts that are below context_hash in the context tree.

context_split bvp context_index splits the context storage layout into a new chunk.

init_test_chain must only be called on a forking 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