(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

val current : Raw_context.t -> Level_repr.t

val previous : Raw_context.t -> Level_repr.t

val root : Raw_context.t -> Level_repr.t

val from_raw : Raw_context.t -> Raw_level_repr.t -> Level_repr.t

(**  Fails with [Negative_level_and_offset_sum] if the sum of the raw_level and the offset is negative. *)
val from_raw_with_offset :
  Raw_context.t -> offset:int32 -> Raw_level_repr.t -> Level_repr.t tzresult

(** When the given level is two or above, return its predecessor. When
    the given level is one or less, return [None] (because we cannot
    build the [Level_repr.t] for level zero). *)
val pred : Raw_context.t -> Level_repr.t -> Level_repr.t option

val succ : Raw_context.t -> Level_repr.t -> Level_repr.t

(** [i] must be positive *)
val add : Raw_context.t -> Level_repr.t -> int -> Level_repr.t

(** [sub c level i] returns None if the level is before the first
   level of the Alpha family of protocol, otherwise it returns the
   expected level. [i] must be positive. *)
val sub : Raw_context.t -> Level_repr.t -> int -> Level_repr.t option

val first_level_in_cycle : Raw_context.t -> Cycle_repr.t -> Level_repr.t

val last_level_in_cycle : Raw_context.t -> Cycle_repr.t -> Level_repr.t

val levels_in_cycle : Raw_context.t -> Cycle_repr.t -> Level_repr.t list

val levels_in_current_cycle :
  Raw_context.t -> ?offset:int32 -> unit -> Level_repr.t list

val levels_with_commitments_in_cycle :
  Raw_context.t -> Cycle_repr.t -> Level_repr.t list

val last_allowed_fork_level : Raw_context.t -> Raw_level_repr.t

(** Returns [Some cycle] if the current level represents the last
   level of [cycle] and [None] if the level is not the last level of a
   cycle. *)
val dawn_of_a_new_cycle : Raw_context.t -> Cycle_repr.t option

(** Returns [true] if the stake distribution should be snapshot at the current
   level. *)
val may_snapshot_stake_distribution : Raw_context.t -> bool

(** Returns [true] if RANDAO should be computed at the current level, that is
    if the current level, relative to the cycle's start, equals the nonce
    revelation period cut-off. *)
val may_compute_randao : Raw_context.t -> bool