package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

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

Module Tezos_alpha_test_helpers.StateSource

Sourcetype double_signing_state = {
  1. culprit : Tezos_base.TzPervasives.Signature.Public_key_hash.t;
  2. evidence : Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation;
  3. denounced : bool;
  4. misbehaviour : Tezos_protocol_alpha.Protocol.Misbehaviour_repr.t;
}
Sourcetype t = {
  1. account_map : State_account.account_map;
  2. total_supply : Tezos_alpha_test_helpers.State_account.Tez.t;
  3. constants : Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.t;
  4. param_requests : (string * Adaptive_issuance_helpers.staking_parameters * int) list;
  5. force_ai_vote_yes : bool;
  6. baking_policy : Block.baker_policy option;
  7. last_level_rewards : Tezos_protocol_alpha.Protocol.Alpha_context.Raw_level.t;
  8. snapshot_balances : (string * State_account.balance) list Tezos_base.TzPervasives.String.Map.t;
  9. saved_rate : Q.t option;
  10. burn_rewards : bool;
  11. pending_operations : Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list;
  12. pending_slashes : (Tezos_base.TzPervasives.Signature.Public_key_hash.t * Tezos_protocol_alpha.Protocol.Denunciations_repr.item) list;
  13. double_signings : double_signing_state list;
  14. ai_activation_cycle : Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t option;
  15. force_attest_all : bool;
}

Type of the state

Sourceval param_wait : t -> int

Expected number of cycles before staking parameters get applied

Sourceval unstake_wait : t -> int

Expected number of cycles before staking unstaked funds get unfrozen

Sourceval find_account : string -> t -> State_account.account_state

From a name, returns the corresponding account

Sourceval find_account_from_pkh : Tezos_base.TzPervasives.Signature.public_key_hash -> t -> string * State_account.account_state
Sourceval is_self_delegate : string -> t -> bool

Returns true iff account is a delegate

Sourceval apply_transfer : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t -> Tezos_base.TzPervasives.String.Map.key -> Tezos_base.TzPervasives.String.Map.key -> t -> t
Sourceval apply_stake : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t -> Tezos_alpha_test_helpers.State_account.Cycle.cycle -> Tezos_base.TzPervasives.String.Map.key -> t -> t
Sourceval 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 -> t -> t
Sourceval apply_unslashable : Tezos_alpha_test_helpers.State_account.Cycle.cycle -> Tezos_base.TzPervasives.String.Map.key -> t -> t
Sourceval apply_unslashable_for_all : Tezos_alpha_test_helpers.State_account.Cycle.cycle -> t -> t
Sourceval apply_rewards : baker:string -> Block.t -> t -> t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval update_account : string -> State_account.account_state -> t -> t

Given an account name and new account state, updates state accordingly Preferably use other specific update functions

Sourceval update_delegate : string -> string option -> t -> t
Sourceval add_pending_operations : Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list -> t -> t
Sourceval pop_pending_operations : t -> t * Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list