@aztec/foundation 0.0.0-test.0

package/dest/serialize/buffer_reader.js

@@ -0,0 +1,290 @@
+/**
+ * The BufferReader class provides a utility for reading various data types from a buffer.
+ * It supports reading numbers, booleans, byte arrays, Fr and Fq field elements,
+ * vectors, arrays, objects, strings, and maps. It maintains an internal index to
+ * keep track of the current reading position in the buffer.
+ *
+ * Usage:
+ * Create a new instance of BufferReader with a buffer and an optional offset.
+ * Use the provided methods to read desired data types from the buffer.
+ * The reading methods automatically advance the internal index.
+ *
+ * @example
+ * const reader = new BufferReader(someBuffer);
+ * const num = reader.readNumber();
+ * const bool = reader.readBoolean();
+ * const byteArray = reader.readBytes(4);
+ */ export class BufferReader {
+    buffer;
+    index;
+    constructor(buffer, offset = 0){
+        this.buffer = buffer;
+        this.index = offset;
+    }
+    /**
+   * Creates a BufferReader instance from either a Buffer or an existing BufferReader.
+   * If the input is a Buffer, it creates a new BufferReader with the given buffer.
+   * If the input is already a BufferReader, it returns the input unchanged.
+   *
+   * @param bufferOrReader - A Buffer or BufferReader to initialize the BufferReader.
+   * @returns An instance of BufferReader.
+   */ static asReader(bufferOrReader) {
+        if (bufferOrReader instanceof BufferReader) {
+            return bufferOrReader;
+        }
+        const buf = Buffer.isBuffer(bufferOrReader) ? bufferOrReader : Buffer.from(bufferOrReader.buffer, bufferOrReader.byteOffset, bufferOrReader.byteLength);
+        return new BufferReader(buf);
+    }
+    /** Returns true if the underlying buffer has been consumed completely. */ isEmpty() {
+        return this.index === this.buffer.length;
+    }
+    /**
+   * Reads a 32-bit unsigned integer from the buffer at the current index position.
+   * Updates the index position by 4 bytes after reading the number.
+   *
+   * @returns The read 32-bit unsigned integer value.
+   */ readNumber() {
+        this.#rangeCheck(4);
+        this.index += 4;
+        return this.buffer.readUint32BE(this.index - 4);
+    }
+    /**
+   * Reads `count` 32-bit unsigned integers from the buffer at the current index position.
+   * @param count - The number of 32-bit unsigned integers to read.
+   * @returns An array of 32-bit unsigned integers.
+   */ readNumbers(count) {
+        const result = Array.from({
+            length: count
+        }, ()=>this.readNumber());
+        return result;
+    }
+    /**
+   * Reads a 256-bit unsigned integer from the buffer at the current index position.
+   * Updates the index position by 32 bytes after reading the number.
+   *
+   * Assumes the number is stored in big-endian format.
+   *
+   * @returns The read 256 bit value as a bigint.
+   */ readUInt256() {
+        this.#rangeCheck(32);
+        let result = BigInt(0);
+        for(let i = 0; i < 32; i++){
+            result = result << BigInt(8) | BigInt(this.buffer[this.index + i]);
+        }
+        this.index += 32;
+        return result;
+    }
+    /**
+   * Reads a 16-bit unsigned integer from the buffer at the current index position.
+   * Updates the index position by 2 bytes after reading the number.
+   *
+   * @returns The read 16 bit value.
+   */ readUInt16() {
+        this.#rangeCheck(2);
+        this.index += 2;
+        return this.buffer.readUInt16BE(this.index - 2);
+    }
+    /**
+   * Reads a 8-bit unsigned integer from the buffer at the current index position.
+   * Updates the index position by 1 byte after reading the number.
+   *
+   * @returns The read 8 bit value.
+   */ readUInt8() {
+        this.#rangeCheck(1);
+        this.index += 1;
+        return this.buffer.readUInt8(this.index - 1);
+    }
+    /**
+   * Reads and returns the next boolean value from the buffer.
+   * Advances the internal index by 1, treating the byte at the current index as a boolean value.
+   * Returns true if the byte is non-zero, false otherwise.
+   *
+   * @returns A boolean value representing the byte at the current index.
+   */ readBoolean() {
+        this.#rangeCheck(1);
+        this.index += 1;
+        return Boolean(this.buffer.at(this.index - 1));
+    }
+    /**
+   * Reads a specified number of bytes from the buffer and returns a new Buffer containing those bytes.
+   * Advances the reader's index by the number of bytes read. Throws an error if there are not enough
+   * bytes left in the buffer to satisfy the requested number of bytes.
+   *
+   * @param n - The number of bytes to read from the buffer.
+   * @returns A new Buffer containing the read bytes.
+   */ readBytes(n) {
+        this.#rangeCheck(n);
+        this.index += n;
+        return Buffer.from(this.buffer.subarray(this.index - n, this.index));
+    }
+    /** Reads until the end of the buffer. */ readToEnd() {
+        const result = this.buffer.subarray(this.index);
+        this.index = this.buffer.length;
+        return result;
+    }
+    /**
+   * 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.
+   *
+   * @returns An array of numbers representing the vector read from the buffer.
+   */ readNumberVector() {
+        return this.readVector({
+            fromBuffer: (reader)=>reader.readNumber()
+        });
+    }
+    /**
+   * Reads a vector of fixed size from the buffer and deserializes its elements using the provided itemDeserializer object.
+   * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance and returns the deserialized element.
+   * The method first reads the size of the vector (a number) from the buffer, then iterates through its elements,
+   * deserializing each one using the 'fromBuffer' method of 'itemDeserializer'.
+   *
+   * @param itemDeserializer - Object with 'fromBuffer' method to deserialize vector elements.
+   * @returns An array of deserialized elements of type T.
+   */ readVector(itemDeserializer) {
+        const size = this.readNumber();
+        const result = new Array(size);
+        for(let i = 0; i < size; i++){
+            result[i] = itemDeserializer.fromBuffer(this);
+        }
+        return result;
+    }
+    /**
+   * Reads a vector of fixed size from the buffer and deserializes its elements using the provided itemDeserializer object.
+   * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance and returns the deserialized element.
+   * The method first reads the size of the vector (a number) from the buffer, then iterates through its elements,
+   * deserializing each one using the 'fromBuffer' method of 'itemDeserializer'.
+   *
+   * @param itemDeserializer - Object with 'fromBuffer' method to deserialize vector elements.
+   * @returns An array of deserialized elements of type T.
+   */ readVectorUint8Prefix(itemDeserializer) {
+        const size = this.readUInt8();
+        const result = new Array(size);
+        for(let i = 0; i < size; i++){
+            result[i] = itemDeserializer.fromBuffer(this);
+        }
+        return result;
+    }
+    /**
+   * Read an array of a fixed size with elements of type T from the buffer.
+   * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance as input,
+   * and returns an instance of the desired deserialized data type T.
+   * This method will call the 'fromBuffer' method for each element in the array and return the resulting array.
+   *
+   * @param size - The fixed number of elements in the array.
+   * @param itemDeserializer - An object with a 'fromBuffer' method to deserialize individual elements of type T.
+   * @returns An array of instances of type T.
+   */ readArray(size, itemDeserializer) {
+        const result = Array.from({
+            length: size
+        }, ()=>itemDeserializer.fromBuffer(this));
+        return result;
+    }
+    /**
+   * Read a variable sized Buffer array where elements are represented by length + data.
+   * The method consecutively looks for a number which is the size of the proceeding buffer,
+   * then reads the bytes until it reaches the end of the reader's internal buffer.
+   * NOTE: if `size` is not provided, this will run to the end of the reader's buffer.
+   * @param size - Size of the buffer array in bytes (full remaining buffer length if left empty).
+   * @returns An array of variable sized buffers.
+   */ readBufferArray(size = -1) {
+        const result = [];
+        const end = size >= 0 ? this.index + size : this.buffer.length;
+        this.#rangeCheck(end - this.index);
+        while(this.index < end){
+            const item = this.readBuffer();
+            result.push(item);
+        }
+        // Ensure that all bytes have been read.
+        if (this.index !== end) {
+            throw new Error(`Reader buffer was not fully consumed. Consumed up to ${this.index} bytes. End of data: ${end} bytes.`);
+        }
+        return result;
+    }
+    /**
+   * Reads a serialized object from a buffer and returns the deserialized object using the given deserializer.
+   *
+   * @typeparam T - The type of the deserialized object.
+   * @param deserializer - An object with a 'fromBuffer' method that takes a BufferReader instance and returns an instance of the deserialized object.
+   * @returns The deserialized object of type T.
+   */ readObject(deserializer) {
+        return deserializer.fromBuffer(this);
+    }
+    /**
+   * Returns a Buffer containing the next n bytes from the current buffer without modifying the reader's index position.
+   * If n is not provided or exceeds the remaining length of the buffer, it returns all bytes from the current position till the end of the buffer.
+   *
+   * @param n - The number of bytes to peek from the current buffer. (Optional).
+   * @returns A Buffer with the next n bytes or the remaining bytes if n is not provided or exceeds the buffer length.
+   */ peekBytes(n) {
+        this.#rangeCheck(n || 0);
+        return this.buffer.subarray(this.index, n ? this.index + n : undefined);
+    }
+    /**
+   * Reads a string from the buffer and returns it.
+   * The method first reads the size of the string, then reads the corresponding
+   * number of bytes from the buffer and converts them to a string.
+   *
+   * @returns The read string from the buffer.
+   */ readString() {
+        return this.readBuffer().toString();
+    }
+    /**
+   * Reads a buffer from the current position of the reader and advances the index.
+   * The method first reads the size (number) of bytes to be read, and then returns
+   * a Buffer with that size containing the bytes. Useful for reading variable-length
+   * binary data encoded as (size, data) format.
+   *
+   * @returns A Buffer containing the read bytes.
+   */ readBuffer() {
+        const size = this.readNumber();
+        this.#rangeCheck(size);
+        return this.readBytes(size);
+    }
+    /**
+   * Reads a buffer from the current position of the reader and advances the index.
+   * The method first reads the size (number) of bytes to be read, and then returns
+   * a Buffer with that size containing the bytes. Useful for reading variable-length
+   * binary data encoded as (size, data) format.
+   *
+   * @returns A Buffer containing the read bytes.
+   */ readUint8Array() {
+        const size = this.readNumber();
+        this.#rangeCheck(size);
+        return this.readBytes(size);
+    }
+    /**
+   * Reads and constructs a map object from the current buffer using the provided deserializer.
+   * The method reads the number of entries in the map, followed by iterating through each key-value pair.
+   * The key is read as a string, while the value is obtained using the passed deserializer's `fromBuffer` method.
+   * The resulting map object is returned, containing all the key-value pairs read from the buffer.
+   *
+   * @param deserializer - An object with a `fromBuffer` method to deserialize the values in the map.
+   * @returns A map object with string keys and deserialized values based on the provided deserializer.
+   */ readMap(deserializer) {
+        const numEntries = this.readNumber();
+        const map = {};
+        for(let i = 0; i < numEntries; i++){
+            const key = this.readString();
+            const value = this.readObject(deserializer);
+            map[key] = value;
+        }
+        return map;
+    }
+    /**
+   * Get the length of the reader's buffer.
+   * @returns The length of the underlying reader's buffer.
+   */ getLength() {
+        return this.buffer.length;
+    }
+    /**
+   * Gets bytes remaining to be read from the buffer.
+   * @returns Bytes remaining to be read from the buffer.
+   */ remainingBytes() {
+        return this.buffer.length - this.index;
+    }
+    #rangeCheck(numBytes) {
+        if (this.index + numBytes > this.buffer.length) {
+            throw new Error(`Attempted to read beyond buffer length. Start index: ${this.index}, Num bytes to read: ${numBytes}, Buffer length: ${this.buffer.length}`);
+        }
+    }
+}

package/dest/serialize/field_reader.d.ts

@@ -0,0 +1,112 @@
+import { Fq, type Fr } from '../fields/fields.js';
+import type { Tuple } from './types.js';
+/**
+ * The FieldReader class provides a utility for reading various data types from a field array.
+ *
+ * Usage:
+ * Create a new instance of FieldReader with an array of fields and an optional offset.
+ * Use the provided methods to read desired data types from the field array.
+ * The reading methods automatically advance the internal index.
+ */
+export declare class FieldReader {
+    private fields;
+    private index;
+    private length;
+    constructor(fields: Fr[], offset?: number);
+    /**
+     * Creates a FieldReader instance from either a field array or an existing FieldReader.
+     *
+     * @param fields - A field array or FieldReader to initialize the FieldReader.
+     * @returns An instance of FieldReader.
+     */
+    static asReader(fields: Fr[] | FieldReader): FieldReader;
+    /**
+     * Returns the current cursor position.
+     *
+     * @returns The current cursor position.
+     */
+    get cursor(): number;
+    /**
+     * Skips the next n fields.
+     *
+     * @param n - The number of fields to skip.
+     */
+    skip(n: number): void;
+    /**
+     * Reads a single field from the array.
+     *
+     * @returns A field.
+     */
+    readField(): Fr;
+    /**
+     * Peeks at the next field without advancing the cursor.
+     *
+     * @returns A field.
+     */
+    peekField(): Fr;
+    /**
+     * Reads a Fq from the array.
+     *
+     * @returns An Fq.
+     */
+    readFq(): Fq;
+    /**
+     * Reads and returns the next boolean value from the field array.
+     * Advances the internal index by 1, treating the field at the current index as a boolean value.
+     * Returns true if the field is non-zero, false otherwise.
+     * Throw if the value is not 0 or 1.
+     *
+     * @returns A boolean value representing the field at the current index.
+     */
+    readBoolean(): boolean;
+    /**
+     * Reads a 32-bit unsigned integer from the field array at the current index position.
+     * Updates the index position by 1 after reading the number.
+     * Throw if the value is greater than 2 ** 32.
+     *
+     * @returns The read 32-bit unsigned integer value.
+     */
+    readU32(): number;
+    /**
+     * Read an array of a fixed size field array.
+     *
+     * @param size - The fixed number of fields in the array.
+     * @returns An array of fields.
+     */
+    readFieldArray<N extends number>(size: N): Tuple<Fr, N>;
+    /**
+     * Read an array of a fixed size with elements of type T from the field array.
+     * The 'itemDeserializer' object should have a 'fromFields' method that takes a FieldReader instance as input,
+     * and returns an instance of the desired deserialized data type T.
+     * This method will call the 'fromFields' method for each element in the array and return the resulting array.
+     *
+     * @param size - The fixed number of elements in the array.
+     * @param itemDeserializer - An object with a 'fromFields' method to deserialize individual elements of type T.
+     * @returns An array of instances of type T.
+     */
+    readArray<T, N extends number>(size: N, itemDeserializer: {
+        /**
+         * A function for deserializing data from a FieldReader instance.
+         */
+        fromFields: (reader: FieldReader) => T;
+    }): Tuple<T, N>;
+    /**
+     * Reads a serialized object from a field array and returns the deserialized object using the given deserializer.
+     *
+     * @typeparam T - The type of the deserialized object.
+     * @param deserializer - An object with a 'fromFields' method that takes a FieldReader instance and returns an instance of the deserialized object.
+     * @returns The deserialized object of type T.
+     */
+    readObject<T>(deserializer: {
+        /**
+         * A method that takes a FieldReader instance and returns an instance of the deserialized data type.
+         */
+        fromFields: (reader: FieldReader) => T;
+    }): T;
+    /**
+     * Returns whether the reader has finished reading all fields.
+     * @returns A bool.
+     */
+    isFinished(): boolean;
+}
+//# sourceMappingURL=field_reader.d.ts.map

package/dest/serialize/field_reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field_reader.d.ts","sourceRoot":"","sources":["../../src/serialize/field_reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,WAAW;IAGV,OAAO,CAAC,MAAM;IAF1B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,MAAM,CAAS;gBACH,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,SAAI;IAQ5C;;;;;OAKG;WACW,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,GAAG,WAAW;IAQ/D;;;;OAIG;IACH,IAAW,MAAM,WAEhB;IAED;;;;OAIG;IACI,IAAI,CAAC,CAAC,EAAE,MAAM;IAOrB;;;;OAIG;IACI,SAAS,IAAI,EAAE;IAOtB;;;;OAIG;IACI,SAAS,IAAI,EAAE;IAOtB;;;;OAIG;IACI,MAAM,IAAI,EAAE;IAInB;;;;;;;OAOG;IACI,WAAW,IAAI,OAAO;IAS7B;;;;;;OAMG;IACI,OAAO,IAAI,MAAM;IASxB;;;;;OAKG;IACI,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IAQ9D;;;;;;;;;OASG;IACI,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAClC,IAAI,EAAE,CAAC,EACP,gBAAgB,EAAE;QAChB;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GACA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAKd;;;;;;OAMG;IACI,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE;QACjC;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GAAG,CAAC;IAIL;;;OAGG;IACI,UAAU,IAAI,OAAO;CAG7B"}

package/dest/serialize/field_reader.js

@@ -0,0 +1,147 @@
+import { Fq } from '../fields/fields.js';
+/**
+ * The FieldReader class provides a utility for reading various data types from a field array.
+ *
+ * Usage:
+ * Create a new instance of FieldReader with an array of fields and an optional offset.
+ * Use the provided methods to read desired data types from the field array.
+ * The reading methods automatically advance the internal index.
+ */ export class FieldReader {
+    fields;
+    index;
+    length;
+    constructor(fields, offset = 0){
+        this.fields = fields;
+        this.index = offset;
+        this.length = fields.length;
+        if (offset >= this.length) {
+            throw new Error('Offset out of bounds.');
+        }
+    }
+    /**
+   * Creates a FieldReader instance from either a field array or an existing FieldReader.
+   *
+   * @param fields - A field array or FieldReader to initialize the FieldReader.
+   * @returns An instance of FieldReader.
+   */ static asReader(fields) {
+        if (fields instanceof FieldReader) {
+            return fields;
+        }
+        return new FieldReader(fields);
+    }
+    /**
+   * Returns the current cursor position.
+   *
+   * @returns The current cursor position.
+   */ get cursor() {
+        return this.index;
+    }
+    /**
+   * Skips the next n fields.
+   *
+   * @param n - The number of fields to skip.
+   */ skip(n) {
+        if (this.index + n > this.length) {
+            throw new Error('Not enough fields to be consumed.');
+        }
+        this.index += n;
+    }
+    /**
+   * Reads a single field from the array.
+   *
+   * @returns A field.
+   */ readField() {
+        if (this.index === this.length) {
+            throw new Error('Not enough fields to be consumed.');
+        }
+        return this.fields[this.index++];
+    }
+    /**
+   * Peeks at the next field without advancing the cursor.
+   *
+   * @returns A field.
+   */ peekField() {
+        if (this.index === this.length) {
+            throw new Error('Not enough fields to be consumed.');
+        }
+        return this.fields[this.index];
+    }
+    /**
+   * Reads a Fq from the array.
+   *
+   * @returns An Fq.
+   */ readFq() {
+        return Fq.fromHighLow(this.readField(), this.readField());
+    }
+    /**
+   * Reads and returns the next boolean value from the field array.
+   * Advances the internal index by 1, treating the field at the current index as a boolean value.
+   * Returns true if the field is non-zero, false otherwise.
+   * Throw if the value is not 0 or 1.
+   *
+   * @returns A boolean value representing the field at the current index.
+   */ readBoolean() {
+        const field = this.readField();
+        const value = field.toBigInt();
+        if (value > 1n) {
+            throw new Error('Field is not a boolean.');
+        }
+        return value == 1n;
+    }
+    /**
+   * Reads a 32-bit unsigned integer from the field array at the current index position.
+   * Updates the index position by 1 after reading the number.
+   * Throw if the value is greater than 2 ** 32.
+   *
+   * @returns The read 32-bit unsigned integer value.
+   */ readU32() {
+        const field = this.readField();
+        const value = field.toBigInt();
+        if (value >= 1n << 32n) {
+            throw new Error('Field is not a u32.');
+        }
+        return Number(value);
+    }
+    /**
+   * Read an array of a fixed size field array.
+   *
+   * @param size - The fixed number of fields in the array.
+   * @returns An array of fields.
+   */ readFieldArray(size) {
+        const result = [];
+        for(let i = 0; i < size; ++i){
+            result.push(this.readField());
+        }
+        return result;
+    }
+    /**
+   * Read an array of a fixed size with elements of type T from the field array.
+   * The 'itemDeserializer' object should have a 'fromFields' method that takes a FieldReader instance as input,
+   * and returns an instance of the desired deserialized data type T.
+   * This method will call the 'fromFields' method for each element in the array and return the resulting array.
+   *
+   * @param size - The fixed number of elements in the array.
+   * @param itemDeserializer - An object with a 'fromFields' method to deserialize individual elements of type T.
+   * @returns An array of instances of type T.
+   */ readArray(size, itemDeserializer) {
+        const result = Array.from({
+            length: size
+        }, ()=>itemDeserializer.fromFields(this));
+        return result;
+    }
+    /**
+   * Reads a serialized object from a field array and returns the deserialized object using the given deserializer.
+   *
+   * @typeparam T - The type of the deserialized object.
+   * @param deserializer - An object with a 'fromFields' method that takes a FieldReader instance and returns an instance of the deserialized object.
+   * @returns The deserialized object of type T.
+   */ readObject(deserializer) {
+        return deserializer.fromFields(this);
+    }
+    /**
+   * Returns whether the reader has finished reading all fields.
+   * @returns A bool.
+   */ isFinished() {
+        return this.index >= this.length;
+    }
+}

package/dest/serialize/free_funcs.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '../fields/fields.js';
+import type { Tuple } from './types.js';
+/**
+ * Convert a boolean value to its corresponding byte representation in a Buffer of size 1.
+ * The function takes a boolean value and writes it into a new buffer as either 1 (true) or 0 (false).
+ * This method is useful for converting a boolean value into a binary format that can be stored or transmitted easily.
+ *
+ * @param b - The boolean value to be converted.
+ * @returns A Buffer containing the byte representation of the input boolean value.
+ */
+export declare function boolToByte(b: boolean): Buffer;
+/**
+ * @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 declare function numToUInt16BE(n: number, bufferSize?: number): Buffer;
+/**
+ * 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,
+ * and returned as a Buffer of specified size (defaults to 4).
+ * If the provided bufferSize is greater than 4, the additional bytes will be padded with zeros.
+ *
+ * @param n - The number to be converted into a little-endian unsigned integer buffer.
+ * @param bufferSize - Optional, the size of the output buffer (default value is 4).
+ * @returns A Buffer containing the serialized little-endian unsigned integer representation of the input number.
+ */
+export declare function numToUInt32LE(n: number, bufferSize?: number): Buffer;
+/**
+ * Convert a number to a big-endian unsigned 32-bit integer Buffer.
+ * This function takes a number and an optional buffer size as input and creates a Buffer with the specified size (defaults to 4) containing the big-endian representation of the input number as an unsigned 32-bit integer. Note that the bufferSize should be greater than or equal to 4, otherwise the output Buffer might truncate the serialized value.
+ *
+ * @param n - The input number to be converted to a big-endian unsigned 32-bit integer Buffer.
+ * @param bufferSize - Optional, the size of the output Buffer (default is 4).
+ * @returns A Buffer containing the big-endian unsigned 32-bit integer representation of the input number.
+ */
+export declare function numToUInt32BE(n: number, bufferSize?: number): Buffer;
+/**
+ * Serialize a number into a big-endian signed 32-bit integer Buffer with the specified buffer size.
+ * This function converts the input number into its binary representation and stores it in a Buffer
+ * with the provided buffer size. By default, the buffer size is set to 4 bytes which represents a 32-bit integer.
+ * The function will use the last 4 bytes of the buffer to store the serialized number. If the input number
+ * is outside the range of a 32-bit signed integer, the resulting serialization may be incorrect due to truncation.
+ *
+ * @param n - The number to be serialized as a signed 32-bit integer.
+ * @param bufferSize - Optional, the size of the output Buffer (default is 4 bytes).
+ * @returns A Buffer containing the serialized big-endian signed 32-bit integer.
+ */
+export declare function numToInt32BE(n: number, bufferSize?: number): Buffer;
+/**
+ * Convert a number to an 8-bit unsigned integer and return it as a Buffer of length 1.
+ * The input number is written as an 8-bit unsigned integer into the buffer. This function
+ * is useful for converting small numeric values to a standardized binary format that can be
+ * easily stored or transmitted.
+ *
+ * @param n - The number to be converted to an 8-bit unsigned integer.
+ * @returns A Buffer containing the 8-bit unsigned integer representation of the input number.
+ */
+export declare function numToUInt8(n: number): Buffer;
+/**
+ * Adds a 4-byte byte-length prefix to a buffer.
+ * @param buf - The input Buffer to be prefixed
+ * @returns A Buffer with 4-byte byte-length prefix.
+ */
+export declare function prefixBufferWithLength(buf: Buffer): Buffer;
+/**
+ * Parse a buffer as a big integer.
+ */
+export declare function toBigInt(buf: Buffer): bigint;
+/**
+ * Stores full 256 bits of information in 2 fields.
+ * @param buf - 32 bytes of data
+ * @returns 2 field elements
+ */
+export declare function to2Fields(buf: Buffer): [Fr, Fr];
+/**
+ * Reconstructs the original 32 bytes of data from 2 field elements.
+ * @param field1 - First field element
+ * @param field2 - Second field element
+ * @returns 32 bytes of data as a Buffer
+ */
+export declare function from2Fields(field1: Fr, field2: Fr): Buffer;
+/**
+ * Truncates SHA hashes to match Noir's truncated version
+ * @param buf - 32 bytes of data
+ * @returns 31 bytes of data padded to 32
+ */
+export declare function truncateAndPad(buf: Buffer): Buffer;
+/**
+ * Stores 248 bits of information in 1 field.
+ * @param buf - 32 or 31 bytes of data
+ * @returns 1 field element
+ */
+export declare function toTruncField(buf: Buffer): Fr;
+/**
+ * Reconstructs the original 31 bytes of data from 1 truncated field element.
+ * @param field - field element
+ * @returns 31 bytes of data as a Buffer
+ */
+export declare function fromTruncField(field: Fr): Buffer;
+export declare function fromFieldsTuple(fields: Tuple<Fr, 2>): Buffer;
+export declare function toHumanReadable(buf: Buffer, maxLen?: number): string;
+//# sourceMappingURL=free_funcs.d.ts.map

package/dest/serialize/free_funcs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"free_funcs.d.ts","sourceRoot":"","sources":["../../src/serialize/free_funcs.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,qBAAqB,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,UAIpC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,UAItD;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,UAItD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,UAItD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,UAIrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,UAKnC;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,UAIjD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM5C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAU/C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,CAW1D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAW5C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,EAAE,GAAG,MAAM,CAMhD;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAE5D;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAMpE"}