package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-libs.crypto/Tezos_crypto/Signature/Bls/Primitive/Fr/index.html

Module Primitive.FrSource

Sourceexception Not_in_field of Bytes.t
Sourceval order : Z.t

The order of the finite field

Sourceval size_in_bytes : int

minimal number of bytes required to encode a value of the field.

Sourceval check_bytes : Bytes.t -> bool

check_bytes bs returns true if bs is a correct byte representation of a field element

Sourceval zero : t

The neutral element for the addition

Sourceval one : t

The neutral element for the multiplication

Sourceval add : t -> t -> t

add a b returns a + b mod order

Sourceval mul : t -> t -> t

mul a b returns a * b mod order

Sourceval eq : t -> t -> bool

eq a b returns true if a = b mod order, else false

Sourceval negate : t -> t

negate x returns -x mod order. Equivalently, negate x returns the unique y such that x + y mod order = 0

Sourceval inverse_exn : t -> t

inverse_exn x returns x^-1 if x is not 0, else raise Division_by_zero

Sourceval inverse_opt : t -> t option

inverse_opt x returns x^-1 if x is not 0 as an option, else None

Sourceval pow : t -> Z.t -> t

pow x n returns x^n

Sourceval of_bytes_exn : Bytes.t -> t

From a predefined bytes representation, construct a value t. It is not required that to_bytes (of_bytes_exn t) = t. Raise Not_in_field if the bytes do not represent an element in the field.

Sourceval of_bytes_opt : Bytes.t -> t option

From a predefined bytes representation, construct a value t. It is not required that to_bytes (Option.get (of_bytes_opt t)) = t. By default, little endian encoding is used and the given element is modulo the prime order

Sourceval to_bytes : t -> Bytes.t

Convert the value t to a bytes representation which can be used for hashing for instance. It is not required that to_bytes (of_bytes_exn t) = t. By default, little endian encoding is used, and length of the resulting bytes may vary depending on the order.

Sourceval size_in_memory : int

Actual number of bytes allocated for a value of type t

Sourceval of_z : Z.t -> t

of_z x builds an element t from the Zarith element x. mod order is applied if x >= order or x < 0.

Sourceval to_z : t -> Z.t

to_z x builds a Zarith element, using the decimal representation. Arithmetic on the result can be done using the modular functions on integers

OCaml

Innovation. Community. Security.