Module `Tezos_raw_protocol_012_Psithaca.Raw_context`Source

Errors

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Too_many_internal_operations

Sourcetype missing_key_kind =

| Get
| Set
| Del
| Copy

Sourcetype storage_error =

| Incompatible_protocol_version of string
| Missing_key of string list * missing_key_kind
| Existing_key of string list
| Corrupted_data of string list

An internal storage error that should not happen

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Storage_error of storage_error

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Failed_to_parse_parameter of bytes

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Failed_to_decode_parameter of Tezos_protocol_environment_012_Psithaca.Data_encoding.json * string

Source

val storage_error : 
  storage_error ->
  'a Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Abstract Context

Sourcetype t

Abstract view of the context. Includes a handle to the functional key-value database (Context.t) along with some in-memory values (gas, etc.).

Sourcetype root = t

Source

val prepare : 
  level:Tezos_protocol_environment_012_Psithaca.Int32.t ->
  predecessor_timestamp:Tezos_protocol_environment_012_Psithaca.Time.t ->
  timestamp:Tezos_protocol_environment_012_Psithaca.Time.t ->
  Tezos_protocol_environment_012_Psithaca.Context.t ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Retrieves the state of the database and gives its abstract view. It also returns wether this is the first block validated with this version of the protocol.

Sourcetype previous_protocol =

| Genesis of Parameters_repr.t
| Hangzhou_011

Source

val prepare_first_block : 
  level:int32 ->
  timestamp:Tezos_protocol_environment_012_Psithaca.Time.t ->
  Tezos_protocol_environment_012_Psithaca.Context.t ->
  (previous_protocol * t)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val activate : 
  t ->
  Tezos_protocol_environment_012_Psithaca.Protocol_hash.t ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

Sourceval recover : t -> Tezos_protocol_environment_012_Psithaca.Context.t

Returns the state of the database resulting of operations on its abstract view

Sourceval current_level : t -> Level_repr.t

Sourceval predecessor_timestamp : t -> Tezos_protocol_environment_012_Psithaca.Time.t

Sourceval current_timestamp : t -> Tezos_protocol_environment_012_Psithaca.Time.t

Sourceval constants : t -> Constants_repr.parametric

Source

val patch_constants : 
  t ->
  (Constants_repr.parametric -> Constants_repr.parametric) ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

Sourceval round_durations : t -> Round_repr.Durations.t

Sourceval cycle_eras : t -> Level_repr.cycle_eras

Retrieve the cycle eras.

Source

val credit_collected_fees_only_call_from_token : 
  t ->
  Tez_repr.t ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Increment the current block fee stash that will be credited to the payload producer's account at finalize_application

Source

val spend_collected_fees_only_call_from_token : 
  t ->
  Tez_repr.t ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Decrement the current block fee stash that will be credited to the payload producer's account at finalize_application

Sourceval get_collected_fees : t -> Tez_repr.t

Returns the current block fee stash that will be credited to the payload producer's account at finalize_application

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Gas_limit_too_high

Source

val check_gas_limit_is_valid : 
  t ->
  'a Gas_limit_repr.Arith.t ->
  unit Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val consume_gas_limit_in_block : 
  t ->
  'a Gas_limit_repr.Arith.t ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Sourceval set_gas_limit : t -> 'a Gas_limit_repr.Arith.t -> t

Sourceval set_gas_unlimited : t -> t

Sourceval gas_level : t -> Gas_limit_repr.t

Sourceval gas_consumed : since:t -> until:t -> Gas_limit_repr.Arith.fp

Sourceval remaining_operation_gas : t -> Gas_limit_repr.Arith.fp

Sourceval update_remaining_operation_gas : t -> Gas_limit_repr.Arith.fp -> t

Sourceval block_gas_level : t -> Gas_limit_repr.Arith.fp

Sourceval update_remaining_block_gas : t -> Gas_limit_repr.Arith.fp -> t

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Undefined_operation_nonce

Source

val init_origination_nonce : 
  t ->
  Tezos_protocol_environment_012_Psithaca.Operation_hash.t ->
  t

Source

val get_origination_nonce : 
  t ->
  Contract_repr.origination_nonce
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val increment_origination_nonce : 
  t ->
  (t * Contract_repr.origination_nonce)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Sourceval unset_origination_nonce : t -> t

Generic accessors

Sourcetype key = string list

Sourcetype value = bytes

Sourcetype tree

Source

module type T =
  Raw_context_intf.T
    with type root := root
     and type key := key
     and type value := value
     and type tree := tree

include T with type t := t

include Raw_context_intf.VIEW
  with type key := key
  with type value := value
  with type tree := tree
  with type t := t

Getters

Sourceval mem : t -> key -> bool Tezos_protocol_environment_012_Psithaca.Lwt.t

mem t k is an Lwt promise that resolves to true iff k is bound to a value in t.

Sourceval mem_tree : t -> key -> bool Tezos_protocol_environment_012_Psithaca.Lwt.t

mem_tree t k is like mem but for trees.

Source

val get : 
  t ->
  key ->
  value Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

get t k is an Lwt promise that resolves to Ok v if k is bound to the value v in t and Storage_ErrorMissing_key otherwise.

Source

val get_tree : 
  t ->
  key ->
  tree Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

get_tree is like get but for trees.

Source

val find : 
  t ->
  key ->
  value option Tezos_protocol_environment_012_Psithaca.Lwt.t

find t k is an Lwt promise that resolves to Some v if k is bound to the value v in t and None otherwise.

Source

val find_tree : 
  t ->
  key ->
  tree option Tezos_protocol_environment_012_Psithaca.Lwt.t

find_tree t k is like find but for trees.

Source

val list : 
  t ->
  ?offset:int ->
  ?length:int ->
  key ->
  (string * tree) list Tezos_protocol_environment_012_Psithaca.Lwt.t

list t key is the list of files and sub-nodes stored under k in t. The result order is not specified but is stable.

offset and length are used for pagination.

Setters

Source

val init : 
  t ->
  key ->
  value ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

init t k v is an Lwt promise that resolves to Ok c if:

k is unbound in t;
k is bound to v in c;
and c is similar to t otherwise.

It is Storage_errorExisting_key if k is already bound in t.

Source

val init_tree : 
  t ->
  key ->
  tree ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

init_tree is like init but for trees.

Source

val update : 
  t ->
  key ->
  value ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

update t k v is an Lwt promise that resolves to Ok c if:

k is bound in t;
k is bound to v in c;
and c is similar to t otherwise.

It is Storage_errorMissing_key if k is not already bound in t.

Source

val update_tree : 
  t ->
  key ->
  tree ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

update_tree is like update but for trees.

Sourceval add : t -> key -> value -> t Tezos_protocol_environment_012_Psithaca.Lwt.t

add t k v is an Lwt promise that resolves to c such that:

k is bound to v in c;
and c is similar to t otherwise.

If k was already bound in t to a value that is physically equal to v, the result of the function is a promise that resolves to t. Otherwise, the previous binding of k in t disappears.

Source

val add_tree : 
  t ->
  key ->
  tree ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

add_tree is like add but for trees.

Sourceval remove : t -> key -> t Tezos_protocol_environment_012_Psithaca.Lwt.t

remove t k v is an Lwt promise that resolves to c such that:

k is unbound in c;
and c is similar to t otherwise.

Source

val remove_existing : 
  t ->
  key ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

remove_existing t k v is an Lwt promise that resolves to Ok c if:

k is bound in t to a value;
k is unbound in c;
and c is similar to t otherwise.

Source

val remove_existing_tree : 
  t ->
  key ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

remove_existing_tree t k v is an Lwt promise that reolves to Ok c if:

k is bound in t to a tree;
k is unbound in c;
and c is similar to t otherwise.

Source

val add_or_remove : 
  t ->
  key ->
  value option ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

add_or_remove t k v is:

add t k x if v is Some x;
remove t k otherwise.

Source

val add_or_remove_tree : 
  t ->
  key ->
  tree option ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

add_or_remove_tree t k v is:

add_tree t k x if v is Some x;
remove t k otherwise.

Folds

Source

val fold : 
  ?depth:[ `Eq of int | `Le of int | `Lt of int | `Ge of int | `Gt of int ] ->
  t ->
  key ->
  order:[ `Sorted | `Undefined ] ->
  init:'a ->
  f:(key -> tree -> 'a -> 'a Tezos_protocol_environment_012_Psithaca.Lwt.t) ->
  'a Tezos_protocol_environment_012_Psithaca.Lwt.t

fold ?depth t root ~init ~f recursively folds over the trees and values of t. The f callbacks are called with a key relative to root. f is never called with an empty key for values; i.e., folding over a value is a no-op.

Elements are traversed in lexical order of keys.

The depth is 0-indexed. If depth is set (by default it is not), then f is only called when the conditions described by the parameter is true:

Eq d folds over nodes and contents of depth exactly d.
Lt d folds over nodes and contents of depth strictly less than d.
Le d folds over nodes and contents of depth less than or equal to d.
Gt d folds over nodes and contents of depth strictly more than d.
Ge d folds over nodes and contents of depth more than or equal to d.

Source

module Tree : 
  Raw_context_intf.TREE
    with type t := t
     and type key := key
     and type value := value
     and type tree := tree

Tree provides immutable, in-memory partial mirror of the context, with lazy reads and delayed writes. The trees are Merkle trees that carry the same hash as the part of the context they mirror.

Sourceval project : t -> root

Internally used in Storage_functors to escape from a view.

Sourceval absolute_key : t -> key -> key

Internally used in Storage_functors to retrieve a full key from partial key relative a view.

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Block_quota_exceeded

Raised if block gas quota is exhausted during gas consumption.

Sourcetype Tezos_protocol_environment_012_Psithaca.Error_monad.error +=

| Operation_quota_exceeded

Raised if operation gas quota is exhausted during gas consumption.

Source

val consume_gas : 
  t ->
  Gas_limit_repr.cost ->
  t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Internally used in Storage_functors to consume gas from within a view. May raise Block_quota_exceeded or Operation_quota_exceeded.

Source

val check_enough_gas : 
  t ->
  Gas_limit_repr.cost ->
  unit Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Check if consume_gas will fail

Sourceval description : t Storage_description.t

Sourceval reset_internal_nonce : t -> t

Initialize the local nonce used for preventing a script to duplicate an internal operation to replay it.

Source

val fresh_internal_nonce : 
  t ->
  (t * int) Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Increments the internal operation nonce.

Sourceval record_internal_nonce : t -> int -> t

Mark an internal operation nonce as taken.

Sourceval internal_nonce_already_recorded : t -> int -> bool

Check is the internal operation nonce has been taken.

Source

val fold_map_temporary_lazy_storage_ids : 
  t ->
  (Lazy_storage_kind.Temp_ids.t -> Lazy_storage_kind.Temp_ids.t * 'res) ->
  t * 'res

Source

val map_temporary_lazy_storage_ids_s : 
  t ->
  (Lazy_storage_kind.Temp_ids.t ->
    (t * Lazy_storage_kind.Temp_ids.t)
      Tezos_protocol_environment_012_Psithaca.Lwt.t) ->
  t Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

module Cache : 
  Tezos_protocol_environment_012_Psithaca.Context.CACHE
    with type t := t
     and type size := int
     and type index := int
     and type identifier := string
     and type key = Tezos_protocol_environment_012_Psithaca.Context.Cache.key
     and type value =
           Tezos_protocol_environment_012_Psithaca.Context.Cache.value

Source

val record_non_consensus_operation_hash : 
  t ->
  Tezos_protocol_environment_012_Psithaca.Operation_hash.t ->
  t

Source

val non_consensus_operations : 
  t ->
  Tezos_protocol_environment_012_Psithaca.Operation_hash.t list

Source

val set_sampler_for_cycle : 
  t ->
  Cycle_repr.t ->
  (Seed_repr.seed
   * (Tezos_protocol_environment_012_Psithaca.Signature.public_key
      * Tezos_protocol_environment_012_Psithaca.Signature.public_key_hash)
       Sampler.t) ->
  (t, [ `Sampler_already_set ])
    Tezos_protocol_environment_012_Psithaca.Pervasives.result

set_sampler_for_cycle ctxt cycle sampler evaluates to Ok c with c verifying sampler_for_cycle c cycle = sampler if no sampler was set for the same cycle beforehand. In the other case, it returns Error `Sampler_already_set.

Source

val sampler_for_cycle : 
  t ->
  Cycle_repr.t ->
  (Seed_repr.seed
   * (Tezos_protocol_environment_012_Psithaca.Signature.public_key
      * Tezos_protocol_environment_012_Psithaca.Signature.public_key_hash)
       Sampler.t,
    [ `Sampler_not_set ])
    Tezos_protocol_environment_012_Psithaca.Pervasives.result

sampler_for_cycle ctxt cycle evaluates to Ok sampler if a sampler was set for cycle using set_sampler_for_cycle. Otherwise, it returns Error `Sampler_not_set.

Source

val stake_distribution_for_current_cycle : 
  t ->
  Tez_repr.t
    Tezos_protocol_environment_012_Psithaca.Signature.Public_key_hash.Map.t
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val init_stake_distribution_for_current_cycle : 
  t ->
  Tez_repr.t
    Tezos_protocol_environment_012_Psithaca.Signature.Public_key_hash.Map.t ->
  t

Sourcemodule type CONSENSUS = sig ... end

Source

module Consensus : 
  CONSENSUS
    with type t := t
     and type slot := Slot_repr.t
     and type 'a slot_map := 'a Slot_repr.Map.t
     and type slot_set := Slot_repr.Set.t
     and type round := Round_repr.t

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-012-Psithaca.raw/Tezos_raw_protocol_012_Psithaca/Raw_context/index.html

Module `Tezos_raw_protocol_012_Psithaca.Raw_context`Source

Errors

Abstract Context

Generic accessors

Getters

Setters

Folds

package tezos-protocol-012-Psithaca

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-012-Psithaca.raw/Tezos_raw_protocol_012_Psithaca/Raw_context/index.html

Module Tezos_raw_protocol_012_Psithaca.Raw_contextSource

Errors

Abstract Context

Generic accessors

Getters

Setters

Folds

dune-project
Dependency

Module `Tezos_raw_protocol_012_Psithaca.Raw_context`Source