package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Random Generation
Entropy
Predefined nonce
Serializers

tezos-protocol-alpha

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Tezos_raw_protocol_alpha.Seed_repr`Source

Tezos Protocol Implementation - Random number generation

This is not expected to be a good cryptographic random number generator. In particular this is supposed to be used in situations where the seed is a globally known information.

The only expected property is: It should be difficult to find a seed such that the generated sequence is a given one.

Random Generation

Sourcetype t

The state of the random number generator

Sourcetype seed

A random seed, to derive random sequences from

Sourcetype sequence

A random sequence, to derive random values from

Source

type vdf_setup =
  Tezos_protocol_environment_alpha.Vdf.discriminant
  * Tezos_protocol_environment_alpha.Vdf.challenge

A VDF discriminant and challenge

Source

type vdf_solution =
  Tezos_protocol_environment_alpha.Vdf.result
  * Tezos_protocol_environment_alpha.Vdf.proof

A VDF result, to derive a seed from

Source

val pp_solution : 
  Tezos_protocol_environment_alpha.Format.formatter ->
  vdf_solution ->
  unit

Sourceval compare_vdf_solution : vdf_solution -> vdf_solution -> int

Compare only the first element of two vdf_solution, that are of Vdf.result.

Source

val generate_vdf_setup : 
  seed_discriminant:seed ->
  seed_challenge:seed ->
  vdf_setup

Source

val verify : 
  vdf_setup ->
  Tezos_protocol_environment_alpha.Int64.t ->
  vdf_solution ->
  bool option

Sourceval vdf_to_seed : seed -> vdf_solution -> seed

Sourceval initialize_new : seed -> bytes list -> t

initialize_new state ident returns a new generator

Sourceval sequence : t -> int32 -> sequence

sequence state n prepares the n-th sequence of a state

Sourceval take : sequence -> bytes * sequence

Generates the next random value in the sequence

Sourceval take_int32 : sequence -> int32 -> int32 * sequence

take_int32 s bound generates the next random value as a bounded int32

parameter bound
must be a positive integer

raises Invalid_argument
"Seed_repr.take_int32" if bound <= 0

Sourceval take_int64 : sequence -> int64 -> int64 * sequence

take_int64 s bound generates the next random value as a bounded int64

parameter bound
must be a positive integer

raises Invalid_argument
"Seed_repr.take_int64" if bound <= 0

Entropy

Sourcetype nonce

A nonce for adding entropy to the generator

Sourceval update_seed : seed -> nonce -> seed

Add entropy to the seed generator

Source

val make_nonce : 
  bytes ->
  nonce Tezos_protocol_environment_alpha.Error_monad.tzresult

Use a byte sequence as a nonce

Sourceval hash : nonce -> Nonce_hash.t

Compute the hash of a nonce

Sourceval check_hash : nonce -> Nonce_hash.t -> bool

check_hash nonce hash is true if the nonce correspond to the hash

Sourceval nonce_hash_key_part : Nonce_hash.t -> string list -> string list

For using nonce hashes as keys in the hierarchical database

Sourceval deterministic_seed : seed -> seed

Returns a new seed by hashing the one passed with a constant.

Sourceval initial_seeds : ?initial_seed:State_hash.t -> int -> seed list

initial_seeds n generates the first n seeds for which there are no nonces. The first seed is a constant value. The kth seed is the hash of seed (k-1) concatenated with a constant. If an initial_seed is provided, the first seed is created using it as the first one.

Predefined nonce

Sourceval initial_nonce_0 : nonce

Sourceval initial_nonce_hash_0 : Nonce_hash.t

Serializers

Sourceval nonce_encoding : nonce Tezos_protocol_environment_alpha.Data_encoding.t

Sourceval seed_encoding : seed Tezos_protocol_environment_alpha.Data_encoding.t

Source

val vdf_setup_encoding : 
  vdf_setup Tezos_protocol_environment_alpha.Data_encoding.t

Source

val vdf_solution_encoding : 
  vdf_solution Tezos_protocol_environment_alpha.Data_encoding.t

Sourcetype seed_status =

| RANDAO_seed
| VDF_seed

Source

val seed_status_encoding : 
  seed_status Tezos_protocol_environment_alpha.Data_encoding.t

package tezos-protocol-alpha

Module Tezos_raw_protocol_alpha.Seed_reprSource

Random Generation

Entropy

Predefined nonce

Serializers

Module `Tezos_raw_protocol_alpha.Seed_repr`Source