package bls12-381

You can search for identifiers within the package.

in-package search v0.2.0

package bls12-381

bls12-381
- Library bls12-381
  - Bls12_381
    
    Elliptic_curve_sig
    
    T
    
    Scalar
    
    Fq12
    
    Fr
    
    G1
    
    Uncompressed
    
    Scalar
    
    Compressed
    
    Scalar
    
    G2
    
    Uncompressed
    
    Scalar
    
    Compressed
    
    Scalar
    
    Pairing
    
    Rustc_bls12_381_bindings
    
    MakeFieldBindings
    
    Fq12
    
    Fr
    
    MakeGroupBindings
    
    G1
    
    G2
    
    Pairing
    
    Rustc_bls12_381_stubs
    
    CI
- Sources
  - bls12-381
    
    Fq12.ml
    
    Fr.ml
    
    bls12_381.ml
    
    g1.ml
    
    g2.ml
    
    pairing.ml
    
    rustc_bls12_381_bindings.ml
    
    rustc_bls12_381_stubs.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `G2.Uncompressed`Source

include Elliptic_curve_sig.T with type Scalar.t = Fr.t

Sourceexception Not_on_curve of Bytes.t

Sourcetype t

The type of the element in the elliptic curve

Sourceval size_in_bytes : int

The size of a point representation, in bytes

Sourcemodule Scalar : Ff.BASE with type t = Fr.t

Sourceval empty : unit -> t

Create an empty value to store an element of the curve. DO NOT USE THIS TO DO COMPUTATIONS WITH, UNDEFINED BEHAVIORS MAY HAPPEN

Sourceval check_bytes : Bytes.t -> bool

Check if a point, represented as a byte array, is on the curve *

Sourceval of_bytes_opt : Bytes.t -> t option

Attempt to construct a point from a byte array

Sourceval of_bytes_exn : Bytes.t -> t

Attempt to construct a point from a byte array. Raise Not_on_curve if the point is not on the curve

Sourceval to_bytes : t -> Bytes.t

Return a representation in bytes

Sourceval zero : t

Zero of the elliptic curve

Sourceval one : t

A fixed generator of the elliptic curve

Sourceval is_zero : t -> bool

Return true if the given element is zero

Sourceval random : ?state:Random.State.t -> unit -> t

Generate a random element

Sourceval add : t -> t -> t

Return the addition of two element

Sourceval double : t -> t

double g returns 2g

Sourceval negate : t -> t

Return the opposite of the element

Sourceval eq : t -> t -> bool

Return true if the two elements are algebraically the same

Sourceval mul : t -> Scalar.t -> t

Multiply an element by a scalar

Sourceval of_z_opt : x:(Z.t * Z.t) -> y:(Z.t * Z.t) -> t option

Create a point from the coordinates. If the point is not on the curve, None is return. The points must be given modulo the order of Fq. The points are in the form (c0, c1) where x = c1 * X + c0 and y = c1 * X + c0. To create the point at infinity, use zero ()

package bls12-381

Module G2.UncompressedSource

Module `G2.Uncompressed`Source