@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/bcs/deserializer.js

@@ -0,0 +1,470 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { MAX_U32_NUMBER } from "./consts.js";
+import { Hex } from "../core/hex.js";
+/**
+ * Shared TextDecoder instance for string deserialization to avoid repeated instantiation.
+ */
+const TEXT_DECODER = new TextDecoder();
+/**
+ * Maximum allowed length for deserialized byte arrays and strings.
+ * This prevents memory exhaustion attacks from malformed BCS data.
+ * Set to 10MB which should be sufficient for any legitimate use case.
+ */
+const MAX_DESERIALIZE_BYTES_LENGTH = 10 * 1024 * 1024; // 10MB
+/**
+ * A class that provides methods for deserializing various data types from a byte buffer.
+ * It supports deserialization of primitive types, strings, and complex objects using a BCS (Binary Common Serialization) layout.
+ * @group Implementation
+ * @category BCS
+ */
+export class Deserializer {
+    buffer;
+    offset;
+    /**
+     * Creates a new instance of the class with a copy of the provided data buffer.
+     * This prevents outside mutation of the buffer.
+     *
+     * @param data - The data to be copied into the internal buffer as a Uint8Array.
+     * @group Implementation
+     * @category BCS
+     */
+    constructor(data) {
+        // copies data to prevent outside mutation of buffer.
+        this.buffer = new ArrayBuffer(data.length);
+        new Uint8Array(this.buffer).set(data, 0);
+        this.offset = 0;
+    }
+    static fromHex(hex) {
+        const data = Hex.hexInputToUint8Array(hex);
+        return new Deserializer(data);
+    }
+    /**
+     * Reads a specified number of bytes from the buffer and advances the offset.
+     * Returns a view into the buffer rather than copying for better performance.
+     *
+     * SECURITY NOTE: This returns a view, not a copy. Callers that expose the result
+     * externally MUST call .slice() to create a copy. Internal numeric deserializers
+     * (deserializeU8, deserializeU16, etc.) only read values and don't expose the view.
+     * deserializeBytes() and deserializeFixedBytes() call .slice() before returning.
+     *
+     * @param length - The number of bytes to read from the buffer.
+     * @throws Throws an error if the read operation exceeds the buffer's length.
+     * @group Implementation
+     * @category BCS
+     */
+    read(length) {
+        if (this.offset + length > this.buffer.byteLength) {
+            throw new Error("Reached to the end of buffer");
+        }
+        // Use subarray to return a view instead of slice which copies
+        // SECURITY: View is safe because numeric deserializers only read values,
+        // and byte deserializers call .slice() before returning to caller
+        const bytes = new Uint8Array(this.buffer, this.offset, length);
+        this.offset += length;
+        return bytes;
+    }
+    /**
+     * Returns the number of bytes remaining in the buffer.
+     *
+     * This information is useful to determine if there's more data to be read.
+     *
+     * @returns The number of bytes remaining in the buffer.
+     * @group Implementation
+     * @category BCS
+     */
+    remaining() {
+        return this.buffer.byteLength - this.offset;
+    }
+    /**
+     * Asserts that the buffer has no remaining bytes.
+     *
+     * @throws {Error} Throws an error if there are remaining bytes in the buffer.
+     * @group Implementation
+     * @category BCS
+     */
+    assertFinished() {
+        if (this.remaining() !== 0) {
+            throw new Error("Buffer has remaining bytes");
+        }
+    }
+    /**
+     * Deserializes a UTF-8 encoded string from a byte array. It first reads the length of the string in bytes,
+     * followed by the actual byte content, and decodes it into a string.
+     *
+     * BCS layout for "string": string_length | string_content
+     * where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
+     *
+     * @example
+     * ```typescript
+     * const deserializer = new Deserializer(new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
+     * assert(deserializer.deserializeStr() === "1234abcd");
+     * ```
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeStr() {
+        const value = this.deserializeBytes();
+        return TEXT_DECODER.decode(value);
+    }
+    /**
+     * @deprecated use `deserializeOption("string")` instead.
+     *
+     * The BCS layout for Optional<String> is 0 if none, else 1 followed by the string length and string content.
+     * @returns The deserialized string if it exists, otherwise undefined.
+     * @example
+     * ```typescript
+     * const deserializer = new Deserializer(new Uint8Array([0x00]));
+     * assert(deserializer.deserializeOptionStr() === undefined);
+     * const deserializer = new Deserializer(new Uint8Array([1, 8, 49, 50, 51, 52, 97, 98, 99, 100]));
+     * assert(deserializer.deserializeOptionStr() === "1234abcd");
+     * ```
+     */
+    deserializeOptionStr() {
+        return this.deserializeOption("string");
+    }
+    deserializeOption(type, len) {
+        const exists = this.deserializeBool();
+        if (!exists)
+            return undefined;
+        if (type === "string") {
+            return this.deserializeStr();
+        }
+        if (type === "bytes") {
+            return this.deserializeBytes();
+        }
+        if (type === "fixedBytes") {
+            if (len === undefined) {
+                throw new Error("Fixed bytes length not provided");
+            }
+            return this.deserializeFixedBytes(len);
+        }
+        return this.deserialize(type);
+    }
+    /**
+     * Deserializes an array of bytes.
+     *
+     * The BCS layout for "bytes" consists of a bytes_length followed by the bytes themselves, where bytes_length is a u32 integer
+     * encoded as a uleb128 integer, indicating the length of the bytes array.
+     *
+     * @returns {Uint8Array} The deserialized array of bytes (a copy, safe to modify).
+     * @throws {Error} If the length exceeds the maximum allowed (10MB) to prevent memory exhaustion.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeBytes() {
+        const len = this.deserializeUleb128AsU32();
+        // Security: Prevent memory exhaustion from malformed data
+        if (len > MAX_DESERIALIZE_BYTES_LENGTH) {
+            throw new Error(`Deserialization error: byte array length ${len} exceeds maximum allowed ${MAX_DESERIALIZE_BYTES_LENGTH}`);
+        }
+        // Return a copy so caller can safely modify without affecting buffer
+        return this.read(len).slice();
+    }
+    /**
+     * Deserializes an array of bytes of a specified length.
+     *
+     * @param len - The number of bytes to read from the source.
+     * @returns {Uint8Array} The deserialized array of bytes (a copy, safe to modify).
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeFixedBytes(len) {
+        // Return a copy so caller can safely modify without affecting buffer
+        return this.read(len).slice();
+    }
+    /**
+     * Deserializes a boolean value from a byte stream.
+     *
+     * The BCS layout for a boolean uses one byte, where "0x01" represents true and "0x00" represents false.
+     * An error is thrown if the byte value is not valid.
+     *
+     * @returns The deserialized boolean value.
+     * @throws Throws an error if the boolean value is invalid.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeBool() {
+        const bool = this.read(1)[0];
+        if (bool !== 1 && bool !== 0) {
+            throw new Error("Invalid boolean value");
+        }
+        return bool === 1;
+    }
+    /**
+     * Deserializes a uint8 number from the binary data.
+     *
+     * BCS layout for "uint8": One byte. Binary format in little-endian representation.
+     *
+     * @returns {number} The deserialized uint8 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU8() {
+        return this.read(1)[0];
+    }
+    /**
+     * Deserializes a uint16 number from a binary format in little-endian representation.
+     *
+     * BCS layout for "uint16": Two bytes.
+     * @example
+     * ```typescript
+     * const deserializer = new Deserializer(new Uint8Array([0x34, 0x12]));
+     * assert(deserializer.deserializeU16() === 4660);
+     * ```
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU16() {
+        const bytes = this.read(2);
+        return new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength).getUint16(0, true);
+    }
+    /**
+     * Deserializes a uint32 number from a binary format in little-endian representation.
+     *
+     * BCS layout for "uint32": Four bytes.
+     * @example
+     * ```typescript
+     * const deserializer = new Deserializer(new Uint8Array([0x78, 0x56, 0x34, 0x12]));
+     * assert(deserializer.deserializeU32() === 305419896);
+     * ```
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU32() {
+        const bytes = this.read(4);
+        return new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength).getUint32(0, true);
+    }
+    /**
+     * Deserializes a uint64 number.
+     *
+     * This function combines two 32-bit values to return a 64-bit unsigned integer in little-endian representation.
+     * @example
+     * ```typescript
+     * const deserializer = new Deserializer(new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
+     * assert(deserializer.deserializeU64() === 1311768467750121216);
+     * ```
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU64() {
+        const low = this.deserializeU32();
+        const high = this.deserializeU32();
+        // combine the two 32-bit values and return (little endian)
+        return BigInt((BigInt(high) << BigInt(32)) | BigInt(low));
+    }
+    /**
+     * Deserializes a uint128 number from its binary representation.
+     * This function combines two 64-bit values to return a single uint128 value in little-endian format.
+     *
+     * @returns {BigInt} The deserialized uint128 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU128() {
+        const low = this.deserializeU64();
+        const high = this.deserializeU64();
+        // combine the two 64-bit values and return (little endian)
+        return BigInt((high << BigInt(64)) | low);
+    }
+    /**
+     * Deserializes a uint256 number from its binary representation.
+     *
+     * The BCS layout for "uint256" consists of thirty-two bytes in little-endian format.
+     *
+     * @returns {BigInt} The deserialized uint256 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeU256() {
+        const low = this.deserializeU128();
+        const high = this.deserializeU128();
+        // combine the two 128-bit values and return (little endian)
+        return BigInt((high << BigInt(128)) | low);
+    }
+    /**
+     * Deserializes an 8-bit signed integer from the binary data.
+     * BCS layout for "int8": One byte. Binary format in little-endian representation.
+     *
+     * @returns {number} The deserialized int8 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI8() {
+        const bytes = this.read(1);
+        return new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength).getInt8(0);
+    }
+    /**
+     * Deserializes a 16-bit signed integer from a binary format in little-endian representation.
+     * BCS layout for "int16": Two bytes.
+     *
+     * @returns {number} The deserialized int16 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI16() {
+        const bytes = this.read(2);
+        return new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength).getInt16(0, true);
+    }
+    /**
+     * Deserializes a 32-bit signed integer from a binary format in little-endian representation.
+     * BCS layout for "int32": Four bytes.
+     *
+     * @returns {number} The deserialized int32 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI32() {
+        const bytes = this.read(4);
+        return new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength).getInt32(0, true);
+    }
+    /**
+     * Deserializes a 64-bit signed integer.
+     * This function combines two 32-bit values to return a 64-bit signed integer in little-endian representation.
+     *
+     * @returns {bigint} The deserialized int64 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI64() {
+        const low = this.deserializeU32();
+        const high = this.deserializeU32();
+        // combine the two 32-bit values (little endian)
+        const unsigned = BigInt((BigInt(high) << BigInt(32)) | BigInt(low));
+        // Convert from unsigned to signed using two's complement
+        const signBit = BigInt(1) << BigInt(63);
+        if (unsigned >= signBit) {
+            return unsigned - (BigInt(1) << BigInt(64));
+        }
+        return unsigned;
+    }
+    /**
+     * Deserializes a 128-bit signed integer from its binary representation.
+     * This function combines two 64-bit values to return a single int128 value in little-endian format.
+     *
+     * @returns {bigint} The deserialized int128 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI128() {
+        const low = this.deserializeU64();
+        const high = this.deserializeU64();
+        // combine the two 64-bit values (little endian)
+        const unsigned = BigInt((high << BigInt(64)) | low);
+        // Convert from unsigned to signed using two's complement
+        const signBit = BigInt(1) << BigInt(127);
+        if (unsigned >= signBit) {
+            return unsigned - (BigInt(1) << BigInt(128));
+        }
+        return unsigned;
+    }
+    /**
+     * Deserializes a 256-bit signed integer from its binary representation.
+     * BCS layout for "int256": Thirty-two bytes in little-endian format.
+     *
+     * @returns {bigint} The deserialized int256 number.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeI256() {
+        const low = this.deserializeU128();
+        const high = this.deserializeU128();
+        // combine the two 128-bit values (little endian)
+        const unsigned = BigInt((high << BigInt(128)) | low);
+        // Convert from unsigned to signed using two's complement
+        const signBit = BigInt(1) << BigInt(255);
+        if (unsigned >= signBit) {
+            return unsigned - (BigInt(1) << BigInt(256));
+        }
+        return unsigned;
+    }
+    /**
+     * Deserializes a uleb128 encoded uint32 number.
+     *
+     * This function is used for interpreting lengths of variable-length sequences and tags of enum values in BCS encoding.
+     *
+     * @throws {Error} Throws an error if the parsed value exceeds the maximum uint32 number.
+     * @throws {Error} Throws an error if the uleb128 encoding is malformed (too many bytes).
+     * @returns {number} The deserialized uint32 value.
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeUleb128AsU32() {
+        let value = BigInt(0);
+        let shift = 0;
+        // Maximum 5 bytes for uleb128-encoded u32 (7 bits per byte, 5*7=35 bits > 32 bits needed)
+        const MAX_ULEB128_BYTES = 5;
+        let bytesRead = 0;
+        while (bytesRead < MAX_ULEB128_BYTES) {
+            const byte = this.deserializeU8();
+            bytesRead += 1;
+            value |= BigInt(byte & 0x7f) << BigInt(shift);
+            // Early overflow check before continuing
+            if (value > MAX_U32_NUMBER) {
+                throw new Error("Overflow while parsing uleb128-encoded uint32 value");
+            }
+            if ((byte & 0x80) === 0) {
+                break;
+            }
+            shift += 7;
+        }
+        // If we read MAX_ULEB128_BYTES and the last byte had continuation bit set, it's malformed
+        if (bytesRead === MAX_ULEB128_BYTES && value > MAX_U32_NUMBER) {
+            throw new Error("Overflow while parsing uleb128-encoded uint32 value");
+        }
+        return Number(value);
+    }
+    /**
+     * Helper function that primarily exists to support alternative syntax for deserialization.
+     * That is, if we have a `const deserializer: new Deserializer(...)`, instead of having to use
+     * `MyClass.deserialize(deserializer)`, we can call `deserializer.deserialize(MyClass)`.
+     *
+     * @example const deserializer = new Deserializer(new Uint8Array([1, 2, 3]));
+     * const value = deserializer.deserialize(MyClass); // where MyClass has a `deserialize` function
+     * // value is now an instance of MyClass
+     * // equivalent to `const value = MyClass.deserialize(deserializer)`
+     * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
+     *
+     * @returns the deserialized value of class type T
+     * @group Implementation
+     * @category BCS
+     */
+    deserialize(cls) {
+        // NOTE: `deserialize` in `cls.deserialize(this)` here is a static method defined in `cls`,
+        // It is separate from the `deserialize` instance method defined here in Deserializer.
+        return cls.deserialize(this);
+    }
+    /**
+     * Deserializes an array of BCS Deserializable values given an existing Deserializer instance with a loaded byte buffer.
+     *
+     * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
+     * @returns An array of deserialized values of type T.
+     * @example
+     * // serialize a vector of addresses
+     * const addresses = new Array<AccountAddress>(
+     *   AccountAddress.from("0x1"),
+     *   AccountAddress.from("0x2"),
+     *   AccountAddress.from("0xa"),
+     *   AccountAddress.from("0xb"),
+     * );
+     * const serializer = new Serializer();
+     * serializer.serializeVector(addresses);
+     * const serializedBytes = serializer.toUint8Array();
+     *
+     * // deserialize the bytes into an array of addresses
+     * const deserializer = new Deserializer(serializedBytes);
+     * const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
+     * // deserializedAddresses is now an array of AccountAddress instances
+     * @group Implementation
+     * @category BCS
+     */
+    deserializeVector(cls) {
+        const length = this.deserializeUleb128AsU32();
+        const vector = new Array();
+        for (let i = 0; i < length; i += 1) {
+            vector.push(this.deserialize(cls));
+        }
+        return vector;
+    }
+}
+//# sourceMappingURL=deserializer.js.map

package/dist/bcs/deserializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deserializer.js","sourceRoot":"","sources":["../../src/bcs/deserializer.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC;;GAEG;AACH,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;AAEvC;;;;GAIG;AACH,MAAM,4BAA4B,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,OAAO;AAiC9D;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IACf,MAAM,CAAc;IAEpB,MAAM,CAAS;IAEvB;;;;;;;OAOG;IACH,YAAY,IAAgB;QAC1B,qDAAqD;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,GAAa;QAC1B,MAAM,IAAI,GAAG,GAAG,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,MAAc;QACzB,IAAI,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,8DAA8D;QAC9D,yEAAyE;QACzE,kEAAkE;QAClE,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,cAAc;QACZ,IAAI,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IA4CD,iBAAiB,CACf,IAA2D,EAC3D,GAAY;QAEZ,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QAE9B,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YAC1B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC3C,0DAA0D;QAC1D,IAAI,GAAG,GAAG,4BAA4B,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CACb,4CAA4C,GAAG,4BAA4B,4BAA4B,EAAE,CAC1G,CAAC;QACJ,CAAC;QACD,qEAAqE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB,CAAC,GAAW;QAC/B,qEAAqE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEnC,2DAA2D;QAC3D,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,eAAe;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEnC,2DAA2D;QAC3D,OAAO,MAAM,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAEpC,4DAA4D;QAC5D,OAAO,MAAM,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACH,aAAa;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEnC,gDAAgD;QAChD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAEpE,yDAAyD;QACzD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;QACxC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,OAAO,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,eAAe;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEnC,gDAAgD;QAChD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAEpD,yDAAyD;QACzD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,OAAO,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,eAAe;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAEpC,iDAAiD;QACjD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAErD,yDAAyD;QACzD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,OAAO,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,uBAAuB;QACrB,IAAI,KAAK,GAAW,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,0FAA0F;QAC1F,MAAM,iBAAiB,GAAG,CAAC,CAAC;QAC5B,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,OAAO,SAAS,GAAG,iBAAiB,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAClC,SAAS,IAAI,CAAC,CAAC;YAEf,KAAK,IAAI,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;YAE9C,yCAAyC;YACzC,IAAI,KAAK,GAAG,cAAc,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;YACzE,CAAC;YAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM;YACR,CAAC;YAED,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;QAED,0FAA0F;QAC1F,IAAI,SAAS,KAAK,iBAAiB,IAAI,KAAK,GAAG,cAAc,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAI,GAAsB;QACnC,2FAA2F;QAC3F,sFAAsF;QACtF,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,CAAI,GAAsB;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,KAAK,EAAK,CAAC;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/bcs/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./deserializer.js";
+export * from "./serializer.js";
+export * from "./serializable/entryFunctionBytes.js";
+export * from "./serializable/fixedBytes.js";
+export * from "./serializable/movePrimitives.js";
+export * from "./serializable/moveStructs.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/bcs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bcs/index.ts"],"names":[],"mappings":"AAGA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC"}

package/dist/bcs/index.js

@@ -0,0 +1,9 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export * from "./deserializer.js";
+export * from "./serializer.js";
+export * from "./serializable/entryFunctionBytes.js";
+export * from "./serializable/fixedBytes.js";
+export * from "./serializable/movePrimitives.js";
+export * from "./serializable/moveStructs.js";
+//# sourceMappingURL=index.js.map

package/dist/bcs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/bcs/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC"}

package/dist/bcs/serializable/entryFunctionBytes.d.ts

@@ -0,0 +1,60 @@
+import { Serializer, Serializable } from "../serializer.js";
+import { Deserializer } from "../deserializer.js";
+import { FixedBytes } from "./fixedBytes.js";
+import { EntryFunctionArgument } from "../../transactions/instances/transactionArgument.js";
+/**
+ * This class exists solely to represent a sequence of fixed bytes as a serialized entry function, because
+ * serializing an entry function appends a prefix that's *only* used for entry function arguments.
+ *
+ * NOTE: Using this class for serialized script functions will lead to erroneous and unexpected behavior.
+ *
+ * If you wish to convert this class back to a TransactionArgument, you must know the type
+ * of the argument beforehand, and use the appropriate class to deserialize the bytes within
+ * an instance of this class.
+ * @group Implementation
+ * @category BCS
+ */
+export declare class EntryFunctionBytes extends Serializable implements EntryFunctionArgument {
+    readonly value: FixedBytes;
+    /**
+     * Creates an instance of the class with a specified hexadecimal input value.
+     *
+     * @param value - The hexadecimal input to be converted into FixedBytes.
+     * @group Implementation
+     * @category BCS
+     */
+    private constructor();
+    /**
+     * Serializes the value using the provided serializer.
+     * This function is essential for accurately representing a sequence of bytes that are already BCS-serialized as a type.
+     *
+     * Note that to see the Move, BCS-serialized representation of the underlying fixed byte vector,
+     * we must not serialize the length prefix.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Serializes the current instance for use as an entry function argument by converting the underlying fixed byte vector to a
+     * type-agnostic byte vector.
+     * This process includes serializing the length prefix of the byte vector.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
+     */
+    serializeForEntryFunction(serializer: Serializer): void;
+    /**
+     * The only way to create an instance of this class is to use this static method.
+     * This function should only be used when deserializing a sequence of EntryFunctionPayload arguments.
+     * @param deserializer - The deserializer instance with the buffered bytes.
+     * @param length - The length of the bytes to deserialize.
+     * @returns An instance of this class, which will now only be usable as an EntryFunctionArgument.
+     * @group Implementation
+     * @category BCS
+     */
+    static deserialize(deserializer: Deserializer, length: number): EntryFunctionBytes;
+}
+//# sourceMappingURL=entryFunctionBytes.d.ts.map

package/dist/bcs/serializable/entryFunctionBytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entryFunctionBytes.d.ts","sourceRoot":"","sources":["../../../src/bcs/serializable/entryFunctionBytes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qDAAqD,CAAC;AAG5F;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,qBAAqB;IACnF,SAAgB,KAAK,EAAE,UAAU,CAAC;IAElC;;;;;;OAMG;IACH,OAAO;IAYP;;;;;;;;;;OAUG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAUvC;;;;;;;;OAQG;IACH,yBAAyB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvD;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,kBAAkB;CAInF"}

package/dist/bcs/serializable/entryFunctionBytes.js

@@ -0,0 +1,82 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { Serializable } from "../serializer.js";
+import { FixedBytes } from "./fixedBytes.js";
+/**
+ * This class exists solely to represent a sequence of fixed bytes as a serialized entry function, because
+ * serializing an entry function appends a prefix that's *only* used for entry function arguments.
+ *
+ * NOTE: Using this class for serialized script functions will lead to erroneous and unexpected behavior.
+ *
+ * If you wish to convert this class back to a TransactionArgument, you must know the type
+ * of the argument beforehand, and use the appropriate class to deserialize the bytes within
+ * an instance of this class.
+ * @group Implementation
+ * @category BCS
+ */
+export class EntryFunctionBytes extends Serializable {
+    value;
+    /**
+     * Creates an instance of the class with a specified hexadecimal input value.
+     *
+     * @param value - The hexadecimal input to be converted into FixedBytes.
+     * @group Implementation
+     * @category BCS
+     */
+    constructor(value) {
+        super();
+        this.value = new FixedBytes(value);
+    }
+    // Note that to see the Move, BCS-serialized representation of the underlying fixed byte vector,
+    // we must not serialize the length prefix.
+    //
+    // In other words, this class is only used to represent a sequence of bytes that are already
+    // BCS-serialized as a type. To represent those bytes accurately, the BCS-serialized form is the same exact
+    // representation.
+    /**
+     * Serializes the value using the provided serializer.
+     * This function is essential for accurately representing a sequence of bytes that are already BCS-serialized as a type.
+     *
+     * Note that to see the Move, BCS-serialized representation of the underlying fixed byte vector,
+     * we must not serialize the length prefix.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
+     */
+    serialize(serializer) {
+        serializer.serialize(this.value);
+    }
+    // When we serialize these bytes as an entry function argument, we need to
+    // serialize the length prefix. This essentially converts the underlying fixed byte vector to a type-agnostic
+    // byte vector to an `any` type.
+    // NOTE: This, and the lack of a `serializeForScriptFunction`, is the only meaningful difference between this
+    // class and FixedBytes.
+    /**
+     * Serializes the current instance for use as an entry function argument by converting the underlying fixed byte vector to a
+     * type-agnostic byte vector.
+     * This process includes serializing the length prefix of the byte vector.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
+     */
+    serializeForEntryFunction(serializer) {
+        serializer.serializeU32AsUleb128(this.value.value.length);
+        serializer.serialize(this);
+    }
+    /**
+     * The only way to create an instance of this class is to use this static method.
+     * This function should only be used when deserializing a sequence of EntryFunctionPayload arguments.
+     * @param deserializer - The deserializer instance with the buffered bytes.
+     * @param length - The length of the bytes to deserialize.
+     * @returns An instance of this class, which will now only be usable as an EntryFunctionArgument.
+     * @group Implementation
+     * @category BCS
+     */
+    static deserialize(deserializer, length) {
+        const fixedBytes = FixedBytes.deserialize(deserializer, length);
+        return new EntryFunctionBytes(fixedBytes.value);
+    }
+}
+//# sourceMappingURL=entryFunctionBytes.js.map

package/dist/bcs/serializable/entryFunctionBytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entryFunctionBytes.js","sourceRoot":"","sources":["../../../src/bcs/serializable/entryFunctionBytes.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAc,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAI7C;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAClC,KAAK,CAAa;IAElC;;;;;;OAMG;IACH,YAAoB,KAAe;QACjC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,gGAAgG;IAChG,2CAA2C;IAC3C,EAAE;IACF,4FAA4F;IAC5F,2GAA2G;IAC3G,kBAAkB;IAElB;;;;;;;;;;OAUG;IACH,SAAS,CAAC,UAAsB;QAC9B,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,0EAA0E;IAC1E,6GAA6G;IAC7G,gCAAgC;IAChC,6GAA6G;IAC7G,wBAAwB;IAExB;;;;;;;;OAQG;IACH,yBAAyB,CAAC,UAAsB;QAC9C,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1D,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B,EAAE,MAAc;QAC3D,MAAM,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAChE,OAAO,IAAI,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;CACF"}