package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-18.0.tar.gz
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

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.