@account-kit/smart-contracts 4.6.1 → 4.8.0

package/src/ma-v2/actions/install-validation/installValidation.ts

@@ -0,0 +1,213 @@
+import {
+  AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
+  EntityIdOverrideError,
+  type GetEntryPointFromAccount,
+  type SendUserOperationResult,
+  type UserOperationOverridesParameter,
+  type SmartAccountSigner,
+} from "@aa-sdk/core";
+import {
+  type Address,
+  type Hex,
+  encodeFunctionData,
+  concatHex,
+  zeroAddress,
+} from "viem";
+
+import { semiModularAccountBytecodeAbi } from "../../abis/semiModularAccountBytecodeAbi.js";
+import type { HookConfig, ValidationConfig } from "../common/types.js";
+import {
+  serializeValidationConfig,
+  serializeHookConfig,
+  serializeModuleEntity,
+} from "../common/utils.js";
+
+import { type SMAV2AccountClient } from "../../client/client.js";
+import { type MAV2Account } from "../../account/semiModularAccountV2.js";
+import { DEFAULT_OWNER_ENTITY_ID } from "../../utils.js";
+
+export type InstallValidationParams<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = {
+  validationConfig: ValidationConfig;
+  selectors: Hex[];
+  installData: Hex;
+  hooks: {
+    hookConfig: HookConfig;
+    initData: Hex;
+  }[];
+  account?: MAV2Account<TSigner> | undefined;
+} & UserOperationOverridesParameter<
+  GetEntryPointFromAccount<MAV2Account<TSigner>>
+>;
+
+export type UninstallValidationParams<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = {
+  moduleAddress: Address;
+  entityId: number;
+  uninstallData: Hex;
+  hookUninstallDatas: Hex[];
+  account?: MAV2Account<TSigner> | undefined;
+} & UserOperationOverridesParameter<
+  GetEntryPointFromAccount<MAV2Account<TSigner>>
+>;
+
+export type InstallValidationActions<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = {
+  installValidation: (
+    args: InstallValidationParams<TSigner>
+  ) => Promise<SendUserOperationResult>;
+  uninstallValidation: (
+    args: UninstallValidationParams<TSigner>
+  ) => Promise<SendUserOperationResult>;
+};
+
+/**
+ * Provides validation installation and uninstallation functionalities for a MA v2 client, ensuring compatibility with `SmartAccountClient`.
+ *
+ * @example
+ * ```ts
+ * import { createSMAV2AccountClient, installValidationActions, getDefaultSingleSignerValidationModuleAddress, SingleSignerValidationModule } from "@account-kit/smart-contracts";
+ * import { Address } from "viem";
+ *
+ * const client = (await createSMAV2AccountClient({ ... })).extend(installValidationActions);
+ * const sessionKeyAddress: Address = "0x1234";
+ * const sessionKeyEntityId: number = 1;
+ *
+ * await client.installValidation({
+ *   validationConfig: {
+ *     moduleAddress: getDefaultSingleSignerValidationModuleAddress(
+ *       client.chain
+ *     ),
+ *     entityId: sessionKeyEntityId,
+ *     isGlobal: true,
+ *     isSignatureValidation: false,
+ *     isUserOpValidation: true,
+ *   },
+ *   selectors: [],
+ *   installData: SingleSignerValidationModule.encodeOnInstallData({
+ *     entityId: sessionKeyEntityId,
+ *     signer: sessionKeyAddress,
+ *   }),
+ *   hooks: [],
+ * });
+ *
+ * await client.uninstallValidation({
+ *   moduleAddress: sessionKeyAddress,
+ *   entityId: sessionKeyEntityId,
+ *   uninstallData: SingleSignerValidationModule.encodeOnUninstallData({
+ *     entityId: sessionKeyEntityId,
+ *   }),
+ *   hookUninstallDatas: [],
+ * });
+ *
+ * ```
+ *
+ * @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
+>(
+  client: SMAV2AccountClient<TSigner>
+) => InstallValidationActions<TSigner> = (client) => ({
+  installValidation: async ({
+    validationConfig,
+    selectors,
+    installData,
+    hooks,
+    account = client.account,
+    overrides,
+  }) => {
+    if (!account) {
+      throw new AccountNotFoundError();
+    }
+
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "installValidation",
+        client
+      );
+    }
+
+    // an entityId of zero is only allowed if we're installing or uninstalling hooks on the fallback validation
+    if (
+      validationConfig.entityId === DEFAULT_OWNER_ENTITY_ID &&
+      validationConfig.moduleAddress !== zeroAddress
+    ) {
+      throw new EntityIdOverrideError();
+    }
+
+    const { encodeCallData } = account;
+
+    const callData = await encodeCallData(
+      encodeFunctionData({
+        abi: semiModularAccountBytecodeAbi,
+        functionName: "installValidation",
+        args: [
+          serializeValidationConfig(validationConfig),
+          selectors,
+          installData,
+          hooks.map((hook: { hookConfig: HookConfig; initData: Hex }) =>
+            concatHex([serializeHookConfig(hook.hookConfig), hook.initData])
+          ),
+        ],
+      })
+    );
+
+    return client.sendUserOperation({
+      uo: callData,
+      account,
+      overrides,
+    });
+  },
+
+  uninstallValidation: async ({
+    moduleAddress,
+    entityId,
+    uninstallData,
+    hookUninstallDatas,
+    account = client.account,
+    overrides,
+  }) => {
+    if (!account) {
+      throw new AccountNotFoundError();
+    }
+
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "uninstallValidation",
+        client
+      );
+    }
+
+    const { encodeCallData } = account;
+
+    const callData = await encodeCallData(
+      encodeFunctionData({
+        abi: semiModularAccountBytecodeAbi,
+        functionName: "uninstallValidation",
+        args: [
+          serializeModuleEntity({
+            moduleAddress,
+            entityId,
+          }),
+          uninstallData,
+          hookUninstallDatas,
+        ],
+      })
+    );
+
+    return client.sendUserOperation({
+      uo: callData,
+      account,
+      overrides,
+    });
+  },
+});

package/src/ma-v2/client/client.ts

@@ -0,0 +1,74 @@
+import {
+  createSmartAccountClient,
+  type SmartAccountClient,
+  type SmartAccountSigner,
+  type SmartAccountClientConfig,
+} from "@aa-sdk/core";
+import { type Chain, type Transport } from "viem";
+
+import {
+  createSMAV2Account,
+  type CreateSMAV2AccountParams,
+  type MAV2Account,
+} from "../account/semiModularAccountV2.js";
+
+export type SMAV2AccountClient<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = SmartAccountClient<Transport, Chain, MAV2Account<TSigner>>;
+
+export type CreateSMAV2AccountClientParams<
+  TTransport extends Transport = Transport,
+  TChain extends Chain = Chain,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = CreateSMAV2AccountParams<TTransport, TSigner> &
+  Omit<
+    SmartAccountClientConfig<TTransport, TChain>,
+    "transport" | "account" | "chain"
+  >;
+
+export function createSMAV2AccountClient<
+  TChain extends Chain = Chain,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  args: CreateSMAV2AccountClientParams<Transport, TChain, TSigner>
+): Promise<SMAV2AccountClient<TSigner>>;
+
+/**
+ * Creates a SMAv2 account client using the provided configuration parameters.
+ *
+ * @example
+ * ```ts
+ * import { http } from "viem";
+ * import { createSMAV2AccountClient } from "@account-kit/smart-contracts";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { sepolia } from "@account-kit/infra";
+ *
+ * const MNEMONIC = "...";
+ * const RPC_URL = "...";
+ *
+ * const signer = LocalAccountSigner.mnemonicToAccountSigner(MNEMONIC);
+ *
+ * const chain = sepolia;
+ *
+ * const transport = http(RPC_URL);
+ *
+ * const SMAV2SignerAccountClient = await createSMAV2AccountClient({
+ *  chain,
+ *  signer,
+ *  transport,
+ * });
+ * ```
+ *
+ * @param {CreateSMAV2AccountClientParams} config The configuration parameters required to create the MAv2 account client
+ * @returns {Promise<SmartAccountClient>} A promise that resolves to a `SmartAccountClient` instance
+ */
+export async function createSMAV2AccountClient(
+  config: CreateSMAV2AccountClientParams
+): Promise<SmartAccountClient> {
+  const smaV2Account = await createSMAV2Account(config);
+
+  return createSmartAccountClient({
+    ...config,
+    account: smaV2Account,
+  });
+}

package/src/ma-v2/index.ts

@@ -0,0 +1,47 @@
+// ma v2 exports
+export { accountFactoryAbi } from "./abis/accountFactoryAbi.js";
+export { modularAccountAbi } from "./abis/modularAccountAbi.js";
+export { semiModularAccountBytecodeAbi } from "./abis/semiModularAccountBytecodeAbi.js";
+export { semiModularAccountStorageAbi } from "./abis/semiModularAccountStorageAbi.js";
+
+export { nativeSMASigner } from "./account/nativeSMASigner.js";
+export type * from "./account/semiModularAccountV2.js";
+export { createSMAV2Account } from "./account/semiModularAccountV2.js";
+
+export type {
+  ModuleEntity,
+  ValidationConfig,
+  HookConfig,
+  ValidationData,
+} from "./actions/common/types.js";
+export { HookType } from "./actions/common/types.js";
+export {
+  serializeValidationConfig,
+  serializeHookConfig,
+  serializeModuleEntity,
+} from "./actions/common/utils.js";
+export type * from "./actions/install-validation/installValidation.js";
+export { installValidationActions } from "./actions/install-validation/installValidation.js";
+
+export type * from "./client/client.js";
+export { createSMAV2AccountClient } from "./client/client.js";
+
+export {
+  getDefaultAllowlistModuleAddress,
+  getDefaultNativeTokenLimitModuleAddress,
+  getDefaultPaymasterGuardModuleAddress,
+  getDefaultSingleSignerValidationModuleAddress,
+  getDefaultTimeRangeModuleAddress,
+  getDefaultWebauthnValidationModuleAddress,
+} from "./modules/utils.js";
+export { allowlistModuleAbi } from "./modules/allowlist-module/abis/allowlistModuleAbi.js";
+export { AllowlistModule } from "./modules/allowlist-module/module.js";
+export { nativeTokenLimitModuleAbi } from "./modules/native-token-limit-module/abis/nativeTokenLimitModuleAbi.js";
+export { NativeTokenLimitModule } from "./modules/native-token-limit-module/module.js";
+export { paymasterGuardModuleAbi } from "./modules/paymaster-guard-module/abis/paymasterGuardModuleAbi.js";
+export { PaymasterGuardModule } from "./modules/paymaster-guard-module/module.js";
+export { singleSignerValidationModuleAbi } from "./modules/single-signer-validation/abis/singleSignerValidationModuleAbi.js";
+export { SingleSignerValidationModule } from "./modules/single-signer-validation/module.js";
+export { timeRangeModuleAbi } from "./modules/time-range-module/abis/timeRangeModuleAbi.js";
+export { TimeRangeModule } from "./modules/time-range-module/module.js";
+export { webauthnValidationModuleAbi } from "./modules/webauthn-validation/abis/webauthnValidationAbi.js";