@account-kit/signer 4.60.1 → 4.61.0

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.60.1";
+export declare const VERSION = "4.61.0";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@account-kit/signer",
-  "version": "4.60.1",
+  "version": "4.61.0",
   "description": "Core interfaces and clients for interfacing with the Alchemy Signer API",
   "author": "Alchemy",
   "license": "MIT",
@@ -48,8 +48,8 @@
     "typescript-template": "*"
   },
   "dependencies": {
-    "@aa-sdk/core": "^4.60.1",
-    "@account-kit/logging": "^4.60.1",
+    "@aa-sdk/core": "^4.61.0",
+    "@account-kit/logging": "^4.61.0",
     "@noble/curves": "^1.9.2",
     "@noble/hashes": "1.7.1",
     "@noble/secp256k1": "^2.3.0",
@@ -78,5 +78,5 @@
     "url": "https://github.com/alchemyplatform/aa-sdk/issues"
   },
   "homepage": "https://github.com/alchemyplatform/aa-sdk#readme",
-  "gitHead": "a12e3557ed0067bfe432d427280b8b4495a8a748"
+  "gitHead": "cb25c3a1f44b589de97fefcf930fc373a6ff9bc9"
 }

package/src/base.ts

@@ -960,11 +960,9 @@ export abstract class BaseAlchemySigner<TClient extends BaseSignerClient>
    * ```
    *
    * @param {unknown} params export wallet parameters
-   * @returns {boolean} true if the wallet was exported successfully
+   * @returns {Promise<unknown>} the result of the wallet export operation
    */
-  exportWallet: (
-    params: Parameters<(typeof this.inner)["exportWallet"]>[0],
-  ) => Promise<boolean> = async (params) => {
+  exportWallet: TClient["exportWallet"] = async (params) => {
     return this.inner.exportWallet(params);
   };
 

package/src/client/base.ts

@@ -15,7 +15,6 @@ import { getDefaultProviderCustomization } from "../oauth.js";
 import type { OauthMode } from "../signer.js";
 import { base64UrlEncode } from "../utils/base64UrlEncode.js";
 import { resolveRelativeUrl } from "../utils/resolveRelativeUrl.js";
-import { assertNever } from "../utils/typeAssertions.js";
 import type {
   AlchemySignerClientEvent,
   AlchemySignerClientEvents,
@@ -81,7 +80,10 @@ const withHexPrefix = (hex: string) => `0x${hex}` as const;
 /**
  * Base class for all Alchemy Signer clients
  */
-export abstract class BaseSignerClient<TExportWalletParams = unknown> {
+export abstract class BaseSignerClient<
+  TExportWalletParams = unknown,
+  TExportWalletOutput = unknown,
+> {
   private _user: User | undefined;
   private connectionConfig: ConnectionConfig;
   protected turnkeyClient: TurnkeyClient;
@@ -137,29 +139,6 @@ export abstract class BaseSignerClient<TExportWalletParams = unknown> {
     this.turnkeyClient.stamper = stamper;
   }
 
-  /**
-   * Exports wallet credentials based on the specified type, either as a SEED_PHRASE or PRIVATE_KEY.
-   *
-   * @param {object} params The parameters for exporting the wallet
-   * @param {ExportWalletStamper} params.exportStamper The stamper used for exporting the wallet
-   * @param {"SEED_PHRASE" | "PRIVATE_KEY"} params.exportAs Specifies the format for exporting the wallet, either as a SEED_PHRASE or PRIVATE_KEY
-   * @returns {Promise<boolean>} A promise that resolves to true if the export is successful
-   */
-  protected exportWalletInner(params: {
-    exportStamper: ExportWalletStamper;
-    exportAs: "SEED_PHRASE" | "PRIVATE_KEY";
-  }): Promise<boolean> {
-    const { exportAs } = params;
-    switch (exportAs) {
-      case "PRIVATE_KEY":
-        return this.exportAsPrivateKey(params.exportStamper);
-      case "SEED_PHRASE":
-        return this.exportAsSeedPhrase(params.exportStamper);
-      default:
-        assertNever(exportAs, `Unknown export mode: ${exportAs}`);
-    }
-  }
-
   /**
    * Authenticates the user by either email or passkey account creation flow. Emits events during the process.
    *
@@ -265,7 +244,9 @@ export abstract class BaseSignerClient<TExportWalletParams = unknown> {
 
   public abstract disconnect(): Promise<void>;
 
-  public abstract exportWallet(params: TExportWalletParams): Promise<boolean>;
+  public abstract exportWallet(
+    params: TExportWalletParams,
+  ): Promise<TExportWalletOutput>;
 
   public abstract targetPublicKey(): Promise<string>;
 
@@ -1141,94 +1122,6 @@ export abstract class BaseSignerClient<TExportWalletParams = unknown> {
   // #endregion
 
   // #region PRIVATE METHODS
-  private exportAsSeedPhrase = async (stamper: ExportWalletStamper) => {
-    if (!this.user) {
-      throw new NotAuthenticatedError();
-    }
-
-    const { wallets } = await this.turnkeyClient.getWallets({
-      organizationId: this.user.orgId,
-    });
-
-    const walletAccounts = await Promise.all(
-      wallets.map(({ walletId }) =>
-        this.turnkeyClient.getWalletAccounts({
-          organizationId: this.user!.orgId,
-          walletId,
-        }),
-      ),
-    ).then((x) => x.flatMap((x) => x.accounts));
-
-    const walletAccount = walletAccounts.find(
-      (x) => x.address === this.user!.address,
-    );
-
-    if (!walletAccount) {
-      throw new Error(
-        `Could not find wallet associated with ${this.user.address}`,
-      );
-    }
-
-    const { activity } = await this.turnkeyClient.exportWallet({
-      organizationId: this.user.orgId,
-      type: "ACTIVITY_TYPE_EXPORT_WALLET",
-      timestampMs: Date.now().toString(),
-      parameters: {
-        walletId: walletAccount!.walletId,
-        targetPublicKey: stamper.publicKey()!,
-      },
-    });
-
-    const { exportBundle } = await this.pollActivityCompletion(
-      activity,
-      this.user.orgId,
-      "exportWalletResult",
-    );
-
-    const result = await stamper.injectWalletExportBundle(
-      exportBundle,
-      this.user.orgId,
-    );
-
-    if (!result) {
-      throw new Error("Failed to inject wallet export bundle");
-    }
-
-    return result;
-  };
-
-  private exportAsPrivateKey = async (stamper: ExportWalletStamper) => {
-    if (!this.user) {
-      throw new NotAuthenticatedError();
-    }
-
-    const { activity } = await this.turnkeyClient.exportWalletAccount({
-      organizationId: this.user.orgId,
-      type: "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT",
-      timestampMs: Date.now().toString(),
-      parameters: {
-        address: this.user.address,
-        targetPublicKey: stamper.publicKey()!,
-      },
-    });
-
-    const { exportBundle } = await this.pollActivityCompletion(
-      activity,
-      this.user.orgId,
-      "exportWalletAccountResult",
-    );
-
-    const result = await stamper.injectKeyExportBundle(
-      exportBundle,
-      this.user.orgId,
-    );
-
-    if (!result) {
-      throw new Error("Failed to inject wallet export bundle");
-    }
-
-    return result;
-  };
 
   /**
    * Returns the authentication url for the selected OAuth Proivder

package/src/client/index.ts

@@ -5,7 +5,9 @@ import { WebauthnStamper } from "@turnkey/webauthn-stamper";
 import { z } from "zod";
 import type { AuthParams } from "../signer.js";
 import { generateRandomBuffer } from "../utils/generateRandomBuffer.js";
-import { BaseSignerClient } from "./base.js";
+import { assertNever } from "../utils/typeAssertions.js";
+import { BaseSignerClient, type ExportWalletStamper } from "./base.js";
+import { NotAuthenticatedError } from "../errors.js";
 import type {
   AlchemySignerClientEvents,
   AuthenticatingEventMetadata,
@@ -22,6 +24,7 @@ import type {
   GetWebAuthnAttestationResult,
   IdTokenOnly,
   SmsAuthParams,
+  ExportWalletOutput,
 } from "./types.js";
 import { MfaRequiredError } from "../errors.js";
 import { parseMfaError } from "../utils/parseMfaError.js";
@@ -54,7 +57,10 @@ export type AlchemySignerClientParams = z.input<
  * A lower level client used by the AlchemySigner used to communicate with
  * Alchemy's signer service.
  */
-export class AlchemySignerWebClient extends BaseSignerClient<ExportWalletParams> {
+export class AlchemySignerWebClient extends BaseSignerClient<
+  ExportWalletParams,
+  ExportWalletOutput
+> {
   private iframeStamper: IframeStamper;
   private webauthnStamper: WebauthnStamper;
   oauthCallbackUrl: string;
@@ -389,7 +395,7 @@ export class AlchemySignerWebClient extends BaseSignerClient<ExportWalletParams>
   public override exportWallet = async ({
     iframeContainerId,
     iframeElementId = "turnkey-export-iframe",
-  }: ExportWalletParams) => {
+  }: ExportWalletParams): Promise<ExportWalletOutput> => {
     const exportWalletIframeStamper = new IframeStamper({
       iframeContainer: document.getElementById(iframeContainerId),
       iframeElementId: iframeElementId,
@@ -410,6 +416,29 @@ export class AlchemySignerWebClient extends BaseSignerClient<ExportWalletParams>
     });
   };
 
+  /**
+   * Exports wallet credentials based on the specified type, either as a SEED_PHRASE or PRIVATE_KEY.
+   *
+   * @param {object} params The parameters for exporting the wallet
+   * @param {ExportWalletStamper} params.exportStamper The stamper used for exporting the wallet
+   * @param {"SEED_PHRASE" | "PRIVATE_KEY"} params.exportAs Specifies the format for exporting the wallet, either as a SEED_PHRASE or PRIVATE_KEY
+   * @returns {Promise<boolean>} A promise that resolves to true if the export is successful
+   */
+  protected exportWalletInner(params: {
+    exportStamper: ExportWalletStamper;
+    exportAs: "SEED_PHRASE" | "PRIVATE_KEY";
+  }): Promise<ExportWalletOutput> {
+    const { exportAs } = params;
+    switch (exportAs) {
+      case "PRIVATE_KEY":
+        return this.exportAsPrivateKey(params.exportStamper);
+      case "SEED_PHRASE":
+        return this.exportAsSeedPhrase(params.exportStamper);
+      default:
+        assertNever(exportAs, `Unknown export mode: ${exportAs}`);
+    }
+  }
+
   /**
    * Asynchronous function that clears the user and resets the iframe stamper.
    *
@@ -748,6 +777,96 @@ export class AlchemySignerWebClient extends BaseSignerClient<ExportWalletParams>
       ];
     }
   }
+
+  private exportAsSeedPhrase = async (stamper: ExportWalletStamper) => {
+    if (!this.user) {
+      throw new NotAuthenticatedError();
+    }
+
+    const { wallets } = await this.turnkeyClient.getWallets({
+      organizationId: this.user.orgId,
+    });
+
+    const walletAccountResponses = await Promise.all(
+      wallets.map(({ walletId }) =>
+        this.turnkeyClient.getWalletAccounts({
+          organizationId: this.user!.orgId,
+          walletId,
+        }),
+      ),
+    );
+    const walletAccounts = walletAccountResponses.flatMap((x) => x.accounts);
+
+    const walletAccount = walletAccounts.find(
+      (x) => x.address.toLowerCase() === this.user!.address.toLowerCase(),
+    );
+
+    if (!walletAccount) {
+      throw new Error(
+        `Could not find wallet associated with ${this.user.address}`,
+      );
+    }
+
+    const { activity } = await this.turnkeyClient.exportWallet({
+      organizationId: this.user.orgId,
+      type: "ACTIVITY_TYPE_EXPORT_WALLET",
+      timestampMs: Date.now().toString(),
+      parameters: {
+        walletId: walletAccount!.walletId,
+        targetPublicKey: stamper.publicKey()!,
+      },
+    });
+
+    const { exportBundle } = await this.pollActivityCompletion(
+      activity,
+      this.user.orgId,
+      "exportWalletResult",
+    );
+
+    const result = await stamper.injectWalletExportBundle(
+      exportBundle,
+      this.user.orgId,
+    );
+
+    if (!result) {
+      throw new Error("Failed to inject wallet export bundle");
+    }
+
+    return result;
+  };
+
+  private exportAsPrivateKey = async (stamper: ExportWalletStamper) => {
+    if (!this.user) {
+      throw new NotAuthenticatedError();
+    }
+
+    const { activity } = await this.turnkeyClient.exportWalletAccount({
+      organizationId: this.user.orgId,
+      type: "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT",
+      timestampMs: Date.now().toString(),
+      parameters: {
+        address: this.user.address,
+        targetPublicKey: stamper.publicKey()!,
+      },
+    });
+
+    const { exportBundle } = await this.pollActivityCompletion(
+      activity,
+      this.user.orgId,
+      "exportWalletAccountResult",
+    );
+
+    const result = await stamper.injectKeyExportBundle(
+      exportBundle,
+      this.user.orgId,
+    );
+
+    if (!result) {
+      throw new Error("Failed to inject wallet export bundle");
+    }
+
+    return result;
+  };
 }
 
 /**

package/src/client/types.ts

@@ -30,6 +30,8 @@ export type ExportWalletParams = {
   iframeElementId?: string;
 };
 
+export type ExportWalletOutput = boolean;
+
 export type CreateAccountParams =
   | {
       type: "email";

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is autogenerated by inject-version.ts. Any changes will be
 // overwritten on commit!
-export const VERSION = "4.60.1";
+export const VERSION = "4.61.0";