package octez-shell-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez shell libraries

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

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

Module `Tezos_client_base_unix.Daemon_config`Source

include module type of struct include Client_config end

Sourcetype 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_base.TzPervasives.Protocol_hash.t option;
print_timings : bool;
log_requests : bool;
better_errors : bool;
client_mode : client_mode;

}

Sourceand 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

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_endpoint_arg of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_media_type_arg of string

Sourcetype Tezos_base.TzPervasives.error +=

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

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_chain_argument of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_block_argument of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_protocol_argument of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_port_arg of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_remote_signer_argument of string

Sourcetype Tezos_base.TzPervasives.error +=

| Invalid_wait_arg of string

Sourcetype Tezos_base.TzPervasives.error +=

| 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 = Client_config.Cfg_file

Sourceval default_cli_args : cli_args

Sourceval string_parameter : unit -> (string, 'a) Tezos_clic.parameter

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

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

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

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

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

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

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

Sourceval base_dir_arg : unit -> (string option, 'a) Tezos_clic.arg

Sourceval no_base_dir_warnings_switch : unit -> (bool, 'a) Tezos_clic.arg

Sourceval config_file_arg : unit -> (string option, 'a) Tezos_clic.arg

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

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

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

Sourceval 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

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, 'a) 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

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

Sourceval endpoint_confdesc : string

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

val 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, 'a) Tezos_clic.arg

Sourceval 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) result Lwt.t

Sourceval default_config_file_name : string

Sourceval mockup_bootstrap_accounts : string

Sourceval mockup_protocol_constants : string

val config_show_client : 
  Tezos_client_base.Client_context.full ->
  string ->
  Cfg_file.t ->
  (unit, 'a) result Lwt.t

val 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

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) result Lwt.t

val 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

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

Sourcetype 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.command list;
base_dir : string option;
require_auth : bool;

}

Sourceval 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) result Lwt.t

Sourceval 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)
    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

Sourcemodule type Remote_params = Client_config.Remote_params

Sourceval other_registrations : (Cfg_file.t -> (module Remote_params) -> unit) option

val 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

Sourceval default_media_type : Tezos_rpc_http.Media_type.Command_line.t