package tezos-protocol-alpha
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a
doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Raw_context/index.html
Module Tezos_raw_protocol_alpha.Raw_contextSource
State of the validation.
Two parts:
1. Context.t: what is stored between blocks, this includes an Irmin tree typically stored on disk and the cache (stored in RAM).
2. Additional information needed during the validation of a block but not persisted across blocks, always stored in RAM. The gas counter is here.
Alpha_context.t is actually implemented as Raw_context.t. The difference is that Alpha_context.mli does not expose this so functions manipulating an Alpha_context.t are guaranteed to only access the context through the storage modules exposed in Alpha_context.mli. These modules are in charge of maintaining invariants over the structure of the context.
Errors
type 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
type Tezos_protocol_environment_alpha.Error_monad.error += | Failed_to_decode_parameter of Tezos_protocol_environment_alpha.Data_encoding.json * string
Abstract Context
Abstract view of the context. Includes a handle to the functional key-value database (Context.t) along with some in-memory values (gas, etc.).
The internal message to be injected into the smart rollups’ shared inbox when validating the very first block of this protocol.
Serialized version of protocol_migration_internal_message.
val prepare :
level:Tezos_protocol_environment_alpha.Int32.t ->
predecessor_timestamp:Tezos_protocol_environment_alpha.Time.t ->
timestamp:Tezos_protocol_environment_alpha.Time.t ->
adaptive_issuance_enable:bool ->
Tezos_protocol_environment_alpha.Context.t ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tRetrieves 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.
val prepare_first_block :
level:int32 ->
timestamp:Tezos_protocol_environment_alpha.Time.t ->
Tezos_protocol_environment_alpha.Chain_id.t ->
Tezos_protocol_environment_alpha.Context.t ->
(previous_protocol * t) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tval activate :
t ->
Tezos_protocol_environment_alpha.Protocol_hash.t ->
t Tezos_protocol_environment_alpha.Lwt.tReturns the state of the database resulting of operations on its abstract view
val patch_constants :
t ->
(Constants_parametric_repr.t -> Constants_parametric_repr.t) ->
t Tezos_protocol_environment_alpha.Lwt.tRetrieve the cycle eras.
val credit_collected_fees_only_call_from_token :
t ->
Tez_repr.t ->
t Tezos_protocol_environment_alpha.Error_monad.tzresultIncrement the current block fee stash that will be credited to the payload producer's account at finalize_application
val spend_collected_fees_only_call_from_token :
t ->
Tez_repr.t ->
t Tezos_protocol_environment_alpha.Error_monad.tzresultDecrement the current block fee stash that will be credited to the payload producer's account at finalize_application
Returns the current block fee stash that will be credited to the payload producer's account at finalize_application
val consume_gas_limit_in_block :
t ->
'a Gas_limit_repr.Arith.t ->
t Tezos_protocol_environment_alpha.Error_monad.tzresultconsume_gas_limit_in_block ctxt gas_limit checks that gas_limit is well-formed (i.e. it does not exceed the hard gas limit per operation as defined in ctxt, and it is positive), then consumes gas_limit in the current block gas level of ctxt.
init_origination_nonce ctxt hash initialise the origination nonce in memory from hash. See Origination_nonce.t for more information.
val get_origination_nonce :
t ->
Origination_nonce.t Tezos_protocol_environment_alpha.Error_monad.tzresultval increment_origination_nonce :
t ->
(t * Origination_nonce.t)
Tezos_protocol_environment_alpha.Error_monad.tzresultunset_origination_nonce ctxt unset the origination nonce in memory. To be used only when no more origination can be done in that operation. See Origination_nonce.t for more information.
Generic accessors
include T with type t := t and type local_context := local_context
include Raw_context_intf.VIEW
with type key := key
with type value := value
with type tree := tree
with type t := t
Getters
mem t k is an Lwt promise that resolves to true iff k is bound to a value in t.
mem_tree t k is like mem but for trees.
val get :
t ->
key ->
value Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget 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.
val get_tree :
t ->
key ->
tree Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget_tree is like get but for trees.
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.
find_tree t k is like find but for trees.
val list :
t ->
?offset:int ->
?length:int ->
key ->
(string * tree) list Tezos_protocol_environment_alpha.Lwt.tlist 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
val init :
t ->
key ->
value ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tinit t k v is an Lwt promise that resolves to Ok c if:
kis unbound int;kis bound tovinc;- and
cis similar tototherwise.
It is Storage_errorExisting_key if k is already bound in t.
val init_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tinit_tree is like init but for trees.
val update :
t ->
key ->
value ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tupdate t k v is an Lwt promise that resolves to Ok c if:
kis bound int;kis bound tovinc;- and
cis similar tototherwise.
It is Storage_errorMissing_key if k is not already bound in t.
val update_tree :
t ->
key ->
tree ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tupdate_tree is like update but for trees.
add t k v is an Lwt promise that resolves to c such that:
kis bound tovinc;- and
cis similar tototherwise.
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.
add_tree is like add but for trees.
remove t k v is an Lwt promise that resolves to c such that:
kis unbound inc;- and
cis similar tototherwise.
val remove_existing :
t ->
key ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tremove_existing t k v is an Lwt promise that resolves to Ok c if:
kis bound intto a value;kis unbound inc;- and
cis similar tototherwise.
val remove_existing_tree :
t ->
key ->
t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tremove_existing_tree t k v is an Lwt promise that reolves to Ok c if:
kis bound intto a tree;kis unbound inc;- and
cis similar tototherwise.
add_or_remove t k v is:
add t k xifvisSome x;remove t kotherwise.
add_or_remove_tree t k v is:
add_tree t k xifvisSome x;remove t kotherwise.
Folds
val fold :
?depth:Raw_context_intf.depth ->
t ->
key ->
order:[ `Sorted | `Undefined ] ->
init:'a ->
f:(key -> tree -> 'a -> 'a Tezos_protocol_environment_alpha.Lwt.t) ->
'a Tezos_protocol_environment_alpha.Lwt.tfold ?depth t root ~order ~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.
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 dfolds over nodes and values of depth exactlyd.Lt dfolds over nodes and values of depth strictly less thand.Le dfolds over nodes and values of depth less than or equal tod.Gt dfolds over nodes and values of depth strictly more thand.Ge dfolds over nodes and values of depth more than or equal tod.
If order is `Sorted (the default), the elements are traversed in lexicographic order of their keys. For large nodes, it is memory-consuming, use `Undefined for a more memory efficient fold.
Hash configurations
config t is t's hash configuration.
length t key is an Lwt promise that resolves to the number of files and sub-nodes stored under k in t.
It is equivalent to list t k >|= List.length but has a constant-time complexity.
Most of the time, this function does not perform any I/O as the length is cached in the tree. It may perform one read to load the root node of the tree in case it has not been loaded already. The initial constant is the same between list and length. They both perform the same kind of I/O reads. While list usually performs a linear number of reads, length does at most one.
module Tree :
Raw_context_intf.TREE
with type t := t
and type key := key
and type value := value
and type tree := treeTree 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.
Proofs are compact representations of trees which can be shared between peers.
type ('proof, 'result) verifier :=
'proof ->
(tree -> (tree * 'result) Tezos_protocol_environment_alpha.Lwt.t) ->
(tree * 'result,
[ `Proof_mismatch of string
| `Stream_too_long of string
| `Stream_too_short of string ])
Tezos_protocol_environment_alpha.Pervasives.result
Tezos_protocol_environment_alpha.Lwt.tverify p f runs f in checking mode. f is a function that takes a tree as input and returns a new version of the tree and a result. p is a proof, that is a minimal representation of the tree that contains what f should be expecting.
Therefore, contrary to trees found in a storage, the contents of the trees passed to f may not be available. For this reason, looking up a value at some path can now produce three distinct outcomes:
- A value
vis present in the proofpand returned :find tree pathis a promise returningSome v; pathis known to have no value intree:find tree pathis a promise returningNone; andpathis known to have a value intreebutpdoes not provide it becausefshould not need it:verifyreturns an error classifyingpathas an invalid path (see below).
The same semantics apply to all operations on the tree t passed to f and on all operations on the trees built from f.
The generated tree is the tree after f has completed. That tree is disconnected from any storage (i.e. index). It is possible to run operations on it as long as they don't require loading shallowed subtrees.
The result is Error (`Msg _) if the proof is rejected:
- For tree proofs: when
p.beforeis different from the hash ofp.state; - For tree and stream proofs: when
p.afteris different from the hash off p.state; - For tree proofs: when
f p.statetries to access invalid paths inp.state; - For stream proofs: when the proof is not consumed in the exact same order it was produced;
- For stream proofs: when the proof is too short or not empty once
fis done.
type tree_proof := Proof.tree Proof.tThe type for tree proofs.
Guarantee that the given computation performs exactly the same state operations as the generating computation, *in some order*.
verify_tree_proof is the verifier of tree proofs.
type stream_proof := Proof.stream Proof.tThe type for stream proofs.
Guarantee that the given computation performs exactly the same state operations as the generating computation, in the exact same order.
verify_stream is the verifier of stream proofs.
The equality function for context configurations. If two context have the same configuration, they will generate the same context hashes.
Internally used in Storage_functors to escape from a view.
Internally used in Storage_functors to retrieve a full key from partial key relative a view.
Raised if block gas quota is exhausted during gas consumption.
Raised if operation gas quota is exhausted during gas consumption.
val consume_gas :
t ->
Gas_limit_repr.cost ->
t Tezos_protocol_environment_alpha.Error_monad.tzresultInternally used in Storage_functors to consume gas from within a view. May raise Block_quota_exceeded or Operation_quota_exceeded.
val check_enough_gas :
t ->
Gas_limit_repr.cost ->
unit Tezos_protocol_environment_alpha.Error_monad.tzresultCheck if consume_gas will fail
val with_local_context :
t ->
key ->
(local_context ->
(local_context * 'a) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t) ->
(t * 'a) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.twith_local_context ctxt key f runs function f over the local context at path key of the global ctxt. Using the local context f can perform faster context accesses under key.
Local_context provides functions for local access from a specific directory.
Initialize the local nonce used for preventing a script to duplicate an internal operation to replay it.
val fresh_internal_nonce :
t ->
(t * int) Tezos_protocol_environment_alpha.Error_monad.tzresultIncrements the internal operation nonce.
Check is the internal operation nonce has been taken.
val fold_map_temporary_lazy_storage_ids :
t ->
(Lazy_storage_kind.Temp_ids.t -> Lazy_storage_kind.Temp_ids.t * 'res) ->
t * 'resval map_temporary_lazy_storage_ids_s :
t ->
(Lazy_storage_kind.Temp_ids.t ->
(t * Lazy_storage_kind.Temp_ids.t) Tezos_protocol_environment_alpha.Lwt.t) ->
t Tezos_protocol_environment_alpha.Lwt.tval record_non_consensus_operation_hash :
t ->
Tezos_protocol_environment_alpha.Operation_hash.t ->
ttype consensus_pk = {delegate : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;consensus_pk : Tezos_protocol_environment_alpha.Signature.Public_key.t;consensus_pkh : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;
}Record that the dictator already voted in this block.
val init_sampler_for_cycle :
t ->
Cycle_repr.t ->
Seed_repr.seed ->
consensus_pk Sampler.t ->
t Tezos_protocol_environment_alpha.Error_monad.tzresultinit_sampler_for_cycle ctxt cycle seed state caches the seeded stake sampler (a.k.a. seed, state) for cycle in memory for quick access.
val sampler_for_cycle :
read:
(t ->
(Seed_repr.seed * consensus_pk Sampler.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t) ->
t ->
Cycle_repr.t ->
(t * Seed_repr.seed * consensus_pk Sampler.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tsampler_for_cycle ~read ctxt cycle returns the seeded stake sampler for cycle. The sampler is read in memory if init_sampler_for_cycle or sampler_for_cycle was previously called for the same cycle. Otherwise, it is read "on-disk" with the read function and then cached in ctxt like init_sampler_for_cycle.
val stake_distribution_for_current_cycle :
t ->
Stake_repr.t Tezos_protocol_environment_alpha.Signature.Public_key_hash.Map.t
Tezos_protocol_environment_alpha.Error_monad.tzresultval init_stake_distribution_for_current_cycle :
t ->
Stake_repr.t Tezos_protocol_environment_alpha.Signature.Public_key_hash.Map.t ->
tReturns the reward coefficient for the current cycle This value is equal to the value in Storage.Issuance_coeff if it exists, or equal to Q.one otherwise.
Updates the reward coefficient for the current cycle. This update should only be called once per cycle. It is done in Adaptive_issuance_storage
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
and type consensus_pk := consensus_pk