package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Client_config end
type cli_args = Client_config.cli_args = {
  1. chain : Tezos_shell_services.Chain_services.chain;
  2. block : Tezos_shell_services.Shell_services.block;
  3. confirmations : int option;
  4. sources : Tezos_proxy.Light.sources_config option;
  5. password_filename : string option;
  6. protocol : Tezos_base.TzPervasives.Protocol_hash.t option;
  7. print_timings : bool;
  8. log_requests : bool;
  9. better_errors : bool;
  10. client_mode : client_mode;
}
and client_mode = [
  1. | `Mode_client
  2. | `Mode_light
  3. | `Mode_mockup
  4. | `Mode_proxy
]
val all_modes : [> `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] list
val client_mode_to_string : [< `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] -> string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_endpoint_arg of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_media_type_arg of string
type Tezos_base.TzPervasives.error +=
  1. | Suppressed_arg of {
    1. args : string list;
    2. by : string;
    }
type Tezos_base.TzPervasives.error +=
  1. | Invalid_chain_argument of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_block_argument of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_protocol_argument of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_port_arg of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_remote_signer_argument of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_wait_arg of string
type Tezos_base.TzPervasives.error +=
  1. | Invalid_mode_arg of string
val home : string
val base_dir_env_name : string
val default_base_dir : string
val default_chain : [> `Main ]
val default_block : [> `Head of int ]
val default_endpoint : Uri.t
val default_daily_logs_path : 'a option
module Cfg_file = Client_config.Cfg_file
val default_cli_args : cli_args
val string_parameter : unit -> (string, Tezos_client_base.Client_context.full) Tezos_clic.parameter
val endpoint_parameter : unit -> (Uri.t, 'a) Tezos_clic.parameter
val sources_parameter : unit -> (Tezos_proxy.Light.sources_config, 'a) Tezos_clic.parameter
val wait_parameter : unit -> (int option, 'a) Tezos_clic.parameter
val protocol_parameter : unit -> (Tezos_base.TzPervasives.Protocol_hash.t option, 'a) Tezos_clic.parameter
val base_dir_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
val no_base_dir_warnings_switch : unit -> (bool, 'a) Tezos_clic.arg
val config_file_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
val timings_switch : unit -> (bool, 'a) Tezos_clic.arg
val wait_arg : unit -> (int option option, 'a) Tezos_clic.arg
val protocol_arg : unit -> (Tezos_base.TzPervasives.Protocol_hash.t option option, 'a) Tezos_clic.arg
val log_requests_switch : unit -> (bool, 'a) Tezos_clic.arg
val better_errors : unit -> (bool, 'a) Tezos_clic.arg
val addr_confdesc : string
val addr_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
val port_confdesc : string
val port_arg : unit -> (int option, 'a) Tezos_clic.arg
val tls_confdesc : string
val tls_switch : unit -> (bool, 'a) Tezos_clic.arg
val media_type_confdesc : string
val endpoint_confdesc : string
val endpoint_arg : unit -> (Uri.t option, 'a) Tezos_clic.arg
val sources_arg : unit -> (Tezos_proxy.Light.sources_config option, 'a) Tezos_clic.arg
val remote_signer_arg : unit -> (Uri.t option, 'a) Tezos_clic.arg
val password_filename_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
val client_mode_arg : unit -> (client_mode, 'a) Tezos_clic.arg
val read_config_file : string -> Cfg_file.t Tezos_base.TzPervasives.tzresult Lwt.t
val fail_on_non_mockup_dir : Tezos_client_base.Client_context.full -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val default_config_file_name : string
val mockup_bootstrap_accounts : string
val mockup_protocol_constants : string
val config_show_client : Tezos_client_base.Client_context.full -> string -> Cfg_file.t -> (unit, 'a) Stdlib.result Lwt.t
val config_init_client : string -> Cfg_file.t -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t
val config_init_mockup : Tezos_client_base.Client_context.full -> Tezos_base.TzPervasives.Protocol_hash.t option -> string -> string -> string -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val global_options : unit -> (string option * bool * string option * bool * Tezos_shell_services.Chain_services.chain * Tezos_shell_services.Block_services.block * int option option * Tezos_base.TzPervasives.Protocol_hash.t option option * bool * bool * string option * int option * bool * Tezos_rpc_http.Media_type.Command_line.t option * Uri.t option * Tezos_proxy.Light.sources_config option * Uri.t option * string option * client_mode, Tezos_client_base.Client_context.full) Tezos_clic.options
type parsed_config_args = Client_config.parsed_config_args = {
  1. parsed_config_file : Cfg_file.t option;
  2. parsed_args : cli_args option;
  3. config_commands : Tezos_client_base.Client_context.full Tezos_clic.command list;
  4. base_dir : string option;
  5. require_auth : bool;
}
val default_parsed_config_args : parsed_config_args
val check_base_dir_for_mode : Tezos_client_base.Client_context.full -> [< `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] -> bool -> string -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val build_endpoint : string option -> int option -> bool option -> Uri.t
val light_mode_checks : [< `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] -> Uri.t -> Tezos_proxy.Light.sources_config option -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val parse_config_args : Tezos_client_base.Client_context.full -> string list -> (parsed_config_args * string list, Tezos_error_monad.Error_monad.tztrace) Stdlib.result Lwt.t
type t = string option * bool * string option * bool * Tezos_shell_services.Shell_services.chain * Tezos_shell_services.Shell_services.block * int option option * Tezos_base.TzPervasives.Protocol_hash.t option option * bool * bool * string option * int option * bool * Tezos_rpc_http.Media_type.Command_line.t option * Uri.t option * Tezos_proxy.Light.sources_config option * Uri.t option * string option * client_mode
module type Remote_params = Client_config.Remote_params
val other_registrations : (Cfg_file.t -> (module Remote_params) -> unit) option
val clic_commands : base_dir:'a -> config_commands:'b list -> builtin_commands:'c list -> other_commands:'c list -> require_auth:'d -> 'b list
val logger : 'a option
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct