Source file tez_helpers.ml

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

open Protocol
open Alpha_context
open Environment
include Tez

let ( +? ) t1 t2 = t1 +? t2 |> wrap_tzresult

let ( -? ) t1 t2 = t1 -? t2 |> wrap_tzresult

let ( *? ) t1 t2 = t1 *? t2 |> wrap_tzresult

let ( /? ) t1 t2 = t1 /? t2 |> wrap_tzresult

let ( +! ) t1 t2 =
  match t1 +? t2 with Ok r -> r | Error _ -> Pervasives.failwith "adding tez"

let ( -! ) t1 t2 =
  match t1 -? t2 with
  | Ok r -> r
  | Error _ -> Pervasives.failwith "subtracting tez"

let ( *! ) t1 t2 =
  match t1 *? t2 with
  | Ok r -> r
  | Error _ -> Pervasives.failwith "multiplying tez"

let ( /! ) t1 t2 =
  match t1 /? t2 with
  | Ok r -> r
  | Error _ -> Pervasives.failwith "dividing tez"

let of_int x =
  match Tez.of_mutez (Int64.mul (Int64.of_int x) 1_000_000L) with
  | None -> invalid_arg "tez_of_int"
  | Some x -> x

let of_mutez x =
  match Tez.of_mutez x with None -> invalid_arg "tez_of_mutez" | Some x -> x

let to_mutez = Tez.to_mutez

(* Should be the same as Tez.max_mutez *)
let max_tez =
  match Tez.of_mutez Int64.max_int with None -> assert false | Some p -> p

let of_z a = Z.to_int64 a |> Tez.of_mutez_exn

let of_q ~round Q.{num; den} =
  (match round with `Up -> Z.cdiv num den | `Down -> Z.div num den) |> of_z

let to_z a = to_mutez a |> Z.of_int64

let ratio num den =
  Q.make (Z.of_int64 (to_mutez num)) (Z.of_int64 (to_mutez den))

let mul_q tez portion =
  let tez_z = to_mutez tez |> Z.of_int64 in
  Q.(mul portion ~$$tez_z)

module Compare = Tez

module Ez_tez = struct
  (** Aliases for tez values *)
  type tez_quantity =
    | Half
    | All
    | All_but_one
    | Nothing
    | Max_tez
    | Amount of t

  let tez_quantity_pp fmt value =
    let s =
      match value with
      | Nothing -> "Zero"
      | All -> "All"
      | All_but_one -> "All but 1µꜩ"
      | Half -> "Half"
      | Max_tez -> "Maximum"
      | Amount a -> Format.asprintf "%aꜩ" pp a
    in
    Format.fprintf fmt "%s" s

  (* [all] is the amount returned when [qty = All]. If [qty = Half], returns half of that. *)
  let quantity_to_tez all qty =
    match qty with
    | Nothing -> zero
    | All -> all
    | All_but_one -> if equal all zero then zero else all -! one_mutez
    | Half -> all /! 2L
    | Max_tez -> max_tez
    | Amount a -> a
end