package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type priority =
  1. | High
  2. | Medium
  3. | Low of Q.t list
type status =
  1. | Fresh
  2. | Reclassified

The status of a pending operation.

type status_and_priority = {
  1. priority : priority;
  2. status : status;
}
type 'protocol_data t

This type is used for data representing pending operations of the prevalidator. Any iterator on this structure will process operations with `High priority first, followed by `Medium and finally `Low priority.

This module implements a sized-set data-structure.

val empty : 'protocol_data t

The empty structure of pending operations.

val hashes : 'protocol_data t -> Tezos_base.TzPervasives.Operation_hash.Set.t

hashes p returns the set of hashes contained in p

val operations : 'protocol_data t -> 'protocol_data Shell_operation.operation Tezos_base.TzPervasives.Operation_hash.Map.t

operations p returns the Map of bindings oph -> op contained in p

val is_empty : 'protocol_data t -> bool

is_empty p returns true if p has operations, false otherwise.

val mem : Tezos_base.TzPervasives.Operation_hash.t -> 'protocol_data t -> bool

mem oph p returns true if oph is found in p, false otherwise.

Complexity is O(log(n)), where n is the number of operations (hashes) in the structure.

val add : 'protocol_data Shell_operation.operation -> status_and_priority -> 'protocol_data t -> 'protocol_data t

add oph op p status_and_priority records the operation op whose hash is oph and whose status and priority is status_and_priority in p.

Complexity is O(log(n)), where n is the number of operations (hashes) in the structure.

It is unspecified behaviour to call this function with a hash (oph) which is already recorded in the data-structure (p). It is your responsibility as the caller of the function to ensure this.

val remove : Tezos_base.TzPervasives.Operation_hash.t -> 'protocol_data t -> 'protocol_data t

remove oph op p removes the binding oph from p.

Complexity is O(log(n)), where n is the number of operations (hashes) in the structure.

val cardinal : 'protocol_data t -> int

cardinal p returns the number of operations (hashes) in p.

Complexity is O(n), where n is the number of operations (hashes) in the structure.

val fold : (status_and_priority -> Tezos_base.TzPervasives.Operation_hash.t -> 'protocol_data Shell_operation.operation -> 'a -> 'a) -> 'protocol_data t -> 'a -> 'a

fold f p acc applies the function f on every binding oph |-> op of status and priority status_and_priority in p. The acc is passed to and (possibly) updated by every call to f.

We iterate on operations with the following order:

  • Fresh status and High priority
  • Fresh status and Medium priority
  • Fresh status and Low priority
  • Reclassified status and High priority
  • Reclassified status and Medium priority
  • Reclassified status and Low priority

For operations with the same priority, the iteration order is defined Operation_hash.compare function (operations with small hashes are processed first).

val iter : (status_and_priority -> Tezos_base.TzPervasives.Operation_hash.t -> 'protocol_data Shell_operation.operation -> unit) -> 'protocol_data t -> unit

iter f p is similar to fold where acc is unit

val fold_es : (status_and_priority -> Tezos_base.TzPervasives.Operation_hash.t -> 'protocol_data Shell_operation.operation -> 'a -> ('a, 'b) Stdlib.result Lwt.t) -> 'protocol_data t -> 'a -> ('a, 'b) Stdlib.result Lwt.t

fold_es f p acc is the Lwt version of fold, except that fold_es returns wihtout iterating over all the elements of the list as soon as a value Error e is returned by f

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct