package tezos-shell

You can search for identifiers within the package.

in-package search v0.2.0

package tezos-shell

tezos-shell
- Tezos_shell

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 = {

user_activated_upgrades : Tezos_base.User_activated.upgrades;
(*
user activated upgrades
*)
user_activated_protocol_overrides : Tezos_base.User_activated.protocol_overrides;
(*
user activated protocol overrides
*)
operation_metadata_size_limit : int option;
(*
size limit for operation metadata that should be written on disk
*)

}

type validator_kind =

| Internal : Tezos_store.Store.Chain.chain_store -> validator_kind
| External : {
1. genesis : Tezos_base.Genesis.t;
2. data_dir : string;
3. context_root : string;
4. protocol_root : string;
5. process_path : string;
6. sandbox_parameters : Data_encoding.json option;
} -> 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 t

Internal representation of the block validator process

val init : 
  validator_environment ->
  validator_kind ->
  (t, Tezos_error_monad.TzCore.error list) result Lwt.t

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

val reconfigure_event_logging : 
  t ->
  Tezos_stdlib_unix.Internal_event_unix.Configuration.t ->
  (unit, Tezos_error_monad.TzCore.error list) result Lwt.t

val apply_block : 
  t ->
  Tezos_store.Store.chain_store ->
  predecessor:Tezos_store.Store.Block.t ->
  Tezos_base.Block_header.t ->
  Tezos_base.Operation.t list list ->
  (Tezos_validation.Block_validation.result,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

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

val preapply_block : 
  t ->
  Tezos_store.Store.chain_store ->
  predecessor:Tezos_store.Store.Block.t ->
  protocol_data:bytes ->
  timestamp:Tezos_base.Time.Protocol.t ->
  Tezos_base.Operation.t list list ->
  (Tezos_base.Block_header.shell_header
   * Tezos_error_monad.TzCore.error Tezos_shell_services.Preapply_result.t list,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val precheck_block : 
  t ->
  Tezos_store.Store.chain_store ->
  predecessor:Tezos_store.Store.Block.t ->
  Tezos_base.Block_header.t ->
  Tezos_crypto.Block_hash.t ->
  Tezos_base.Operation.t list list ->
  (unit, Tezos_error_monad.TzCore.error list) result Lwt.t

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

val commit_genesis : 
  t ->
  chain_id:Tezos_crypto.Chain_id.t ->
  (Tezos_crypto.Context_hash.t, Tezos_error_monad.TzCore.error list) result
    Lwt.t

val init_test_chain : 
  t ->
  Tezos_store.Store.Block.t ->
  (Tezos_base.Block_header.t, Tezos_error_monad.TzCore.error list) result Lwt.t

init_test_chain must only be called on a forking block.