package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7062cd57addd452852598a2214ade393130efa087b99068d53713bdf912b3680
sha512=08e4091144a03ce3c107fb91a66501bd8b65ca3278917c455a2eaac6df3e108ade63f6ab8340a4bb152d60f404326e464d0ec95d26cafe8e82f870465d24a5fc
doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Seed_storage/index.html
Module Tezos_raw_protocol_alpha.Seed_storageSource
This modules handles the storage of random nonce seeds.
This module is responsible for maintaining the table Storage.Seed.For_cycle.
type seed_computation_status = | Nonce_revelation_stage| Vdf_revelation_stage of {seed_discriminant : Seed_repr.seed;seed_challenge : Seed_repr.seed;
}| Computation_finished
type Tezos_protocol_environment_alpha.Error_monad.error += | Unknown of {oldest : Cycle_repr.t;cycle : Cycle_repr.t;latest : Cycle_repr.t;
}| Already_accepted| Unverified_vdf| Too_early_revelation
val init :
?initial_seed:State_hash.t ->
Raw_context.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tGenerates the first preserved_cycles+2 seeds for which there are no nonces.
val check_vdf :
Raw_context.t ->
Seed_repr.vdf_solution ->
unit Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tVerifies if a VDF (result, proof) is valid.
val update_seed :
Raw_context.t ->
Seed_repr.vdf_solution ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tUpdates the seed with a function of the VDF result.
val raw_for_cycle :
Raw_context.t ->
Cycle_repr.t ->
Seed_repr.seed Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tReturns the seed associated with the given cycle. Returns a generic storage error when the seed is not available.
val for_cycle :
Raw_context.t ->
Cycle_repr.t ->
Seed_repr.seed Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tReturns the seed associated with the given cycle. Returns the Unknown error when the seed is not available.
val compute_randao :
Raw_context.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tComputes RANDAO output for cycle #(current_cycle + preserved + 1)
val cycle_end :
Raw_context.t ->
Cycle_repr.t ->
(Raw_context.t * Nonce_storage.unrevealed list)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tMust be run at the end of the cycle, resets the VDF state and returns unrevealed nonces to know which party has to forfeit its endorsing rewards for that cycle.
val get_seed_computation_status :
Raw_context.t ->
seed_computation_status Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tReturn the random seed computation status, that is whether the VDF computation period has started, and if so the information needed, or if it has finished for the current cycle.
val remove_for_cycle :
Raw_context.t ->
Cycle_repr.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tRemoves the seed associated with the given cycle from the storage. It assumes the seed exists. If it does not it returns a generic storage error.