Revision b615df1cabcd074cd216b490e99ec2260a69c324 authored by Corneliu Hoffman on 25 November 2022, 19:52:51 UTC, committed by Corneliu Hoffman on 07 December 2022, 09:16:00 UTC
1 parent dfa2482
client_main_run.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. *)
(* *)
(*****************************************************************************)
module type M = (* This module type lists the parameters you can give to the
function [run] defined below; most calls use and will use the
default value for this module type, which is module
[Client_config] (client_config.ml). Another instance of this
module type is in main_signer.ml *)
sig
type t
val global_options :
(* Global options for the CLI. The presence of (unit ->) is
because of weak type variables. *)
unit ->
(t, Client_context_unix.unix_full) Tezos_clic.options
val parse_config_args :
(* How to parse CLI arguments *)
#Tezos_client_base.Client_context.full ->
string list ->
(Client_config.parsed_config_args * string list) tzresult Lwt.t
val default_chain : Chain_services.chain
val default_block : [> `Head of int]
val default_base_dir :
(* You may use the default base directory in [Client_config] or
define your own one. *)
string
val default_media_type : Media_type.Command_line.t
val other_registrations :
(* You may give an **optional** function that will work on the
configuration file and the remote parameters. *)
(Client_config.Cfg_file.t -> (module Client_config.Remote_params) -> unit)
option
val clic_commands :
base_dir:
(* This function defines how you put together different types of
commands. Default (in [Client_config]) is to simply append the lists
together. Arguments [base_dir] and [require_auth] are to be used
if you need them, default (in [Client_config]) is to ignore them. *)
string ->
config_commands:
Tezos_client_base.Client_context.full Tezos_clic.command list ->
builtin_commands:
Tezos_client_base.Client_context.full Tezos_clic.command list ->
other_commands:Tezos_client_base.Client_context.full Tezos_clic.command list ->
require_auth:bool ->
Tezos_client_base.Client_context.full Tezos_clic.command list
val logger :
(* Provide your own [logger] here if you need to override the
logger that might come from elsewhere. Default (in [Client_config]) is
[None], but [Main_signer] uses this overriding feature. *)
RPC_client_unix.logger option
end
val run :
(module M) ->
select_commands:
(RPC_client_unix.http_ctxt ->
Client_config.cli_args ->
Client_context.full Tezos_clic.command list tzresult Lwt.t) ->
unit
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...