generator

Documentation

Index

• func GenerateBaseFields(conf CurveConfig) error
• func GenerateDoc(conf CurveConfig) error
• func GenerateFq12over6over2(conf CurveConfig) error
• func GenerateMultiExpHelpers(conf CurveConfig) error
• func GeneratePairingTests(conf CurveConfig) error
• func GeneratePoint(_conf CurveConfig, coordType, pointName string) error
• type CurveConfig
  • func NewCurveConfig(name, rTorsion, fpModulus string, glv bool, cc bool) CurveConfig

Functions

func GenerateBaseFields

func GenerateBaseFields(conf CurveConfig) error

GenerateBaseFields generates the base field fr and fp

func GenerateDoc

func GenerateDoc(conf CurveConfig) error

GenerateDoc generates package level doc

func GenerateFq12over6over2

func GenerateFq12over6over2(conf CurveConfig) error

GenerateFq12over6over2 generates a tower 2->6->12 over fp

func GenerateMultiExpHelpers

func GenerateMultiExpHelpers(conf CurveConfig) error

GenerateMultiExpHelpers generates multi exp helpers functions

func GeneratePairingTests

func GeneratePairingTests(conf CurveConfig) error

GeneratePairingTests generates elliptic curve arithmetic

func GeneratePoint

func GeneratePoint(_conf CurveConfig, coordType, pointName string) error

GeneratePoint generates elliptic curve arithmetic

Types

type CurveConfig

type CurveConfig struct {
	CurveName        string
	RTorsion         string
	RBitLen          int
	FpModulus        string
	OutputDir        string
	GLV              bool  // scalar mulitplication using GLV
	CofactorCleaning bool  // flag telling if the Cofactor cleaning is available
	CRange           []int // multiexp bucket method: generate inner methods (with const arrays) for each c
	PMod4            int   // 3 or 1
}

CurveConfig describes parameters of the curve useful for the templates

func NewCurveConfig

func NewCurveConfig(name, rTorsion, fpModulus string, glv bool, cc bool) CurveConfig

NewCurveConfig returns a struct initialized with the parameters needed for template generation (internal use in gurvy)