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

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.

val protocol_hash : Tezos_crypto.Protocol_hash.t

val directory : 
  Tezos_protocol_environment.rpc_context Tezos_rpc.RPC_directory.t

RPCs provided by the protocol

val hash : 
  Tezos_rpc.RPC_context.simple ->
  ?chain:Tezos_shell_services.Block_services.chain ->
  ?block:Tezos_shell_services.Block_services.block ->
  unit ->
  (Tezos_crypto.Block_hash.t, Tezos_error_monad.TzCore.error list) result Lwt.t

The protocol's /chains/<chain>/blocks/<block_id>/hash RPC

val init_env_rpc_context : 
  Tezos_client_base.Client_context.printer ->
  (Proxy_proto.proto_rpc -> Proxy_getter.proxy_m Lwt.t) ->
  Tezos_rpc.RPC_context.json ->
  Proxy.mode ->
  Tezos_shell_services.Block_services.chain ->
  Tezos_shell_services.Block_services.block ->
  (Tezos_protocol_environment.rpc_context, Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

How to build the context to execute RPCs on. Arguments are:

A printer (for logging)
An instance of RPC_context.json, to perform RPCs
Whether tezos-client or tezos-proxy-server is running
The chain for which the context is required
The block for which the context is required

val time_between_blocks : 
  Tezos_rpc.RPC_context.json ->
  Tezos_shell_services.Block_services.chain ->
  Tezos_shell_services.Block_services.block ->
  (int64 option, Tezos_error_monad.TzCore.error list) result Lwt.t

The time_between_blocks constant for the given block, if any.

Functions used to implement the light mode

include Light_proto.PROTO_RPCS

val merkle_tree : 
  Proxy.proxy_getter_input ->
  Proxy_context.M.key ->
  Tezos_shell_services.Block_services.merkle_leaf_kind ->
  (Tezos_shell_services.Block_services.merkle_tree option,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t