package octez-protocol-020-PsParisC-libs

  1. Overview
  2. Docs
Octez protocol 020-PsParisC libraries

Install

Dune Dependency

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

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-020-PsParisC-libs.test-helpers/Tezos_020_PsParisC_test_helpers/Adaptive_issuance_helpers/index.html

Module Tezos_020_PsParisC_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_020_PsParisC.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_020_PsParisC.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_020_PsParisC.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_020_PsParisC.Protocol.Denunciations_repr.item) -> Tezos_protocol_020_PsParisC.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_020_PsParisC_test_helpers__Context.t -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t -> (balance * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval assert_balance_check : loc:string -> Tezos_020_PsParisC_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_020_PsParisC.Protocol.Alpha_context.Cycle.t, Tezos_base.TzPervasives.tztrace) result Lwt.t

AI operations

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

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct