Class Field

Adds this Field element to another to a Field element.

let a = Field(3);
let sum = a.add(5)

Assert that this Field is either 0 or 1.

Field(0).assertBool();

Deprecated

Deprecated - use assertBool instead

Assert that this Field is either 0 or 1.

Field(0).assertBoolean();

Assert that this Field equals another Field-like value. Throws an error if the assertion fails.

Field(1).assertEquals(1);

Assert that this Field is greater than another Field-like value.

Field(1).assertGt(0);

Assert that this Field is greater than or equal to another Field-like value.

Field(1).assertGte(0);

Deprecated

Deprecated - use assertGreaterThan instead

Assert that this Field is greater than another Field-like value.

Field(1).assertGt(0);

Deprecated

Deprecated - use assertGreaterThanOrEqual instead

Assert that this Field is greater than or equal to another Field-like value.

Field(1).assertGte(0);

Assert that this Field is lower than another Field-like value.

Field(1).assertLessThan(2);

Assert that this Field is lower than or equal to another Field-like value.

Field(1).assertLessThanOrEqual(2);

Deprecated

Deprecated - use assertLessThan instead

Assert that this Field is lower than another Field-like value.

Field(1).assertLessThan(2);

Deprecated

Deprecated - use assertLessThanOrEqualinstead

Assert that this Field is lower than or equal to another Field-like value.

Field(1).assertLte(2);

Divides this Field element through another coercible to a field.

Check if this Field equals another Field-like value. Returns a Bool.

Field(2).equals(2); // Bool(true)

Creates a data structure from an array of serialized Field elements.

Check if this Field is greater than another Field-like value. Returns a Bool.

Field(2).greaterThan(1); // Bool(true)

Check if this Field is greater than or equal to another Field-like value. Returns a Bool.

Field(2).greaterThanOrEqual(1); // Bool(true)

Deprecated

Deprecated - use {@link greaterThan} instead

Check if this Field is greater than another Field-like value. Returns a Bool.

Field(2).gt(1); // Bool(true)

Deprecated

Deprecated - use greaterThanOrEqual instead

Check if this Field is greater than or equal to another Field-like value. Returns a Bool.

Field(2).gte(1); // Bool(true)

Inverts this Field element.

const invX = x.inv();
invX.assertEquals(Field(1).div(x));

Returns

A Field element that is equivalent to one divided by this element.

Checks whether this is a hard-coded constant in the Circuit.

Check if this Field is lower than another Field-like value. Returns a Bool.

Field(2).lessThan(3); // Bool(true)

Check if this Field is lower than or equal to another Field-like value. Returns a Bool.

Field(2).lessThanOrEqual(3); // Bool(true)

Deprecated

Deprecated - use lessThan instead

Check if this Field is lower than another Field-like value. Returns a Bool.

Field(2).lt(3); // Bool(true)

Deprecated

Deprecated - use lessThanOrEqual instead

Check if this Field is lower than or equal to another Field-like value. Returns a Bool.

Field(2).lte(3); // Bool(true)

Multiplies this Field element with another coercible to a field.

Negates this Field. This is equivalent to multiplying the Field by -1.

const negOne = Field(1).neg();
negOne.assertEquals(-1);

Returns the size of this type.

Square roots this Field element.

x.square().sqrt().assertEquals(x);

Squares this Field element.

const x2 = x.square();
x2.assertEquals(x.mul(x));

Subtracts another Field-like element from this one.

Serialize this instance of a Field to a bigint. This operation does NOT affect the circuit and can't be used to prove anything about the bigint representation of the Field.

Little endian binary representation of the field element.

Little endian binary representation of the field element. Fails if the field element cannot fit in length bits.

Returns a constant.

Serializes this data structure into Field elements.

Serialize this instance of a Field to a JSON string. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.

Serialize the Field to a string, e.g. for printing. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.

Converts a bit array into a field element (little endian) Fails if the field element cannot fit given too many bits.

Creates a data structure from an array of serialized Field elements.

Deserialize a JSON structure into a Field. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.

A random field element.

Returns the size of this type.

Static method to serialize a Field into its auxiliary data.

Static method to serialize a Field into an array of Field elements.

Serialize a Field to a JSON string. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.