@aptos-labs/ts-sdk 1.33.1 → 1.33.2

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

@@ -15,6 +15,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 +25,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 +34,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 +43,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 +52,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 +71,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 +88,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 +104,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 +123,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 +140,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 +157,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-FD6FGKYY.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

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

@@ -46,6 +46,8 @@ import '../../core/common.mjs';
  *
  * @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>;
@@ -54,6 +56,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * 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>);
     /**
@@ -61,15 +65,21 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * 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;
     /**
@@ -86,6 +96,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```typescript
      * const v = MoveVector.U8([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     static U8(values: Array<number> | HexInput): MoveVector<U8>;
     /**
@@ -100,6 +112,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```typescript
      * const v = MoveVector.U16([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
   
      */
     static U16(values: Array<number>): MoveVector<U16>;
@@ -116,6 +130,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```
      * const v = MoveVector.U32([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
   
      */
     static U32(values: Array<number>): MoveVector<U32>;
@@ -131,6 +147,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```typescript
      * const v = MoveVector.U64([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     static U64(values: Array<AnyNumber>): MoveVector<U64>;
     /**
@@ -144,6 +162,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```typescript
      * const v = MoveVector.U128([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     static U128(values: Array<AnyNumber>): MoveVector<U128>;
     /**
@@ -158,6 +178,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * ```typescript
      * const v = MoveVector.U256([1, 2, 3, 4]);
      * ```
+     * @group Implementation
+     * @category BCS
      */
     static U256(values: Array<AnyNumber>): MoveVector<U256>;
     /**
@@ -171,6 +193,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      *
      * @example
      *    * const v = MoveVector.Bool([true, false, true, false]);
+     * @group Implementation
+     * @category BCS
      */
     static Bool(values: Array<boolean>): MoveVector<Bool>;
     /**
@@ -183,6 +207,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      *
      * @example
      * const v = MoveVector.MoveString(["hello", "world"]);
+     * @group Implementation
+     * @category BCS
      */
     static MoveString(values: Array<string>): MoveVector<MoveString>;
     /**
@@ -190,6 +216,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * 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;
     /**
@@ -208,6 +236,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
 }
@@ -217,6 +247,8 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
  * 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;
@@ -230,6 +262,8 @@ declare class Serialized extends Serializable implements TransactionArgument {
      * 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>;
 }
@@ -240,6 +274,8 @@ declare class Serialized extends Serializable implements TransactionArgument {
  * functions and script functions.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category BCS
  */
 declare class MoveString extends Serializable implements TransactionArgument {
     value: string;
@@ -267,12 +303,16 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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;
@@ -286,6 +326,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -298,6 +340,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -310,6 +354,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -322,6 +368,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -334,6 +382,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -346,6 +396,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -358,6 +410,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;
     /**
@@ -371,6 +425,8 @@ declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends
      * @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>;

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

@@ -1,2 +1,2 @@
-import{a,b,c,d}from"../../chunk-ZMMLM6ZJ.mjs";import"../../chunk-42H7WETG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-J3E4UMBB.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.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-IDTLNF4M.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-XTOIL6MB.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

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

@@ -10,6 +10,8 @@ import '../utils/apiEndpoints.mjs';
  * This class serves as a base class for all serializable types. It facilitates
  * composable serialization of complex types and enables the serialization of
  * instances to their BCS (Binary Canonical Serialization) representation.
+ * @group Implementation
+ * @category BCS
  */
 declare abstract class Serializable {
     abstract serialize(serializer: Serializer): void;
@@ -17,12 +19,16 @@ declare abstract class Serializable {
      * Serializes a `Serializable` value to its BCS representation.
      * This function is the TypeScript SDK equivalent of `bcs::to_bytes` in Move.
      * @returns the BCS representation of the Serializable instance as a byte buffer.
+     * @group Implementation
+     * @category BCS
      */
     bcsToBytes(): Uint8Array;
     /**
      * Converts the BCS-serialized bytes of a value into a Hex instance.
      * This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.
      * @returns A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
+     * @group Implementation
+     * @category BCS
      */
     bcsToHex(): Hex;
     /**
@@ -41,6 +47,8 @@ declare abstract class Serializable {
  * It provides methods to serialize strings, bytes, numbers, and other serializable objects
  * using the Binary Coded Serialization (BCS) layout. The serialized data can be retrieved as a
  * Uint8Array.
+ * @group Implementation
+ * @category BCS
  */
 declare class Serializer {
     private buffer;
@@ -50,6 +58,8 @@ declare class Serializer {
      * The `length` must be greater than 0.
      *
      * @param length - The size of the buffer in bytes.
+     * @group Implementation
+     * @category BCS
      */
     constructor(length?: number);
     /**
@@ -57,12 +67,16 @@ declare class Serializer {
      * This function dynamically resizes the buffer if the current size is insufficient.
      *
      * @param bytes - The number of bytes to ensure the buffer can handle.
+     * @group Implementation
+     * @category BCS
      */
     private ensureBufferWillHandleSize;
     /**
      * Appends the specified values to the buffer, ensuring that the buffer can accommodate the new data.
      *
      * @param {Uint8Array} values - The values to be appended to the buffer.
+     * @group Implementation
+     * @category BCS
      */
     protected appendToBuffer(values: Uint8Array): void;
     /**
@@ -72,6 +86,8 @@ declare class Serializer {
      * @param fn.byteOffset - The byte offset at which to write the value.
      * @param fn.value - The numeric value to serialize into the buffer.
      * @param fn.littleEndian - Optional flag indicating whether to use little-endian byte order (defaults to true).
+     * @group Implementation
+     * @category BCS
      */
     private serializeWithFunction;
     /**
@@ -90,6 +106,8 @@ declare class Serializer {
      * serializer.serializeStr("1234abcd");
      * assert(serializer.toUint8Array() === new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
      * ```
+     * @group Implementation
+     * @category BCS
      */
     serializeStr(value: string): void;
     /**
@@ -99,6 +117,8 @@ declare class Serializer {
      * BCS layout for "bytes": bytes_length | bytes
      * where bytes_length is a u32 integer encoded as a uleb128 integer, equal to the length of the bytes array.
      * @param value - The byte array to serialize.
+     * @group Implementation
+     * @category BCS
      */
     serializeBytes(value: Uint8Array): void;
     /**
@@ -107,6 +127,8 @@ declare class Serializer {
      * When deserializing, the number of bytes to deserialize needs to be passed in.
   
      * @param value - The Uint8Array to be serialized.
+     * @group Implementation
+     * @category BCS
      */
     serializeFixedBytes(value: Uint8Array): void;
     /**
@@ -115,6 +137,8 @@ declare class Serializer {
      * The BCS layout for a boolean uses one byte, where "0x01" represents true and "0x00" represents false.
      *
      * @param value - The boolean value to serialize.
+     * @group Implementation
+     * @category BCS
      */
     serializeBool(value: boolean): void;
     /**
@@ -122,11 +146,15 @@ declare class Serializer {
      * BCS layout for "uint8": One byte. Binary format in little-endian representation.
      *
      * @param value - The Uint8 value to serialize.
+     * @group Implementation
+     * @category BCS
      */
     serializeU8(value: Uint8): void;
     /**
      * Serializes a uint16 number.
      *
+     * @group Implementation
+     * @category BCS
   
      */
     /**
@@ -140,6 +168,8 @@ declare class Serializer {
      * serializer.serializeU16(4660);
      * assert(serializer.toUint8Array() === new Uint8Array([0x34, 0x12]));
      * ```
+     * @group Implementation
+     * @category BCS
      */
     serializeU16(value: Uint16): void;
     /**
@@ -152,6 +182,8 @@ declare class Serializer {
      * assert(serializer.toUint8Array() === new Uint8Array([0x78, 0x56, 0x34, 0x12]));
      * ```
      * @param value - The 32-bit unsigned integer value to serialize.
+     * @group Implementation
+     * @category BCS
      */
     serializeU32(value: Uint32): void;
     /**
@@ -165,12 +197,16 @@ declare class Serializer {
      * serializer.serializeU64(1311768467750121216);
      * assert(serializer.toUint8Array() === new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
      * ```
+     * @group Implementation
+     * @category BCS
      */
     serializeU64(value: AnyNumber): void;
     /**
      * Serializes a U128 value into a format suitable for storage or transmission.
      *
      * @param value - The U128 value to serialize, represented as a number.
+     * @group Implementation
+     * @category BCS
      */
     serializeU128(value: AnyNumber): void;
     /**
@@ -178,6 +214,8 @@ declare class Serializer {
      * This function is essential for encoding large numbers in a compact format suitable for transmission or storage.
      *
      * @param value - The U256 value to serialize, represented as an AnyNumber.
+     * @group Implementation
+     * @category BCS
      */
     serializeU256(value: AnyNumber): void;
     /**
@@ -185,6 +223,8 @@ declare class Serializer {
      * BCS uses uleb128 encoding in two cases: (1) lengths of variable-length sequences and (2) tags of enum values
      *
      * @param val - The 32-bit unsigned integer value to be serialized.
+     * @group Implementation
+     * @category BCS
      */
     serializeU32AsUleb128(val: Uint32): void;
     /**
@@ -193,6 +233,8 @@ declare class Serializer {
      * This function allows you to retrieve the byte representation of the buffer up to the current offset.
      *
      * @returns Uint8Array - The byte array representation of the buffer.
+     * @group Implementation
+     * @category BCS
      */
     toUint8Array(): Uint8Array;
     /**
@@ -201,6 +243,8 @@ declare class Serializer {
      * @param value The Serializable value to serialize.
      *
      * @returns the serializer instance
+     * @group Implementation
+     * @category BCS
      */
     serialize<T extends Serializable>(value: T): void;
     /**
@@ -221,6 +265,8 @@ declare class Serializer {
      * // serializedBytes is now the BCS-serialized bytes
      * // The equivalent value in Move would be:
      * // `bcs::to_bytes(&vector<address> [@0x1, @0x2, @0xa, @0xb])`;
+     * @group Implementation
+     * @category BCS
      */
     serializeVector<T extends Serializable>(values: Array<T>): void;
     /**
@@ -239,6 +285,8 @@ declare class Serializer {
      * serializer.serializeOption(new AccountAddress(...));  // Serializes optional Serializable
      * serializer.serializeOption(undefined);  // Serializes none case
      * ```
+     * @group Implementation
+     * @category BCS
      */
     serializeOption<T extends Serializable | string | Uint8Array>(value?: T, len?: number): void;
     /**
@@ -251,10 +299,20 @@ declare class Serializer {
      * BCS layout for undefined: 0
      *
      * @param value - The optional string to serialize. If undefined, it will serialize as 0.
+     * @group Implementation
+     * @category BCS
      */
     serializeOptionStr(value?: string): void;
 }
+/**
+ * @group Implementation
+ * @category BCS
+ */
 declare function ensureBoolean(value: unknown): asserts value is boolean;
+/**
+ * @group Implementation
+ * @category BCS
+ */
 declare const outOfRangeErrorMessage: (value: AnyNumber, min: AnyNumber, max: AnyNumber) => string;
 /**
  * Validates that a given number is within a specified range.
@@ -263,6 +321,8 @@ declare const outOfRangeErrorMessage: (value: AnyNumber, min: AnyNumber, max: An
  * @param value - The number to validate.
  * @param minValue - The minimum allowable value (inclusive).
  * @param maxValue - The maximum allowable value (inclusive).
+ * @group Implementation
+ * @category BCS
  */
 declare function validateNumberInRange<T extends AnyNumber>(value: T, minValue: T, maxValue: T): void;
 

package/dist/esm/bcs/serializer.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e}from"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Serializable,b as Serializer,c as ensureBoolean,d as outOfRangeErrorMessage,e as validateNumberInRange};
+import{a,b,c,d,e}from"../chunk-EBMEXURY.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Serializable,b as Serializer,c as ensureBoolean,d as outOfRangeErrorMessage,e as validateNumberInRange};
 //# sourceMappingURL=serializer.mjs.map

package/dist/esm/{chunk-PMGK5IHB.mjs → chunk-2FBJWTJD.mjs}

@@ -1,2 +1,2 @@
-import{a as t,b as n,c as o,d as r}from"./chunk-7V35JAAF.mjs";import{a as s}from"./chunk-33CVOPIN.mjs";import{b as i}from"./chunk-JNO7KPMG.mjs";var a=class{constructor(e){this.config=e}async getFungibleAssetMetadata(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),t({aptosConfig:this.config,...e})}async getFungibleAssetMetadataByAssetType(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),(await t({aptosConfig:this.config,options:{where:{asset_type:{_eq:e.assetType}}}}))[0]}async getFungibleAssetMetadataByCreatorAddress(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),await t({aptosConfig:this.config,options:{where:{creator_address:{_eq:i.from(e.creatorAddress).toStringLong()}}}})}async getFungibleAssetActivities(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),n({aptosConfig:this.config,...e})}async getCurrentFungibleAssetBalances(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),o({aptosConfig:this.config,...e})}async transferFungibleAsset(e){return r({aptosConfig:this.config,...e})}};export{a};
-//# sourceMappingURL=chunk-PMGK5IHB.mjs.map
+import{a as t,b as n,c as o,d as r}from"./chunk-2TJ6OTVD.mjs";import{a as s}from"./chunk-S7RZGC56.mjs";import{b as i}from"./chunk-Q4C4U6I4.mjs";var a=class{constructor(e){this.config=e}async getFungibleAssetMetadata(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),t({aptosConfig:this.config,...e})}async getFungibleAssetMetadataByAssetType(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),(await t({aptosConfig:this.config,options:{where:{asset_type:{_eq:e.assetType}}}}))[0]}async getFungibleAssetMetadataByCreatorAddress(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),await t({aptosConfig:this.config,options:{where:{creator_address:{_eq:i.from(e.creatorAddress).toStringLong()}}}})}async getFungibleAssetActivities(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),n({aptosConfig:this.config,...e})}async getCurrentFungibleAssetBalances(e){return await s({config:this.config,minimumLedgerVersion:e?.minimumLedgerVersion,processorType:"fungible_asset_processor"}),o({aptosConfig:this.config,...e})}async transferFungibleAsset(e){return r({aptosConfig:this.config,...e})}};export{a};
+//# sourceMappingURL=chunk-2FBJWTJD.mjs.map

package/dist/esm/chunk-2FBJWTJD.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/fungibleAsset.ts"],"sourcesContent":["// Copyright © Aptos Foundation\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n  AnyNumber,\n  GetCurrentFungibleAssetBalancesResponse,\n  GetFungibleAssetActivitiesResponse,\n  GetFungibleAssetMetadataResponse,\n  PaginationArgs,\n  WhereArg,\n} from \"../types\";\nimport {\n  getCurrentFungibleAssetBalances,\n  getFungibleAssetActivities,\n  getFungibleAssetMetadata,\n  transferFungibleAsset,\n} from \"../internal/fungibleAsset\";\nimport {\n  CurrentFungibleAssetBalancesBoolExp,\n  FungibleAssetActivitiesBoolExp,\n  FungibleAssetMetadataBoolExp,\n} from \"../types/generated/types\";\nimport { ProcessorType } from \"../utils/const\";\nimport { AptosConfig } from \"./aptosConfig\";\nimport { waitForIndexerOnVersion } from \"./utils\";\nimport { Account } from \"../account\";\nimport { AccountAddress, AccountAddressInput } from \"../core\";\nimport { InputGenerateTransactionOptions } from \"../transactions\";\nimport { SimpleTransaction } from \"../transactions/instances/simpleTransaction\";\n\n/**\n * A class for querying and managing fungible asset-related operations on the Aptos blockchain.\n * @group FungibleAsset\n */\nexport class FungibleAsset {\n  /**\n   * Initializes a new instance of the Aptos class with the provided configuration.\n   * This allows you to interact with the Aptos blockchain using the specified network settings.\n   *\n   * @param config - The configuration settings for connecting to the Aptos network.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * async function runExample() {\n   *     // Create a configuration for the Aptos client\n   *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed\n   *\n   *     // Initialize the Aptos client with the configuration\n   *     const aptos = new Aptos(config);\n   *\n   *     console.log(\"Aptos client initialized:\", aptos);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  constructor(readonly config: AptosConfig) {}\n\n  /**\n   * Queries all fungible asset metadata.\n   *\n   * @param args Optional parameters for the query.\n   * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.\n   * @param args.options Optional configuration for pagination and filtering.\n   *\n   * @returns A list of fungible asset metadata.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Fetching fungible asset metadata\n   *   const fungibleAssets = await aptos.getFungibleAssetMetadata();\n   *   console.log(fungibleAssets);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async getFungibleAssetMetadata(args?: {\n    minimumLedgerVersion?: AnyNumber;\n    options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;\n  }): Promise<GetFungibleAssetMetadataResponse> {\n    await waitForIndexerOnVersion({\n      config: this.config,\n      minimumLedgerVersion: args?.minimumLedgerVersion,\n      processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,\n    });\n    return getFungibleAssetMetadata({ aptosConfig: this.config, ...args });\n  }\n\n  /**\n   * Queries the fungible asset metadata for a specific asset type.\n   * This function helps retrieve detailed information about a fungible asset based on its type.\n   *\n   * @param args - The parameters for the query.\n   * @param args.assetType - The asset type of the fungible asset, e.g., \"0x1::aptos_coin::AptosCoin\" for Aptos Coin.\n   * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.\n   *\n   * @returns A fungible asset metadata item.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Retrieve fungible asset metadata by asset type\n   *   const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({\n   *     assetType: \"0x1::aptos_coin::AptosCoin\" // replace with your asset type\n   *   });\n   *\n   *   console.log(fungibleAsset);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async getFungibleAssetMetadataByAssetType(args: {\n    assetType: string;\n    minimumLedgerVersion?: AnyNumber;\n  }): Promise<GetFungibleAssetMetadataResponse[0]> {\n    await waitForIndexerOnVersion({\n      config: this.config,\n      minimumLedgerVersion: args?.minimumLedgerVersion,\n      processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,\n    });\n    const data = await getFungibleAssetMetadata({\n      aptosConfig: this.config,\n      options: {\n        where: {\n          asset_type: { _eq: args.assetType },\n        },\n      },\n    });\n\n    return data[0];\n  }\n\n  /**\n   * Retrieves fungible asset metadata based on the creator address.\n   *\n   * This function allows you to query metadata for a specific fungible asset created by a given address.\n   *\n   * @param args - The parameters for the query.\n   * @param args.creatorAddress - The creator address of the fungible asset.\n   * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.\n   *\n   * @returns A fungible asset metadata item.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Retrieve fungible asset metadata by creator address\n   *   const fungibleAsset = await aptos.getFungibleAssetMetadataByCreatorAddress({\n   *     creatorAddress: \"0x123\", // replace with a real creator address\n   *   });\n   *\n   *   console.log(fungibleAsset);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async getFungibleAssetMetadataByCreatorAddress(args: {\n    creatorAddress: AccountAddressInput;\n    minimumLedgerVersion?: AnyNumber;\n  }): Promise<GetFungibleAssetMetadataResponse> {\n    await waitForIndexerOnVersion({\n      config: this.config,\n      minimumLedgerVersion: args?.minimumLedgerVersion,\n      processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,\n    });\n    const data = await getFungibleAssetMetadata({\n      aptosConfig: this.config,\n      options: {\n        where: {\n          creator_address: { _eq: AccountAddress.from(args.creatorAddress).toStringLong() },\n        },\n      },\n    });\n\n    return data;\n  }\n\n  /**\n   * Queries all fungible asset activities and returns a list of their metadata.\n   *\n   * @param args Optional parameters for the query.\n   * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.\n   * @param args.options Optional configuration for pagination and filtering.\n   * @returns A list of fungible asset metadata.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Fetching fungible asset activities\n   *   const fungibleAssetActivities = await aptos.getFungibleAssetActivities();\n   *   console.log(fungibleAssetActivities);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async getFungibleAssetActivities(args?: {\n    minimumLedgerVersion?: AnyNumber;\n    options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;\n  }): Promise<GetFungibleAssetActivitiesResponse> {\n    await waitForIndexerOnVersion({\n      config: this.config,\n      minimumLedgerVersion: args?.minimumLedgerVersion,\n      processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,\n    });\n    return getFungibleAssetActivities({ aptosConfig: this.config, ...args });\n  }\n\n  /**\n   * Queries all fungible asset balances.\n   *\n   * @param args Optional parameters for the query.\n   * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.\n   * @param args.options Optional configuration for pagination and filtering.\n   *\n   * @returns A list of fungible asset metadata.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Fetching current fungible asset balances\n   *   const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances();\n   *\n   *   console.log(fungibleAssetBalances);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async getCurrentFungibleAssetBalances(args?: {\n    minimumLedgerVersion?: AnyNumber;\n    options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;\n  }): Promise<GetCurrentFungibleAssetBalancesResponse> {\n    await waitForIndexerOnVersion({\n      config: this.config,\n      minimumLedgerVersion: args?.minimumLedgerVersion,\n      processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,\n    });\n    return getCurrentFungibleAssetBalances({ aptosConfig: this.config, ...args });\n  }\n\n  /**\n   * Transfer a specified amount of fungible asset from the sender's primary store to the recipient's primary store.\n   * This method allows you to transfer any fungible asset, including fungible tokens.\n   *\n   * @param args - The arguments for the transfer operation.\n   * @param args.sender - The sender account.\n   * @param args.fungibleAssetMetadataAddress - The fungible asset account address. For example, if you’re transferring USDT,\n   * this would be the USDT address.\n   * @param args.recipient - The recipient account address.\n   * @param args.amount - The number of assets to transfer.\n   * @param args.options - Optional parameters for generating the transaction.\n   *\n   * @returns A SimpleTransaction that can be simulated or submitted to the chain.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   // Transfer fungible asset from sender to recipient\n   *   const transaction = await aptos.transferFungibleAsset({\n   *     sender: Account.generate(), // replace with a real sender account\n   *     fungibleAssetMetadataAddress: \"0x123\", // replace with a real fungible asset address\n   *     recipient: \"0x456\", // replace with a real recipient account\n   *     amount: 5\n   *   });\n   *\n   *   console.log(transaction);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group FungibleAsset\n   */\n  async transferFungibleAsset(args: {\n    sender: Account;\n    fungibleAssetMetadataAddress: AccountAddressInput;\n    recipient: AccountAddressInput;\n    amount: AnyNumber;\n    options?: InputGenerateTransactionOptions;\n  }): Promise<SimpleTransaction> {\n    return transferFungibleAsset({ aptosConfig: this.config, ...args });\n  }\n}\n"],"mappings":"gJAkCO,IAAMA,EAAN,KAAoB,CAwBzB,YAAqBC,EAAqB,CAArB,YAAAA,CAAsB,CA2B3C,MAAM,yBAAyBC,EAGe,CAC5C,aAAMC,EAAwB,CAC5B,OAAQ,KAAK,OACb,qBAAsBD,GAAM,qBAC5B,wCACF,CAAC,EACME,EAAyB,CAAE,YAAa,KAAK,OAAQ,GAAGF,CAAK,CAAC,CACvE,CA+BA,MAAM,oCAAoCA,EAGO,CAC/C,aAAMC,EAAwB,CAC5B,OAAQ,KAAK,OACb,qBAAsBD,GAAM,qBAC5B,wCACF,CAAC,GACY,MAAME,EAAyB,CAC1C,YAAa,KAAK,OAClB,QAAS,CACP,MAAO,CACL,WAAY,CAAE,IAAKF,EAAK,SAAU,CACpC,CACF,CACF,CAAC,GAEW,CAAC,CACf,CAgCA,MAAM,yCAAyCA,EAGD,CAC5C,aAAMC,EAAwB,CAC5B,OAAQ,KAAK,OACb,qBAAsBD,GAAM,qBAC5B,wCACF,CAAC,EACY,MAAME,EAAyB,CAC1C,YAAa,KAAK,OAClB,QAAS,CACP,MAAO,CACL,gBAAiB,CAAE,IAAKC,EAAe,KAAKH,EAAK,cAAc,EAAE,aAAa,CAAE,CAClF,CACF,CACF,CAAC,CAGH,CA0BA,MAAM,2BAA2BA,EAGe,CAC9C,aAAMC,EAAwB,CAC5B,OAAQ,KAAK,OACb,qBAAsBD,GAAM,qBAC5B,wCACF,CAAC,EACMI,EAA2B,CAAE,YAAa,KAAK,OAAQ,GAAGJ,CAAK,CAAC,CACzE,CA4BA,MAAM,gCAAgCA,EAGe,CACnD,aAAMC,EAAwB,CAC5B,OAAQ,KAAK,OACb,qBAAsBD,GAAM,qBAC5B,wCACF,CAAC,EACMK,EAAgC,CAAE,YAAa,KAAK,OAAQ,GAAGL,CAAK,CAAC,CAC9E,CAsCA,MAAM,sBAAsBA,EAMG,CAC7B,OAAOM,EAAsB,CAAE,YAAa,KAAK,OAAQ,GAAGN,CAAK,CAAC,CACpE,CACF","names":["FungibleAsset","config","args","waitForIndexerOnVersion","getFungibleAssetMetadata","AccountAddress","getFungibleAssetActivities","getCurrentFungibleAssetBalances","transferFungibleAsset"]}

package/dist/esm/{chunk-L4SWQLAJ.mjs → chunk-2N5KYALM.mjs}

@@ -1,2 +1,2 @@
-import{d as s}from"./chunk-SNYYEVJA.mjs";import{b as i}from"./chunk-HMMNQFVM.mjs";import{c as n}from"./chunk-H3C3VTHS.mjs";import{b as o}from"./chunk-JNO7KPMG.mjs";var c=class a{constructor(t){this.signingScheme=0;let{privateKey:e,address:r}=t;this.privateKey=e,this.publicKey=e.publicKey(),this.accountAddress=r?o.from(r):this.publicKey.authKey().derivedAddress()}static generate(){let t=n.generate();return new a({privateKey:t})}static fromDerivationPath(t){let{path:e,mnemonic:r}=t,u=n.fromDerivationPath(e,r);return new a({privateKey:u})}verifySignature(t){return this.publicKey.verifySignature(t)}signWithAuthenticator(t){return new i(this.publicKey,this.privateKey.sign(t))}signTransactionWithAuthenticator(t){return new i(this.publicKey,this.signTransaction(t))}sign(t){return this.privateKey.sign(t)}signTransaction(t){return this.sign(s(t))}};export{c as a};
-//# sourceMappingURL=chunk-L4SWQLAJ.mjs.map
+import{d as s}from"./chunk-4ZYPDCSP.mjs";import{b as i}from"./chunk-QHC5DKVZ.mjs";import{c as n}from"./chunk-FZD5RWSZ.mjs";import{b as o}from"./chunk-Q4C4U6I4.mjs";var c=class a{constructor(t){this.signingScheme=0;let{privateKey:e,address:r}=t;this.privateKey=e,this.publicKey=e.publicKey(),this.accountAddress=r?o.from(r):this.publicKey.authKey().derivedAddress()}static generate(){let t=n.generate();return new a({privateKey:t})}static fromDerivationPath(t){let{path:e,mnemonic:r}=t,u=n.fromDerivationPath(e,r);return new a({privateKey:u})}verifySignature(t){return this.publicKey.verifySignature(t)}signWithAuthenticator(t){return new i(this.publicKey,this.privateKey.sign(t))}signTransactionWithAuthenticator(t){return new i(this.publicKey,this.signTransaction(t))}sign(t){return this.privateKey.sign(t)}signTransaction(t){return this.sign(s(t))}};export{c as a};
+//# sourceMappingURL=chunk-2N5KYALM.mjs.map

package/dist/esm/chunk-2N5KYALM.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/account/Ed25519Account.ts"],"sourcesContent":["import { AccountAuthenticatorEd25519 } from \"../transactions/authenticator/account\";\nimport { HexInput, SigningScheme } from \"../types\";\nimport { AccountAddress, AccountAddressInput } from \"../core/accountAddress\";\nimport { Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature } from \"../core/crypto\";\nimport type { Account } from \"./Account\";\nimport { AnyRawTransaction } from \"../transactions/types\";\nimport { generateSigningMessageForTransaction } from \"../transactions/transactionBuilder/signingMessage\";\n\n/**\n * Arguments required to create an instance of an Ed25519 signer.\n *\n * @param privateKey - The private key used for signing.\n * @param address - Optional account address associated with the signer.\n * @group Implementation\n * @category Account (On-Chain Model)\n */\nexport interface Ed25519SignerConstructorArgs {\n  privateKey: Ed25519PrivateKey;\n  address?: AccountAddressInput;\n}\n\n/**\n * Arguments for creating an Ed25519 signer from a derivation path.\n *\n * @param path - The derivation path for the Ed25519 key.\n * @param mnemonic - The mnemonic phrase used to generate the key.\n * @group Implementation\n * @category Account (On-Chain Model)\n */\nexport interface Ed25519SignerFromDerivationPathArgs {\n  path: string;\n  mnemonic: string;\n}\n\n/**\n * Arguments required to verify an Ed25519 signature against a given message.\n *\n * @param message - The message to be verified, represented in hexadecimal format.\n * @param signature - The Ed25519 signature to validate.\n * @group Implementation\n * @category Account (On-Chain Model)\n */\nexport interface VerifyEd25519SignatureArgs {\n  message: HexInput;\n  signature: Ed25519Signature;\n}\n\n/**\n * Represents an Ed25519 account that provides signing capabilities through an Ed25519 private key.\n * This class allows for the creation of accounts, signing messages and transactions, and verifying signatures.\n *\n * Note: Generating an instance of this class does not create the account on-chain.\n * @group Implementation\n * @category Account (On-Chain Model)\n */\nexport class Ed25519Account implements Account {\n  /**\n   * Private key associated with the account\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  readonly privateKey: Ed25519PrivateKey;\n\n  readonly publicKey: Ed25519PublicKey;\n\n  readonly accountAddress: AccountAddress;\n\n  readonly signingScheme = SigningScheme.Ed25519;\n\n  // region Constructors\n\n  /**\n   * Creates an instance of the Ed25519Signer with the specified parameters.\n   * This constructor initializes the private key, public key, and account address for the signer.\n   *\n   * @param args - The constructor arguments for the Ed25519Signer.\n   * @param args.privateKey - The private key used for signing.\n   * @param args.address - The optional account address; if not provided, it will derive the address from the public key.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  constructor(args: Ed25519SignerConstructorArgs) {\n    const { privateKey, address } = args;\n    this.privateKey = privateKey;\n    this.publicKey = privateKey.publicKey();\n    this.accountAddress = address ? AccountAddress.from(address) : this.publicKey.authKey().derivedAddress();\n  }\n\n  /**\n   * Generates a new Ed25519 account using a randomly generated private key.\n   * This function is useful for creating a signer that can be used for cryptographic operations.\n   *\n   * @returns {Ed25519Account} The newly generated Ed25519 account.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  static generate(): Ed25519Account {\n    const privateKey = Ed25519PrivateKey.generate();\n    return new Ed25519Account({ privateKey });\n  }\n\n  /**\n   * Derives an Ed25519 account using a specified BIP44 path and mnemonic seed phrase.\n   *\n   * @param args - The arguments for deriving the account.\n   * @param args.path - The BIP44 derive hardened path, e.g., m/44'/637'/0'/0'/0'.\n   * Detailed description: {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}\n   * @param args.mnemonic - The mnemonic seed phrase of the account.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  static fromDerivationPath(args: Ed25519SignerFromDerivationPathArgs) {\n    const { path, mnemonic } = args;\n    const privateKey = Ed25519PrivateKey.fromDerivationPath(path, mnemonic);\n    return new Ed25519Account({ privateKey });\n  }\n  // endregion\n\n  // region Account\n  /**\n   * Verify the given message and signature with the public key.\n   *\n   * @param args - The arguments for verifying the signature.\n   * @param args.message - Raw message data in HexInput format.\n   * @param args.signature - Signed message signature.\n   * @returns A boolean indicating whether the signature is valid.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  verifySignature(args: VerifyEd25519SignatureArgs): boolean {\n    return this.publicKey.verifySignature(args);\n  }\n\n  /**\n   * Sign a message using the account's Ed25519 private key.\n   * This function returns an AccountAuthenticator containing the signature along with the account's public key.\n   *\n   * @param message - The signing message, represented as hexadecimal input.\n   * @returns An AccountAuthenticator containing the signature and the account's public key.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  signWithAuthenticator(message: HexInput): AccountAuthenticatorEd25519 {\n    return new AccountAuthenticatorEd25519(this.publicKey, this.privateKey.sign(message));\n  }\n\n  /**\n   * Sign a transaction using the account's Ed25519 private key.\n   * This function returns an AccountAuthenticator that contains the signature of the transaction along with the account's public key.\n   *\n   * @param transaction - The raw transaction to be signed.\n   * @returns An AccountAuthenticator containing the signature and the public key.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorEd25519 {\n    return new AccountAuthenticatorEd25519(this.publicKey, this.signTransaction(transaction));\n  }\n\n  /**\n   * Sign the given message using the account's Ed25519 private key.\n   * @param message - The message to be signed in HexInput format.\n   * @returns Signature - The resulting signature of the signed message.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  sign(message: HexInput): Ed25519Signature {\n    return this.privateKey.sign(message);\n  }\n\n  /**\n   * Sign the given transaction using the available signing capabilities.\n   * This function helps ensure that the transaction is properly authenticated before submission.\n   *\n   * @param transaction - The transaction to be signed.\n   * @returns Signature - The resulting signature for the transaction.\n   * @group Implementation\n   * @category Account (On-Chain Model)\n   */\n  signTransaction(transaction: AnyRawTransaction): Ed25519Signature {\n    return this.sign(generateSigningMessageForTransaction(transaction));\n  }\n\n  // endregion\n}\n"],"mappings":"oKAuDO,IAAMA,EAAN,MAAMC,CAAkC,CA0B7C,YAAYC,EAAoC,CAdhD,KAAS,cAAgB,EAevB,GAAM,CAAE,WAAAC,EAAY,QAAAC,CAAQ,EAAIF,EAChC,KAAK,WAAaC,EAClB,KAAK,UAAYA,EAAW,UAAU,EACtC,KAAK,eAAiBC,EAAUC,EAAe,KAAKD,CAAO,EAAI,KAAK,UAAU,QAAQ,EAAE,eAAe,CACzG,CAUA,OAAO,UAA2B,CAChC,IAAMD,EAAaG,EAAkB,SAAS,EAC9C,OAAO,IAAIL,EAAe,CAAE,WAAAE,CAAW,CAAC,CAC1C,CAYA,OAAO,mBAAmBD,EAA2C,CACnE,GAAM,CAAE,KAAAK,EAAM,SAAAC,CAAS,EAAIN,EACrBC,EAAaG,EAAkB,mBAAmBC,EAAMC,CAAQ,EACtE,OAAO,IAAIP,EAAe,CAAE,WAAAE,CAAW,CAAC,CAC1C,CAcA,gBAAgBD,EAA2C,CACzD,OAAO,KAAK,UAAU,gBAAgBA,CAAI,CAC5C,CAWA,sBAAsBO,EAAgD,CACpE,OAAO,IAAIC,EAA4B,KAAK,UAAW,KAAK,WAAW,KAAKD,CAAO,CAAC,CACtF,CAWA,iCAAiCE,EAA6D,CAC5F,OAAO,IAAID,EAA4B,KAAK,UAAW,KAAK,gBAAgBC,CAAW,CAAC,CAC1F,CASA,KAAKF,EAAqC,CACxC,OAAO,KAAK,WAAW,KAAKA,CAAO,CACrC,CAWA,gBAAgBE,EAAkD,CAChE,OAAO,KAAK,KAAKC,EAAqCD,CAAW,CAAC,CACpE,CAGF","names":["Ed25519Account","_Ed25519Account","args","privateKey","address","AccountAddress","Ed25519PrivateKey","path","mnemonic","message","AccountAuthenticatorEd25519","transaction","generateSigningMessageForTransaction"]}