Module `Tezos_alpha_test_helpers.State_account`Source

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

Sourcemodule Cycle = Tez_staking_helpers.Cycle

Sourcemodule Tez = Tez_staking_helpers.Tez

Sourcemodule Partial_tez = Tez_staking_helpers.Partial_tez

Representation of Tez with non integer values

Sourcemodule Frozen_tez = Tez_staking_helpers.Frozen_tez

Frozen_tez represents frozen stake and frozen unstaked funds. Properties:

Sourcemodule Unstaked_frozen = Tez_staking_helpers.Unstaked_frozen

Representation of Unstaked frozen deposits

Sourcemodule Unstaked_finalizable = Tez_staking_helpers.Unstaked_finalizable

Representation of unstaked finalizable tez

Source

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

Pseudotoken helpers

Sourceval pseudo_to_partial_tez : Z.t -> Z.t -> Frozen_tez.t -> Q.t

Sourceval stake_values_real : Tez.t -> Z.t -> Frozen_tez.t -> Z.t * Q.t

Sourceval unstake_values_real : Tez.t -> Z.t -> Frozen_tez.t -> Z.t * Q.t

include module type of struct include Account_helpers end

Sourceval fail_account_not_found : string -> string -> 'a

Sourcemodule CycleMap = Account_helpers.CycleMap

Sourcetype account_state = Account_helpers.account_state = {

pkh : Tezos_base.TzPervasives.Signature.Public_key_hash.t;
contract : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t;
delegate : string option;
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;
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;
(*
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.
*)
slashed_cycles : Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t list;
last_active_cycle : Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.t;

}

Abstract information of accounts

Source

val init_account : 
  ?delegate:string ->
  pkh:Tezos_base.TzPervasives.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 ->
  ?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_active_cycle:Tezos_alpha_test_helpers.Tez_staking_helpers.Cycle.cycle ->
  unit ->
  account_state

Sourcetype account_map = account_state Tezos_base.TzPervasives.String.Map.t

Sourcetype balance = Account_helpers.balance = {

liquid_b : Tez_staking_helpers.Tez.t;
bonds_b : Tez_staking_helpers.Tez.t;
staked_b : Tez_staking_helpers.Partial_tez.t;
unstaked_frozen_b : Tez_staking_helpers.Tez.t;
unstaked_finalizable_b : Tez_staking_helpers.Tez.t;
staking_delegator_numerator_b : Z.t;
staking_delegate_denominator_b : Z.t;

}

Balance returned by RPCs. Partial tez are rounded down

Sourceval balance_zero : balance

Source

val balance_of_account : 
  Tezos_base.TzPervasives.String.Map.key ->
  account_map ->
  balance

Sourceval balance_pp : Format.formatter -> balance -> unit

Sourceval balance_update_pp : Format.formatter -> (balance * balance) -> unit

Source

val assert_balance_equal : 
  loc:string ->
  string ->
  balance ->
  balance ->
  (unit, Tezos_base.TzPervasives.tztrace) result Lwt.t

Source

val update_account : 
  f:('a -> 'a) ->
  Tezos_base.TzPervasives.String.Map.key ->
  'a Tezos_base.TzPervasives.String.Map.t ->
  'a Tezos_base.TzPervasives.String.Map.t

Source

val balance_and_total_balance_of_account : 
  Tezos_base.TzPervasives.String.Map.key ->
  account_map ->
  balance * Tez_staking_helpers.Tez.t

Source

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

Source

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)
    result
    Lwt.t

Source

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) result Lwt.t

Source

val log_debug_balance : 
  Tezos_base.TzPervasives.String.Map.key ->
  account_map ->
  unit

Source

val log_debug_rpc_balance : 
  string ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t ->
  Block.t ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

Source

val log_debug_balance_update : 
  Tezos_base.TzPervasives.String.Map.key ->
  account_map ->
  account_map ->
  unit

Source

val current_total_frozen_deposits_with_limits : 
  account_state ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t

Source

val add_liquid_rewards : 
  Tez.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val add_frozen_rewards : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_burn : 
  Tez.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_transfer : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val stake_from_unstake : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  Cycle.cycle ->
  int ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t
  * Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t

Source

val apply_stake : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  Cycle.cycle ->
  int ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_unstake : 
  Tezos_alpha_test_helpers__Tez_staking_helpers.Cycle.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_unslashable_f : 
  Tezos_alpha_test_helpers__Tez_staking_helpers.Cycle.t ->
  account_state ->
  account_state

Source

val apply_unslashable : 
  Tezos_alpha_test_helpers__Tez_staking_helpers.Cycle.t ->
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_unslashable_for_all : 
  Tezos_alpha_test_helpers__Tez_staking_helpers.Cycle.t ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val apply_finalize : 
  Tezos_base.TzPervasives.String.Map.key ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  account_state Tezos_base.TzPervasives.String.Map.t

Source

val compute_future_frozen_rights : 
  Block.block ->
  account_state Tezos_base.TzPervasives.String.Map.t ->
  (account_state Tezos_base.TzPervasives.String.Map.t,
    Tezos_base.TzPervasives.tztrace)
    result
    Lwt.t

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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/State_account/index.html

Module `Tezos_alpha_test_helpers.State_account`Source

package octez-protocol-alpha-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/State_account/index.html

Module Tezos_alpha_test_helpers.State_accountSource

Module `Tezos_alpha_test_helpers.State_account`Source