package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha libraries

Install

Dune Dependency

Authors

Maintainers

Sources

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

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

Module Context.DelegateSource

Sourcetype info = Tezos_protocol_alpha.Protocol.Delegate_services.info = {
  1. full_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  2. current_frozen_deposits : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  3. frozen_deposits : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  4. staking_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  5. frozen_deposits_limit : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option;
  6. delegated_contracts : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t list;
  7. delegated_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  8. total_delegated_stake : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  9. staking_denominator : Tezos_protocol_alpha.Protocol.Alpha_context.Staking_pseudotoken.t;
  10. deactivated : bool;
  11. grace_period : Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t;
  12. voting_info : Vote.delegate_info;
  13. active_consensus_key : Tezos_protocol_alpha.Environment.Signature.Public_key_hash.t;
  14. pending_consensus_keys : (Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t * Tezos_protocol_alpha.Environment.Signature.Public_key_hash.t) list;
}
Sourcetype stake = {
  1. frozen : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  2. weighted_delegated : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
}
Sourceval info : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Delegate_services.info Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval full_balance : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval current_frozen_deposits : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval initial_frozen_deposits : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t

calls the RPC frozen_deposits: we're using a different name to be more easily distinguishable from current_frozen_deposits

Sourceval staking_balance : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval staking_denominator : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Environment.Z.t Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval frozen_deposits_limit : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval deactivated : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> bool Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval voting_info : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Vote.delegate_info Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval consensus_key : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Delegate_services.consensus_keys_info Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval participation : t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_protocol_alpha.Protocol.Alpha_context.Delegate.participation_info Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
Sourceval is_forbidden : ?policy:Block.baker_policy -> t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> bool Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t

This function might begin constructing a block. Use policy to specify a valid baker for the new block (default By_round 0)

Sourceval stake_for_cycle : ?policy:Block.baker_policy -> t -> Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> stake Tezos_base.TzPervasives.tzresult Tezos_protocol_alpha.Environment.Lwt.t
OCaml

Innovation. Community. Security.