package tezos-shell

  1. Overview
  2. Docs
type priority = [
  1. | `High
  2. | `Medium
  3. | `Low of Q.t list
]

The priority of a pending operation.

A priority is attached to each pending operation.

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.

val empty : 'protocol_data t

The empty structure of pending operations.

val hashes : 'protocol_data t -> Tezos_crypto.Operation_hash.Set.t

hashes p returns the set of hashes contained in p

val operations : 'protocol_data t -> 'protocol_data Prevalidation.operation Tezos_crypto.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_crypto.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 Prevalidation.operation -> priority -> 'protocol_data t -> 'protocol_data t

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

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

val remove : Tezos_crypto.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 : (priority -> Tezos_crypto.Operation_hash.t -> 'protocol_data Prevalidation.operation -> 'a -> 'a) -> 'protocol_data t -> 'a -> 'a

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

We iterate on operations with `High priority first, then on those with `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 : (priority -> Tezos_crypto.Operation_hash.t -> 'protocol_data Prevalidation.operation -> unit) -> 'protocol_data t -> unit

iter f p is similar to fold where acc is unit

val fold_es : (priority -> Tezos_crypto.Operation_hash.t -> 'protocol_data Prevalidation.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.