package octez-shell-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez shell libraries

Install

dune-project

Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.1.tar.gz

sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d

sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

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

Module `Internal.Tree`Source

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

Source

val get : 
  t ->
  key ->
  Tezos_protocol_environment.Proxy_context.M.tree option Lwt.t

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

Source

val 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.