package octez-libs

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

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.0.tar.gz
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

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

Module G2.ScalarSource

Sourceexception Not_in_field of Bytes.t
Sourcetype t = Fr.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.