feat: adds webauthn session key support

aa-sdk/core/src/errors/account.ts

@@ -17,6 +17,20 @@ export class AccountNotFoundError extends BaseError {
   }
 }
 
+/**
+ * This error is thrown when an account is not a Modular Account V2
+ */
+
+export class NotAModularAccountV2Error extends BaseError {
+  override name = "NotAModularAccountV2Error";
+  /**
+   * Constructor for initializing an error message indicating that the account is not a Modular Account V2.
+   */
+  constructor() {
+    super("This is not a Modular Account V2 account.");
+  }
+}
+
 /**
  * Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.
  * This error suggests providing an override via the `factoryAddress` parameter when creating an account.

aa-sdk/core/src/index.ts

@@ -57,6 +57,7 @@ export {
 export type * from "./entrypoint/types.js";
 export {
   AccountNotFoundError,
+  NotAModularAccountV2Error,
   AccountRequiresOwnerError,
   BatchExecutionNotSupportedError,
   DefaultFactoryNotDefinedError,

account-kit/smart-contracts/src/ma-v2/account/common/modularAccountV2Base.ts

@@ -1,38 +1,40 @@
 import {
   createBundlerClient,
   getEntryPoint,
+  InvalidDeferredActionNonce,
   InvalidEntityIdError,
   InvalidNonceKeyError,
-  InvalidDeferredActionNonce,
   toSmartContractAccount,
   type AccountOp,
   type SmartAccountSigner,
+  type SmartContractAccount,
   type SmartContractAccountWithSigner,
   type ToSmartContractAccountParams,
-  type SmartContractAccount,
 } from "@aa-sdk/core";
-import { DEFAULT_OWNER_ENTITY_ID, parseDeferredAction } from "../../utils.js";
 import {
-  type Hex,
-  type Address,
-  type Chain,
-  type Transport,
+  concatHex,
   encodeFunctionData,
-  maxUint32,
-  zeroAddress,
   getContract,
-  concatHex,
   maxUint152,
+  maxUint32,
+  zeroAddress,
+  type Address,
+  type Chain,
+  type Hex,
+  type Transport,
 } from "viem";
+import type { ToWebAuthnAccountParameters } from "viem/account-abstraction";
 import { modularAccountAbi } from "../../abis/modularAccountAbi.js";
 import { serializeModuleEntity } from "../../actions/common/utils.js";
-import { nativeSMASigner } from "../nativeSMASigner.js";
 import { singleSignerMessageSigner } from "../../modules/single-signer-validation/signer.js";
-import type { ToWebAuthnAccountParameters } from "viem/account-abstraction";
 import { webauthnSigningFunctions } from "../../modules/webauthn-validation/signingMethods.js";
+import { DEFAULT_OWNER_ENTITY_ID, parseDeferredAction } from "../../utils.js";
+import { nativeSMASigner } from "../nativeSMASigner.js";
 
 export const executeUserOpSelector: Hex = "0x8DD7712F";
 
+export type ModularAccountsV2 = ModularAccountV2 | WebauthnModularAccountV2;
+
 export type SignerEntity = {
   isGlobalValidation: boolean;
   entityId: number;
@@ -358,3 +360,9 @@ export async function createMAv2Base<
     encodeCallData,
   } as ModularAccountV2<TSigner>; // TO DO: figure out when this breaks! we shouldn't have to cast
 }
+
+export function isModularAccountV2(
+  account: SmartContractAccount,
+): account is ModularAccountV2 | WebauthnModularAccountV2 {
+  return account.source === "ModularAccountV2";
+}

account-kit/smart-contracts/src/ma-v2/actions/install-validation/installValidation.ts

@@ -1,35 +1,44 @@
 import {
   AccountNotFoundError,
-  IncompatibleClientError,
-  isSmartAccountClient,
+  NotAModularAccountV2Error,
   EntityIdOverrideError,
+  type GetAccountParameter,
   type GetEntryPointFromAccount,
+  IncompatibleClientError,
   type SendUserOperationResult,
   type UserOperationOverridesParameter,
-  type SmartAccountSigner,
+  isSmartAccountClient,
+  isSmartAccountWithSigner,
 } from "@aa-sdk/core";
 import {
   type Address,
+  type Chain,
+  type Client,
   type Hex,
-  encodeFunctionData,
+  type Transport,
   concatHex,
+  encodeFunctionData,
   zeroAddress,
 } from "viem";
 
 import { semiModularAccountBytecodeAbi } from "../../abis/semiModularAccountBytecodeAbi.js";
 import type { HookConfig, ValidationConfig } from "../common/types.js";
 import {
-  serializeValidationConfig,
   serializeHookConfig,
   serializeModuleEntity,
+  serializeValidationConfig,
 } from "../common/utils.js";
 
-import { type ModularAccountV2Client } from "../../client/client.js";
-import { type ModularAccountV2 } from "../../account/common/modularAccountV2Base.js";
+import {
+  type ModularAccountsV2,
+  isModularAccountV2,
+} from "../../account/common/modularAccountV2Base.js";
 import { DEFAULT_OWNER_ENTITY_ID } from "../../utils.js";
 
 export type InstallValidationParams<
-  TSigner extends SmartAccountSigner = SmartAccountSigner,
+  TAccount extends ModularAccountsV2 | undefined =
+    | ModularAccountsV2
+    | undefined,
 > = {
   validationConfig: ValidationConfig;
   selectors: Hex[];
@@ -38,38 +47,38 @@ export type InstallValidationParams<
     hookConfig: HookConfig;
     initData: Hex;
   }[];
-  account?: ModularAccountV2<TSigner> | undefined;
-} & UserOperationOverridesParameter<
-  GetEntryPointFromAccount<ModularAccountV2<TSigner>>
->;
+} & UserOperationOverridesParameter<GetEntryPointFromAccount<TAccount>> &
+  GetAccountParameter<TAccount>;
 
 export type UninstallValidationParams<
-  TSigner extends SmartAccountSigner = SmartAccountSigner,
+  TAccount extends ModularAccountsV2 | undefined =
+    | ModularAccountsV2
+    | undefined,
 > = {
   moduleAddress: Address;
   entityId: number;
   uninstallData: Hex;
   hookUninstallDatas: Hex[];
-  account?: ModularAccountV2<TSigner> | undefined;
-} & UserOperationOverridesParameter<
-  GetEntryPointFromAccount<ModularAccountV2<TSigner>>
->;
+} & UserOperationOverridesParameter<GetEntryPointFromAccount<TAccount>> &
+  GetAccountParameter<TAccount>;
 
 export type InstallValidationActions<
-  TSigner extends SmartAccountSigner = SmartAccountSigner,
+  TAccount extends ModularAccountsV2 | undefined =
+    | ModularAccountsV2
+    | undefined,
 > = {
   installValidation: (
-    args: InstallValidationParams<TSigner>,
+    args: InstallValidationParams<TAccount>,
   ) => Promise<SendUserOperationResult>;
   encodeInstallValidation: (
     // TODO: omit the user op sending related parameters from this type
-    args: InstallValidationParams<TSigner>,
+    args: InstallValidationParams<TAccount>,
   ) => Promise<Hex>;
   uninstallValidation: (
-    args: UninstallValidationParams<TSigner>,
+    args: UninstallValidationParams<TAccount>,
   ) => Promise<SendUserOperationResult>;
   encodeUninstallValidation: (
-    args: UninstallValidationParams<TSigner>,
+    args: UninstallValidationParams<TAccount>,
   ) => Promise<Hex>;
 };
 
@@ -117,23 +126,32 @@ export type InstallValidationActions<
  * @param {object} client - The client instance which provides account and sendUserOperation functionality.
  * @returns {object} - An object containing two methods, `installValidation` and `uninstallValidation`.
  */
-export const installValidationActions: <
-  TSigner extends SmartAccountSigner = SmartAccountSigner,
+export function installValidationActions<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends ModularAccountsV2 | undefined =
+    | ModularAccountsV2
+    | undefined,
 >(
-  client: ModularAccountV2Client<TSigner>,
-) => InstallValidationActions<TSigner> = (client) => {
+  client: Client<TTransport, TChain, TAccount>,
+): InstallValidationActions<TAccount> {
   const encodeInstallValidation = async ({
     validationConfig,
     selectors,
     installData,
     hooks,
     account = client.account,
-  }: InstallValidationParams) => {
+  }: InstallValidationParams<TAccount>) => {
     if (!account) {
       throw new AccountNotFoundError();
     }
 
-    if (!isSmartAccountClient(client)) {
+    if (!isModularAccountV2(account)) {
+      throw new NotAModularAccountV2Error();
+    }
+
+    if (isSmartAccountWithSigner(account) && !isSmartAccountClient(client)) {
+      // if we don't differentiate between WebauthnModularAccountV2Client and ModularAccountV2Client, passing client to isSmartAccountClient complains
       throw new IncompatibleClientError(
         "SmartAccountClient",
         "installValidation",
@@ -171,12 +189,17 @@ export const installValidationActions: <
     uninstallData,
     hookUninstallDatas,
     account = client.account,
-  }: UninstallValidationParams) => {
+  }: UninstallValidationParams<TAccount>) => {
     if (!account) {
       throw new AccountNotFoundError();
     }
 
-    if (!isSmartAccountClient(client)) {
+    if (!isModularAccountV2(account)) {
+      throw new NotAModularAccountV2Error();
+    }
+
+    if (isSmartAccountWithSigner(account) && !isSmartAccountClient(client)) {
+      // if we don't differentiate between WebauthnModularAccountV2Client and ModularAccountV2Client, passing client to isSmartAccountClient complains
       throw new IncompatibleClientError(
         "SmartAccountClient",
         "uninstallValidation",
@@ -210,7 +233,19 @@ export const installValidationActions: <
       hooks,
       account = client.account,
       overrides,
-    }) => {
+    }: InstallValidationParams<TAccount>) => {
+      if (!isSmartAccountClient(client)) {
+        throw new IncompatibleClientError(
+          "SmartAccountClient",
+          "installValidation",
+          client,
+        );
+      }
+
+      if (!account) {
+        throw new AccountNotFoundError();
+      }
+
       const callData = await encodeInstallValidation({
         validationConfig,
         selectors,
@@ -233,8 +268,20 @@ export const installValidationActions: <
       hookUninstallDatas,
       account = client.account,
       overrides,
-    }) => {
-      const callData = await encodeUninstallValidation({
+    }: UninstallValidationParams<TAccount>) => {
+      if (!account) {
+        throw new AccountNotFoundError();
+      }
+
+      if (!isSmartAccountClient(client)) {
+        throw new IncompatibleClientError(
+          "SmartAccountClient",
+          "uninstallValidation",
+          client,
+        );
+      }
+
+      const callData: Hex = await encodeUninstallValidation({
         moduleAddress,
         entityId,
         uninstallData,
@@ -249,4 +296,4 @@ export const installValidationActions: <
       });
     },
   };
-};
+}