@aztec/foundation 0.15.0 → 0.15.1

package/src/json-rpc/client/json_rpc_client.ts

@@ -123,7 +123,9 @@ export function createJsonRpcClient<T extends object>(
     {},
     {
       get: (target, rpcMethod: string) => {
-        if (['then', 'catch'].includes(rpcMethod)) return Reflect.get(target, rpcMethod);
+        if (['then', 'catch'].includes(rpcMethod)) {
+          return Reflect.get(target, rpcMethod);
+        }
         return (...params: any[]) => {
           debug(format(`JsonRpcClient.constructor`, 'proxy', rpcMethod, '<-', params));
           return request(rpcMethod, params);

package/src/log/console.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { LogFn } from './index.js';
+import { LogFn } from './log_fn.js';
 
 /**
  * ConsoleLogger is a utility class that provides customizable console logging functionality.

package/src/log/debug.ts

@@ -1,6 +1,6 @@
 import debug from 'debug';
 
-import { LogFn } from './index.js';
+import { LogFn } from './log_fn.js';
 
 let preLogHook: ((...args: any[]) => void) | undefined;
 let postLogHook: ((...args: any[]) => void) | undefined;

package/src/log/index.ts

@@ -1,10 +1,5 @@
-/** Structured log data to include with the message. */
-export type LogData = Record<string, string | number | bigint | boolean>;
-
-/** A callable logger instance. */
-export type LogFn = (msg: string, data?: LogData) => void;
-
 export * from './console.js';
 export * from './debug.js';
 export * from './logger.js';
 export * from './log_history.js';
+export * from './log_fn.js';

package/src/log/log_fn.ts

@@ -0,0 +1,5 @@
+/** Structured log data to include with the message. */
+export type LogData = Record<string, string | number | bigint | boolean>;
+
+/** A callable logger instance. */
+export type LogFn = (msg: string, data?: LogData) => void;

package/src/log/logger.ts

@@ -2,7 +2,7 @@ import debug from 'debug';
 import isNode from 'detect-node';
 import { isatty } from 'tty';
 
-import { LogData, LogFn } from './index.js';
+import { LogData, LogFn } from './log_fn.js';
 
 // Matches a subset of Winston log levels
 const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug'] as const;
@@ -39,7 +39,9 @@ export type DebugLogger = LogFn & Logger;
  */
 export function createDebugLogger(name: string): DebugLogger {
   const debugLogger = debug(name);
-  if (currentLevel === 'debug') debugLogger.enabled = true;
+  if (currentLevel === 'debug') {
+    debugLogger.enabled = true;
+  }
 
   const logger = {
     silent: () => {},
@@ -78,7 +80,9 @@ function logWithDebug(debug: debug.Debugger, level: LogLevel, msg: string, data?
 
   msg = data ? `${msg} ${fmtLogData(data)}` : msg;
   if (debug.enabled) {
-    if (level !== 'debug') msg = `${level.toUpperCase()} ${msg}`;
+    if (level !== 'debug') {
+      msg = `${level.toUpperCase()} ${msg}`;
+    }
     debug(msg);
   } else if (LogLevels.indexOf(level) <= LogLevels.indexOf(currentLevel)) {
     printLog(`${getPrefix(debug, level)} ${msg}`);
@@ -94,7 +98,9 @@ function logWithDebug(debug: debug.Debugger, level: LogLevel, msg: string, data?
 function getPrefix(debugLogger: debug.Debugger, level: LogLevel) {
   const levelLabel = currentLevel !== level ? ` ${level.toUpperCase()}` : '';
   const prefix = `${debugLogger.namespace.replace(/^aztec:/, '')}${levelLabel}`;
-  if (!isNode || !isatty(process.stderr.fd)) return prefix;
+  if (!isNode || !isatty(process.stderr.fd)) {
+    return prefix;
+  }
   const colorIndex = debug.selectColor(debugLogger.namespace) as number;
   const colorCode = '\u001B[3' + (colorIndex < 8 ? colorIndex : '8;5;' + colorIndex);
   return `  ${colorCode};1m${prefix}\u001B[0m`;

package/src/serialize/buffer_reader.ts

@@ -1,4 +1,3 @@
-import { Fq, Fr } from '../fields/fields.js';
 import { Tuple } from './types.js';
 
 /**
@@ -83,27 +82,6 @@ export class BufferReader {
     return Buffer.from(this.buffer.subarray(this.index - n, this.index));
   }
 
-  /**
-   * Reads a Fr (finite field) element from the buffer using the 'fromBuffer' method of the Fr class.
-   * The Fr class should provide a 'fromBuffer' method that takes a BufferReader instance as input.
-   *
-   * @returns An instance of the Fr class representing the finite field element.
-   */
-  public readFr(): Fr {
-    return Fr.fromBuffer(this);
-  }
-
-  /**
-   * Reads the next Fq element from the buffer using the Fq.fromBuffer method.
-   * The Fq element represents a finite field in elliptic curve cryptography and is used for calculations.
-   * Advances the internal buffer index by the number of bytes read.
-   *
-   * @returns An Fq instance representing the finite field element.
-   */
-  public readFq(): Fq {
-    return Fq.fromBuffer(this);
-  }
-
   /**
    * Reads a vector of numbers from the buffer and returns it as an array of numbers.
    * The method utilizes the 'readVector' method, passing a deserializer that reads numbers.

package/src/serialize/free_funcs.ts

@@ -15,6 +15,17 @@ export function boolToByte(b: boolean) {
   return buf;
 }
 
+/**
+ * @param n - The input number to be converted to a big-endian unsigned 16-bit integer Buffer.
+ * @param bufferSize - Optional, the size of the output Buffer (default is 2).
+ * @returns A Buffer containing the big-endian unsigned 16-bit integer representation of the input number.
+ */
+export function numToUInt16BE(n: number, bufferSize = 2) {
+  const buf = Buffer.alloc(bufferSize);
+  buf.writeUInt16BE(n, bufferSize - 2);
+  return buf;
+}
+
 /**
  * Convert a number into a 4-byte little-endian unsigned integer buffer.
  * The input number is serialized as an unsigned 32-bit integer in little-endian byte order,

package/src/transport/interface/transferable.ts

@@ -36,7 +36,9 @@ export interface TransferDescriptor<T = any> {
  * @returns A boolean indicating whether the object is transferable.
  */
 function isTransferable(thing: any): thing is Transferable {
-  if (!thing || typeof thing !== 'object') return false;
+  if (!thing || typeof thing !== 'object') {
+    return false;
+  }
   // Don't check too thoroughly, since the list of transferable things in JS might grow over time
   return true;
 }
@@ -109,7 +111,9 @@ export function Transfer<T>(payload: T, transferables: Transferable[]): Transfer
  */
 export function Transfer<T>(payload: T, transferables?: Transferable[]): TransferDescriptor<T> {
   if (!transferables) {
-    if (!isTransferable(payload)) throw Error();
+    if (!isTransferable(payload)) {
+      throw Error();
+    }
     transferables = [payload];
   }
 

package/src/wasm/wasm_module.ts

@@ -232,7 +232,9 @@ export class WasmModule implements IWasmModule {
     addr = addr >>> 0;
     const m = this.getMemory();
     let i = addr;
-    for (; m[i] !== 0; ++i);
+    while (m[i] !== 0) {
+      ++i;
+    }
     return Buffer.from(m.slice(addr, i)).toString('ascii');
   }
 

package/dest/fields/grumpkin_scalar.d.ts

@@ -1,96 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { BufferReader } from '../serialize/buffer_reader.js';
-import { Fr } from './fields.js';
-/**
- * Represents a field element in a prime finite field with modulus defined by the constant MODULUS.
- * @remarks Called GrumpkinScalar because it is used to represent elements in Grumpkin's scalar field as defined in
- *          the Aztec Yellow Paper.
- */
-export declare class GrumpkinScalar {
-    /**
-     * The element's value as a bigint in the finite field.
-     */
-    readonly value: bigint;
-    static MODULUS: bigint;
-    static MAX_VALUE: bigint;
-    static SIZE_IN_BYTES: number;
-    private static HIGH_SHIFT;
-    private static LOW_MASK;
-    constructor(
-    /**
-     * The element's value as a bigint in the finite field.
-     */
-    value: bigint);
-    get low(): Fr;
-    get high(): Fr;
-    /**
-     * Deserialize a grumpkin scalar serialized in 2 Fr.
-     * @param high - The high Fr element.
-     * @param low - The low Fr element.
-     * @returns A GrumpkinScalar instance with the value of the two Fr elements.
-     */
-    static fromHighLow(high: Fr, low: Fr): GrumpkinScalar;
-    /**
-     * Generates a random GrumpkinScalar.
-     *
-     * @returns A new GrumpkinScalar instance with a randomly generated value.
-     */
-    static random(): GrumpkinScalar;
-    /**
-     * Create an instance of GrumpkinScalar from a given buffer or BufferReader.
-     * @remarks Reads SIZE_IN_BYTES from the provided buffer and converts it to a bigint, then creates a new instance
-     * with that value. Throws an error if the value is out of range for the calling class.
-     *
-     * @param buffer - The input buffer or BufferReader containing the bytes representing the value.
-     * @returns A GrumpkinScalar instance.
-     */
-    static fromBuffer(buffer: Buffer | BufferReader): GrumpkinScalar;
-    /**
-     * Like fromBuffer, but reduces the value modulo MODULUS.
-     *
-     * @param buffer - The Buffer or BufferReader containing the bytes representing the value.
-     * @returns GrumpkinScalar with the decoded value.
-     */
-    static fromBufferWithReduction(buffer: Buffer | BufferReader): GrumpkinScalar;
-    /**
-     * Create a GrumpkinScalar instance from a hex-encoded string.
-     * The input 'address' can be either prefixed with '0x' or not, and should have exactly 64 hex characters.
-     * Throws an error if the input length is invalid or the address value is out of range.
-     *
-     * @param address - The hex-encoded string representing the field element.
-     * @returns A GrumpkinScalar instance.
-     */
-    static fromString(address: string): GrumpkinScalar;
-    /**
-     * Converts the bigint value of the instance to a Buffer representation.
-     * The output buffer has a fixed size, determined by the 'SIZE_IN_BYTES' constant.
-     *
-     * @returns A Buffer containing the byte representation of the instance's value.
-     */
-    toBuffer(): Buffer;
-    /**
-     * Converts the GrumpkinScalar value to a hexadecimal string representation.
-     * The resulting string is prefixed with '0x' and contains the exact number of hex characters required
-     * to represent the numeric value of this instance.
-     *
-     * @param padTo32 - Whether to pad the resulting string to 32 bytes.
-     * @returns A hexadecimal string representing the GrumpkinScalar value.
-     */
-    toString(padTo32?: boolean): `0x${string}`;
-    /**
-     * Check if the value of the current instance is zero.
-     * This function compares the internal 'value' property with 0n (BigInt representation of zero).
-     * Returns true if the value is zero, otherwise returns false.
-     *
-     * @returns A boolean indicating whether the value is zero or not.
-     */
-    isZero(): boolean;
-    /**
-     * Converts the value of the GrumpkinScalar instance to a friendly JSON format.
-     * The output is a hexadecimal string representation of the value with '0x' prefix.
-     *
-     * @returns A string representing the value in the JSON format.
-     */
-    toFriendlyJSON(): `0x${string}`;
-}
-//# sourceMappingURL=grumpkin_scalar.d.ts.map

package/dest/fields/grumpkin_scalar.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"grumpkin_scalar.d.ts","sourceRoot":"","sources":["../../src/fields/grumpkin_scalar.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEjC;;;;GAIG;AACH,qBAAa,cAAc;IAUvB;;OAEG;aACa,KAAK,EAAE,MAAM;IAZ/B,MAAM,CAAC,OAAO,SAAuE;IACrF,MAAM,CAAC,SAAS,SAA+B;IAC/C,MAAM,CAAC,aAAa,SAAM;IAG1B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAkD;IAC3E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA0C;;IAG/D;;OAEG;IACa,KAAK,EAAE,MAAM;IAO/B,IAAI,GAAG,IAAI,EAAE,CAEZ;IAED,IAAI,IAAI,IAAI,EAAE,CAEb;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,cAAc;IAIrD;;;;OAIG;IACH,MAAM,CAAC,MAAM;IAKb;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAK/C;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAM5D;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM;IAIjC;;;;;OAKG;IACH,QAAQ;IAIR;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,UAAQ;IAIxB;;;;;;OAMG;IACH,MAAM;IAIN;;;;;OAKG;IACH,cAAc;CAGf"}

package/dest/fields/grumpkin_scalar.js

@@ -1,125 +0,0 @@
-import { toBigIntBE, toBufferBE, toHex } from '../bigint-buffer/index.js';
-import { randomBytes } from '../crypto/index.js';
-import { BufferReader } from '../serialize/buffer_reader.js';
-import { Fr } from './fields.js';
-/**
- * Represents a field element in a prime finite field with modulus defined by the constant MODULUS.
- * @remarks Called GrumpkinScalar because it is used to represent elements in Grumpkin's scalar field as defined in
- *          the Aztec Yellow Paper.
- */
-export class GrumpkinScalar {
-    constructor(
-    /**
-     * The element's value as a bigint in the finite field.
-     */
-    value) {
-        this.value = value;
-        if (value > GrumpkinScalar.MAX_VALUE) {
-            throw new Error(`GrumpkinScalar out of range ${value}.`);
-        }
-    }
-    get low() {
-        return new Fr(this.value & GrumpkinScalar.LOW_MASK);
-    }
-    get high() {
-        return new Fr(this.value >> GrumpkinScalar.HIGH_SHIFT);
-    }
-    /**
-     * Deserialize a grumpkin scalar serialized in 2 Fr.
-     * @param high - The high Fr element.
-     * @param low - The low Fr element.
-     * @returns A GrumpkinScalar instance with the value of the two Fr elements.
-     */
-    static fromHighLow(high, low) {
-        return new GrumpkinScalar((high.value << GrumpkinScalar.HIGH_SHIFT) + low.value);
-    }
-    /**
-     * Generates a random GrumpkinScalar.
-     *
-     * @returns A new GrumpkinScalar instance with a randomly generated value.
-     */
-    static random() {
-        const r = toBigIntBE(randomBytes(64)) % GrumpkinScalar.MODULUS;
-        return new this(r);
-    }
-    /**
-     * Create an instance of GrumpkinScalar from a given buffer or BufferReader.
-     * @remarks Reads SIZE_IN_BYTES from the provided buffer and converts it to a bigint, then creates a new instance
-     * with that value. Throws an error if the value is out of range for the calling class.
-     *
-     * @param buffer - The input buffer or BufferReader containing the bytes representing the value.
-     * @returns A GrumpkinScalar instance.
-     */
-    static fromBuffer(buffer) {
-        const reader = BufferReader.asReader(buffer);
-        return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
-    }
-    /**
-     * Like fromBuffer, but reduces the value modulo MODULUS.
-     *
-     * @param buffer - The Buffer or BufferReader containing the bytes representing the value.
-     * @returns GrumpkinScalar with the decoded value.
-     */
-    static fromBufferWithReduction(buffer) {
-        const reader = BufferReader.asReader(buffer);
-        const value = toBigIntBE(reader.readBytes(GrumpkinScalar.SIZE_IN_BYTES)) % GrumpkinScalar.MODULUS;
-        return new GrumpkinScalar(value);
-    }
-    /**
-     * Create a GrumpkinScalar instance from a hex-encoded string.
-     * The input 'address' can be either prefixed with '0x' or not, and should have exactly 64 hex characters.
-     * Throws an error if the input length is invalid or the address value is out of range.
-     *
-     * @param address - The hex-encoded string representing the field element.
-     * @returns A GrumpkinScalar instance.
-     */
-    static fromString(address) {
-        return GrumpkinScalar.fromBuffer(Buffer.from(address.replace(/^0x/i, ''), 'hex'));
-    }
-    /**
-     * Converts the bigint value of the instance to a Buffer representation.
-     * The output buffer has a fixed size, determined by the 'SIZE_IN_BYTES' constant.
-     *
-     * @returns A Buffer containing the byte representation of the instance's value.
-     */
-    toBuffer() {
-        return toBufferBE(this.value, GrumpkinScalar.SIZE_IN_BYTES);
-    }
-    /**
-     * Converts the GrumpkinScalar value to a hexadecimal string representation.
-     * The resulting string is prefixed with '0x' and contains the exact number of hex characters required
-     * to represent the numeric value of this instance.
-     *
-     * @param padTo32 - Whether to pad the resulting string to 32 bytes.
-     * @returns A hexadecimal string representing the GrumpkinScalar value.
-     */
-    toString(padTo32 = false) {
-        return toHex(this.value, padTo32);
-    }
-    /**
-     * Check if the value of the current instance is zero.
-     * This function compares the internal 'value' property with 0n (BigInt representation of zero).
-     * Returns true if the value is zero, otherwise returns false.
-     *
-     * @returns A boolean indicating whether the value is zero or not.
-     */
-    isZero() {
-        return this.value === 0n;
-    }
-    /**
-     * Converts the value of the GrumpkinScalar instance to a friendly JSON format.
-     * The output is a hexadecimal string representation of the value with '0x' prefix.
-     *
-     * @returns A string representing the value in the JSON format.
-     */
-    toFriendlyJSON() {
-        return this.toString();
-    }
-}
-GrumpkinScalar.MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n;
-GrumpkinScalar.MAX_VALUE = GrumpkinScalar.MODULUS - 1n;
-GrumpkinScalar.SIZE_IN_BYTES = 32;
-// The following constants are used to split a GrumpkinScalar into two Fr elements.
-GrumpkinScalar.HIGH_SHIFT = BigInt((GrumpkinScalar.SIZE_IN_BYTES / 2) * 8);
-GrumpkinScalar.LOW_MASK = (1n << GrumpkinScalar.HIGH_SHIFT) - 1n;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3J1bXBraW5fc2NhbGFyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpZWxkcy9ncnVtcGtpbl9zY2FsYXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFDMUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ2pELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUM3RCxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRWpDOzs7O0dBSUc7QUFDSCxNQUFNLE9BQU8sY0FBYztJQVN6QjtJQUNFOztPQUVHO0lBQ2EsS0FBYTtRQUFiLFVBQUssR0FBTCxLQUFLLENBQVE7UUFFN0IsSUFBSSxLQUFLLEdBQUcsY0FBYyxDQUFDLFNBQVMsRUFBRTtZQUNwQyxNQUFNLElBQUksS0FBSyxDQUFDLCtCQUErQixLQUFLLEdBQUcsQ0FBQyxDQUFDO1NBQzFEO0lBQ0gsQ0FBQztJQUVELElBQUksR0FBRztRQUNMLE9BQU8sSUFBSSxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssR0FBRyxjQUFjLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDdEQsQ0FBQztJQUVELElBQUksSUFBSTtRQUNOLE9BQU8sSUFBSSxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxjQUFjLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDekQsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLFdBQVcsQ0FBQyxJQUFRLEVBQUUsR0FBTztRQUNsQyxPQUFPLElBQUksY0FBYyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxjQUFjLENBQUMsVUFBVSxDQUFDLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ25GLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsTUFBTSxDQUFDLE1BQU07UUFDWCxNQUFNLENBQUMsR0FBRyxVQUFVLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEdBQUcsY0FBYyxDQUFDLE9BQU8sQ0FBQztRQUMvRCxPQUFPLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3JCLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsTUFBTSxDQUFDLFVBQVUsQ0FBQyxNQUE2QjtRQUM3QyxNQUFNLE1BQU0sR0FBRyxZQUFZLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLE9BQU8sSUFBSSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNwRSxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsdUJBQXVCLENBQUMsTUFBNkI7UUFDMUQsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUM3QyxNQUFNLEtBQUssR0FBRyxVQUFVLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxjQUFjLENBQUMsT0FBTyxDQUFDO1FBQ2xHLE9BQU8sSUFBSSxjQUFjLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDbkMsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxNQUFNLENBQUMsVUFBVSxDQUFDLE9BQWU7UUFDL0IsT0FBTyxjQUFjLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUNwRixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxRQUFRO1FBQ04sT0FBTyxVQUFVLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDOUQsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxRQUFRLENBQUMsT0FBTyxHQUFHLEtBQUs7UUFDdEIsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNwQyxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTTtRQUNKLE9BQU8sSUFBSSxDQUFDLEtBQUssS0FBSyxFQUFFLENBQUM7SUFDM0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsY0FBYztRQUNaLE9BQU8sSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBQ3pCLENBQUM7O0FBN0hNLHNCQUFPLEdBQUcsbUVBQW1FLENBQUM7QUFDOUUsd0JBQVMsR0FBRyxjQUFjLENBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztBQUN4Qyw0QkFBYSxHQUFHLEVBQUUsQ0FBQztBQUUxQixtRkFBbUY7QUFDcEUseUJBQVUsR0FBRyxNQUFNLENBQUMsQ0FBQyxjQUFjLENBQUMsYUFBYSxHQUFHLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO0FBQzVELHVCQUFRLEdBQUcsQ0FBQyxFQUFFLElBQUksY0FBYyxDQUFDLFVBQVUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyJ9

package/src/fields/grumpkin_scalar.ts

@@ -1,138 +0,0 @@
-import { toBigIntBE, toBufferBE, toHex } from '../bigint-buffer/index.js';
-import { randomBytes } from '../crypto/index.js';
-import { BufferReader } from '../serialize/buffer_reader.js';
-import { Fr } from './fields.js';
-
-/**
- * Represents a field element in a prime finite field with modulus defined by the constant MODULUS.
- * @remarks Called GrumpkinScalar because it is used to represent elements in Grumpkin's scalar field as defined in
- *          the Aztec Yellow Paper.
- */
-export class GrumpkinScalar {
-  static MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n;
-  static MAX_VALUE = GrumpkinScalar.MODULUS - 1n;
-  static SIZE_IN_BYTES = 32;
-
-  // The following constants are used to split a GrumpkinScalar into two Fr elements.
-  private static HIGH_SHIFT = BigInt((GrumpkinScalar.SIZE_IN_BYTES / 2) * 8);
-  private static LOW_MASK = (1n << GrumpkinScalar.HIGH_SHIFT) - 1n;
-
-  constructor(
-    /**
-     * The element's value as a bigint in the finite field.
-     */
-    public readonly value: bigint,
-  ) {
-    if (value > GrumpkinScalar.MAX_VALUE) {
-      throw new Error(`GrumpkinScalar out of range ${value}.`);
-    }
-  }
-
-  get low(): Fr {
-    return new Fr(this.value & GrumpkinScalar.LOW_MASK);
-  }
-
-  get high(): Fr {
-    return new Fr(this.value >> GrumpkinScalar.HIGH_SHIFT);
-  }
-
-  /**
-   * Deserialize a grumpkin scalar serialized in 2 Fr.
-   * @param high - The high Fr element.
-   * @param low - The low Fr element.
-   * @returns A GrumpkinScalar instance with the value of the two Fr elements.
-   */
-  static fromHighLow(high: Fr, low: Fr): GrumpkinScalar {
-    return new GrumpkinScalar((high.value << GrumpkinScalar.HIGH_SHIFT) + low.value);
-  }
-
-  /**
-   * Generates a random GrumpkinScalar.
-   *
-   * @returns A new GrumpkinScalar instance with a randomly generated value.
-   */
-  static random() {
-    const r = toBigIntBE(randomBytes(64)) % GrumpkinScalar.MODULUS;
-    return new this(r);
-  }
-
-  /**
-   * Create an instance of GrumpkinScalar from a given buffer or BufferReader.
-   * @remarks Reads SIZE_IN_BYTES from the provided buffer and converts it to a bigint, then creates a new instance
-   * with that value. Throws an error if the value is out of range for the calling class.
-   *
-   * @param buffer - The input buffer or BufferReader containing the bytes representing the value.
-   * @returns A GrumpkinScalar instance.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
-  }
-
-  /**
-   * Like fromBuffer, but reduces the value modulo MODULUS.
-   *
-   * @param buffer - The Buffer or BufferReader containing the bytes representing the value.
-   * @returns GrumpkinScalar with the decoded value.
-   */
-  static fromBufferWithReduction(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    const value = toBigIntBE(reader.readBytes(GrumpkinScalar.SIZE_IN_BYTES)) % GrumpkinScalar.MODULUS;
-    return new GrumpkinScalar(value);
-  }
-
-  /**
-   * Create a GrumpkinScalar instance from a hex-encoded string.
-   * The input 'address' can be either prefixed with '0x' or not, and should have exactly 64 hex characters.
-   * Throws an error if the input length is invalid or the address value is out of range.
-   *
-   * @param address - The hex-encoded string representing the field element.
-   * @returns A GrumpkinScalar instance.
-   */
-  static fromString(address: string) {
-    return GrumpkinScalar.fromBuffer(Buffer.from(address.replace(/^0x/i, ''), 'hex'));
-  }
-
-  /**
-   * Converts the bigint value of the instance to a Buffer representation.
-   * The output buffer has a fixed size, determined by the 'SIZE_IN_BYTES' constant.
-   *
-   * @returns A Buffer containing the byte representation of the instance's value.
-   */
-  toBuffer() {
-    return toBufferBE(this.value, GrumpkinScalar.SIZE_IN_BYTES);
-  }
-
-  /**
-   * Converts the GrumpkinScalar value to a hexadecimal string representation.
-   * The resulting string is prefixed with '0x' and contains the exact number of hex characters required
-   * to represent the numeric value of this instance.
-   *
-   * @param padTo32 - Whether to pad the resulting string to 32 bytes.
-   * @returns A hexadecimal string representing the GrumpkinScalar value.
-   */
-  toString(padTo32 = false) {
-    return toHex(this.value, padTo32);
-  }
-
-  /**
-   * Check if the value of the current instance is zero.
-   * This function compares the internal 'value' property with 0n (BigInt representation of zero).
-   * Returns true if the value is zero, otherwise returns false.
-   *
-   * @returns A boolean indicating whether the value is zero or not.
-   */
-  isZero() {
-    return this.value === 0n;
-  }
-
-  /**
-   * Converts the value of the GrumpkinScalar instance to a friendly JSON format.
-   * The output is a hexadecimal string representation of the value with '0x' prefix.
-   *
-   * @returns A string representing the value in the JSON format.
-   */
-  toFriendlyJSON() {
-    return this.toString();
-  }
-}