Module Tezos_raw_protocol_016_PtMumbai.Tez_reprSource

Sourcetype repr

Internal representation of the Tez currency. Behaves mostly like a natural number where number 1 represents 1/1,000,000 Tez (1 micro-Tez or mutez). It's protected from ever becoming negative and overflowing by special arithmetic functions, which fail in case something undesired would happen. When divided, it's always rounded down to 1 mutez.

Internally encoded as int64, which may be relevant to guard against overflow errors.

Sourcetype t =
  1. | Tez_tag of repr

t is made algebraic in order to distinguish it from the other type parameters of Script_typed_ir.ty.

Sourcetype tez = t
Sourceval zero : t
Sourceval one_mutez : t
Sourceval one_cent : t
Sourceval fifty_cents : t
Sourceval one : t
Sourceval max_mutez : t
Sourceval sub_opt : t -> t -> t option

Same as ( -? ) but returns None instead of an error.

Sourceval to_mutez : t -> int64
Sourceval of_mutez : int64 -> t option

of_mutez n (micro tez) is None if n is negative

Sourceval of_mutez_exn : int64 -> t

of_mutez_exn n fails if n is negative. It should only be used at toplevel for constants.

Sourceval mul_exn : t -> int -> t

It should only be used at toplevel for constants.

Sourceval div_exn : t -> int -> t

It should only be used at toplevel for constants.

include Tezos_protocol_environment_016_PtMumbai.Compare.S with type t := t
Sourceval (=) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (>=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval compare : t -> t -> int
Sourceval equal : t -> t -> bool
Sourceval max : t -> t -> t
Sourceval min : t -> t -> t
Sourceval of_string : string -> t option
Sourceval to_string : t -> string