package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053
doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Staking/index.html
Module Tezos_raw_protocol_alpha.StakingSource
val stake :
Raw_context.t ->
for_next_cycle_use_only_after_slashing:bool ->
amount:[ `At_most of Tez_repr.t | `Exactly of Tez_repr.t ] ->
sender:Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
delegate:Tezos_protocol_environment_alpha.Signature.public_key_hash ->
(Raw_context.t * Receipt_repr.balance_updates)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tstake ctxt ~sender ~for_next_cycle_use_only_after_slashing ~delegate amount add amount as sender's stake to delegate.
If for_next_cycle_use_only_after_slashing is true, the implicit finalisation is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.
val request_unstake :
Raw_context.t ->
for_next_cycle_use_only_after_slashing:bool ->
sender_contract:Contract_repr.t ->
delegate:Tezos_protocol_environment_alpha.Signature.public_key_hash ->
Tez_repr.t ->
(Raw_context.t * Receipt_repr.balance_updates)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.trequest_unstake ctxt ~for_next_cycle_use_only_after_slashing ~sender_contract ~delegate amount records a request from sender_contract to unstake amount from delegate.
If for_next_cycle_use_only_after_slashing is true, the unstake request and the implicit finalisation is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.
val finalize_unstake :
Raw_context.t ->
for_next_cycle_use_only_after_slashing:bool ->
Contract_repr.t ->
(Raw_context.t * Receipt_repr.balance_updates)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tfinalize_unstake ctxt ~for_next_cycle_use_only_after_slashing contract performs the finalization of all unstake requests from contract that can be finalized. An unstake request can be finalized if it is old enough, specifically the requested amount must not be at stake anymore and must not be slashable anymore, i.e. after preserved_cycles + max_slashing_period after the request. Amounts are transferred from the contract's delegate (at request time) unstaked frozen deposits to contract's spendable balance, minus slashing the requested stake undergone in between.
If for_next_cycle_use_only_after_slashing is true, the finalization is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.
Staking can be either automated or manual. If Adaptive Issuance is enabled, staking must be manual.
val check_manual_staking_allowed :
Raw_context.t ->
unit Tezos_protocol_environment_alpha.Error_monad.tzresult