package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Curve25519.AffineEdwardsSource

au^2 + v^2 = 1 + du^2v^2

Sourceexception Not_on_curve of Bytes.t
Sourcetype t

Represents an element on the curve. In the case of a curve with a cofactor, the element is not necessarily in the prime subgroup.

Sourceval size_in_bytes : int

The size of a point representation, in bytes

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 the element

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 a : Base.t

The parameter a of the curve, from the equation a * u^2 + v^2 = 1 + d * u^2 * v^2

Sourceval d : Base.t

The parameter d of the curve, from the equation a * u^2 + v^2 = 1 + d * u^2 * v^2

Sourceval cofactor : Z.t

The cofactor of the curve. The parameter is used in is_small_order and in the random point generator.

Sourceval is_on_curve : u:Base.t -> v:Base.t -> bool

is_on_curve ~u ~v returns true if the coordinates (u, v) represents a point on the curve. It does not check the point is in the prime subgroup.

Sourceval is_in_prime_subgroup : u:Base.t -> v:Base.t -> bool

is_in_prime_subgroup ~u ~v returns true if the coordinates (u, v) represents a point in the prime subgroup. The coordinates must be a point on the curve

Sourceval get_u_coordinate : t -> Base.t

Return the affine coordinate u (such that au^2 + v^2 = 1 + d u^2 v^2

Sourceval get_v_coordinate : t -> Base.t

Return the affine coordinate u (such that au^2 + v^2 = 1 + d u^2 v^2

Sourceval to_montgomery_curve_parameters : unit -> (Base.t * Base.t * Z.t * (Base.t * Base.t)) option
Sourceval to_montgomery : t -> (Base.t * Base.t) option
Sourceval from_coordinates_opt : u:Base.t -> v:Base.t -> t option

Build a point from the affine coordinates. If the point is not on the curve and in the subgroup, returns None

Sourceval from_coordinates_exn : u:Base.t -> v:Base.t -> t

Build a point from the affine coordinates. If the point is not on the curve and in the subgroup, raise Not_on_curve.

Sourceval unsafe_from_coordinates : u:Base.t -> v:Base.t -> t

Build a point from the affine coordinates, without verifying the point is on the curve. Use with precaution.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct