@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/dist/esm/client/post.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f}from"../chunk-7V6DEA7G.mjs";import"../chunk-PUZ25PTD.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-CCMHWJ3Q.mjs";import"../chunk-6QGVRNV6.mjs";import"../chunk-YJCZU6PR.mjs";import"../chunk-MS4MRLGA.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-555I4YHP.mjs";import"../chunk-FVA2OPG4.mjs";export{a as post,d as postAptosFaucet,b as postAptosFullNode,c as postAptosIndexer,e as postAptosPepperService,f as postAptosProvingService};
+import{a,b,c,d,e,f}from"../chunk-2652SPOM.mjs";import"../chunk-2GEIHUHT.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-2CGJLPHP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as post,d as postAptosFaucet,b as postAptosFullNode,c as postAptosIndexer,e as postAptosPepperService,f as postAptosProvingService};
 //# sourceMappingURL=post.mjs.map

package/dist/esm/client/types.d.mts

@@ -25,20 +25,24 @@ interface AptosResponse<Req, Res> {
     config?: any;
     request?: Req;
 }
+/**
+ * Options for handling errors in the Aptos API.
+ */
 type AptosApiErrorOpts = {
     apiType: AptosApiType;
     aptosRequest: AptosRequest;
     aptosResponse: AptosResponse<any, any>;
 };
 /**
- * The type returned from an API error
+ * Represents an error returned from the Aptos API.
+ * This class encapsulates the details of the error, including the request URL, response status, and additional data.
  *
- * @param name - the error name "AptosApiError"
- * @param url the url the request was made to
- * @param status - the response status. i.e. 400
- * @param statusText - the response message
- * @param data the response data
- * @param request - the AptosRequest
+ * @param name - The name of the error, which is always "AptosApiError".
+ * @param url - The URL to which the request was made.
+ * @param status - The HTTP response status code (e.g., 400).
+ * @param statusText - The message associated with the response status.
+ * @param data - The response data returned from the API.
+ * @param request - The original AptosRequest that triggered the error.
  */
 declare class AptosApiError extends Error {
     readonly url: string;
@@ -46,7 +50,16 @@ declare class AptosApiError extends Error {
     readonly statusText: string;
     readonly data: any;
     readonly request: AptosRequest;
-    /** @internal this constructor is for sdk internal use - do not instantiate outside of the SDK codebase */
+    /**
+     * Constructs an instance of AptosApiError with relevant error details.
+     *
+     * @param opts - The options for creating the AptosApiError.
+     * @param opts.apiType - The type of API that generated the error.
+     * @param opts.aptosRequest - The request object that caused the error.
+     * @param opts.aptosResponse - The response object containing error details.
+     *
+     * @internal This constructor is for SDK internal use - do not instantiate outside the SDK codebase.
+     */
     constructor({ apiType, aptosRequest, aptosResponse }: AptosApiErrorOpts);
 }
 

package/dist/esm/client/types.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-FVA2OPG4.mjs";export{a as AptosApiError};
+import{a}from"../chunk-GQABU3RQ.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AptosApiError};
 //# sourceMappingURL=types.mjs.map

package/dist/esm/core/account/index.mjs

@@ -1,2 +1,2 @@
-import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../chunk-WP7WF54Q.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../chunk-PCLU4KLY.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/core/account/utils/address.d.mts

@@ -20,7 +20,7 @@ import '../../../transactions/instances/transactionArgument.mjs';
  */
 declare const createObjectAddress: (creatorAddress: AccountAddress, seed: Uint8Array | string) => AccountAddress;
 /**
- * Creates an resource address from creator address and seed
+ * Creates a resource address from creator address and seed
  *
  * @param creatorAddress The creator account address
  * @param seed The seed in either Uint8Array | string type

package/dist/esm/core/account/utils/address.mjs

@@ -1,2 +1,2 @@
-import{a,b,c}from"../../../chunk-WP7WF54Q.mjs";import"../../../chunk-QPP6BX53.mjs";import"../../../chunk-44GYWUSH.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-HPZ2S4FE.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-BCUSI3N6.mjs";import"../../../chunk-LG7RJQ57.mjs";import"../../../chunk-FVA2OPG4.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import{a,b,c}from"../../../chunk-PCLU4KLY.mjs";import"../../../chunk-KM6UXNC7.mjs";import"../../../chunk-7XS45O6M.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-QQIVWB6G.mjs";import"../../../chunk-KFNDDPOW.mjs";import"../../../chunk-6Q2O5G3J.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=address.mjs.map

package/dist/esm/core/account/utils/index.mjs

@@ -1,2 +1,2 @@
-import"../../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../../chunk-WP7WF54Q.mjs";import"../../../chunk-QPP6BX53.mjs";import"../../../chunk-44GYWUSH.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-HPZ2S4FE.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-BCUSI3N6.mjs";import"../../../chunk-LG7RJQ57.mjs";import"../../../chunk-FVA2OPG4.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import"../../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../../chunk-PCLU4KLY.mjs";import"../../../chunk-KM6UXNC7.mjs";import"../../../chunk-7XS45O6M.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-QQIVWB6G.mjs";import"../../../chunk-KFNDDPOW.mjs";import"../../../chunk-6Q2O5G3J.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/core/accountAddress.d.mts

@@ -10,7 +10,7 @@ import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
 /**
- * This enum is used to explain why an address was invalid.
+ * Provides reasons for an address was invalid.
  */
 declare enum AddressInvalidReason {
     INCORRECT_NUMBER_OF_BYTES = "incorrect_number_of_bytes",
@@ -21,6 +21,9 @@ declare enum AddressInvalidReason {
     LONG_FORM_REQUIRED_UNLESS_SPECIAL = "long_form_required_unless_special",
     INVALID_PADDING_ZEROES = "INVALID_PADDING_ZEROES"
 }
+/**
+ * The input for an account address, which can be either a hexadecimal string or a standard account address.
+ */
 type AccountAddressInput = HexInput | AccountAddress;
 /**
  * NOTE: Only use this class for account addresses. For other hex data, e.g. transaction
@@ -60,68 +63,60 @@ declare class AccountAddress extends Serializable implements TransactionArgument
     /**
      * Creates an instance of AccountAddress from a Uint8Array.
      *
-     * @param args.data A Uint8Array representing an account address.
+     * This function ensures that the input data is exactly 32 bytes long, which is required for a valid account address.
+     *
+     * @param input A Uint8Array representing an account address.
+     * @throws ParsingError if the input length is not equal to 32 bytes.
      */
     constructor(input: Uint8Array);
     /**
-     * Returns whether an address is special, where special is defined as 0x0 to 0xf
-     * inclusive. In other words, the last byte of the address must be < 0b10000 (16)
+     * Determines if the address is classified as special, which is defined as 0x0 to 0xf inclusive.
+     * In other words, the last byte of the address must be < 0b10000 (16)
      * and every other byte must be zero.
      *
-     * For more information on how special addresses are defined see AIP-40:
+     * For more information on how special addresses are defined, see AIP-40:
      * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
      *
-     * @returns true if the address is special, false if not.
+     * @returns true if the address is special, false otherwise.
      */
     isSpecial(): boolean;
     /**
      * Return the AccountAddress as a string as per AIP-40.
      * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
-     *
-     * In short, it means that special addresses are represented in SHORT form, meaning
-     * 0x0 through to 0xf inclusive, and every other address is represented in LONG form,
-     * meaning 0x + 64 hex characters.
+     * This representation returns special addresses in SHORT form (0xf)
+     * and other addresses in LONG form (0x + 64 characters).
      *
      * @returns AccountAddress as a string conforming to AIP-40.
      */
     toString(): `0x${string}`;
     /**
-     * NOTE: Prefer to use `toString` where possible.
-     *
-     * Return the AccountAddress as a string as per AIP-40 but without the leading 0x.
+     * Return the AccountAddress as a string conforming to AIP-40 but without the leading 0x.
      *
-     * Learn more by reading the docstring of `toString`.
+     * NOTE: Prefer to use `toString` where possible.
      *
-     * @returns AccountAddress as a string conforming to AIP-40 but without the leading 0x.
+     * @returns AccountAddress as a string without the leading 0x.
      */
     toStringWithoutPrefix(): string;
     /**
-     * NOTE: Prefer to use `toString` where possible.
-     *
-     * Whereas toString will format special addresses (as defined by isSpecial) using the
-     * SHORT form (no leading 0s), this format the address in the LONG format
-     * unconditionally.
+     * Convert the account address to a string in LONG format, which is always 0x followed by 64 hex characters.
      *
-     * This means it will be 0x + 64 hex characters.
+     * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
      *
      * @returns AccountAddress as a string in LONG form.
      */
     toStringLong(): `0x${string}`;
     /**
-     * NOTE: Prefer to use `toString` where possible.
-     *
-     * Whereas toString will format special addresses (as defined by isSpecial) using the
-     * SHORT form (no leading 0s), this function will include leading zeroes. The string
-     * will not have a leading zero.
+     * Returns the account address as a string in LONG form without a leading 0x.
+     * This function will include leading zeroes and will produce a string of 64 hex characters.
      *
-     * This means it will be 64 hex characters without a leading 0x.
+     * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
      *
-     * @returns AccountAddress as a string in LONG form without a leading 0x.
+     * @returns {string} The account address in LONG form.
      */
     toStringLongWithoutPrefix(): string;
     /**
-     * Get the inner hex data. The inner data is already a Uint8Array so no conversion
-     * is taking place here, it just returns the inner data.
+     * Get the inner data as a Uint8Array.
+     * The inner data is already a Uint8Array, so no conversion takes place.
      *
      * @returns Hex data as Uint8Array
      */
@@ -138,10 +133,23 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      * // `bytes` is now the BCS-serialized address.
      */
     serialize(serializer: Serializer): void;
+    /**
+     * Serializes the current instance into a byte sequence suitable for entry functions.
+     * This allows for the proper encoding of data when interacting with entry functions in the blockchain.
+     *
+     * @param serializer - The serializer instance used to convert the data into bytes.
+     */
     serializeForEntryFunction(serializer: Serializer): void;
+    /**
+     * Serializes the current instance for use in a script function by encoding it into a byte sequence.
+     * This process involves serializing the variant index and the instance data, making it suitable for transmission.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     */
     serializeForScriptFunction(serializer: Serializer): void;
     /**
      * Deserialize an AccountAddress from the byte buffer in a Deserializer instance.
+     * This function allows you to convert a byte representation of an AccountAddress into an instance of AccountAddress.
      * @param deserializer The deserializer to deserialize the AccountAddress from.
      * @returns An instance of AccountAddress.
      * @example
@@ -171,10 +179,14 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      * - SHORT for non-special addresses.
      * - Any address without a leading 0x.
      *
-     * Learn more about the different address formats by reading AIP-40:
-     * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+     * @param input - A hex string representing an account address.
+     *
+     * @throws {ParsingError} If the hex string does not start with 0x or is not in a valid format.
      *
-     * @param input A hex string representing an account address.
+     * @note This function has strict parsing behavior. For relaxed behavior, please use the `fromString` function.
+     *
+     * @see AIP-40 documentation for more details on address formats:
+     * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
      *
      * @returns An instance of AccountAddress.
      */
@@ -200,43 +212,46 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      * Learn more about the different address formats by reading AIP-40:
      * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
      *
-     * @param input A hex string representing an account address.
+     * @param input - A hex string representing an account address.
      *
      * @returns An instance of AccountAddress.
+     *
+     * @throws ParsingError if the hex string is too short, too long, or contains invalid characters.
      */
     static fromString(input: string): AccountAddress;
     /**
-     * Convenience method for creating an AccountAddress from all known inputs.
+     * Convenience method for creating an AccountAddress from various input types.
+     * This function accepts a string, Uint8Array, or an existing AccountAddress instance and returns the corresponding
+     * AccountAddress.
      *
-     * This handles, Uint8array, string, and AccountAddress itself
-     * @param input
+     * @param input - The input to convert into an AccountAddress. This can be a string representation of an address, a Uint8Array,
+     * or an existing AccountAddress.
      */
     static from(input: AccountAddressInput): AccountAddress;
     /**
-     * Convenience method for creating an AccountAddress from all known inputs.
+     * Create an AccountAddress from various input types, including strings, Uint8Array, and AccountAddress instances.
      *
-     * This handles, Uint8array, string, and AccountAddress itself
-     * @param input
+     * @param input - The input to convert into an AccountAddress, which can be a string, a Uint8Array, or an AccountAddress.
      */
     static fromStrict(input: AccountAddressInput): AccountAddress;
     /**
-     * Check if the string is a valid AccountAddress.
+     * Check if the provided input is a valid AccountAddress.
      *
-     * @param args.input A hex string representing an account address.
-     * @param args.strict If true, use strict parsing behavior. If false, use relaxed parsing behavior.
+     * @param args - The arguments for validation.
+     * @param args.input - A hex string representing an account address.
+     * @param args.strict - If true, use strict parsing behavior; if false, use relaxed parsing behavior.
      *
-     * @returns valid = true if the string is valid, valid = false if not. If the string
-     * is not valid, invalidReason will be set explaining why it is invalid.
+     * @returns An object indicating whether the address is valid. If valid, valid = true; if not, valid = false with additional details.
+     * If the address is invalid, invalidReason will explain why it is invalid, and invalidReasonMessage will provide the error message.
      */
     static isValid(args: {
         input: AccountAddressInput;
         strict?: boolean;
     }): ParsingResult<AddressInvalidReason>;
     /**
-     * Return whether AccountAddresses are equal. AccountAddresses are considered equal
-     * if their underlying byte data is identical.
+     * Determine if two AccountAddresses are equal based on their underlying byte data.
      *
-     * @param other The AccountAddress to compare to.
+     * @param other - The AccountAddress to compare to.
      * @returns true if the AccountAddresses are equal, false if not.
      */
     equals(other: AccountAddress): boolean;

package/dist/esm/core/accountAddress.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../chunk-QPP6BX53.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-FVA2OPG4.mjs";export{b as AccountAddress,a as AddressInvalidReason};
+import{a,b}from"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{b as AccountAddress,a as AddressInvalidReason};
 //# sourceMappingURL=accountAddress.mjs.map

package/dist/esm/core/authenticationKey.d.mts

@@ -1,7 +1,7 @@
 import './accountAddress.mjs';
 import '../bcs/deserializer.mjs';
 import '../bcs/serializer.mjs';
-export { A as AuthenticationKey } from '../publicKey-B3XRNhHO.mjs';
+export { A as AuthenticationKey } from '../publicKey-_tPa99ea.mjs';
 import '../types/index.mjs';
 import './hex.mjs';
 import './common.mjs';

package/dist/esm/core/authenticationKey.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-KA6FZNWP.mjs";import"../chunk-QPP6BX53.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-FVA2OPG4.mjs";export{a as AuthenticationKey};
+import{a}from"../chunk-PRZ7AIGA.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AuthenticationKey};
 //# sourceMappingURL=authenticationKey.mjs.map

package/dist/esm/core/common.d.mts

@@ -8,6 +8,12 @@ declare class ParsingError<T> extends Error {
      * messages are not suitable for their use case. This should be an enum.
      */
     invalidReason: T;
+    /**
+     * Creates an instance of the error with a specified message and invalid reason.
+     *
+     * @param message The error message that describes the issue.
+     * @param invalidReason The reason why the input is considered invalid.
+     */
     constructor(message: string, invalidReason: T);
 }
 /**

package/dist/esm/core/common.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-LG7RJQ57.mjs";import"../chunk-FVA2OPG4.mjs";export{a as ParsingError};
+import{a}from"../chunk-6Q2O5G3J.mjs";import"../chunk-KDMSOCZY.mjs";export{a as ParsingError};
 //# sourceMappingURL=common.mjs.map

package/dist/esm/core/crypto/ed25519.d.mts

@@ -1,6 +1,6 @@
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer, Serializable } from '../../bcs/serializer.mjs';
-import { a as AccountPublicKey, V as VerifySignatureArgs, A as AuthenticationKey, P as PublicKey } from '../../publicKey-B3XRNhHO.mjs';
+import { a as AccountPublicKey, V as VerifySignatureArgs, A as AuthenticationKey, P as PublicKey } from '../../publicKey-_tPa99ea.mjs';
 import { HexInput } from '../../types/index.mjs';
 import { PrivateKey } from './privateKey.mjs';
 import { Signature } from './signature.mjs';
@@ -15,6 +15,10 @@ import '../../transactions/instances/transactionArgument.mjs';
 
 /**
  * Checks if an ED25519 signature is non-canonical.
+ * This function helps determine the validity of a signature by verifying its canonical form.
+ *
+ * @param signature - The signature to be checked for canonicality.
+ * @returns A boolean indicating whether the signature is non-canonical.
  *
  * Comes from Aptos Core
  * https://github.com/aptos-labs/aptos-core/blob/main/crates/aptos-crypto/src/ed25519/ed25519_sigs.rs#L47-L85
@@ -27,7 +31,7 @@ declare function isCanonicalEd25519Signature(signature: Signature): boolean;
  * `Legacy` and `Unified` authentication keys.
  *
  * Ed25519 scheme is represented in the SDK as `Legacy authentication key` and also
- * as `AnyPublicKey` that represents any `Unified authentication key`
+ * as `AnyPublicKey` that represents any `Unified authentication key`.
  */
 declare class Ed25519PublicKey extends AccountPublicKey {
     /**
@@ -40,34 +44,73 @@ declare class Ed25519PublicKey extends AccountPublicKey {
      */
     private readonly key;
     /**
-     * Create a new PublicKey instance from a Uint8Array or String.
+     * Creates an instance of the Ed25519Signature class from a hex input.
+     * This constructor validates the length of the signature to ensure it meets the required specifications.
      *
-     * @param hexInput A HexInput (string or Uint8Array)
+     * @param hexInput - The hex input representing the Ed25519 signature.
+     * @throws Error if the signature length is not equal to Ed25519Signature.LENGTH.
      */
     constructor(hexInput: HexInput);
     /**
-     * Verifies a signed data with a public key
-     * @param args.message a signed message as a Hex string or Uint8Array
-     * @param args.signature the signature of the message
+     * Verifies a signed message using a public key.
+     *
+     * @param args - The arguments for verification.
+     * @param args.message - A signed message as a Hex string or Uint8Array.
+     * @param args.signature - The signature of the message.
      */
     verifySignature(args: VerifySignatureArgs): boolean;
+    /**
+     * Generates an authentication key from the public key using the Ed25519 scheme.
+     * This function is essential for creating a secure authentication key that can be used for further cryptographic operations.
+     *
+     * @returns {AuthenticationKey} The generated authentication key.
+     */
     authKey(): AuthenticationKey;
     /**
-     * Get the public key in bytes (Uint8Array).
+     * Convert the internal data representation to a Uint8Array.
      *
-     * @returns Uint8Array representation of the public key
+     * @returns Uint8Array representation of the data.
      */
     toUint8Array(): Uint8Array;
+    /**
+     * Serializes the data into a byte array using the provided serializer.
+     * This allows for the conversion of data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserialize bytes into an Ed25519Signature object.
+     * This function is used to convert serialized byte data into a usable Ed25519Signature instance.
+     *
+     * @param deserializer - The deserializer instance used to read the byte data.
+     */
     static deserialize(deserializer: Deserializer): Ed25519PublicKey;
     /**
+     * Determine if the provided public key is an instance of Ed25519PublicKey.
+     *
+     * @param publicKey - The public key to check.
+     * @returns True if the public key is an instance of Ed25519PublicKey, otherwise false.
      * @deprecated use `instanceof Ed25519PublicKey` instead.
      */
     static isPublicKey(publicKey: AccountPublicKey): publicKey is Ed25519PublicKey;
+    /**
+     * Determines if the provided public key is a valid Ed25519 public key.
+     * This function checks for the presence of the "key" property and verifies that its data length matches the expected length
+     * for Ed25519 public keys.
+     *
+     * @param publicKey - The public key to validate.
+     * @returns A boolean indicating whether the public key is a valid Ed25519 public key.
+     */
     static isInstance(publicKey: PublicKey): publicKey is Ed25519PublicKey;
 }
 /**
  * Represents the private key of an Ed25519 key pair.
+ *
+ * @static
+ * @readonly LENGTH - Length of an Ed25519 private key.
+ * @static
+ * @readonly SLIP_0010_SEED - The Ed25519 key seed to use for BIP-32 compatibility.
  */
 declare class Ed25519PrivateKey extends Serializable implements PrivateKey {
     /**
@@ -93,42 +136,43 @@ declare class Ed25519PrivateKey extends Serializable implements PrivateKey {
     /**
      * Generate a new random private key.
      *
-     * @returns Ed25519PrivateKey
+     * @returns Ed25519PrivateKey A newly generated Ed25519 private key.
      */
     static generate(): Ed25519PrivateKey;
     /**
-     * Derives a private key from a mnemonic seed phrase.
-     *
+     * Derives a private key from a mnemonic seed phrase using a specified BIP44 path.
      * To derive multiple keys from the same phrase, change the path
      *
-     * IMPORTANT: Ed25519 supports hardened derivation only (since it lacks a key homomorphism,
-     * so non-hardened derivation cannot work)
+     * IMPORTANT: Ed25519 supports hardened derivation only, as it lacks a key homomorphism, making non-hardened derivation impossible.
      *
-     * @param path the BIP44 path
-     * @param mnemonics the mnemonic seed phrase
+     * @param path - The BIP44 path used for key derivation.
+     * @param mnemonics - The mnemonic seed phrase from which the key will be derived.
+     * @throws Error if the provided path is not a valid hardened path.
      */
     static fromDerivationPath(path: string, mnemonics: string): Ed25519PrivateKey;
     /**
+     * Derives a child private key from a given BIP44 path and seed.
      * A private inner function so we can separate from the main fromDerivationPath() method
      * to add tests to verify we create the keys correctly.
      *
-     * @param path the BIP44 path
-     * @param seed the seed phrase created by the mnemonics
-     * @param offset the offset used for key derivation, defaults to 0x80000000
-     * @returns
+     * @param path - The BIP44 path used for key derivation.
+     * @param seed - The seed phrase created by the mnemonics, represented as a Uint8Array.
+     * @param offset - The offset used for key derivation, defaults to HARDENED_OFFSET.
+     * @returns An instance of Ed25519PrivateKey derived from the specified path and seed.
      */
     private static fromDerivationPathInner;
     /**
      * Derive the Ed25519PublicKey for this private key.
      *
-     * @returns Ed25519PublicKey
+     * @returns Ed25519PublicKey - The derived public key corresponding to the private key.
      */
     publicKey(): Ed25519PublicKey;
     /**
      * Sign the given message with the private key.
+     * This function generates a digital signature for the specified message, ensuring its authenticity and integrity.
      *
-     * @param message a message as a string or Uint8Array
-     * @returns Signature
+     * @param message - A message as a string or Uint8Array in HexInput format.
+     * @returns A digital signature for the provided message.
      */
     sign(message: HexInput): Ed25519Signature;
     /**
@@ -140,18 +184,25 @@ declare class Ed25519PrivateKey extends Serializable implements PrivateKey {
     /**
      * Get the private key as a hex string with the 0x prefix.
      *
-     * @returns string representation of the private key
+     * @returns string representation of the private key.
      */
     toString(): string;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): Ed25519PrivateKey;
     /**
-     * @deprecated use `instanceof Ed25519PrivateKey` instead.
+     * Determines if the provided private key is an instance of Ed25519PrivateKey.
+     *
+     * @param privateKey - The private key to check.
+     * @returns A boolean indicating whether the private key is an Ed25519PrivateKey.
+     *
+     * @deprecated Use `instanceof Ed25519PrivateKey` instead.
      */
     static isPrivateKey(privateKey: PrivateKey): privateKey is Ed25519PrivateKey;
 }
 /**
- * A signature of a message signed using an Ed25519 private key
+ * Represents a signature of a message signed using an Ed25519 private key.
+ *
+ * @static LENGTH - Length of an Ed25519 signature, which is 64 bytes.
  */
 declare class Ed25519Signature extends Signature {
     /**

package/dist/esm/core/crypto/ed25519.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d}from"../../chunk-DAJOX4PL.mjs";import"../../chunk-IMGLHDIA.mjs";import"../../chunk-BF4ZE37Q.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-KA6FZNWP.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-CCMHWJ3Q.mjs";import"../../chunk-6QGVRNV6.mjs";import"../../chunk-YJCZU6PR.mjs";import"../../chunk-MS4MRLGA.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-FVA2OPG4.mjs";export{c as Ed25519PrivateKey,b as Ed25519PublicKey,d as Ed25519Signature,a as isCanonicalEd25519Signature};
+import{a,b,c,d}from"../../chunk-P3J54CQG.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-N47FTRYO.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{c as Ed25519PrivateKey,b as Ed25519PublicKey,d as Ed25519Signature,a as isCanonicalEd25519Signature};
 //# sourceMappingURL=ed25519.mjs.map