Skip to main content
Version: 2.4.0

ForeignField

Defined in: lib/provable/foreign-field.ts:16

Extended by​

Constructors​

new ForeignField()​

new ForeignField(x: string | number | bigint | Field3 | ForeignField): ForeignField

Defined in: lib/provable/foreign-field.ts:91

Create a new ForeignField from a bigint, number, string or another ForeignField.

Parameters​

x​

string | number | bigint | Field3 | ForeignField

Returns​

ForeignField

Example​

let x = new ForeignField(5);

Note: Inputs must be range checked if they originate from a different field with a different modulus or if they are not constants.

  • When constructing from another ForeignField instance, ensure the modulus matches. If not, check the modulus using Gadgets.ForeignField.assertLessThan() and handle appropriately.
  • When constructing from a Field3 array, ensure all elements are valid Field elements and range checked.
  • Ensure constants are correctly reduced to the modulus of the field.

Properties​

value​

value: Field3;

Defined in: lib/provable/foreign-field.ts:39

The internal representation of a foreign field element, as a tuple of 3 limbs.

_Bigint​

static _Bigint: undefined | {} = undefined;

Defined in: lib/provable/foreign-field.ts:17

_modulus​

static _modulus: undefined | bigint = undefined;

Defined in: lib/provable/foreign-field.ts:18

_provable​

static _provable: any = undefined;

Defined in: lib/provable/foreign-field.ts:400

_variants​

static _variants: 
  | undefined
  | {
  almostReduced: typeof AlmostForeignField;
  canonical: typeof CanonicalForeignField;
  unreduced: typeof UnreducedForeignField;
 } = undefined;

Defined in: lib/provable/foreign-field.ts:48

Sibling classes that represent different ranges of field elements.

Accessors​

Constructor​

Get Signature​

get Constructor(): typeof ForeignField

Defined in: lib/provable/foreign-field.ts:41

Returns​

typeof ForeignField

modulus​

Get Signature​

get modulus(): bigint

Defined in: lib/provable/foreign-field.ts:29

Returns​

bigint

AlmostReduced​

Get Signature​

get static AlmostReduced(): typeof AlmostForeignField

Defined in: lib/provable/foreign-field.ts:66

Constructor for field elements that are "almost reduced", i.e. lie in the range [0, 2^ceil(log2(p))).

Returns​

typeof AlmostForeignField

Bigint​

Get Signature​

get static Bigint(): {}

Defined in: lib/provable/foreign-field.ts:21

Returns​
{}

Canonical​

Get Signature​

get static Canonical(): typeof CanonicalForeignField

Defined in: lib/provable/foreign-field.ts:73

Constructor for field elements that are fully reduced, i.e. lie in the range [0, p).

Returns​

typeof CanonicalForeignField

modulus​

Get Signature​

get static modulus(): bigint

Defined in: lib/provable/foreign-field.ts:25

Returns​

bigint

provable​

Get Signature​

get static provable(): any

Defined in: lib/provable/foreign-field.ts:405

Provable<ForeignField>, see Provable

Returns​

any

sizeInBits​

Get Signature​

get static sizeInBits(): number

Defined in: lib/provable/foreign-field.ts:32

Returns​

number

Unreduced​

Get Signature​

get static Unreduced(): typeof UnreducedForeignField

Defined in: lib/provable/foreign-field.ts:59

Constructor for unreduced field elements.

Returns​

typeof UnreducedForeignField

Methods​

add()​

add(y: number | bigint | ForeignField): UnreducedForeignField

Defined in: lib/provable/foreign-field.ts:210

Finite field addition

Parameters​

y​

number | bigint | ForeignField

Returns​

UnreducedForeignField

Example​

x.add(2); // x + 2 mod p

assertAlmostReduced()​

assertAlmostReduced(): AlmostForeignField

Defined in: lib/provable/foreign-field.ts:165

Assert that this field element lies in the range [0, 2^k), where k = ceil(log2(p)) and p is the foreign field modulus.

Returns the field element as a AlmostForeignField.

For a more efficient version of this for multiple field elements, see assertAlmostReduced.

Note: this does not ensure that the field elements is in the canonical range [0, p). To assert that stronger property, there is assertCanonical. You should typically use assertAlmostReduced though, because it is cheaper to prove and sufficient for ensuring validity of all our non-native field arithmetic methods.

Returns​

AlmostForeignField

assertCanonical()​

assertCanonical(): CanonicalForeignField

Defined in: lib/provable/foreign-field.ts:196

Assert that this field element is fully reduced, i.e. lies in the range [0, p), where p is the foreign field modulus.

Returns the field element as a CanonicalForeignField.

Returns​

CanonicalForeignField

assertEquals()​

Call Signature​

assertEquals(y: number | bigint | CanonicalForeignField, message?: string): CanonicalForeignField

Defined in: lib/provable/foreign-field.ts:288

Assert equality with a ForeignField-like value

Parameters​
y​

number | bigint | CanonicalForeignField

message?​

string

Returns​

CanonicalForeignField

Examples​
x.assertEquals(0, "x is zero");

Since asserting equality can also serve as a range check, this method returns x with the appropriate type:

let xChecked = x.assertEquals(1, "x is 1");
xChecked satisfies CanonicalForeignField;

Call Signature​

assertEquals(y: AlmostForeignField, message?: string): AlmostForeignField

Defined in: lib/provable/foreign-field.ts:289

Assert equality with a ForeignField-like value

Parameters​
y​

AlmostForeignField

message?​

string

Returns​

AlmostForeignField

Examples​
x.assertEquals(0, "x is zero");

Since asserting equality can also serve as a range check, this method returns x with the appropriate type:

let xChecked = x.assertEquals(1, "x is 1");
xChecked satisfies CanonicalForeignField;

Call Signature​

assertEquals(y: ForeignField, message?: string): ForeignField

Defined in: lib/provable/foreign-field.ts:290

Assert equality with a ForeignField-like value

Parameters​
y​

ForeignField

message?​

string

Returns​

ForeignField

Examples​
x.assertEquals(0, "x is zero");

Since asserting equality can also serve as a range check, this method returns x with the appropriate type:

let xChecked = x.assertEquals(1, "x is 1");
xChecked satisfies CanonicalForeignField;

assertLessThan()​

assertLessThan(c: number | bigint, message?: string): void

Defined in: lib/provable/foreign-field.ts:325

Assert that this field element is less than a constant c: x < c.

The constant must satisfy 0 <= c < 2^264, otherwise an error is thrown.

Parameters​

c​

number | bigint

message?​

string

Returns​

void

Example​

x.assertLessThan(10);

neg()​

neg(): AlmostForeignField

Defined in: lib/provable/foreign-field.ts:221

Finite field negation

Returns​

AlmostForeignField

Example​

x.neg(); // -x mod p = p - x

sub()​

sub(y: number | bigint | ForeignField): UnreducedForeignField

Defined in: lib/provable/foreign-field.ts:236

Finite field subtraction

Parameters​

y​

number | bigint | ForeignField

Returns​

UnreducedForeignField

Example​

x.sub(1); // x - 1 mod p

toBigInt()​

toBigInt(): bigint

Defined in: lib/provable/foreign-field.ts:148

Convert this field element to a bigint.

Returns​

bigint

toBits()​

toBits(length?: number): Bool[]

Defined in: lib/provable/foreign-field.ts:344

Unpack a field element to its bits, as a Bool[] array.

This method is provable!

Parameters​

length?​

number

Returns​

Bool[]

toFields()​

toFields(): Field[]

Defined in: lib/provable/foreign-field.ts:392

Instance version of Provable<ForeignField>.toFields, see Provable.toFields

Returns​

Field[]

assertAlmostReduced()​

static assertAlmostReduced<T>(...xs: T): [...{ [i in string | number | symbol]: AlmostForeignField }[]]

Defined in: lib/provable/foreign-field.ts:179

Assert that one or more field elements lie in the range [0, 2^k), where k = ceil(log2(p)) and p is the foreign field modulus.

This is most efficient than when checking a multiple of 3 field elements at once.

Type Parameters​

• T extends Tuple<ForeignField>

Parameters​

xs​

...T

Returns​

[...{ [i in string | number | symbol]: AlmostForeignField }[]]

check()​

static check(_: ForeignField): void

Defined in: lib/provable/foreign-field.ts:396

Parameters​

_​

ForeignField

Returns​

void

from()​

Call Signature​

static from(x: string | number | bigint): CanonicalForeignField

Defined in: lib/provable/foreign-field.ts:114

Coerce the input to a ForeignField.

Parameters​
x​

string | number | bigint

Returns​

CanonicalForeignField

Call Signature​

static from(x: string | number | bigint | ForeignField): ForeignField

Defined in: lib/provable/foreign-field.ts:115

Coerce the input to a ForeignField.

Parameters​
x​

string | number | bigint | ForeignField

Returns​

ForeignField

fromBits()​

static fromBits(bits: Bool[]): AlmostForeignField

Defined in: lib/provable/foreign-field.ts:374

Create a field element from its bits, as a Bool[] array.

This method is provable!

Parameters​

bits​

Bool[]

Returns​

AlmostForeignField

random()​

static random(): CanonicalForeignField

Defined in: lib/provable/foreign-field.ts:385

Returns​

CanonicalForeignField

sum()​

static sum(xs: (number | bigint | ForeignField)[], operations: (-1 | 1)[]): UnreducedForeignField

Defined in: lib/provable/foreign-field.ts:261

Sum (or difference) of multiple finite field elements.

Parameters​

xs​

(number | bigint | ForeignField)[]

operations​

(-1 | 1)[]

Returns​

UnreducedForeignField

Example​

let z = ForeignField.sum([3, 2, 1], [-1, 1]); // 3 - 2 + 1
z.assertEquals(2);

This method expects a list of ForeignField-like values, x0,...,xn, and a list of "operations" op1,...,opn where every op is 1 or -1 (plus or minus), and returns

x0 + op1*x1 + ... + opn*xn

where the sum is computed in finite field arithmetic.

Important: For more than two summands, this is significantly more efficient than chaining calls to ForeignField.add and ForeignField.sub.