package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/octez-shell-libs.client-base-unix/Tezos_client_base_unix/Client_config/index.html

Module Tezos_client_base_unix.Client_configSource

Sourcetype 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;
}
Sourceand client_mode = [
  1. | `Mode_client
  2. | `Mode_light
  3. | `Mode_mockup
  4. | `Mode_proxy
]
Sourceval all_modes : [> `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] list
Sourceval client_mode_to_string : [< `Mode_client | `Mode_light | `Mode_mockup | `Mode_proxy ] -> string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_endpoint_arg of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_media_type_arg of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Suppressed_arg of {
    1. args : string list;
    2. by : string;
    }
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_chain_argument of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_block_argument of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_protocol_argument of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_port_arg of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_remote_signer_argument of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_wait_arg of string
Sourcetype Tezos_base.TzPervasives.error +=
  1. | Invalid_mode_arg of string
Sourceval home : string
Sourceval base_dir_env_name : string
Sourceval default_base_dir : string
Sourceval default_chain : [> `Main ]
Sourceval default_block : [> `Head of int ]
Sourceval default_endpoint : Uri.t
Sourceval default_daily_logs_path : 'a option
Sourcemodule Cfg_file : sig ... end
Sourceval default_cli_args : cli_args
Sourceval string_parameter : unit -> (string, Tezos_client_base.Client_context.full) Tezos_clic.parameter
Sourceval endpoint_parameter : unit -> (Uri.t, 'a) Tezos_clic.parameter
Sourceval sources_parameter : unit -> (Tezos_proxy.Light.sources_config, 'a) Tezos_clic.parameter
Sourceval wait_parameter : unit -> (int option, 'a) Tezos_clic.parameter
Sourceval protocol_parameter : unit -> (Tezos_base.TzPervasives.Protocol_hash.t option, 'a) Tezos_clic.parameter
Sourceval base_dir_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
Sourceval no_base_dir_warnings_switch : unit -> (bool, 'a) Tezos_clic.arg
Sourceval config_file_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
Sourceval timings_switch : unit -> (bool, 'a) Tezos_clic.arg
Sourceval wait_arg : unit -> (int option option, 'a) Tezos_clic.arg
Sourceval protocol_arg : unit -> (Tezos_base.TzPervasives.Protocol_hash.t option option, 'a) Tezos_clic.arg
Sourceval log_requests_switch : unit -> (bool, 'a) Tezos_clic.arg
Sourceval better_errors : unit -> (bool, 'a) Tezos_clic.arg
Sourceval addr_confdesc : string
Sourceval addr_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
Sourceval port_confdesc : string
Sourceval port_arg : unit -> (int option, 'a) Tezos_clic.arg
Sourceval tls_confdesc : string
Sourceval tls_switch : unit -> (bool, 'a) Tezos_clic.arg
Sourceval media_type_confdesc : string
Sourceval endpoint_confdesc : string
Sourceval endpoint_arg : unit -> (Uri.t option, 'a) Tezos_clic.arg
Sourceval sources_arg : unit -> (Tezos_proxy.Light.sources_config option, 'a) Tezos_clic.arg
Sourceval remote_signer_arg : unit -> (Uri.t option, 'a) Tezos_clic.arg
Sourceval password_filename_arg : unit -> (string option, Tezos_client_base.Client_context.full) Tezos_clic.arg
Sourceval client_mode_arg : unit -> (client_mode, 'a) Tezos_clic.arg
Sourceval read_config_file : string -> Cfg_file.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval default_config_file_name : string
Sourceval mockup_bootstrap_accounts : string
Sourceval mockup_protocol_constants : string
Sourceval config_show_client : Tezos_client_base.Client_context.full -> string -> Cfg_file.t -> (unit, 'a) result Lwt.t
Sourceval config_show_mockup : Tezos_client_base.Client_context.full -> Tezos_base.TzPervasives.Protocol_hash.t option -> string -> (unit, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval config_init_client : string -> Cfg_file.t -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t
Sourceval config_init_mockup : Tezos_client_base.Client_context.full -> Tezos_base.TzPervasives.Protocol_hash.t option -> string -> string -> string -> (unit, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval commands : string -> Cfg_file.t -> client_mode -> Tezos_base.TzPervasives.Protocol_hash.t option -> string -> Tezos_client_base.Client_context.full Tezos_clic.command list
Sourceval 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
Sourcetype 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;
}
Sourceval default_parsed_config_args : parsed_config_args
Sourceval 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) result Lwt.t
Sourceval build_endpoint : string option -> int option -> bool option -> Uri.t
Sourceval 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
Sourceval parse_config_args : Tezos_client_base.Client_context.full -> string list -> (parsed_config_args * string list, Tezos_error_monad.Error_monad.tztrace) result Lwt.t
Sourcetype 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
Sourcemodule type Remote_params = sig ... end
Sourceval other_registrations : (Cfg_file.t -> (module Remote_params) -> unit) option
Sourceval clic_commands : base_dir:'a -> config_commands:'b list -> builtin_commands:'b list -> other_commands:'b list -> require_auth:'c -> 'b list
Sourceval logger : 'a option