package octez-protocol-alpha-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65
doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/State_account/index.html
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
Representation of Tez with non integer values
Frozen_tez
represents frozen stake and frozen unstaked funds. Properties:
Representation of Unstaked frozen deposits
Representation of unstaked finalizable tez
Pseudotoken helpers
include module type of struct include Account_helpers end
type 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 cyclec + 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
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
type 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
val assert_balance_equal :
loc:string ->
string ->
balance ->
balance ->
(unit, Tezos_base.TzPervasives.tztrace) result Lwt.t
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
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)
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) result Lwt.t
val log_debug_rpc_balance :
string ->
Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t ->
Block.t ->
unit Tezos_base.TzPervasives.tzresult Lwt.t
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 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
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
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
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
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
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
val apply_unslashable_f :
Tezos_alpha_test_helpers__Tez_staking_helpers.Cycle.t ->
account_state ->
account_state
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
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
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.