(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 Marigold <contact@marigold.dev>                        *)
(* Copyright (c) 2022 Nomadic Labs <contact@nomadic-labs.com>                *)
(* Copyright (c) 2022 Oxhead Alpha <info@oxhead-alpha.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 introduces the types used to identify ticket holders
    within a transaction rollup. *)

(** The hash of a BLS public key is used as the primary identifier
    of ticket holders within a transaction rollup. *)
include module type of Bls.Public_key_hash with type t = Bls.Public_key_hash.t

type address = t

(** [in_memory_size a] returns the number of bytes allocated in RAM for [a]. *)
val in_memory_size : t -> Cache_memory_helpers.sint

(** [size a] returns the number of bytes allocated in an inbox to store [a]. *)
val size : t -> int

module Indexable : sig
  type nonrec 'state t = ('state, address) Indexable.t

  type nonrec index = address Indexable.index

  type nonrec value = address Indexable.value

  type nonrec either = address Indexable.either

  val encoding : either Data_encoding.t

  val index_encoding : index Data_encoding.t

  val compare_values : value -> value -> int

  val value_encoding : value Data_encoding.t

  val compare : 'state t -> 'state' t -> int

  val value : address -> value

  val index : int32 -> index tzresult

  val index_exn : int32 -> index

  val pp : Format.formatter -> 'state t -> unit

  val size : 'state t -> int

  val in_memory_size : 'state t -> Cache_memory_helpers.sint
end