package tezos-proxy

You can search for identifiers within the package.

in-package search v0.2.0

tezos-proxy
- Tezos_proxy
  - Light
  - Light_consensus
    
    Make
    
    Light_proto
  - Light_core
  - Light_internal
    
    Merkle
  - Light_logger
    
    Logger
    
    S
  - Light_proto
    
    PROTO_RPCS
  - Local_context
    
    Tree
  - Logger
    
    S
  - Proxy
    
    CORE
    
    TREE
  - Proxy_commands
  - Proxy_events
  - Proxy_getter
    
    Internal
    
    Tree
    
    M
    
    Make
    
    C
    
    X
    
    MakeProxy
    
    X
    
    REQUESTS_TREE
    
    RequestsTree
  - Proxy_proto
    
    PROTO_RPC
  - Proxy_services
  - RPC_client
    
    http_local_ctxt
  - Registration
    
    Proxy_sig

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of Tezos_context_memory.Context

include Tezos_context_sigs.Context.S

include Tezos_context_sigs.Context.VIEW
  with type key = string list
   and type value = bytes

type t

The type for context views.

type key = string list

The type for context keys.

type value = bytes

The type for context values.

type tree

The type for context trees.

Getters

val mem : t -> key -> bool Lwt.t

mem t k is an Lwt promise that resolves to true iff k is bound to a value in t.

val mem_tree : t -> key -> bool Lwt.t

mem_tree t k is like mem but for trees.

val find : t -> key -> value option Lwt.t

find t k is an Lwt promise that resolves to Some v if k is bound to the value v in t and None otherwise.

val find_tree : t -> key -> tree option Lwt.t

find_tree t k is like find but for trees.

val list : t -> ?offset:int -> ?length:int -> key -> (string * tree) list Lwt.t

list t key is the list of files and sub-nodes stored under k in t. The result order is not specified but is stable.

offset and length are used for pagination.

Setters

val add : t -> key -> value -> t Lwt.t

add t k v is an Lwt promise that resolves to c such that:

k is bound to v in c;
and c is similar to t otherwise.

If k was already bound in t to a value that is physically equal to v, the result of the function is a promise that resolves to t. Otherwise, the previous binding of k in t disappears.

val add_tree : t -> key -> tree -> t Lwt.t

add_tree is like add but for trees.

val remove : t -> key -> t Lwt.t

remove t k v is an Lwt promise that resolves to c such that:

k is unbound in c;
and c is similar to t otherwise.

Folding

val fold : 
  ?depth:Tezos_context_sigs.Context.depth ->
  t ->
  key ->
  order:[ `Sorted | `Undefined ] ->
  init:'a ->
  f:(key -> tree -> 'a -> 'a Lwt.t) ->
  'a Lwt.t

fold ?depth t root ~order ~init ~f recursively folds over the trees and values of t. The f callbacks are called with a key relative to root. f is never called with an empty key for values; i.e., folding over a value is a no-op.

The depth is 0-indexed. If depth is set (by default it is not), then f is only called when the conditions described by the parameter is true:

Eq d folds over nodes and contents of depth exactly d.
Lt d folds over nodes and contents of depth strictly less than d.
Le d folds over nodes and contents of depth less than or equal to d.
Gt d folds over nodes and contents of depth strictly more than d.
Ge d folds over nodes and contents of depth more than or equal to d.

If order is `Sorted (the default), the elements are traversed in lexicographic order of their keys. For large nodes, it is memory-consuming, use `Undefined for a more memory efficient fold.

module Tree : sig ... end

type index

val index : t -> index

val exists : index -> Tezos_crypto.Context_hash.t -> bool Lwt.t

val checkout : index -> Tezos_crypto.Context_hash.t -> t option Lwt.t

val checkout_exn : index -> Tezos_crypto.Context_hash.t -> t Lwt.t

val hash : 
  time:Tezos_base.Time.Protocol.t ->
  ?message:string ->
  t ->
  Tezos_crypto.Context_hash.t

val commit : 
  time:Tezos_base.Time.Protocol.t ->
  ?message:string ->
  t ->
  Tezos_crypto.Context_hash.t Lwt.t

val create : unit -> t

val empty : t

val encoding : t Data_encoding.t

val get_protocol : t -> Tezos_crypto.Protocol_hash.t Lwt.t

val add_protocol : t -> Tezos_crypto.Protocol_hash.t -> t Lwt.t

val get_hash_version : t -> Tezos_crypto.Context_hash.Version.t

Get the hash version used for the context

val set_hash_version : 
  t ->
  Tezos_crypto.Context_hash.Version.t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Set the hash version used for the context. It may recalculate the hashes of the whole context, which can be a long process. Returns an Error if the hash version is unsupported.

exception Context_dangling_hash of string

Exception raised by find_tree and add_tree when applied to shallow trees. It is exposed so that it can be catched by the proxy where such operations on shallow trees are expected.

val add_predecessor_block_metadata_hash : 
  t ->
  Tezos_crypto.Block_metadata_hash.t ->
  t Lwt.t

val add_predecessor_ops_metadata_hash : 
  t ->
  Tezos_crypto.Operation_metadata_list_list_hash.t ->
  t Lwt.t

val get_test_chain : t -> Tezos_base.Test_chain_status.t Lwt.t

val add_test_chain : t -> Tezos_base.Test_chain_status.t -> t Lwt.t

val shallow_of_tree : Tree.repo -> tree -> tree

shallow_of_tree repo t returns a shallow tree with the same hash as t.