gurvy

README

gurvy

gurvy implements Elliptic Curve Cryptography (+Pairing) for BLS381, BLS377 and BN256.

It is actively developed and maintained by the team (zkteam@consensys.net) behind:

• gnark: a framework to execute (and verify) algorithms in zero-knowledge
• goff: fast finite field arithmetic in Golang

Warning

gurvy has not been audited and is provided as-is, use at your own risk. In particular, gurvy makes no security guarantees such as constant time implementation or side-channel attack resistance.

gurvy is optimized for 64bits architectures (x86 amd64) and tested on Unix (Linux / macOS).

Curves supported

• BLS12-381 (Zcash)
• BN256 (Ethereum)
• BLS377 (ZEXE)
• BW6-761 (EC supporting pairing on BLS377 field of definition)

Getting started

Go version

gurvy is tested with the last 2 major releases of Go (1.14 and 1.15).

Install gurvy

go get github.com/consensys/gurvy

Note if that if you use go modules, in go.mod the module path is case sensitive (use consensys and not ConsenSys).

Documentation

The APIs are consistent accross the curves. For example, here is bn256 godoc.

Benchmarks

Here are our measurements comparing gurvy (and goff our finite field library) with mcl.

These benchmarks ran on a AWS z1d.3xlarge instance, with hyperthreading disabled.

bn256	mcl(ns/op)	gurvy & goff (ns/op)
Fp::Add	3.32	3.44
Fp::Mul	18.43	16.1
Fp::Square	18.64	15.1
Fp::Inv	690.55	2080*
Fp::Pow	6485	7440*
G1::ScalarMul	41394	56900
G1::Add	213	224
G1::Double	155	178
G2::ScalarMul	88423	141000
G2::Add	598	871
G2::Double	371	386
Pairing	478244	489258

---

bls381	mcl(ns/op)	gurvy & goff (ns/op)
Fp::Add	5.42	4.6
Fp::Mul	33.63	29.3
Fp::Square	33.86	27
Fp::Inv	1536	4390*
Fp::Pow	18039	18300*
G1::ScalarMul	76799	91500
G1::Add	424	389
G1::Double	308	301
G2::ScalarMul	159068	273000
G2::Add	1162	1240
G2::Double	727	799
Pairing	676513	707984

*note that some routines don't have assembly implementation in goff yet.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details

Documentation

Overview

Package gurvy is an elliptic curve (+pairing) library. It currently expose efficient implementations for bls381, bls377, bn256 and bw761

Index

• type ID
  • func (id ID) String() string

Types

type ID

type ID uint16

ID represent a unique ID for a curve

const (
	UNKNOWN ID = iota
	BLS377
	BLS381
	BN256
	BW761
)

do not modify the order of this enum

func (ID) String

func (id ID) String() string