Raw File
ticket_token.mli
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2021 Trili Tech, <contact@trili.tech>                       *)
(*                                                                           *)
(* 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

open Alpha_context

(** A module for handling ticket-tokens. A ticket-token represents the
    combination of a ticketer (creator of a ticket) and the content. That is,
    a ticket comprises a ticket-token and an amount.
  *)

type 'a parsed_token = {
  ticketer : Contract.t;
  contents_type : 'a Script_typed_ir.comparable_ty;
  contents : 'a;
}

(** A type for representing existentially quantified ticket-tokens. A
    ticket-token consists of a pair of ticketer and contents. *)
type ex_token = Ex_token : 'a parsed_token -> ex_token

(** Unparsed version of [parsed_token].
    Used to encode/decode ticket-token in receipt, RPC, etc.  *)
type unparsed_token = {
  ticketer : Contract.t;
  contents_type : Script.expr;
  contents : Script.expr;
}

val unparsed_token_encoding : unparsed_token Data_encoding.t
back to top