Class Field

Hierarchy

Field

Index

Constructors

constructor

new Field(x: string | number | bigint | boolean | Field): Field

- Defined in snarky.d.ts:28
Coerces anything field-like to a Field.

Parameters
- x: string | number | bigint | boolean | Field
Returns Field

Properties

Static ORDER

ORDER: bigint

The field order as a bigint.

Static minusOne

minusOne: Field

The number -1 as a Field.

Static one

one: Field

The number 1 as a Field.

Static zero

zero: Field

The number 0 as a Field.

Methods

add

add(y: string | number | boolean | Field): Field

- Defined in snarky.d.ts:56
Adds this Field element to another coercible to a field.

Parameters
- y: string | number | boolean | Field
Returns Field

assertBoolean

assertBoolean(): void

- Defined in snarky.d.ts:216
Assert that this Field is either 0 or 1.
```
Field.zero.assertBoolean();
```
This function can only be called inside a checked computation, like a SmartContract method, and throws an error if the assertion fails.
Returns void

assertEquals

assertEquals(y: string | number | boolean | Field): void

- Defined in snarky.d.ts:205
Assert that this Field equals another Field-like value. Throws an error if the assertion fails.
```
Field.one.assertEquals(1);
```
Parameters
- y: string | number | boolean | Field
Returns void

assertGt

assertGt(y: string | number | boolean | Field): void

- Defined in snarky.d.ts:184
Assert that this Field is greater than another Field-like value.
```
Field.one.assertGt(0);
```
This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.
Parameters
- y: string | number | boolean | Field
Returns void

assertGte

assertGte(y: string | number | boolean | Field): void

- Defined in snarky.d.ts:195
Assert that this Field is greater than or equal to another Field-like value.
```
Field.one.assertGte(0);
```
This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.
Parameters
- y: string | number | boolean | Field
Returns void

assertLt

assertLt(y: string | number | boolean | Field): void

- Defined in snarky.d.ts:162
Assert that this Field is lower than another Field-like value.
```
Field.one.assertLt(2);
```
This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.
Parameters
- y: string | number | boolean | Field
Returns void

assertLte

assertLte(y: string | number | boolean | Field): void

- Defined in snarky.d.ts:173
Assert that this Field is lower than or equal to another Field-like value.
```
Field.one.assertLte(2);
```
This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.
Parameters
- y: string | number | boolean | Field
Returns void

div

div(y: string | number | boolean | Field): Field

- Defined in snarky.d.ts:71
Divides this Field element through another coercible to a field.

Parameters
- y: string | number | boolean | Field
Returns Field

equals

equals(y: string | number | boolean | Field): Bool

- Defined in snarky.d.ts:238
Check if this Field equals another Field-like value. Returns a Bool.
```
Field(2).equals(2); // Bool(true)
```
Parameters
- y: string | number | boolean | Field
Returns Bool

gt

gt(y: string | number | boolean | Field): Bool

- Defined in snarky.d.ts:140
Check if this Field is greater than another Field-like value. Returns a Bool.
```
Field(2).gt(1); // Bool(true)
```
Parameters
- y: string | number | boolean | Field
Returns Bool

gte

gte(y: string | number | boolean | Field): Bool

- Defined in snarky.d.ts:149
Check if this Field is greater than or equal to another Field-like value. Returns a Bool.
```
Field(2).gte(1); // Bool(true)
```
Parameters
- y: string | number | boolean | Field
Returns Bool

inv

inv(): Field

- Defined in snarky.d.ts:51
Inverts this Field element.
```
const invX = x.inv();
invX.assertEquals(Field.one.div(x));
```
Returns Field
A field element that is equivalent to one divided by this element.

isConstant

isConstant(): boolean

- Defined in snarky.d.ts:245
Returns boolean

isZero

isZero(): Bool

- Defined in snarky.d.ts:217
Returns Bool

lt

lt(y: string | number | boolean | Field): Bool

- Defined in snarky.d.ts:122
Check if this Field is lower than another Field-like value. Returns a Bool.
```
Field(2).lt(3); // Bool(true)
```
Parameters
- y: string | number | boolean | Field
Returns Bool

lte

lte(y: string | number | boolean | Field): Bool

- Defined in snarky.d.ts:131
Check if this Field is lower than or equal to another Field-like value. Returns a Bool.
```
Field(2).lte(3); // Bool(true)
```
Parameters
- y: string | number | boolean | Field
Returns Bool

mul

mul(y: string | number | boolean | Field): Field

- Defined in snarky.d.ts:66
Multiplies this Field element with another coercible to a field.

Parameters
- y: string | number | boolean | Field
Returns Field

neg

neg(): Field

- Defined in snarky.d.ts:39
Negates this Field. This is equivalent to multiplying the Field by -1.
```
const negOne = Field.one.neg();
negOne.assertEquals(-1);
```
Returns Field

ofFields

ofFields(fields: Field[]): Field

- Defined in snarky.d.ts:301
Parameters
- fields: Field[]
Returns Field

rangeCheckHelper

rangeCheckHelper(numBits: number): Field

- Defined in snarky.d.ts:243
Parameters
- numBits: number
Returns Field

seal

seal(): Field

- Defined in snarky.d.ts:241
Returns Field

sizeInFields

sizeInFields(): number

- Defined in snarky.d.ts:109
Returns number

sqrt

sqrt(): Field

- Defined in snarky.d.ts:90
Square roots this Field element.
```
x.square().sqrt().assertEquals(x);
```
Returns Field

square

square(): Field

- Defined in snarky.d.ts:81
Squares this Field element.
```
const x2 = x.square();
x2.assertEquals(x.mul(x));
```
Returns Field

sub

sub(y: string | number | boolean | Field): Field

- Defined in snarky.d.ts:61
Subtracts another Field-like element from this one.

Parameters
- y: string | number | boolean | Field
Returns Field

toBigInt

toBigInt(): bigint

- Defined in snarky.d.ts:101
Serialize the 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.

Returns bigint

toBits

toBits(): Bool[]
toBits(length: number): Bool[]

- Defined in snarky.d.ts:222
Little endian binary representation of the field element.

Returns Bool[]
- Defined in snarky.d.ts:228
Little endian binary representation of the field element. Fails if the field element cannot fit in length bits.

Parameters
- length: number
Returns Bool[]

toConstant

toConstant(): Field

- Defined in snarky.d.ts:246
Returns Field

toFields

toFields(): Field[]

- Defined in snarky.d.ts:111
Returns Field[]

toJSON

toJSON(): JSONValue

- Defined in snarky.d.ts:106
Serialize the 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.

Returns JSONValue

toString

toString(): string

- Defined in snarky.d.ts:96
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.

Returns string

Static check

check(x: Field): void

- Defined in snarky.d.ts:344
Parameters
- x: Field
Returns void

Static fromBigInt

fromBigInt(x: bigint): Field

- Defined in snarky.d.ts:342
Parameters
- x: bigint
Returns Field

Static fromJSON

fromJSON(x: JSONValue): null | Field

- Defined in snarky.d.ts:338
Parameters
- x: JSONValue
Returns null | Field

Static fromNumber

fromNumber(x: number): Field

- Defined in snarky.d.ts:341
Parameters
- x: number
Returns Field

Static fromString

fromString(x: string): Field

- Defined in snarky.d.ts:340
Parameters
- x: string
Returns Field

Static ofBits

ofBits(x: (boolean | Bool)[]): Field

- Defined in snarky.d.ts:325
Converts a bit array into a field element (little endian) Fails if the field element cannot fit given too many bits.

TODO: Rename to fromBits

Parameters
- x: (boolean | Bool)[]
Returns Field

Static ofFields

ofFields(fields: Field[]): Field

- Defined in snarky.d.ts:304
Parameters
- fields: Field[]
Returns Field

Static random

random(): Field

- Defined in snarky.d.ts:271
A random field element.

Returns Field

Static sizeInFields

sizeInFields(): number

- Defined in snarky.d.ts:306
Returns number

Static toFields

toFields(x: Field): Field[]

- Defined in snarky.d.ts:308
Parameters
- x: Field
Returns Field[]

Static toInput

toInput(x: Field): { fields: Field[] }

- Defined in snarky.d.ts:347
Parameters
- x: Field
Returns { fields: Field[] }
- fields: Field[]

Static toJSON

toJSON(x: Field): JSONValue

- Defined in snarky.d.ts:337
Parameters
- x: Field
Returns JSONValue

Generated using TypeDoc