@aptos-labs/ts-sdk 1.16.0-zeta.0 → 1.16.0-zeta.1

package/dist/common/{accountAddress-BtD_TE5q.d.ts → accountAddress-OUd5ov6z.d.ts}

@@ -747,9 +747,9 @@ type GasEstimation = {
      */
     prioritized_gas_estimate?: number;
 };
-type MoveResource = {
+type MoveResource<T = {}> = {
     type: MoveStructId;
-    data: {};
+    data: T;
 };
 type AccountData = {
     sequence_number: string;
@@ -1463,16 +1463,22 @@ declare class Deserializer {
      */
     deserializeOptionStr(): string | undefined;
     /**
-     * Deserializes a an optional string.
+     * Deserializes a an optional deserializable class.
+     *
+     * BCS layout for Optional<T>: 0 if none, else 1 | bcs representation of class
      *
-     * BCS layout for Optional<String>: 0 if none, else 1 | string_length | string_content
      * @example
-     * ```ts
-     * const deserializer = new Deserializer(new Uint8Array([0x00]));
-     * assert(deserializer.deserializeOptionStr() === undefined);
-     * const deserializer = new Deserializer(new Uint8Array([1, 8, 49, 50, 51, 52, 97, 98, 99, 100]));
-     * assert(deserializer.deserializeOptionStr() === "1234abcd");
-     * ```
+     * const deserializer = new Deserializer(new Uint8Array([1, 2, 3]));
+     * const value = deserializer.deserializeOption(MyClass); // where MyClass has a `deserialize` function
+     * // value is now an instance of MyClass
+     *
+     * const deserializer = new Deserializer(new Uint8Array([0]));
+     * const value = deserializer.deserializeOption(MyClass); // where MyClass has a `deserialize` function
+     * // value is undefined
+     *
+     * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
+     *
+     * @returns the deserialized value of class type T
      */
     deserializeOption<T>(cls: Deserializable<T>): T | undefined;
     /**
@@ -1896,7 +1902,47 @@ declare class Serializer {
      * // `bcs::to_bytes(&vector<address> [@0x1, @0x2, @0xa, @0xb])`;
      */
     serializeVector<T extends Serializable>(values: Array<T>): void;
+    /**
+     * Serializes a BCS Serializable values into a serializer instance or undefined.
+     * Note that this does not return anything. The bytes are added to the serializer instance's byte buffer.
+     *
+     * @param values The array of BCS Serializable values
+     *
+     * @example
+     * ```ts
+     * const serializer = new Serializer();
+     * serializer.serializeOption(new AccountAddress(...));
+     * const serializedBytes = serializer.toUint8Array();
+     * // serializedBytes is now the BCS-serialized byte representation of AccountAddress
+     *
+     * const serializer = new Serializer();
+     * serializer.serializeOption(undefined);
+     * assert(serializer.toUint8Array() === new Uint8Array([0x00]));
+     * ```
+     */
     serializeOption<T extends Serializable>(value?: T): void;
+    /**
+     * Serializes an optional string. UTF8 string is supported.
+     *
+     * The existence of the string is encoded first, 0 if undefined and 1 if it exists.
+     * Them the number of bytes in the string content is serialized, as a uleb128-encoded u32 integer.
+     * Then the string content is serialized as UTF8 encoded bytes.
+     *
+     * BCS layout for optional "string": 1 | string_length | string_content
+     * where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
+     *
+     * BCS layout for undefined: 0
+     * @example
+     * ```ts
+     * const serializer = new Serializer();
+     * serializer.serializeOptionStr("1234abcd");
+     * assert(serializer.toUint8Array() === new Uint8Array([1, 8, 49, 50, 51, 52, 97, 98, 99, 100]));
+     *
+     * const serializer = new Serializer();
+     * serializer.serializeOptionStr(undefined);
+     * assert(serializer.toUint8Array() === new Uint8Array([0]));
+     * ```
+     */
     serializeOptionStr(value?: string): void;
 }
 declare function ensureBoolean(value: unknown): asserts value is boolean;

package/dist/common/cli/index.d.ts

@@ -1,5 +1,5 @@
 import { ChildProcessWithoutNullStreams } from 'child_process';
-import { N as Network, g as AccountAddress } from '../accountAddress-BtD_TE5q.js';
+import { N as Network, g as AccountAddress } from '../accountAddress-OUd5ov6z.js';
 
 declare class LocalNode {
     readonly MAXIMUM_WAIT_TIME_SEC = 75;

package/dist/common/index.d.ts

@@ -1,5 +1,5 @@
-import { S as Serializable, T as TransactionArgument, H as HexInput, a as Serializer, D as Deserializer, E as EntryFunctionArgument, U as Uint8, b as Uint16, c as Uint32, A as AnyNumber, d as Deserializable, e as Hex, f as AuthenticationKeyScheme, g as AccountAddress, h as AnyPublicKeyVariant, i as EphemeralPublicKeyVariant, j as EphemeralCertificateVariant, Z as ZkpVariant, N as Network, C as Client, k as ClientConfig, F as FullNodeConfig, I as IndexerConfig, l as FaucetConfig, m as AptosSettings, M as MoveModuleId, n as ScriptFunctionArgument, o as MoveFunctionId, p as AccountAddressInput, q as MoveFunctionGenericTypeParam, r as SigningSchemeInput, s as SigningScheme, t as AptosRequest, u as AccountData, P as PaginationArgs, L as LedgerVersionArg, v as MoveModuleBytecode, w as TransactionResponse, x as MoveResource, y as MoveStructId, z as TokenStandardArg, O as OrderByArg, G as GetAccountOwnedTokensQueryResponse, B as GetAccountOwnedTokensFromCollectionResponse, J as GetAccountCollectionsWithOwnedTokenResponse, K as GetAccountCoinsDataResponse, W as WhereArg, Q as GetAccountOwnedObjectsResponse, R as GetCollectionDataResponse, V as GetTokenDataResponse, X as GetCurrentTokenOwnershipResponse, Y as GetOwnedTokensResponse, _ as GetTokenActivityResponse, $ as GetEventsResponse, a0 as WaitForTransactionOptions, a1 as UserTransactionResponse, a2 as MoveFunction, a3 as GetFungibleAssetMetadataResponse, a4 as GetFungibleAssetActivitiesResponse, a5 as GetCurrentFungibleAssetBalancesResponse, a6 as LedgerInfo, a7 as Block, a8 as MoveValue, a9 as GetChainTopUserTransactionsResponse, aa as GraphqlQuery, ab as GetProcessorStatusResponse, ac as GetANSNameResponse, ad as GetNumberOfDelegatorsResponse, ae as GetDelegatedStakingActivitiesResponse, af as PendingTransactionResponse, ag as CommittedTransactionResponse, ah as GasEstimation, ai as TableItemRequest, aj as GetTableItemsDataResponse, ak as GetTableItemsMetadataResponse, al as ClientRequest, am as ClientResponse, an as MimeType } from './accountAddress-BtD_TE5q.js';
-export { aA as AccountAuthenticatorVariant, bg as AccountSignature, ar as AddressInvalidReason, aB as AnySignatureVariant, aP as BlockMetadataTransactionResponse, aG as ClientHeadersType, aZ as DecodedTableData, a_ as DeletedTableData, bD as DeriveScheme, bj as DirectWriteSet, b0 as EntryFunctionPayloadResponse, aC as EphemeralSignatureVariant, bl as Event, bk as EventGuid, bG as GenerateAccount, bE as GenerateAccountWithEd25519, bF as GenerateAccountWithSingleSignerSecp256k1Key, b3 as GenesisPayload, aO as GenesisTransactionResponse, au as HexInvalidReason, by as MoveAbility, bs as MoveAddressType, bx as MoveFunctionVisibility, bA as MoveModule, bt as MoveObjectType, bu as MoveOptionType, b4 as MoveScriptBytecode, bB as MoveStruct, bz as MoveStructField, bv as MoveStructType, bw as MoveType, bq as MoveUint128Type, bn as MoveUint16Type, br as MoveUint256Type, bo as MoveUint32Type, bp as MoveUint64Type, bm as MoveUint8Type, b2 as MultisigPayloadResponse, bP as NetworkToChainId, bM as NetworkToFaucetAPI, bK as NetworkToIndexerAPI, bQ as NetworkToNetworkName, bL as NetworkToNodeAPI, bN as NetworkToPepperAPI, bO as NetworkToProverAPI, bH as OrderBy, bI as OrderByValue, as as ParsingError, at as ParsingResult, bC as RoleType, b1 as ScriptPayloadResponse, aw as ScriptTransactionArgumentVariants, bi as ScriptWriteSet, aQ as StateCheckpointTransactionResponse, bJ as TokenStandard, az as TransactionAuthenticatorVariant, bb as TransactionEd25519Signature, bf as TransactionFeePayerSignature, be as TransactionMultiAgentSignature, bd as TransactionMultiEd25519Signature, a$ as TransactionPayloadResponse, ax as TransactionPayloadVariants, aH as TransactionResponseType, bc as TransactionSecp256k1Signature, b5 as TransactionSignature, ay as TransactionVariants, av as TypeTagVariants, aE as Uint128, aF as Uint256, aD as Uint64, aR as ValidatorTransactionResponse, bh as WriteSet, aS as WriteSetChange, aT as WriteSetChangeDeleteModule, aU as WriteSetChangeDeleteResource, aV as WriteSetChangeDeleteTableItem, aW as WriteSetChangeWriteModule, aX as WriteSetChangeWriteResource, aY as WriteSetChangeWriteTableItem, ao as ensureBoolean, aL as isBlockMetadataTransactionResponse, b6 as isEd25519Signature, b9 as isFeePayerSignature, aK as isGenesisTransactionResponse, b8 as isMultiAgentSignature, ba as isMultiEd25519Signature, aI as isPendingTransactionResponse, b7 as isSecp256k1Signature, aM as isStateCheckpointTransactionResponse, aJ as isUserTransactionResponse, aN as isValidatorTransactionResponse, ap as outOfRangeErrorMessage, aq as validateNumberInRange } from './accountAddress-BtD_TE5q.js';
+import { S as Serializable, T as TransactionArgument, H as HexInput, a as Serializer, D as Deserializer, E as EntryFunctionArgument, U as Uint8, b as Uint16, c as Uint32, A as AnyNumber, d as Deserializable, e as Hex, f as AuthenticationKeyScheme, g as AccountAddress, h as AnyPublicKeyVariant, i as EphemeralPublicKeyVariant, j as EphemeralCertificateVariant, Z as ZkpVariant, N as Network, C as Client, k as ClientConfig, F as FullNodeConfig, I as IndexerConfig, l as FaucetConfig, m as AptosSettings, M as MoveModuleId, n as ScriptFunctionArgument, o as MoveFunctionId, p as AccountAddressInput, q as MoveFunctionGenericTypeParam, r as SigningSchemeInput, s as SigningScheme, t as AptosRequest, u as AccountData, P as PaginationArgs, L as LedgerVersionArg, v as MoveModuleBytecode, w as TransactionResponse, x as MoveResource, y as MoveStructId, z as TokenStandardArg, O as OrderByArg, G as GetAccountOwnedTokensQueryResponse, B as GetAccountOwnedTokensFromCollectionResponse, J as GetAccountCollectionsWithOwnedTokenResponse, K as GetAccountCoinsDataResponse, W as WhereArg, Q as GetAccountOwnedObjectsResponse, R as GetCollectionDataResponse, V as GetTokenDataResponse, X as GetCurrentTokenOwnershipResponse, Y as GetOwnedTokensResponse, _ as GetTokenActivityResponse, $ as GetEventsResponse, a0 as WaitForTransactionOptions, a1 as UserTransactionResponse, a2 as MoveFunction, a3 as GetFungibleAssetMetadataResponse, a4 as GetFungibleAssetActivitiesResponse, a5 as GetCurrentFungibleAssetBalancesResponse, a6 as LedgerInfo, a7 as Block, a8 as MoveValue, a9 as GetChainTopUserTransactionsResponse, aa as GraphqlQuery, ab as GetProcessorStatusResponse, ac as GetANSNameResponse, ad as GetNumberOfDelegatorsResponse, ae as GetDelegatedStakingActivitiesResponse, af as PendingTransactionResponse, ag as CommittedTransactionResponse, ah as GasEstimation, ai as TableItemRequest, aj as GetTableItemsDataResponse, ak as GetTableItemsMetadataResponse, al as ClientRequest, am as ClientResponse, an as MimeType } from './accountAddress-OUd5ov6z.js';
+export { aA as AccountAuthenticatorVariant, bg as AccountSignature, ar as AddressInvalidReason, aB as AnySignatureVariant, aP as BlockMetadataTransactionResponse, aG as ClientHeadersType, aZ as DecodedTableData, a_ as DeletedTableData, bD as DeriveScheme, bj as DirectWriteSet, b0 as EntryFunctionPayloadResponse, aC as EphemeralSignatureVariant, bl as Event, bk as EventGuid, bG as GenerateAccount, bE as GenerateAccountWithEd25519, bF as GenerateAccountWithSingleSignerSecp256k1Key, b3 as GenesisPayload, aO as GenesisTransactionResponse, au as HexInvalidReason, by as MoveAbility, bs as MoveAddressType, bx as MoveFunctionVisibility, bA as MoveModule, bt as MoveObjectType, bu as MoveOptionType, b4 as MoveScriptBytecode, bB as MoveStruct, bz as MoveStructField, bv as MoveStructType, bw as MoveType, bq as MoveUint128Type, bn as MoveUint16Type, br as MoveUint256Type, bo as MoveUint32Type, bp as MoveUint64Type, bm as MoveUint8Type, b2 as MultisigPayloadResponse, bP as NetworkToChainId, bM as NetworkToFaucetAPI, bK as NetworkToIndexerAPI, bQ as NetworkToNetworkName, bL as NetworkToNodeAPI, bN as NetworkToPepperAPI, bO as NetworkToProverAPI, bH as OrderBy, bI as OrderByValue, as as ParsingError, at as ParsingResult, bC as RoleType, b1 as ScriptPayloadResponse, aw as ScriptTransactionArgumentVariants, bi as ScriptWriteSet, aQ as StateCheckpointTransactionResponse, bJ as TokenStandard, az as TransactionAuthenticatorVariant, bb as TransactionEd25519Signature, bf as TransactionFeePayerSignature, be as TransactionMultiAgentSignature, bd as TransactionMultiEd25519Signature, a$ as TransactionPayloadResponse, ax as TransactionPayloadVariants, aH as TransactionResponseType, bc as TransactionSecp256k1Signature, b5 as TransactionSignature, ay as TransactionVariants, av as TypeTagVariants, aE as Uint128, aF as Uint256, aD as Uint64, aR as ValidatorTransactionResponse, bh as WriteSet, aS as WriteSetChange, aT as WriteSetChangeDeleteModule, aU as WriteSetChangeDeleteResource, aV as WriteSetChangeDeleteTableItem, aW as WriteSetChangeWriteModule, aX as WriteSetChangeWriteResource, aY as WriteSetChangeWriteTableItem, ao as ensureBoolean, aL as isBlockMetadataTransactionResponse, b6 as isEd25519Signature, b9 as isFeePayerSignature, aK as isGenesisTransactionResponse, b8 as isMultiAgentSignature, ba as isMultiEd25519Signature, aI as isPendingTransactionResponse, b7 as isSecp256k1Signature, aM as isStateCheckpointTransactionResponse, aJ as isUserTransactionResponse, aN as isValidatorTransactionResponse, ap as outOfRangeErrorMessage, aq as validateNumberInRange } from './accountAddress-OUd5ov6z.js';
 import EventEmitter from 'eventemitter3';
 
 type Maybe<T> = T | null;
@@ -1436,6 +1436,14 @@ declare abstract class Proof extends Serializable {
     toString(): string;
 }
 
+type Groth16VerificationKeyResponse = {
+    alpha_g1: string;
+    beta_g2: string;
+    delta_g2: string;
+    gamma_abc_g1: [string, string];
+    gamma_g2: string;
+};
+
 declare const EPK_HORIZON_SECS = 10000000;
 declare const MAX_AUD_VAL_BYTES = 120;
 declare const MAX_UID_KEY_BYTES = 30;
@@ -1451,7 +1459,15 @@ declare const MAX_COMMITED_EPK_BYTES = 93;
  */
 declare class KeylessPublicKey extends AccountPublicKey {
     static readonly ID_COMMITMENT_LENGTH: number;
+    /**
+     * The value of the 'iss' claim on the JWT which identifies the OIDC provider.
+     */
     readonly iss: string;
+    /**
+     * A value representing a cryptographic commitment to a user identity.
+     *
+     * It is calculated from the aud, uidKey, uidVal, pepper.
+     */
     readonly idCommitment: Uint8Array;
     constructor(iss: string, idCommitment: HexInput);
     /**
@@ -1520,7 +1536,7 @@ declare class KeylessSignature extends Signature {
     /**
      * The expiry timestamp in seconds of the EphemeralKeyPair used to sign
      */
-    readonly expiryDateSecs: bigint | number;
+    readonly expiryDateSecs: number;
     /**
      * The ephemeral public key used to verify the signature
      */
@@ -1532,7 +1548,7 @@ declare class KeylessSignature extends Signature {
     constructor(args: {
         jwtHeader: string;
         ephemeralCertificate: EphemeralCertificate;
-        expiryDateSecs: bigint | number;
+        expiryDateSecs: number;
         ephemeralPublicKey: EphemeralPublicKey;
         ephemeralSignature: EphemeralSignature;
     });
@@ -1545,6 +1561,7 @@ declare class KeylessSignature extends Signature {
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): KeylessSignature;
     static load(deserializer: Deserializer): KeylessSignature;
+    static getSimulationSignature(): KeylessSignature;
     static isSignature(signature: Signature): signature is KeylessSignature;
 }
 /**
@@ -1566,6 +1583,18 @@ declare class EphemeralCertificate extends Signature {
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): EphemeralCertificate;
 }
+declare class G1Bytes extends Serializable {
+    data: Uint8Array;
+    constructor(data: HexInput);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): G1Bytes;
+}
+declare class G2Bytes extends Serializable {
+    data: Uint8Array;
+    constructor(data: HexInput);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): G2Bytes;
+}
 /**
  * A representation of a Groth16 proof.  The points are the compressed serialization of affine reprentation of the proof.
  */
@@ -1573,15 +1602,15 @@ declare class Groth16Zkp extends Proof {
     /**
      * The bytes of G1 proof point a
      */
-    a: Uint8Array;
+    a: G1Bytes;
     /**
      * The bytes of G2 proof point b
      */
-    b: Uint8Array;
+    b: G2Bytes;
     /**
      * The bytes of G1 proof point c
      */
-    c: Uint8Array;
+    c: G1Bytes;
     constructor(args: {
         a: HexInput;
         b: HexInput;
@@ -1616,11 +1645,12 @@ declare class ZeroKnowledgeSig extends Signature {
      */
     readonly expHorizonSecs: bigint;
     /**
-     * A key value pair on the JWT token that can be made public
+     * 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.
      */
     readonly extraField?: string;
     /**
-     * Set in the case of signing by recovery services
+     * The 'aud' value of the recovery service which is set when recovering an account.
      */
     readonly overrideAudVal?: string;
     /**
@@ -1650,6 +1680,27 @@ declare class ZeroKnowledgeSig extends Signature {
     static deserialize(deserializer: Deserializer): ZeroKnowledgeSig;
     static load(deserializer: Deserializer): ZeroKnowledgeSig;
 }
+declare class KeylessConfiguration {
+    readonly verficationKey: Groth16VerificationKey;
+    readonly maxExpHorizonSecs: number;
+    constructor(verficationKey: Groth16VerificationKey, maxExpHorizonSecs: number);
+    static create(res: Groth16VerificationKeyResponse, maxExpHorizonSecs: number): KeylessConfiguration;
+}
+declare class Groth16VerificationKey {
+    readonly alphaG1: G1Bytes;
+    readonly betaG2: G2Bytes;
+    readonly deltaG2: G2Bytes;
+    readonly gammaAbcG1: G1Bytes[];
+    readonly gammaG2: G2Bytes;
+    constructor(args: {
+        alphaG1: HexInput;
+        betaG2: HexInput;
+        deltaG2: HexInput;
+        gammaAbcG1: [HexInput, HexInput];
+        gammaG2: HexInput;
+    });
+    static fromGroth16VerificationKeyResponse(res: Groth16VerificationKeyResponse): Groth16VerificationKey;
+}
 
 /**
  * Represents the Secp256k1 ecdsa public key
@@ -3171,7 +3222,7 @@ declare class EphemeralKeyPair extends Serializable {
      * A timestamp in seconds indicating when the ephemeral key pair is expired.  After expiry, a new
      * EphemeralKeyPair must be generated and a new JWT needs to be created.
      */
-    readonly expiryDateSecs: bigint | number;
+    readonly expiryDateSecs: number;
     /**
      * The value passed to the IdP when the user authenticates.  It comprises of a hash of the
      * ephermeral public key, expiry date, and blinder.
@@ -3189,7 +3240,7 @@ declare class EphemeralKeyPair extends Serializable {
     private publicKey;
     constructor(args: {
         privateKey: PrivateKey;
-        expiryDateSecs?: AnyNumber;
+        expiryDateSecs?: number;
         blinder?: HexInput;
     });
     /**
@@ -3213,7 +3264,7 @@ declare class EphemeralKeyPair extends Serializable {
      */
     static generate(args?: {
         scheme: EphemeralPublicKeyVariant;
-        expiryDateSecs?: bigint | number;
+        expiryDateSecs?: number;
     }): EphemeralKeyPair;
     /**
      * From the ephemeral public key, expiry timestamp, and blinder, calculate the nonce to be used at authentication via OIDC.
@@ -3274,6 +3325,12 @@ declare class AptosApiError extends Error {
 type AptsoDomainSeparator = `APTOS::${string}`;
 declare abstract class CryptoHashable extends Serializable {
     abstract readonly domainSeparator: AptsoDomainSeparator;
+    /**
+     * Hashes the bcs serialized from of the class. This is the typescript corollary to the BCSCryptoHash macro in aptos-core.
+     *
+     * @returns Uint8Array
+     */
+    hash(): Uint8Array;
 }
 
 declare const IssuerToJwkEndpoint: Record<string, string>;
@@ -3289,21 +3346,73 @@ declare class KeylessError extends Error {
     constructor(type: KeylessErrorType);
     static fromAptosApiError(error: AptosApiError, signer: KeylessAccount): Promise<KeylessError>;
 }
+/**
+ * Account implementation for the Keyless authentication scheme.
+ *
+ * Used to represent a Keyless based account and sign transactions with it.
+ *
+ * Use KeylessAccount.fromJWTAndProof to instantiate a KeylessAccount with a JWT, proof and EphemeralKeyPair.
+ *
+ * When the proof expires or the JWT becomes invalid, the KeylessAccount must be instantiated again with a new JWT,
+ * EphemeralKeyPair, and corresponding proof.
+ */
 declare class KeylessAccount extends Serializable implements Account$1 {
     static readonly PEPPER_LENGTH: number;
+    /**
+     * The KeylessPublicKey associated with the account
+     */
     readonly publicKey: KeylessPublicKey;
+    /**
+     * The EphemeralKeyPair used to generate sign.
+     */
     readonly ephemeralKeyPair: EphemeralKeyPair;
+    /**
+     * The claim on the JWT to identify a user.  This is typically 'sub' or 'email'.
+     */
     readonly uidKey: string;
+    /**
+     * The value of the uidKey claim on the JWT.  This intended to be a stable user identifier.
+     */
     readonly uidVal: string;
+    /**
+     * The value of the 'aud' claim on the JWT, also known as client ID.  This is the identifier for the dApp's
+     * OIDC registration with the identity provider.
+     */
     readonly aud: string;
+    /**
+     * A value contains 31 bytes of entropy that preserves privacy of the account. Typically fetched from a pepper provider.
+     */
     readonly pepper: Uint8Array;
+    /**
+     * Account address associated with the account
+     */
     readonly accountAddress: AccountAddress;
+    /**
+     * The zero knowledge signature (if ready) which contains the proof used to validate the EphemeralKeyPair.
+     */
     proof: ZeroKnowledgeSig | undefined;
+    /**
+     * The proof of the EphemeralKeyPair or a promise that provides the proof.  This is used to allow for awaiting on
+     * fetching the proof.
+     */
     readonly proofOrPromise: ZeroKnowledgeSig | Promise<ZeroKnowledgeSig>;
+    /**
+     * Signing scheme used to sign transactions
+     */
     readonly signingScheme: SigningScheme;
+    /**
+     * The JWT token used to derive the account
+     */
     private jwt;
+    /**
+     * A value that caches the JWT's validity.  A JWT becomes invalid when it's corresponding JWK is rotated from the
+     * identity provider's JWK keyset.
+     */
     private isJwtValid;
-    readonly emitter: EventEmitter<ProofFetchEvents>;
+    /**
+     * An event emitter used to assist in handling asycronous proof fetching.
+     */
+    private readonly emitter;
     constructor(args: {
         address?: AccountAddress;
         ephemeralKeyPair: EphemeralKeyPair;
@@ -3329,12 +3438,6 @@ declare class KeylessAccount extends Serializable implements Account$1 {
      * @return boolean
      */
     isExpired(): boolean;
-    /**
-     * Checks if the the JWK used to verify the token still exists on the issuer's JWK uri.
-     * Caches the result.
-     * @return boolean
-     */
-    checkJwkValidity(): Promise<boolean>;
     /**
      * Sign a message using Keyless.
      * @param message the message to sign, as binary input
@@ -3379,9 +3482,22 @@ declare class KeylessAccount extends Serializable implements Account$1 {
         proofFetchCallback?: ProofFetchCallback;
     }): KeylessAccount;
 }
+/**
+ * A container class to hold a transaction and a proof.  It implements CryptoHashable which is used to create
+ * the signing message for Keyless transactions.  We sign over the proof to ensure non-malleability.
+ */
 declare class TransactionAndProof extends CryptoHashable {
+    /**
+     * The transaction to sign.
+     */
     transaction: AnyRawTransactionInstance;
+    /**
+     * The zero knowledge proof used in signing the transaction.
+     */
     proof?: ZkProof;
+    /**
+     * The domain separator prefix used when hashing.
+     */
     domainSeparator: AptsoDomainSeparator;
     constructor(transaction: AnyRawTransactionInstance, proof?: ZkProof);
     serialize(serializer: Serializer): void;
@@ -4626,7 +4742,7 @@ declare function buildTransaction(args: InputGenerateMultiAgentRawTransactionArg
  * @returns A signed serialized transaction that can be simulated
  */
 declare function generateSignedTransactionForSimulation(args: InputSimulateTransactionData): Uint8Array;
-declare function getAuthenticatorForSimulation(pk: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
+declare function getAuthenticatorForSimulation(publicKey: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
 /**
  * Prepare a transaction to be submitted to chain
  *
@@ -4705,15 +4821,6 @@ declare function deriveTransactionType(transaction: AnyRawTransaction): AnyRawTr
  * @returns The Uint8Array of the signing message
  */
 declare function generateSigningMessage(bytes: Uint8Array, domainSeparator: string): Uint8Array;
-/**
- * Generates the 'signing message' form of a serilizable value. It bcs serializes the value and uses the name of
- * its constructor as the domain separator.
- *
- * @param hashable An object that has a bcs serialized form
- *
- * @returns The Uint8Array of the signing message
- */
-declare function generateSigningMessageForBcsCryptoHashable(hashable: CryptoHashable): Uint8Array;
 /**
  * Generates the 'signing message' form of a transaction. It derives the type of transaction and
  * applies the appropriate domain separator based on if there is extra data such as a fee payer or
@@ -6086,6 +6193,13 @@ declare class Table {
 declare class Keyless {
     readonly config: AptosConfig;
     constructor(config: AptosConfig);
+    /**
+     * Gets the parameters of how Keyless Accounts are configured on chain.
+     *
+     * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     * @returns KeylessConfiguration
+     */
+    getKeylessConfig(options?: LedgerVersionArg): Promise<KeylessConfiguration>;
     /**
      * Fetches the pepper from the Aptos pepper service API.
      *
@@ -6104,7 +6218,6 @@ declare class Keyless {
      * @param args.ephemeralKeyPair the EphemeralKeyPair used to generate the nonce in the JWT token
      * @param args.uidKey a key in the JWT token to use to set the uidVal in the IdCommitment
      * @param args.pepper the pepper
-     * @param args.extraFieldKey a key in the JWT token used to reveal a value on chain
      * @param args.proofFetchCallback a callback function that if set, the fetch of the proof will be done asyncronously. Once
      * if finishes the callback function will be called.
      * @returns A KeylessAccount that can be used to sign transactions
@@ -6114,7 +6227,6 @@ declare class Keyless {
         ephemeralKeyPair: EphemeralKeyPair;
         uidKey?: string;
         pepper?: HexInput;
-        extraFieldKey?: string;
         proofFetchCallback?: ProofFetchCallback;
     }): Promise<KeylessAccount>;
 }
@@ -6218,6 +6330,12 @@ type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
  */
 declare function get<Req extends {}, Res extends {}>(options: GetRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Makes a get request to the pepper service
+ *
+ * @param options GetAptosRequestOptions
+ * @returns AptosResponse
+ */
 declare function getAptosPepperService<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
 
@@ -6270,7 +6388,13 @@ declare function post<Req extends {}, Res extends {}>(options: PostRequestOption
 declare function postAptosFullNode<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function postAptosIndexer<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Makes a post request to the pepper service
+ *
+ * @param options GetAptosRequestOptions
+ * @returns AptosResponse
+ */
 declare function postAptosPepperService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function postAptosProvingService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 
-export { APTOS_BIP44_REGEX, APTOS_COIN, APTOS_HARDENED_REGEX, Account$1 as Account, AccountAddress, AccountAddressInput, AccountAuthenticator, AccountAuthenticatorEd25519, AccountAuthenticatorMultiEd25519, AccountAuthenticatorMultiKey, AccountAuthenticatorSingleKey, AccountData, AccountPublicKey, AccountSequenceNumber, AnyNumber, AnyPublicKey, AnyPublicKeyVariant, type AnyRawTransaction, type AnyRawTransactionInstance, AnySignature, type AnyTransactionPayloadInstance, Aptos, AptosApiError, AptosApiType, AptosConfig, AptosRequest, type AptosResponse, AptosSettings, AuthenticationKey, AuthenticationKeyScheme, Block, Bool, CKDPriv, ChainId, Client, ClientConfig, ClientRequest, ClientResponse, CommittedTransactionResponse, type CreateAccountFromPrivateKeyArgs, type CreateEd25519AccountFromPrivateKeyArgs, type CreateEd25519SingleKeyAccountFromPrivateKeyArgs, type CreateSingleKeyAccountFromPrivateKeyArgs, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, type DerivedKeys, Deserializable, type DeserializableClass, Deserializer, EPK_HORIZON_SECS, Ed25519Account, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, type Ed25519SignerConstructorArgs, type Ed25519SignerFromDerivationPathArgs, EntryFunction, type EntryFunctionABI, EntryFunctionArgument, type EntryFunctionArgumentTypes, EntryFunctionBytes, EphemeralCertificate, EphemeralCertificateVariant, EphemeralKeyPair, EphemeralPublicKey, EphemeralPublicKeyVariant, EphemeralSignature, type ExecutionFinishEventData, type FailureEventData, FaucetConfig, FeePayerRawTransaction, FixedBytes, FullNodeConfig, type FunctionABI, GasEstimation, type GenerateAccountArgs, type GenerateEd25519AccountArgs, type GenerateEd25519SingleKeyAccountArgs, type GenerateSingleKeyAccountArgs, GetANSNameResponse, GetAccountCoinsDataResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountOwnedObjectsResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountOwnedTokensQueryResponse, type GetAptosRequestOptions, GetChainTopUserTransactionsResponse, GetCollectionDataResponse, GetCurrentFungibleAssetBalancesResponse, GetCurrentTokenOwnershipResponse, GetDelegatedStakingActivitiesResponse, GetEventsResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, GetNumberOfDelegatorsResponse, GetOwnedTokensResponse, GetProcessorStatusResponse, type GetRequestOptions, GetTableItemsDataResponse, GetTableItemsMetadataResponse, GetTokenActivityResponse, GetTokenDataResponse, GraphqlQuery, Groth16Zkp, HARDENED_OFFSET, Hex, HexInput, Identifier, IndexerConfig, type InputEntryFunctionData, type InputEntryFunctionDataWithABI, type InputEntryFunctionDataWithRemoteABI, type InputGenerateMultiAgentRawTransactionArgs, type InputGenerateMultiAgentRawTransactionData, type InputGenerateRawTransactionArgs, type InputGenerateSingleSignerRawTransactionArgs, type InputGenerateSingleSignerRawTransactionData, type InputGenerateTransactionData, type InputGenerateTransactionOptions, type InputGenerateTransactionPayloadData, type InputGenerateTransactionPayloadDataWithABI, type InputGenerateTransactionPayloadDataWithRemoteABI, type InputMultiSigData, type InputMultiSigDataWithABI, type InputMultiSigDataWithRemoteABI, type InputScriptData, type InputSimulateTransactionData, type InputSimulateTransactionOptions, type InputSubmitTransactionData, type InputViewFunctionData, type InputViewFunctionDataWithABI, type InputViewFunctionDataWithRemoteABI, IssuerToJwkEndpoint, KeyType, KeylessAccount, KeylessError, KeylessErrorType, KeylessPublicKey, KeylessSignature, LedgerInfo, LedgerVersionArg, 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, MimeType, ModuleId, MoveFunction, MoveFunctionGenericTypeParam, MoveFunctionId, MoveModuleBytecode, MoveModuleId, MoveOption, MoveResource, MoveString, MoveStructId, MoveValue, MoveVector, MultiAgentRawTransaction, MultiAgentTransaction, MultiEd25519PublicKey, MultiEd25519Signature, MultiKey, MultiKeyAccount, MultiKeySignature, MultiSig, MultiSigTransactionPayload, Network, OrderByArg, PaginationArgs, PendingTransactionResponse, type PostAptosRequestOptions, type PostRequestOptions, type PrivateKey, type PrivateKeyFromDerivationPathArgs, ProcessorType, type ProofFetchCallback, type ProofFetchEvents, type ProofFetchFailure, type ProofFetchStatus, type ProofFetchSuccess, PublicKey, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT, RawTransaction, RawTransactionWithData, RotationProofChallenge, Script, ScriptFunctionArgument, type ScriptFunctionArgumentTypes, Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature, Serializable, Serializer, Signature, SignedTransaction, SigningScheme, SigningSchemeInput, type SimpleEntryFunctionArgumentTypes, SimpleTransaction, SingleKeyAccount, type SingleKeySignerConstructorArgs, type SingleKeySignerFromDerivationPathArgs, type SingleKeySignerGenerateArgs, StructTag, type SuccessEventData, TableItemRequest, TokenStandardArg, TransactionAndProof, TransactionArgument, TransactionAuthenticator, TransactionAuthenticatorEd25519, TransactionAuthenticatorFeePayer, TransactionAuthenticatorMultiAgent, TransactionAuthenticatorMultiEd25519, TransactionAuthenticatorSingleSender, TransactionPayload, TransactionPayloadEntryFunction, TransactionPayloadMultiSig, TransactionPayloadScript, TransactionResponse, TransactionWorker, type TransactionWorkerEvents, TransactionWorkerEventsEnum, type TypeArgument, TypeTag, TypeTagAddress, TypeTagBool, TypeTagGeneric, TypeTagParserError, TypeTagParserErrorType, TypeTagReference, TypeTagSigner, TypeTagStruct, TypeTagU128, TypeTagU16, TypeTagU256, TypeTagU32, TypeTagU64, TypeTagU8, TypeTagVector, U128, U16, U256, U32, U64, U8, Uint16, Uint32, Uint8, UserTransactionResponse, type VerifyEd25519SignatureArgs, type VerifyMultiKeySignatureArgs, type VerifySignatureArgs, type VerifySingleKeySignatureArgs, type ViewFunctionABI, WaitForTransactionOptions, WhereArg, ZeroKnowledgeSig, ZkProof, ZkpVariant, aptosCoinStructTag, aptosRequest, buildTransaction, checkOrConvertArgument, convertArgument, deriveKey, deriveTransactionType, deserializeFromScriptArgument, fetchEntryFunctionAbi, fetchFunctionAbi, fetchViewFunctionAbi, findFirstNonSignerArg, generateRawTransaction, generateSignedTransaction, generateSignedTransactionForSimulation, generateSigningMessage, generateSigningMessageForBcsCryptoHashable, generateSigningMessageForTransaction, generateTransactionPayload, generateTransactionPayloadWithABI, generateUserTransactionHash, generateViewFunctionPayload, generateViewFunctionPayloadWithABI, get, getAptosFullNode, getAptosPepperService, getAuthenticatorForSimulation, getFunctionParts, hashValues, isBcsAddress, isBcsBool, isBcsFixedBytes, isBcsString, isBcsU128, isBcsU16, isBcsU256, isBcsU32, isBcsU64, isBcsU8, isBool, isEncodedEntryFunctionArgument, isLargeNumber, isNull, isNumber, isScriptDataInput, isString, isValidBIP44Path, isValidHardenedPath, mnemonicToSeed, normalizeBundle, objectStructTag, optionStructTag, paginateWithCursor, parseTypeTag, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, postAptosPepperService, postAptosProvingService, promiseFulfilledStatus, request, splitPath, standardizeTypeTags, stringStructTag, throwTypeMismatch };
+export { APTOS_BIP44_REGEX, APTOS_COIN, APTOS_HARDENED_REGEX, Account$1 as Account, AccountAddress, AccountAddressInput, AccountAuthenticator, AccountAuthenticatorEd25519, AccountAuthenticatorMultiEd25519, AccountAuthenticatorMultiKey, AccountAuthenticatorSingleKey, AccountData, AccountPublicKey, AccountSequenceNumber, AnyNumber, AnyPublicKey, AnyPublicKeyVariant, type AnyRawTransaction, type AnyRawTransactionInstance, AnySignature, type AnyTransactionPayloadInstance, Aptos, AptosApiError, AptosApiType, AptosConfig, AptosRequest, type AptosResponse, AptosSettings, AuthenticationKey, AuthenticationKeyScheme, Block, Bool, CKDPriv, ChainId, Client, ClientConfig, ClientRequest, ClientResponse, CommittedTransactionResponse, type CreateAccountFromPrivateKeyArgs, type CreateEd25519AccountFromPrivateKeyArgs, type CreateEd25519SingleKeyAccountFromPrivateKeyArgs, type CreateSingleKeyAccountFromPrivateKeyArgs, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, type DerivedKeys, Deserializable, type DeserializableClass, Deserializer, EPK_HORIZON_SECS, Ed25519Account, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, type Ed25519SignerConstructorArgs, type Ed25519SignerFromDerivationPathArgs, EntryFunction, type EntryFunctionABI, EntryFunctionArgument, type EntryFunctionArgumentTypes, EntryFunctionBytes, EphemeralCertificate, EphemeralCertificateVariant, EphemeralKeyPair, EphemeralPublicKey, EphemeralPublicKeyVariant, EphemeralSignature, type ExecutionFinishEventData, type FailureEventData, FaucetConfig, FeePayerRawTransaction, FixedBytes, FullNodeConfig, type FunctionABI, GasEstimation, type GenerateAccountArgs, type GenerateEd25519AccountArgs, type GenerateEd25519SingleKeyAccountArgs, type GenerateSingleKeyAccountArgs, GetANSNameResponse, GetAccountCoinsDataResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountOwnedObjectsResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountOwnedTokensQueryResponse, type GetAptosRequestOptions, GetChainTopUserTransactionsResponse, GetCollectionDataResponse, GetCurrentFungibleAssetBalancesResponse, GetCurrentTokenOwnershipResponse, GetDelegatedStakingActivitiesResponse, GetEventsResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, GetNumberOfDelegatorsResponse, GetOwnedTokensResponse, GetProcessorStatusResponse, type GetRequestOptions, GetTableItemsDataResponse, GetTableItemsMetadataResponse, GetTokenActivityResponse, GetTokenDataResponse, GraphqlQuery, Groth16Zkp, HARDENED_OFFSET, Hex, HexInput, Identifier, IndexerConfig, type InputEntryFunctionData, type InputEntryFunctionDataWithABI, type InputEntryFunctionDataWithRemoteABI, type InputGenerateMultiAgentRawTransactionArgs, type InputGenerateMultiAgentRawTransactionData, type InputGenerateRawTransactionArgs, type InputGenerateSingleSignerRawTransactionArgs, type InputGenerateSingleSignerRawTransactionData, type InputGenerateTransactionData, type InputGenerateTransactionOptions, type InputGenerateTransactionPayloadData, type InputGenerateTransactionPayloadDataWithABI, type InputGenerateTransactionPayloadDataWithRemoteABI, type InputMultiSigData, type InputMultiSigDataWithABI, type InputMultiSigDataWithRemoteABI, type InputScriptData, type InputSimulateTransactionData, type InputSimulateTransactionOptions, type InputSubmitTransactionData, type InputViewFunctionData, type InputViewFunctionDataWithABI, type InputViewFunctionDataWithRemoteABI, IssuerToJwkEndpoint, KeyType, KeylessAccount, KeylessConfiguration, KeylessError, KeylessErrorType, KeylessPublicKey, KeylessSignature, LedgerInfo, LedgerVersionArg, 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, MimeType, ModuleId, MoveFunction, MoveFunctionGenericTypeParam, MoveFunctionId, MoveModuleBytecode, MoveModuleId, MoveOption, MoveResource, MoveString, MoveStructId, MoveValue, MoveVector, MultiAgentRawTransaction, MultiAgentTransaction, MultiEd25519PublicKey, MultiEd25519Signature, MultiKey, MultiKeyAccount, MultiKeySignature, MultiSig, MultiSigTransactionPayload, Network, OrderByArg, PaginationArgs, PendingTransactionResponse, type PostAptosRequestOptions, type PostRequestOptions, type PrivateKey, type PrivateKeyFromDerivationPathArgs, ProcessorType, type ProofFetchCallback, type ProofFetchEvents, type ProofFetchFailure, type ProofFetchStatus, type ProofFetchSuccess, PublicKey, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT, RawTransaction, RawTransactionWithData, RotationProofChallenge, Script, ScriptFunctionArgument, type ScriptFunctionArgumentTypes, Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature, Serializable, Serializer, Signature, SignedTransaction, SigningScheme, SigningSchemeInput, type SimpleEntryFunctionArgumentTypes, SimpleTransaction, SingleKeyAccount, type SingleKeySignerConstructorArgs, type SingleKeySignerFromDerivationPathArgs, type SingleKeySignerGenerateArgs, StructTag, type SuccessEventData, TableItemRequest, TokenStandardArg, TransactionAndProof, TransactionArgument, TransactionAuthenticator, TransactionAuthenticatorEd25519, TransactionAuthenticatorFeePayer, TransactionAuthenticatorMultiAgent, TransactionAuthenticatorMultiEd25519, TransactionAuthenticatorSingleSender, TransactionPayload, TransactionPayloadEntryFunction, TransactionPayloadMultiSig, TransactionPayloadScript, TransactionResponse, TransactionWorker, type TransactionWorkerEvents, TransactionWorkerEventsEnum, type TypeArgument, TypeTag, TypeTagAddress, TypeTagBool, TypeTagGeneric, TypeTagParserError, TypeTagParserErrorType, TypeTagReference, TypeTagSigner, TypeTagStruct, TypeTagU128, TypeTagU16, TypeTagU256, TypeTagU32, TypeTagU64, TypeTagU8, TypeTagVector, U128, U16, U256, U32, U64, U8, Uint16, Uint32, Uint8, UserTransactionResponse, type VerifyEd25519SignatureArgs, type VerifyMultiKeySignatureArgs, type VerifySignatureArgs, type VerifySingleKeySignatureArgs, type ViewFunctionABI, WaitForTransactionOptions, WhereArg, ZeroKnowledgeSig, ZkProof, ZkpVariant, aptosCoinStructTag, aptosRequest, buildTransaction, checkOrConvertArgument, convertArgument, deriveKey, deriveTransactionType, deserializeFromScriptArgument, fetchEntryFunctionAbi, fetchFunctionAbi, fetchViewFunctionAbi, findFirstNonSignerArg, generateRawTransaction, generateSignedTransaction, generateSignedTransactionForSimulation, generateSigningMessage, generateSigningMessageForTransaction, generateTransactionPayload, generateTransactionPayloadWithABI, generateUserTransactionHash, generateViewFunctionPayload, generateViewFunctionPayloadWithABI, get, getAptosFullNode, getAptosPepperService, getAuthenticatorForSimulation, getFunctionParts, hashValues, isBcsAddress, isBcsBool, isBcsFixedBytes, isBcsString, isBcsU128, isBcsU16, isBcsU256, isBcsU32, isBcsU64, isBcsU8, isBool, isEncodedEntryFunctionArgument, isLargeNumber, isNull, isNumber, isScriptDataInput, isString, isValidBIP44Path, isValidHardenedPath, mnemonicToSeed, normalizeBundle, objectStructTag, optionStructTag, paginateWithCursor, parseTypeTag, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, postAptosPepperService, postAptosProvingService, promiseFulfilledStatus, request, splitPath, standardizeTypeTags, stringStructTag, throwTypeMismatch };