Legend:
Library
Module
Module type
Parameter
Class
Class type
This module is responsible for building the description of the current state of the storage, which is then used to build specification of the RPC endpoints for accessing the storage. It produces restoRPC_directory.t values, which can be used directly to construct the RPC endpoint tree.
Export an RPC hierarchy for querying the context. There is one service by possible path in the context. Services for "directory" are able to aggregate in one JSON object the whole subtree.
Create a empty context description, keys will be registered by side effects.
val register_value :
'keyt->get:
('key->('a option,
Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.errorTezos_protocol_environment_012_Psithaca__Environment.Error_monad.trace)Stdlib.resultLwt.t)->'aData_encoding.t->
unit
Register a single key accessor at a given path.
val register_named_subcontext : 'keyt->string list->'keyt
Return a description for a prefixed fragment of the given context. All keys registered in the subcontext will be shared by the external context
Description of an index as a sequence of `RPC_arg.t`.
val register_indexed_subcontext :
'keyt->list:
('key->('arg list,
Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.errorTezos_protocol_environment_012_Psithaca__Environment.Error_monad.trace)Stdlib.resultLwt.t)->('key, 'arg, 'sub_key)args->'sub_keyt
Return a description for a indexed sub-context. All keys registered in the subcontext will be shared by the external context. One should provide a function to list all the registered index in the context.
Helpers for manipulating and defining indexes.
val pack : ('key, 'a, 'sub_key)args->'key->'a->'sub_key
val unpack : ('key, 'a, 'sub_key)args->'sub_key->'key * 'a