add gadgets to API surface, UInt32, UInt64, implement rot32 #1259

Trivo25 · 2023-11-21T09:02:20Z

adds API support for the new bitwise gadgets to UInt32 and UInt64
implements divMod32 and addMod32
implements rotation32 using divMod32
refactors rangeCheckHelper into a gadget
implements leftShift32 based on divMod32

…ghtShift, and bitwise AND operations on UInt64 values using Gadgets module The Gadgets module provides implementations for bitwise XOR, NOT, rotate, leftShift, rightShift, and bitwise AND operations on UInt64 values. These operations are useful for performing bitwise operations on UInt64 values in a circuit. The following operations have been added: - `xor(x: UInt64)`: Performs a bitwise XOR operation between the current UInt64 value and the provided UInt64 value `x`. Returns a new UInt64 value representing the result of the XOR operation. - `not(checked = true)`: Performs a bitwise NOT operation on the current UInt64 value. If the `checked` parameter is set to `true`, the operation is implemented using the `Gadgets.xor` gadget with a second argument as an all one bitmask of the same length. If the `checked` parameter is set to `false`, the operation is implemented as a subtraction of the input from the all one bitmask. Returns a new UInt64 value representing the result of the NOT operation. - `rotate(direction: 'left' | 'right' = 'left')`: Performs a bitwise rotation operation on the current UInt64 value. The `direction` parameter determines the direction of the rotation, with `'left'` indicating a left rotation and `'right'` indicating a right rotation. Returns a new UInt64 value representing the result of the rotation operation. - `leftShift()`: Performs a bitwise left shift operation on the current UInt64 value. Returns a new UInt64 value representing the result of the left shift operation. - `rightShift()`: Performs a bitwise right shift operation on the current UInt64 value. Returns a new UInt64 value representing the result of the right shift operation. - `and(x: UInt64)`: Performs a bitwise AND operation between the current UInt64 value and the provided UInt64 value `x`. Returns a new UInt64 value representing the result of the AND operation. These operations provide additional functionality for working with UInt64 values in circuits.

…to 'bits' to improve clarity feat(int.ts): add documentation for the rotate, leftShift, rightShift, and and methods to improve code understanding and usage

… 'from' method instead of direct instantiation to improve clarity and consistency feat(int.ts): add support for bitwise XOR operation on UInt32 elements to perform XOR operation between two UInt32 elements feat(int.ts): add support for bitwise NOT operation on UInt32 elements to perform bitwise negation of a UInt32 element feat(int.ts): add support for rotation operation on UInt32 elements to perform left and right rotation of bits in a UInt32 element feat(int.ts): add support for left shift operation on UInt32 elements to perform left shift of bits in a UInt32 element feat(int.ts): add support for right shift operation on UInt32 elements to perform right shift of bits in a UInt32 element feat(int.ts): add support for bitwise AND operation on UInt32 elements to perform AND operation between two UInt32 elements

src/lib/gadgets/arithmetic.ts

src/lib/gadgets/bitwise.ts

src/lib/gadgets/range-check.ts

mitschabaude · 2023-11-29T22:18:58Z

src/lib/int.ts

+      let xMinusYFits = Gadgets.isInRangeN(UInt32.NUM_BITS, xMinusY);
+      let yMinusXFits = Gadgets.isInRangeN(UInt32.NUM_BITS, yMinusX);
      xMinusYFits.or(yMinusXFits).assertEquals(true);
      // x <= y if y - x fits in 64 bits
      return yMinusXFits;


this code proves that yMinusXFits is the boolean that indicates whether yMinusX in [0, 2^64).

note that it's not just returning Gadgets.isInRangeN(UInt32.NUM_BITS, yMinusX), which it could if the gadget would do what it promises.

the code here, by doing xMinusYFits.or(yMinusXFits).assertEquals(true), anchors the case that yMinusXFits = false to a specific other case (namely, xMinusYFits = true) in which we can definitely know that yMinusX can't be in range.

mitschabaude · 2023-11-29T22:24:07Z

src/lib/gadgets/gadgets.ts

+   * Checks whether the input value is in the range [0, 2^n). `n` must be a multiple of 16.
+   *
+   * This function proves that the provided field element can be represented with `n` bits.
+   * If the field element exceeds `n` bits, `Bool(false)` is returned and `Bool(true)` otherwise.


this is misleading, because it only proves that the result is in range if the return value of isInRangeN() is true. It doesn't prove that the result is not in range if the return value is false.

See my comment on where this is used: #1259 (comment)

So maybe better to rephrase the doccomment, or frame it as a helper function for now. I can follow up with some code that actually proves the full thing, which I think would also make the UInt64 comparison cheaper (currently the comparison calls rangeCheckHelper twice, but it can be done with one call)

mitschabaude

Left shift and right shift look good to me!

My only concern now is the misleading documentation of the isInRange() gadget that I requested :D But I think it can be just fixed in a follow-up where we make it do what it says, so approving!

src/lib/int.ts

mitschabaude · 2023-12-04T07:19:51Z

Created a follow-up issue that doesn't need to be addressed here: #1286

src/lib/gadgets/gadgets.ts

Trivo25 added 5 commits November 14, 2023 11:24

fix(int.ts): update parameter name in rotate method from 'direction' …

840fc7a

…to 'bits' to improve clarity feat(int.ts): add documentation for the rotate, leftShift, rightShift, and and methods to improve code understanding and usage

simplify doc comments, avoid confusion

5020ce3

same for uint32

63fa85f

Trivo25 marked this pull request as draft November 21, 2023 09:03

Trivo25 added 10 commits November 21, 2023 10:07

Merge branch 'main' into feature/gadgets-uint

14f2051

bump bindings

3932338

add divMod32, addMod32

8c524b6

rotate32, rename rotate to rotate64

7d8ff8e

add rotate32 tests

27d6f8a

epose rot32

0d5e09b

rangeCheck32

81c90c4

add rotate32 to UInt32

aafd4b8

fix tests

6419176

fix vk regression test

e8cac1a

mitschabaude reviewed Nov 21, 2023

View reviewed changes

src/lib/gadgets/arithmetic.ts Outdated Show resolved Hide resolved

Trivo25 added 6 commits November 22, 2023 09:26

add constant check

4685946

re-add range checks

4013f14

add doc comments

bc9a20e

rename r and q to remainder and quotient

14a7717

undo chain tests because not needed

51d0bfd

Undo comment

ce34be8

Trivo25 commented Nov 22, 2023

View reviewed changes

src/lib/gadgets/arithmetic.ts Show resolved Hide resolved

src/lib/gadgets/arithmetic.ts Outdated Show resolved Hide resolved

src/lib/gadgets/bitwise.ts Show resolved Hide resolved

src/lib/gadgets/range-check.ts Outdated Show resolved Hide resolved

bump bindings

4d78fc0

Trivo25 commented Nov 22, 2023

View reviewed changes

src/lib/gadgets/range-check.ts Show resolved Hide resolved

Trivo25 added 4 commits November 22, 2023 13:44

fix return type opf witness

d370e29

limit input to 64bit, add tests

08069bb

adjust error message

954607e

Merge branch 'main' into feature/gadgets-uint

0878630

Trivo25 added 8 commits November 29, 2023 12:07

remove debug code

6da47bd

fix tests

2f18e5f

handle constant case

1b3ce9b

fix tests

ff91e1d

undo spacing in example

a0f1e5e

fix compile issue

de71797

clean up

fb2aabd

doc comment fix

b3d74df

mitschabaude reviewed Nov 29, 2023

View reviewed changes

mitschabaude approved these changes Nov 29, 2023

View reviewed changes

Trivo25 mentioned this pull request Nov 29, 2023

Add NOT gadget to Fields #1010

Closed

mitschabaude mentioned this pull request Dec 1, 2023

Twisted edwards curve operations #1283

Draft

mitschabaude reviewed Dec 4, 2023

View reviewed changes

src/lib/int.ts Outdated Show resolved Hide resolved

barriebyron reviewed Dec 5, 2023

View reviewed changes

src/lib/gadgets/gadgets.ts Outdated Show resolved Hide resolved

barriebyron mentioned this pull request Dec 5, 2023

docs: add bitwise operation gadgets to o1js o1-labs/docs2#737

Merged

Trivo25 added 11 commits December 15, 2023 11:53

Merge branch 'main' into feature/gadgets-uint

12942ed

return UInt instead of field

cfa4883

fix compilation, bump bindings

9702793

fix doc comment

7b5e8fa

remove unused imports

673c822

resolve dependency issue

108513c

resolve dependency issue, yet again

fc70678

return UInt32 instead of Field

a8ff0aa

changelog

d4f27be

Merge branch 'main' into feature/gadgets-uint

c1e6087

fix correct bindings

e2785ab

mitschabaude merged commit d68441b into main Dec 19, 2023
11 checks passed

mitschabaude deleted the feature/gadgets-uint branch December 19, 2023 10:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add gadgets to API surface, UInt32, UInt64, implement rot32 #1259

add gadgets to API surface, UInt32, UInt64, implement rot32 #1259

Trivo25 commented Nov 21, 2023 •

edited

mitschabaude Nov 29, 2023 •

edited

mitschabaude Nov 29, 2023 •

edited

mitschabaude left a comment

mitschabaude commented Dec 4, 2023

add gadgets to API surface, UInt32, UInt64, implement rot32 #1259

add gadgets to API surface, UInt32, UInt64, implement rot32 #1259

Conversation

Trivo25 commented Nov 21, 2023 • edited

mitschabaude Nov 29, 2023 • edited

Choose a reason for hiding this comment

mitschabaude Nov 29, 2023 • edited

Choose a reason for hiding this comment

mitschabaude left a comment

Choose a reason for hiding this comment

mitschabaude commented Dec 4, 2023

Trivo25 commented Nov 21, 2023 •

edited

mitschabaude Nov 29, 2023 •

edited

mitschabaude Nov 29, 2023 •

edited