Module Tezos_alpha_test_helpers.State_account

State_account is dedicated to operations in State.t that would modify an account_state. This includes any operation like transfer, stake, unstake, set_delegate_parameters, anything related to slashing or rewards, etc...

include module type of struct include Tez_staking_helpers end
module Partial_tez = Tez_staking_helpers.Partial_tez

Representation of Tez with non integer values

module Frozen_tez = Tez_staking_helpers.Frozen_tez

Frozen_tez represents frozen stake and frozen unstaked funds. Properties:

module Unstaked_frozen = Tez_staking_helpers.Unstaked_frozen

Representation of Unstaked frozen deposits

module Unstaked_finalizable = Tez_staking_helpers.Unstaked_finalizable

Representation of unstaked finalizable tez

val tez_to_pseudo : round:[ `Down | `Up ] -> Tez.t -> Z.t -> Frozen_tez.t -> Z.t

Pseudotoken helpers

val pseudo_to_partial_tez : Z.t -> Z.t -> Frozen_tez.t -> Q.t
val stake_values_real : Tez.t -> Z.t -> Frozen_tez.t -> Z.t * Q.t
val unstake_values_real : Tez.t -> Z.t -> Frozen_tez.t -> Z.t * Q.t
include module type of struct include Account_helpers end
val fail_account_not_found : string -> string -> 'a
module CycleMap = Account_helpers.CycleMap
type account_state = Account_helpers.account_state = {
  1. pkh : Tezos_alpha_test_helpers.Signature.Public_key_hash.t;
  2. contract : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t;
  3. revealed : bool;
  4. delegate : string option;
  5. parameters : Adaptive_issuance_helpers.staking_parameters;
  6. liquid : Tez_staking_helpers.Tez.t;
  7. bonds : Tez_staking_helpers.Tez.t;
  8. frozen_deposits : Tez_staking_helpers.Frozen_tez.t;
  9. unstaked_frozen : Tez_staking_helpers.Unstaked_frozen.t;
  10. unstaked_finalizable : Tez_staking_helpers.Unstaked_finalizable.t;
  11. staking_delegator_numerator : Z.t;
  12. staking_delegate_denominator : Z.t;
  13. frozen_rights : Tez_staking_helpers.Tez.t CycleMap.t;
    (*

    The portion of rights that comes from staking, used for baking/attesting during the specified cycle.

    At the end of cycle c, the current frozen deposits of the delegate (own + co-staked, taking limit_of_staking_over_baking into account) are added to this table for cycle c + consensus_rights_delay + 1. The table is unmodified if at that time, the account is not a delegate or is a deactivated delegate.

    *)
  14. slashed_cycles : Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t list;
  15. last_seen_activity : Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t option;
  16. consensus_keys : Signature.public_key_hash CycleMap.t;
  17. companion_keys : Tezos_alpha_test_helpers.Signature.Bls.Public_key_hash.t CycleMap.t;
}

Abstract information of accounts

val init_account : name:Tezos_base.TzPervasives.String.Map.key -> ?delegate:string -> pkh:Tezos_alpha_test_helpers.Signature.Public_key_hash.t -> contract:Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> parameters:Adaptive_issuance_helpers.staking_parameters -> ?liquid:Tez_staking_helpers.Tez.t -> ?bonds:Tez_staking_helpers.Tez.t -> ?frozen_deposits:Tez_staking_helpers.Frozen_tez.t -> ?revealed:bool -> ?unstaked_frozen:Tez_staking_helpers.Unstaked_frozen.t -> ?unstaked_finalizable:Tez_staking_helpers.Unstaked_finalizable.t -> ?staking_delegator_numerator:Z.t -> ?staking_delegate_denominator:Z.t -> ?frozen_rights:Tez_staking_helpers.Tez.t CycleMap.t -> ?slashed_cycles:Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t list -> ?last_seen_activity:Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t -> unit -> account_state
type balance = Account_helpers.balance = {
  1. liquid_b : Tez_staking_helpers.Tez.t;
  2. bonds_b : Tez_staking_helpers.Tez.t;
  3. staked_b : Tez_staking_helpers.Partial_tez.t;
  4. unstaked_frozen_b : Tez_staking_helpers.Tez.t;
  5. unstaked_finalizable_b : Tez_staking_helpers.Tez.t;
  6. staking_delegator_numerator_b : Z.t;
  7. staking_delegate_denominator_b : Z.t;
}

Balance returned by RPCs. Partial tez are rounded down

val balance_zero : balance
val balance_pp : Stdlib.Format.formatter -> balance -> unit
val balance_update_pp : Stdlib.Format.formatter -> (balance * balance) -> unit
val assert_balance_equal : loc:string -> string -> balance -> balance -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val balance_and_total_balance_of_account : Tezos_base.TzPervasives.String.Map.key -> account_map -> balance * Tez_staking_helpers.Tez.t
val assert_pseudotokens_consistency : loc:string -> balance -> account_state -> string -> account_state Tezos_base.TzPervasives.String.Map.t -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val get_balance_from_context : Tezos_alpha_test_helpers__Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> (balance * Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val assert_balance_check : loc:string -> Tezos_alpha_test_helpers__Context.t -> Tezos_base.TzPervasives.String.Map.key -> account_state Tezos_base.TzPervasives.String.Map.t -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t
val log_debug_balance : Tezos_base.TzPervasives.String.Map.key -> account_map -> unit
val log_debug_balance_update : Tezos_base.TzPervasives.String.Map.key -> account_map -> account_map -> unit
val current_total_frozen_deposits_with_limits : account_state -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t
val assert_balance_evolution : loc:string -> for_accounts:Tezos_base.TzPervasives.String.t list -> part:[< `liquid | `staked | `unstaked_finalizable | `unstaked_frozen ] -> name:Tezos_base.TzPervasives.String.t -> old_balance:balance -> new_balance:balance -> (Tez_staking_helpers.Partial_tez.t -> Tez_staking_helpers.Partial_tez.t -> bool) -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val pp_ck_map : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a CycleMap.t -> unit

Compute the staking rights for current_cycle + consensus_rights_delay + 1 and save them into account.frozen_rights for each delegate.