Module Mavryk_raw_protocol_alpha.Staking

stake 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.

request_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.

finalize_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 consensus_rights_delay + 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.

type staking_automation =
  1. | Auto_staking
  2. | Manual_staking

Staking can be either automated or manual. If Adaptive Issuance is enabled, staking must be manual.

val staking_automation : Raw_context.t -> staking_automation