package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
exception Rpc_dir_creation_failure of Tezos_base.TzPervasives.tztrace

Exception used by the proxy mode when creation of the input environment (of the RPC handler) fails. This exception is used to temporarily escape from the monad, because at the point of throwing, the code is NOT in tzresult Lwt.t. As it's dealing with resto APIs it's in an Lwt.t-only monad. This exception is injected back in the tzresult Lwt.t monad at the point where it is caught (with Lwt.catch).

type mode =
  1. | Light_client of Light.sources
    (*

    octez-client --mode light is running

    *)
  2. | Proxy_client
    (*

    octez-client --mode proxy is running

    *)
  3. | Proxy_server of {
    1. sleep : float -> unit Lwt.t;
    2. sym_block_caching_time : Ptime.span option;
    3. on_disk_proxy_builder : (Tezos_base.TzPervasives.Context_hash.t -> Tezos_protocol_environment.Proxy_delegate.t Tezos_base.TzPervasives.tzresult Lwt.t) option;
    }
    (*

    tezos-proxy-server is running. The sleep field is implemented by Lwt_unix.sleep. We don't want to depend on it directly (for compiling to Javascript), hence this field. The Ptime.span option field is the value of argument --sym-block-caching-time. The (Context_hash.t -> Proxy_delegate.t tzresult Lwt.t) option value is constructed from argument --data-dir: if the argument is present, this value represents how data is looked up in the data-dir of a running node.

    *)

Whether using the light mode or the proxy mode (remember that the light mode is a different instance of the proxy mode (see srcs/lib_proxy/README_LIGHT.md for documentation) and whether octez-client or tezos-proxy-server is running.

build_directory printer rpc_context env mode returns the directory of RPCs that is served locally by the client's light and proxy modes and by the proxy server. Parameters are:

  • printer is used for logging.
  • rpc_context is used to perform RPCs to distant endpoints.
  • mode specifies whether octez-client (light or proxy mode) or tezos-proxy-server is running.
  • env is a protocol-specific module used to create the context passed when executing a RPC.
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