package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type
type kind =
  1. | Proposal
    (*

    protocols can be proposed

    *)
  2. | Exploration
    (*

    a proposal can be voted

    *)
  3. | Cooldown
    (*

    a delay before the second vote of the Promotion period.

    *)
  4. | Promotion
    (*

    activation can be voted

    *)
  5. | Adoption
    (*

    a delay before activation

    *)

The voting period kinds are ordered as follows: Proposal -> Testing_vote -> Testing -> Promotion -> Adoption. This order is the one used be the function succ below.

val kind_encoding : kind Data_encoding.t
type voting_period = {
  1. index : int32;
  2. kind : kind;
  3. start_position : int32;
}

A voting period can be of several kinds and is uniquely identified by the counter 'index'. The 'start_position' represents the relative position of the first level of the period with respect to the first level of the Alpha family of protocols.

type t = voting_period
type info = {
  1. voting_period : t;
  2. position : int32;
  3. remaining : int32;
}

Information about a block with respect to the voting period it belongs to: the voting period, the position within the voting period and the number of remaining blocks till the end of the period. The following invariant is satisfied: `position + remaining + 1 = blocks_per_voting_period`

val root : start_position:int32 -> t
val (=) : voting_period -> voting_period -> bool
val (<>) : voting_period -> voting_period -> bool
val (<) : voting_period -> voting_period -> bool
val (<=) : voting_period -> voting_period -> bool
val (>=) : voting_period -> voting_period -> bool
val (>) : voting_period -> voting_period -> bool
val compare : voting_period -> voting_period -> int
val equal : voting_period -> voting_period -> bool
val encoding : t Data_encoding.t
val info_encoding : info Data_encoding.t
val pp : Stdlib.Format.formatter -> t -> unit
val pp_info : Stdlib.Format.formatter -> info -> unit
val pp_kind : Stdlib.Format.formatter -> kind -> unit
val raw_reset : t -> start_position:int32 -> t

raw_reset period ~start_position increment the index by one and set the kind to Proposal which is the period kind that start the voting process. start_position is the level at wich this voting_period started.

val raw_succ : t -> start_position:int32 -> t

raw_succ period ~start_position increment the index by one and set the kind to its successor. start_position is the level at which this voting_period started.

val position_since : Level_repr.t -> t -> int32
val remaining_blocks : Level_repr.t -> t -> blocks_per_voting_period:int32 -> int32
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct