package tezos-protocol-014-PtKathma

You can search for identifiers within the package.

in-package search v0.2.0

Tezos/Protocol: economic-protocol definition

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (8)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-16.1.tar.gz

sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7

sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f

doc/tezos-protocol-014-PtKathma.raw/Tezos_raw_protocol_014_PtKathma/Round_repr/Durations/index.html

Module `Round_repr.Durations`Source

Sourcetype t

round_durations represents the duration of rounds in seconds

Sourceval pp : Tezos_protocol_environment_014_PtKathma.Format.formatter -> t -> unit

Creation functions

Source

val create : 
  first_round_duration:Period_repr.t ->
  delay_increment_per_round:Period_repr.t ->
  t Tezos_protocol_environment_014_PtKathma.Error_monad.tzresult

create ~first_round_duration ~delay_increment_per_round creates a valid duration value

parameter first_round_duration
duration of round 0

parameter delay_increment_per_round
amount of time added in from one round duration to the duration of its next round

raises Invalid_argument
if
- first_round_duration <= 1; or
- delay_increment_per_round is <= 0

Source

val create_opt : 
  first_round_duration:Period_repr.t ->
  delay_increment_per_round:Period_repr.t ->
  t option

create_opt ~first_round_duration ~delay_increment_per_round returns a valid duration value Some d when create ~first_round_duration ~delay_increment_per_round does not fail. It returns None otherwise.

Sourceval encoding : t Tezos_protocol_environment_014_PtKathma.Data_encoding.encoding

Warning May trigger an exception when the expected invariant does not hold.

Accessors

Sourceval round_duration : t -> round -> Period_repr.t

round_duration round_durations ~round returns the duration of round ~round. This duration follows the arithmetic progression

duration(round_n) = first_round_duration + round_n * delay_increment_per_round

On This Page

Creation functions
Accessors