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

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-shell-libs.proxy/Tezos_proxy/Proxy/index.html

Module Tezos_proxy.ProxySource

Code that is used both by protocol-dependent code and by other code. Note that we don't want this code in proxy_proto.ml because it's independent from the protocol and we neither want this code in proxy_getter.ml, because it would create a cyclic dependency between proxy_proto.ml and proxy_getter.ml

Sourcemodule Local = Tezos_context_memory.Context
Sourcetype mode =
  1. | Client
    (*

    Mode when octez-client executes

    *)
  2. | Server
    (*

    Mode when tezos-proxy-server executes

    *)

Whether octez-client or tezos-proxy-server is running.

Sourcetype proxy_getter_input = {
  1. rpc_context : Tezos_rpc.Context.simple;
    (*

    How to perform RPC calls

    *)
  2. mode : mode;
    (*

    Whether octez-client or tezos-proxy-server is running

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

    The chain involved in the RPC call

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

    The block involved in the RPC call

    *)
}

A dumb container, used to perform RPC calls concerning a specific chain and block. In other words this container is used to perform RPC calls of the form /chains/<chain>/blocks/<block> where the <...> received the value of the corresponding field of this record.

Sourcetype 'a update =
  1. | Mutation
  2. | Value of 'a

The result of setting a leaf. A mutation if done in place, otherwise a fresh value. We need this type because the proxy implementation returns a value whereas the light mode's implementation performs a mutation (because of Irmin under the hood).

Sourcemodule type TREE = sig ... end

An ad-hoc module type used by implementations of the proxy mode when it uses the ../raw/bytes RPC to query its distant endpoint. It is ad-hoc because its get function has the concrete Proxy_context.M.tree as a return type and because add_leaf has the concrete Tezos_context_sigs.Context.Proof_types.raw_context as a parameter (this type is inherited from the return type of the ../raw/bytes RPC).

Sourcemodule type CORE = sig ... end

Module used by implementations of Proxy_getter.M.