@aptos-labs/ts-sdk 1.29.0 → 1.30.0

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

@@ -1,6 +1,6 @@
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer } from '../../bcs/serializer.mjs';
-import { a as AccountPublicKey, V as VerifySignatureArgs, A as AuthenticationKey } from '../../publicKey-B3XRNhHO.mjs';
+import { a as AccountPublicKey, V as VerifySignatureArgs, A as AuthenticationKey } from '../../publicKey-_tPa99ea.mjs';
 import { Ed25519PublicKey, Ed25519Signature } from './ed25519.mjs';
 import { Signature } from './signature.mjs';
 import '../../types/index.mjs';
@@ -16,6 +16,12 @@ import './privateKey.mjs';
 
 /**
  * Represents the public key of a K-of-N Ed25519 multi-sig transaction.
+ *
+ * A K-of-N multi-sig transaction requires at least K out of N authorized signers to sign the transaction
+ * for it to be executed. This class encapsulates the logic for managing the public keys and the threshold
+ * for valid signatures.
+ *
+ * @see {@link https://aptos.dev/integration/creating-a-signed-transaction/ | Creating a Signed Transaction}
  */
 declare class MultiEd25519PublicKey extends AccountPublicKey {
     /**
@@ -45,7 +51,7 @@ declare class MultiEd25519PublicKey extends AccountPublicKey {
      *
      * @see {@link
      * https://aptos.dev/integration/creating-a-signed-transaction/ | Creating a Signed Transaction}
-     *
+     * @param args - A wrapper to let you choose the param order.
      * @param args.publicKeys A list of public keys
      * @param args.threshold At least "threshold" signatures must be valid
      */
@@ -53,17 +59,47 @@ declare class MultiEd25519PublicKey extends AccountPublicKey {
         publicKeys: Ed25519PublicKey[];
         threshold: number;
     });
+    /**
+     * Verifies a multi-signature against a given message.
+     * This function ensures that the provided signatures meet the required threshold and are valid for the given message.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The multi-signature containing multiple signatures and a bitmap indicating which signatures are valid.
+     * @returns True if the signature is valid; otherwise, false.
+     * @throws Error if the bitmap and signatures length mismatch or if there are not enough valid signatures.
+     */
     verifySignature(args: VerifySignatureArgs): boolean;
+    /**
+     * Generates an authentication key based on the current instance's byte representation.
+     * This function is essential for creating a secure authentication key that can be used for various cryptographic operations.
+     *
+     * @returns {AuthenticationKey} The generated authentication key.
+     */
     authKey(): AuthenticationKey;
     /**
      * Converts a PublicKeys into Uint8Array (bytes) with: bytes = p1_bytes | ... | pn_bytes | threshold
      */
     toUint8Array(): Uint8Array;
+    /**
+     * Serializes the current instance into bytes using the provided serializer.
+     * This allows for the conversion of the instance's data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer used to convert the instance into bytes.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a MultiEd25519Signature from the provided deserializer.
+     * This function helps in reconstructing a MultiEd25519Signature object from its serialized byte representation.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     */
     static deserialize(deserializer: Deserializer): MultiEd25519PublicKey;
 }
 /**
  * Represents the signature of a K-of-N Ed25519 multi-sig transaction.
+ *
+ * @see {@link https://aptos.dev/integration/creating-a-signed-transaction/#multisignature-transactions | Creating a Signed Transaction}
  */
 declare class MultiEd25519Signature extends Signature {
     /**
@@ -108,9 +144,12 @@ declare class MultiEd25519Signature extends Signature {
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): MultiEd25519Signature;
     /**
-     * Helper method to create a bitmap out of the specified bit positions
-     * @param args.bits The bitmap positions that should be set. A position starts at index 0.
-     * Valid position should range between 0 and 31.
+     * Helper method to create a bitmap out of the specified bit positions.
+     * This function allows you to set specific bits in a 32-bit long bitmap based on the provided positions.
+     *
+     * @param args The arguments for creating the bitmap.
+     * @param args.bits The bitmap positions that should be set. A position starts at index 0. Valid positions should range between 0 and 31.
+     *
      * @example
      * Here's an example of valid `bits`
      * ```
@@ -119,7 +158,7 @@ declare class MultiEd25519Signature extends Signature {
      * `[0, 2, 31]` means the 1st, 3rd and 32nd bits should be set in the bitmap.
      * The result bitmap should be 0b1010000000000000000000000000001
      *
-     * @returns bitmap that is 32bit long
+     * @returns bitmap that is 32 bits long.
      */
     static createBitmap(args: {
         bits: number[];

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

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-45IUUCAV.mjs";import"../../chunk-GWSDIX6C.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as MultiEd25519PublicKey,b as MultiEd25519Signature};
+import{a,b}from"../../chunk-WIXNX7HY.mjs";import"../../chunk-WSVOJSAC.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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 MultiEd25519PublicKey,b as MultiEd25519Signature};
 //# sourceMappingURL=multiEd25519.mjs.map

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

@@ -1,6 +1,6 @@
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer } from '../../bcs/serializer.mjs';
-import { a as AccountPublicKey, P as PublicKey, V as VerifySignatureArgs, A as AuthenticationKey } from '../../publicKey-B3XRNhHO.mjs';
+import { a as AccountPublicKey, P as PublicKey, V as VerifySignatureArgs, A as AuthenticationKey } from '../../publicKey-_tPa99ea.mjs';
 import { Signature } from './signature.mjs';
 import { AnyPublicKey, AnySignature } from './singleKey.mjs';
 import '../../types/index.mjs';
@@ -14,10 +14,12 @@ import '../accountAddress.mjs';
 import '../../transactions/instances/transactionArgument.mjs';
 
 /**
- * Represents the public key of a multi-agent account.
+ * Represents a multi-key authentication scheme for accounts, allowing multiple public keys
+ * to be associated with a single account. This class enforces a minimum number of valid signatures
+ * required to authorize actions, ensuring enhanced security for multi-agent accounts.
  *
  * The public keys of each individual agent can be any type of public key supported by Aptos.
- * Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263) Aptos supports
+ * Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263), Aptos supports
  * `Legacy` and `Unified` authentication keys.
  */
 declare class MultiKey extends AccountPublicKey {
@@ -29,14 +31,51 @@ declare class MultiKey extends AccountPublicKey {
      * The minimum number of valid signatures required, for the number of public keys specified
      */
     readonly signaturesRequired: number;
+    /**
+     * Signature for a K-of-N multi-sig transaction.
+     * This constructor initializes a multi-signature transaction with the provided signatures and bitmap.
+     *
+     * @param args An object containing the parameters for the multi-signature transaction.
+     * @param args.signatures A list of signatures.
+     * @param args.bitmap A bitmap represented as a Uint8Array or an array of numbers, where each bit indicates whether a
+     * corresponding signature is present. A maximum of 32 signatures is supported, and the length of the bitmap must be 4 bytes.
+     *
+     * @throws Error if the number of signatures exceeds the maximum supported, if the bitmap length is incorrect, or if the number
+     * of signatures does not match the bitmap.
+     */
     constructor(args: {
         publicKeys: Array<PublicKey>;
         signaturesRequired: number;
     });
+    /**
+     * Verifies the provided signature against the given message.
+     * This function helps ensure the integrity and authenticity of the message by checking if the signature is valid.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify.
+     */
     verifySignature(args: VerifySignatureArgs): boolean;
+    /**
+     * Generates an authentication key based on the current instance's byte representation.
+     * This key can be used for secure authentication processes within the system.
+     *
+     * @returns {AuthenticationKey} The generated authentication key.
+     */
     authKey(): AuthenticationKey;
-    toUint8Array(): Uint8Array;
+    /**
+     * Serializes the object by writing its signatures and bitmap to the provided serializer.
+     * This allows the object to be converted into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a MultiKeySignature from the provided deserializer.
+     * This function retrieves the signatures and bitmap necessary for creating a MultiKeySignature object.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     */
     static deserialize(deserializer: Deserializer): MultiKey;
     /**
      * Create a bitmap that holds the mapping from the original public keys
@@ -51,11 +90,24 @@ declare class MultiKey extends AccountPublicKey {
     /**
      * Get the index of the provided public key.
      *
-     * @param publicKey array of the index mapping to the matching public keys
-     * @returns the corresponding index of the publicKey, if it exists
+     * This function retrieves the index of a specified public key within the MultiKey.
+     * If the public key does not exist, it throws an error.
+     *
+     * @param publicKey - The public key to find the index for.
+     * @returns The corresponding index of the public key, if it exists.
+     * @throws Error - If the public key is not found in the MultiKey.
      */
     getIndex(publicKey: PublicKey): number;
+    static isInstance(value: PublicKey): value is MultiKey;
 }
+/**
+ * Represents a multi-signature transaction using Ed25519 signatures.
+ * This class allows for the creation and management of a K-of-N multi-signature scheme,
+ * where a specified number of signatures are required to authorize a transaction.
+ *
+ * It includes functionality to validate the number of signatures against a bitmap,
+ * which indicates which public keys have signed the transaction.
+ */
 declare class MultiKeySignature extends Signature {
     /**
      * Number of bytes in the bitmap representing who signed the transaction (32-bits)
@@ -106,7 +158,6 @@ declare class MultiKeySignature extends Signature {
     static createBitmap(args: {
         bits: number[];
     }): Uint8Array;
-    toUint8Array(): Uint8Array;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): MultiKeySignature;
 }

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

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-HHGJXVAE.mjs";import"../../chunk-GMBSQDPO.mjs";import"../../chunk-GDO6Q2FI.mjs";import"../../chunk-BA4RBST6.mjs";import"../../chunk-G5XLMQ5E.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import"../../chunk-F63E4CR7.mjs";import"../../chunk-GWSDIX6C.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-YU3IYJRL.mjs";import"../../chunk-CRA2MFJC.mjs";import"../../chunk-XMW65WCQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UAEODDZS.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as MultiKey,b as MultiKeySignature};
+import{a,b}from"../../chunk-6AGTDRNM.mjs";import"../../chunk-S3FVA55H.mjs";import"../../chunk-DZJXOL64.mjs";import"../../chunk-37UZKMJI.mjs";import"../../chunk-5CCHECTE.mjs";import"../../chunk-ONBFUPEC.mjs";import"../../chunk-XHCALZ7X.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-WSVOJSAC.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-OLPI7QAH.mjs";import"../../chunk-WOOH5MMX.mjs";import"../../chunk-CRL4WGOH.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4CDDWSKZ.mjs";import"../../chunk-LEKBJ2EG.mjs";import"../../chunk-GQABU3RQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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-UI3AKMZX.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J245N3XF.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as MultiKey,b as MultiKeySignature};
 //# sourceMappingURL=multiKey.mjs.map

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

@@ -1,18 +1,48 @@
 /**
- * Hashes a string to a field element via poseidon
+ * Hashes a string to a field element via Poseidon hashing.
+ * This function is useful for converting a string into a fixed-size hash that can be used in cryptographic applications.
  *
- * @returns bigint result of the hash
+ * @param str - The string to be hashed.
+ * @param maxSizeBytes - The maximum size in bytes for the resulting hash.
+ * @returns bigint - The result of the hash.
  */
 declare function hashStrToField(str: string, maxSizeBytes: number): bigint;
+/**
+ * Pads and packs the given byte array to a specified maximum size and appends its length.
+ * This function ensures that the byte array does not exceed the maximum size, throwing an error if it does.
+ * It is useful for preparing byte data for further processing or transmission by ensuring a consistent format.
+ *
+ * @param bytes - The byte array to be padded and packed.
+ * @param maxSizeBytes - The maximum allowed size for the byte array.
+ * @throws Error if the length of the input bytes exceeds the maximum size.
+ * @returns A new Uint8Array that contains the padded and packed bytes along with the length of the original byte array.
+ */
 declare function padAndPackBytesWithLen(bytes: Uint8Array, maxSizeBytes: number): bigint[];
+/**
+ * Converts a little-endian byte array into a BigInt.
+ * This function is useful for interpreting byte data as a numerical value in a way that respects the little-endian format.
+ *
+ * @param bytes - The byte array to convert.
+ * @returns The resulting BigInt representation of the byte array.
+ */
 declare function bytesToBigIntLE(bytes: Uint8Array): bigint;
-declare function bigIntToBytesLE(value: bigint | number, length: number): Uint8Array;
 /**
- * Hashes up to 16 scalar elements via the poseidon hashing algorithm.
+ * Converts a bigint value into a little-endian byte array of a specified length.
+ * This function is useful for representing large integers in a byte format, which is often required for cryptographic operations
+ * or binary data manipulation.
  *
+ * @param value - The number to convert into bytes.
+ * @param length - The desired length of the resulting byte array.
+ * @returns A Uint8Array containing the little-endian representation of the bigint value.
+ */
+declare function bigIntToBytesLE(value: bigint | number, length: number): Uint8Array;
+/**
+ * Hashes up to 16 scalar elements via the Poseidon hashing algorithm.
  * Each element must be scalar fields of the BN254 elliptic curve group.
  *
- * @returns bigint result of the hash
+ * @param inputs - An array of elements to be hashed, which can be of type number, bigint, or string.
+ * @returns bigint - The result of the hash.
+ * @throws Error - Throws an error if the input length exceeds the maximum allowed.
  */
 declare function poseidonHash(inputs: (number | bigint | string)[]): bigint;
 

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

@@ -1,2 +1,2 @@
-import{a,b,c,d,e}from"../../chunk-SRPI2FFA.mjs";import"../../chunk-FVA2OPG4.mjs";export{d as bigIntToBytesLE,c as bytesToBigIntLE,a as hashStrToField,b as padAndPackBytesWithLen,e as poseidonHash};
+import{a,b,c,d,e}from"../../chunk-GMKKHGXK.mjs";import"../../chunk-KDMSOCZY.mjs";export{d as bigIntToBytesLE,c as bytesToBigIntLE,a as hashStrToField,b as padAndPackBytesWithLen,e as poseidonHash};
 //# sourceMappingURL=poseidon.mjs.map

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

@@ -1,5 +1,5 @@
 import { HexInput } from '../../types/index.mjs';
-import { P as PublicKey } from '../../publicKey-B3XRNhHO.mjs';
+import { P as PublicKey } from '../../publicKey-_tPa99ea.mjs';
 import { Signature } from './signature.mjs';
 import '../../utils/apiEndpoints.mjs';
 import '../../types/indexer.mjs';
@@ -13,17 +13,21 @@ import '../../bcs/deserializer.mjs';
 import '../../transactions/instances/transactionArgument.mjs';
 
 /**
- * An abstract representation of a private key.
- * It is associated to a signature scheme and provides signing capabilities.
+ * Represents a private key used for signing messages and deriving the associated public key.
+ *
+ * @method sign - Signs the given message with the private key.
+ * @method publicKey - Derives the public key associated with the private key.
+ * @method toUint8Array - Retrieves the private key in bytes.
  */
 interface PrivateKey {
     /**
-     * Sign the given message with the private key.
-     * @param message in HexInput format
+     * Sign the given message with the private key to create a signature.
+     * @param message - The message to be signed, provided in HexInput format.
+     * @returns A Signature object representing the signed message.
      */
     sign(message: HexInput): Signature;
     /**
-     * Derive the public key associated with the private key
+     * Derive the public key associated with the private key.
      */
     publicKey(): PublicKey;
     /**

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

@@ -8,14 +8,10 @@ import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 
 /**
- * An abstract representation of a crypto proof.
- * associated to a specific zero knowledge proof schemes e.g. Groth16, PLONK
+ * An abstract representation of a cryptographic proof associated with specific
+ * zero-knowledge proof schemes, such as Groth16 and PLONK.
  */
 declare abstract class Proof extends Serializable {
-    /**
-     * Get the proof as a hex string with a 0x prefix e.g. 0x123456...
-     */
-    toString(): string;
 }
 
 export { Proof };

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

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-MQGW234H.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as Proof};
+import{a}from"../../chunk-ONBFUPEC.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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 Proof};
 //# sourceMappingURL=proof.mjs.map

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

@@ -1,6 +1,6 @@
 import '../../types/index.mjs';
 import '../../bcs/serializer.mjs';
-export { a as AccountPublicKey, P as PublicKey, V as VerifySignatureArgs } from '../../publicKey-B3XRNhHO.mjs';
+export { a as AccountPublicKey, P as PublicKey, V as VerifySignatureArgs } from '../../publicKey-_tPa99ea.mjs';
 import './signature.mjs';
 import '../../utils/apiEndpoints.mjs';
 import '../../types/indexer.mjs';

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

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-76OH2Z4Q.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{b as AccountPublicKey,a as PublicKey};
+import{a,b}from"../../chunk-4OV7QU2U.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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 AccountPublicKey,a as PublicKey};
 //# sourceMappingURL=publicKey.mjs.map

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

@@ -2,7 +2,7 @@ import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer, Serializable } from '../../bcs/serializer.mjs';
 import { HexInput } from '../../types/index.mjs';
 import { PrivateKey } from './privateKey.mjs';
-import { P as PublicKey, V as VerifySignatureArgs } from '../../publicKey-B3XRNhHO.mjs';
+import { P as PublicKey, V as VerifySignatureArgs } from '../../publicKey-_tPa99ea.mjs';
 import { Signature } from './signature.mjs';
 import '../../utils/apiEndpoints.mjs';
 import '../../types/indexer.mjs';
@@ -14,37 +14,73 @@ import '../accountAddress.mjs';
 import '../../transactions/instances/transactionArgument.mjs';
 
 /**
- * Represents the Secp256k1 ecdsa public key
+ * Represents a Secp256k1 ECDSA public key.
  *
- * Secp256k1 authentication key is represented in the SDK as `AnyPublicKey`.
+ * @extends PublicKey
+ * @static
+ * @property LENGTH - The length of the Secp256k1 public key in bytes.
  */
 declare class Secp256k1PublicKey extends PublicKey {
     static readonly LENGTH: number;
     private readonly key;
     /**
-     * Create a new PublicKey instance from a Uint8Array or String.
+     * Create a new PublicKey instance from a HexInput, which can be a string or Uint8Array.
+     * This constructor validates the length of the provided signature data.
      *
-     * @param hexInput A HexInput (string or Uint8Array)
+     * @param hexInput - A HexInput (string or Uint8Array) representing the signature data.
+     * @throws Error if the length of the signature data is not equal to Secp256k1Signature.LENGTH.
      */
     constructor(hexInput: HexInput);
     /**
-     * Verifies a Secp256k1 signature against the public key
+     * Verifies a Secp256k1 signature against the public key.
+     *
+     * This function checks the validity of a signature for a given message, ensuring that the signature is canonical as a malleability check.
      *
-     * Note signatures are validated to be canonical as a malleability check
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify against the public key.
      */
     verifySignature(args: VerifySignatureArgs): boolean;
+    /**
+     * Get the data as a Uint8Array representation.
+     *
+     * @returns Uint8Array representation of the data.
+     */
     toUint8Array(): Uint8Array;
+    /**
+     * Serializes the data into a byte array using the provided serializer.
+     * This function is essential for converting data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to convert the data.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a Secp256k1Signature from the provided deserializer.
+     * This function allows you to reconstruct a Secp256k1Signature object from its serialized byte representation.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     */
+    deserialize(deserializer: Deserializer): Secp256k1Signature;
     static deserialize(deserializer: Deserializer): Secp256k1PublicKey;
     /**
+     * Determine if the provided public key is an instance of Secp256k1PublicKey.
+     *
      * @deprecated use `instanceof Secp256k1PublicKey` instead
-     * @param publicKey
+     * @param publicKey - The public key to check.
      */
     static isPublicKey(publicKey: PublicKey): publicKey is Secp256k1PublicKey;
+    /**
+     * Determines if the provided public key is a valid instance of a Secp256k1 public key.
+     * This function checks for the presence of a "key" property and validates the length of the key data.
+     *
+     * @param publicKey - The public key to validate.
+     * @returns A boolean indicating whether the public key is a valid Secp256k1 public key.
+     */
     static isInstance(publicKey: PublicKey): publicKey is Secp256k1PublicKey;
 }
 /**
- * A Secp256k1 ecdsa private key
+ * Represents a Secp256k1 ECDSA private key, providing functionality to create, sign messages,
+ * derive public keys, and serialize/deserialize the key.
  */
 declare class Secp256k1PrivateKey extends Serializable implements PrivateKey {
     /**
@@ -65,41 +101,42 @@ declare class Secp256k1PrivateKey extends Serializable implements PrivateKey {
     /**
      * Generate a new random private key.
      *
-     * @returns Secp256k1PrivateKey
+     * @returns Secp256k1PrivateKey - A newly generated Secp256k1 private key.
      */
     static generate(): Secp256k1PrivateKey;
     /**
-     * Derives a private key from a mnemonic seed phrase.
+     * Derives a private key from a mnemonic seed phrase using a specified BIP44 path.
+     *
+     * @param path - The BIP44 path to derive the key from.
+     * @param mnemonics - The mnemonic seed phrase used for key generation.
      *
-     * @param path the BIP44 path
-     * @param mnemonics the mnemonic seed phrase
+     * @returns The generated private key.
      *
-     * @returns The generated key
+     * @throws Error if the provided path is not a valid BIP44 path.
      */
     static fromDerivationPath(path: string, mnemonics: string): Secp256k1PrivateKey;
     /**
-     * A private inner function so we can separate from the main fromDerivationPath() method
-     * to add tests to verify we create the keys correctly.
+     * Derives a private key from a specified BIP44 path using a given seed.
+     * This function is essential for generating keys that follow the hierarchical deterministic (HD) wallet structure.
      *
-     * @param path the BIP44 path
-     * @param seed the seed phrase created by the mnemonics
-     *
-     * @returns The generated key
+     * @param path - The BIP44 path used for key derivation.
+     * @param seed - The seed phrase created by the mnemonics, represented as a Uint8Array.
+     * @returns The generated private key as an instance of Secp256k1PrivateKey.
+     * @throws Error if the derived private key is invalid.
      */
     private static fromDerivationPathInner;
     /**
      * Sign the given message with the private key.
+     * This function generates a cryptographic signature for the provided message, ensuring the signature is canonical and non-malleable.
      *
-     * Note: signatures are canonical, and non-malleable
-     *
-     * @param message a message as a string or Uint8Array
-     * @returns Signature
+     * @param message - A message in HexInput format to be signed.
+     * @returns Signature - The generated signature for the provided message.
      */
     sign(message: HexInput): Secp256k1Signature;
     /**
      * Derive the Secp256k1PublicKey from this private key.
      *
-     * @returns Secp256k1PublicKey
+     * @returns Secp256k1PublicKey The derived public key.
      */
     publicKey(): Secp256k1PublicKey;
     /**
@@ -109,7 +146,7 @@ declare class Secp256k1PrivateKey extends Serializable implements PrivateKey {
      */
     toUint8Array(): Uint8Array;
     /**
-     * Get the private key as a hex string with the 0x prefix.
+     * Get the private key as a string representation.
      *
      * @returns string representation of the private key
      */
@@ -117,12 +154,20 @@ declare class Secp256k1PrivateKey extends Serializable implements PrivateKey {
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): Secp256k1PrivateKey;
     /**
+     * Determines if the provided private key is an instance of Secp256k1PrivateKey.
+     *
+     * @param privateKey - The private key to be checked.
+     *
      * @deprecated use `instanceof Secp256k1PrivateKey` instead
      */
     static isPrivateKey(privateKey: PrivateKey): privateKey is Secp256k1PrivateKey;
 }
 /**
- * A signature of a message signed using a Secp256k1 ecdsa private key
+ * Represents a signature of a message signed using a Secp256k1 ECDSA private key.
+ *
+ * @static
+ * @readonly
+ * @length The length of Secp256k1 ECDSA signatures, which is 64 bytes.
  */
 declare class Secp256k1Signature extends Signature {
     /**

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

@@ -1,2 +1,2 @@
-import{a,b,c}from"../../chunk-GDO6Q2FI.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{b as Secp256k1PrivateKey,a as Secp256k1PublicKey,c as Secp256k1Signature};
+import{a,b,c}from"../../chunk-DZJXOL64.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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 Secp256k1PrivateKey,a as Secp256k1PublicKey,c as Secp256k1Signature};
 //# sourceMappingURL=secp256k1.mjs.map

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

@@ -9,18 +9,19 @@ import '../../types/generated/types.mjs';
 
 /**
  * An abstract representation of a crypto signature,
- * associated to a specific signature scheme e.g. Ed25519 or Secp256k1
+ * associated with a specific signature scheme, e.g., Ed25519 or Secp256k1.
  *
- * This is the product of signing a message directly from a PrivateKey
- * and can be verified against a CryptoPublicKey.
+ * This class represents the product of signing a message directly from a
+ * PrivateKey and can be verified against a CryptoPublicKey.
  */
 declare abstract class Signature extends Serializable {
     /**
      * Get the raw signature bytes
      */
-    abstract toUint8Array(): Uint8Array;
+    toUint8Array(): Uint8Array;
     /**
      * Get the signature as a hex string with a 0x prefix e.g. 0x123456...
+     * @returns The hex string representation of the signature.
      */
     toString(): string;
 }

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

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-MLDQ2TY2.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as Signature};
+import{a}from"../../chunk-IBLZ6MZU.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.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 Signature};
 //# sourceMappingURL=signature.mjs.map