package octez-injector

You can search for identifiers within the package.

in-package search v0.2.0

Octez: library for building injectors

Install

dune-project

Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.0.tar.gz

sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c

sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-injector/Octez_injector/Injector_sigs/module-type-PARAMETERS/index.html

Module type `Injector_sigs.PARAMETERS`Source

Module type for parameter of functor Injector_functor.Make.

type state

The type of the state that the injector can access

module Tag : TAG

A module which contains the different tags for the injector

module Operation : PARAM_OPERATION

A module for the injector operations

val events_section : string list

Where to put the events for this injector

val table_estimated_size : Tag.t -> int

Coarse approximation for the number of operation of each tag we expect to inject for each block.

val retry_unsuccessful_operation : 
  state ->
  Operation.t ->
  unsuccessful_status ->
  retry_action Lwt.t

Action (see retry_action) to be taken on unsuccessful operation (see unsuccessful_status).

val operation_tag : Operation.t -> Tag.t

The tag of a manager operation. This is used to send operations to the correct queue automatically (when signer is not provided) and to recover persistent information.

val fee_parameter : state -> Operation.t -> fee_parameter

Returns the fee_parameter (to compute fee w.r.t. gas, size, etc.) and the caps of fee and burn for each operation.

val batch_must_succeed : Operation.t list -> [ `All | `At_least_one ]

When injecting the given operations in an L1 batch, if batch_must_succeed operations returns `All then all the operations must succeed in the simulation of injection. If it returns `At_least_one, at least one operation in the list operations must be successful in the simulation. In any case, only operations which are known as successful will be included in the injected L1 batch. Note: Returning `At_least_one allows to incrementally build "or-batches" by iteratively removing operations that fail from the desired batch.