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

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-libs.plompiler/Plompiler/Gadget/Edwards25519/index.html

Module Gadget.Edwards25519Source

Parameters

module L : sig ... end

Signature

Sourcetype nat_mod

Represents an element from a base field

Sourcetype point = nat_mod * nat_mod

Represents a point on the curve in affine coordinates

Sourceval input_point : ?kind:L.input_kind -> (Z.t * Z.t) -> point L.repr L.t

Returns a Plompiler representation of a point

Sourceval is_on_curve : point L.repr -> bool L.repr L.t

is_on_curve p checks whether a point p is on the curve

Sourceval from_coordinates : nat_mod L.repr -> nat_mod L.repr -> point L.repr L.t

from_coordinates x y constructs a point p = (x, y) from coordinates x and y. The function also checks whether the point is on the curve (but not necessarily in the subgroup)

Sourceval unsafe_from_coordinates : nat_mod L.repr -> nat_mod L.repr -> point L.repr L.t

unsafe_from_coordinates x y is similar to from_coordinates but does not verify the point is on the curve. It can be used to build a variable of type point without adding any constraint

Sourceval get_x_coordinate : point L.repr -> nat_mod L.repr

get_x_coordinate p returns a first coordinate x of a point p

Sourceval get_y_coordinate : point L.repr -> nat_mod L.repr

get_y_coordinate p returns a second coordinate y of a point p

Returns the point at infinity of the curve (additive identity)

Sourceval base_point : point L.repr L.t

Returns the base point of the curve (a fixed generator)

add p q computes a point addition p + q

negate p computes a point negation -p

Sourceval cond_add : point L.repr -> point L.repr -> bool L.repr -> point L.repr L.t

cond_add p q b returns p + b * q, i.e., either a point addition p and q or a point p based on the value b

double p computes a point doubling p + p

Sourceval scalar_mul : bool list L.repr -> point L.repr -> point L.repr L.t

scalar_mul s p computes a point multiplication p by a scalar s. The scalar s is encoded in little-endian order

Sourceval multi_scalar_mul : bool list list L.repr -> point list L.repr -> point L.repr L.t

multi_scalar_mul ls lp computes the multi-scalar multiplication s₁·p₁ + s₂·p₂ + … + sₖ·pₖ

Sourceval scalar_order : Z.t

Returns the order of the prime-order subgroup of the elliptic curve group

Sourceval base_order : Z.t

Returns the prime number defining the underlying field

Sourceval to_compressed_bytes : point L.repr -> L.Bytes.tl L.repr L.t

to_compressed_bytes p returns the compressed representation of a point p = (x, y) in little-endian bytes pow2 255 * (x % 2) + y