npm - @aptos-labs/ts-sdk - Versions diffs - 1.29.0-zeta.0 → 1.29.0-zeta.2 - Mend

@aptos-labs/ts-sdk 1.29.0-zeta.0 → 1.29.0-zeta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1006) hide show

package/dist/esm/core/crypto/keyless.d.mts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { a as AccountPublicKey, A as AuthenticationKey, P as PublicKey } from '../../publicKey-B3XRNhHO.mjs';
+import { a as AccountPublicKey, A as AuthenticationKey, P as PublicKey } from '../../publicKey-_tPa99ea.mjs';
 import { Signature } from './signature.mjs';
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer, Serializable } from '../../bcs/serializer.mjs';
@@ -26,9 +26,12 @@ declare const MAX_EXTRA_FIELD_BYTES = 350;
 declare const MAX_JWT_HEADER_B64_BYTES = 300;
 declare const MAX_COMMITED_EPK_BYTES = 93;
 /**
- * Represents the KeylessPublicKey public key
+ * Represents a Keyless Public Key used for authentication.
  *
- * KeylessPublicKey authentication key is represented in the SDK as `AnyPublicKey`.
+ * This class encapsulates the public key functionality for keyless authentication,
+ * including methods for generating and verifying signatures, as well as serialization
+ * and deserialization of the key. The KeylessPublicKey is represented in the SDK
+ * as `AnyPublicKey`.
  */
 declare class KeylessPublicKey extends AccountPublicKey {
     /**
@@ -45,39 +48,71 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * It is calculated from the aud, uidKey, uidVal, pepper.
      */
     readonly idCommitment: Uint8Array;
-    constructor(iss: string, idCommitment: HexInput);
     /**
-     * Get the authentication key for the keyless public key
+     * Constructs an instance with the specified parameters for cryptographic operations.
      *
-     * @returns AuthenticationKey
-     */
-    authKey(): AuthenticationKey;
-    /**
-     * Get the public key in bytes (Uint8Array).
-     *
-     * @returns Uint8Array representation of the public key
+     * @param args - The parameters required to initialize the instance.
+     * @param args.alphaG1 - The hex representation of the alpha G1 value.
+     * @param args.betaG2 - The hex representation of the beta G2 value.
+     * @param args.deltaG2 - The hex representation of the delta G2 value.
+     * @param args.gammaAbcG1 - An array containing two hex representations for gamma ABC G1 values.
+     * @param args.gammaG2 - The hex representation of the gamma G2 value.
      */
-    toUint8Array(): Uint8Array;
+    constructor(iss: string, idCommitment: HexInput);
     /**
-     * Get the public key as a hex string with the 0x prefix.
+     * Get the authentication key for the keyless public key.
      *
-     * @returns string representation of the public key
+     * @returns AuthenticationKey - The authentication key derived from the keyless public key.
      */
-    toString(): string;
+    authKey(): AuthenticationKey;
     /**
-     * Verifies a signed data with a public key
+     * Verifies the validity of a signature for a given message.
      *
-     * @param args.message message
-     * @param args.signature The signature
-     * @returns true if the signature is valid
+     * @param args - The arguments for signature verification.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify against the message.
+     * @returns true if the signature is valid; otherwise, false.
      */
     verifySignature(args: {
         message: HexInput;
         signature: KeylessSignature;
     }): boolean;
+    /**
+     * Serializes the current instance into a format suitable for transmission or storage.
+     * This function ensures that all relevant fields are properly serialized, including the proof and optional fields.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @param serializer.proof - The proof to be serialized.
+     * @param serializer.expHorizonSecs - The expiration horizon in seconds.
+     * @param serializer.extraField - An optional additional field for serialization.
+     * @param serializer.overrideAudVal - An optional override value for auditing.
+     * @param serializer.trainingWheelsSignature - An optional signature for training wheels.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a ZeroKnowledgeSig object from the provided deserializer.
+     * This function allows you to reconstruct a ZeroKnowledgeSig instance from its serialized form.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @returns A new instance of ZeroKnowledgeSig.
+     */
     static deserialize(deserializer: Deserializer): KeylessPublicKey;
+    /**
+     * Loads a KeylessPublicKey instance from the provided deserializer.
+     * This function is used to deserialize the necessary components to create a KeylessPublicKey.
+     *
+     * @param deserializer - The deserializer used to extract the string and byte data.
+     * @param deserializer.deserializeStr - A method to deserialize a string value.
+     * @param deserializer.deserializeBytes - A method to deserialize byte data.
+     * @returns A new instance of KeylessPublicKey.
+     */
     static load(deserializer: Deserializer): KeylessPublicKey;
+    /**
+     * Determines if the provided public key is an instance of KeylessPublicKey.
+     *
+     * @param publicKey - The public key to check.
+     * @returns A boolean indicating whether the public key is a KeylessPublicKey instance.
+     */
     static isPublicKey(publicKey: PublicKey): publicKey is KeylessPublicKey;
     /**
      * Creates a KeylessPublicKey from the JWT components plus pepper
@@ -96,19 +131,35 @@ declare class KeylessPublicKey extends AccountPublicKey {
         aud: string;
         pepper: HexInput;
     }): KeylessPublicKey;
+    /**
+     * Creates a KeylessPublicKey instance from a JWT and a pepper value.
+     * This function is useful for generating a public key that can be used for authentication based on the provided JWT claims and pepper.
+     *
+     * @param args - The arguments for creating the KeylessPublicKey.
+     * @param args.jwt - The JSON Web Token to decode.
+     * @param args.pepper - The pepper value used in the key creation process.
+     * @param args.uidKey - An optional key to retrieve the unique identifier from the JWT payload, defaults to "sub".
+     * @returns A KeylessPublicKey instance created from the provided JWT and pepper.
+     */
     static fromJwtAndPepper(args: {
         jwt: string;
         pepper: HexInput;
         uidKey?: string;
     }): KeylessPublicKey;
+    /**
+     * Checks if the provided public key is a valid instance by verifying its structure and types.
+     *
+     * @param publicKey - The public key to validate.
+     * @returns A boolean indicating whether the public key is a valid instance.
+     */
     static isInstance(publicKey: PublicKey): boolean;
 }
 /**
- * A signature of a message signed via Keyless Accounnt that uses proofs or the jwt token to authenticate.
+ * Represents a signature of a message signed via a Keyless Account, utilizing proofs or a JWT token for authentication.
  */
 declare class KeylessSignature extends Signature {
     /**
-     * The inner signature ZeroKnowledgeSigniature or OpenIdSignature
+     * The inner signature ZeroKnowledgeSignature or OpenIdSignature
      */
     readonly ephemeralCertificate: EphemeralCertificate;
     /**
@@ -134,19 +185,16 @@ declare class KeylessSignature extends Signature {
         ephemeralPublicKey: EphemeralPublicKey;
         ephemeralSignature: EphemeralSignature;
     });
-    /**
-     * Get the signature in bytes (Uint8Array).
-     *
-     * @returns Uint8Array representation of the signature
-     */
-    toUint8Array(): Uint8Array;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): KeylessSignature;
     static getSimulationSignature(): KeylessSignature;
     static isSignature(signature: Signature): signature is KeylessSignature;
 }
 /**
- * A container for a signature that is a ZeroKnowledgeSig.  Can be expanded to support OpenIdSignature.
+ * Represents an ephemeral certificate containing a signature, specifically a ZeroKnowledgeSig.
+ * This class can be extended to support additional signature types, such as OpenIdSignature.
+ *
+ * @extends Signature
  */
 declare class EphemeralCertificate extends Signature {
     readonly signature: Signature;
@@ -164,12 +212,24 @@ declare class EphemeralCertificate extends Signature {
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): EphemeralCertificate;
 }
+/**
+ * Represents a fixed-size byte array of 32 bytes, extending the Serializable class.
+ * This class is used for handling and serializing G1 bytes in cryptographic operations.
+ *
+ * @extends Serializable
+ */
 declare class G1Bytes extends Serializable {
     data: Uint8Array;
     constructor(data: HexInput);
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): G1Bytes;
 }
+/**
+ * Represents a 64-byte G2 element in a cryptographic context.
+ * This class provides methods for serialization and deserialization of G2 bytes.
+ *
+ * @extends Serializable
+ */
 declare class G2Bytes extends Serializable {
     data: Uint8Array;
     constructor(data: HexInput);
@@ -177,7 +237,10 @@ declare class G2Bytes extends Serializable {
     static deserialize(deserializer: Deserializer): G2Bytes;
 }
 /**
- * A representation of a Groth16 proof.  The points are the compressed serialization of affine reprentation of the proof.
+ * Represents a Groth16 zero-knowledge proof, consisting of three proof points in compressed serialization format.
+ * The points are the compressed serialization of affine representation of the proof.
+ *
+ * @extends Proof
  */
 declare class Groth16Zkp extends Proof {
     /**
@@ -201,7 +264,9 @@ declare class Groth16Zkp extends Proof {
     static deserialize(deserializer: Deserializer): Groth16Zkp;
 }
 /**
- * A container for a different zero knowledge proof types
+ * Represents a container for different types of zero-knowledge proofs.
+ *
+ * @extends Serializable
  */
 declare class ZkProof extends Serializable {
     readonly proof: Proof;
@@ -214,7 +279,9 @@ declare class ZkProof extends Serializable {
     static deserialize(deserializer: Deserializer): ZkProof;
 }
 /**
- * The signature representation of a proof
+ * Represents a zero-knowledge signature, encapsulating the proof and its associated metadata.
+ *
+ * @extends Signature
  */
 declare class ZeroKnowledgeSig extends Signature {
     /**
@@ -246,22 +313,21 @@ declare class ZeroKnowledgeSig extends Signature {
         trainingWheelsSignature?: EphemeralSignature;
     });
     /**
-     * Get the signature in bytes (Uint8Array).
-     *
-     * @returns Uint8Array representation of the signature
-     */
-    toUint8Array(): Uint8Array;
-    /**
-     * Return a ZeroKnowledgeSig object from its bcs serialization in bytes.
+     * Deserialize a ZeroKnowledgeSig object from its BCS serialization in bytes.
      *
-     * @returns ZeroKnowledgeSig
+     * @param bytes - The bytes representing the serialized ZeroKnowledgeSig.
+     * @returns ZeroKnowledgeSig - The deserialized ZeroKnowledgeSig object.
      */
     static fromBytes(bytes: Uint8Array): ZeroKnowledgeSig;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): ZeroKnowledgeSig;
 }
 /**
- * A class which represents the on-chain configuration for how Keyless accounts work
+ * Represents the on-chain configuration for how Keyless accounts operate.
+ *
+ * @remarks
+ * This class encapsulates the verification key and the maximum lifespan of ephemeral key pairs,
+ * which are essential for the functionality of Keyless accounts.
  */
 declare class KeylessConfiguration {
     /**
@@ -276,7 +342,7 @@ declare class KeylessConfiguration {
     static create(res: Groth16VerificationKeyResponse, maxExpHorizonSecs: number): KeylessConfiguration;
 }
 /**
- * A representation of the verification key stored on chain used to verify Groth16 proofs
+ * Represents the verification key stored on-chain used to verify Groth16 proofs.
  */
 declare class Groth16VerificationKey {
     /**
@@ -306,13 +372,28 @@ declare class Groth16VerificationKey {
         gammaAbcG1: [HexInput, HexInput];
         gammaG2: HexInput;
     });
+    /**
+     * Converts a Groth16VerificationKeyResponse object into a Groth16VerificationKey instance.
+     *
+     * @param res - The Groth16VerificationKeyResponse object containing the verification key data.
+     * @param res.alpha_g1 - The alpha G1 value from the response.
+     * @param res.beta_g2 - The beta G2 value from the response.
+     * @param res.delta_g2 - The delta G2 value from the response.
+     * @param res.gamma_abc_g1 - The gamma ABC G1 value from the response.
+     * @param res.gamma_g2 - The gamma G2 value from the response.
+     * @returns A Groth16VerificationKey instance constructed from the provided response data.
+     */
     static fromGroth16VerificationKeyResponse(res: Groth16VerificationKeyResponse): Groth16VerificationKey;
 }
 /**
- * Gets the parameters of how Keyless Accounts are configured on chain including the verifying key and the max expiry horizon
+ * Retrieves the configuration parameters for Keyless Accounts on the blockchain, including the verifying key and the maximum
+ * expiry horizon.
  *
- * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
- * @returns KeylessConfiguration
+ * @param args - The arguments for retrieving the keyless configuration.
+ * @param args.aptosConfig - The Aptos configuration object containing network details.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.ledgerVersion - The ledger version to query; if not provided, the latest version will be used.
+ * @returns KeylessConfiguration - The configuration object containing the verifying key and maximum expiry horizon.
  */
 declare function getKeylessConfig(args: {
     aptosConfig: AptosConfig;

package/dist/esm/core/crypto/keyless.mjs CHANGED Viewed

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p}from"../../chunk-6VJ3HRHN.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import"../../chunk-VDSDMO5B.mjs";import"../../chunk-OGX4PXYG.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-3RBIEWVC.mjs";import"../../chunk-SS4IPKAI.mjs";import"../../chunk-E6O72G24.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-QQU4IQ27.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UAEODDZS.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as EPK_HORIZON_SECS,k as EphemeralCertificate,l as Groth16Zkp,o as KeylessConfiguration,i as KeylessPublicKey,j as KeylessSignature,b as MAX_AUD_VAL_BYTES,h as MAX_COMMITED_EPK_BYTES,f as MAX_EXTRA_FIELD_BYTES,e as MAX_ISS_VAL_BYTES,g as MAX_JWT_HEADER_B64_BYTES,c as MAX_UID_KEY_BYTES,d as MAX_UID_VAL_BYTES,n as ZeroKnowledgeSig,m as ZkProof,p as getKeylessConfig};
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p}from"../../chunk-SV6XYAEJ.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-ONBFUPEC.mjs";import"../../chunk-S4BBYLCO.mjs";import"../../chunk-VQJIGBIR.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-VDCQU3UG.mjs";import"../../chunk-WUNJA7HN.mjs";import"../../chunk-75NUNLHW.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4CDDWSKZ.mjs";import"../../chunk-WNCWH4Z2.mjs";import"../../chunk-GQABU3RQ.mjs";import"../../chunk-J245N3XF.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-LEKBJ2EG.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-44HKW3VX.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-N47FTRYO.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as EPK_HORIZON_SECS,k as EphemeralCertificate,l as Groth16Zkp,o as KeylessConfiguration,i as KeylessPublicKey,j as KeylessSignature,b as MAX_AUD_VAL_BYTES,h as MAX_COMMITED_EPK_BYTES,f as MAX_EXTRA_FIELD_BYTES,e as MAX_ISS_VAL_BYTES,g as MAX_JWT_HEADER_B64_BYTES,c as MAX_UID_KEY_BYTES,d as MAX_UID_VAL_BYTES,n as ZeroKnowledgeSig,m as ZkProof,p as getKeylessConfig};
 //# sourceMappingURL=keyless.mjs.map

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

@@ -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 CHANGED Viewed

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-XG57ULWZ.mjs";import"../../chunk-OGX4PXYG.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-QQU4IQ27.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as MultiEd25519PublicKey,b as MultiEd25519Signature};
+import{a,b}from"../../chunk-OZRUYSI3.mjs";import"../../chunk-VQJIGBIR.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-44HKW3VX.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-N47FTRYO.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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-C26X2GLF.mjs";import"../../chunk-URF3VICX.mjs";import"../../chunk-LWRYJL3W.mjs";import"../../chunk-Z7G2ODBC.mjs";import"../../chunk-6VJ3HRHN.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import"../../chunk-VDSDMO5B.mjs";import"../../chunk-OGX4PXYG.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-3RBIEWVC.mjs";import"../../chunk-SS4IPKAI.mjs";import"../../chunk-E6O72G24.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-QQU4IQ27.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.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-LVLCMN7X.mjs";import"../../chunk-6HWNCKNB.mjs";import"../../chunk-BFAYEGUQ.mjs";import"../../chunk-NOFMA27U.mjs";import"../../chunk-SV6XYAEJ.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-ONBFUPEC.mjs";import"../../chunk-S4BBYLCO.mjs";import"../../chunk-VQJIGBIR.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-VDCQU3UG.mjs";import"../../chunk-WUNJA7HN.mjs";import"../../chunk-75NUNLHW.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4CDDWSKZ.mjs";import"../../chunk-WNCWH4Z2.mjs";import"../../chunk-GQABU3RQ.mjs";import"../../chunk-J245N3XF.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-LEKBJ2EG.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-44HKW3VX.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-N47FTRYO.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as MultiKey,b as MultiKeySignature};
 //# sourceMappingURL=multiKey.mjs.map

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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;
     /**