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.proxy/Tezos_proxy/Proxy_getter/index.html

Module Tezos_proxy.Proxy_getterSource

module Local := Tezos_context_memory.Context
module Proof := Tezos_context_sigs.Context.Proof_types
Sourceval raw_context_size : Proof.raw_context -> int

The size of a tree, for logging

Sourcemodule type REQUESTS_TREE = sig ... end

The point of this data structure is as follows:

The point of this data structure is as follows:

Sourcemodule type M = sig ... end
Sourcetype proxy_m = (module M)
Sourcetype proxy_builder =
  1. | Of_rpc of Proxy_proto.proto_rpc -> proxy_m Lwt.t
    (*

    Build a proxy that uses network requests for all data.

    *)
  2. | Of_data_dir of Tezos_base.TzPervasives.Context_hash.t -> Tezos_protocol_environment.Proxy_delegate.t Tezos_base.TzPervasives.tzresult Lwt.t
    (*

    Build a proxy that looks up data in a running node's data dir.

    *)

The different ways to obtain data from the node. The two functions being wrapped are ultimately used to build Proxy_delegate.t values, that are passed to Proxy_context.empty.

Sourcetype rpc_context_args = {
  1. printer : Tezos_client_base.Client_context.printer option;
    (*

    Optional printer to display information in some custom format.

    *)
  2. proxy_builder : proxy_builder;
    (*

    Given the protocol implementation of the RPCs required by the proxy mode, how to build an instance of proxy_m that will then make it possible to build a Tezos_protocol_environment.Proxy_context.

    *)
  3. rpc_context : Tezos_rpc.Context.generic;
    (*

    How to perform RPC calls. We need such a value, because the proxy mode performs RPCs to initialize itself (by requesting the header) and also to fill Tezos_protocol_environment.Proxy_context on-demand.

    *)
  4. mode : Proxy.mode;
    (*

    Whether the client or the proxy server is running.

    *)
  5. chain : Tezos_shell_services.Block_services.chain;
    (*

    The chain to provide RPC calls for.

    *)
  6. block : Tezos_shell_services.Block_services.block;
    (*

    The block to provide RPC calls for.

    *)
}

Input data required by the proxy mode to build a Tezos_protocol_environment.rpc_context.

Sourceval make_delegate : rpc_context_args -> (module Proxy_proto.PROTO_RPC) -> Tezos_base.TzPervasives.Context_hash.t -> Tezos_protocol_environment.Proxy_delegate.t Tezos_base.TzPervasives.tzresult Lwt.t

Builds a proxy delegate in the way specified by the proxy_builder field of the rpc_context_args argument.

Functor to obtain the implementation of M for the proxy mode (as opposed to the light mode implementation)

Functor to obtain a generic implementation. Used by the light mode

Sourcemodule Internal : sig ... end

Exposed for testing purpose only, you should not use it directly