Module `Tezos_shell.Shell_plugin`Source

Sourcemodule type FILTER = sig ... end

Type of a protocol-specific mempool filter plugin.

Sourcemodule type RPC = sig ... end

Type of a protocol-specific RPC plug-in.

module No_filter
  (Proto : Tezos_protocol_updater.Registered_protocol.T) : 
  FILTER with module Proto = Proto and type Mempool.state = unit

Dummy filter that does nothing

Sourcemodule type METRICS = sig ... end

This is a protocol specific module that is used to collect all the * protocol-specific metrics. This module * allows to decode protocol data payload and provide back basic * types that can be used as metrics.

Sourcemodule Undefined_metrics_plugin (P : sig ... end) : METRICS

Emtpy metrics module. All metrics are -1.

Sourcetype filter_t =

| Recent of (module FILTER)
| Legacy of (module Legacy_mempool_plugin.FILTER)

Juggling between recent filter version FILTER, designed for Lima (environment V7) and newer protocols, and legacy filter version Legacy_mempool_plugin.FILTER.

Source

val no_filter : 
  (module Tezos_protocol_updater.Registered_protocol.T) ->
  filter_t

Dummy filter that does nothing.

Sourceval register_filter : (module FILTER) -> unit

Register a mempool filter plugin for a specific protocol (according to its Proto.hash). The protocol must be Lima or a more recent one.

Sourceval register_legacy_filter : (module Legacy_mempool_plugin.FILTER) -> unit

Register a mempool filter plugin for a specific protocol (according to its Proto.hash). The protocol must be Kathmandu or older.

Sourceval register_rpc : (module RPC) -> unit

Registers a RPC plug-in for a specific protocol

Sourceval register_metrics : (module METRICS) -> unit

Sourceval find_filter : Tezos_base.TzPervasives.Protocol_hash.t -> filter_t option

Looks for a mempool filter plug-in for a specific protocol.

Sourceval find_rpc : Tezos_base.TzPervasives.Protocol_hash.t -> (module RPC) option

Looks for an rpc plug-in for a specific protocol.

Source

val find_metrics : 
  Tezos_base.TzPervasives.Protocol_hash.t ->
  (module METRICS) option

Looks for a metrics plugin module for a specific protocol

Source

val safe_find_metrics : 
  Tezos_base.TzPervasives.Protocol_hash.t ->
  (module METRICS) Lwt.t

Same as find_metrics but returns Undefined_metrics_plugin if not found

package tezos-shell

Module Tezos_shell.Shell_pluginSource

Module `Tezos_shell.Shell_plugin`Source