octez-shell-libs 20.1 · OCaml Package

type parameters = {

context_root : string;
protocol_root : string;
genesis : Tezos_base.TzPervasives.Genesis.t;
readonly : bool;
data_dir : string;
sandbox_parameters : Tezos_base.TzPervasives.Data_encoding.json option;
user_activated_upgrades : Tezos_base.TzPervasives.User_activated.upgrades;
user_activated_protocol_overrides : Tezos_base.TzPervasives.User_activated.protocol_overrides;
operation_metadata_size_limit : Tezos_shell_services.Shell_limits.operation_metadata_size_limit;
dal_config : Tezos_crypto_dal.Cryptobox.Config.t;
internal_events : Tezos_base.Internal_event_config.t;

}

type never = |

type _ request =

| Apply : {
1. chain_id : Tezos_base.TzPervasives.Chain_id.t;
2. block_header : Tezos_base.TzPervasives.Block_header.t;
3. predecessor_block_header : Tezos_base.TzPervasives.Block_header.t;
4. predecessor_block_metadata_hash : Tezos_base.TzPervasives.Block_metadata_hash.t option;
5. predecessor_ops_metadata_hash : Tezos_base.TzPervasives.Operation_metadata_list_list_hash.t option;
6. predecessor_resulting_context_hash : Tezos_base.TzPervasives.Context_hash.t;
7. operations : Block_validation.operation list list;
8. max_operations_ttl : int;
9. should_precheck : bool;
10. simulate : bool;
} -> Block_validation.result request
| Preapply : {
1. chain_id : Tezos_base.TzPervasives.Chain_id.t;
2. timestamp : Tezos_base.TzPervasives.Time.Protocol.t;
3. protocol_data : bytes;
4. live_blocks : Tezos_base.TzPervasives.Block_hash.Set.t;
5. live_operations : Tezos_base.TzPervasives.Operation_hash.Set.t;
6. predecessor_shell_header : Tezos_base.TzPervasives.Block_header.shell_header;
7. predecessor_hash : Tezos_base.TzPervasives.Block_hash.t;
8. predecessor_max_operations_ttl : int;
9. predecessor_block_metadata_hash : Tezos_base.TzPervasives.Block_metadata_hash.t option;
10. predecessor_ops_metadata_hash : Tezos_base.TzPervasives.Operation_metadata_list_list_hash.t option;
11. predecessor_resulting_context_hash : Tezos_base.TzPervasives.Context_hash.t;
12. operations : Block_validation.operation list list;
} -> (Tezos_base.TzPervasives.Block_header.shell_header * Tezos_base.TzPervasives.error Tezos_shell_services.Preapply_result.t list) request
| Precheck : {
1. chain_id : Tezos_base.TzPervasives.Chain_id.t;
2. predecessor_block_header : Tezos_base.TzPervasives.Block_header.t;
3. predecessor_block_hash : Tezos_base.TzPervasives.Block_hash.t;
4. predecessor_resulting_context_hash : Tezos_base.TzPervasives.Context_hash.t;
5. header : Tezos_base.TzPervasives.Block_header.t;
6. operations : Block_validation.operation list list;
7. hash : Tezos_base.TzPervasives.Block_hash.t;
} -> unit request
| Commit_genesis : {
1. chain_id : Tezos_base.TzPervasives.Chain_id.t;
} -> Tezos_base.TzPervasives.Context_hash.t request
| Fork_test_chain : {
1. chain_id : Tezos_base.TzPervasives.Chain_id.t;
2. context_hash : Tezos_base.TzPervasives.Context_hash.t;
3. forked_header : Tezos_base.TzPervasives.Block_header.t;
} -> Tezos_base.TzPervasives.Block_header.t request
| Context_garbage_collection : {
1. context_hash : Tezos_base.TzPervasives.Context_hash.t;
2. gc_lockfile_path : string;
} -> unit request
| Context_split : unit request
| Terminate : never request
| Reconfigure_event_logging : Tezos_base_unix.Internal_event_unix.Configuration.t -> unit request

val request_pp : Format.formatter -> 'a request -> unit

val magic : Tezos_base.TzPervasives.Bytes.t

val parameters_encoding : parameters Tezos_base.TzPervasives.Data_encoding.t

type packed_request =

| Erequest : _ request -> packed_request

val request_encoding : packed_request Tezos_base.TzPervasives.Data_encoding.t

val result_encoding : 'a request -> 'a Tezos_base.TzPervasives.Data_encoding.t

val send : 
  Lwt_io.output_channel ->
  'a Tezos_base.TzPervasives.Data_encoding.t ->
  'a ->
  unit Lwt.t

val recv : 
  Lwt_io.input_channel ->
  'a Tezos_base.TzPervasives.Data_encoding.t ->
  'a Lwt.t

val recv_result : 
  Lwt_io.input_channel ->
  'a Tezos_base.TzPervasives.Data_encoding.t ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

val socket_path_prefix : string

The prefix for the validation socket filename.

Do not use it directly except for documentation purposes; use socket_path instead.

val socket_path : socket_dir:string -> pid:int -> string

Get the validation socket path.

socket_dir is the directory where the file should be put. pid is the process ID of the validator process.

val create_socket_listen : 
  canceler:Lwt_canceler.t ->
  max_requests:int ->
  socket_path:string ->
  Lwt_unix.file_descr Tezos_base.TzPervasives.tzresult Lwt.t

val create_socket_connect : 
  canceler:Lwt_canceler.t ->
  socket_path:string ->
  Lwt_unix.file_descr Tezos_base.TzPervasives.tzresult Lwt.t

package octez-shell-libs