(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) Nomadic Labs, <contact@nomadic-labs.com>                    *)
(* Copyright (c) Functori, <contact@functori.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 Injector_sigs

exception Protocol_not_found

module Make (Parameters : PARAMETERS) : sig
  type proto_client =
    (module PROTOCOL_CLIENT
       with type operation = Parameters.Operation.t
        and type state = Parameters.state)

  (** Register a protocol client for a specific protocol to be used by the
      injector. *)
  val register : Protocol_hash.t -> proto_client -> unit

  (** Return the protocol client for a given protocol.

      @raise Protocol_not_found if the protocol is not known by the injector. In
        this case the injector will not be able to inject operations in blocks
        of this protocol.  *)
  val proto_client_for_protocol : Protocol_hash.t -> proto_client

  (** Returns the list of protocol clients registered. *)
  val registered_proto_clients : unit -> (Protocol_hash.t * proto_client) list

  (** Runs the [checks] functions on all registered protocol clients for the
      injector. *)
  val check_registered_proto_clients :
    Parameters.state -> (unit, tztrace) result
end