(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2023 Nomadic Labs, <contact@nomadic-labs.com>               *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(** [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.

 *)
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:Signature.Public_key_hash.t ->
  delegate:Signature.public_key_hash ->
  (Raw_context.t * Receipt_repr.balance_updates) tzresult Lwt.t

(** [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.  *)
val request_unstake :
  Raw_context.t ->
  for_next_cycle_use_only_after_slashing:bool ->
  sender_contract:Contract_repr.t ->
  delegate:Signature.public_key_hash ->
  Tez_repr.t ->
  (Raw_context.t * Receipt_repr.balance_updates) tzresult Lwt.t

(** [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 [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.*)
val finalize_unstake :
  Raw_context.t ->
  for_next_cycle_use_only_after_slashing:bool ->
  Contract_repr.t ->
  (Raw_context.t * Receipt_repr.balance_updates) tzresult Lwt.t

(** Staking can be either automated or manual. If Adaptive Issuance is
    enabled, staking must be manual. *)
type staking_automation = Auto_staking | Manual_staking

val staking_automation : Raw_context.t -> staking_automation

val check_manual_staking_allowed : Raw_context.t -> unit tzresult