@aztec/foundation 0.7.2 → 0.7.4

package/dest/serialize/deserializer.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * DeserializeFn is a type representing a deserialization function for a specific data type. The function takes
+ * a buffer and an offset as input, and returns an object containing the deserialized element of the data type and
+ * the number of bytes advanced in the buffer. This type is used to provide custom deserialization logic for arrays,
+ * objects or custom data types while working with the Deserializer class.
+ */
+export type DeserializeFn<T> = (buf: Buffer, offset: number) => {
+    /**
+     * The deserialized element of the specified data type.
+     */
+    elem: T;
+    /**
+     * The number of bytes advanced in the buffer during deserialization.
+     */
+    adv: number;
+};
+/**
+ * Deserializer class provides a set of methods to deserialize different data types from a buffer.
+ * It maintains an internal buffer and offset, updating the offset as it deserializes each data type.
+ * The class supports deserialization of various data types including boolean, integers, big integers,
+ * buffers, strings, dates, and arrays with custom deserialization functions.
+ *
+ * @example
+ * const deserializer = new Deserializer(buffer);
+ * const boolValue = deserializer.bool();
+ * const intValue = deserializer.int32();
+ * const bigIntValue = deserializer.bigInt();
+ * const stringValue = deserializer.string();
+ * const dateValue = deserializer.date();
+ * const arrayValue = deserializer.deserializeArray(customDeserializeFn);
+ */
+export declare class Deserializer {
+    private buf;
+    private offset;
+    constructor(buf: Buffer, offset?: number);
+    /**
+     * Deserialize a boolean value from the buffer at the current offset.
+     * Advances the internal offset by one byte after deserialization.
+     * Returns 'true' if the deserialized value is non-zero, otherwise returns 'false'.
+     *
+     * @returns The deserialized boolean value.
+     */
+    bool(): boolean;
+    /**
+     * Deserialize a 32-bit unsigned integer from the buffer at the current offset.
+     * Advances the internal buffer offset by 4 after successful deserialization.
+     * The result is returned as a JavaScript number.
+     *
+     * @returns A 32-bit unsigned integer value.
+     */
+    uInt32(): number;
+    /**
+     * Deserialize a 32-bit signed integer from the internal buffer.
+     * Reads 4 bytes from the current offset in the buffer and interprets them as a little-endian int32 value.
+     * Advances the internal offset by 4 bytes after successful deserialization.
+     *
+     * @returns The deserialized 32-bit signed integer value.
+     */
+    int32(): number;
+    /**
+     * Deserialize a BigInt from the buffer, taking into account the specified width.
+     * The method reads 'width' bytes from the buffer starting at the current offset and converts it to a BigInt.
+     * The offset is advanced by 'width' bytes after successful deserialization.
+     *
+     * @param width - The number of bytes to read from the buffer to construct the BigInt (default is 32).
+     * @returns The deserialized BigInt value.
+     */
+    bigInt(width?: number): bigint;
+    /**
+     * Deserialize a variable-length byte array from the internal buffer.
+     * This method reads the length of the array and then extracts the corresponding bytes.
+     * It advances the internal offset by the number of bytes read, including the length prefix.
+     *
+     * @returns A Buffer instance containing the deserialized byte array.
+     */
+    vector(): Buffer;
+    /**
+     * Extract a sub-buffer with the specified width, advancing the internal offset.
+     * The function slices the buffer from the current offset to the offset plus the provided width,
+     * and advances the internal offset by the width. This can be useful for working with fixed-width
+     * structures within the original buffer.
+     *
+     * @param width - The number of bytes to include in the extracted sub-buffer.
+     * @returns A sub-buffer containing the specified number of bytes from the original buffer.
+     */
+    buffer(width: number): Buffer;
+    /**
+     * Deserialize a string from the internal buffer.
+     * It first deserializes a vector representing the UTF-8 encoded string from the buffer,
+     * and then converts it to a string.
+     *
+     * @returns The deserialized string.
+     */
+    string(): string;
+    /**
+     * Deserialize a Date object from the internal buffer.
+     * The date value is expected to be stored as a 64-bit BigInt representing the number of milliseconds since the Unix epoch.
+     * Advances the internal offset by 8 bytes after deserialization.
+     *
+     * @returns A Date instance representing the deserialized date value.
+     */
+    date(): Date;
+    /**
+     * Deserialize an array of elements using the provided deserialization function.
+     * This method reads the serialized data from the buffer and deserializes each element in the array
+     * using the given 'fn' deserialization function. The returned array contains the deserialized elements
+     * in their original order.
+     *
+     * @param fn - The deserialization function to be applied on each element in the array.
+     * @returns An array containing the deserialized elements.
+     */
+    deserializeArray<T>(fn: DeserializeFn<T>): T[];
+    /**
+     * Executes the given deserialization function on this Deserializer's buffer and updates the internal offset.
+     * The DeserializeFn<T> should take a Buffer and an offset as input, and return an object containing the deserialized
+     * element and the number of bytes advanced in the buffer. This method is useful for custom deserialization logic
+     * or implementing new deserialization functions.
+     *
+     * @typeparam T - The type of the deserialized element.
+     * @param fn - The deserialization function to execute.
+     * @returns The deserialized element of type T.
+     */
+    exec<T>(fn: DeserializeFn<T>): T;
+    /**
+     * Returns the current offset value in the Deserializer instance.
+     * The offset is updated as elements are deserialized from the buffer.
+     * It can be useful for tracking the position in the buffer during complex deserialization processes.
+     *
+     * @returns The current offset value as a number.
+     */
+    getOffset(): number;
+}
+//# sourceMappingURL=deserializer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deserializer.d.ts","sourceRoot":"","sources":["../../src/serialize/deserializer.ts"],"names":[],"mappings":";AASA;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAC7B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,KACX;IACH;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,GAAG;IAAU,OAAO,CAAC,MAAM;gBAA3B,GAAG,EAAE,MAAM,EAAU,MAAM,SAAI;IAEnD;;;;;;OAMG;IACI,IAAI;IAIX;;;;;;OAMG;IACI,MAAM;IAIb;;;;;;OAMG;IACI,KAAK;IAIZ;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,SAAK;IAIxB;;;;;;OAMG;IACI,MAAM;IAIb;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM;IAM3B;;;;;;OAMG;IACI,MAAM;IAIb;;;;;;OAMG;IACI,IAAI;IAIX;;;;;;;;OAQG;IACI,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC;IAI/C;;;;;;;;;OASG;IACI,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC;IAMvC;;;;;;OAMG;IACI,SAAS;CAGjB"}

package/dest/serialize/deserializer.js

@@ -0,0 +1,145 @@
+import { deserializeArrayFromVector, deserializeBigInt, deserializeBool, deserializeBufferFromVector, deserializeInt32, deserializeUInt32, } from './free_funcs.js';
+/**
+ * Deserializer class provides a set of methods to deserialize different data types from a buffer.
+ * It maintains an internal buffer and offset, updating the offset as it deserializes each data type.
+ * The class supports deserialization of various data types including boolean, integers, big integers,
+ * buffers, strings, dates, and arrays with custom deserialization functions.
+ *
+ * @example
+ * const deserializer = new Deserializer(buffer);
+ * const boolValue = deserializer.bool();
+ * const intValue = deserializer.int32();
+ * const bigIntValue = deserializer.bigInt();
+ * const stringValue = deserializer.string();
+ * const dateValue = deserializer.date();
+ * const arrayValue = deserializer.deserializeArray(customDeserializeFn);
+ */
+export class Deserializer {
+    constructor(buf, offset = 0) {
+        this.buf = buf;
+        this.offset = offset;
+    }
+    /**
+     * Deserialize a boolean value from the buffer at the current offset.
+     * Advances the internal offset by one byte after deserialization.
+     * Returns 'true' if the deserialized value is non-zero, otherwise returns 'false'.
+     *
+     * @returns The deserialized boolean value.
+     */
+    bool() {
+        return this.exec(deserializeBool) ? true : false;
+    }
+    /**
+     * Deserialize a 32-bit unsigned integer from the buffer at the current offset.
+     * Advances the internal buffer offset by 4 after successful deserialization.
+     * The result is returned as a JavaScript number.
+     *
+     * @returns A 32-bit unsigned integer value.
+     */
+    uInt32() {
+        return this.exec(deserializeUInt32);
+    }
+    /**
+     * Deserialize a 32-bit signed integer from the internal buffer.
+     * Reads 4 bytes from the current offset in the buffer and interprets them as a little-endian int32 value.
+     * Advances the internal offset by 4 bytes after successful deserialization.
+     *
+     * @returns The deserialized 32-bit signed integer value.
+     */
+    int32() {
+        return this.exec(deserializeInt32);
+    }
+    /**
+     * Deserialize a BigInt from the buffer, taking into account the specified width.
+     * The method reads 'width' bytes from the buffer starting at the current offset and converts it to a BigInt.
+     * The offset is advanced by 'width' bytes after successful deserialization.
+     *
+     * @param width - The number of bytes to read from the buffer to construct the BigInt (default is 32).
+     * @returns The deserialized BigInt value.
+     */
+    bigInt(width = 32) {
+        return this.exec((buf, offset) => deserializeBigInt(buf, offset, width));
+    }
+    /**
+     * Deserialize a variable-length byte array from the internal buffer.
+     * This method reads the length of the array and then extracts the corresponding bytes.
+     * It advances the internal offset by the number of bytes read, including the length prefix.
+     *
+     * @returns A Buffer instance containing the deserialized byte array.
+     */
+    vector() {
+        return this.exec(deserializeBufferFromVector);
+    }
+    /**
+     * Extract a sub-buffer with the specified width, advancing the internal offset.
+     * The function slices the buffer from the current offset to the offset plus the provided width,
+     * and advances the internal offset by the width. This can be useful for working with fixed-width
+     * structures within the original buffer.
+     *
+     * @param width - The number of bytes to include in the extracted sub-buffer.
+     * @returns A sub-buffer containing the specified number of bytes from the original buffer.
+     */
+    buffer(width) {
+        const buf = this.buf.slice(this.offset, this.offset + width);
+        this.offset += width;
+        return buf;
+    }
+    /**
+     * Deserialize a string from the internal buffer.
+     * It first deserializes a vector representing the UTF-8 encoded string from the buffer,
+     * and then converts it to a string.
+     *
+     * @returns The deserialized string.
+     */
+    string() {
+        return this.vector().toString();
+    }
+    /**
+     * Deserialize a Date object from the internal buffer.
+     * The date value is expected to be stored as a 64-bit BigInt representing the number of milliseconds since the Unix epoch.
+     * Advances the internal offset by 8 bytes after deserialization.
+     *
+     * @returns A Date instance representing the deserialized date value.
+     */
+    date() {
+        return new Date(Number(this.bigInt(8)));
+    }
+    /**
+     * Deserialize an array of elements using the provided deserialization function.
+     * This method reads the serialized data from the buffer and deserializes each element in the array
+     * using the given 'fn' deserialization function. The returned array contains the deserialized elements
+     * in their original order.
+     *
+     * @param fn - The deserialization function to be applied on each element in the array.
+     * @returns An array containing the deserialized elements.
+     */
+    deserializeArray(fn) {
+        return this.exec((buf, offset) => deserializeArrayFromVector(fn, buf, offset));
+    }
+    /**
+     * Executes the given deserialization function on this Deserializer's buffer and updates the internal offset.
+     * The DeserializeFn<T> should take a Buffer and an offset as input, and return an object containing the deserialized
+     * element and the number of bytes advanced in the buffer. This method is useful for custom deserialization logic
+     * or implementing new deserialization functions.
+     *
+     * @typeparam T - The type of the deserialized element.
+     * @param fn - The deserialization function to execute.
+     * @returns The deserialized element of type T.
+     */
+    exec(fn) {
+        const { elem, adv } = fn(this.buf, this.offset);
+        this.offset += adv;
+        return elem;
+    }
+    /**
+     * Returns the current offset value in the Deserializer instance.
+     * The offset is updated as elements are deserialized from the buffer.
+     * It can be useful for tracking the position in the buffer during complex deserialization processes.
+     *
+     * @returns The current offset value as a number.
+     */
+    getOffset() {
+        return this.offset;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVzZXJpYWxpemVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcmlhbGl6ZS9kZXNlcmlhbGl6ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLDBCQUEwQixFQUMxQixpQkFBaUIsRUFDakIsZUFBZSxFQUNmLDJCQUEyQixFQUMzQixnQkFBZ0IsRUFDaEIsaUJBQWlCLEdBQ2xCLE1BQU0saUJBQWlCLENBQUM7QUFzQnpCOzs7Ozs7Ozs7Ozs7OztHQWNHO0FBQ0gsTUFBTSxPQUFPLFlBQVk7SUFDdkIsWUFBb0IsR0FBVyxFQUFVLFNBQVMsQ0FBQztRQUEvQixRQUFHLEdBQUgsR0FBRyxDQUFRO1FBQVUsV0FBTSxHQUFOLE1BQU0sQ0FBSTtJQUFHLENBQUM7SUFFdkQ7Ozs7OztPQU1HO0lBQ0ksSUFBSTtRQUNULE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFDbkQsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNJLE1BQU07UUFDWCxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksS0FBSztRQUNWLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQ3JDLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0ksTUFBTSxDQUFDLEtBQUssR0FBRyxFQUFFO1FBQ3RCLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEdBQVcsRUFBRSxNQUFjLEVBQUUsRUFBRSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUMzRixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksTUFBTTtRQUNYLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQywyQkFBMkIsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNJLE1BQU0sQ0FBQyxLQUFhO1FBQ3pCLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQU0sR0FBRyxLQUFLLENBQUMsQ0FBQztRQUM3RCxJQUFJLENBQUMsTUFBTSxJQUFJLEtBQUssQ0FBQztRQUNyQixPQUFPLEdBQUcsQ0FBQztJQUNiLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSSxNQUFNO1FBQ1gsT0FBTyxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDbEMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNJLElBQUk7UUFDVCxPQUFPLElBQUksSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMxQyxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSSxnQkFBZ0IsQ0FBSSxFQUFvQjtRQUM3QyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFXLEVBQUUsTUFBYyxFQUFFLEVBQUUsQ0FBQywwQkFBMEIsQ0FBQyxFQUFFLEVBQUUsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDakcsQ0FBQztJQUVEOzs7Ozs7Ozs7T0FTRztJQUNJLElBQUksQ0FBSSxFQUFvQjtRQUNqQyxNQUFNLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUNoRCxJQUFJLENBQUMsTUFBTSxJQUFJLEdBQUcsQ0FBQztRQUNuQixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSSxTQUFTO1FBQ2QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDO0lBQ3JCLENBQUM7Q0FDRiJ9

package/dest/serialize/free_funcs.d.ts

@@ -0,0 +1,203 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '@aztec/foundation/fields';
+/**
+ * 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;
+/**
+ * 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;
+/**
+ * Serialize a Buffer into a vector format by encoding the length of the buffer and concatenating it with the original buffer.
+ * The resulting vector consists of a 4-byte header containing the big-endian representation of the original buffer's length, followed by the original buffer.
+ * This function is useful when storing buffers as data structures with dynamic lengths and later deserializing them using 'deserializeBufferFromVector'.
+ *
+ * @param buf - The input Buffer to be serialized into a vector format.
+ * @returns A Buffer containing the serialized vector with the encoded length header.
+ */
+export declare function serializeBufferToVector(buf: Buffer): Buffer;
+/**
+ * Serialize a BigInt value into a Buffer of specified width.
+ * The function converts the input BigInt into its big-endian representation and stores it in a Buffer of the given width.
+ * If the width is not provided, a default value of 32 bytes will be used. It is important to provide an appropriate width
+ * to avoid truncation or incorrect serialization of large BigInt values.
+ *
+ * @param n - The BigInt value to be serialized.
+ * @param width - The width (in bytes) of the output Buffer, optional with default value 32.
+ * @returns A Buffer containing the serialized BigInt value in big-endian format.
+ */
+export declare function serializeBigInt(n: bigint, width?: number): Buffer;
+/**
+ * Deserialize a big integer from a buffer, given an offset and width.
+ * Reads the specified number of bytes from the buffer starting at the offset, converts it to a big integer, and returns the deserialized result along with the number of bytes read (advanced).
+ *
+ * @param buf - The buffer containing the big integer to be deserialized.
+ * @param offset - The position in the buffer where the big integer starts. Defaults to 0.
+ * @param width - The number of bytes to read from the buffer for the big integer. Defaults to 32.
+ * @returns An object containing the deserialized big integer value ('elem') and the number of bytes advanced ('adv').
+ */
+export declare function deserializeBigInt(buf: Buffer, offset?: number, width?: number): {
+    elem: bigint;
+    adv: number;
+};
+/**
+ * Serializes a Date object into a Buffer containing its timestamp as a big integer value.
+ * The resulting Buffer has a fixed width of 8 bytes, representing a 64-bit big-endian integer.
+ * This function is useful for converting date values into a binary format that can be stored or transmitted easily.
+ *
+ * @param date - The Date object to be serialized.
+ * @returns A Buffer containing the serialized timestamp of the input Date object.
+ */
+export declare function serializeDate(date: Date): Buffer;
+/**
+ * Deserialize a buffer from a vector by reading the length from its first 4 bytes, and then extracting the contents of the buffer.
+ * The function returns an object containing the deserialized buffer as 'elem' and the number of bytes advanced ('adv') after deserialization.
+ *
+ * @param vector - The input buffer containing the serialized vector.
+ * @param offset - The starting position from where the deserialization should begin (default is 0).
+ * @returns An object with the deserialized buffer as 'elem' and the number of bytes advanced ('adv') after deserialization.
+ */
+export declare function deserializeBufferFromVector(vector: Buffer, offset?: number): {
+    elem: Buffer;
+    adv: number;
+};
+/**
+ * Deserialize a boolean value from a given buffer at the specified offset.
+ * Reads a single byte at the provided offset in the buffer and returns
+ * the deserialized boolean value along with the number of bytes read (adv).
+ *
+ * @param buf - The buffer containing the serialized boolean value.
+ * @param offset - The position in the buffer to start reading the boolean value.
+ * @returns An object containing the deserialized boolean value (elem) and the number of bytes read (adv).
+ */
+export declare function deserializeBool(buf: Buffer, offset?: number): {
+    elem: number;
+    adv: number;
+};
+/**
+ * Deserialize a 4-byte unsigned integer from a buffer, starting at the specified offset.
+ * The deserialization reads 4 bytes from the given buffer and converts it into a number.
+ * Returns an object containing the deserialized unsigned integer and the number of bytes advanced (4).
+ *
+ * @param buf - The buffer containing the serialized unsigned integer.
+ * @param offset - The starting position in the buffer to deserialize from (default is 0).
+ * @returns An object with the deserialized unsigned integer as 'elem' and the number of bytes advanced ('adv') as 4.
+ */
+export declare function deserializeUInt32(buf: Buffer, offset?: number): {
+    elem: number;
+    adv: number;
+};
+/**
+ * Deserialize a signed 32-bit integer from a buffer at the given offset.
+ * The input 'buf' should be a Buffer containing binary data, and 'offset' should be the position in the buffer
+ * where the signed 32-bit integer starts. Returns an object with both the deserialized integer (elem) and the
+ * number of bytes advanced in the buffer (adv, always equal to 4).
+ *
+ * @param buf - The buffer containing the binary data.
+ * @param offset - Optional, the position in the buffer where the signed 32-bit integer starts (default is 0).
+ * @returns An object with the deserialized integer as 'elem' and the number of bytes advanced as 'adv'.
+ */
+export declare function deserializeInt32(buf: Buffer, offset?: number): {
+    elem: number;
+    adv: number;
+};
+/**
+ * Deserialize a field element from a buffer, starting at the given offset.
+ * The function reads 32 bytes from the buffer and converts it into a field element using Fr.fromBuffer.
+ * It returns an object containing the deserialized field element and the number of bytes read (adv).
+ *
+ * @param buf - The buffer containing the serialized field element.
+ * @param offset - The position in the buffer where the field element starts. Default is 0.
+ * @returns An object with 'elem' as the deserialized field element and 'adv' as the number of bytes read.
+ */
+export declare function deserializeField(buf: Buffer, offset?: number): {
+    elem: Fr;
+    adv: number;
+};
+/**
+ * Serialize an array of Buffer instances into a single Buffer by concatenating the array length as a 4-byte unsigned integer
+ * and then the individual Buffer elements. The function is useful for storing or transmitting an array of binary data chunks
+ * (e.g., file parts) in a compact format.
+ *
+ * @param arr - An array of Buffer instances to be serialized into a single vector-like Buffer.
+ * @returns A Buffer containing the serialized array length followed by the concatenated elements of the input Buffer array.
+ */
+export declare function serializeBufferArrayToVector(arr: Buffer[]): Buffer;
+/**
+ * Deserialize an array of fixed length elements from a given buffer using a custom deserializer function.
+ * The deserializer function should take the buffer and an offset as arguments, and return an object containing
+ * the deserialized element and the number of bytes used to deserialize it (adv).
+ *
+ * @param deserialize - A custom deserializer function to extract individual elements from the buffer.
+ * @param vector - The input buffer containing the serialized array.
+ * @param offset - An optional starting position in the buffer for deserializing the array.
+ * @returns An object containing the deserialized array and the total number of bytes used during deserialization (adv).
+ */
+export declare function deserializeArrayFromVector<T>(deserialize: (buf: Buffer, offset: number) => {
+    /**
+     * The element.
+     */
+    elem: T;
+    /**
+     * The advancement offset.
+     */
+    adv: number;
+}, vector: Buffer, offset?: number): {
+    elem: T[];
+    adv: number;
+};
+/**
+ * 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];
+//# 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":";AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,UAIpC;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;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,UAIlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,SAAK,UAEpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI,EAAE,KAAK,SAAK;;;EAEpE;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,UAEvC;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAIrE;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGvD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,UAIzD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAC1C,WAAW,EAAE,CACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,KACX;IACH;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,EACD,MAAM,EAAE,MAAM,EACd,MAAM,SAAI;;;EAYX;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,CAW/C"}