fix: decorators should now correctly respect account hoisting

alchemyplatform · Jan 31, 2024 · 86d884e · 86d884e
1 parent 8573d3f
commit 86d884e
Show file tree

Hide file tree

Showing 43 changed files with 514 additions and 238 deletions.
diff --git a/packages/accounts/plugingen/phases/plugin-actions/index.ts b/packages/accounts/plugingen/phases/plugin-actions/index.ts
@@ -15,6 +15,7 @@ export const PluginActionsGenPhase: Phase = async (input) => {
   addImport("viem", { name: "EncodeFunctionDataParameters", isType: true });
   addImport("viem", { name: "Transport", isType: true });
   addImport("viem", { name: "Chain", isType: true });
+  addImport("viem", { name: "Client", isType: true });
   addImport("@alchemy/aa-core", {
     name: "SmartContractAccount",
     isType: true,
@@ -23,10 +24,6 @@ export const PluginActionsGenPhase: Phase = async (input) => {
     name: "UserOperationOverrides",
     isType: true,
   });
-  addImport("@alchemy/aa-core", {
-    name: "SmartAccountClient",
-    isType: true,
-  });
   addImport("@alchemy/aa-core", {
     name: "GetAccountParameter",
     isType: true,
@@ -36,6 +33,8 @@ export const PluginActionsGenPhase: Phase = async (input) => {
     isType: true,
   });
   addImport("@alchemy/aa-core", { name: "AccountNotFoundError" });
+  addImport("@alchemy/aa-core", { name: "isSmartAccountClient" });
+  addImport("@alchemy/aa-core", { name: "IncompatibleClientError" });
 
   const providerFunctionDefs: string[] = [];
   const providerFunctions = executionAbi
@@ -58,11 +57,15 @@ export const PluginActionsGenPhase: Phase = async (input) => {
         n.name
       }">, "args"> & { overrides?: UserOperationOverrides; } & GetAccountParameter<TAccount>) => Promise<SendUserOperationResult>
         `);
+      const methodName = camelCase(n.name);
       return dedent`
-              ${camelCase(n.name)}(${argsParamString}) {
+              ${methodName}(${argsParamString}) {
                 if (!account) {
                   throw new AccountNotFoundError();
-                }  
+                } 
+                if (!isSmartAccountClient(client)) {
+                  throw new IncompatibleClientError("SmartAccountClient", "${methodName}");
+                }
   
                 const uo = encodeFunctionData({
                   abi: ${executionAbiConst},
@@ -110,16 +113,10 @@ export const PluginActionsGenPhase: Phase = async (input) => {
             | SmartContractAccount
             | undefined
     >(
-        client: SmartAccountClient<TTransport, TChain, TAccount>
-    ) => ${contract.name}Actions<TAccount> = <
-        TTransport extends Transport = Transport,
-        TChain extends Chain | undefined = Chain | undefined,
-        TAccount extends SmartContractAccount | undefined =
-            | SmartContractAccount
-            | undefined
-    >(
-        client: SmartAccountClient<TTransport, TChain, TAccount>
-    ) => ({ ${providerFunctions.join(",\n")} });
+        client: Client<TTransport, TChain, TAccount>
+    ) => ${
+      contract.name
+    }Actions<TAccount> = (client) => ({ ${providerFunctions.join(",\n")} });
   `);
 
   return input;

diff --git a/packages/accounts/plugingen/phases/plugin-actions/management-actions.ts b/packages/accounts/plugingen/phases/plugin-actions/management-actions.ts
@@ -46,12 +46,18 @@ export const ManagementActionsGenPhase: Phase = async (input) => {
       `
     );
 
+    const installMethodName = `install${contract.name}`;
+
     input.content.push(dedent`
-    install${contract.name}({account = client.account, overrides, ...params}) {
+    ${installMethodName}({account = client.account, overrides, ...params}) {
       if (!account) {
         throw new AccountNotFoundError();
       }
 
+      if (!isSmartAccountClient(client)) {
+        throw new IncompatibleClientError("SmartAccountClient", "${installMethodName}");
+      }
+
       const chain = client.chain;
       if (!chain) {
         throw new Error("Chain is required");

diff --git a/packages/accounts/plugingen/phases/plugin-actions/read-actions.ts b/packages/accounts/plugingen/phases/plugin-actions/read-actions.ts
@@ -21,15 +21,12 @@ export const AccountReadActionsGenPhase: Phase = async (input) => {
     const argsEncodeString = n.inputs.length > 0 ? "args," : "";
     const isViewFunction = n.stateMutability === "view";
 
+    const encodeMethodName = `encode${pascalCase(n.name)}`;
     accountFunctionActionDefs.push(
-      dedent`encode${pascalCase(
-        n.name
-      )}: (args: Pick<EncodeFunctionDataParameters<typeof ${executionAbiConst}, "${
-        n.name
-      }">, "args">) => Hex`
+      dedent`${encodeMethodName}: (args: Pick<EncodeFunctionDataParameters<typeof ${executionAbiConst}, "${n.name}">, "args">) => Hex`
     );
     methodContent.push(dedent`
-      encode${pascalCase(n.name)}(${argsParamString}) {
+      ${encodeMethodName}(${argsParamString}) {
           return encodeFunctionData({
               abi: ${executionAbiConst},
               functionName: "${n.name}",
@@ -45,28 +42,23 @@ export const AccountReadActionsGenPhase: Phase = async (input) => {
     if (isViewFunction) {
       addImport("viem", { name: "ReadContractReturnType", isType: true });
       input.hasReadMethods = true;
+      const readMethodName = `read${pascalCase(n.name)}`;
       accountFunctionActionDefs.push(
         n.inputs.length > 0
-          ? dedent`read${pascalCase(
-              n.name
-            )}: (args: Pick<EncodeFunctionDataParameters<typeof ${executionAbiConst}, "${
-              n.name
-            }">, "args"> & GetAccountParameter<TAccount>) => Promise<ReadContractReturnType<typeof ${executionAbiConst}, "${
-              n.name
-            }">>`
-          : dedent`read${pascalCase(
-              n.name
-            )}: (args: GetAccountParameter<TAccount>) => Promise<ReadContractReturnType<typeof ${executionAbiConst}, "${
-              n.name
-            }">>`
+          ? dedent`${readMethodName}: (args: Pick<EncodeFunctionDataParameters<typeof ${executionAbiConst}, "${n.name}">, "args"> & GetAccountParameter<TAccount>) => Promise<ReadContractReturnType<typeof ${executionAbiConst}, "${n.name}">>`
+          : dedent`${readMethodName}: (args: GetAccountParameter<TAccount>) => Promise<ReadContractReturnType<typeof ${executionAbiConst}, "${n.name}">>`
       );
 
       methodContent.push(dedent`
-        async read${pascalCase(n.name)} (${readArgsParamString}) {
+        async ${readMethodName} (${readArgsParamString}) {
           if (!account) {
             throw new AccountNotFoundError();
           }
 
+          if (!isSmartAccountClient(client)) {
+            throw new IncompatibleClientError("SmartAccountClient", "${readMethodName}");
+          }
+
           return client.readContract({
             address: account.address,
             abi: ${executionAbiConst},

diff --git a/packages/accounts/plugingen/phases/plugin-generator/get-contract-gen.ts b/packages/accounts/plugingen/phases/plugin-generator/get-contract-gen.ts
@@ -4,10 +4,6 @@ import type { Phase } from "../../types";
 export const GetContractGenPhase: Phase = async (input) => {
   const { content, contract, addImport } = input;
 
-  addImport("@alchemy/aa-core", {
-    name: "SmartAccountClient",
-    isType: true,
-  });
   addImport("viem", { name: "getContract", isType: false });
   addImport("viem", { name: "GetContractReturnType", isType: true });
   addImport("viem", { name: "Address", isType: true });

diff --git a/packages/accounts/src/light-account/actions/transferOwnership.ts b/packages/accounts/src/light-account/actions/transferOwnership.ts
@@ -1,11 +1,12 @@
 import {
   AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
   type GetAccountParameter,
   type Hex,
-  type SmartAccountClient,
   type SmartAccountSigner,
 } from "@alchemy/aa-core";
-import type { Chain, Transport } from "viem";
+import type { Chain, Client, Transport } from "viem";
 import type { LightAccount } from "../account";
 
 export type TransferLightAccountOwnershipParams<
@@ -26,7 +27,7 @@ export const transferOwnership: <
     | LightAccount<TOwner>
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>,
+  client: Client<TTransport, TChain, TAccount>,
   args: TransferLightAccountOwnershipParams<TOwner, TAccount>
 ) => Promise<Hex> = async (
   client,
@@ -36,6 +37,13 @@ export const transferOwnership: <
     throw new AccountNotFoundError();
   }
 
+  if (!isSmartAccountClient(client)) {
+    throw new IncompatibleClientError(
+      "SmartAccountClient",
+      "transferOwnership"
+    );
+  }
+
   const data = account.encodeTransferOwnership(await newOwner.getAddress());
   const result = await client.sendUserOperation({
     uo: {

diff --git a/packages/accounts/src/light-account/lightAccountClientDecorator.ts b/packages/accounts/src/light-account/lightAccountClientDecorator.ts
@@ -1,10 +1,9 @@
 import type {
   GetAccountParameter,
   Hex,
-  SmartAccountClient,
   SmartAccountSigner,
 } from "@alchemy/aa-core";
-import type { Chain, Transport } from "viem";
+import type { Chain, Client, Transport } from "viem";
 import type { LightAccount } from "./account";
 import { transferOwnership } from "./actions/transferOwnership.js";
 
@@ -30,7 +29,7 @@ export const lightAccountClientActions: <
     | LightAccount<TOwner>
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>
+  client: Client<TTransport, TChain, TAccount>
 ) => LightAccountClientActions<TOwner, TAccount> = (client) => ({
   transferOwnership: async (args) => transferOwnership(client, args),
 });
diff --git a/packages/accounts/src/msca/account-loupe/decorator.ts b/packages/accounts/src/msca/account-loupe/decorator.ts
@@ -1,10 +1,11 @@
 import {
   AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
   type GetAccountParameter,
-  type SmartAccountClient,
   type SmartContractAccount,
 } from "@alchemy/aa-core";
-import type { Address, Chain, Hash, Transport } from "viem";
+import type { Address, Chain, Client, Hash, Transport } from "viem";
 import { IAccountLoupeAbi } from "../abis/IAccountLoupe.js";
 import type {
   ExecutionFunctionConfig,
@@ -57,7 +58,7 @@ export const accountLoupeActions: <
     | SmartContractAccount
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>
+  client: Client<TTransport, TChain, TAccount>
 ) => AccountLoupeActions<TAccount> = (client) => ({
   getExecutionFunctionConfig: async ({
     selector,
@@ -67,6 +68,13 @@ export const accountLoupeActions: <
       throw new AccountNotFoundError();
     }
 
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "getExecutionFunctionConfig"
+      );
+    }
+
     return client.readContract({
       address: account.address,
       abi: IAccountLoupeAbi,
@@ -80,6 +88,13 @@ export const accountLoupeActions: <
       throw new AccountNotFoundError();
     }
 
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "getExecutionHooks"
+      );
+    }
+
     return client.readContract({
       address: account.address,
       abi: IAccountLoupeAbi,
@@ -92,6 +107,14 @@ export const accountLoupeActions: <
     if (!account) {
       throw new AccountNotFoundError();
     }
+
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "getPreValidationHooks"
+      );
+    }
+
     return client.readContract({
       address: account.address,
       abi: IAccountLoupeAbi,
@@ -105,6 +128,13 @@ export const accountLoupeActions: <
       throw new AccountNotFoundError();
     }
 
+    if (!isSmartAccountClient(client)) {
+      throw new IncompatibleClientError(
+        "SmartAccountClient",
+        "getInstalledPlugins"
+      );
+    }
+
     return client.readContract({
       address: account.address,
       abi: IAccountLoupeAbi,

diff --git a/packages/accounts/src/msca/plugin-manager/decorator.ts b/packages/accounts/src/msca/plugin-manager/decorator.ts
@@ -1,9 +1,8 @@
 import type {
   SendUserOperationResult,
-  SmartAccountClient,
   SmartContractAccount,
 } from "@alchemy/aa-core";
-import type { Chain, Transport } from "viem";
+import type { Chain, Client, Transport } from "viem";
 import { installPlugin, type InstallPluginParams } from "./installPlugin.js";
 import {
   uninstallPlugin,
@@ -30,7 +29,7 @@ export const pluginManagerActions: <
     | SmartContractAccount
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>
+  client: Client<TTransport, TChain, TAccount>
 ) => PluginManagerActions<TAccount> = (client) => ({
   installPlugin: async (params) => installPlugin(client, params),
   uninstallPlugin: async (params) => uninstallPlugin(client, params),

diff --git a/packages/accounts/src/msca/plugin-manager/installPlugin.ts b/packages/accounts/src/msca/plugin-manager/installPlugin.ts
@@ -1,5 +1,7 @@
 import {
   AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
   type GetAccountParameter,
   type SmartAccountClient,
   type SmartContractAccount,
@@ -11,6 +13,7 @@ import {
   keccak256,
   type Address,
   type Chain,
+  type Client,
   type Hash,
   type Transport,
 } from "viem";
@@ -36,7 +39,7 @@ export async function installPlugin<
     | SmartContractAccount
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>,
+  client: Client<TTransport, TChain, TAccount>,
   {
     overrides,
     account = client.account,
@@ -47,6 +50,10 @@ export async function installPlugin<
     throw new AccountNotFoundError();
   }
 
+  if (!isSmartAccountClient(client)) {
+    throw new IncompatibleClientError("SmartAccountClient", "installPlugin");
+  }
+
   const callData = await encodeInstallPluginUserOperation(client, params);
   return client.sendUserOperation({ uo: callData, overrides, account });
 }

diff --git a/packages/accounts/src/msca/plugin-manager/uninstallPlugin.ts b/packages/accounts/src/msca/plugin-manager/uninstallPlugin.ts
@@ -1,14 +1,16 @@
 import {
   AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
   type GetAccountParameter,
-  type SmartAccountClient,
   type SmartContractAccount,
   type UserOperationOverrides,
 } from "@alchemy/aa-core";
 import {
   encodeFunctionData,
   type Address,
   type Chain,
+  type Client,
   type Hash,
   type Transport,
 } from "viem";
@@ -31,7 +33,7 @@ export async function uninstallPlugin<
     | SmartContractAccount
     | undefined
 >(
-  client: SmartAccountClient<TTransport, TChain, TAccount>,
+  client: Client<TTransport, TChain, TAccount>,
   {
     overrides,
     account = client.account,
@@ -42,6 +44,10 @@ export async function uninstallPlugin<
     throw new AccountNotFoundError();
   }
 
+  if (!isSmartAccountClient(client)) {
+    throw new IncompatibleClientError("SmartAccountClient", "uninstallPlugin");
+  }
+
   const callData = await encodeUninstallPluginUserOperation(params);
   return client.sendUserOperation({ uo: callData, overrides, account });
 }