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

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

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

Module Tezos_alpha_test_helpers.Adaptive_issuance_helpersSource

Sourceval join_errors : (unit, 'a list) result -> (unit, 'a list) result -> (unit, 'a list) result Lwt.t
Sourcemodule Tez : sig ... end

Tez manipulation module

Sourcemodule Partial_tez : sig ... end

Representation of Tez with non integer values

Sourcemodule Cycle = Tezos_protocol_alpha.Protocol.Alpha_context.Cycle
Sourcemodule Frozen_tez : sig ... end

Frozen_tez represents frozen stake and frozen unstaked funds. Properties:

Sourcemodule Unstaked_frozen : sig ... end

Representation of Unstaked frozen deposits

Sourcemodule Unstaked_finalizable : sig ... end

Representation of unstaked finalizable tez

Sourcetype staking_parameters = {
  1. limit_of_staking_over_baking : Q.t;
  2. edge_of_baking_over_staking : Q.t;
}

Abstraction of the staking parameters for tests

Sourcemodule CycleMap : sig ... end
Sourcetype account_state = {
  1. pkh : Tezos_base.TzPervasives.Signature.Public_key_hash.t;
  2. contract : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t;
  3. delegate : string option;
  4. parameters : staking_parameters;
  5. liquid : Tez.t;
  6. bonds : Tez.t;
  7. frozen_deposits : Frozen_tez.t;
  8. unstaked_frozen : Unstaked_frozen.t;
  9. unstaked_finalizable : Unstaked_finalizable.t;
  10. staking_delegator_numerator : Z.t;
  11. staking_delegate_denominator : Z.t;
  12. frozen_rights : Tez.t CycleMap.t;
  13. slashed_cycles : Cycle.t list;
}

Abstract information of accounts

Sourceval init_account : ?delegate:string -> pkh:Tezos_base.TzPervasives.Signature.Public_key_hash.t -> contract:Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> parameters:staking_parameters -> ?liquid:Tez.t -> ?bonds:Tez.t -> ?frozen_deposits:Frozen_tez.t -> ?unstaked_frozen:Unstaked_frozen.t -> ?unstaked_finalizable:Unstaked_finalizable.t -> ?staking_delegator_numerator:Z.t -> ?staking_delegate_denominator:Z.t -> ?frozen_rights:Tez.t CycleMap.t -> ?slashed_cycles:Cycle.t list -> unit -> account_state
Sourcetype balance = {
  1. liquid_b : Tez.t;
  2. bonds_b : Tez.t;
  3. staked_b : Partial_tez.t;
  4. unstaked_frozen_b : Tez.t;
  5. unstaked_finalizable_b : 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

Sourceval balance_zero : balance
Sourceval balance_pp : Format.formatter -> balance -> unit
Sourceval balance_update_pp : Format.formatter -> (balance * balance) -> unit
Sourceval assert_balance_equal : loc:string -> string -> balance -> balance -> (unit, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval apply_unslashable_f : Cycle.t -> account_state -> account_state
Sourceval balance_and_total_balance_of_account : Tezos_base.TzPervasives.String.Map.key -> account_map -> balance * Tez.t
Sourceval apply_slashing : (Tezos_base.TzPervasives.Signature.Public_key_hash.t * Tezos_protocol_alpha.Protocol.Denunciations_repr.item) -> Cycle.cycle -> Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.t -> account_state Tezos_base.TzPervasives.String.Map.t -> account_state Tezos_base.TzPervasives.String.Map.t * Tez.t
Sourceval 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
Sourceval 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
Sourceval get_launch_cycle : loc:string -> Block.t -> (Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t, Tezos_base.TzPervasives.tztrace) result Lwt.t

AI operations

Sourceval stake : Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval set_delegate_parameters : Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> parameters:staking_parameters -> Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval unstake : Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval finalize_unstake : Context.t -> ?amount:Tez.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval portion_of_rewards_to_liquid_for_cycle : ?policy:Block.baker_policy -> Tezos_alpha_test_helpers__Context.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tez.t -> (Tez.t, Tezos_base.TzPervasives.tztrace) result Lwt.t