Module `Tezos_raw_protocol_alpha.Tez_repr`Source

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 =

| Tez_tag of repr

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

Sourcetype Tezos_protocol_environment_alpha.Error_monad.error +=

| Addition_overflow of t * t
| Subtraction_underflow of t * t
| Multiplication_overflow of t * Tezos_protocol_environment_alpha.Z.t
| Negative_multiplicator of t * Tezos_protocol_environment_alpha.Z.t
| Invalid_divisor of t * Tezos_protocol_environment_alpha.Z.t

Sourceval zero : t

Sourceval one_mutez : t

Sourceval one_cent : t

Sourceval fifty_cents : t

Sourceval one : t

Sourceval max_mutez : t

Sourceval (-?) : t -> t -> t Tezos_protocol_environment_alpha.Error_monad.tzresult

Sourceval sub_opt : t -> t -> t option

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

Sourceval (+?) : t -> t -> t Tezos_protocol_environment_alpha.Error_monad.tzresult

Source

val (*?) : 
  t ->
  int64 ->
  t Tezos_protocol_environment_alpha.Error_monad.tzresult

Source

val (/?) : 
  t ->
  int64 ->
  t Tezos_protocol_environment_alpha.Error_monad.tzresult

Sourceval div2 : t -> t

Source

val mul_ratio : 
  rounding:[ `Down | `Up ] ->
  t ->
  num:int64 ->
  den:int64 ->
  t Tezos_protocol_environment_alpha.Error_monad.tzresult

mul_ratio ~rounding tez ~num ~den returns tez * num / den without failing when tez * num overflows. rounding controls the rounding of the division.

Source

val mul_ratio_z : 
  rounding:[ `Down | `Up ] ->
  t ->
  num:Tezos_protocol_environment_alpha.Z.t ->
  den:Tezos_protocol_environment_alpha.Z.t ->
  t Tezos_protocol_environment_alpha.Error_monad.tzresult

mul_ratio_z is the same as mul_ratio, but takes Z.t as arguments

Source

val mul_q : 
  rounding:[ `Down | `Up ] ->
  t ->
  Tezos_protocol_environment_alpha.Q.t ->
  t Tezos_protocol_environment_alpha.Error_monad.tzresult

mul_q is the same as mul_ratio_z, but takes a Q.t as an argument

Sourceval mul_percentage : rounding:[ `Down | `Up ] -> t -> Percentage.t -> t

mul_percentage tez percentage returns tez * percentage / 100. No errors can happen.

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.

Sourceval encoding : t Tezos_protocol_environment_alpha.Data_encoding.t

Source

val balance_update_encoding : 
  [ `Credited of t | `Debited of t ]
    Tezos_protocol_environment_alpha.Data_encoding.t

include Tezos_protocol_environment_alpha.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 pp : Tezos_protocol_environment_alpha.Format.formatter -> t -> unit

Sourceval of_string : string -> t option

Sourceval to_string : t -> string

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Tez_repr/index.html

Module `Tezos_raw_protocol_alpha.Tez_repr`Source

package tezos-protocol-alpha

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Tez_repr/index.html

Module Tezos_raw_protocol_alpha.Tez_reprSource

Module `Tezos_raw_protocol_alpha.Tez_repr`Source