@aptos-labs/ts-sdk 2.0.1 → 3.1.0

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

@@ -1,435 +1,7 @@
-import { U8, U16, U32, U64, U128, U256, Bool } from './movePrimitives.mjs';
-import { Serializable, Serializer } from '../serializer.mjs';
-import { Deserializer, Deserializable } from '../deserializer.mjs';
-import { HexInput, AnyNumber } from '../../types/types.mjs';
-import { EntryFunctionArgument, TransactionArgument } from '../../transactions/instances/transactionArgument.mjs';
+export { k as MoveOption, j as MoveString, M as MoveVector, i as Serialized } from '../../account--Q9z_xMN.mjs';
 import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
-import '../../core/hex.mjs';
+import '../../utils/const.mjs';
 import '../../core/common.mjs';
-
-/**
- * This class is the Aptos Typescript SDK representation of a Move `vector<T>`,
- * where `T` represents either a primitive type (`bool`, `u8`, `u64`, ...)
- * or a BCS-serializable struct itself.
- *
- * It is a BCS-serializable, array-like type that contains an array of values of type `T`,
- * where `T` is a class that implements `Serializable`.
- *
- * The purpose of this class is to facilitate easy construction of BCS-serializable
- * Move `vector<T>` types.
- *
- * @example
- * // in Move: `vector<u8> [1, 2, 3, 4];`
- * const vecOfU8s = new MoveVector<U8>([new U8(1), new U8(2), new U8(3), new U8(4)]);
- * // in Move: `std::bcs::to_bytes(vector<u8> [1, 2, 3, 4]);`
- * const bcsBytes = vecOfU8s.toUint8Array();
- *
- * // vector<vector<u8>> [ vector<u8> [1], vector<u8> [1, 2, 3, 4], vector<u8> [5, 6, 7, 8] ];
- * const vecOfVecs = new MoveVector<MoveVector<U8>>([
- *   new MoveVector<U8>([new U8(1)]),
- *   MoveVector.U8([1, 2, 3, 4]),
- *   MoveVector.U8([5, 6, 7, 8]),
- * ]);
- *
- * // vector<Option<u8>> [ std::option::some<u8>(1), std::option::some<u8>(2) ];
- * const vecOfOptionU8s = new MoveVector<MoveOption<U8>>([
- *    MoveOption.U8(1),
- *    MoveOption.U8(2),
- * ]);
- *
- * // vector<MoveString> [ std::string::utf8(b"hello"), std::string::utf8(b"world") ];
- * const vecOfStrings = new MoveVector([new MoveString("hello"), new MoveString("world")]);
- * const vecOfStrings2 = MoveVector.MoveString(["hello", "world"]);
- *
- * @param values an Array<T> of values where T is a class that implements Serializable
- * @returns a `MoveVector<T>` with the values `values`
- * @group Implementation
- * @category BCS
- */
-declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends Serializable implements TransactionArgument {
-    values: Array<T>;
-    /**
-     * Initializes a new instance of the class with an optional value.
-     * This constructor sets up the internal vector based on the provided value.
-     *
-     * @param values - The initial value to be stored in the vector, or null to initialize an empty vector.
-     * @group Implementation
-     * @category BCS
-     */
-    constructor(values: Array<T>);
-    /**
-     * Serializes the current instance into a byte sequence suitable for entry functions.
-     * This allows the data to be properly formatted for transmission or storage.
-     *
-     * @param serializer - The serializer instance used to serialize the byte sequence.
-     * @group Implementation
-     * @category BCS
-     */
-    serializeForEntryFunction(serializer: Serializer): void;
-    /**
-     * NOTE: This function will only work when the inner values in the `MoveVector` are `U8`s.
-     * @param serializer
-     * @group Implementation
-     * @category BCS
-     */
-    /**
-     * Serialize the string as a fixed byte string without the length prefix for use in a script function.
-     * @param serializer - The serializer used to convert the byte vector into a format suitable for a script function.
-     * @group Implementation
-     * @category BCS
-     */
-    serializeForScriptFunction(serializer: Serializer): void;
-    /**
-     * Factory method to generate a MoveVector<U8> from a `number` or `undefined`.
-     *
-     * This method allows you to create a MoveVector that encapsulates a U8 value, enabling you to handle optional U8 values
-     * effectively.
-     *
-     * @param values - The values used to fill the MoveVector. If `values` is undefined or null, the resulting MoveVector's
-     * `.isSome()` method will return false.
-     * @returns A MoveVector<U8> with an inner value `value`.
-     *
-     * @example
-     * ```typescript
-     * const v = MoveVector.U8([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-     */
-    static U8(values: Array<number> | HexInput): MoveVector<U8>;
-    /**
-     * Factory method to generate a MoveOption<U16> from a `number` or `null`.
-     *
-     * This method allows you to create a MoveVector that can either hold a U16 value or be empty.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is null or undefined, the resulting MoveVector's
-     * `.isSome()` method will return false.
-     * @returns A MoveVector<U16> with an inner value `value`.
-     * @example
-     * ```typescript
-     * const v = MoveVector.U16([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-  
-     */
-    static U16(values: Array<number>): MoveVector<U16>;
-    /**
-     * Factory method to generate a MoveVector<U32> from a `number` or `null`.
-     *
-     * This method allows you to create a MoveVector that can either hold a U32 value or be empty.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is null or undefined,
-     * the resulting MoveVector's .isSome() method will return false.
-     * @returns A MoveVector<U32> with an inner value `value`.
-     *
-     * @example
-     * ```
-     * const v = MoveVector.U32([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-  
-     */
-    static U32(values: Array<number>): MoveVector<U32>;
-    /**
-     * Factory method to generate a MoveVector<U64> from a number, bigint, or null/undefined.
-     * This allows for the creation of an optional U64 value that can be checked for presence.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is undefined or null, the resulting MoveVector's
-     * `.isSome()` method will return false.
-     * @returns A MoveVector<U64> with an inner value `value`.
-     *
-     * @example
-     * ```typescript
-     * const v = MoveVector.U64([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-     */
-    static U64(values: Array<AnyNumber>): MoveVector<U64>;
-    /**
-     * Factory method to generate a MoveVector<U128> from a number, bigint, or undefined.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is undefined, the resulting MoveVector's `.isSome()`
-     * method will return false.
-     * @returns A MoveVector<U128> with an inner value `value`.
-     *
-     * @example
-     * ```typescript
-     * const v = MoveVector.U128([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-     */
-    static U128(values: Array<AnyNumber>): MoveVector<U128>;
-    /**
-     * Factory method to generate a MoveVector<U256> from a number, bigint, or null/undefined.
-     * This allows for the creation of an optional U256 value, enabling checks for presence or absence of a value.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is undefined or null,
-     *                the resulting MoveVector's .isSome() method will return false.
-     * @returns A MoveVector<U256> with an inner value `value`.
-     *
-     * @example
-     * ```typescript
-     * const v = MoveVector.U256([1, 2, 3, 4]);
-     * ```
-     * @group Implementation
-     * @category BCS
-     */
-    static U256(values: Array<AnyNumber>): MoveVector<U256>;
-    /**
-     * Factory method to generate a MoveVector<Bool> from a `boolean` or `undefined`.
-     * This method allows you to create an optional boolean value that can be used in various contexts where a boolean may or may
-     * not be present.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is undefined, the resulting MoveVector's .isSome() method
-     * will return false.
-     * @returns A MoveVector<Bool> with an inner value `value`.
-     *
-     * @example
-     *    * const v = MoveVector.Bool([true, false, true, false]);
-     * @group Implementation
-     * @category BCS
-     */
-    static Bool(values: Array<boolean>): MoveVector<Bool>;
-    /**
-     * Factory method to generate a MoveVector<MoveString> from a `string` or `undefined`.
-     * This function creates a MoveVector that encapsulates a MoveString if the provided value is not null or undefined.
-     *
-     * @param values - The value used to fill the MoveVector. If `value` is undefined, the resulting MoveVector's .isSome() method
-     * will return false.
-     * @returns A MoveVector<MoveString> with an inner value `value`.
-     *
-     * @example
-     * const v = MoveVector.MoveString(["hello", "world"]);
-     * @group Implementation
-     * @category BCS
-     */
-    static MoveString(values: Array<string>): MoveVector<MoveString>;
-    /**
-     * Serializes the current object using the provided serializer.
-     * This function will serialize the value if it is present.
-     *
-     * @param serializer - The serializer instance used to perform the serialization.
-     * @group Implementation
-     * @category BCS
-     */
-    serialize(serializer: Serializer): void;
-    /**
-     * Deserialize a MoveVector of type T, specifically where T is a Serializable and Deserializable type.
-     *
-     * NOTE: This only works with a depth of one. Generics will not work.
-     *
-     * NOTE: This will not work with types that aren't of the Serializable class.
-     *
-     * If you're looking for a more flexible deserialization function, you can use the deserializeVector function
-     * in the Deserializer class.
-     *
-     * @example
-     * const vec = MoveVector.deserialize(deserializer, U64);
-     * @param deserializer the Deserializer instance to use, with bytes loaded into it already.
-     * @param cls the class to typecast the input values to, must be a Serializable and Deserializable type.
-     * @returns a MoveVector of the corresponding class T
-     *
-     * @group Implementation
-     * @category BCS
-     */
-    static deserialize<T extends Serializable & EntryFunctionArgument>(deserializer: Deserializer, cls: Deserializable<T>): MoveVector<T>;
-}
-/**
- * Represents a serialized data structure that encapsulates a byte array.
- * This class extends the Serializable class and provides methods for serialization
- * and deserialization of byte data, as well as converting to a MoveVector.
- *
- * @extends Serializable
- * @group Implementation
- * @category BCS
- */
-declare class Serialized extends Serializable implements TransactionArgument {
-    readonly value: Uint8Array;
-    constructor(value: HexInput);
-    serialize(serializer: Serializer): void;
-    serializeForEntryFunction(serializer: Serializer): void;
-    serializeForScriptFunction(serializer: Serializer): void;
-    static deserialize(deserializer: Deserializer): Serialized;
-    /**
-     * Deserialize the bytecode into a MoveVector of the specified type.
-     * This function allows you to convert serialized data into a usable MoveVector format.
-     *
-     * @param cls - The class type of the elements in the MoveVector.
-     * @group Implementation
-     * @category BCS
-     */
-    toMoveVector<T extends Serializable & EntryFunctionArgument>(cls: Deserializable<T>): MoveVector<T>;
-}
-/**
- * Represents a string value that can be serialized and deserialized.
- * This class extends the Serializable base class and provides methods
- * for serializing the string in different contexts, such as for entry
- * functions and script functions.
- *
- * @extends Serializable
- * @group Implementation
- * @category BCS
- */
-declare class MoveString extends Serializable implements TransactionArgument {
-    value: string;
-    constructor(value: string);
-    serialize(serializer: Serializer): void;
-    serializeForEntryFunction(serializer: Serializer): void;
-    serializeForScriptFunction(serializer: Serializer): void;
-    static deserialize(deserializer: Deserializer): MoveString;
-}
-declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends Serializable implements EntryFunctionArgument {
-    private vec;
-    readonly value?: T;
-    constructor(value?: T | null);
-    serializeForEntryFunction(serializer: Serializer): void;
-    /**
-     * Retrieves the inner value of the MoveOption.
-     *
-     * This method is inspired by Rust's `Option<T>.unwrap()`, where attempting to unwrap a `None` value results in a panic.
-     * This method will throw an error if the value is not present.
-     *
-     * @example
-     * const option = new MoveOption<Bool>(new Bool(true));
-     * const value = option.unwrap();  // Returns the Bool instance
-     *
-     * @throws {Error} Throws an error if the MoveOption does not contain a value.
-     *
-     * @returns {T} The contained value if present.
-     * @group Implementation
-     * @category BCS
-     */
-    unwrap(): T;
-    /**
-     * Check if the MoveOption has a value.
-     *
-     * @returns {boolean} Returns true if there is exactly one value in the MoveOption.
-     * @group Implementation
-     * @category BCS
-     */
-    isSome(): boolean;
-    serialize(serializer: Serializer): void;
-    /**
-     * Factory method to generate a MoveOption<U8> from a `number` or `undefined`.
-     *
-     * @example
-     * MoveOption.U8(1).isSome() === true;
-     * MoveOption.U8().isSome() === false;
-     * MoveOption.U8(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U8> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U8(value?: number | null): MoveOption<U8>;
-    /**
-     * Factory method to generate a MoveOption<U16> from a `number` or `undefined`.
-     *
-     * @example
-     * MoveOption.U16(1).isSome() === true;
-     * MoveOption.U16().isSome() === false;
-     * MoveOption.U16(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U16> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U16(value?: number | null): MoveOption<U16>;
-    /**
-     * Factory method to generate a MoveOption<U32> from a `number` or `undefined`.
-     *
-     * @example
-     * MoveOption.U32(1).isSome() === true;
-     * MoveOption.U32().isSome() === false;
-     * MoveOption.U32(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U32> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U32(value?: number | null): MoveOption<U32>;
-    /**
-     * Factory method to generate a MoveOption<U64> from a `number` or a `bigint` or `undefined`.
-     *
-     * @example
-     * MoveOption.U64(1).isSome() === true;
-     * MoveOption.U64().isSome() === false;
-     * MoveOption.U64(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U64> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U64(value?: AnyNumber | null): MoveOption<U64>;
-    /**
-     * Factory method to generate a MoveOption<U128> from a `number` or a `bigint` or `undefined`.
-     *
-     * @example
-     * MoveOption.U128(1).isSome() === true;
-     * MoveOption.U128().isSome() === false;
-     * MoveOption.U128(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U128> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U128(value?: AnyNumber | null): MoveOption<U128>;
-    /**
-     * Factory method to generate a MoveOption<U256> from a `number` or a `bigint` or `undefined`.
-     *
-     * @example
-     * MoveOption.U256(1).isSome() === true;
-     * MoveOption.U256().isSome() === false;
-     * MoveOption.U256(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<U256> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static U256(value?: AnyNumber | null): MoveOption<U256>;
-    /**
-     * Factory method to generate a MoveOption<Bool> from a `boolean` or `undefined`.
-     *
-     * @example
-     * MoveOption.Bool(true).isSome() === true;
-     * MoveOption.Bool().isSome() === false;
-     * MoveOption.Bool(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<Bool> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static Bool(value?: boolean | null): MoveOption<Bool>;
-    /**
-     * Factory method to generate a MoveOption<MoveString> from a `string` or `undefined`.
-     *
-     * @example
-     * MoveOption.MoveString("hello").isSome() === true;
-     * MoveOption.MoveString("").isSome() === true;
-     * MoveOption.MoveString().isSome() === false;
-     * MoveOption.MoveString(undefined).isSome() === false;
-     * @param value the value used to fill the MoveOption. If `value` is undefined
-     * the resulting MoveOption's .isSome() method will return false.
-     * @returns a MoveOption<MoveString> with an inner value `value`
-     * @group Implementation
-     * @category BCS
-     */
-    static MoveString(value?: string | null): MoveOption<MoveString>;
-    static deserialize<U extends Serializable & EntryFunctionArgument>(deserializer: Deserializer, cls: Deserializable<U>): MoveOption<U>;
-}
-
-export { MoveOption, MoveString, MoveVector, Serialized };

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

@@ -1,2 +1,2 @@
-import{a,b,c,d}from"../../chunk-Q4W3WJ2U.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-FLZPUYXQ.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-ODAAZLPK.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{d as MoveOption,c as MoveString,a as MoveVector,b as Serialized};
+import{a,b,c,d}from"../../chunk-2BOHKN33.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-IJE2LVZG.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-FLZPUYXQ.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{d as MoveOption,c as MoveString,a as MoveVector,b as Serialized};
 //# sourceMappingURL=moveStructs.mjs.map