package tezos-protocol-003-PsddFKi3

  1. Overview
  2. Docs
Tezos protocol 003-PsddFKi3 package

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

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

doc/tezos_raw_protocol_003_PsddFKi3/Tezos_raw_protocol_003_PsddFKi3/Storage_description/index.html

Module Tezos_raw_protocol_003_PsddFKi3.Storage_descriptionSource

Sourcetype 'key t

Typed description of the key-value context.

Trivial display of the key-value context layout.

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.

Sourceval create : unit -> 'key t

Create a empty context description, keys will be registred by side effects.

Register a single key accessor at a given path.

Sourceval register_named_subcontext : 'key t -> string list -> 'key t

Return a description for a prefixed fragment of the given context. All keys registred in the subcontext will be shared by the external context

Sourcetype (_, _, _) args =
  1. | One : {
    1. rpc_arg : 'a Tezos_protocol_environment_003_PsddFKi3.RPC_arg.t;
    2. encoding : 'a Tezos_protocol_environment_003_PsddFKi3.Data_encoding.t;
    3. compare : 'a -> 'a -> int;
    } -> ('key, 'a, 'key * 'a) args
  2. | Pair : ('key, 'a, 'inter_key) args * ('inter_key, 'b, 'sub_key) args -> ('key, 'a * 'b, 'sub_key) args

Description of an index as a sequence of `RPC_arg.t`.

Sourceval register_indexed_subcontext : 'key t -> list: ('key -> 'arg list Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult Tezos_protocol_environment_003_PsddFKi3.Lwt.t) -> ('key, 'arg, 'sub_key) args -> 'sub_key t

Return a description for a indexed sub-context. All keys registred in the subcontext will be shared by the external context. One should provide a function to list all the registred index in the context.

Helpers for manipulating and defining indexes.

Sourceval pack : ('key, 'a, 'sub_key) args -> 'key -> 'a -> 'sub_key
Sourceval unpack : ('key, 'a, 'sub_key) args -> 'sub_key -> 'key * 'a
Sourcemodule type INDEX = sig ... end