stake_storage.mli
(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2021 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. *)
(* *)
(*****************************************************************************)
(** This module provides basic operations (accessors and setters) on
staking tokens.
It is responsible for maintaining the following tables:
- {!Storage.Stake.Selected_distribution_for_cycle}
- {!Storage.Stake.Staking_balance}
- {!Storage.Stake.Active_delegates_with_minimal_stake}
- {!Storage.Stake.Total_active_stake}
*)
val initialize_delegate :
Raw_context.t ->
Signature.public_key_hash ->
delegated:Tez_repr.t ->
Raw_context.t tzresult Lwt.t
val get_full_staking_balance :
Raw_context.t ->
Signature.public_key_hash ->
Full_staking_balance_repr.t tzresult Lwt.t
val remove_delegated_stake :
Raw_context.t ->
Signature.Public_key_hash.t ->
Tez_repr.t ->
Raw_context.t tzresult Lwt.t
val remove_frozen_stake_only_call_from_token :
Raw_context.t ->
Frozen_staker_repr.t ->
Tez_repr.t ->
Raw_context.t tzresult Lwt.t
val add_delegated_stake :
Raw_context.t ->
Signature.Public_key_hash.t ->
Tez_repr.t ->
Raw_context.t tzresult Lwt.t
val add_frozen_stake_only_call_from_token :
Raw_context.t ->
Frozen_staker_repr.t ->
Tez_repr.t ->
Raw_context.t tzresult Lwt.t
val set_inactive :
Raw_context.t -> Signature.Public_key_hash.t -> Raw_context.t Lwt.t
val set_active :
Raw_context.t -> Signature.Public_key_hash.t -> Raw_context.t tzresult Lwt.t
(** [fold ctxt ~f ~order init] folds [f] on the list of active delegates having the
minimal required stake. The folding process starts with [init]. Each element of the
list is the public key hash of a delegate. *)
val fold_on_active_delegates_with_minimal_stake_es :
Raw_context.t ->
f:(Signature.Public_key_hash.t -> 'a -> 'a tzresult Lwt.t) ->
order:[`Sorted | `Undefined] ->
init:'a ->
'a tzresult Lwt.t
(** [set_selected_distribution_for_cycle ctxt cycle distrib total_stake] saves
the selected distribution [distrib] of the [total_stake] for the given
[cycle]. *)
val set_selected_distribution_for_cycle :
Raw_context.t ->
Cycle_repr.t ->
(Signature.public_key_hash * Stake_repr.t) list ->
Stake_repr.t ->
Raw_context.t tzresult Lwt.t
val clear_at_cycle_end :
Raw_context.t -> new_cycle:Cycle_repr.t -> Raw_context.t tzresult Lwt.t
val fold_on_active_delegates_with_minimal_stake_s :
Raw_context.t ->
order:[`Sorted | `Undefined] ->
init:'a ->
f:(Signature.Public_key_hash.t -> 'a -> 'a Lwt.t) ->
'a Lwt.t
val get_selected_distribution :
Raw_context.t ->
Cycle_repr.t ->
(Signature.Public_key_hash.t * Stake_repr.t) list tzresult Lwt.t
val find_selected_distribution :
Raw_context.t ->
Cycle_repr.t ->
(Signature.Public_key_hash.t * Stake_repr.t) list option tzresult Lwt.t
val get_selected_distribution_as_map :
Raw_context.t ->
Cycle_repr.t ->
Stake_repr.t Signature.Public_key_hash.Map.t tzresult Lwt.t
(** Copy the stake distribution for the current cycle (from
[Storage.Stake.Selected_distribution_for_cycle]) in the raw
context. *)
val prepare_stake_distribution : Raw_context.t -> Raw_context.t tzresult Lwt.t
(** [get_total_active_stake ctxt cycle] retrieves the amount in Tez of the
active stake at [cycle] from [ctxt]. *)
val get_total_active_stake :
Raw_context.t -> Cycle_repr.t -> Stake_repr.t tzresult Lwt.t
(** [add_contract_delegated_stake ctxt contract amount] calls
[Stake_storage.add_delegated_stake ctxt delegate amount] if
[contract] has a [delegate]. Otherwise this function does
nothing. *)
val add_contract_delegated_stake :
Raw_context.t -> Contract_repr.t -> Tez_repr.t -> Raw_context.t tzresult Lwt.t
(** [remove_contract_delegated_stake ctxt contract amount] calls
[Stake_storage.remove_delegated_stake ctxt delegate amount] if
[contract] has a [delegate]. Otherwise this function does
nothing. *)
val remove_contract_delegated_stake :
Raw_context.t -> Contract_repr.t -> Tez_repr.t -> Raw_context.t tzresult Lwt.t
val cleanup_values_for_protocol_p :
Raw_context.t ->
preserved_cycles:int ->
consensus_rights_delay:int ->
new_cycle:Cycle_repr.t ->
Raw_context.t tzresult Lwt.t
module For_RPC : sig
val get_staking_balance :
Raw_context.t -> Signature.Public_key_hash.t -> Tez_repr.t tzresult Lwt.t
end
module Internal_for_tests : sig
(** Same as [get_staking_balance] but returns zero if the argument
is not an active delegate above minimal stake. *)
val get :
Raw_context.t -> Signature.Public_key_hash.t -> Tez_repr.t tzresult Lwt.t
end
