Seed_storage (mavryk-protocol-001-PtAtLas.Mavryk_raw_protocol_001_PtAtLas.Seed

type seed_computation_status =

| Nonce_revelation_stage
| Vdf_revelation_stage of {
1. seed_discriminant : Seed_repr.seed;
2. seed_challenge : Seed_repr.seed;
}
| Computation_finished

type Mavryk_protocol_environment_001_PtAtLas.Error_monad.error +=

| Unknown of {
1. oldest : Cycle_repr.t;
2. cycle : Cycle_repr.t;
3. latest : Cycle_repr.t;
}
| Already_accepted
| Unverified_vdf
| Too_early_revelation

val init : 
  ?initial_seed:State_hash.t ->
  Raw_context.t ->
  Raw_context.t Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Generates the first preserved_cycles+2 seeds for which there are no nonces.

val check_vdf : 
  Raw_context.t ->
  Seed_repr.vdf_solution ->
  unit Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Verifies if a VDF (result, proof) is valid.

returns
Error Too_early_revelation if the nonce revelation threshold is greater than the current level cycle position.

returns
Error Already_accepted if a VDF seed has already been recorded.

returns
Error Unverified_vdf if the Seed_repr.vdf_solution is not verified.

val update_seed : 
  Raw_context.t ->
  Seed_repr.vdf_solution ->
  Raw_context.t Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Updates the seed with a function of the VDF result.

val raw_for_cycle : 
  Raw_context.t ->
  Cycle_repr.t ->
  Seed_repr.seed Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Returns 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 Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Returns 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 Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Computes RANDAO output for cycle #(current_cycle + preserved + 1)

val cycle_end : 
  Raw_context.t ->
  Cycle_repr.t ->
  (Raw_context.t * Nonce_storage.unrevealed list)
    Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Must be run at the end of the cycle, resets the VDF state and returns unrevealed nonces to know which party has to forfeit its attesting rewards for that cycle.

val get_seed_computation_status : 
  Raw_context.t ->
  seed_computation_status
    Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Return 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 Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
    Mavryk_protocol_environment_001_PtAtLas.Lwt.t

Removes 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.