package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13
doc/octez-shell-libs.shell-context/Tezos_shell_context/Proxy_delegate_maker/index.html
Module Tezos_shell_context.Proxy_delegate_maker
Source
val of_memory_tree :
Tezos_context_memory.Context.tree ->
Tezos_protocol_environment.Proxy_delegate.t
of_memory_tree t
creates a delegate that is backed by the tree t
. This is an alternative to delegating to a distant endpoint by doing RPCs (as done in the client, see e.g. proto_alpha/lib_client/proxy.ml
). As delegates created by of_memory_tree
are backed by an in-memory tree, they are as fast as they can be.
This constructor is easier to use than of_memory_context
, because it requires only a tree of data; not a context. This constructor is typically useful for tests.
val of_memory_context :
Tezos_context_memory.Context.t ->
Tezos_protocol_environment.Proxy_delegate.t
of_memory_context m
creates a delegate that is backed by the tree underlying m
. This is an alternative to delegating to a distant endpoint by doing RPCs (as done in the client, see e.g. proto_alpha/lib_client/proxy.ml
). As delegates created by of_memory_context
are backed by an in-memory tree, they are as fast as they can be.
This constructor is slightly harder to use than of_memory_tree
, because it requires a full-fledged context instead of a tree (a context contains a tree, so a context is harder to obtain).
make_index context_path
creates an index that is suitable for being passed to of_index
.
val of_index :
index:Tezos_context.Context.index ->
Tezos_crypto.Hashed.Context_hash.t ->
Tezos_protocol_environment.Proxy_delegate.t Tezos_base.TzPervasives.tzresult
Lwt.t
of_index index ctxt_hash
creates a delegate that checkouts the given index at the given ctxt_hash
. It fails in the error monad if the hash is unknown. Otherwise it returns a delegate that queries the tree of data at this hash.
This constructor is the hardest to use of all of this file, because to obtain an index
, you need a full-fledged context on disk.