1// This package implements efficient Golidlocks arithmetic operations within Gnark. We do not use
  2// the emulated field arithmetic API, because it is too slow for our purposes. Instead, we use
  3// an efficient reduction method that leverages the fact that the modulus is a simple
  4// linear combination of powers of two.
  5package goldilocks
  6
  7// In general, methods whose name do not contain `NoReduce` can be used without any extra mental
  8// overhead. These methods act exactly as you would expect a normal field would operate.
  9//
 10// However, if you want to aggressively optimize the number of constraints in your circuit, it can
 11// be very beneficial to use the no reduction methods and keep track of the maximum number of bits
 12// your computation uses.
 13
 14// This implementation is based on the following plonky2 implementation of Goldilocks
 15// Available here: https://github.com/0xPolygonZero/plonky2/blob/main/field/src/goldilocks_field.rs#L70
 16
 17import (
 18	"fmt"
 19	"math"
 20	"math/big"
 21
 22	"github.com/consensys/gnark-crypto/field/goldilocks"
 23	"github.com/consensys/gnark/constraint/solver"
 24	"github.com/consensys/gnark/frontend"
 25	"github.com/consensys/gnark/std/math/emulated"
 26	"github.com/consensys/gnark/std/rangecheck"
 27)
 28
 29// The multiplicative group generator of the field.
 30var MULTIPLICATIVE_GROUP_GENERATOR goldilocks.Element = goldilocks.NewElement(7)
 31
 32// The two adicity of the field.
 33var TWO_ADICITY uint64 = 32
 34
 35// The power of two generator of the field.
 36var POWER_OF_TWO_GENERATOR goldilocks.Element = goldilocks.NewElement(1753635133440165772)
 37
 38// The modulus of the field.
 39var MODULUS *big.Int = emulated.Goldilocks{}.Modulus()
 40
 41// The threshold maximum number of bits at which we must reduce the element.
 42var REDUCE_NB_BITS_THRESHOLD uint8 = 254 - 64
 43
 44// The number of bits to use for range checks on inner products of field elements.
 45var RANGE_CHECK_NB_BITS int = 140
 46
 47// Registers the hint functions with the solver.
 48func init() {
 49	solver.RegisterHint(MulAddHint)
 50	solver.RegisterHint(ReduceHint)
 51	solver.RegisterHint(InverseHint)
 52	solver.RegisterHint(SplitLimbsHint)
 53}
 54
 55// A type alias used to represent Goldilocks field elements.
 56type Variable struct {
 57	Limb frontend.Variable
 58}
 59
 60// Creates a new Goldilocks field element from an existing variable. Assumes that the element is
 61// already reduced.
 62func NewVariable(x frontend.Variable) Variable {
 63	return Variable{Limb: x}
 64}
 65
 66// The zero element in the Golidlocks field.
 67func Zero() Variable {
 68	return NewVariable(0)
 69}
 70
 71// The one element in the Goldilocks field.
 72func One() Variable {
 73	return NewVariable(1)
 74}
 75
 76// The negative one element in the Goldilocks field.
 77func NegOne() Variable {
 78	return NewVariable(MODULUS.Uint64() - 1)
 79}
 80
 81// The chip used for Goldilocks field operations.
 82type Chip struct {
 83	api          frontend.API
 84	rangeChecker frontend.Rangechecker
 85}
 86
 87// Creates a new Goldilocks Chip.
 88func New(api frontend.API) *Chip {
 89	rangeChecker := rangecheck.New(api)
 90	return &Chip{api: api, rangeChecker: rangeChecker}
 91}
 92
 93// Adds two field elements such that x + y = z within the Golidlocks field.
 94func (p *Chip) Add(a Variable, b Variable) Variable {
 95	return p.MulAdd(a, NewVariable(1), b)
 96}
 97
 98// Adds two field elements such that x + y = z within the Golidlocks field without reducing.
 99func (p *Chip) AddNoReduce(a Variable, b Variable) Variable {
100	return NewVariable(p.api.Add(a.Limb, b.Limb))
101}
102
103// Subtracts two field elements such that x + y = z within the Golidlocks field.
104func (p *Chip) Sub(a Variable, b Variable) Variable {
105	return p.MulAdd(b, NewVariable(MODULUS.Uint64()-1), a)
106}
107
108// Subtracts two field elements such that x + y = z within the Golidlocks field without reducing.
109func (p *Chip) SubNoReduce(a Variable, b Variable) Variable {
110	return NewVariable(p.api.Add(a.Limb, p.api.Mul(b.Limb, MODULUS.Uint64()-1)))
111}
112
113// Multiplies two field elements such that x * y = z within the Golidlocks field.
114func (p *Chip) Mul(a Variable, b Variable) Variable {
115	return p.MulAdd(a, b, Zero())
116}
117
118// Multiplies two field elements such that x * y = z within the Golidlocks field without reducing.
119func (p *Chip) MulNoReduce(a Variable, b Variable) Variable {
120	return NewVariable(p.api.Mul(a.Limb, b.Limb))
121}
122
123// Multiplies two field elements and adds a field element such that x * y + z = c within the
124// Golidlocks field.
125func (p *Chip) MulAdd(a Variable, b Variable, c Variable) Variable {
126	result, err := p.api.Compiler().NewHint(MulAddHint, 2, a.Limb, b.Limb, c.Limb)
127	if err != nil {
128		panic(err)
129	}
130
131	quotient := NewVariable(result[0])
132	remainder := NewVariable(result[1])
133
134	cLimbCopy := p.api.Mul(c.Limb, 1)
135	lhs := p.api.MulAcc(cLimbCopy, a.Limb, b.Limb)
136	rhs := p.api.MulAcc(remainder.Limb, MODULUS, quotient.Limb)
137	p.api.AssertIsEqual(lhs, rhs)
138
139	p.RangeCheck(quotient)
140	p.RangeCheck(remainder)
141	return remainder
142}
143
144// Multiplies two field elements and adds a field element such that x * y + z = c within the
145// Golidlocks field without reducing.
146func (p *Chip) MulAddNoReduce(a Variable, b Variable, c Variable) Variable {
147	cLimbCopy := p.api.Mul(c.Limb, 1)
148	return NewVariable(p.api.MulAcc(cLimbCopy, a.Limb, b.Limb))
149}
150
151// The hint used to compute MulAdd.
152func MulAddHint(_ *big.Int, inputs []*big.Int, results []*big.Int) error {
153	if len(inputs) != 3 {
154		panic("MulAddHint expects 3 input operands")
155	}
156
157	for _, operand := range inputs {
158		if operand.Cmp(MODULUS) >= 0 {
159			panic(fmt.Sprintf("%s is not in the field", operand.String()))
160		}
161	}
162
163	product := new(big.Int).Mul(inputs[0], inputs[1])
164	sum := new(big.Int).Add(product, inputs[2])
165	quotient := new(big.Int).Div(sum, MODULUS)
166	remainder := new(big.Int).Rem(sum, MODULUS)
167
168	results[0] = quotient
169	results[1] = remainder
170
171	return nil
172}
173
174// Reduces a field element x such that x % MODULUS = y.
175func (p *Chip) Reduce(x Variable) Variable {
176	// Witness a `quotient` and `remainder` such that:
177	//
178	// 		MODULUS * quotient + remainder = x
179	//
180	// Must check that offset \in [0, MODULUS) and carry \in [0, 2^RANGE_CHECK_NB_BITS) to ensure
181	// that this computation does not overflow. We use 2^RANGE_CHECK_NB_BITS to reduce the cost of the range check
182	//
183	// In other words, we assume that we at most compute a a dot product with dimension at most RANGE_CHECK_NB_BITS - 128.
184
185	result, err := p.api.Compiler().NewHint(ReduceHint, 2, x.Limb)
186	if err != nil {
187		panic(err)
188	}
189
190	quotient := result[0]
191	p.rangeChecker.Check(quotient, RANGE_CHECK_NB_BITS)
192
193	remainder := NewVariable(result[1])
194	p.RangeCheck(remainder)
195
196	p.api.AssertIsEqual(x.Limb, p.api.Add(p.api.Mul(quotient, MODULUS), remainder.Limb))
197
198	return remainder
199}
200
201// Reduces a field element x such that x % MODULUS = y.
202func (p *Chip) ReduceWithMaxBits(x Variable, maxNbBits uint64) Variable {
203	// Witness a `quotient` and `remainder` such that:
204	//
205	// 		MODULUS * quotient + remainder = x
206	//
207	// Must check that remainder \in [0, MODULUS) and quotient \in [0, 2^maxNbBits) to ensure that this
208	// computation does not overflow.
209
210	result, err := p.api.Compiler().NewHint(ReduceHint, 2, x.Limb)
211	if err != nil {
212		panic(err)
213	}
214
215	quotient := result[0]
216	p.rangeChecker.Check(quotient, int(maxNbBits))
217
218	remainder := NewVariable(result[1])
219	p.RangeCheck(remainder)
220
221	p.api.AssertIsEqual(x.Limb, p.api.Add(p.api.Mul(quotient, MODULUS), remainder.Limb))
222
223	return remainder
224}
225
226// The hint used to compute Reduce.
227func ReduceHint(_ *big.Int, inputs []*big.Int, results []*big.Int) error {
228	if len(inputs) != 1 {
229		panic("ReduceHint expects 1 input operand")
230	}
231	input := inputs[0]
232	quotient := new(big.Int).Div(input, MODULUS)
233	remainder := new(big.Int).Rem(input, MODULUS)
234	results[0] = quotient
235	results[1] = remainder
236	return nil
237}
238
239// Computes the inverse of a field element x such that x * x^-1 = 1.
240func (p *Chip) Inverse(x Variable) Variable {
241	result, err := p.api.Compiler().NewHint(InverseHint, 1, x.Limb)
242	if err != nil {
243		panic(err)
244	}
245
246	inverse := NewVariable(result[0])
247	p.RangeCheck(inverse)
248
249	product := p.Mul(inverse, x)
250	p.api.AssertIsEqual(product.Limb, frontend.Variable(1))
251	return inverse
252}
253
254// The hint used to compute Inverse.
255func InverseHint(_ *big.Int, inputs []*big.Int, results []*big.Int) error {
256	if len(inputs) != 1 {
257		panic("InverseHint expects 1 input operand")
258	}
259
260	input := inputs[0]
261	if input.Cmp(MODULUS) == 0 || input.Cmp(MODULUS) == 1 {
262		panic("Input is not in the field")
263	}
264
265	inputGl := goldilocks.NewElement(input.Uint64())
266	resultGl := goldilocks.NewElement(0)
267	resultGl.Inverse(&inputGl)
268
269	result := big.NewInt(0)
270	results[0] = resultGl.BigInt(result)
271
272	return nil
273}
274
275// Computes a field element raised to some power.
276func (p *Chip) Exp(x Variable, k *big.Int) Variable {
277	if k.IsUint64() && k.Uint64() == 0 {
278		return One()
279	}
280
281	e := k
282	if k.Sign() == -1 {
283		panic("Unsupported negative exponent. Need to implement inversion.")
284	}
285
286	z := x
287	for i := e.BitLen() - 2; i >= 0; i-- {
288		z = p.Mul(z, z)
289		if e.Bit(i) == 1 {
290			z = p.Mul(z, x)
291		}
292	}
293
294	return z
295}
296
297// The hint used to split a GoldilocksVariable into 2 32 bit limbs.
298func SplitLimbsHint(_ *big.Int, inputs []*big.Int, results []*big.Int) error {
299	if len(inputs) != 1 {
300		panic("SplitLimbsHint expects 1 input operand")
301	}
302
303	// The Goldilocks field element
304	input := inputs[0]
305
306	if input.Cmp(MODULUS) == 0 || input.Cmp(MODULUS) == 1 {
307		return fmt.Errorf("input is not in the field")
308	}
309
310	two_32 := big.NewInt(int64(math.Pow(2, 32)))
311
312	// The most significant bits
313	results[0] = new(big.Int).Quo(input, two_32)
314	// The least significant bits
315	results[1] = new(big.Int).Rem(input, two_32)
316
317	return nil
318}
319
320// Range checks a field element x to be less than the Golidlocks modulus 2 ^ 64 - 2 ^ 32 + 1.
321func (p *Chip) RangeCheck(x Variable) {
322	// The Goldilocks' modulus is 2^64 - 2^32 + 1, which is:
323	//
324	// 		1111111111111111111111111111111100000000000000000000000000000001
325	//
326	// in big endian binary. This function will first verify that x is at most 64 bits wide. Then it
327	// checks that if the bits[0:31] (in big-endian) are all 1, then bits[32:64] are all zero.
328
329	result, err := p.api.Compiler().NewHint(SplitLimbsHint, 2, x.Limb)
330	if err != nil {
331		panic(err)
332	}
333
334	// We check that this is a valid decomposition of the Goldilock's element and range-check each limb.
335	mostSigLimb := result[0]
336	leastSigLimb := result[1]
337	p.api.AssertIsEqual(
338		p.api.Add(
339			p.api.Mul(mostSigLimb, uint64(math.Pow(2, 32))),
340			leastSigLimb,
341		),
342		x.Limb,
343	)
344	p.rangeChecker.Check(mostSigLimb, 32)
345	p.rangeChecker.Check(leastSigLimb, 32)
346
347	// If the most significant bits are all 1, then we need to check that the least significant bits are all zero
348	// in order for element to be less than the Goldilock's modulus.
349	// Otherwise, we don't need to do any checks, since we already know that the element is less than the Goldilocks modulus.
350	shouldCheck := p.api.IsZero(p.api.Sub(mostSigLimb, uint64(math.Pow(2, 32))-1))
351	p.api.AssertIsEqual(
352		p.api.Select(
353			shouldCheck,
354			leastSigLimb,
355			frontend.Variable(0),
356		),
357		frontend.Variable(0),
358	)
359}
360
361func (p *Chip) AssertIsEqual(x, y Variable) {
362	p.api.AssertIsEqual(x.Limb, y.Limb)
363}
364
365// Computes the n'th primitive root of unity for the Goldilocks field.
366func PrimitiveRootOfUnity(nLog uint64) goldilocks.Element {
367	if nLog > TWO_ADICITY {
368		panic("nLog is greater than TWO_ADICITY")
369	}
370	res := goldilocks.NewElement(POWER_OF_TWO_GENERATOR.Uint64())
371	for i := 0; i < int(TWO_ADICITY-nLog); i++ {
372		res.Square(&res)
373	}
374	return res
375}
376
377func TwoAdicSubgroup(nLog uint64) []goldilocks.Element {
378	if nLog > TWO_ADICITY {
379		panic("nLog is greater than GOLDILOCKS_TWO_ADICITY")
380	}
381
382	var res []goldilocks.Element
383	rootOfUnity := PrimitiveRootOfUnity(nLog)
384	res = append(res, goldilocks.NewElement(1))
385
386	for i := 0; i < (1 << nLog); i++ {
387		lastElement := res[len(res)-1]
388		res = append(res, *lastElement.Mul(&lastElement, &rootOfUnity))
389	}
390
391	return res
392}