Module Tez_staking_helpers.Tez

include module type of struct include Tez_helpers end

This module wraps the errors from the protocol and provides some helpful functions manipulating Tez.

val zero : t
val one_mumav : t
val one_cent : t
val fifty_cents : t
val one : t
val max_tez : t
val sub_opt : t -> t -> t option
val (*?) : t -> int64 -> t Mavryk_base.TzPervasives.tzresult
val (/?) : t -> int64 -> t Mavryk_base.TzPervasives.tzresult
val (-!) : t -> t -> t
val (+!) : t -> t -> t
val (*!) : t -> int64 -> t
val (/!) : t -> int64 -> t
val to_mumav : t -> int64
val of_mumav : int64 -> t
module Compare = Tez_helpers.Compare
val pp : Stdlib.Format.formatter -> t -> unit
val to_string : t -> string
val ratio : t -> t -> Q.t
val mul_q : t -> Q.t -> Q.t
val of_int : int -> t
val of_q : round:[ `Down | `Up ] -> Q.t -> t
val of_z : Z.t -> t
val to_z : t -> Z.t
module Ez_tez = Tez_helpers.Ez_tez

Functions to manipulate Tez in a high level way

include module type of struct include Tez_helpers.Compare end
val (=) : Tez_helpers.t -> Tez_helpers.t -> bool

x = y iff compare x y = 0

val (<>) : Tez_helpers.t -> Tez_helpers.t -> bool

x <> y iff compare x y <> 0

val (<) : Tez_helpers.t -> Tez_helpers.t -> bool

x < y iff compare x y < 0

val (<=) : Tez_helpers.t -> Tez_helpers.t -> bool

x <= y iff compare x y <= 0

val (>=) : Tez_helpers.t -> Tez_helpers.t -> bool

x >= y iff compare x y >= 0

val (>) : Tez_helpers.t -> Tez_helpers.t -> bool

x > y iff compare x y > 0

val compare : Tez_helpers.t -> Tez_helpers.t -> int

compare an alias for the functor parameter's compare function

val equal : Tez_helpers.t -> Tez_helpers.t -> bool

equal x y iff compare x y = 0

max x y is x if x >= y otherwise it is y

min x y is x if x <= y otherwise it is y