@aptos-labs/ts-sdk 1.33.1 → 1.33.2-sc.0

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

@@ -1,4 +1,4 @@
-import { a as AccountPublicKey, A as AuthenticationKey, P as PublicKey } from '../../publicKey-BVXX1nVl.mjs';
+import { a as AccountPublicKey, A as AuthenticationKey, P as PublicKey } from '../../publicKey-BMtGNNLg.mjs';
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer } from '../../bcs/serializer.mjs';
 import { HexInput } from '../../types/types.mjs';
@@ -11,6 +11,7 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 import '../../transactions/instances/transactionArgument.mjs';
 import './ephemeral.mjs';
 import './proof.mjs';
@@ -24,14 +25,20 @@ import '../../utils/const.mjs';
  * 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`.
+ * @group Implementation
+ * @category Serialization
  */
 declare class FederatedKeylessPublicKey extends AccountPublicKey {
     /**
      * The address that contains the JWK set to be used for verification.
+     * @group Implementation
+     * @category Serialization
      */
     readonly jwkAddress: AccountAddress;
     /**
      * The inner public key which contains the standard Keyless public key.
+     * @group Implementation
+     * @category Serialization
      */
     readonly keylessPublicKey: KeylessPublicKey;
     constructor(jwkAddress: AccountAddressInput, keylessPublicKey: KeylessPublicKey);
@@ -39,6 +46,8 @@ declare class FederatedKeylessPublicKey extends AccountPublicKey {
      * Get the authentication key for the federated keyless public key
      *
      * @returns AuthenticationKey
+     * @group Implementation
+     * @category Serialization
      */
     authKey(): AuthenticationKey;
     /**
@@ -47,6 +56,8 @@ declare class FederatedKeylessPublicKey extends AccountPublicKey {
      * @param args.message message
      * @param args.signature The signature
      * @returns true if the signature is valid
+     * @group Implementation
+     * @category Serialization
      */
     verifySignature(args: {
         message: HexInput;
@@ -64,6 +75,8 @@ declare class FederatedKeylessPublicKey extends AccountPublicKey {
      * @param args.aud the client ID of the application
      * @param args.pepper The pepper used to maintain privacy of the account
      * @returns FederatedKeylessPublicKey
+     * @group Implementation
+     * @category Serialization
      */
     static create(args: {
         iss: string;

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

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-U3T4ZT7B.mjs";import"../../chunk-PXMNAP2Q.mjs";import"../../chunk-UGTIALNW.mjs";import"../../chunk-KCWRCWNT.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-H3C3VTHS.mjs";import"../../chunk-BUAHUVAD.mjs";import"../../chunk-MHN6XY4Z.mjs";import"../../chunk-4O5XDQDO.mjs";import"../../chunk-5B3SMBXQ.mjs";import"../../chunk-OIOGOW6I.mjs";import"../../chunk-AKIO3OIT.mjs";import"../../chunk-JNO7KPMG.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-372SLYVR.mjs";import"../../chunk-LKKI2KAP.mjs";import"../../chunk-VWGB5BHW.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-CDEYH77E.mjs";import"../../chunk-F45G3GP3.mjs";import"../../chunk-V4FKFCBL.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J7PJSK3J.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-ZMBXHMVQ.mjs";import"../../chunk-BRV3RLKW.mjs";import"../../chunk-ZMMLM6ZJ.mjs";import"../../chunk-42H7WETG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-J3E4UMBB.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-YD2BMHH7.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as FederatedKeylessPublicKey};
+import{a}from"../../chunk-NW2WUKWV.mjs";import"../../chunk-KG23XFU2.mjs";import"../../chunk-GOXRBEIJ.mjs";import"../../chunk-XJJVJOX5.mjs";import"../../chunk-T6NQDM7D.mjs";import"../../chunk-XGF7UNEW.mjs";import"../../chunk-EMURYYVO.mjs";import"../../chunk-WCMW2L3P.mjs";import"../../chunk-DPW6ELCQ.mjs";import"../../chunk-C3Q23D22.mjs";import"../../chunk-ROT6S6BM.mjs";import"../../chunk-FN4C3CKC.mjs";import"../../chunk-Q4C4U6I4.mjs";import"../../chunk-YOZBVVKL.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SZRZ3HIL.mjs";import"../../chunk-FKJ3GCBI.mjs";import"../../chunk-CNCRJ56P.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4YLUM62M.mjs";import"../../chunk-QHEKBHNU.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-TOBQ5UE6.mjs";import"../../chunk-MT2RJ7H3.mjs";import"../../chunk-N4VVDQA5.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-XTOIL6MB.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-DAFSKSZ5.mjs";import"../../chunk-4RXKALLC.mjs";import"../../chunk-RJ7F4JDV.mjs";import"../../chunk-AIABPCUF.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as FederatedKeylessPublicKey};
 //# sourceMappingURL=federatedKeyless.mjs.map

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

@@ -1,5 +1,7 @@
 /**
  * Contains the derived cryptographic key as a Uint8Array.
+ * @group Implementation
+ * @category Serialization
  */
 type DerivedKeys = {
     key: Uint8Array;
@@ -7,15 +9,27 @@ type DerivedKeys = {
 };
 /**
  * Aptos derive path is 637
+ * @group Implementation
+ * @category Serialization
  */
 declare const APTOS_HARDENED_REGEX: RegExp;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const APTOS_BIP44_REGEX: RegExp;
 /**
  * Supported key types and their associated seeds.
+ * @group Implementation
+ * @category Serialization
  */
 declare enum KeyType {
     ED25519 = "ed25519 seed"
 }
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const HARDENED_OFFSET = 2147483648;
 /**
  * Validate a BIP-44 derivation path string to ensure it meets the required format.
@@ -26,6 +40,8 @@ declare const HARDENED_OFFSET = 2147483648;
  * Note that for Secp256k1, the last two components must be non-hardened.
  *
  * @param path - The path string to validate (e.g. `m/44'/637'/0'/0/0`).
+ * @group Implementation
+ * @category Serialization
  */
 declare function isValidBIP44Path(path: string): boolean;
 /**
@@ -43,24 +59,36 @@ declare function isValidBIP44Path(path: string): boolean;
  * with the hash function breaking the homomorphism.
  *
  * @param path - The derivation path string to validate (e.g. `m/44'/637'/0'/0'/0'`).
+ * @group Implementation
+ * @category Serialization
  */
 declare function isValidHardenedPath(path: string): boolean;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const deriveKey: (hashSeed: Uint8Array | string, data: Uint8Array | string) => DerivedKeys;
 /**
  * Derive a child key from the private key
  * @param key
  * @param chainCode
  * @param index
+ * @group Implementation
+ * @category Serialization
  */
 declare const CKDPriv: ({ key, chainCode }: DerivedKeys, index: number) => DerivedKeys;
 /**
  * Splits derive path into segments
  * @param path
+ * @group Implementation
+ * @category Serialization
  */
 declare const splitPath: (path: string) => Array<string>;
 /**
  * Normalizes the mnemonic by removing extra whitespace and making it lowercase
  * @param mnemonic the mnemonic seed phrase
+ * @group Implementation
+ * @category Serialization
  */
 declare const mnemonicToSeed: (mnemonic: string) => Uint8Array;
 

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

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-OIOGOW6I.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};
+import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-C3Q23D22.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,16 +7,17 @@ export { FederatedKeylessPublicKey } from './federatedKeyless.mjs';
 export { EPK_HORIZON_SECS, EphemeralCertificate, Groth16VerificationKey, 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, MoveJWK, ZeroKnowledgeSig, ZkProof, getIssAudAndUidVal, getKeylessConfig, getKeylessJWKs, parseJwtHeader } 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-BVXX1nVl.mjs';
+export { a as AccountPublicKey, P as PublicKey, V as VerifySignatureArgs } from '../../publicKey-BMtGNNLg.mjs';
 export { Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature } from './secp256k1.mjs';
 export { Signature } from './signature.mjs';
-export { AnyPublicKey, AnySignature } from './singleKey.mjs';
+export { AnyPublicKey, AnySignature, PrivateKeyInput } from './singleKey.mjs';
 import '../../bcs/deserializer.mjs';
 import '../../types/types.mjs';
 import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 import '../../bcs/serializer.mjs';
 import '../hex.mjs';
 import '../common.mjs';

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

@@ -1,2 +1,2 @@
-import"../../chunk-HEZ2ZYZA.mjs";import{a as s,b as t}from"../../chunk-XZN344G4.mjs";import{a as aa,b as ba}from"../../chunk-TCXYTPUR.mjs";import{a as _,b as $}from"../../chunk-JMPHD4BP.mjs";import{a as u,b as v,c as w}from"../../chunk-7N7FEBZA.mjs";import{a as Z}from"../../chunk-U3T4ZT7B.mjs";import{a as E,b as F,c as G,d as H,e as I,f as J,g as K,h as L,i as M,j as N,k as O,l as P,m as Q,n as R,o as S,p as T,q as U,r as V,s as W,t as X,u as Y}from"../../chunk-PXMNAP2Q.mjs";import"../../chunk-UGTIALNW.mjs";import{a as x,b as y}from"../../chunk-KCWRCWNT.mjs";import{a as z,b as A,c as B,d as C,e as D}from"../../chunk-GMKKHGXK.mjs";import{a as o,b as p,c as q,d as r}from"../../chunk-H3C3VTHS.mjs";import{a as k}from"../../chunk-BUAHUVAD.mjs";import{a as l,b as m}from"../../chunk-MHN6XY4Z.mjs";import{a as n}from"../../chunk-4O5XDQDO.mjs";import"../../chunk-5B3SMBXQ.mjs";import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-OIOGOW6I.mjs";import"../../chunk-AKIO3OIT.mjs";import"../../chunk-JNO7KPMG.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-372SLYVR.mjs";import"../../chunk-LKKI2KAP.mjs";import"../../chunk-VWGB5BHW.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-CDEYH77E.mjs";import"../../chunk-F45G3GP3.mjs";import"../../chunk-V4FKFCBL.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J7PJSK3J.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-ZMBXHMVQ.mjs";import"../../chunk-BRV3RLKW.mjs";import"../../chunk-ZMMLM6ZJ.mjs";import"../../chunk-42H7WETG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-J3E4UMBB.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-YD2BMHH7.mjs";import"../../chunk-KDMSOCZY.mjs";export{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,m as AccountPublicKey,_ as AnyPublicKey,$ as AnySignature,h as CKDPriv,E as EPK_HORIZON_SECS,q as Ed25519PrivateKey,p as Ed25519PublicKey,r as Ed25519Signature,O as EphemeralCertificate,x as EphemeralPublicKey,y as EphemeralSignature,Z as FederatedKeylessPublicKey,T as Groth16VerificationKey,P as Groth16Zkp,d as HARDENED_OFFSET,c as KeyType,S as KeylessConfiguration,M as KeylessPublicKey,N as KeylessSignature,F as MAX_AUD_VAL_BYTES,L as MAX_COMMITED_EPK_BYTES,J as MAX_EXTRA_FIELD_BYTES,I as MAX_ISS_VAL_BYTES,K as MAX_JWT_HEADER_B64_BYTES,G as MAX_UID_KEY_BYTES,H as MAX_UID_VAL_BYTES,X as MoveJWK,s as MultiEd25519PublicKey,t as MultiEd25519Signature,aa as MultiKey,ba as MultiKeySignature,k as PrivateKey,l as PublicKey,v as Secp256k1PrivateKey,u as Secp256k1PublicKey,w as Secp256k1Signature,n as Signature,R as ZeroKnowledgeSig,Q as ZkProof,C as bigIntToBytesLE,B as bytesToBigIntLE,g as deriveKey,V as getIssAudAndUidVal,U as getKeylessConfig,W as getKeylessJWKs,z as hashStrToField,o as isCanonicalEd25519Signature,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,A as padAndPackBytesWithLen,Y as parseJwtHeader,D as poseidonHash,i as splitPath};
+import"../../chunk-HEZ2ZYZA.mjs";import{a as s,b as t}from"../../chunk-ODEDSSQL.mjs";import{a as aa,b as ba}from"../../chunk-3XH3NNSR.mjs";import{a as _,b as $}from"../../chunk-4ZJJINCW.mjs";import{a as u,b as v,c as w}from"../../chunk-G5ZWH5T3.mjs";import{a as Z}from"../../chunk-NW2WUKWV.mjs";import{a as E,b as F,c as G,d as H,e as I,f as J,g as K,h as L,i as M,j as N,k as O,l as P,m as Q,n as R,o as S,p as T,q as U,r as V,s as W,t as X,u as Y}from"../../chunk-KG23XFU2.mjs";import{a as z,b as A,c as B,d as C,e as D}from"../../chunk-GOXRBEIJ.mjs";import"../../chunk-XJJVJOX5.mjs";import{a as x,b as y}from"../../chunk-T6NQDM7D.mjs";import{a as o,b as p,c as q,d as r}from"../../chunk-XGF7UNEW.mjs";import{a as l,b as m}from"../../chunk-EMURYYVO.mjs";import{a as n}from"../../chunk-WCMW2L3P.mjs";import"../../chunk-DPW6ELCQ.mjs";import{a,b,c,d,e,f,g,h,i,j}from"../../chunk-C3Q23D22.mjs";import{a as k}from"../../chunk-ROT6S6BM.mjs";import"../../chunk-FN4C3CKC.mjs";import"../../chunk-Q4C4U6I4.mjs";import"../../chunk-YOZBVVKL.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SZRZ3HIL.mjs";import"../../chunk-FKJ3GCBI.mjs";import"../../chunk-CNCRJ56P.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4YLUM62M.mjs";import"../../chunk-QHEKBHNU.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-TOBQ5UE6.mjs";import"../../chunk-MT2RJ7H3.mjs";import"../../chunk-N4VVDQA5.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-XTOIL6MB.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-DAFSKSZ5.mjs";import"../../chunk-4RXKALLC.mjs";import"../../chunk-RJ7F4JDV.mjs";import"../../chunk-AIABPCUF.mjs";import"../../chunk-KDMSOCZY.mjs";export{b as APTOS_BIP44_REGEX,a as APTOS_HARDENED_REGEX,m as AccountPublicKey,_ as AnyPublicKey,$ as AnySignature,h as CKDPriv,E as EPK_HORIZON_SECS,q as Ed25519PrivateKey,p as Ed25519PublicKey,r as Ed25519Signature,O as EphemeralCertificate,x as EphemeralPublicKey,y as EphemeralSignature,Z as FederatedKeylessPublicKey,T as Groth16VerificationKey,P as Groth16Zkp,d as HARDENED_OFFSET,c as KeyType,S as KeylessConfiguration,M as KeylessPublicKey,N as KeylessSignature,F as MAX_AUD_VAL_BYTES,L as MAX_COMMITED_EPK_BYTES,J as MAX_EXTRA_FIELD_BYTES,I as MAX_ISS_VAL_BYTES,K as MAX_JWT_HEADER_B64_BYTES,G as MAX_UID_KEY_BYTES,H as MAX_UID_VAL_BYTES,X as MoveJWK,s as MultiEd25519PublicKey,t as MultiEd25519Signature,aa as MultiKey,ba as MultiKeySignature,k as PrivateKey,l as PublicKey,v as Secp256k1PrivateKey,u as Secp256k1PublicKey,w as Secp256k1Signature,n as Signature,R as ZeroKnowledgeSig,Q as ZkProof,C as bigIntToBytesLE,B as bytesToBigIntLE,g as deriveKey,V as getIssAudAndUidVal,U as getKeylessConfig,W as getKeylessJWKs,z as hashStrToField,o as isCanonicalEd25519Signature,e as isValidBIP44Path,f as isValidHardenedPath,j as mnemonicToSeed,A as padAndPackBytesWithLen,Y as parseJwtHeader,D 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-BVXX1nVl.mjs';
+import { a as AccountPublicKey, A as AuthenticationKey, P as PublicKey } from '../../publicKey-BMtGNNLg.mjs';
 import { Signature } from './signature.mjs';
 import { Deserializer } from '../../bcs/deserializer.mjs';
 import { Serializer, Serializable } from '../../bcs/serializer.mjs';
@@ -14,16 +14,49 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/apiEndpoints.mjs';
+import '@aptos-labs/script-composer-pack';
 import '../../transactions/instances/transactionArgument.mjs';
 import '../../utils/const.mjs';
 
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const EPK_HORIZON_SECS = 10000000;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_AUD_VAL_BYTES = 120;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_UID_KEY_BYTES = 30;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_UID_VAL_BYTES = 330;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_ISS_VAL_BYTES = 120;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_EXTRA_FIELD_BYTES = 350;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_JWT_HEADER_B64_BYTES = 300;
+/**
+ * @group Implementation
+ * @category Serialization
+ */
 declare const MAX_COMMITED_EPK_BYTES = 93;
 /**
  * Represents a Keyless Public Key used for authentication.
@@ -32,20 +65,28 @@ declare const MAX_COMMITED_EPK_BYTES = 93;
  * 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`.
+ * @group Implementation
+ * @category Serialization
  */
 declare class KeylessPublicKey extends AccountPublicKey {
     /**
      * The number of bytes that `idCommitment` should be
+     * @group Implementation
+     * @category Serialization
      */
     static readonly ID_COMMITMENT_LENGTH: number;
     /**
      * The value of the 'iss' claim on the JWT which identifies the OIDC provider.
+     * @group Implementation
+     * @category Serialization
      */
     readonly iss: string;
     /**
      * A value representing a cryptographic commitment to a user identity.
      *
      * It is calculated from the aud, uidKey, uidVal, pepper.
+     * @group Implementation
+     * @category Serialization
      */
     readonly idCommitment: Uint8Array;
     /**
@@ -57,12 +98,16 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     constructor(iss: string, idCommitment: HexInput);
     /**
      * Get the authentication key for the keyless public key.
      *
      * @returns AuthenticationKey - The authentication key derived from the keyless public key.
+     * @group Implementation
+     * @category Serialization
      */
     authKey(): AuthenticationKey;
     /**
@@ -72,6 +117,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     verifySignature(args: {
         message: HexInput;
@@ -87,6 +134,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     serialize(serializer: Serializer): void;
     /**
@@ -95,6 +144,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      *
      * @param deserializer - The deserializer instance used to read the serialized data.
      * @returns A new instance of ZeroKnowledgeSig.
+     * @group Implementation
+     * @category Serialization
      */
     static deserialize(deserializer: Deserializer): KeylessPublicKey;
     /**
@@ -105,6 +156,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     static load(deserializer: Deserializer): KeylessPublicKey;
     /**
@@ -112,6 +165,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      *
      * @param publicKey - The public key to check.
      * @returns A boolean indicating whether the public key is a KeylessPublicKey instance.
+     * @group Implementation
+     * @category Serialization
      */
     static isPublicKey(publicKey: PublicKey): publicKey is KeylessPublicKey;
     /**
@@ -123,6 +178,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @param args.aud the client ID of the application
      * @param args.pepper The pepper used to maintain privacy of the account
      * @returns KeylessPublicKey
+     * @group Implementation
+     * @category Serialization
      */
     static create(args: {
         iss: string;
@@ -140,6 +197,8 @@ declare class KeylessPublicKey extends AccountPublicKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     static fromJwtAndPepper(args: {
         jwt: string;
@@ -151,31 +210,45 @@ declare class KeylessPublicKey extends AccountPublicKey {
      *
      * @param publicKey - The public key to validate.
      * @returns A boolean indicating whether the public key is a valid instance.
+     * @group Implementation
+     * @category Serialization
      */
     static isInstance(publicKey: PublicKey): boolean;
 }
 /**
  * Represents a signature of a message signed via a Keyless Account, utilizing proofs or a JWT token for authentication.
+ * @group Implementation
+ * @category Serialization
  */
 declare class KeylessSignature extends Signature {
     /**
      * The inner signature ZeroKnowledgeSignature or OpenIdSignature
+     * @group Implementation
+     * @category Serialization
      */
     readonly ephemeralCertificate: EphemeralCertificate;
     /**
      * The jwt header in the token used to create the proof/signature.  In json string representation.
+     * @group Implementation
+     * @category Serialization
      */
     readonly jwtHeader: string;
     /**
      * The expiry timestamp in seconds of the EphemeralKeyPair used to sign
+     * @group Implementation
+     * @category Serialization
      */
     readonly expiryDateSecs: number;
     /**
      * The ephemeral public key used to verify the signature
+     * @group Implementation
+     * @category Serialization
      */
     readonly ephemeralPublicKey: EphemeralPublicKey;
     /**
      * The signature resulting from signing with the private key of the EphemeralKeyPair
+     * @group Implementation
+     * @category Serialization
      */
     readonly ephemeralSignature: EphemeralSignature;
     constructor(args: {
@@ -201,11 +274,15 @@ declare class KeylessSignature extends Signature {
  * This class can be extended to support additional signature types, such as OpenIdSignature.
  *
  * @extends Signature
+ * @group Implementation
+ * @category Serialization
  */
 declare class EphemeralCertificate extends Signature {
     readonly signature: Signature;
     /**
      * Index of the underlying enum variant
+     * @group Implementation
+     * @category Serialization
      */
     private readonly variant;
     constructor(signature: Signature, variant: EphemeralCertificateVariant);
@@ -213,6 +290,8 @@ declare class EphemeralCertificate extends Signature {
      * Get the public key in bytes (Uint8Array).
      *
      * @returns Uint8Array representation of the public key
+     * @group Implementation
+     * @category Serialization
      */
     toUint8Array(): Uint8Array;
     serialize(serializer: Serializer): void;
@@ -223,6 +302,8 @@ declare class EphemeralCertificate extends Signature {
  * This class is used for handling and serializing G1 bytes in cryptographic operations.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Serialization
  */
 declare class G1Bytes extends Serializable {
     data: Uint8Array;
@@ -235,6 +316,8 @@ declare class G1Bytes extends Serializable {
  * This class provides methods for serialization and deserialization of G2 bytes.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Serialization
  */
 declare class G2Bytes extends Serializable {
     data: Uint8Array;
@@ -247,18 +330,26 @@ declare class G2Bytes extends Serializable {
  * The points are the compressed serialization of affine representation of the proof.
  *
  * @extends Proof
+ * @group Implementation
+ * @category Serialization
  */
 declare class Groth16Zkp extends Proof {
     /**
      * The bytes of G1 proof point a
+     * @group Implementation
+     * @category Serialization
      */
     a: G1Bytes;
     /**
      * The bytes of G2 proof point b
+     * @group Implementation
+     * @category Serialization
      */
     b: G2Bytes;
     /**
      * The bytes of G1 proof point c
+     * @group Implementation
+     * @category Serialization
      */
     c: G1Bytes;
     constructor(args: {
@@ -273,11 +364,15 @@ declare class Groth16Zkp extends Proof {
  * Represents a container for different types of zero-knowledge proofs.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Serialization
  */
 declare class ZkProof extends Serializable {
     readonly proof: Proof;
     /**
      * Index of the underlying enum variant
+     * @group Implementation
+     * @category Serialization
      */
     private readonly variant;
     constructor(proof: Proof, variant: ZkpVariant);
@@ -288,27 +383,39 @@ declare class ZkProof extends Serializable {
  * Represents a zero-knowledge signature, encapsulating the proof and its associated metadata.
  *
  * @extends Signature
+ * @group Implementation
+ * @category Serialization
  */
 declare class ZeroKnowledgeSig extends Signature {
     /**
      * The proof
+     * @group Implementation
+     * @category Serialization
      */
     readonly proof: ZkProof;
     /**
      * The max lifespan of the proof
+     * @group Implementation
+     * @category Serialization
      */
     readonly expHorizonSecs: number;
     /**
      * A key value pair on the JWT token that can be specified on the signature which would reveal the value on chain.
      * Can be used to assert identity or other attributes.
+     * @group Implementation
+     * @category Serialization
      */
     readonly extraField?: string;
     /**
      * The 'aud' value of the recovery service which is set when recovering an account.
+     * @group Implementation
+     * @category Serialization
      */
     readonly overrideAudVal?: string;
     /**
      * The training wheels signature
+     * @group Implementation
+     * @category Serialization
      */
     readonly trainingWheelsSignature?: EphemeralSignature;
     constructor(args: {
@@ -323,6 +430,8 @@ declare class ZeroKnowledgeSig extends Signature {
      *
      * @param bytes - The bytes representing the serialized ZeroKnowledgeSig.
      * @returns ZeroKnowledgeSig - The deserialized ZeroKnowledgeSig object.
+     * @group Implementation
+     * @category Serialization
      */
     static fromBytes(bytes: Uint8Array): ZeroKnowledgeSig;
     serialize(serializer: Serializer): void;
@@ -334,14 +443,20 @@ declare class ZeroKnowledgeSig extends Signature {
  * @remarks
  * This class encapsulates the verification key and the maximum lifespan of ephemeral key pairs,
  * which are essential for the functionality of Keyless accounts.
+ * @group Implementation
+ * @category Serialization
  */
 declare class KeylessConfiguration {
     /**
      * The verification key used to verify Groth16 proofs on chain
+     * @group Implementation
+     * @category Serialization
      */
     readonly verificationKey: Groth16VerificationKey;
     /**
      * The maximum lifespan of an ephemeral key pair.  This is configured on chain.
+     * @group Implementation
+     * @category Serialization
      */
     readonly maxExpHorizonSecs: number;
     constructor(verificationKey: Groth16VerificationKey, maxExpHorizonSecs: number);
@@ -349,26 +464,38 @@ declare class KeylessConfiguration {
 }
 /**
  * Represents the verification key stored on-chain used to verify Groth16 proofs.
+ * @group Implementation
+ * @category Serialization
  */
 declare class Groth16VerificationKey {
     /**
      * The `alpha * G`, where `G` is the generator of G1
+     * @group Implementation
+     * @category Serialization
      */
     readonly alphaG1: G1Bytes;
     /**
      * The `alpha * H`, where `H` is the generator of G2
+     * @group Implementation
+     * @category Serialization
      */
     readonly betaG2: G2Bytes;
     /**
      * The `delta * H`, where `H` is the generator of G2
+     * @group Implementation
+     * @category Serialization
      */
     readonly deltaG2: G2Bytes;
     /**
      * The `gamma^{-1} * (beta * a_i + alpha * b_i + c_i) * H`, where H is the generator of G1
+     * @group Implementation
+     * @category Serialization
      */
     readonly gammaAbcG1: [G1Bytes, G1Bytes];
     /**
      * The `gamma * H`, where `H` is the generator of G2
+     * @group Implementation
+     * @category Serialization
      */
     readonly gammaG2: G2Bytes;
     constructor(args: {
@@ -396,6 +523,8 @@ declare class Groth16VerificationKey {
      * @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.
+     * @group Implementation
+     * @category Serialization
      */
     static fromGroth16VerificationKeyResponse(res: Groth16VerificationKeyResponse): Groth16VerificationKey;
 }
@@ -408,6 +537,8 @@ declare class Groth16VerificationKey {
  * @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.
+ * @group Implementation
+ * @category Serialization
  */
 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,q,r,s,t,u}from"../../chunk-PXMNAP2Q.mjs";import"../../chunk-UGTIALNW.mjs";import"../../chunk-KCWRCWNT.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-H3C3VTHS.mjs";import"../../chunk-BUAHUVAD.mjs";import"../../chunk-MHN6XY4Z.mjs";import"../../chunk-4O5XDQDO.mjs";import"../../chunk-5B3SMBXQ.mjs";import"../../chunk-OIOGOW6I.mjs";import"../../chunk-AKIO3OIT.mjs";import"../../chunk-JNO7KPMG.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-372SLYVR.mjs";import"../../chunk-LKKI2KAP.mjs";import"../../chunk-VWGB5BHW.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-CDEYH77E.mjs";import"../../chunk-F45G3GP3.mjs";import"../../chunk-V4FKFCBL.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J7PJSK3J.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-ZMBXHMVQ.mjs";import"../../chunk-BRV3RLKW.mjs";import"../../chunk-ZMMLM6ZJ.mjs";import"../../chunk-42H7WETG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-J3E4UMBB.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-YD2BMHH7.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as EPK_HORIZON_SECS,k as EphemeralCertificate,p as Groth16VerificationKey,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,t as MoveJWK,n as ZeroKnowledgeSig,m as ZkProof,r as getIssAudAndUidVal,q as getKeylessConfig,s as getKeylessJWKs,u as parseJwtHeader};
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u}from"../../chunk-KG23XFU2.mjs";import"../../chunk-GOXRBEIJ.mjs";import"../../chunk-XJJVJOX5.mjs";import"../../chunk-T6NQDM7D.mjs";import"../../chunk-XGF7UNEW.mjs";import"../../chunk-EMURYYVO.mjs";import"../../chunk-WCMW2L3P.mjs";import"../../chunk-DPW6ELCQ.mjs";import"../../chunk-C3Q23D22.mjs";import"../../chunk-ROT6S6BM.mjs";import"../../chunk-FN4C3CKC.mjs";import"../../chunk-Q4C4U6I4.mjs";import"../../chunk-YOZBVVKL.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SZRZ3HIL.mjs";import"../../chunk-FKJ3GCBI.mjs";import"../../chunk-CNCRJ56P.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4YLUM62M.mjs";import"../../chunk-QHEKBHNU.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-TOBQ5UE6.mjs";import"../../chunk-MT2RJ7H3.mjs";import"../../chunk-N4VVDQA5.mjs";import"../../chunk-ORMOQWWH.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-XTOIL6MB.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-DAFSKSZ5.mjs";import"../../chunk-4RXKALLC.mjs";import"../../chunk-RJ7F4JDV.mjs";import"../../chunk-AIABPCUF.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as EPK_HORIZON_SECS,k as EphemeralCertificate,p as Groth16VerificationKey,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,t as MoveJWK,n as ZeroKnowledgeSig,m as ZkProof,r as getIssAudAndUidVal,q as getKeylessConfig,s as getKeylessJWKs,u as parseJwtHeader};
 //# sourceMappingURL=keyless.mjs.map