(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2021 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(** Calculate the average transaction cost. *)
val average_transaction_cost :
  Client.stresstest_gas_estimation -> Average_block.t -> int

(** Deduce the maximal theoretical TPS based on hard gas limit per block and
   the gas cost of the average operation. *)
val deduce_tps :
  protocol:Protocol.t ->
  protocol_constants:Protocol.constants ->
  average_transaction_cost:int ->
  unit ->
  int

(** Calculate fee and gas limit given gas cost estimation. *)
val deduce_fee_and_gas_limit : int -> Tez.t * int

(** Calculate probabilities of smart contracts in a form suitable for
    passing to the client stresstest command. *)
val calculate_smart_contract_parameters :
  Average_block.t ->
  Client.stresstest_gas_estimation ->
  (string * Client.stresstest_contract_parameters) list