@account-kit/signer 4.0.0-alpha.9 → 4.0.0-beta.1

package/dist/esm/client/base.d.ts

@@ -1,5 +1,5 @@
 import { type ConnectionConfig } from "@aa-sdk/core";
-import { TurnkeyClient } from "@turnkey/http";
+import { TurnkeyClient, type TSignedRequest } from "@turnkey/http";
 import EventEmitter from "eventemitter3";
 import type { Hex } from "viem";
 import type { AlchemySignerClientEvents, CreateAccountParams, EmailAuthParams, GetWebAuthnAttestationResult, SignerBody, SignerResponse, SignupResponse, User } from "./types.js";
@@ -14,16 +14,37 @@ export type ExportWalletStamper = TurnkeyClient["stamper"] & {
     injectKeyExportBundle(bundle: string): Promise<boolean>;
     publicKey(): string | null;
 };
+/**
+ * Base class for all Alchemy Signer clients
+ */
 export declare abstract class BaseSignerClient<TExportWalletParams = unknown> {
     private _user;
     private connectionConfig;
     protected turnkeyClient: TurnkeyClient;
     protected rootOrg: string;
     protected eventEmitter: EventEmitter<AlchemySignerClientEvents>;
+    /**
+     * Create a new instance of the Alchemy Signer client
+     *
+     * @param {BaseSignerClientParams} params the parameters required to create the client
+     */
     constructor(params: BaseSignerClientParams);
     protected get user(): User | undefined;
     protected set user(user: User | undefined);
+    /**
+     * Sets the stamper of the TurnkeyClient.
+     *
+     * @param {TurnkeyClient["stamper"]} stamper the stamper function to set for the TurnkeyClient
+     */
     protected setStamper(stamper: TurnkeyClient["stamper"]): void;
+    /**
+     * 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";
@@ -42,14 +63,72 @@ export declare abstract class BaseSignerClient<TExportWalletParams = unknown> {
     protected abstract getWebAuthnAttestation(options: CredentialCreationOptions, userDetails?: {
         username: string;
     }): Promise<GetWebAuthnAttestationResult>;
+    /**
+     * Listen to events emitted by the client
+     *
+     * @param {AlchemySignerClientEvent} event the event you want to listen to
+     * @param {AlchemySignerClientEvents[AlchemySignerClientEvent]} listener the callback function to execute when an event is fired
+     * @returns {() => void} a function that will remove the listener when called
+     */
     on: <E extends keyof AlchemySignerClientEvents>(event: E, listener: AlchemySignerClientEvents[E]) => () => EventEmitter<AlchemySignerClientEvents, any>;
+    /**
+     * Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.
+     *
+     * @param {CredentialCreationOptions} options The options used to create the WebAuthn attestation
+     * @returns {Promise<string[]>} A promise that resolves to an array of authenticator IDs
+     * @throws {NotAuthenticatedError} If the user is not authenticated
+     */
     addPasskey: (options: CredentialCreationOptions) => Promise<string[]>;
+    /**
+     * Retrieves the current user or fetches the user information if not already available.
+     *
+     * @param {string} [orgId] optional organization ID, defaults to the user's organization ID
+     * @returns {Promise<User>} A promise that resolves to the user object
+     * @throws {Error} if no organization ID is provided when there is no current user
+     */
     whoami: (orgId?: string | undefined) => Promise<User>;
+    /**
+     * Generates a stamped whoami request for the current user. This request can then be used to call /signer/v1/whoami to get the user information.
+     * This is useful if you want to get the user information in a different context like a server. You can pass the stamped request to the server
+     * and then call our API to get the user information. Using this stamp is the most trusted way to get the user information since a stamp can only
+     * belong to the user who created it.
+     *
+     * @returns {Promise<TSignedRequest>} a promise that resolves to the "whoami" information for the logged in user
+     * @throws {Error} if no organization ID is provided
+     */
+    stampWhoami: () => Promise<TSignedRequest>;
+    /**
+     * Looks up information based on an email address.
+     *
+     * @param {string} email the email address to look up
+     * @returns {Promise<any>} the result of the lookup request
+     */
     lookupUserByEmail: (email: string) => Promise<{
         orgId: string | null;
     }>;
+    /**
+     * This will sign a message with the user's private key, without doing any transformations on the message.
+     * For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass
+     * that result here.
+     *
+     * @param {Hex} msg the hex representation of the bytes to sign
+     * @returns {Promise<Hex>} the signature over the raw hex
+     */
     signRawMessage: (msg: Hex) => Promise<Hex>;
+    /**
+     * Returns the current user or null if no user is set.
+     *
+     * @returns {User | null} the current user object or null if no user is available
+     */
     getUser: () => User | null;
+    /**
+     * Sends a POST request to the given signer route with the specified body and returns the response.
+     * Not intended to be used directly, use the specific methods instead on the client instead.
+     *
+     * @param {SignerRoutes} route The route to which the request should be sent
+     * @param {SignerBody<R>} body The request body containing the data to be sent
+     * @returns {Promise<SignerResponse<R>>} A promise that resolves to the response from the signer
+     */
     request: <R extends "/v1/signup" | "/v1/whoami" | "/v1/auth" | "/v1/lookup" | "/v1/sign-payload">(route: R, body: SignerBody<R>) => Promise<SignerResponse<R>>;
     private exportAsSeedPhrase;
     private exportAsPrivateKey;

package/dist/esm/client/base.js

@@ -3,7 +3,15 @@ import { TurnkeyClient } from "@turnkey/http";
 import EventEmitter from "eventemitter3";
 import { NotAuthenticatedError } from "../errors.js";
 import { base64UrlEncode } from "../utils/base64UrlEncode.js";
+/**
+ * Base class for all Alchemy Signer clients
+ */
 export class BaseSignerClient {
+    /**
+     * Create a new instance of the Alchemy Signer client
+     *
+     * @param {BaseSignerClientParams} params the parameters required to create the client
+     */
     constructor(params) {
         Object.defineProperty(this, "_user", {
             enumerable: true,
@@ -35,6 +43,15 @@ export class BaseSignerClient {
             writable: true,
             value: void 0
         });
+        // #endregion
+        // #region PUBLIC METHODS
+        /**
+         * Listen to events emitted by the client
+         *
+         * @param {AlchemySignerClientEvent} event the event you want to listen to
+         * @param {AlchemySignerClientEvents[AlchemySignerClientEvent]} listener the callback function to execute when an event is fired
+         * @returns {() => void} a function that will remove the listener when called
+         */
         Object.defineProperty(this, "on", {
             enumerable: true,
             configurable: true,
@@ -44,6 +61,13 @@ export class BaseSignerClient {
                 return () => this.eventEmitter.removeListener(event, listener);
             }
         });
+        /**
+         * Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.
+         *
+         * @param {CredentialCreationOptions} options The options used to create the WebAuthn attestation
+         * @returns {Promise<string[]>} A promise that resolves to an array of authenticator IDs
+         * @throws {NotAuthenticatedError} If the user is not authenticated
+         */
         Object.defineProperty(this, "addPasskey", {
             enumerable: true,
             configurable: true,
@@ -72,6 +96,13 @@ export class BaseSignerClient {
                 return authenticatorIds;
             }
         });
+        /**
+         * Retrieves the current user or fetches the user information if not already available.
+         *
+         * @param {string} [orgId] optional organization ID, defaults to the user's organization ID
+         * @returns {Promise<User>} A promise that resolves to the user object
+         * @throws {Error} if no organization ID is provided when there is no current user
+         */
         Object.defineProperty(this, "whoami", {
             enumerable: true,
             configurable: true,
@@ -105,6 +136,34 @@ export class BaseSignerClient {
                 return this.user;
             }
         });
+        /**
+         * Generates a stamped whoami request for the current user. This request can then be used to call /signer/v1/whoami to get the user information.
+         * This is useful if you want to get the user information in a different context like a server. You can pass the stamped request to the server
+         * and then call our API to get the user information. Using this stamp is the most trusted way to get the user information since a stamp can only
+         * belong to the user who created it.
+         *
+         * @returns {Promise<TSignedRequest>} a promise that resolves to the "whoami" information for the logged in user
+         * @throws {Error} if no organization ID is provided
+         */
+        Object.defineProperty(this, "stampWhoami", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async () => {
+                if (!this.user) {
+                    throw new Error("User must be authenticated to stamp a whoami request");
+                }
+                return await this.turnkeyClient.stampGetWhoami({
+                    organizationId: this.user.orgId,
+                });
+            }
+        });
+        /**
+         * Looks up information based on an email address.
+         *
+         * @param {string} email the email address to look up
+         * @returns {Promise<any>} the result of the lookup request
+         */
         Object.defineProperty(this, "lookupUserByEmail", {
             enumerable: true,
             configurable: true,
@@ -113,6 +172,14 @@ export class BaseSignerClient {
                 return this.request("/v1/lookup", { email });
             }
         });
+        /**
+         * This will sign a message with the user's private key, without doing any transformations on the message.
+         * For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass
+         * that result here.
+         *
+         * @param {Hex} msg the hex representation of the bytes to sign
+         * @returns {Promise<Hex>} the signature over the raw hex
+         */
         Object.defineProperty(this, "signRawMessage", {
             enumerable: true,
             configurable: true,
@@ -138,6 +205,11 @@ export class BaseSignerClient {
                 return signature;
             }
         });
+        /**
+         * Returns the current user or null if no user is set.
+         *
+         * @returns {User | null} the current user object or null if no user is available
+         */
         Object.defineProperty(this, "getUser", {
             enumerable: true,
             configurable: true,
@@ -146,6 +218,14 @@ export class BaseSignerClient {
                 return this.user ?? null;
             }
         });
+        /**
+         * Sends a POST request to the given signer route with the specified body and returns the response.
+         * Not intended to be used directly, use the specific methods instead on the client instead.
+         *
+         * @param {SignerRoutes} route The route to which the request should be sent
+         * @param {SignerBody<R>} body The request body containing the data to be sent
+         * @returns {Promise<SignerResponse<R>>} A promise that resolves to the response from the signer
+         */
         Object.defineProperty(this, "request", {
             enumerable: true,
             configurable: true,
@@ -173,6 +253,8 @@ export class BaseSignerClient {
                 return json;
             }
         });
+        // #endregion
+        // #region PRIVATE METHODS
         Object.defineProperty(this, "exportAsSeedPhrase", {
             enumerable: true,
             configurable: true,
@@ -234,6 +316,7 @@ export class BaseSignerClient {
                 return result;
             }
         });
+        // eslint-disable-next-line eslint-rules/require-jsdoc-on-reexported-functions
         Object.defineProperty(this, "pollActivityCompletion", {
             enumerable: true,
             configurable: true,
@@ -254,6 +337,7 @@ export class BaseSignerClient {
                     status === "ACTIVITY_STATUS_CONSENSUS_NEEDED") {
                     throw new Error(`Failed to get activity with with id ${id} (status: ${status})`);
                 }
+                // TODO: add ability to configure this + add exponential backoff
                 await new Promise((resolve) => setTimeout(resolve, 500));
                 return this.pollActivityCompletion(activity, organizationId, resultKey);
             }
@@ -276,9 +360,22 @@ export class BaseSignerClient {
         }
         this._user = user;
     }
+    /**
+     * Sets the stamper of the TurnkeyClient.
+     *
+     * @param {TurnkeyClient["stamper"]} stamper the stamper function to set for the TurnkeyClient
+     */
     setStamper(stamper) {
         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
+     */
     exportWalletInner(params) {
         switch (params.exportAs) {
             case "PRIVATE_KEY":

package/dist/esm/client/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/client/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AA8B9D,MAAM,OAAgB,gBAAgB;IAYpC,YAAY,MAA8B;QAXlC;;;;;WAAwB;QACxB;;;;;WAAmC;QACjC;;;;;WAA6B;QAC7B;;;;;WAAgB;QAChB;;;;;WAAsD;QAmGzD;;;;mBAAK,CACV,KAAQ,EACR,QAAsC,EACtC,EAAE;gBACF,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,QAAe,CAAC,CAAC;gBAE7C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAe,CAAC,CAAC;YACxE,CAAC;WAAC;QASK;;;;mBAAa,KAAK,EAAE,OAAkC,EAAE,EAAE;gBAC/D,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBACD,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAClE,OAAO,CACR,CAAC;gBAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC;oBACjE,IAAI,EAAE,wCAAwC;oBAC9C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,UAAU,EAAE;wBACV,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;wBACxB,cAAc,EAAE;4BACd;gCACE,WAAW;gCACX,iBAAiB,EAAE,WAAW,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE;gCACrD,SAAS,EAAE,eAAe,CAAC,SAAS,CAAC;6BACtC;yBACF;qBACF;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAC5D,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,4BAA4B,CAC7B,CAAC;gBAEF,OAAO,gBAAgB,CAAC;YAC1B,CAAC;WAAC;QASK;;;;mBAAS,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,EAAiB,EAAE;gBAChE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,OAAO,IAAI,CAAC,IAAI,CAAC;gBACnB,CAAC;gBAED,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACvC,CAAC;gBAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;oBAC7D,cAAc,EAAE,KAAK;iBACtB,CAAC,CAAC;gBAEH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;oBAC5C,cAAc;iBACf,CAAC,CAAC;gBAEH,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE;oBACzB,IAAI,CAAC;wBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC;6BACtD,YAAsB,CAAC;oBAC5B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,OAAO,SAAS,CAAC;oBACnB,CAAC;gBACH,CAAC,CAAC,EAAE,CAAC;gBAEL,IAAI,CAAC,IAAI,GAAG;oBACV,GAAG,IAAI;oBACP,YAAY;iBACb,CAAC;gBAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACnB,CAAC;WAAC;QAQK;;;;mBAAoB,KAAK,EAAE,KAAa,EAAE,EAAE;gBACjD,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,CAAC;WAAC;QAUK;;;;mBAAiB,KAAK,EAAE,GAAQ,EAAgB,EAAE;gBACvD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;oBAClE,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,mCAAmC;oBACzC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,QAAQ,EAAE,8BAA8B;wBACxC,YAAY,EAAE,qBAAqB;wBACnC,OAAO,EAAE,GAAG;wBACZ,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;qBAC5B;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;oBAC3D,cAAc;iBACf,CAAC,CAAC;gBAEH,OAAO,SAAS,CAAC;YACnB,CAAC;WAAC;QAOK;;;;mBAAU,GAAgB,EAAE;gBACjC,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;YAC3B,CAAC;WAAC;QAUK;;;;mBAAU,KAAK,EACpB,KAAQ,EACR,IAAmB,EACS,EAAE;gBAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,2BAA2B,CAAC;gBACxE,MAAM,QAAQ,GAAG,SAAS,CAAC;gBAE3B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC9B,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;gBACnD,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;oBACjC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC5E,CAAC;qBAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;oBACrC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;gBACzE,CAAC;gBAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE;oBACxD,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC1B,OAAO;iBACR,CAAC,CAAC;gBAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBACzC,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAEnC,OAAO,IAAyB,CAAC;YACnC,CAAC;WAAC;QAKM;;;;mBAAqB,KAAK,EAAE,OAA4B,EAAE,EAAE;gBAClE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;oBACtD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;iBAChC,CAAC,CAAC;gBAEH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAC3B,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;oBACnC,cAAc,EAAE,IAAI,CAAC,IAAK,CAAC,KAAK;oBAChC,QAAQ;iBACT,CAAC,CACH,CACF,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5C,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,IAAK,CAAC,OAAO,CACxC,CAAC;gBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAC7D,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;oBACzD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,6BAA6B;oBACnC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,QAAQ,EAAE,aAAc,CAAC,QAAQ;wBACjC,eAAe,EAAE,OAAO,CAAC,SAAS,EAAG;qBACtC;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CACxD,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,oBAAoB,CACrB,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC;gBAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC;WAAC;QAEM;;;;mBAAqB,KAAK,EAAE,OAA4B,EAAE,EAAE;gBAClE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;oBAChE,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,qCAAqC;oBAC3C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;wBAC1B,eAAe,EAAE,OAAO,CAAC,SAAS,EAAG;qBACtC;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CACxD,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,2BAA2B,CAC5B,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;gBAEjE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC;WAAC;QAGQ;;;;mBAAyB,KAAK,EAKtC,QAEa,EACb,cAAsB,EACtB,SAAY,EAOZ,EAAE;gBACF,IAAI,QAAQ,CAAC,MAAM,KAAK,2BAA2B,EAAE,CAAC;oBACpD,OAAO,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC;gBACrC,CAAC;gBAED,MAAM,EACJ,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GACjC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;oBACvC,UAAU,EAAE,QAAQ,CAAC,EAAE;oBACvB,cAAc;iBACf,CAAC,CAAC;gBAEH,IAAI,MAAM,KAAK,2BAA2B,EAAE,CAAC;oBAC3C,OAAO,MAAM,CAAC,SAAS,CAAE,CAAC;gBAC5B,CAAC;gBAED,IACE,MAAM,KAAK,wBAAwB;oBACnC,MAAM,KAAK,0BAA0B;oBACrC,MAAM,KAAK,kCAAkC,EAC7C,CAAC;oBACD,MAAM,IAAI,KAAK,CACb,uCAAuC,EAAE,aAAa,MAAM,GAAG,CAChE,CAAC;gBACJ,CAAC;gBAGD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;gBAEzD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;YAC1E,CAAC;WAAC;QAnZA,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAElD,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,sCAAsC,CAAC;QACnE,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,EAA6B,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CACpC,EAAE,OAAO,EAAE,yBAAyB,EAAE,EACtC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,IAAc,IAAI;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAc,IAAI,CAAC,IAAsB;QACvC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAOS,UAAU,CAAC,OAAiC;QACpD,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IACvC,CAAC;IAUS,iBAAiB,CAAC,MAG3B;QACC,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;YACxB,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YACvD,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CAiWF","sourcesContent":["import { type ConnectionConfig, ConnectionConfigSchema } from \"@aa-sdk/core\";\nimport { TurnkeyClient } from \"@turnkey/http\";\nimport EventEmitter from \"eventemitter3\";\nimport type { Hex } from \"viem\";\nimport { NotAuthenticatedError } from \"../errors.js\";\nimport { base64UrlEncode } from \"../utils/base64UrlEncode.js\";\nimport type {\n  AlchemySignerClientEvent,\n  AlchemySignerClientEvents,\n  CreateAccountParams,\n  EmailAuthParams,\n  GetWebAuthnAttestationResult,\n  SignerBody,\n  SignerResponse,\n  SignerRoutes,\n  SignupResponse,\n  User,\n} from \"./types.js\";\n\nexport interface BaseSignerClientParams {\n  stamper: TurnkeyClient[\"stamper\"];\n  connection: ConnectionConfig;\n  rootOrgId?: string;\n  rpId?: string;\n}\n\nexport type ExportWalletStamper = TurnkeyClient[\"stamper\"] & {\n  injectWalletExportBundle(bundle: string): Promise<boolean>;\n  injectKeyExportBundle(bundle: string): Promise<boolean>;\n  publicKey(): string | null;\n};\n\n/**\n * Base class for all Alchemy Signer clients\n */\nexport abstract class BaseSignerClient<TExportWalletParams = unknown> {\n  private _user: User | undefined;\n  private connectionConfig: ConnectionConfig;\n  protected turnkeyClient: TurnkeyClient;\n  protected rootOrg: string;\n  protected eventEmitter: EventEmitter<AlchemySignerClientEvents>;\n\n  /**\n   * Create a new instance of the Alchemy Signer client\n   *\n   * @param {BaseSignerClientParams} params the parameters required to create the client\n   */\n  constructor(params: BaseSignerClientParams) {\n    const { stamper, connection, rootOrgId } = params;\n\n    this.rootOrg = rootOrgId ?? \"24c1acf5-810f-41e0-a503-d5d13fa8e830\";\n    this.eventEmitter = new EventEmitter<AlchemySignerClientEvents>();\n    this.connectionConfig = ConnectionConfigSchema.parse(connection);\n    this.turnkeyClient = new TurnkeyClient(\n      { baseUrl: \"https://api.turnkey.com\" },\n      stamper\n    );\n  }\n\n  protected get user() {\n    return this._user;\n  }\n\n  protected set user(user: User | undefined) {\n    if (user && !this._user) {\n      this.eventEmitter.emit(\"connected\", user);\n    } else if (!user && this._user) {\n      this.eventEmitter.emit(\"disconnected\");\n    }\n\n    this._user = user;\n  }\n\n  /**\n   * Sets the stamper of the TurnkeyClient.\n   *\n   * @param {TurnkeyClient[\"stamper\"]} stamper the stamper function to set for the TurnkeyClient\n   */\n  protected setStamper(stamper: TurnkeyClient[\"stamper\"]) {\n    this.turnkeyClient.stamper = stamper;\n  }\n\n  /**\n   * Exports wallet credentials based on the specified type, either as a SEED_PHRASE or PRIVATE_KEY.\n   *\n   * @param {object} params The parameters for exporting the wallet\n   * @param {ExportWalletStamper} params.exportStamper The stamper used for exporting the wallet\n   * @param {\"SEED_PHRASE\" | \"PRIVATE_KEY\"} params.exportAs Specifies the format for exporting the wallet, either as a SEED_PHRASE or PRIVATE_KEY\n   * @returns {Promise<boolean>} A promise that resolves to true if the export is successful\n   */\n  protected exportWalletInner(params: {\n    exportStamper: ExportWalletStamper;\n    exportAs: \"SEED_PHRASE\" | \"PRIVATE_KEY\";\n  }): Promise<boolean> {\n    switch (params.exportAs) {\n      case \"PRIVATE_KEY\":\n        return this.exportAsPrivateKey(params.exportStamper);\n      case \"SEED_PHRASE\":\n        return this.exportAsSeedPhrase(params.exportStamper);\n    }\n  }\n\n  // #region ABSTRACT METHODS\n\n  public abstract createAccount(\n    params: CreateAccountParams\n  ): Promise<SignupResponse>;\n\n  public abstract initEmailAuth(\n    params: Omit<EmailAuthParams, \"targetPublicKey\">\n  ): Promise<{ orgId: string }>;\n\n  public abstract completeEmailAuth(params: {\n    bundle: string;\n    orgId: string;\n  }): Promise<User>;\n\n  public abstract disconnect(): Promise<void>;\n\n  public abstract exportWallet(params: TExportWalletParams): Promise<boolean>;\n\n  public abstract lookupUserWithPasskey(user?: User): Promise<User>;\n\n  protected abstract getWebAuthnAttestation(\n    options: CredentialCreationOptions,\n    userDetails?: { username: string }\n  ): Promise<GetWebAuthnAttestationResult>;\n\n  // #endregion\n\n  // #region PUBLIC METHODS\n\n  /**\n   * Listen to events emitted by the client\n   *\n   * @param {AlchemySignerClientEvent} event the event you want to listen to\n   * @param {AlchemySignerClientEvents[AlchemySignerClientEvent]} listener the callback function to execute when an event is fired\n   * @returns {() => void} a function that will remove the listener when called\n   */\n  public on = <E extends AlchemySignerClientEvent>(\n    event: E,\n    listener: AlchemySignerClientEvents[E]\n  ) => {\n    this.eventEmitter.on(event, listener as any);\n\n    return () => this.eventEmitter.removeListener(event, listener as any);\n  };\n\n  /**\n   * Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.\n   *\n   * @param {CredentialCreationOptions} options The options used to create the WebAuthn attestation\n   * @returns {Promise<string[]>} A promise that resolves to an array of authenticator IDs\n   * @throws {NotAuthenticatedError} If the user is not authenticated\n   */\n  public addPasskey = async (options: CredentialCreationOptions) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n    const { attestation, challenge } = await this.getWebAuthnAttestation(\n      options\n    );\n\n    const { activity } = await this.turnkeyClient.createAuthenticators({\n      type: \"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2\",\n      timestampMs: Date.now().toString(),\n      organizationId: this.user.orgId,\n      parameters: {\n        userId: this.user.userId,\n        authenticators: [\n          {\n            attestation,\n            authenticatorName: `passkey-${Date.now().toString()}`,\n            challenge: base64UrlEncode(challenge),\n          },\n        ],\n      },\n    });\n\n    const { authenticatorIds } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"createAuthenticatorsResult\"\n    );\n\n    return authenticatorIds;\n  };\n\n  /**\n   * Retrieves the current user or fetches the user information if not already available.\n   *\n   * @param {string} [orgId] optional organization ID, defaults to the user's organization ID\n   * @returns {Promise<User>} A promise that resolves to the user object\n   * @throws {Error} if no organization ID is provided when there is no current user\n   */\n  public whoami = async (orgId = this.user?.orgId): Promise<User> => {\n    if (this.user) {\n      return this.user;\n    }\n\n    if (!orgId) {\n      throw new Error(\"No orgId provided\");\n    }\n\n    const stampedRequest = await this.turnkeyClient.stampGetWhoami({\n      organizationId: orgId,\n    });\n\n    const user = await this.request(\"/v1/whoami\", {\n      stampedRequest,\n    });\n\n    const credentialId = (() => {\n      try {\n        return JSON.parse(stampedRequest?.stamp.stampHeaderValue)\n          .credentialId as string;\n      } catch (e) {\n        return undefined;\n      }\n    })();\n\n    this.user = {\n      ...user,\n      credentialId,\n    };\n\n    return this.user;\n  };\n\n  /**\n   * Looks up information based on an email address.\n   *\n   * @param {string} email the email address to look up\n   * @returns {Promise<any>} the result of the lookup request\n   */\n  public lookupUserByEmail = async (email: string) => {\n    return this.request(\"/v1/lookup\", { email });\n  };\n\n  /**\n   * This will sign a message with the user's private key, without doing any transformations on the message.\n   * For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass\n   * that result here.\n   *\n   * @param {Hex} msg the hex representation of the bytes to sign\n   * @returns {Promise<Hex>} the signature over the raw hex\n   */\n  public signRawMessage = async (msg: Hex): Promise<Hex> => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const stampedRequest = await this.turnkeyClient.stampSignRawPayload({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        encoding: \"PAYLOAD_ENCODING_HEXADECIMAL\",\n        hashFunction: \"HASH_FUNCTION_NO_OP\",\n        payload: msg,\n        signWith: this.user.address,\n      },\n    });\n\n    const { signature } = await this.request(\"/v1/sign-payload\", {\n      stampedRequest,\n    });\n\n    return signature;\n  };\n\n  /**\n   * Returns the current user or null if no user is set.\n   *\n   * @returns {User | null} the current user object or null if no user is available\n   */\n  public getUser = (): User | null => {\n    return this.user ?? null;\n  };\n\n  /**\n   * Sends a POST request to the given signer route with the specified body and returns the response.\n   * Not intended to be used directly, use the specific methods instead on the client instead.\n   *\n   * @param {SignerRoutes} route The route to which the request should be sent\n   * @param {SignerBody<R>} body The request body containing the data to be sent\n   * @returns {Promise<SignerResponse<R>>} A promise that resolves to the response from the signer\n   */\n  public request = async <R extends SignerRoutes>(\n    route: R,\n    body: SignerBody<R>\n  ): Promise<SignerResponse<R>> => {\n    const url = this.connectionConfig.rpcUrl ?? \"https://api.g.alchemy.com\";\n    const basePath = \"/signer\";\n\n    const headers = new Headers();\n    headers.append(\"Content-Type\", \"application/json\");\n    if (this.connectionConfig.apiKey) {\n      headers.append(\"Authorization\", `Bearer ${this.connectionConfig.apiKey}`);\n    } else if (this.connectionConfig.jwt) {\n      headers.append(\"Authorization\", `Bearer ${this.connectionConfig.jwt}`);\n    }\n\n    const response = await fetch(`${url}${basePath}${route}`, {\n      method: \"POST\",\n      body: JSON.stringify(body),\n      headers,\n    });\n\n    if (!response.ok) {\n      throw new Error(await response.text());\n    }\n\n    const json = await response.json();\n\n    return json as SignerResponse<R>;\n  };\n\n  // #endregion\n\n  // #region PRIVATE METHODS\n  private exportAsSeedPhrase = async (stamper: ExportWalletStamper) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const { wallets } = await this.turnkeyClient.getWallets({\n      organizationId: this.user.orgId,\n    });\n\n    const walletAccounts = await Promise.all(\n      wallets.map(({ walletId }) =>\n        this.turnkeyClient.getWalletAccounts({\n          organizationId: this.user!.orgId,\n          walletId,\n        })\n      )\n    ).then((x) => x.flatMap((x) => x.accounts));\n\n    const walletAccount = walletAccounts.find(\n      (x) => x.address === this.user!.address\n    );\n\n    if (!walletAccount) {\n      throw new Error(\n        `Could not find wallet associated with ${this.user.address}`\n      );\n    }\n\n    const { activity } = await this.turnkeyClient.exportWallet({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_EXPORT_WALLET\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        walletId: walletAccount!.walletId,\n        targetPublicKey: stamper.publicKey()!,\n      },\n    });\n\n    const { exportBundle } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"exportWalletResult\"\n    );\n\n    const result = await stamper.injectWalletExportBundle(exportBundle);\n\n    if (!result) {\n      throw new Error(\"Failed to inject wallet export bundle\");\n    }\n\n    return result;\n  };\n\n  private exportAsPrivateKey = async (stamper: ExportWalletStamper) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const { activity } = await this.turnkeyClient.exportWalletAccount({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        address: this.user.address,\n        targetPublicKey: stamper.publicKey()!,\n      },\n    });\n\n    const { exportBundle } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"exportWalletAccountResult\"\n    );\n\n    const result = await stamper.injectKeyExportBundle(exportBundle);\n\n    if (!result) {\n      throw new Error(\"Failed to inject wallet export bundle\");\n    }\n\n    return result;\n  };\n\n  // eslint-disable-next-line eslint-rules/require-jsdoc-on-reexported-functions\n  protected pollActivityCompletion = async <\n    T extends keyof Awaited<\n      ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n    >[\"activity\"][\"result\"]\n  >(\n    activity: Awaited<\n      ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n    >[\"activity\"],\n    organizationId: string,\n    resultKey: T\n  ): Promise<\n    NonNullable<\n      Awaited<\n        ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n      >[\"activity\"][\"result\"][T]\n    >\n  > => {\n    if (activity.status === \"ACTIVITY_STATUS_COMPLETED\") {\n      return activity.result[resultKey]!;\n    }\n\n    const {\n      activity: { status, id, result },\n    } = await this.turnkeyClient.getActivity({\n      activityId: activity.id,\n      organizationId,\n    });\n\n    if (status === \"ACTIVITY_STATUS_COMPLETED\") {\n      return result[resultKey]!;\n    }\n\n    if (\n      status === \"ACTIVITY_STATUS_FAILED\" ||\n      status === \"ACTIVITY_STATUS_REJECTED\" ||\n      status === \"ACTIVITY_STATUS_CONSENSUS_NEEDED\"\n    ) {\n      throw new Error(\n        `Failed to get activity with with id ${id} (status: ${status})`\n      );\n    }\n\n    // TODO: add ability to configure this + add exponential backoff\n    await new Promise((resolve) => setTimeout(resolve, 500));\n\n    return this.pollActivityCompletion(activity, organizationId, resultKey);\n  };\n  // #endregion\n}\n"]}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/client/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAyB,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAuB,MAAM,eAAe,CAAC;AACnE,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AA2B9D;;GAEG;AACH,MAAM,OAAgB,gBAAgB;IAOpC;;;;OAIG;IACH,YAAY,MAA8B;QAXlC;;;;;WAAwB;QACxB;;;;;WAAmC;QACjC;;;;;WAA6B;QAC7B;;;;;WAAgB;QAChB;;;;;WAAsD;QAwFhE,aAAa;QAEb,yBAAyB;QAEzB;;;;;;WAMG;QACI;;;;mBAAK,CACV,KAAQ,EACR,QAAsC,EACtC,EAAE;gBACF,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,QAAe,CAAC,CAAC;gBAE7C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAe,CAAC,CAAC;YACxE,CAAC;WAAC;QAEF;;;;;;WAMG;QACI;;;;mBAAa,KAAK,EAAE,OAAkC,EAAE,EAAE;gBAC/D,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBACD,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAClE,OAAO,CACR,CAAC;gBAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC;oBACjE,IAAI,EAAE,wCAAwC;oBAC9C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,UAAU,EAAE;wBACV,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;wBACxB,cAAc,EAAE;4BACd;gCACE,WAAW;gCACX,iBAAiB,EAAE,WAAW,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE;gCACrD,SAAS,EAAE,eAAe,CAAC,SAAS,CAAC;6BACtC;yBACF;qBACF;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAC5D,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,4BAA4B,CAC7B,CAAC;gBAEF,OAAO,gBAAgB,CAAC;YAC1B,CAAC;WAAC;QAEF;;;;;;WAMG;QACI;;;;mBAAS,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,EAAiB,EAAE;gBAChE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,OAAO,IAAI,CAAC,IAAI,CAAC;gBACnB,CAAC;gBAED,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACvC,CAAC;gBAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;oBAC7D,cAAc,EAAE,KAAK;iBACtB,CAAC,CAAC;gBAEH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;oBAC5C,cAAc;iBACf,CAAC,CAAC;gBAEH,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE;oBACzB,IAAI,CAAC;wBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC;6BACtD,YAAsB,CAAC;oBAC5B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,OAAO,SAAS,CAAC;oBACnB,CAAC;gBACH,CAAC,CAAC,EAAE,CAAC;gBAEL,IAAI,CAAC,IAAI,GAAG;oBACV,GAAG,IAAI;oBACP,YAAY;iBACb,CAAC;gBAEF,OAAO,IAAI,CAAC,IAAI,CAAC;YACnB,CAAC;WAAC;QAEF;;;;;;;;WAQG;QACI;;;;mBAAc,KAAK,IAA6B,EAAE;gBACvD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;gBAC1E,CAAC;gBAED,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;oBAC7C,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;iBAChC,CAAC,CAAC;YACL,CAAC;WAAC;QAEF;;;;;WAKG;QACI;;;;mBAAoB,KAAK,EAAE,KAAa,EAAE,EAAE;gBACjD,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,CAAC;WAAC;QAEF;;;;;;;WAOG;QACI;;;;mBAAiB,KAAK,EAAE,GAAQ,EAAgB,EAAE;gBACvD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;oBAClE,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,mCAAmC;oBACzC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,QAAQ,EAAE,8BAA8B;wBACxC,YAAY,EAAE,qBAAqB;wBACnC,OAAO,EAAE,GAAG;wBACZ,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;qBAC5B;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE;oBAC3D,cAAc;iBACf,CAAC,CAAC;gBAEH,OAAO,SAAS,CAAC;YACnB,CAAC;WAAC;QAEF;;;;WAIG;QACI;;;;mBAAU,GAAgB,EAAE;gBACjC,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;YAC3B,CAAC;WAAC;QAEF;;;;;;;WAOG;QACI;;;;mBAAU,KAAK,EACpB,KAAQ,EACR,IAAmB,EACS,EAAE;gBAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,2BAA2B,CAAC;gBACxE,MAAM,QAAQ,GAAG,SAAS,CAAC;gBAE3B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC9B,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;gBACnD,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;oBACjC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC5E,CAAC;qBAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;oBACrC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;gBACzE,CAAC;gBAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE;oBACxD,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC1B,OAAO;iBACR,CAAC,CAAC;gBAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBACzC,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAEnC,OAAO,IAAyB,CAAC;YACnC,CAAC;WAAC;QAEF,aAAa;QAEb,0BAA0B;QAClB;;;;mBAAqB,KAAK,EAAE,OAA4B,EAAE,EAAE;gBAClE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;oBACtD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;iBAChC,CAAC,CAAC;gBAEH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAC3B,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;oBACnC,cAAc,EAAE,IAAI,CAAC,IAAK,CAAC,KAAK;oBAChC,QAAQ;iBACT,CAAC,CACH,CACF,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5C,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,IAAK,CAAC,OAAO,CACxC,CAAC;gBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAC7D,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;oBACzD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,6BAA6B;oBACnC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,QAAQ,EAAE,aAAc,CAAC,QAAQ;wBACjC,eAAe,EAAE,OAAO,CAAC,SAAS,EAAG;qBACtC;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CACxD,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,oBAAoB,CACrB,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC;gBAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC;WAAC;QAEM;;;;mBAAqB,KAAK,EAAE,OAA4B,EAAE,EAAE;gBAClE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;oBAChE,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;oBAC/B,IAAI,EAAE,qCAAqC;oBAC3C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE;wBACV,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;wBAC1B,eAAe,EAAE,OAAO,CAAC,SAAS,EAAG;qBACtC;iBACF,CAAC,CAAC;gBAEH,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CACxD,QAAQ,EACR,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,2BAA2B,CAC5B,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;gBAEjE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC;WAAC;QAEF,8EAA8E;QACpE;;;;mBAAyB,KAAK,EAKtC,QAEa,EACb,cAAsB,EACtB,SAAY,EAOZ,EAAE;gBACF,IAAI,QAAQ,CAAC,MAAM,KAAK,2BAA2B,EAAE,CAAC;oBACpD,OAAO,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC;gBACrC,CAAC;gBAED,MAAM,EACJ,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GACjC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;oBACvC,UAAU,EAAE,QAAQ,CAAC,EAAE;oBACvB,cAAc;iBACf,CAAC,CAAC;gBAEH,IAAI,MAAM,KAAK,2BAA2B,EAAE,CAAC;oBAC3C,OAAO,MAAM,CAAC,SAAS,CAAE,CAAC;gBAC5B,CAAC;gBAED,IACE,MAAM,KAAK,wBAAwB;oBACnC,MAAM,KAAK,0BAA0B;oBACrC,MAAM,KAAK,kCAAkC,EAC7C,CAAC;oBACD,MAAM,IAAI,KAAK,CACb,uCAAuC,EAAE,aAAa,MAAM,GAAG,CAChE,CAAC;gBACJ,CAAC;gBAED,gEAAgE;gBAChE,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;gBAEzD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;YAC1E,CAAC;WAAC;QAtaA,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAElD,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,sCAAsC,CAAC;QACnE,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,EAA6B,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CACpC,EAAE,OAAO,EAAE,yBAAyB,EAAE,EACtC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,IAAc,IAAI;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAc,IAAI,CAAC,IAAsB;QACvC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACO,UAAU,CAAC,OAAiC;QACpD,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACO,iBAAiB,CAAC,MAG3B;QACC,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;YACxB,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YACvD,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CAoXF","sourcesContent":["import { ConnectionConfigSchema, type ConnectionConfig } from \"@aa-sdk/core\";\nimport { TurnkeyClient, type TSignedRequest } from \"@turnkey/http\";\nimport EventEmitter from \"eventemitter3\";\nimport type { Hex } from \"viem\";\nimport { NotAuthenticatedError } from \"../errors.js\";\nimport { base64UrlEncode } from \"../utils/base64UrlEncode.js\";\nimport type {\n  AlchemySignerClientEvent,\n  AlchemySignerClientEvents,\n  CreateAccountParams,\n  EmailAuthParams,\n  GetWebAuthnAttestationResult,\n  SignerBody,\n  SignerResponse,\n  SignerRoutes,\n  SignupResponse,\n  User,\n} from \"./types.js\";\n\nexport interface BaseSignerClientParams {\n  stamper: TurnkeyClient[\"stamper\"];\n  connection: ConnectionConfig;\n  rootOrgId?: string;\n  rpId?: string;\n}\n\nexport type ExportWalletStamper = TurnkeyClient[\"stamper\"] & {\n  injectWalletExportBundle(bundle: string): Promise<boolean>;\n  injectKeyExportBundle(bundle: string): Promise<boolean>;\n  publicKey(): string | null;\n};\n\n/**\n * Base class for all Alchemy Signer clients\n */\nexport abstract class BaseSignerClient<TExportWalletParams = unknown> {\n  private _user: User | undefined;\n  private connectionConfig: ConnectionConfig;\n  protected turnkeyClient: TurnkeyClient;\n  protected rootOrg: string;\n  protected eventEmitter: EventEmitter<AlchemySignerClientEvents>;\n\n  /**\n   * Create a new instance of the Alchemy Signer client\n   *\n   * @param {BaseSignerClientParams} params the parameters required to create the client\n   */\n  constructor(params: BaseSignerClientParams) {\n    const { stamper, connection, rootOrgId } = params;\n\n    this.rootOrg = rootOrgId ?? \"24c1acf5-810f-41e0-a503-d5d13fa8e830\";\n    this.eventEmitter = new EventEmitter<AlchemySignerClientEvents>();\n    this.connectionConfig = ConnectionConfigSchema.parse(connection);\n    this.turnkeyClient = new TurnkeyClient(\n      { baseUrl: \"https://api.turnkey.com\" },\n      stamper\n    );\n  }\n\n  protected get user() {\n    return this._user;\n  }\n\n  protected set user(user: User | undefined) {\n    if (user && !this._user) {\n      this.eventEmitter.emit(\"connected\", user);\n    } else if (!user && this._user) {\n      this.eventEmitter.emit(\"disconnected\");\n    }\n\n    this._user = user;\n  }\n\n  /**\n   * Sets the stamper of the TurnkeyClient.\n   *\n   * @param {TurnkeyClient[\"stamper\"]} stamper the stamper function to set for the TurnkeyClient\n   */\n  protected setStamper(stamper: TurnkeyClient[\"stamper\"]) {\n    this.turnkeyClient.stamper = stamper;\n  }\n\n  /**\n   * Exports wallet credentials based on the specified type, either as a SEED_PHRASE or PRIVATE_KEY.\n   *\n   * @param {object} params The parameters for exporting the wallet\n   * @param {ExportWalletStamper} params.exportStamper The stamper used for exporting the wallet\n   * @param {\"SEED_PHRASE\" | \"PRIVATE_KEY\"} params.exportAs Specifies the format for exporting the wallet, either as a SEED_PHRASE or PRIVATE_KEY\n   * @returns {Promise<boolean>} A promise that resolves to true if the export is successful\n   */\n  protected exportWalletInner(params: {\n    exportStamper: ExportWalletStamper;\n    exportAs: \"SEED_PHRASE\" | \"PRIVATE_KEY\";\n  }): Promise<boolean> {\n    switch (params.exportAs) {\n      case \"PRIVATE_KEY\":\n        return this.exportAsPrivateKey(params.exportStamper);\n      case \"SEED_PHRASE\":\n        return this.exportAsSeedPhrase(params.exportStamper);\n    }\n  }\n\n  // #region ABSTRACT METHODS\n\n  public abstract createAccount(\n    params: CreateAccountParams\n  ): Promise<SignupResponse>;\n\n  public abstract initEmailAuth(\n    params: Omit<EmailAuthParams, \"targetPublicKey\">\n  ): Promise<{ orgId: string }>;\n\n  public abstract completeEmailAuth(params: {\n    bundle: string;\n    orgId: string;\n  }): Promise<User>;\n\n  public abstract disconnect(): Promise<void>;\n\n  public abstract exportWallet(params: TExportWalletParams): Promise<boolean>;\n\n  public abstract lookupUserWithPasskey(user?: User): Promise<User>;\n\n  protected abstract getWebAuthnAttestation(\n    options: CredentialCreationOptions,\n    userDetails?: { username: string }\n  ): Promise<GetWebAuthnAttestationResult>;\n\n  // #endregion\n\n  // #region PUBLIC METHODS\n\n  /**\n   * Listen to events emitted by the client\n   *\n   * @param {AlchemySignerClientEvent} event the event you want to listen to\n   * @param {AlchemySignerClientEvents[AlchemySignerClientEvent]} listener the callback function to execute when an event is fired\n   * @returns {() => void} a function that will remove the listener when called\n   */\n  public on = <E extends AlchemySignerClientEvent>(\n    event: E,\n    listener: AlchemySignerClientEvents[E]\n  ) => {\n    this.eventEmitter.on(event, listener as any);\n\n    return () => this.eventEmitter.removeListener(event, listener as any);\n  };\n\n  /**\n   * Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.\n   *\n   * @param {CredentialCreationOptions} options The options used to create the WebAuthn attestation\n   * @returns {Promise<string[]>} A promise that resolves to an array of authenticator IDs\n   * @throws {NotAuthenticatedError} If the user is not authenticated\n   */\n  public addPasskey = async (options: CredentialCreationOptions) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n    const { attestation, challenge } = await this.getWebAuthnAttestation(\n      options\n    );\n\n    const { activity } = await this.turnkeyClient.createAuthenticators({\n      type: \"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2\",\n      timestampMs: Date.now().toString(),\n      organizationId: this.user.orgId,\n      parameters: {\n        userId: this.user.userId,\n        authenticators: [\n          {\n            attestation,\n            authenticatorName: `passkey-${Date.now().toString()}`,\n            challenge: base64UrlEncode(challenge),\n          },\n        ],\n      },\n    });\n\n    const { authenticatorIds } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"createAuthenticatorsResult\"\n    );\n\n    return authenticatorIds;\n  };\n\n  /**\n   * Retrieves the current user or fetches the user information if not already available.\n   *\n   * @param {string} [orgId] optional organization ID, defaults to the user's organization ID\n   * @returns {Promise<User>} A promise that resolves to the user object\n   * @throws {Error} if no organization ID is provided when there is no current user\n   */\n  public whoami = async (orgId = this.user?.orgId): Promise<User> => {\n    if (this.user) {\n      return this.user;\n    }\n\n    if (!orgId) {\n      throw new Error(\"No orgId provided\");\n    }\n\n    const stampedRequest = await this.turnkeyClient.stampGetWhoami({\n      organizationId: orgId,\n    });\n\n    const user = await this.request(\"/v1/whoami\", {\n      stampedRequest,\n    });\n\n    const credentialId = (() => {\n      try {\n        return JSON.parse(stampedRequest?.stamp.stampHeaderValue)\n          .credentialId as string;\n      } catch (e) {\n        return undefined;\n      }\n    })();\n\n    this.user = {\n      ...user,\n      credentialId,\n    };\n\n    return this.user;\n  };\n\n  /**\n   * Generates a stamped whoami request for the current user. This request can then be used to call /signer/v1/whoami to get the user information.\n   * This is useful if you want to get the user information in a different context like a server. You can pass the stamped request to the server\n   * and then call our API to get the user information. Using this stamp is the most trusted way to get the user information since a stamp can only\n   * belong to the user who created it.\n   *\n   * @returns {Promise<TSignedRequest>} a promise that resolves to the \"whoami\" information for the logged in user\n   * @throws {Error} if no organization ID is provided\n   */\n  public stampWhoami = async (): Promise<TSignedRequest> => {\n    if (!this.user) {\n      throw new Error(\"User must be authenticated to stamp a whoami request\");\n    }\n\n    return await this.turnkeyClient.stampGetWhoami({\n      organizationId: this.user.orgId,\n    });\n  };\n\n  /**\n   * Looks up information based on an email address.\n   *\n   * @param {string} email the email address to look up\n   * @returns {Promise<any>} the result of the lookup request\n   */\n  public lookupUserByEmail = async (email: string) => {\n    return this.request(\"/v1/lookup\", { email });\n  };\n\n  /**\n   * This will sign a message with the user's private key, without doing any transformations on the message.\n   * For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass\n   * that result here.\n   *\n   * @param {Hex} msg the hex representation of the bytes to sign\n   * @returns {Promise<Hex>} the signature over the raw hex\n   */\n  public signRawMessage = async (msg: Hex): Promise<Hex> => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const stampedRequest = await this.turnkeyClient.stampSignRawPayload({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        encoding: \"PAYLOAD_ENCODING_HEXADECIMAL\",\n        hashFunction: \"HASH_FUNCTION_NO_OP\",\n        payload: msg,\n        signWith: this.user.address,\n      },\n    });\n\n    const { signature } = await this.request(\"/v1/sign-payload\", {\n      stampedRequest,\n    });\n\n    return signature;\n  };\n\n  /**\n   * Returns the current user or null if no user is set.\n   *\n   * @returns {User | null} the current user object or null if no user is available\n   */\n  public getUser = (): User | null => {\n    return this.user ?? null;\n  };\n\n  /**\n   * Sends a POST request to the given signer route with the specified body and returns the response.\n   * Not intended to be used directly, use the specific methods instead on the client instead.\n   *\n   * @param {SignerRoutes} route The route to which the request should be sent\n   * @param {SignerBody<R>} body The request body containing the data to be sent\n   * @returns {Promise<SignerResponse<R>>} A promise that resolves to the response from the signer\n   */\n  public request = async <R extends SignerRoutes>(\n    route: R,\n    body: SignerBody<R>\n  ): Promise<SignerResponse<R>> => {\n    const url = this.connectionConfig.rpcUrl ?? \"https://api.g.alchemy.com\";\n    const basePath = \"/signer\";\n\n    const headers = new Headers();\n    headers.append(\"Content-Type\", \"application/json\");\n    if (this.connectionConfig.apiKey) {\n      headers.append(\"Authorization\", `Bearer ${this.connectionConfig.apiKey}`);\n    } else if (this.connectionConfig.jwt) {\n      headers.append(\"Authorization\", `Bearer ${this.connectionConfig.jwt}`);\n    }\n\n    const response = await fetch(`${url}${basePath}${route}`, {\n      method: \"POST\",\n      body: JSON.stringify(body),\n      headers,\n    });\n\n    if (!response.ok) {\n      throw new Error(await response.text());\n    }\n\n    const json = await response.json();\n\n    return json as SignerResponse<R>;\n  };\n\n  // #endregion\n\n  // #region PRIVATE METHODS\n  private exportAsSeedPhrase = async (stamper: ExportWalletStamper) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const { wallets } = await this.turnkeyClient.getWallets({\n      organizationId: this.user.orgId,\n    });\n\n    const walletAccounts = await Promise.all(\n      wallets.map(({ walletId }) =>\n        this.turnkeyClient.getWalletAccounts({\n          organizationId: this.user!.orgId,\n          walletId,\n        })\n      )\n    ).then((x) => x.flatMap((x) => x.accounts));\n\n    const walletAccount = walletAccounts.find(\n      (x) => x.address === this.user!.address\n    );\n\n    if (!walletAccount) {\n      throw new Error(\n        `Could not find wallet associated with ${this.user.address}`\n      );\n    }\n\n    const { activity } = await this.turnkeyClient.exportWallet({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_EXPORT_WALLET\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        walletId: walletAccount!.walletId,\n        targetPublicKey: stamper.publicKey()!,\n      },\n    });\n\n    const { exportBundle } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"exportWalletResult\"\n    );\n\n    const result = await stamper.injectWalletExportBundle(exportBundle);\n\n    if (!result) {\n      throw new Error(\"Failed to inject wallet export bundle\");\n    }\n\n    return result;\n  };\n\n  private exportAsPrivateKey = async (stamper: ExportWalletStamper) => {\n    if (!this.user) {\n      throw new NotAuthenticatedError();\n    }\n\n    const { activity } = await this.turnkeyClient.exportWalletAccount({\n      organizationId: this.user.orgId,\n      type: \"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT\",\n      timestampMs: Date.now().toString(),\n      parameters: {\n        address: this.user.address,\n        targetPublicKey: stamper.publicKey()!,\n      },\n    });\n\n    const { exportBundle } = await this.pollActivityCompletion(\n      activity,\n      this.user.orgId,\n      \"exportWalletAccountResult\"\n    );\n\n    const result = await stamper.injectKeyExportBundle(exportBundle);\n\n    if (!result) {\n      throw new Error(\"Failed to inject wallet export bundle\");\n    }\n\n    return result;\n  };\n\n  // eslint-disable-next-line eslint-rules/require-jsdoc-on-reexported-functions\n  protected pollActivityCompletion = async <\n    T extends keyof Awaited<\n      ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n    >[\"activity\"][\"result\"]\n  >(\n    activity: Awaited<\n      ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n    >[\"activity\"],\n    organizationId: string,\n    resultKey: T\n  ): Promise<\n    NonNullable<\n      Awaited<\n        ReturnType<(typeof this.turnkeyClient)[\"getActivity\"]>\n      >[\"activity\"][\"result\"][T]\n    >\n  > => {\n    if (activity.status === \"ACTIVITY_STATUS_COMPLETED\") {\n      return activity.result[resultKey]!;\n    }\n\n    const {\n      activity: { status, id, result },\n    } = await this.turnkeyClient.getActivity({\n      activityId: activity.id,\n      organizationId,\n    });\n\n    if (status === \"ACTIVITY_STATUS_COMPLETED\") {\n      return result[resultKey]!;\n    }\n\n    if (\n      status === \"ACTIVITY_STATUS_FAILED\" ||\n      status === \"ACTIVITY_STATUS_REJECTED\" ||\n      status === \"ACTIVITY_STATUS_CONSENSUS_NEEDED\"\n    ) {\n      throw new Error(\n        `Failed to get activity with with id ${id} (status: ${status})`\n      );\n    }\n\n    // TODO: add ability to configure this + add exponential backoff\n    await new Promise((resolve) => setTimeout(resolve, 500));\n\n    return this.pollActivityCompletion(activity, organizationId, resultKey);\n  };\n  // #endregion\n}\n"]}

package/dist/esm/client/index.d.ts

@@ -113,21 +113,183 @@ export declare const AlchemySignerClientParamsSchema: z.ZodObject<{
     rootOrgId?: string | undefined;
 }>;
 export type AlchemySignerClientParams = z.input<typeof AlchemySignerClientParamsSchema>;
+/**
+ * A lower level client used by the AlchemySigner used to communicate with
+ * Alchemy's signer service.
+ */
 export declare class AlchemySignerWebClient extends BaseSignerClient<ExportWalletParams> {
     private iframeStamper;
     private webauthnStamper;
     iframeContainerId: string;
+    /**
+     * Initializes a new instance with the given parameters, setting up the connection, iframe configuration, and WebAuthn stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     * ```
+     *
+     * @param {AlchemySignerClientParams} params the parameters required to initialize the client
+     * @param {ConnectionConfig} params.connection The connection details needed to connect to the service
+     * @param {{ iframeElementId?: string; iframeContainerId: string }} params.iframeConfig The configuration details for setting up the iframe stamper
+     * @param {string} params.rpId The relying party ID, defaulting to the current hostname if not provided
+     * @param {string} params.rootOrgId The root organization ID
+     */
     constructor(params: AlchemySignerClientParams);
+    /**
+     * Authenticates the user by either email or passkey account creation flow. Emits events during the process.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.createAccount({ type: "email", email: "you@mail.com" });
+     * ```
+     *
+     * @param {CreateAccountParams} params The parameters for creating an account, including the type (email or passkey) and additional details.
+     * @returns {Promise<SignupResponse>} A promise that resolves with the response object containing the account creation result.
+     */
     createAccount: (params: CreateAccountParams) => Promise<import("./types.js").SignupResponse>;
+    /**
+     * Begin authenticating a user with their email and an expiration time for the authentication request. Initializes the iframe stamper to get the target public key.
+     * This method sends an email to the user to complete their login
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.initEmailAuth({ email: "you@mail.com" });
+     * ```
+     *
+     * @param {Omit<EmailAuthParams, "targetPublicKey">} params The parameters for email authentication, excluding the target public key
+     * @returns {Promise<any>} The response from the authentication request
+     */
     initEmailAuth: (params: Omit<EmailAuthParams, "targetPublicKey">) => Promise<{
         orgId: string;
     }>;
+    /**
+     * Completes email auth for the user by injecting a credential bundle and retrieving the user information based on the provided organization ID. Emits events during the process.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.completeEmailAuth({ orgId: "user-org-id", bundle: "bundle-from-email" });
+     * ```
+     *
+     * @param {{ bundle: string; orgId: string }} config The configuration object for the authentication function containing the credential bundle to inject and the organization id associated with the user
+     * @returns {Promise<User>} A promise that resolves to the authenticated user information
+     */
     completeEmailAuth: ({ bundle, orgId, }: {
         bundle: string;
         orgId: string;
     }) => Promise<User>;
+    /**
+     * Asynchronously handles the authentication process using WebAuthn Stamper. If a user is provided, sets the user and returns it. Otherwise, retrieves the current user and initializes the WebAuthn stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.lookupUserWithPasskey();
+     * ```
+     *
+     * @param {User} [user] An optional user object to authenticate
+     * @returns {Promise<User>} A promise that resolves to the authenticated user object
+     */
     lookupUserWithPasskey: (user?: User | undefined) => Promise<User>;
+    /**
+     * Initiates the export of a wallet by creating an iframe stamper and calling the appropriate export function.
+     * The export can be based on a seed phrase or a private key.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.exportWallet({
+     *  iframeContainerId: "export-iframe-container",
+     * });
+     * ```
+     *
+     * @param {ExportWalletParams} config The parameters for exporting the wallet
+     * @param {string} config.iframeContainerId The ID of the container element that will hold the iframe stamper
+     * @param {string} [config.iframeElementId] Optional ID for the iframe element
+     * @returns {Promise<void>} A promise that resolves when the export process is complete
+     */
     exportWallet: ({ iframeContainerId, iframeElementId, }: ExportWalletParams) => Promise<boolean>;
+    /**
+     * Asynchronous function that clears the user and resets the iframe stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.disconnect();
+     * ```
+     */
     disconnect: () => Promise<void>;
     private initIframeStamper;
     private initWebauthnStamper;