Make (u.b62e798f41a33c23f4643aa6da7e4516.tezos-shell.16.0.doc.tezos-shell.Tezos

Parameters

module Filter : Shell_plugin.FILTER

Signature

Sourcetype protocol_operation = Filter.Proto.operation

Similar to the same type in the protocol, see Tezos_protocol_environment.PROTOCOL.operation

Sourcetype validation_state = Filter.Proto.validation_state

Similar to the same type in the protocol, see Tezos_protocol_environment.PROTOCOL

Sourcetype filter_state = Filter.Mempool.state

Type Shell_plugin.FILTER.Mempool.state.

Sourcetype filter_config = Filter.Mempool.config

Type Shell_plugin.FILTER.Mempool.config.

Sourcetype chain_store = Tezos_store.Store.chain_store

The type implemented by Tezos_store.Store.chain_store in production, and mocked in tests

Sourcetype t

The state used internally by this module. Created by create and then passed back and possibly updated by add_operation and remove_operation.

This state notably contains a representation of the protocol mempool, as well as the filter state.

Source

val create : 
  chain_store ->
  head:Tezos_store.Store.Block.t ->
  timestamp:Tezos_base.Time.Protocol.t ->
  t Tezos_base.TzPervasives.tzresult Lwt.t

Create an empty state based on the head block.

Called only once when a prevalidator starts.

Source

val flush : 
  chain_store ->
  head:Tezos_store.Store.Block.t ->
  timestamp:Tezos_base.Time.Protocol.t ->
  t ->
  t Tezos_base.TzPervasives.tzresult Lwt.t

Create a new empty state based on the head block.

The previous state must be provided (even when it was based on a different block). Indeed, parts of it are recycled to make this function more efficient than create.

Source

val pre_filter : 
  t ->
  filter_config ->
  protocol_operation Shell_operation.operation ->
  [ `Passed_prefilter of Prevalidator_pending_operations.priority
  | Prevalidator_classification.error_classification ]
    Lwt.t

Light preliminary checks that should be performed on arrival of an operation and after a flush of the prevalidator.

See Shell_plugin.FILTER.Mempool.pre_filter.

Source

type replacement =
  (Tezos_base.TzPervasives.Operation_hash.t
   * Prevalidator_classification.error_classification)
    option

If an old operation has been replaced by a newly added operation, then this type contains its hash and its new classification. If there is no replaced operation, this is None.

Source

type add_result =
  t
  * protocol_operation Shell_operation.operation
  * Prevalidator_classification.classification
  * replacement

Result of add_operation.

Contain the updated (or unchanged) state t, the operation (in which count_successful_prechecks has been incremented if appropriate), its classification, and the potential replacement.

Invariant: replacement can only be Some _ when the classification is `Prechecked.

Source

val add_operation : 
  t ->
  filter_config ->
  protocol_operation Shell_operation.operation ->
  add_result Lwt.t

Call the protocol Mempool.add_operation function, providing it with the conflict_handler from the plugin.

Then if the protocol accepts the operation, call the plugin add_operation_and_enforce_mempool_bound, which is responsible for bounding the number of manager operations in the mempool.

See add_result for a description of the output.

Sourceval remove_operation : t -> Tezos_base.TzPervasives.Operation_hash.t -> t

Remove an operation from the state.

The state remains unchanged when the operation was not present.

Sourcemodule Internal_for_tests : sig ... end