package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type
type reward_kind =
  1. | Baking_reward_fixed_portion
  2. | Baking_reward_bonus_per_slot
  3. | Attesting_reward_per_slot
  4. | Liquidity_baking_subsidy
  5. | Seed_nonce_revelation_tip
  6. | Vdf_revelation_tip
val reward_from_constants : ?coeff:Tezos_protocol_environment_alpha.Q.t -> Constants.Parametric.t -> reward_kind:reward_kind -> Tez.t

reward_from_constants ~coeff csts ~reward_kind returns the amount of rewards in Tez.t for the given reward_kind, according to the given parameters in csts. The (optional) value coeff is a multiplicative factor applied to the rewards (default = 1). It verifies reward_from_constants ~coeff csts ~reward_kind = coeff * reward_from_constants csts ~reward_kind.

get_reward_coeff ctxt cycle reads the reward coeff for the given cycle from the storage. Returns Q.one if the given cycle is not between current_cycle and current_cycle + preserved_cycles. If adaptive issuance has not been activated, or has been activated and the given cycle is less than preserved_cycles after the activation cycle, then this function returns Q.one. Used only for RPCs. To get the actual rewards, use the reward functions defined above.

get_reward_bonus ctxt cycle reads the reward bonus for the given cycle from the storage. If cycle is None, returns 0.

Returns 0 if the given cycle is not between current_cycle and current_cycle + preserved_cycles.

If adaptive issuance has not been activated, then this function returns 0. Used only for RPCs. To get the actual rewards, use Delegate_rewards.

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