@aptos-labs/ts-sdk 1.33.0 → 1.33.2-sc.0

package/dist/esm/bcs/deserializer.d.mts

@@ -1,8 +1,9 @@
-import { Uint8, Uint16, Uint32, Uint64, Uint128, Uint256 } from '../types/types.mjs';
+import { HexInput, Uint8, Uint16, Uint32, Uint64, Uint128, Uint256 } from '../types/types.mjs';
 import '../types/indexer.mjs';
 import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 import '../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 
 /**
  * This interface exists to define Deserializable<T> inputs for functions that
@@ -11,6 +12,8 @@ import '../utils/apiEndpoints.mjs';
  * for static methods in interfaces.
  *
  * @template T - The type that this will deserialize into.
+ * @group Implementation
+ * @category BCS
  */
 interface Deserializable<T> {
     /**
@@ -27,12 +30,16 @@ interface Deserializable<T> {
      * // value is now an instance of MyClass
      * // equivalent to `const value = MyClass.deserialize(deserializer)`
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserialize(deserializer: Deserializer): T;
 }
 /**
  * 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
  */
 declare class Deserializer {
     private buffer;
@@ -42,13 +49,18 @@ declare class Deserializer {
      * 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: Uint8Array);
+    static fromHex(hex: HexInput): Deserializer;
     /**
      * Reads a specified number of bytes from the buffer and advances the offset.
      *
      * @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
      */
     private read;
     /**
@@ -57,10 +69,11 @@ declare class Deserializer {
      * 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(): number;
     /**
-     * @deprecated use `deserializeOption` instead.
      * 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.
      *
@@ -72,8 +85,24 @@ declare class Deserializer {
      * const deserializer = new Deserializer(new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
      * assert(deserializer.deserializeStr() === "1234abcd");
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserializeStr(): string;
+    /**
+     * @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(): string | undefined;
     /**
      * Deserializes an optional value from the buffer.
      *
@@ -109,6 +138,8 @@ declare class Deserializer {
      * const optBytes = deserializer.deserializeOption("fixedBytes", 4);
      * // optBytes === Uint8Array[1, 2, 3, 4]
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserializeOption(type: "string"): string | undefined;
     deserializeOption(type: "bytes"): Uint8Array | undefined;
@@ -121,12 +152,16 @@ declare class Deserializer {
      * encoded as a uleb128 integer, indicating the length of the bytes array.
      *
      * @returns {Uint8Array} The deserialized array of bytes.
+     * @group Implementation
+     * @category BCS
      */
     deserializeBytes(): Uint8Array;
     /**
      * Deserializes an array of bytes of a specified length.
      *
      * @param len - The number of bytes to read from the source.
+     * @group Implementation
+     * @category BCS
      */
     deserializeFixedBytes(len: number): Uint8Array;
     /**
@@ -137,6 +172,8 @@ declare class Deserializer {
      *
      * @returns The deserialized boolean value.
      * @throws Throws an error if the boolean value is invalid.
+     * @group Implementation
+     * @category BCS
      */
     deserializeBool(): boolean;
     /**
@@ -145,6 +182,8 @@ declare class Deserializer {
      * BCS layout for "uint8": One byte. Binary format in little-endian representation.
      *
      * @returns {number} The deserialized uint8 number.
+     * @group Implementation
+     * @category BCS
      */
     deserializeU8(): Uint8;
     /**
@@ -156,6 +195,8 @@ declare class Deserializer {
      * const deserializer = new Deserializer(new Uint8Array([0x34, 0x12]));
      * assert(deserializer.deserializeU16() === 4660);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserializeU16(): Uint16;
     /**
@@ -167,6 +208,8 @@ declare class Deserializer {
      * const deserializer = new Deserializer(new Uint8Array([0x78, 0x56, 0x34, 0x12]));
      * assert(deserializer.deserializeU32() === 305419896);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserializeU32(): Uint32;
     /**
@@ -178,6 +221,8 @@ declare class Deserializer {
      * const deserializer = new Deserializer(new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
      * assert(deserializer.deserializeU64() === 1311768467750121216);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     deserializeU64(): Uint64;
     /**
@@ -185,6 +230,8 @@ declare class Deserializer {
      * 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(): Uint128;
     /**
@@ -193,6 +240,8 @@ declare class Deserializer {
      * 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(): Uint256;
     /**
@@ -202,6 +251,8 @@ declare class Deserializer {
      *
      * @throws {Error} Throws an error if the parsed value exceeds the maximum uint32 number.
      * @returns {number} The deserialized uint32 value.
+     * @group Implementation
+     * @category BCS
      */
     deserializeUleb128AsU32(): Uint32;
     /**
@@ -216,6 +267,8 @@ declare class 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<T>(cls: Deserializable<T>): T;
     /**
@@ -239,6 +292,8 @@ declare class Deserializer {
      * const deserializer = new Deserializer(serializedBytes);
      * const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
      * // deserializedAddresses is now an array of AccountAddress instances
+     * @group Implementation
+     * @category BCS
      */
     deserializeVector<T>(cls: Deserializable<T>): Array<T>;
 }

package/dist/esm/bcs/deserializer.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-D52UKPQF.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Deserializer};
+import{a}from"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Deserializer};
 //# sourceMappingURL=deserializer.mjs.map

package/dist/esm/bcs/index.d.mts

@@ -9,6 +9,7 @@ import '../types/indexer.mjs';
 import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 import '../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 import '../core/hex.mjs';
 import '../core/common.mjs';
 import '../transactions/instances/transactionArgument.mjs';

package/dist/esm/bcs/index.mjs

@@ -1,2 +1,2 @@
-import"../chunk-FZY4PMEE.mjs";import{a as h}from"../chunk-ZMBXHMVQ.mjs";import{a as g}from"../chunk-BRV3RLKW.mjs";import{a as p,b as q,c as r,d as s}from"../chunk-Q3CWUEXI.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o}from"../chunk-42H7WETG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-U2PRGW4O.mjs";import{a}from"../chunk-D52UKPQF.mjs";import{a as b,b as c,c as d,d as e,e as f}from"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{i as Bool,a as Deserializer,h as EntryFunctionBytes,g as FixedBytes,s as MoveOption,r as MoveString,p as MoveVector,b as Serializable,q as Serialized,c as Serializer,n as U128,k as U16,o as U256,l as U32,m as U64,j as U8,d as ensureBoolean,e as outOfRangeErrorMessage,f as validateNumberInRange};
+import"../chunk-FZY4PMEE.mjs";import{a as h}from"../chunk-TOBQ5UE6.mjs";import{a as g}from"../chunk-MT2RJ7H3.mjs";import{a as p,b as q,c as r,d as s}from"../chunk-N4VVDQA5.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o}from"../chunk-ORMOQWWH.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import{a}from"../chunk-XTOIL6MB.mjs";import{a as b,b as c,c as d,d as e,e as f}from"../chunk-EBMEXURY.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{i as Bool,a as Deserializer,h as EntryFunctionBytes,g as FixedBytes,s as MoveOption,r as MoveString,p as MoveVector,b as Serializable,q as Serialized,c as Serializer,n as U128,k as U16,o as U256,l as U32,m as U64,j as U8,d as ensureBoolean,e as outOfRangeErrorMessage,f as validateNumberInRange};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/bcs/serializable/entryFunctionBytes.d.mts

@@ -9,6 +9,7 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 
 /**
  * This class exists solely to represent a sequence of fixed bytes as a serialized entry function, because
@@ -19,6 +20,8 @@ import '../../utils/apiEndpoints.mjs';
  * 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
  */
 declare class EntryFunctionBytes extends Serializable implements EntryFunctionArgument {
     readonly value: FixedBytes;
@@ -26,6 +29,8 @@ declare class EntryFunctionBytes extends Serializable implements EntryFunctionAr
      * 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();
     /**
@@ -36,6 +41,8 @@ declare class EntryFunctionBytes extends Serializable implements EntryFunctionAr
      * 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;
     /**
@@ -44,6 +51,8 @@ declare class EntryFunctionBytes extends Serializable implements EntryFunctionAr
      * 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;
     /**
@@ -52,6 +61,8 @@ declare class EntryFunctionBytes extends Serializable implements EntryFunctionAr
      * @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;
 }

package/dist/esm/bcs/serializable/entryFunctionBytes.mjs

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-ZMBXHMVQ.mjs";import"../../chunk-BRV3RLKW.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as EntryFunctionBytes};
+import{a}from"../../chunk-TOBQ5UE6.mjs";import"../../chunk-MT2RJ7H3.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as EntryFunctionBytes};
 //# sourceMappingURL=entryFunctionBytes.mjs.map

package/dist/esm/bcs/serializable/fixedBytes.d.mts

@@ -8,6 +8,7 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 
 /**
  * Represents a contiguous sequence of already serialized BCS bytes.
@@ -38,6 +39,8 @@ import '../../utils/apiEndpoints.mjs';
  * @param value - HexInput representing a sequence of Uint8 bytes.
  * @returns A Serializable FixedBytes instance, which when serialized, does not prepend the length of the bytes.
  * @see EntryFunctionBytes
+ * @group Implementation
+ * @category BCS
  */
 declare class FixedBytes extends Serializable implements TransactionArgument {
     value: Uint8Array;
@@ -46,6 +49,8 @@ declare class FixedBytes extends Serializable implements TransactionArgument {
      * The value is converted from hexadecimal format to a Uint8Array.
      *
      * @param value - The hexadecimal input to be converted.
+     * @group Implementation
+     * @category BCS
      */
     constructor(value: HexInput);
     /**
@@ -53,6 +58,8 @@ declare class FixedBytes extends Serializable implements TransactionArgument {
      * This function is essential for converting the fixed bytes into a format suitable for storage or transmission.
      *
      * @param serializer - The serializer instance used for serialization.
+     * @group Implementation
+     * @category BCS
      */
     serialize(serializer: Serializer): void;
     /**
@@ -60,6 +67,8 @@ declare class FixedBytes extends Serializable implements TransactionArgument {
      * This allows the instance to be converted into a format suitable for transmission or storage.
      *
      * @param serializer - The serializer used to perform the serialization.
+     * @group Implementation
+     * @category BCS
      */
     serializeForEntryFunction(serializer: Serializer): void;
     /**
@@ -67,6 +76,8 @@ declare class FixedBytes extends Serializable implements TransactionArgument {
      * This function is essential for preparing data to be passed as arguments in script functions.
      *
      * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
      */
     serializeForScriptFunction(serializer: Serializer): void;
     /**
@@ -75,6 +86,8 @@ declare class FixedBytes extends Serializable implements TransactionArgument {
      *
      * @param deserializer - The deserializer instance used to read the byte data.
      * @param length - The length of the byte array to be deserialized.
+     * @group Implementation
+     * @category BCS
      */
     static deserialize(deserializer: Deserializer, length: number): FixedBytes;
 }

package/dist/esm/bcs/serializable/fixedBytes.mjs

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-BRV3RLKW.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as FixedBytes};
+import{a}from"../../chunk-MT2RJ7H3.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as FixedBytes};
 //# sourceMappingURL=fixedBytes.mjs.map

package/dist/esm/bcs/serializable/movePrimitives.d.mts

@@ -6,6 +6,7 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 import '../../core/hex.mjs';
 import '../../core/common.mjs';
 
@@ -15,6 +16,8 @@ import '../../core/common.mjs';
  * the boolean value for different contexts, such as entry functions and script functions.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class Bool extends Serializable implements TransactionArgument {
     readonly value: boolean;
@@ -23,6 +26,8 @@ declare class Bool extends Serializable implements TransactionArgument {
      * This ensures that the value is validated to be within the acceptable range.
      *
      * @param value - The number to be validated and assigned, which must be between 0 and MAX_U256_BIG_INT.
+     * @group Implementation
+     * @category BCS
      */
     constructor(value: boolean);
     /**
@@ -30,6 +35,8 @@ declare class Bool extends Serializable implements TransactionArgument {
      * This function is essential for converting the value into a format suitable for transmission or storage.
      *
      * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category BCS
      */
     serialize(serializer: Serializer): void;
     /**
@@ -37,6 +44,8 @@ declare class Bool extends Serializable implements TransactionArgument {
      * This allows the instance to be properly formatted for serialization in transactions.
      *
      * @param serializer - The serializer instance used to serialize the byte sequence.
+     * @group Implementation
+     * @category BCS
      */
     serializeForEntryFunction(serializer: Serializer): void;
     /**
@@ -44,12 +53,16 @@ declare class Bool extends Serializable implements TransactionArgument {
      * This allows for the conversion of the instance into a format suitable for transmission or storage.
      *
      * @param serializer - The serializer used to perform the serialization.
+     * @group Implementation
+     * @category BCS
      */
     serializeForScriptFunction(serializer: Serializer): void;
     /**
      * Deserializes a U256 value from the provided deserializer.
      *
      * @param deserializer - The deserializer instance used to read the U256 data.
+     * @group Implementation
+     * @category BCS
      */
     deserialize(deserializer: Deserializer): U256;
     static deserialize(deserializer: Deserializer): Bool;
@@ -59,6 +72,8 @@ declare class Bool extends Serializable implements TransactionArgument {
  * This class extends the Serializable class and provides methods for serialization and deserialization of U8 values.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U8 extends Serializable implements TransactionArgument {
     readonly value: Uint8;
@@ -74,6 +89,8 @@ declare class U8 extends Serializable implements TransactionArgument {
  * and deserialization of the U16 value.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U16 extends Serializable implements TransactionArgument {
     readonly value: Uint16;
@@ -88,6 +105,8 @@ declare class U16 extends Serializable implements TransactionArgument {
  * This class ensures that the value is within the valid range for a U32.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U32 extends Serializable implements TransactionArgument {
     readonly value: Uint32;
@@ -105,6 +124,8 @@ declare class U32 extends Serializable implements TransactionArgument {
  * and script functions.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U64 extends Serializable implements TransactionArgument {
     readonly value: bigint;
@@ -120,6 +141,8 @@ declare class U64 extends Serializable implements TransactionArgument {
  * of U128 values, ensuring that the values are within the valid range.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U128 extends Serializable implements TransactionArgument {
     readonly value: bigint;
@@ -135,6 +158,8 @@ declare class U128 extends Serializable implements TransactionArgument {
  * ensuring that the values are within the valid range.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class U256 extends Serializable implements TransactionArgument {
     readonly value: bigint;

package/dist/esm/bcs/serializable/movePrimitives.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g}from"../../chunk-42H7WETG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as Bool,f as U128,c as U16,g as U256,d as U32,e as U64,b as U8};
+import{a,b,c,d,e,f,g}from"../../chunk-ORMOQWWH.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as Bool,f as U128,c as U16,g as U256,d as U32,e as U64,b as U8};
 //# sourceMappingURL=movePrimitives.mjs.map