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

module type Proxy_sig = sig ... end

The module type of a proxy environment. Modules of this type should be prepared protocol-side and registered here to become available to the proxy facility.

type proxy_environment = (module Proxy_sig)

val register_proxy_context : proxy_environment -> unit

register_proxy_context env adds a proxy environment to the list of known environments. Raise Invalid_argument if an environment for the given protocol exists already.

val get_all_registered : unit -> proxy_environment list

get_all_registered () returns all proxy environments that have been registered so far with register_proxy_context

val get_registered_proxy : 
  Tezos_client_base.Client_context.printer ->
  Tezos_rpc.RPC_context.simple ->
  [< `Mode_light | `Mode_proxy ] ->
  ?chain:Tezos_shell_services.Block_services.chain ->
  ?block:Tezos_shell_services.Block_services.block ->
  Tezos_crypto.Protocol_hash.t option ->
  (proxy_environment, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Returns a proxy environment for the given protocol (or the first one in the list of registered protocols if the Protocol_hash.t is None, see the Registration module).