package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-libs.rpc-http-server/Tezos_rpc_http_server/RPC_middleware/index.html

Module Tezos_rpc_http_server.RPC_middlewareSource

This module provides middlewares that is used by the RPC servers to forward unsupported RPCs to a full node.

Sourcetype forwarder_events = {
  1. on_forwarding : Cohttp.Request.t -> unit Lwt.t;
    (*

    Called right before an unsupported RPC gets forwarded to the node.

    *)
  2. on_locally_handled : Cohttp.Request.t -> unit Lwt.t;
    (*

    Called after an RPC has been handled by the server itself (without any forwarding).

    *)
}

Callbacks to add side-effects to proxy_server_query_forwarder, typically used to emit events.

Sourceval proxy_server_query_forwarder : ?acl:RPC_server.Acl.t -> ?ctx:Cohttp_lwt_unix.Net.ctx -> ?forwarder_events:forwarder_events -> Uri.t -> RPC_server.callback -> RPC_server.callback

A Resto middleware that transforms any callback to an other that rewrites queries that the proxy server cannot handle and forwards them to the full node at the given Uri.t. If acl parameter is provided, the forwarding happens only if the ACL rules are satisfied.

Sourceval rpc_metrics_transform_callback : update_metrics: (string -> string -> (unit -> Cohttp_lwt_unix.Server.response_action Lwt.t) -> Cohttp_lwt_unix.Server.response_action Lwt.t) -> unit Tezos_rpc.Directory.t -> RPC_server.callback -> RPC_server.callback

A Resto middleware that transforms any server callback to an other that handles RPC metrics