diff --git a/barretenberg/ts/src/types/fields.ts b/barretenberg/ts/src/types/fields.ts index ef9d9188ced..ed4eec2ace0 100644 --- a/barretenberg/ts/src/types/fields.ts +++ b/barretenberg/ts/src/types/fields.ts @@ -3,6 +3,11 @@ import { toBigIntBE, toBufferBE } from '../bigint-array/index.js'; import { BufferReader, uint8ArrayToHexString } from '../serialize/index.js'; // TODO(#4189): Replace with implementation in yarn-project/foundation/src/fields/fields.ts +/** + * Fr field class. + * @dev This class is used to represent elements of BN254 scalar field or elements in the base field of Grumpkin. + * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.) + */ export class Fr { static ZERO = new Fr(0n); static MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n; @@ -57,6 +62,11 @@ export class Fr { } } +/** + * Fq field class. + * @dev This class is used to represent elements of BN254 base field or elements in the scalar field of Grumpkin. + * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.) + */ export class Fq { static MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n; static MAX_VALUE = this.MODULUS - 1n; diff --git a/yarn-project/foundation/src/fields/fields.ts b/yarn-project/foundation/src/fields/fields.ts index 42584f5f584..436003adbfd 100644 --- a/yarn-project/foundation/src/fields/fields.ts +++ b/yarn-project/foundation/src/fields/fields.ts @@ -190,6 +190,8 @@ export interface Fr { /** * Fr field class. + * @dev This class is used to represent elements of BN254 scalar field or elements in the base field of Grumpkin. + * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.) */ export class Fr extends BaseField { static ZERO = new Fr(0n); @@ -299,6 +301,8 @@ export interface Fq { /** * Fq field class. + * @dev This class is used to represent elements of BN254 base field or elements in the scalar field of Grumpkin. + * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.) */ export class Fq extends BaseField { static ZERO = new Fq(0n);