@aptos-labs/ts-sdk 1.35.0-zeta.1 → 1.35.0-zeta.2

package/dist/common/index.d.ts

@@ -6782,6 +6782,7 @@ declare class MultiKeyAccount implements Account$1, KeylessSigner {
      * @category Account (On-Chain Model)
      */
     static fromPublicKeysAndSigners(args: {
+        address?: AccountAddressInput;
         publicKeys: PublicKey[];
         signaturesRequired: number;
         signers: SingleKeySignerOrLegacyEd25519Account[];
@@ -10294,11 +10295,11 @@ declare class General {
      * async function runExample() {
      *   // Querying the Aptos Indexer for ledger information
      *   const topUserTransactions = await aptos.queryIndexer({
-     *     query: `query MyQuery {
+     *     query: { query: `query MyQuery {
      *       ledger_infos {
      *         chain_id
      *       }
-     *     }`
+     *     }`}
      *   });
      *
      *   console.log(topUserTransactions);
@@ -12491,13 +12492,26 @@ declare class Transaction {
         options?: InputGenerateTransactionOptions;
     }): Promise<SimpleTransaction>;
     /**
-     * Rotate an account's authentication key. After rotation, only the new private key can be used to sign transactions for the account.
-     * Note: Only legacy Ed25519 scheme is supported for now.
-     * More info: {@link https://aptos.dev/guides/account-management/key-rotation/}
+     * Rotates the authentication key for a given account.  Once an account is rotated, only the new private key
+     * or keyless signing scheme can be used to sign transactions for the account.
+     *
+     * @param args - The arguments for rotating the authentication key.
+     * @param args.fromAccount - The account from which the authentication key will be rotated.
+     * @param args.toAccount - (Optional) The target account to rotate to. Required if not using toNewPrivateKey or toAuthKey.
+     * @param args.toNewPrivateKey - (Optional) The new private key to rotate to. Required if not using toAccount or toAuthKey.
+     * @param args.toAuthKey - (Optional) The new authentication key to rotate to. Can only be used with dangerouslySkipVerification=true.
+     * @param args.dangerouslySkipVerification - (Optional) If true, skips verification steps after rotation. Required when using toAuthKey.
+     *
+     * @remarks
+     * This function supports three modes of rotation:
+     * 1. Using a target Account object (toAccount)
+     * 2. Using a new private key (toNewPrivateKey)
+     * 3. Using a raw authentication key (toAuthKey) - requires dangerouslySkipVerification=true
+     *
+     * When not using dangerouslySkipVerification, the function performs additional safety checks and account setup.
      *
-     * @param args The arguments for rotating the auth key.
-     * @param args.fromAccount The account to rotate the auth key for.
-     * @param args.toNewPrivateKey The new private key to rotate to.
+     * If the new key is a multi key, skipping verification is dangerous because verification will publish the public key onchain and
+     * prevent users from being locked out of the account from loss of knowledge of one of the public keys.
      *
      * @returns PendingTransactionResponse
      *
@@ -12525,16 +12539,16 @@ declare class Transaction {
      */
     rotateAuthKey(args: {
         fromAccount: Account$1;
-        toNewPrivateKey: Ed25519PrivateKey;
-    }): Promise<PendingTransactionResponse>;
-    rotateAuthKeyToMultiEd25519(args: {
-        fromAccount: Account$1;
-        multiEd25519Account: MultiEd25519Account;
-    }): Promise<PendingTransactionResponse>;
-    rotateAuthKeyWithVerificationTransaction(args: {
-        fromAccount: Account$1;
+    } & ({
         toAccount: Account$1;
-    }): Promise<CommittedTransactionResponse>;
+        dangerouslySkipVerification?: never;
+    } | {
+        toNewPrivateKey: Ed25519PrivateKey;
+        dangerouslySkipVerification?: never;
+    } | {
+        toAuthKey: AuthenticationKey;
+        dangerouslySkipVerification: true;
+    })): Promise<PendingTransactionResponse>;
     /**
      * Sign a transaction that can later be submitted to the chain.
      * This function is essential for ensuring the authenticity of the transaction by using the provided account's signing capabilities.