feat: allowlist module installation and uninstallation

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

@@ -17,6 +17,7 @@ import {
   type Transport,
   encodeFunctionData,
   concatHex,
+  zeroAddress,
 } from "viem";
 
 import { semiModularAccountBytecodeAbi } from "../../abis/semiModularAccountBytecodeAbi.js";
@@ -95,7 +96,9 @@ export const installValidationActions: <
     }
 
     if (validationConfig.entityId === 0) {
-      throw new EntityIdOverrideError();
+      if (validationConfig.moduleAddress !== zeroAddress) {
+        throw new EntityIdOverrideError();
+      }
     }
 
     const callData = encodeFunctionData({

account-kit/smart-contracts/src/ma-v2/client/client.test.ts

@@ -1,4 +1,4 @@
-import { custom, parseEther, publicActions } from "viem";
+import { custom, parseEther, publicActions, zeroAddress } from "viem";
 
 import { LocalAccountSigner, type SmartAccountSigner } from "@aa-sdk/core";
 
@@ -10,6 +10,8 @@ import { accounts } from "~test/constants.js";
 import { installValidationActions } from "../actions/install-validation/installValidation.js";
 import { getDefaultSingleSignerValidationModuleAddress } from "../modules/utils.js";
 import { SingleSignerValidationModule } from "../modules/single-signer-validation/module.js";
+import { allowlistModule } from "../modules/allowlist-module/module.js";
+import { HookType } from "../actions/common/types.js";
 
 describe("MA v2 Tests", async () => {
   const instance = local070Instance;
@@ -185,6 +187,82 @@ describe("MA v2 Tests", async () => {
     ).rejects.toThrowError();
   });
 
+  it("installs allowlist module, then uninstalls", async () => {
+    let provider = (await givenConnectedProvider({ signer })).extend(
+      installValidationActions
+    );
+
+    await setBalance(client, {
+      address: provider.getAddress(),
+      value: parseEther("2"),
+    });
+
+    const hookInstallData = allowlistModule.encodeOnInstallData({
+      entityId: 1,
+      inputs: [
+        {
+          target,
+          hasSelectorAllowlist: false,
+          hasERC20SpendLimit: false,
+          erc20SpendLimit: 0n,
+          selectors: [],
+        },
+      ],
+    });
+
+    const installResult = await provider.installValidation({
+      validationConfig: {
+        moduleAddress: zeroAddress,
+        entityId: 0,
+        isGlobal: true,
+        isSignatureValidation: true,
+        isUserOpValidation: true,
+      },
+      selectors: [],
+      installData: "0x",
+      hooks: [
+        {
+          hookConfig: {
+            address: addresses.allowlistModule,
+            entityId: 0, // uint32
+            hookType: HookType.VALIDATION,
+            hasPreHooks: true,
+            hasPostHooks: true,
+          },
+          initData: hookInstallData,
+        },
+      ],
+    });
+
+    await expect(
+      provider.waitForUserOperationTransaction(installResult)
+    ).resolves.not.toThrowError();
+
+    const hookUninstallData = allowlistModule.encodeOnUninstallData({
+      entityId: 0,
+      inputs: [
+        {
+          target,
+          hasSelectorAllowlist: false,
+          hasERC20SpendLimit: false,
+          erc20SpendLimit: 0n,
+          selectors: [],
+        },
+      ],
+    });
+
+    const uninstallResult = await provider.uninstallValidation({
+      moduleAddress: zeroAddress,
+      entityId: 0,
+      uninstallData: "0x",
+      hookUninstallDatas: [hookUninstallData],
+    });
+
+    await expect(
+      provider.waitForUserOperationTransaction(uninstallResult)
+    ).resolves.not.toThrowError();
+  });
+
   const givenConnectedProvider = async ({
     signer,
     accountAddress,

account-kit/smart-contracts/src/ma-v2/modules/allowlist-module/module.ts

@@ -0,0 +1,99 @@
+import { encodeAbiParameters, type Address, type Hex } from "viem";
+
+import { allowlistModuleAbi } from "./abis/allowlistModuleAbi.js";
+
+const addresses: Record<number | "default", Address> = {
+  default: "0xE46ca4a98c485caEE2Abb6ef5116292B8c78a868",
+};
+
+const meta = {
+  name: "AllowlistModule",
+  version: "alpha.1",
+  addresses,
+};
+
+export const allowlistModule = {
+  meta,
+  abi: allowlistModuleAbi,
+  encodeOnInstallData: (args: {
+    entityId: number;
+    inputs: Array<{
+      target: Address;
+      hasSelectorAllowlist: boolean;
+      hasERC20SpendLimit: boolean;
+      erc20SpendLimit: bigint;
+      selectors: Array<Hex>;
+    }>;
+  }): Hex => {
+    const { entityId, inputs } = args;
+    return encodeAbiParameters(
+      [
+        { type: "uint32" },
+        {
+          type: "tuple[]",
+          components: [
+            { type: "address" },
+            { type: "bool" },
+            { type: "bool" },
+            { type: "uint256" },
+            { type: "bytes4[]" },
+          ],
+        },
+      ],
+      [
+        entityId,
+        inputs.map(
+          (input) =>
+            [
+              input.target,
+              input.hasSelectorAllowlist,
+              input.hasERC20SpendLimit,
+              input.erc20SpendLimit,
+              input.selectors,
+            ] as const
+        ),
+      ]
+    );
+  },
+
+  encodeOnUninstallData: (args: {
+    entityId: number;
+    inputs: Array<{
+      target: Address;
+      hasSelectorAllowlist: boolean;
+      hasERC20SpendLimit: boolean;
+      erc20SpendLimit: bigint;
+      selectors: Array<Hex>;
+    }>;
+  }): Hex => {
+    const { entityId, inputs } = args;
+    return encodeAbiParameters(
+      [
+        { type: "uint32" },
+        {
+          type: "tuple[]",
+          components: [
+            { type: "address" },
+            { type: "bool" },
+            { type: "bool" },
+            { type: "uint256" },
+            { type: "bytes4[]" },
+          ],
+        },
+      ],
+      [
+        entityId,
+        inputs.map(
+          (input) =>
+            [
+              input.target,
+              input.hasSelectorAllowlist,
+              input.hasERC20SpendLimit,
+              input.erc20SpendLimit,
+              input.selectors,
+            ] as const
+        ),
+      ]
+    );
+  },
+};