@aztec-labs/foundation 6.0.0-nightly.20260829

package/dest/schemas/utils.d.ts

@@ -0,0 +1,47 @@
+import { type ZodObject, type ZodRawShape, type ZodType, type ZodTypeAny, z } from 'zod';
+import type { ZodFor } from './types.js';
+export declare const hexSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/** Schema for a buffer represented as a base64 string or a Buffer object. */
+export declare const bufferSchema: ZodFor<Buffer>;
+export type ZodNullableOptional<T extends ZodTypeAny> = ZodType<z.output<T> | undefined, z.input<T> | null | undefined>;
+/**
+ * Declares a parameter as optional. Use this over z.optional in order to accept nulls as undefineds.
+ * This is required as JSON does not have an undefined type, and null is used to represent it, so we
+ * need to convert nulls to undefineds as we parse.
+ */
+export declare function optional<T extends ZodTypeAny>(schema: T): z.ZodPipe<z.ZodOptional<z.ZodNullable<T>>, z.ZodTransform<Awaited<NonNullable<z.TypeOf<T>>> | undefined, z.TypeOf<T> | null | undefined>>;
+type ToJsonIs<T, TRet> = T extends {
+    toJSON(): TRet;
+} ? T : never;
+/**
+ * Creates a schema that accepts a hex string and uses it to hydrate an instance.
+ * @param klazz - Class that implements either fromString or fromBuffer.
+ * @returns A schema for the class.
+ */
+export declare function hexSchemaFor<TClass extends {
+    fromString(str: string): any;
+} | {
+    fromBuffer(buf: Buffer): any;
+}>(klazz: TClass, refinement?: (input: string) => boolean): ZodType<TClass extends {
+    fromString(str: string): infer TInstance;
+} | {
+    fromBuffer(buf: Buffer): infer TInstance;
+} ? ToJsonIs<TInstance, string> : never, string>;
+/**
+ * Creates a schema that accepts a base64 string and uses it to hydrate an instance.
+ * @param klazz - Class that implements fromBuffer.
+ * @returns A schema for the class.
+ */
+export declare function bufferSchemaFor<TClass extends {
+    fromBuffer(buf: Buffer): any;
+}>(klazz: TClass, refinement?: (buf: Buffer) => boolean): ZodType<TClass extends {
+    fromBuffer(buf: Buffer): infer TInstance;
+} ? ToJsonIs<TInstance, Buffer> : never, string>;
+/** Creates a schema for a js Map type that matches the serialization used in jsonStringify. */
+export declare function mapSchema<TKey, TValue>(key: ZodFor<TKey>, value: ZodFor<TValue>): ZodFor<Map<TKey, TValue>>;
+/** Creates a schema for a js Set type that matches the serialization used in jsonStringify. */
+export declare function setSchema<T>(value: ZodFor<T>): ZodFor<Set<T>>;
+/** Given an already parsed and validated object, extracts the keys defined in the given schema. Does not validate again. */
+export declare function pickFromSchema<T extends object, S extends ZodObject<ZodRawShape>>(obj: T, schema: S): Partial<T>;
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zY2hlbWFzL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLFNBQVMsRUFBRSxLQUFLLFdBQVcsRUFBRSxLQUFLLE9BQU8sRUFBRSxLQUFLLFVBQVUsRUFBRSxDQUFDLEVBQUUsTUFBTSxLQUFLLENBQUM7QUFJekYsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRXpDLGVBQU8sTUFBTSxTQUFTLHdEQUFpRixDQUFDO0FBS3hHLDZFQUE2RTtBQUM3RSxlQUFPLE1BQU0sWUFBWSxFQUFFLE1BQU0sQ0FBQyxNQUFNLENBaUJ0QyxDQUFDO0FBRUgsTUFBTSxNQUFNLG1CQUFtQixDQUFDLENBQUMsU0FBUyxVQUFVLElBQUksT0FBTyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEdBQUcsU0FBUyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcsSUFBSSxHQUFHLFNBQVMsQ0FBQyxDQUFDO0FBRXhIOzs7O0dBSUc7QUFDSCx3QkFBZ0IsUUFBUSxDQUFDLENBQUMsU0FBUyxVQUFVLEVBQUUsTUFBTSxFQUFFLENBQUMsNklBRXZEO0FBRUQsS0FBSyxRQUFRLENBQUMsQ0FBQyxFQUFFLElBQUksSUFBSSxDQUFDLFNBQVM7SUFBRSxNQUFNLElBQUksSUFBSSxDQUFBO0NBQUUsR0FBRyxDQUFDLEdBQUcsS0FBSyxDQUFDO0FBRWxFOzs7O0dBSUc7QUFDSCx3QkFBZ0IsWUFBWSxDQUFDLE1BQU0sU0FBUztJQUFFLFVBQVUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLEdBQUcsQ0FBQTtDQUFFLEdBQUc7SUFBRSxVQUFVLENBQUMsR0FBRyxFQUFFLE1BQU0sR0FBRyxHQUFHLENBQUE7Q0FBRSxFQUM3RyxLQUFLLEVBQUUsTUFBTSxFQUNiLFVBQVUsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLE1BQU0sS0FBSyxPQUFPLEdBQ3RDLE9BQU8sQ0FDUixNQUFNLFNBQVM7SUFBRSxVQUFVLENBQUMsR0FBRyxFQUFFLE1BQU0sR0FBRyxNQUFNLFNBQVMsQ0FBQTtDQUFFLEdBQUc7SUFBRSxVQUFVLENBQUMsR0FBRyxFQUFFLE1BQU0sR0FBRyxNQUFNLFNBQVMsQ0FBQTtDQUFFLEdBQ3RHLFFBQVEsQ0FBQyxTQUFTLEVBQUUsTUFBTSxDQUFDLEdBQzNCLEtBQUssRUFDVCxNQUFNLENBQ1AsQ0FNQTtBQUVEOzs7O0dBSUc7QUFDSCx3QkFBZ0IsZUFBZSxDQUFDLE1BQU0sU0FBUztJQUFFLFVBQVUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLEdBQUcsQ0FBQTtDQUFFLEVBQzdFLEtBQUssRUFBRSxNQUFNLEVBQ2IsVUFBVSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxLQUFLLE9BQU8sR0FDcEMsT0FBTyxDQUFDLE1BQU0sU0FBUztJQUFFLFVBQVUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLE1BQU0sU0FBUyxDQUFBO0NBQUUsR0FBRyxRQUFRLENBQUMsU0FBUyxFQUFFLE1BQU0sQ0FBQyxHQUFHLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FFcEg7QUFFRCwrRkFBK0Y7QUFDL0Ysd0JBQWdCLFNBQVMsQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLEdBQUcsRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxNQUFNLENBQUMsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUUzRztBQUVELCtGQUErRjtBQUMvRix3QkFBZ0IsU0FBUyxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FFN0Q7QUFFRCw0SEFBNEg7QUFDNUgsd0JBQWdCLGNBQWMsQ0FBQyxDQUFDLFNBQVMsTUFBTSxFQUFFLENBQUMsU0FBUyxTQUFTLENBQUMsV0FBVyxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQyxjQUVuRyJ9

package/dest/schemas/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/schemas/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIzF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,eAAO,MAAM,SAAS,wDAAiF,CAAC;AAKxG,6EAA6E;AAC7E,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,CAiBtC,CAAC;AAEH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,UAAU,IAAI,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAExH;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE,CAAC,6IAEvD;AAED,KAAK,QAAQ,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,SAAS;IAAE,MAAM,IAAI,IAAI,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAElE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,SAAS;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC7G,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,GACtC,OAAO,CACR,MAAM,SAAS;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,SAAS,CAAA;CAAE,GAAG;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,SAAS,CAAA;CAAE,GACtG,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,GAC3B,KAAK,EACT,MAAM,CACP,CAMA;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,SAAS;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC7E,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GACpC,OAAO,CAAC,MAAM,SAAS;IAAE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,SAAS,CAAA;CAAE,GAAG,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAEpH;AAED,+FAA+F;AAC/F,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAE3G;AAED,+FAA+F;AAC/F,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAE7D;AAED,4HAA4H;AAC5H,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,cAEnG"}

package/dest/schemas/utils.js

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+import { pick } from '../collection/object.js';
+import { isHex, withoutHexPrefix } from '../string/index.js';
+export const hexSchema = z.string().refine(isHex, 'Not a valid hex string').transform(withoutHexPrefix);
+// Copied from zod internals, which was copied from https://stackoverflow.com/questions/7860392/determine-if-string-is-in-base64-using-javascript
+const base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/;
+/** Schema for a buffer represented as a base64 string or a Buffer object. */ export const bufferSchema = z.union([
+    // Serialization from base64 string.
+    z.string()// We only test the str for base64 if it's shorter than 1024 bytes, otherwise we've run into maximum
+    // stack size exceeded errors when trying to validate excessively long strings (such as contract bytecode).
+    .refine((str)=>str.length > 1024 || base64Regex.test(str), 'Not a valid base64 string').transform((data)=>Buffer.from(data, 'base64')),
+    // Serialization from Buffer-annotated object.
+    z.object({
+        type: z.literal('Buffer'),
+        data: z.array(z.number().int().min(0).max(255))
+    }).transform(({ data })=>Buffer.from(data)),
+    // Serialization from Buffer
+    z.instanceof(Buffer)
+]);
+/**
+ * Declares a parameter as optional. Use this over z.optional in order to accept nulls as undefineds.
+ * This is required as JSON does not have an undefined type, and null is used to represent it, so we
+ * need to convert nulls to undefineds as we parse.
+ */ export function optional(schema) {
+    return schema.nullish().transform((value)=>value ?? undefined);
+}
+/**
+ * Creates a schema that accepts a hex string and uses it to hydrate an instance.
+ * @param klazz - Class that implements either fromString or fromBuffer.
+ * @returns A schema for the class.
+ */ export function hexSchemaFor(klazz, refinement) {
+    const stringSchema = refinement ? z.string().refine(refinement, `Not a valid instance`) : z.string();
+    const hexSchema = stringSchema.refine(isHex, 'Not a valid hex string');
+    return 'fromString' in klazz ? hexSchema.transform(klazz.fromString.bind(klazz)) : hexSchema.transform((str)=>Buffer.from(withoutHexPrefix(str), 'hex')).transform(klazz.fromBuffer.bind(klazz));
+}
+/**
+ * Creates a schema that accepts a base64 string and uses it to hydrate an instance.
+ * @param klazz - Class that implements fromBuffer.
+ * @returns A schema for the class.
+ */ export function bufferSchemaFor(klazz, refinement) {
+    return bufferSchema.refine(refinement ?? (()=>true), 'Not a valid buffer').transform(klazz.fromBuffer.bind(klazz));
+}
+/** Creates a schema for a js Map type that matches the serialization used in jsonStringify. */ export function mapSchema(key, value) {
+    return z.array(z.tuple([
+        key,
+        value
+    ])).transform((entries)=>new Map(entries));
+}
+/** Creates a schema for a js Set type that matches the serialization used in jsonStringify. */ export function setSchema(value) {
+    return z.array(value).transform((entries)=>new Set(entries));
+}
+/** Given an already parsed and validated object, extracts the keys defined in the given schema. Does not validate again. */ export function pickFromSchema(obj, schema) {
+    return pick(obj, ...Object.keys(schema.shape));
+}

package/dest/serialize/buffer_reader.d.ts

@@ -0,0 +1,274 @@
+import type { Tuple } from './types.js';
+/**
+ * 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 declare class BufferReader {
+    #private;
+    private buffer;
+    private index;
+    constructor(buffer: Buffer, offset?: number);
+    /**
+     * 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: Uint8Array | Buffer | BufferReader): BufferReader;
+    /** Returns true if the underlying buffer has been consumed completely. */
+    isEmpty(): boolean;
+    /**
+     * 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(): number;
+    /**
+     * 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<N extends number>(count: N): Tuple<number, N>;
+    /**
+     * 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.
+     */
+    readUInt64(): bigint;
+    /**
+     * Reads a 128-bit unsigned integer from the buffer at the current index position.
+     * Updates the index position by 16 bytes after reading the number.
+     *
+     * Assumes the number is stored in big-endian format.
+     *
+     * @returns The read 128 bit value as a bigint.
+     */
+    readUInt128(): bigint;
+    /**
+     * 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(): bigint;
+    /**
+     * Reads a 256-bit signed integer (two's complement) from the buffer at the current index position.
+     * Updates the index position by 32 bytes after reading the number.
+     *
+     * @returns The read 256 bit signed value as a bigint.
+     */
+    readInt256(): bigint;
+    /** Alias for readUInt256 */
+    readBigInt(): bigint;
+    /**
+     * 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(): number;
+    /**
+     * 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(): number;
+    /**
+     * 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(): boolean;
+    /**
+     * 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: number): Buffer;
+    /** Reads until the end of the buffer. */
+    readToEnd(): Buffer;
+    /**
+     * 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(): number[];
+    /**
+     * Reads a vector of 256-bit unsigned integers from the buffer and returns it as an array of bigints.
+     * The method utilizes the 'readVector' method, passing a deserializer that reads bigints.
+     *
+     * @returns An array of bigints representing the vector read from the buffer.
+     */
+    readUint256Vector(): bigint[];
+    /**
+     * 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.
+     * @param maxSize - Optional maximum allowed size for the vector. If the size exceeds this, an error is thrown.
+     * @returns An array of deserialized elements of type T.
+     */
+    readVector<T>(itemDeserializer: {
+        /**
+         * A method to deserialize data from a buffer.
+         */
+        fromBuffer: (reader: BufferReader) => T;
+    }, maxSize?: number): T[];
+    /**
+     * 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<T>(itemDeserializer: {
+        /**
+         * A method to deserialize data from a buffer.
+         */
+        fromBuffer: (reader: BufferReader) => T;
+    }): T[];
+    /**
+     * 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<T, N extends number>(size: N, itemDeserializer: {
+        /**
+         * A function for deserializing data from a BufferReader instance.
+         */
+        fromBuffer: (reader: BufferReader) => T;
+    }): Tuple<T, N>;
+    /**
+     * 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?: number): Buffer[];
+    /**
+     * 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<T>(deserializer: {
+        /**
+         * A method that takes a BufferReader instance and returns an instance of the deserialized data type.
+         */
+        fromBuffer: (reader: BufferReader) => T;
+    }): T;
+    /**
+     * 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?: number): Buffer;
+    /**
+     * 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.
+     *
+     * @param maxSize - Optional maximum allowed size for the string buffer. If the size exceeds this, an error is thrown.
+     * @returns The read string from the buffer.
+     */
+    readString(maxSize?: number): string;
+    /**
+     * 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.
+     *
+     * @param maxSize - Optional maximum allowed size for the buffer. If the size exceeds this, an error is thrown.
+     * @returns A Buffer containing the read bytes.
+     */
+    readBuffer(maxSize?: number): Buffer;
+    /**
+     * 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(): Uint8Array;
+    /**
+     * 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<T>(deserializer: {
+        /**
+         * Deserializes an element of type T from a BufferReader instance.
+         */
+        fromBuffer: (reader: BufferReader) => T;
+    }): {
+        [key: string]: T;
+    };
+    /**
+     * Get the length of the reader's buffer.
+     * @returns The length of the underlying reader's buffer.
+     */
+    getLength(): number;
+    /**
+     * Gets bytes remaining to be read from the buffer.
+     * @returns Bytes remaining to be read from the buffer.
+     */
+    remainingBytes(): number;
+}
+/**
+ * A deserializer
+ */
+export interface FromBuffer<T> {
+    /**
+     * Deserializes an object from a buffer
+     * @param buffer - The buffer to deserialize.
+     */
+    fromBuffer(buffer: Buffer): T;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVmZmVyX3JlYWRlci5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcmlhbGl6ZS9idWZmZXJfcmVhZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLFlBQVksQ0FBQztBQUV4Qzs7Ozs7Ozs7Ozs7Ozs7OztHQWdCRztBQUNILHFCQUFhLFlBQVk7O0lBR3JCLE9BQU8sQ0FBQyxNQUFNO0lBRmhCLE9BQU8sQ0FBQyxLQUFLLENBQVM7SUFDdEIsWUFDVSxNQUFNLEVBQUUsTUFBTSxFQUN0QixNQUFNLFNBQUksRUFHWDtJQUVEOzs7Ozs7O09BT0c7SUFDSCxPQUFjLFFBQVEsQ0FBQyxjQUFjLEVBQUUsVUFBVSxHQUFHLE1BQU0sR0FBRyxZQUFZLEdBQUcsWUFBWSxDQVV2RjtJQUVELDBFQUEwRTtJQUNuRSxPQUFPLElBQUksT0FBTyxDQUV4QjtJQUVEOzs7OztPQUtHO0lBQ0ksVUFBVSxJQUFJLE1BQU0sQ0FJMUI7SUFFRDs7OztPQUlHO0lBQ0ksV0FBVyxDQUFDLENBQUMsU0FBUyxNQUFNLEVBQUUsS0FBSyxFQUFFLENBQUMsR0FBRyxLQUFLLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxDQUcvRDtJQUVEOzs7Ozs7O09BT0c7SUFDSSxVQUFVLElBQUksTUFBTSxDQU8xQjtJQUVEOzs7Ozs7O09BT0c7SUFDSSxXQUFXLElBQUksTUFBTSxDQVUzQjtJQUVEOzs7Ozs7O09BT0c7SUFDSSxXQUFXLElBQUksTUFBTSxDQVUzQjtJQUVEOzs7OztPQUtHO0lBQ0ksVUFBVSxJQUFJLE1BQU0sQ0FNMUI7SUFFRCw0QkFBNEI7SUFDckIsVUFBVSxJQUFJLE1BQU0sQ0FFMUI7SUFFRDs7Ozs7T0FLRztJQUNJLFVBQVUsSUFBSSxNQUFNLENBSTFCO0lBRUQ7Ozs7O09BS0c7SUFDSSxTQUFTLElBQUksTUFBTSxDQUl6QjtJQUVEOzs7Ozs7T0FNRztJQUNJLFdBQVcsSUFBSSxPQUFPLENBSTVCO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLFNBQVMsQ0FBQyxDQUFDLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0FJbEM7SUFFRCx5Q0FBeUM7SUFDbEMsU0FBUyxJQUFJLE1BQU0sQ0FJekI7SUFFRDs7Ozs7T0FLRztJQUNJLGdCQUFnQixJQUFJLE1BQU0sRUFBRSxDQUlsQztJQUVEOzs7OztPQUtHO0lBQ0ksaUJBQWlCLElBQUksTUFBTSxFQUFFLENBSW5DO0lBRUQ7Ozs7Ozs7OztPQVNHO0lBQ0ksVUFBVSxDQUFDLENBQUMsRUFDakIsZ0JBQWdCLEVBQUU7UUFDaEI7O1dBRUc7UUFDSCxVQUFVLEVBQUUsQ0FBQyxNQUFNLEVBQUUsWUFBWSxLQUFLLENBQUMsQ0FBQztLQUN6QyxFQUNELE9BQU8sQ0FBQyxFQUFFLE1BQU0sR0FDZixDQUFDLEVBQUUsQ0FlTDtJQUVEOzs7Ozs7OztPQVFHO0lBQ0kscUJBQXFCLENBQUMsQ0FBQyxFQUFFLGdCQUFnQixFQUFFO1FBQ2hEOztXQUVHO1FBQ0gsVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLFlBQVksS0FBSyxDQUFDLENBQUM7S0FDekMsR0FBRyxDQUFDLEVBQUUsQ0FPTjtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNJLFNBQVMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxTQUFTLE1BQU0sRUFDbEMsSUFBSSxFQUFFLENBQUMsRUFDUCxnQkFBZ0IsRUFBRTtRQUNoQjs7V0FFRztRQUNILFVBQVUsRUFBRSxDQUFDLE1BQU0sRUFBRSxZQUFZLEtBQUssQ0FBQyxDQUFDO0tBQ3pDLEdBQ0EsS0FBSyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FHYjtJQUVEOzs7Ozs7O09BT0c7SUFDSSxlQUFlLENBQUMsSUFBSSxTQUFLLEdBQUcsTUFBTSxFQUFFLENBZTFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksVUFBVSxDQUFDLENBQUMsRUFBRSxZQUFZLEVBQUU7UUFDakM7O1dBRUc7UUFDSCxVQUFVLEVBQUUsQ0FBQyxNQUFNLEVBQUUsWUFBWSxLQUFLLENBQUMsQ0FBQztLQUN6QyxHQUFHLENBQUMsQ0FFSjtJQUVEOzs7Ozs7T0FNRztJQUNJLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxNQUFNLEdBQUcsTUFBTSxDQUduQztJQUVEOzs7Ozs7O09BT0c7SUFDSSxVQUFVLENBQUMsT0FBTyxDQUFDLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0FFMUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNJLFVBQVUsQ0FBQyxPQUFPLENBQUMsRUFBRSxNQUFNLEdBQUcsTUFBTSxDQU8xQztJQUVEOzs7Ozs7O09BT0c7SUFDSSxjQUFjLElBQUksVUFBVSxDQUlsQztJQUVEOzs7Ozs7OztPQVFHO0lBQ0ksT0FBTyxDQUFDLENBQUMsRUFBRSxZQUFZLEVBQUU7UUFDOUI7O1dBRUc7UUFDSCxVQUFVLEVBQUUsQ0FBQyxNQUFNLEVBQUUsWUFBWSxLQUFLLENBQUMsQ0FBQztLQUN6QyxHQUFHO1FBQUUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLENBQUMsQ0FBQTtLQUFFLENBU3ZCO0lBRUQ7OztPQUdHO0lBQ0ksU0FBUyxJQUFJLE1BQU0sQ0FFekI7SUFFRDs7O09BR0c7SUFDSSxjQUFjLElBQUksTUFBTSxDQUU5QjtDQVNGO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsVUFBVSxDQUFDLENBQUM7SUFDM0I7OztPQUdHO0lBQ0gsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLEdBQUcsQ0FBQyxDQUFDO0NBQy9CIn0=

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

@@ -0,0 +1 @@
+{"version":3,"file":"buffer_reader.d.ts","sourceRoot":"","sources":["../../src/serialize/buffer_reader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAY;;IAGrB,OAAO,CAAC,MAAM;IAFhB,OAAO,CAAC,KAAK,CAAS;IACtB,YACU,MAAM,EAAE,MAAM,EACtB,MAAM,SAAI,EAGX;IAED;;;;;;;OAOG;IACH,OAAc,QAAQ,CAAC,cAAc,EAAE,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAUvF;IAED,0EAA0E;IACnE,OAAO,IAAI,OAAO,CAExB;IAED;;;;;OAKG;IACI,UAAU,IAAI,MAAM,CAI1B;IAED;;;;OAIG;IACI,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAG/D;IAED;;;;;;;OAOG;IACI,UAAU,IAAI,MAAM,CAO1B;IAED;;;;;;;OAOG;IACI,WAAW,IAAI,MAAM,CAU3B;IAED;;;;;;;OAOG;IACI,WAAW,IAAI,MAAM,CAU3B;IAED;;;;;OAKG;IACI,UAAU,IAAI,MAAM,CAM1B;IAED,4BAA4B;IACrB,UAAU,IAAI,MAAM,CAE1B;IAED;;;;;OAKG;IACI,UAAU,IAAI,MAAM,CAI1B;IAED;;;;;OAKG;IACI,SAAS,IAAI,MAAM,CAIzB;IAED;;;;;;OAMG;IACI,WAAW,IAAI,OAAO,CAI5B;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAIlC;IAED,yCAAyC;IAClC,SAAS,IAAI,MAAM,CAIzB;IAED;;;;;OAKG;IACI,gBAAgB,IAAI,MAAM,EAAE,CAIlC;IAED;;;;;OAKG;IACI,iBAAiB,IAAI,MAAM,EAAE,CAInC;IAED;;;;;;;;;OASG;IACI,UAAU,CAAC,CAAC,EACjB,gBAAgB,EAAE;QAChB;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,CAAC,CAAC;KACzC,EACD,OAAO,CAAC,EAAE,MAAM,GACf,CAAC,EAAE,CAeL;IAED;;;;;;;;OAQG;IACI,qBAAqB,CAAC,CAAC,EAAE,gBAAgB,EAAE;QAChD;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,CAAC,CAAC;KACzC,GAAG,CAAC,EAAE,CAON;IAED;;;;;;;;;OASG;IACI,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAClC,IAAI,EAAE,CAAC,EACP,gBAAgB,EAAE;QAChB;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,CAAC,CAAC;KACzC,GACA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAGb;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,IAAI,SAAK,GAAG,MAAM,EAAE,CAe1C;IAED;;;;;;OAMG;IACI,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE;QACjC;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,CAAC,CAAC;KACzC,GAAG,CAAC,CAEJ;IAED;;;;;;OAMG;IACI,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAGnC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAE1C;IAED;;;;;;;;OAQG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAO1C;IAED;;;;;;;OAOG;IACI,cAAc,IAAI,UAAU,CAIlC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE;QAC9B;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,CAAC,CAAC;KACzC,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE,CASvB;IAED;;;OAGG;IACI,SAAS,IAAI,MAAM,CAEzB;IAED;;;OAGG;IACI,cAAc,IAAI,MAAM,CAE9B;CASF;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC;CAC/B"}