package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install

Dune Dependency

Authors

Maintainers

Sources

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

doc/octez-shell-libs.proxy/Tezos_proxy/Proxy_getter/Internal/Tree/index.html

Module Internal.TreeSource

Sourcetype t = Local.tree

The abstract type that implementors of this module type provide. Obtain an instance with empty. Think of t as a tree type.

Sourcetype key = Local.key

An abstract type of key.

Sourceval empty : t

empty returns a pristine value

get t key returns the tree of data mapped by key, if any.

Sourceval add_leaf : t -> key -> Tezos_context_sigs.Context.Proof_types.raw_context -> t Proxy.update Lwt.t

add_leaf t key raw_ctxt returns a variant of t where key is mapped to raw_ctxt. When this function is called, it transforms raw_ctxt, under the hood, into an instance of Proxy_context.M.tree, as the latter is the type internally stored in t (it needs to be, as it's the return type of get).

This function is called add_leaf, because the proxy mode iteratively builds its local copy of the endpoint's data. This function is only called when adding a new leaf in the tree of data, never to replace existing data. In other words, it's not a general purpose setter.

OCaml

Innovation. Community. Security.