package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type
type balance =
  1. | Contract of Contract_repr.t
  2. | Block_fees
  3. | Deposits of Tezos_protocol_environment_alpha.Signature.Public_key_hash.t
  4. | Nonce_revelation_rewards
  5. | Double_signing_evidence_rewards
  6. | Endorsing_rewards
  7. | Baking_rewards
  8. | Baking_bonuses
  9. | Storage_fees
  10. | Double_signing_punishments
  11. | Lost_endorsing_rewards of Tezos_protocol_environment_alpha.Signature.Public_key_hash.t * bool * bool
  12. | Liquidity_baking_subsidies
  13. | Burned
  14. | Commitments of Blinded_public_key_hash.t
  15. | Bootstrap
  16. | Invoice
  17. | Initial_commitments
  18. | Minted
  19. | Frozen_bonds of Contract_repr.t * Bond_id_repr.t
  20. | Tx_rollup_rejection_punishments
  21. | Tx_rollup_rejection_rewards
  22. | Sc_rollup_refutation_punishments
  23. | Sc_rollup_refutation_rewards

Places where tez can be found in the ledger's state.

val compare_balance : balance -> balance -> int

Compares two balances.

type balance_update =
  1. | Debited of Tez_repr.t
  2. | Credited of Tez_repr.t

A credit or debit of tez to a balance.

type update_origin =
  1. | Block_application
    (*

    Update from a block application

    *)
  2. | Protocol_migration
    (*

    Update from a protocol migration

    *)
  3. | Subsidy
    (*

    Update from an inflationary subsidy

    *)
  4. | Simulation
    (*

    Simulation of an operation *

    *)

An origin of a balance update

val compare_update_origin : update_origin -> update_origin -> int

Compares two origins.

type balance_updates = (balance * balance_update * update_origin) list

A list of balance updates. Duplicates may happen. For example, an entry of the form (Rewards (b,c), Credited am, ...) indicates that the balance of frozen rewards has been increased by am for baker b and cycle c.

The property Json.destruct (Json.construct balance_updates) = balance_updates does not always hold for balance_updates_encoding when balance_updates contains entries of the form (_, _ Tez_repr.zero, _). This is because the balance_update (_ Tez_repr.zero) always decodes into (Credited Tez_repr.zero).

Group updates by (balance x origin), and remove zero-valued balances.

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