@aztec/foundation 0.7.2 → 0.7.4

package/dest/fields/fields.js

@@ -0,0 +1,219 @@
+import { toBigIntBE, toBufferBE, toHex } from '../bigint-buffer/index.js';
+import { randomBytes } from '../crypto/index.js';
+import { BufferReader } from '../serialize/buffer_reader.js';
+/**
+ * Fr represents a field of integers modulo the prime number MODULUS.
+ * It provides utility functions to work with elements in this field, such as conversions between different representations and checks for equality and zero values. The elements can be serialized to and deserialized from byte buffers or strings.
+ * Some use cases include working with cryptographic operations and finite fields.
+ */
+export class Fr {
+    constructor(value) {
+        const isFr = (value) => !!value.toBigInt;
+        this.value = isFr(value) ? value.toBigInt() : BigInt(value);
+        if (this.value > Fr.MAX_VALUE) {
+            throw new Error(`Fr out of range ${value}.`);
+        }
+    }
+    /**
+     * Generates a random Fr or Fq instance with a value modulo the respective class' MODULUS.
+     * This method uses randomBytes to generate a random 32-byte buffer, converts it to a bigint
+     * and takes the modulus of the result with the class' MODULUS constant.
+     *
+     * @returns A new Fr or Fq instance with a random value.
+     */
+    static random() {
+        const r = toBigIntBE(randomBytes(Fr.SIZE_IN_BYTES)) % Fr.MODULUS;
+        return new Fr(r);
+    }
+    /**
+     * Returns a new zero-value field.
+     * @returns A new zero-value field.
+     */
+    static zero() {
+        return new Fr(0n);
+    }
+    /**
+     * Create an instance of the corresponding class (Fr or Fq) from a Buffer or a BufferReader.
+     * Reads 'SIZE_IN_BYTES' bytes from the given Buffer or BufferReader and constructs an instance with the decoded value.
+     * If the input is a Buffer, it is internally converted to a BufferReader before reading.
+     * Throws an error if the input length is invalid or the decoded value is out of range.
+     *
+     * @param buffer - The Buffer or BufferReader containing the bytes representing the value.
+     * @returns An instance of the corresponding class (Fr or Fq) with the decoded value.
+     */
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new Fr(toBigIntBE(reader.readBytes(Fr.SIZE_IN_BYTES)));
+    }
+    /**
+     * Create a Fr 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 Fr instance.
+     */
+    static fromString(address) {
+        return Fr.fromBuffer(Buffer.from(address.replace(/^0x/i, ''), 'hex'));
+    }
+    /**
+     * Converts the value of the instance to a buffer with a specified length.
+     * The method uses the provided value and size in bytes to create a buffer representation
+     * of the numeric value. This can be useful for serialization and communication purposes.
+     *
+     * @returns A buffer representing the instance's value.
+     */
+    toBuffer() {
+        return toBufferBE(this.value, Fr.SIZE_IN_BYTES);
+    }
+    /**
+     * Converts the value of the Fr or Fq class instance to a hexadecimal string.
+     * The resulting string is prefixed with '0x' and represents the bigint value
+     * in base 16.
+     *
+     * @param padTo32 - Whether to pad the string to 32 bytes.
+     * @returns A hex-encoded string representing the value of the class instance.
+     */
+    toString(padTo32 = false) {
+        return toHex(this.value, padTo32);
+    }
+    /**
+     * Retrieves the underlying bigint.
+     * This method mostly exists to match user expectations, as value is already public.
+     * @returns The underlying bigint.
+     */
+    toBigInt() {
+        return this.value;
+    }
+    /**
+     * Returns a shortened string representation of the Fr value, formatted with '0x' prefix and ellipsis in the middle.
+     * The resulting string has first 10 characters (including '0x') and last 4 characters of the full hexadecimal value.
+     *
+     * @returns A shorter, human-readable string representation of the Fr value.
+     */
+    toShortString() {
+        const str = this.toString();
+        return `${str.slice(0, 10)}...${str.slice(-4)}`;
+    }
+    /**
+     * Checks if the provided Fr instance is equal to the current instance.
+     * Two instances are considered equal if their 'value' properties are the same.
+     *
+     * @param rhs - The Fr instance to compare with the current instance.
+     * @returns A boolean indicating whether the two instances are equal.
+     */
+    equals(rhs) {
+        return this.value === rhs.value;
+    }
+    /**
+     * Check if the instance value is zero.
+     * The method returns true if the value of the instance is 0n (zero in BigInt representation),
+     * otherwise, it returns false.
+     *
+     * @returns A boolean indicating whether the instance value is zero or not.
+     */
+    isZero() {
+        return this.value === 0n;
+    }
+    /**
+     * Converts the current value of the Fq or Fr instance to a friendly JSON representation.
+     * The output will be a hexadecimal string prefixed with '0x'.
+     *
+     * @returns A '0x' prefixed hexadecimal string representing the current value.
+     */
+    toFriendlyJSON() {
+        return this.toString();
+    }
+}
+Fr.ZERO = new Fr(0n);
+Fr.MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
+Fr.MAX_VALUE = Fr.MODULUS - 1n;
+Fr.SIZE_IN_BYTES = 32;
+/**
+ * Fq represents a field element in a prime finite field with modulus defined by the constant MODULUS.
+ * It provides methods for creating, manipulating, and comparing field elements, as well as converting
+ * them to/from different data types like Buffers and hex strings. Field elements are used in various
+ * cryptographic protocols and operations, such as elliptic curve cryptography.
+ *
+ * @example
+ * const fqElem = new Fq(BigInt("123456789"));
+ * const randomFqElem = Fq.random();
+ * const fromBufferFqElem = Fq.fromBuffer(buffer);
+ */
+export class Fq {
+    constructor(
+    /**
+     * The element's value as a bigint in the finite field.
+     */
+    value) {
+        this.value = value;
+        if (value > Fq.MAX_VALUE) {
+            throw new Error(`Fq out of range ${value}.`);
+        }
+    }
+    /**
+     * Generates a random Fr or Fq instance with a value within the range of their respective modulus.
+     * The random value is generated from a byte array of length equal to SIZE_IN_BYTES, then truncated
+     * to the appropriate modulus before creating the new Fr or Fq instance.
+     *
+     * @returns A new Fr or Fq instance with a randomly generated value.
+     */
+    static random() {
+        const r = toBigIntBE(randomBytes(64)) % Fq.MODULUS;
+        return new this(r);
+    }
+    /**
+     * Create an instance of the calling class (Fr or Fq) from a given buffer or BufferReader.
+     * 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 An instance of the calling class (Fr or Fq) initialized with the bigint value.
+     */
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
+    }
+    /**
+     * 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, Fq.SIZE_IN_BYTES);
+    }
+    /**
+     * Converts the Fq 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.
+     *
+     * @returns A hexadecimal string representing the Fq value.
+     */
+    toString() {
+        return toHex(this.value);
+    }
+    /**
+     * 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 Fr or Fq 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();
+    }
+}
+Fq.MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n;
+Fq.MAX_VALUE = Fr.MODULUS - 1n;
+Fq.SIZE_IN_BYTES = 32;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmllbGRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpZWxkcy9maWVsZHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLFVBQVUsRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFDMUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ2pELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUU3RDs7OztHQUlHO0FBQ0gsTUFBTSxPQUFPLEVBQUU7SUFXYixZQUFZLEtBQTBDO1FBQ3BELE1BQU0sSUFBSSxHQUFHLENBQUMsS0FBMEMsRUFBOEIsRUFBRSxDQUFDLENBQUMsQ0FBRSxLQUFZLENBQUMsUUFBUSxDQUFDO1FBQ2xILElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUM1RCxJQUFJLElBQUksQ0FBQyxLQUFLLEdBQUcsRUFBRSxDQUFDLFNBQVMsRUFBRTtZQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLG1CQUFtQixLQUFLLEdBQUcsQ0FBQyxDQUFDO1NBQzlDO0lBQ0gsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILE1BQU0sQ0FBQyxNQUFNO1FBQ1gsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQyxFQUFFLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDO1FBQ2pFLE9BQU8sSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDbkIsQ0FBQztJQUVEOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxJQUFJO1FBQ1QsT0FBTyxJQUFJLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNwQixDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxNQUFNLENBQUMsVUFBVSxDQUFDLE1BQTZCO1FBQzdDLE1BQU0sTUFBTSxHQUFHLFlBQVksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDN0MsT0FBTyxJQUFJLEVBQUUsQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ2hFLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsTUFBTSxDQUFDLFVBQVUsQ0FBQyxPQUFlO1FBQy9CLE9BQU8sRUFBRSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLEVBQUUsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUM7SUFDeEUsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILFFBQVE7UUFDTixPQUFPLFVBQVUsQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILFFBQVEsQ0FBQyxPQUFPLEdBQUcsS0FBSztRQUN0QixPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ3BDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksUUFBUTtRQUNiLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxhQUFhO1FBQ1gsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQzVCLE9BQU8sR0FBRyxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsTUFBTSxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTSxDQUFDLEdBQU87UUFDWixPQUFPLElBQUksQ0FBQyxLQUFLLEtBQUssR0FBRyxDQUFDLEtBQUssQ0FBQztJQUNsQyxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTTtRQUNKLE9BQU8sSUFBSSxDQUFDLEtBQUssS0FBSyxFQUFFLENBQUM7SUFDM0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsY0FBYztRQUNaLE9BQU8sSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBQ3pCLENBQUM7O0FBeklNLE9BQUksR0FBRyxJQUFJLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQztBQUNsQixVQUFPLEdBQUcsbUVBQW1FLENBQUM7QUFDOUUsWUFBUyxHQUFHLEVBQUUsQ0FBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO0FBQzVCLGdCQUFhLEdBQUcsRUFBRSxDQUFDO0FBeUk1Qjs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxPQUFPLEVBQUU7SUFLYjtJQUNFOztPQUVHO0lBQ2EsS0FBYTtRQUFiLFVBQUssR0FBTCxLQUFLLENBQVE7UUFFN0IsSUFBSSxLQUFLLEdBQUcsRUFBRSxDQUFDLFNBQVMsRUFBRTtZQUN4QixNQUFNLElBQUksS0FBSyxDQUFDLG1CQUFtQixLQUFLLEdBQUcsQ0FBQyxDQUFDO1NBQzlDO0lBQ0gsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILE1BQU0sQ0FBQyxNQUFNO1FBQ1gsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQyxFQUFFLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUM7UUFDbkQsT0FBTyxJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNyQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILE1BQU0sQ0FBQyxVQUFVLENBQUMsTUFBNkI7UUFDN0MsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUM3QyxPQUFPLElBQUksSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDcEUsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsUUFBUTtRQUNOLE9BQU8sVUFBVSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQ2xELENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxRQUFRO1FBQ04sT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxNQUFNO1FBQ0osT0FBTyxJQUFJLENBQUMsS0FBSyxLQUFLLEVBQUUsQ0FBQztJQUMzQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxjQUFjO1FBQ1osT0FBTyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDekIsQ0FBQzs7QUFoRk0sVUFBTyxHQUFHLG1FQUFtRSxDQUFDO0FBQzlFLFlBQVMsR0FBRyxFQUFFLENBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztBQUM1QixnQkFBYSxHQUFHLEVBQUUsQ0FBQyJ9

package/dest/fields/grumpkin_scalar.d.ts

@@ -0,0 +1,96 @@
+/// <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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,125 @@
+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/dest/fields/grumpkin_scalar.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=grumpkin_scalar.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"grumpkin_scalar.test.d.ts","sourceRoot":"","sources":["../../src/fields/grumpkin_scalar.test.ts"],"names":[],"mappings":""}

package/dest/fields/grumpkin_scalar.test.js

@@ -0,0 +1,45 @@
+import { GrumpkinScalar } from './grumpkin_scalar.js';
+describe('GrumpkinScalar Serialization', () => {
+    // Test case for GrumpkinScalar.fromHighLow
+    it('fromHighLow should serialize and deserialize correctly', () => {
+        const original = GrumpkinScalar.random();
+        const high = original.high;
+        const low = original.low;
+        const deserialized = GrumpkinScalar.fromHighLow(high, low);
+        // Check if the deserialized instance is equal to the original
+        expect(deserialized).toEqual(original);
+    });
+    // Test case for GrumpkinScalar.fromBuffer
+    it('fromBuffer should serialize and deserialize correctly', () => {
+        const original = GrumpkinScalar.random();
+        const buffer = original.toBuffer();
+        const deserialized = GrumpkinScalar.fromBuffer(buffer);
+        // Check if the deserialized instance is equal to the original
+        expect(deserialized).toEqual(original);
+    });
+    // Test case for GrumpkinScalar.fromString
+    it('fromString should serialize and deserialize correctly', () => {
+        const original = GrumpkinScalar.random();
+        const hexString = original.toString();
+        const deserialized = GrumpkinScalar.fromString(hexString);
+        // Check if the deserialized instance is equal to the original
+        expect(deserialized).toEqual(original);
+    });
+    // Test case for GrumpkinScalar.toBuffer
+    it('toBuffer should serialize and deserialize correctly', () => {
+        const original = GrumpkinScalar.random();
+        const buffer = original.toBuffer();
+        const deserialized = GrumpkinScalar.fromBuffer(buffer);
+        // Check if the deserialized instance is equal to the original
+        expect(deserialized).toEqual(original);
+    });
+    // Test case for GrumpkinScalar.toString
+    it('toString should serialize and deserialize correctly', () => {
+        const original = GrumpkinScalar.random();
+        const hexString = original.toString();
+        const deserialized = GrumpkinScalar.fromString(hexString);
+        // Check if the deserialized instance is equal to the original
+        expect(deserialized).toEqual(original);
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3J1bXBraW5fc2NhbGFyLnRlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmllbGRzL2dydW1wa2luX3NjYWxhci50ZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxjQUFjLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQUV0RCxRQUFRLENBQUMsOEJBQThCLEVBQUUsR0FBRyxFQUFFO0lBQzVDLDJDQUEyQztJQUMzQyxFQUFFLENBQUMsd0RBQXdELEVBQUUsR0FBRyxFQUFFO1FBQ2hFLE1BQU0sUUFBUSxHQUFHLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN6QyxNQUFNLElBQUksR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDO1FBQzNCLE1BQU0sR0FBRyxHQUFHLFFBQVEsQ0FBQyxHQUFHLENBQUM7UUFFekIsTUFBTSxZQUFZLEdBQUcsY0FBYyxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUM7UUFFM0QsOERBQThEO1FBQzlELE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDekMsQ0FBQyxDQUFDLENBQUM7SUFFSCwwQ0FBMEM7SUFDMUMsRUFBRSxDQUFDLHVEQUF1RCxFQUFFLEdBQUcsRUFBRTtRQUMvRCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekMsTUFBTSxNQUFNLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ25DLE1BQU0sWUFBWSxHQUFHLGNBQWMsQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUM7UUFFdkQsOERBQThEO1FBQzlELE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDekMsQ0FBQyxDQUFDLENBQUM7SUFFSCwwQ0FBMEM7SUFDMUMsRUFBRSxDQUFDLHVEQUF1RCxFQUFFLEdBQUcsRUFBRTtRQUMvRCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekMsTUFBTSxTQUFTLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sWUFBWSxHQUFHLGNBQWMsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUM7UUFFMUQsOERBQThEO1FBQzlELE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDekMsQ0FBQyxDQUFDLENBQUM7SUFFSCx3Q0FBd0M7SUFDeEMsRUFBRSxDQUFDLHFEQUFxRCxFQUFFLEdBQUcsRUFBRTtRQUM3RCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekMsTUFBTSxNQUFNLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ25DLE1BQU0sWUFBWSxHQUFHLGNBQWMsQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUM7UUFFdkQsOERBQThEO1FBQzlELE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDekMsQ0FBQyxDQUFDLENBQUM7SUFFSCx3Q0FBd0M7SUFDeEMsRUFBRSxDQUFDLHFEQUFxRCxFQUFFLEdBQUcsRUFBRTtRQUM3RCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekMsTUFBTSxTQUFTLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sWUFBWSxHQUFHLGNBQWMsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUM7UUFFMUQsOERBQThEO1FBQzlELE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDekMsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUMsQ0FBQyJ9

package/dest/fields/index.d.ts

@@ -0,0 +1,5 @@
+export * from './fields.js';
+export * from './point.js';
+export * from './coordinate.js';
+export * from './grumpkin_scalar.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fields/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

package/dest/fields/index.js

@@ -0,0 +1,5 @@
+export * from './fields.js';
+export * from './point.js';
+export * from './coordinate.js';
+export * from './grumpkin_scalar.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmllbGRzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsaUJBQWlCLENBQUM7QUFDaEMsY0FBYyxzQkFBc0IsQ0FBQyJ9

package/dest/fields/point.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="node" resolution-mode="require"/>
+import { BufferReader } from '../serialize/buffer_reader.js';
+import { Fr } from './fields.js';
+/**
+ * Represents a Point on an elliptic curve with x and y coordinates.
+ * The Point class provides methods for creating instances from different input types,
+ * converting instances to various output formats, and checking the equality of points.
+ */
+export declare class Point {
+    /**
+     * The point's x coordinate
+     */
+    readonly x: Fr;
+    /**
+     * The point's y coordinate
+     */
+    readonly y: Fr;
+    static ZERO: Point;
+    static SIZE_IN_BYTES: number;
+    /** Used to differentiate this class from AztecAddress */
+    readonly kind = "point";
+    constructor(
+    /**
+     * The point's x coordinate
+     */
+    x: Fr, 
+    /**
+     * The point's y coordinate
+     */
+    y: Fr);
+    /**
+     * Generate a random Point instance.
+     *
+     * @returns A randomly generated Point instance.
+     */
+    static random(): Point;
+    /**
+     * Create a Point instance from a given buffer or BufferReader.
+     * The input 'buffer' should have exactly 64 bytes representing the x and y coordinates.
+     *
+     * @param buffer - The buffer or BufferReader containing the x and y coordinates of the point.
+     * @returns A Point instance.
+     */
+    static fromBuffer(buffer: Buffer | BufferReader): Point;
+    /**
+     * Create a Point instance from a hex-encoded string.
+     * The input 'address' should be prefixed with '0x' or not, and have exactly 128 hex characters representing the x and y coordinates.
+     * Throws an error if the input length is invalid or coordinate values are out of range.
+     *
+     * @param address - The hex-encoded string representing the Point coordinates.
+     * @returns A Point instance.
+     */
+    static fromString(address: string): Point;
+    /**
+     * Returns the contents of the point as an array of 2 fields.
+     * @returns The point as an array of 2 fields
+     */
+    toFields(): Fr[];
+    /**
+     * Returns the contents of the point as BigInts.
+     * @returns The point as BigInts
+     */
+    toBigInts(): {
+        x: bigint;
+        y: bigint;
+    };
+    /**
+     * Converts the Point instance to a Buffer representaion of the coordinates.
+     * The outputs buffer length will be 64, the length of both coordinates not represented as fields.
+     * @returns A Buffer representation of the Point instance.
+     */
+    toBuffer(): Buffer;
+    /**
+     * Convert the Point instance to a hexadecimal string representation.
+     * The output string is prefixed with '0x' and consists of exactly 128 hex characters,
+     * representing the concatenated x and y coordinates of the point.
+     *
+     * @returns A hex-encoded string representing the Point instance.
+     */
+    toString(): string;
+    /**
+     * Generate a short string representation of the Point instance.
+     * The returned string includes the first 10 and last 4 characters of the full string representation,
+     * with '...' in between to indicate truncation. This is useful for displaying or logging purposes
+     * when the full string representation may be too long.
+     *
+     * @returns A truncated string representation of the Point instance.
+     */
+    toShortString(): string;
+    /**
+     * Check if two Point instances are equal by comparing their buffer values.
+     * Returns true if the buffer values are the same, and false otherwise.
+     *
+     * @param rhs - The Point instance to compare with the current instance.
+     * @returns A boolean indicating whether the two Point instances are equal.
+     */
+    equals(rhs: Point): boolean;
+}
+/**
+ * Does this object look like a point?
+ * @param obj - Object to test if it is a point.
+ * @returns Whether it looks like a point.
+ */
+export declare function isPoint(obj: object): obj is Point;
+//# sourceMappingURL=point.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"point.d.ts","sourceRoot":"","sources":["../../src/fields/point.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEjC;;;;GAIG;AACH,qBAAa,KAAK;IAQd;;OAEG;aACa,CAAC,EAAE,EAAE;IACrB;;OAEG;aACa,CAAC,EAAE,EAAE;IAdvB,MAAM,CAAC,IAAI,QAA+B;IAC1C,MAAM,CAAC,aAAa,SAAwB;IAE5C,yDAAyD;IACzD,SAAgB,IAAI,WAAW;;IAG7B;;OAEG;IACa,CAAC,EAAE,EAAE;IACrB;;OAEG;IACa,CAAC,EAAE,EAAE;IAGvB;;;;OAIG;IACH,MAAM,CAAC,MAAM;IAKb;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAK/C;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM;IAIjC;;;OAGG;IACH,QAAQ;IAIR;;;OAGG;IACH,SAAS;;;;IAOT;;;;OAIG;IACH,QAAQ;IAIR;;;;;;OAMG;IACH,QAAQ;IAIR;;;;;;;OAOG;IACH,aAAa;IAKb;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,KAAK;CAGlB;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,KAAK,CAIjD"}