@aptos-labs/ts-sdk 1.29.0 → 1.30.0

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

@@ -1,7 +1,7 @@
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer } from '../../bcs/serializer.mjs';
 import { EphemeralPublicKeyVariant, 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';
@@ -15,7 +15,7 @@ import '../../transactions/instances/transactionArgument.mjs';
 /**
  * Represents ephemeral public keys for Aptos Keyless accounts.
  *
- * These are not public keys used as a public key on an account.  They are only used ephemerally on Keyless accounts.
+ * These keys are used only temporarily within Keyless accounts and are not utilized as public keys for account identification.
  */
 declare class EphemeralPublicKey extends PublicKey {
     /**
@@ -26,32 +26,53 @@ declare class EphemeralPublicKey extends PublicKey {
      * An enum indicating the scheme of the ephemeral public key
      */
     readonly variant: EphemeralPublicKeyVariant;
-    constructor(publicKey: PublicKey);
     /**
-     * Get the public key in bytes (Uint8Array).
+     * Creates an instance of EphemeralPublicKey using the provided public key.
+     * This constructor ensures that only supported signature types are accepted.
      *
-     * @returns Uint8Array representation of the public key
+     * @param publicKey - The public key to be used for the ephemeral public key.
+     * @throws Error if the signature type is unsupported.
      */
-    toUint8Array(): Uint8Array;
+    constructor(publicKey: PublicKey);
     /**
-     * Verifies a signed data with a the ephemeral public key
+     * Verifies a signed message using the ephemeral public key.
      *
-     * @param args.message message
-     * @param args.signature The signature that was signed by the private key of the ephemeral public key
-     * @returns true if the signature is valid
+     * @param args - The arguments for the verification.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature that was signed by the private key of the ephemeral public key.
+     * @returns true if the signature is valid, otherwise false.
      */
     verifySignature(args: {
         message: HexInput;
         signature: EphemeralSignature;
     }): boolean;
+    /**
+     * Serializes the current instance, specifically handling the Ed25519 signature type.
+     * This function ensures that the signature is properly serialized using the provided serializer.
+     *
+     * @param serializer - The serializer instance used to serialize the signature.
+     * @throws Error if the signature type is unknown.
+     */
     serialize(serializer: Serializer): void;
+    /**
+     * Deserializes an EphemeralSignature from the provided deserializer.
+     * This function allows you to retrieve an EphemeralSignature based on the deserialized data.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     */
     static deserialize(deserializer: Deserializer): EphemeralPublicKey;
+    /**
+     * Determines if the provided public key is an instance of `EphemeralPublicKey`.
+     *
+     * @param publicKey - The public key to check.
+     * @returns A boolean indicating whether the public key is an ephemeral type.
+     */
     static isPublicKey(publicKey: PublicKey): publicKey is EphemeralPublicKey;
 }
 /**
  * Represents ephemeral signatures used in Aptos Keyless accounts.
  *
- * These signatures are used inside of KeylessSignature
+ * These signatures are utilized within the KeylessSignature framework.
  */
 declare class EphemeralSignature extends Signature {
     /**
@@ -60,11 +81,12 @@ declare class EphemeralSignature extends Signature {
     readonly signature: Signature;
     constructor(signature: Signature);
     /**
-     * Get the public key in bytes (Uint8Array).
+     * Deserializes an ephemeral signature from a hexadecimal input.
+     * This function allows you to convert a hexadecimal representation of an ephemeral signature into its deserialized form for
+     * further processing.
      *
-     * @returns Uint8Array representation of the public key
+     * @param hexInput - The hexadecimal input representing the ephemeral signature.
      */
-    toUint8Array(): Uint8Array;
     static fromHex(hexInput: HexInput): EphemeralSignature;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): EphemeralSignature;

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

@@ -1,2 +1,2 @@
-import{a,b}from"../../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-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 EphemeralPublicKey,b as EphemeralSignature};
+import{a,b}from"../../chunk-XHCALZ7X.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 EphemeralPublicKey,b as EphemeralSignature};
 //# sourceMappingURL=ephemeral.mjs.map

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

@@ -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 { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer } from '../../bcs/serializer.mjs';
 import { HexInput } from '../../types/index.mjs';
@@ -21,7 +21,7 @@ import '../../utils/const.mjs';
 /**
  * Represents the FederatedKeylessPublicKey public key
  *
- * These keys use an onchain address as a source of truth for the JWK used to verify signatures.
+ * These keys use an on-chain address as a source of truth for the JWK used to verify signatures.
  *
  * FederatedKeylessPublicKey authentication key is represented in the SDK as `AnyPublicKey`.
  */
@@ -41,18 +41,6 @@ declare class FederatedKeylessPublicKey extends AccountPublicKey {
      * @returns AuthenticationKey
      */
     authKey(): AuthenticationKey;
-    /**
-     * Get the public key in bytes (Uint8Array).
-     *
-     * @returns Uint8Array representation of the public key
-     */
-    toUint8Array(): Uint8Array;
-    /**
-     * Get the public key as a hex string with the 0x prefix.
-     *
-     * @returns string representation of the public key
-     */
-    toString(): string;
     /**
      * Verifies a signed data with a public key
      *

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

@@ -1,2 +1,2 @@
-import{a}from"../../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 FederatedKeylessPublicKey};
+import{a}from"../../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 FederatedKeylessPublicKey};
 //# sourceMappingURL=federatedKeyless.mjs.map

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

@@ -1,3 +1,6 @@
+/**
+ * Contains the derived cryptographic key as a Uint8Array.
+ */
 type DerivedKeys = {
     key: Uint8Array;
     chainCode: Uint8Array;
@@ -8,21 +11,21 @@ type DerivedKeys = {
 declare const APTOS_HARDENED_REGEX: RegExp;
 declare const APTOS_BIP44_REGEX: RegExp;
 /**
- * A list of supported key types and associated seeds
+ * Supported key types and their associated seeds.
  */
 declare enum KeyType {
     ED25519 = "ed25519 seed"
 }
 declare const HARDENED_OFFSET = 2147483648;
 /**
- * Aptos derive path is 637
- *
+ * Validate a BIP-44 derivation path string to ensure it meets the required format.
+ * This function checks if the provided path adheres to the BIP-44 standard for Secp256k1.
  * Parse and validate a path that is compliant to BIP-44 in form m/44'/637'/{account_index}'/{change_index}/{address_index}
  * for Secp256k1
  *
- * Note that for secp256k1, last two components must be non-hardened.
+ * Note that for Secp256k1, the last two components must be non-hardened.
  *
- * @param path path string (e.g. `m/44'/637'/0'/0/0`).
+ * @param path - The path string to validate (e.g. `m/44'/637'/0'/0/0`).
  */
 declare function isValidBIP44Path(path: string): boolean;
 /**
@@ -39,7 +42,7 @@ declare function isValidBIP44Path(path: string): boolean;
  * This is because the PK in Ed25519 is, more or less, computed as 𝑔𝐻(𝑠𝑘),
  * with the hash function breaking the homomorphism.
  *
- * @param path path string (e.g. `m/44'/637'/0'/0'/0'`).
+ * @param path - The derivation path string to validate (e.g. `m/44'/637'/0'/0'/0'`).
  */
 declare function isValidHardenedPath(path: string): boolean;
 declare const deriveKey: (hashSeed: Uint8Array | string, data: Uint8Array | string) => DerivedKeys;

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

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-LR65XHSF.mjs";import"../../chunk-FVA2OPG4.mjs";export{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,h as CKDPriv,d as HARDENED_OFFSET,c as KeyType,g as deriveKey,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,i as splitPath};
+import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-PHP47DI4.mjs";import"../../chunk-KDMSOCZY.mjs";export{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,h as CKDPriv,d as HARDENED_OFFSET,c as KeyType,g as deriveKey,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,i as splitPath};
 //# sourceMappingURL=hdKey.mjs.map

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

@@ -7,7 +7,7 @@ export { FederatedKeylessPublicKey } from './federatedKeyless.mjs';
 export { EPK_HORIZON_SECS, EphemeralCertificate, Groth16Zkp, KeylessConfiguration, KeylessPublicKey, KeylessSignature, MAX_AUD_VAL_BYTES, MAX_COMMITED_EPK_BYTES, MAX_EXTRA_FIELD_BYTES, MAX_ISS_VAL_BYTES, MAX_JWT_HEADER_B64_BYTES, MAX_UID_KEY_BYTES, MAX_UID_VAL_BYTES, ZeroKnowledgeSig, ZkProof, getKeylessConfig } from './keyless.mjs';
 export { bigIntToBytesLE, bytesToBigIntLE, hashStrToField, padAndPackBytesWithLen, poseidonHash } from './poseidon.mjs';
 export { PrivateKey } from './privateKey.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';
 export { Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature } from './secp256k1.mjs';
 export { Signature } from './signature.mjs';
 export { AnyPublicKey, AnySignature } from './singleKey.mjs';

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

@@ -1,2 +1,2 @@
-import"../../chunk-HEZ2ZYZA.mjs";import{a as r,b as s}from"../../chunk-45IUUCAV.mjs";import{a as W,b as X}from"../../chunk-HHGJXVAE.mjs";import{a as U,b as V}from"../../chunk-GMBSQDPO.mjs";import"../../chunk-KUX6GQ2E.mjs";import{a as t,b as u,c as v}from"../../chunk-GDO6Q2FI.mjs";import{a as T}from"../../chunk-BA4RBST6.mjs";import{a as D,b as E,c as F,d as G,e as H,f as I,g as J,h as K,i as L,j as M,k as N,l as O,m as P,n as Q,o as R,p as S}from"../../chunk-G5XLMQ5E.mjs";import{a as y,b as z,c as A,d as B,e as C}from"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import{a as w,b as x}from"../../chunk-F63E4CR7.mjs";import{a as n,b as o,c as p,d as q}from"../../chunk-GWSDIX6C.mjs";import{a as m}from"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import{a as k,b as l}from"../../chunk-76OH2Z4Q.mjs";import{a,b,c,d,e,f,g,h,i,j}from"../../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{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,l as AccountPublicKey,U as AnyPublicKey,V as AnySignature,h as CKDPriv,D as EPK_HORIZON_SECS,p as Ed25519PrivateKey,o as Ed25519PublicKey,q as Ed25519Signature,N as EphemeralCertificate,w as EphemeralPublicKey,x as EphemeralSignature,T as FederatedKeylessPublicKey,O as Groth16Zkp,d as HARDENED_OFFSET,c as KeyType,R as KeylessConfiguration,L as KeylessPublicKey,M as KeylessSignature,E as MAX_AUD_VAL_BYTES,K as MAX_COMMITED_EPK_BYTES,I as MAX_EXTRA_FIELD_BYTES,H as MAX_ISS_VAL_BYTES,J as MAX_JWT_HEADER_B64_BYTES,F as MAX_UID_KEY_BYTES,G as MAX_UID_VAL_BYTES,r as MultiEd25519PublicKey,s as MultiEd25519Signature,W as MultiKey,X as MultiKeySignature,k as PublicKey,u as Secp256k1PrivateKey,t as Secp256k1PublicKey,v as Secp256k1Signature,m as Signature,Q as ZeroKnowledgeSig,P as ZkProof,B as bigIntToBytesLE,A as bytesToBigIntLE,g as deriveKey,S as getKeylessConfig,y as hashStrToField,n as isCanonicalEd25519Signature,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,z as padAndPackBytesWithLen,C as poseidonHash,i as splitPath};
+import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import{a as r,b as s}from"../../chunk-WIXNX7HY.mjs";import{a as W,b as X}from"../../chunk-6AGTDRNM.mjs";import{a as U,b as V}from"../../chunk-S3FVA55H.mjs";import{a as t,b as u,c as v}from"../../chunk-DZJXOL64.mjs";import{a as T}from"../../chunk-37UZKMJI.mjs";import{a as D,b as E,c as F,d as G,e as H,f as I,g as J,h as K,i as L,j as M,k as N,l as O,m as P,n as Q,o as R,p as S}from"../../chunk-5CCHECTE.mjs";import"../../chunk-ONBFUPEC.mjs";import{a as w,b as x}from"../../chunk-XHCALZ7X.mjs";import{a as y,b as z,c as A,d as B,e as C}from"../../chunk-GMKKHGXK.mjs";import{a as n,b as o,c as p,d as q}from"../../chunk-WSVOJSAC.mjs";import{a as k,b as l}from"../../chunk-4OV7QU2U.mjs";import{a as m}from"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import{a,b,c,d,e,f,g,h,i,j}from"../../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{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,l as AccountPublicKey,U as AnyPublicKey,V as AnySignature,h as CKDPriv,D as EPK_HORIZON_SECS,p as Ed25519PrivateKey,o as Ed25519PublicKey,q as Ed25519Signature,N as EphemeralCertificate,w as EphemeralPublicKey,x as EphemeralSignature,T as FederatedKeylessPublicKey,O as Groth16Zkp,d as HARDENED_OFFSET,c as KeyType,R as KeylessConfiguration,L as KeylessPublicKey,M as KeylessSignature,E as MAX_AUD_VAL_BYTES,K as MAX_COMMITED_EPK_BYTES,I as MAX_EXTRA_FIELD_BYTES,H as MAX_ISS_VAL_BYTES,J as MAX_JWT_HEADER_B64_BYTES,F as MAX_UID_KEY_BYTES,G as MAX_UID_VAL_BYTES,r as MultiEd25519PublicKey,s as MultiEd25519Signature,W as MultiKey,X as MultiKeySignature,k as PublicKey,u as Secp256k1PrivateKey,t as Secp256k1PublicKey,v as Secp256k1Signature,m as Signature,Q as ZeroKnowledgeSig,P as ZkProof,B as bigIntToBytesLE,A as bytesToBigIntLE,g as deriveKey,S as getKeylessConfig,y as hashStrToField,n as isCanonicalEd25519Signature,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,z as padAndPackBytesWithLen,C as poseidonHash,i as splitPath};
 //# sourceMappingURL=index.mjs.map

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

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

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p}from"../../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 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-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 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