ligo/src/lib_shell_services/monitor_services.mli

(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

open RPC_context

val bootstrapped:
  #streamed -> ((Block_hash.t * Time.t) Lwt_stream.t * stopper) tzresult Lwt.t

val valid_blocks:
  #streamed ->
  ?chains:Chain_services.chain list ->
  ?protocols:Protocol_hash.t list ->
  ?next_protocols:Protocol_hash.t list ->
  unit -> (((Chain_id.t * Block_hash.t) * Block_header.t) Lwt_stream.t * stopper) tzresult Lwt.t

val heads:
  #streamed ->
  ?next_protocols:Protocol_hash.t list ->
  Chain_services.chain ->
  ((Block_hash.t * Block_header.t) Lwt_stream.t * stopper) tzresult Lwt.t

val protocols:
  #streamed ->
  (Protocol_hash.t Lwt_stream.t * stopper) tzresult Lwt.t

val commit_hash: #simple -> string tzresult Lwt.t

module S : sig

  val bootstrapped:
    ([ `GET ], unit,
     unit, unit, unit,
     Block_hash.t * Time.t) RPC_service.t

  val valid_blocks:
    ([ `GET ], unit,
     unit, < chains : Chain_services.chain list;
             next_protocols : Protocol_hash.t list;
             protocols : Protocol_hash.t list >, unit,
     (Chain_id.t * Block_hash.t) * Block_header.t) RPC_service.t

  val heads:
    ([ `GET ], unit,
     unit * Chain_services.chain,
     < next_protocols : Protocol_hash.t list >, unit,
     Block_hash.t * Block_header.t) RPC_service.t

  val protocols:
    ([ `GET ], unit,
     unit, unit, unit,
     Protocol_hash.t) RPC_service.t

  val commit_hash:
    ([ `GET ], unit, unit, unit, unit, string) RPC_service.t
end