BaseAlchemySigner

Defined in: account-kit/signer/src/base.ts:119

Base abstract class for Alchemy Signer, providing authentication and session management for smart accounts. Implements the SmartAccountAuthenticator interface and handles various signer events.

Extended by

• AlchemyWebSigner

Type Parameters

Implements

• SmartAccountAuthenticator<AuthParams, User, TClient>

Constructors

Constructor

1
new BaseAlchemySigner<TClient>(param0): BaseAlchemySigner<TClient>;

Defined in: account-kit/signer/src/base.ts:138

Initializes an instance with the provided client and session configuration. This function sets up the internal store, initializes the session manager, registers listeners and initializes the session manager to manage session state.

Parameters

Returns

BaseAlchemySigner<TClient>

Properties

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const result = await signer.addMfa({ multiFactorType: "totp" });
15
// Result contains multiFactorTotpUrl to display as QR code

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const result = await signer.addPasskey()

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const result = await signer.authenticate({
15
 type: "email",
16
 email: "[email protected]",
17
});

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
await signer.disconnect();

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
// the params passed to this are different based on the specific signer
15
const result = signer.exportWallet()

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const { multiFactors } = await signer.getMfaFactors();

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const result = await signer.removeMfa({
15
  multiFactorIds: ["factor-id-1", "factor-id-2"]
16
});

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const authMethods = await signer.listAuthMethods();
15
const passkey = authMethods.passkeys[0];
16
17
const result = await signer.removePasskey(passkey.authenticatorId);

import { 
class AlchemyWebSigner
A SmartAccountSigner that can be used with any SmartContractAccount
AlchemyWebSigner } from "@account-kit/signer";

        const 
const signer: AlchemyWebSigner
signer = new 
new AlchemyWebSigner(params: AlchemySignerParams): AlchemyWebSigner
Initializes an instance with the provided Alchemy signer parameters after parsing them with a schema.
AlchemyWebSigner({
         
client: {
    connection: ({
        apiKey: string;
        rpcUrl?: undefined;
        jwt?: undefined;
    } | {
        jwt: string;
        rpcUrl?: undefined;
        apiKey?: undefined;
    } | {
        rpcUrl: string;
        apiKey?: undefined;
        jwt?: undefined;
    } | {
        rpcUrl: string;
        jwt: string;
        apiKey?: undefined;
    }) & {
        chainAgnosticUrl?: string | undefined;
    };
    iframeConfig: {
        iframeContainerId: string;
        iframeElementId?: string | undefined;
    };
    rpId?: string | undefined;
    rootOrgId?: string | undefined;
    oauthCallbackUrl?: string | undefined;
    enablePopupOauth?: boolean | undefined;
} | AlchemySignerWebClient
client: {
           
connection: ({
    apiKey: string;
    rpcUrl?: undefined;
    jwt?: undefined;
} | {
    jwt: string;
    rpcUrl?: undefined;
    apiKey?: undefined;
} | {
    rpcUrl: string;
    apiKey?: undefined;
    jwt?: undefined;
} | {
    rpcUrl: string;
    jwt: string;
    apiKey?: undefined;
}) & {
    chainAgnosticUrl?: string | undefined;
}
connection: {
             
rpcUrl: string
rpcUrl: "/api/rpc",
           },
           
iframeConfig: {
    iframeContainerId: string;
}
iframeConfig: {
             
iframeContainerId: string
iframeContainerId: "alchemy-signer-iframe-container",
           },
         },
        });

        const 
const tx: SignedAuthorization<number>
tx = await 
const signer: AlchemyWebSigner
signer.
BaseAlchemySigner<AlchemySignerWebClient>.signAuthorization: (unsignedAuthorization: AuthorizationRequest<number>) => Promise<SignedAuthorization<number>>
Signs an EIP-7702 Authorization and then returns the authorization with the signature.
signAuthorization({
         
contractAddress: `0x${string}`
contractAddress: "0x1234123412341234123412341234123412341234",
         
chainId: number
Chain ID.
chainId: 1,
         
nonce: number
Nonce of the EOA to delegate to.
nonce: 0,
        });

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const signature = await signer.signMessage("Hello, world!");

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const tx = await signer.signTransaction({
15
 to: "0x1234",
16
 value: "0x1234",
17
 data: "0x1234",
18
});

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const signature = await signer.signTypedData({
15
 domain: {},
16
 types: {},
17
 primaryType: "",
18
 message: {},
19
});

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
 client: {
5
   connection: {
6
     rpcUrl: "/api/rpc",
7
   },
8
   iframeConfig: {
9
     iframeContainerId: "alchemy-signer-iframe-container",
10
   },
11
 },
12
});
13
14
const result = await signer.verifyMfa({
15
  multiFactorId: "factor-id",
16
  multiFactorCode: "123456" // 6-digit code from authenticator app
17
});

Methods

addOauthProvider()

1
addOauthProvider(args): Promise<OauthProviderInfo>;

Defined in: account-kit/signer/src/base.ts:1260

Handles OAuth authentication by augmenting the provided arguments with a type and performing authentication based on the OAuth mode (either using redirect or popup).

Parameters

Returns

Promise<OauthProviderInfo>

A promise that resolves to an OauthProviderInfo object containing provider information and the ID token.

fetchConfig()

1
protected fetchConfig(): Promise<SignerConfig>;

Defined in: account-kit/signer/src/base.ts:1882

Returns

Promise<SignerConfig>

getAuthDetails()

1
getAuthDetails(): Promise<User>;

Defined in: account-kit/signer/src/base.ts:479

Gets the current logged in user If a user has an ongoing session, it will use that session and try to authenticate

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
// throws if not logged in
15
const user = await signer.getAuthDetails();

Returns

Promise<User>

the current user

Throws

if there is no user logged in

Implementation of

1
SmartAccountAuthenticator.getAuthDetails;

getConfig()

1
getConfig(): Promise<SignerConfig>;

Defined in: account-kit/signer/src/base.ts:1874

Returns the signer configuration while fetching it if it’s not already initialized.

Returns

Promise<SignerConfig>

A promise that resolves to the signer configuration

getMfaStatus()

1
getMfaStatus(): object;

Defined in: account-kit/signer/src/base.ts:719

Gets the current MFA status

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const mfaStatus = signer.getMfaStatus();
15
if (mfaStatus === AlchemyMfaStatus.REQUIRED) {
16
  // Handle MFA requirement
17
}

Returns

object

The current MFA status

getUser()

Unauthenticated call to look up a user’s organizationId by email or phone

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const result = await signer.getUser({ type: "email", value: "[email protected]" });

Param

the params to look up

Call Signature

1
getUser(email): Promise<
2
  | null
3
  | {
4
  orgId: string;
5
}>;

Defined in: account-kit/signer/src/base.ts:752

Unauthenticated call to look up a user’s organizationId by email

Deprecated

Use getUser({ type: “email”, value: email }) instead

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const result = await signer.getUser("[email protected]");

Parameters

Returns

Promise< | null | { orgId: string; }>

the organization id for the user if they exist

Call Signature

1
getUser(params): Promise<
2
  | null
3
  | {
4
  orgId: string;
5
}>;

Defined in: account-kit/signer/src/base.ts:777

Unauthenticated call to look up a user’s organizationId by email or phone

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const result = await signer.getUser({ type: "email", value: "[email protected]" });

Parameters

Returns

Promise< | null | { orgId: string; }>

the organization id for the user if they exist

initConfig()

1
protected initConfig(): Promise<SignerConfig>;

Defined in: account-kit/signer/src/base.ts:1864

Returns

Promise<SignerConfig>

listAuthMethods()

1
listAuthMethods(): Promise<AuthMethods>;

Defined in: account-kit/signer/src/base.ts:1305

Retrieves a list of auth methods associated with the authenticated user.

Returns

Promise<AuthMethods>

A promise that resolves to an AuthMethods object containing the user’s email, OAuth providers, and passkeys.

Throws

Thrown if the user is not authenticated

on()

1
on<E>(event, listener): () => void;

Defined in: account-kit/signer/src/base.ts:183

Allows you to subscribe to events emitted by the signer

Type Parameters

Parameters

Returns

a function to remove the listener

1
(): void;

Returns

void

preparePopupOauth()

1
preparePopupOauth(): Promise<OauthConfig>;

Defined in: account-kit/signer/src/base.ts:285

Prepares the config needed to use popup-based OAuth login. This must be called before calling .authenticate with params { type: "oauth", mode: "popup" }, and is recommended to be called on page load.

This method exists because browsers may prevent popups from opening unless triggered by user interaction, and so the OAuth config must already have been fetched at the time a user clicks a social login button.

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
await signer.preparePopupOauth();

Returns

Promise<OauthConfig>

the config which must be loaded before using popup-based OAuth

removeOauthProvider()

1
removeOauthProvider(providerId): Promise<any>;

Defined in: account-kit/signer/src/base.ts:1292

Removes an OAuth provider by its ID if the user is authenticated.

Parameters

Returns

Promise<any>

A promise indicating the result of the removal process

Throws

Thrown if the user is not authenticated

setEmail()

Implementation for setEmail method.

Param

An object containing the verificationCode (or simply an email for legacy usage)

Call Signature

1
setEmail(email): Promise<string>;

Defined in: account-kit/signer/src/base.ts:842

Sets the email for the authenticated user, allowing them to login with that email.

Deprecated

You must contact Alchemy to enable this feature for your team, as there are important security considerations. In particular, you must not call this without first validating that the user owns this email account. It is recommended to now use the email verification flow instead.

Parameters

Returns

Promise<string>

A promise that resolves to the updated email address

Throws

If the user is not authenticated

Call Signature

1
setEmail(params): Promise<string>;

Defined in: account-kit/signer/src/base.ts:854

Uses a verification code to update a user’s email, allowing them to login with that email. sendVerificationCode should be called first to obtain the code.

Parameters

Returns

Promise<string>

A promise that resolves to the updated email address

Throws

If the user is not authenticated

toSolanaSigner()

1
toSolanaSigner(): SolanaSigner;

Defined in: account-kit/signer/src/base.ts:1123

Creates a new instance of SolanaSigner using the provided inner value. This requires the signer to be authenticated first

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const solanaSigner = signer.toSolanaSigner();

Returns

SolanaSigner

A new instance of SolanaSigner

toViemAccount()

1
toViemAccount(): object;

Defined in: account-kit/signer/src/base.ts:1079

This method lets you adapt your AlchemySigner to a viem LocalAccount, which will let you use the signer as an EOA directly.

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
const account = signer.toViemAccount();

Returns

object

a LocalAccount object that can be used with viem’s wallet client

Throws

if your signer is not authenticated

validateMultiFactors()

1
validateMultiFactors(params): Promise<User>;

Defined in: account-kit/signer/src/base.ts:1805

Validates MFA factors that were required during authentication. This function should be called after MFA is required and the user has provided their MFA code. It completes the authentication process by validating the MFA factors and completing the auth bundle.

Example

1
import { AlchemyWebSigner } from "@account-kit/signer";
2
3
const signer = new AlchemyWebSigner({
4
  client: {
5
    connection: {
6
      rpcUrl: "/api/rpc",
7
    },
8
    iframeConfig: {
9
      iframeContainerId: "alchemy-signer-iframe-container",
10
    },
11
  },
12
});
13
14
// After MFA is required and user provides code
15
const user = await signer.validateMultiFactors({
16
  multiFactorCode: "123456", // 6-digit code from authenticator app
17
  multiFactorId: "factor-id",
18
});

Parameters

Returns

Promise<User>

A promise that resolves to the authenticated user

Throws

If there is no pending MFA context or if orgId is not found