ligo/vendors/tezos-modded/src/lib_shell/validator.mli
2019-05-27 11:18:48 +02:00

69 lines
3.0 KiB
OCaml

(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* Copyright (c) 2018 Nomadic Labs, <contact@nomadic-labs.com> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
(** Tezos Shell - Main entry point of the validation scheduler. *)
type t
val create:
State.t ->
Distributed_db.t ->
Peer_validator.limits ->
Block_validator.limits ->
Block_validator.validator_kind ->
Prevalidator.limits ->
Chain_validator.limits ->
t tzresult Lwt.t
val shutdown: t -> unit Lwt.t
(** Start the validation scheduler of a given chain. *)
val activate:
t ->
?max_child_ttl:int ->
start_prevalidator:bool ->
State.Chain.t -> Chain_validator.t tzresult Lwt.t
val get: t -> Chain_id.t -> Chain_validator.t tzresult
val get_exn: t -> Chain_id.t -> Chain_validator.t
(** Force the validation of a block. *)
val validate_block:
t ->
?force:bool ->
?chain_id:Chain_id.t ->
MBytes.t -> Operation.t list list ->
(Block_hash.t * State.Block.t option tzresult Lwt.t) tzresult Lwt.t
(** Monitor all the valid block (for all activate chains). *)
val watcher: t -> State.Block.t Lwt_stream.t * Lwt_watcher.stopper
val inject_operation:
t ->
?chain_id:Chain_id.t ->
Operation.t -> unit tzresult Lwt.t
val distributed_db: t -> Distributed_db.t