package tezos-client-base-unix

You can search for identifiers within the package.

in-package search v0.2.0

package tezos-client-base-unix

tezos-client-base-unix
- Tezos_client_base_unix

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 = {

chain : Tezos_shell_services.Chain_services.chain;
block : Tezos_shell_services.Shell_services.block;
confirmations : int option;
sources : Tezos_proxy.Light.sources_config option;
password_filename : string option;
protocol : Tezos_crypto.Protocol_hash.t option;
print_timings : bool;
log_requests : bool;
client_mode : client_mode;

}

and client_mode = [

| `Mode_client
| `Mode_light
| `Mode_mockup
| `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 +=

| Invalid_endpoint_arg of string

type Tezos_base__TzPervasives.error +=

| Invalid_media_type_arg of string

type Tezos_base__TzPervasives.error +=

| Suppressed_arg of {
1. args : string list;
2. by : string;
}

type Tezos_base__TzPervasives.error +=

| Invalid_chain_argument of string

type Tezos_base__TzPervasives.error +=

| Invalid_block_argument of string

type Tezos_base__TzPervasives.error +=

| Invalid_protocol_argument of string

type Tezos_base__TzPervasives.error +=

| Invalid_port_arg of string

type Tezos_base__TzPervasives.error +=

| Invalid_remote_signer_argument of string

type Tezos_base__TzPervasives.error +=

| Invalid_wait_arg of string

type Tezos_base__TzPervasives.error +=

| 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

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.Clic.parameter

val media_type_parameter : 
  unit ->
  (Tezos_rpc_http.Media_type.t list, Tezos_client_base.Client_context.full)
    Tezos_clic.Clic.parameter

val endpoint_parameter : unit -> (Uri.t, 'a) Tezos_clic.Clic.parameter

val sources_parameter : 
  unit ->
  (Tezos_proxy.Light.sources_config, 'a) Tezos_clic.Clic.parameter

val chain_parameter : 
  unit ->
  (Tezos_shell_services.Chain_services.chain, 'a) Tezos_clic.Clic.parameter

val block_parameter : 
  unit ->
  (Tezos_shell_services.Block_services.block, 'a) Tezos_clic.Clic.parameter

val wait_parameter : unit -> (int option, 'a) Tezos_clic.Clic.parameter

val protocol_parameter : 
  unit ->
  (Tezos_crypto.Protocol_hash.t option, 'a) Tezos_clic.Clic.parameter

val base_dir_arg : 
  unit ->
  (string option, Tezos_client_base.Client_context.full) Tezos_clic.Clic.arg

val config_file_arg : 
  unit ->
  (string option, Tezos_client_base.Client_context.full) Tezos_clic.Clic.arg

val timings_switch : unit -> (bool, 'a) Tezos_clic.Clic.arg

val chain_arg : 
  unit ->
  (Tezos_shell_services.Chain_services.chain, 'a) Tezos_clic.Clic.arg

val block_arg : 
  unit ->
  (Tezos_shell_services.Block_services.block, 'a) Tezos_clic.Clic.arg

val wait_arg : unit -> (int option option, 'a) Tezos_clic.Clic.arg

val protocol_arg : 
  unit ->
  (Tezos_crypto.Protocol_hash.t option option, 'a) Tezos_clic.Clic.arg

val log_requests_switch : unit -> (bool, 'a) Tezos_clic.Clic.arg

val addr_confdesc : string

val addr_arg : 
  unit ->
  (string option, Tezos_client_base.Client_context.full) Tezos_clic.Clic.arg

val port_confdesc : string

val port_arg : unit -> (int option, 'a) Tezos_clic.Clic.arg

val tls_confdesc : string

val tls_switch : unit -> (bool, 'a) Tezos_clic.Clic.arg

val media_type_confdesc : string

val media_type_arg : 
  unit ->
  (Tezos_rpc_http.Media_type.t list option,
    Tezos_client_base.Client_context.full)
    Tezos_clic.Clic.arg

val endpoint_confdesc : string

val endpoint_arg : unit -> (Uri.t option, 'a) Tezos_clic.Clic.arg

val sources_arg : 
  unit ->
  (Tezos_proxy.Light.sources_config option, 'a) Tezos_clic.Clic.arg

val remote_signer_arg : unit -> (Uri.t option, 'a) Tezos_clic.Clic.arg

val password_filename_arg : 
  unit ->
  (string option, Tezos_client_base.Client_context.full) Tezos_clic.Clic.arg

val client_mode_arg : unit -> (client_mode, 'a) Tezos_clic.Clic.arg

val read_config_file : 
  string ->
  (Cfg_file.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

val fail_on_non_mockup_dir : 
  Tezos_client_base.Client_context.full ->
  (unit, Tezos_error_monad.TzCore.error list) 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_show_mockup : 
  Tezos_client_base.Client_context.full ->
  Tezos_crypto.Protocol_hash.t option ->
  string ->
  (unit, Tezos_error_monad.TzCore.error list) 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_crypto.Protocol_hash.t option ->
  string ->
  string ->
  string ->
  (unit, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

val commands : 
  string ->
  Cfg_file.t ->
  client_mode ->
  Tezos_crypto.Protocol_hash.t option ->
  string ->
  Tezos_client_base.Client_context.full Tezos_clic.Clic.command list

val global_options : 
  unit ->
  (string option
   * string option
   * bool
   * Tezos_shell_services.Chain_services.chain
   * Tezos_shell_services.Block_services.block
   * int option option
   * Tezos_crypto.Protocol_hash.t option option
   * bool
   * string option
   * int option
   * bool
   * Tezos_rpc_http.Media_type.t list 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.Clic.options

type parsed_config_args = Client_config.parsed_config_args = {

parsed_config_file : Cfg_file.t option;
parsed_args : cli_args option;
config_commands : Tezos_client_base.Client_context.full Tezos_clic.Clic.command list;
base_dir : string option;
require_auth : bool;
password_filename : string option;

}

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 ] ->
  string ->
  (unit, Tezos_error_monad.TzCore.error list) 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_error_monad.TzCore.error list) Stdlib.result 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
  * string option
  * bool
  * Tezos_shell_services.Shell_services.chain
  * Tezos_shell_services.Shell_services.block
  * int option option
  * Tezos_crypto.Protocol_hash.t option option
  * bool
  * string option
  * int option
  * bool
  * Tezos_rpc_http.Media_type.t list 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

val default_media_type : Tezos_rpc_http.Media_type.t list